mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Aksh Garg <a-garg7@ti.com>
To: <linux-pci@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<bhelgaas@google.com>, <corbet@lwn.net>, <cassel@kernel.org>
Cc: <linux-kernel@vger.kernel.org>,
	<linux-arm-kernel@lists.infradead.org>, <s-vadapalli@ti.com>,
	<danishanwar@ti.com>, <srk@ti.com>, <a-garg7@ti.com>
Subject: [RFC PATCH 4/4] PCI: Document APIs for endpoint DOE implementation
Date: Fri, 13 Feb 2026 18:06:03 +0530	[thread overview]
Message-ID: <20260213123603.420941-5-a-garg7@ti.com> (raw)
In-Reply-To: <20260213123603.420941-1-a-garg7@ti.com>

From: Aksh Garg <a-garg7@ti.com>

Add kernel-doc API reference section to the DOE endpoint documentation,
documenting the exported functions from drivers/pci/doe-ep.c for use by
endpoint controller drivers and protocol handler modules.

Co-developed-by: Siddharth Vadapalli <s-vadapalli@ti.com>
Signed-off-by: Siddharth Vadapalli <s-vadapalli@ti.com>
Signed-off-by: Aksh Garg <a-garg7@ti.com>
---
 Documentation/PCI/pci-doe-ep.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/PCI/pci-doe-ep.rst b/Documentation/PCI/pci-doe-ep.rst
index d6715944c117..6ad064e838e7 100644
--- a/Documentation/PCI/pci-doe-ep.rst
+++ b/Documentation/PCI/pci-doe-ep.rst
@@ -289,3 +289,9 @@ When the controller driver receives an error code from
 ``pci_ep_doe_process_request()``, it sets the ERROR bit in the DOE Status
 register instead of writing a response to the read mailbox register,
 and frees the buffers.
+
+API Reference
+=============
+
+.. kernel-doc:: drivers/pci/doe-ep.c
+   :export:
-- 
2.34.1


  parent reply	other threads:[~2026-02-13 12:36 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-13 12:35 [RFC PATCH 0/4] PCI: Add DOE support for endpoint Aksh Garg
2026-02-13 12:36 ` [RFC PATCH 1/4] PCI: Add documentation for DOE endpoint support Aksh Garg
2026-02-13 20:33   ` Niklas Cassel
2026-02-18 11:21     ` Aksh Garg
2026-02-13 12:36 ` [RFC PATCH 2/4] PCI/DOE: Move common definitions to the header file Aksh Garg
2026-02-22 13:01   ` Lukas Wunner
2026-02-23  7:30     ` Aksh Garg
2026-02-13 12:36 ` [RFC PATCH 3/4] PCI/DOE: Add DOE mailbox support for endpoint functions Aksh Garg
2026-02-13 13:21   ` Niklas Cassel
2026-02-18  4:28   ` Alistair Francis
2026-03-04 14:18     ` Manivannan Sadhasivam
2026-03-06 12:14       ` Aksh Garg
2026-02-22 13:06   ` Lukas Wunner
2026-02-23 10:44     ` Aksh Garg
2026-03-04 14:17   ` Manivannan Sadhasivam
2026-03-06  8:17     ` Aksh Garg
2026-02-13 12:36 ` Aksh Garg [this message]
2026-02-13 13:16 ` [RFC PATCH 0/4] PCI: Add DOE support for endpoint Niklas Cassel
2026-03-04 14:22 ` Manivannan Sadhasivam

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260213123603.420941-5-a-garg7@ti.com \
    --to=a-garg7@ti.com \
    --cc=bhelgaas@google.com \
    --cc=cassel@kernel.org \
    --cc=corbet@lwn.net \
    --cc=danishanwar@ti.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=s-vadapalli@ti.com \
    --cc=srk@ti.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®