Re: [PATCH v5 4/4] Documentation: PCI: Add documentation for DOE endpoint support

From: Randy Dunlap

Date: Wed Jun 10 2026 - 19:22:10 EST




On 6/10/26 3:02 AM, Aksh Garg wrote:
> Document the architecture and implementation details for the Data Object
> Exchange (DOE) framework for PCIe Endpoint devices.
>
> Co-developed-by: Siddharth Vadapalli <s-vadapalli@xxxxxx>
> Signed-off-by: Siddharth Vadapalli <s-vadapalli@xxxxxx>
> Signed-off-by: Aksh Garg <a-garg7@xxxxxx>

Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Thanks.

> ---
>
> Changes from v4 to v5:
> - Updated the DOE Abort handling setion.
>
> Changes from v3 to v4:
> - Updated the maximum size of the DOE object from 256KB to 1MB,
> as per PCIe spec.
> - Updated the DOE setup and cleanup sections.
>
> Changes from v2 to v3:
> - Rebased on 7.1-rc1.
>
> Changes since v1:
> - Squashed the patches [1] and [2], and moved the documentation file
> to Documentation/PCI/endpoint/pci-endpoint-doe.rst to match the existing
> naming scheme, as suggested by Niklas Cassel
> - Updated the documentation as per the design and implementaion changes
> made to previous patches in this series:
> * Updated for static protocol array instead of dynamic registration
> * Documented asynchronous callback model
> * Updated request/response flow with new callback signature
> * Updated memory ownership: DOE core frees request, driver frees response
> * Updated initialization and cleanup sections for new APIs
>
> v4: https://lore.kernel.org/all/20260522052434.802034-5-a-garg7@xxxxxx/
> v3: https://lore.kernel.org/all/20260427051725.223704-5-a-garg7@xxxxxx/
> v2: https://lore.kernel.org/all/20260401073022.215805-5-a-garg7@xxxxxx/
> v1: [1] https://lore.kernel.org/all/20260213123603.420941-2-a-garg7@xxxxxx/
> [2] https://lore.kernel.org/all/20260213123603.420941-5-a-garg7@xxxxxx/
>
> Documentation/PCI/endpoint/index.rst | 1 +
> .../PCI/endpoint/pci-endpoint-doe.rst | 333 ++++++++++++++++++
> 2 files changed, 334 insertions(+)
> create mode 100644 Documentation/PCI/endpoint/pci-endpoint-doe.rst


--
~Randy