Skip to content

Commit

Permalink
Documentation: Document the NVMe PCI endpoint target driver
Browse files Browse the repository at this point in the history
Add a documentation file
(Documentation/nvme/nvme-pci-endpoint-target.rst) for the new NVMe PCI
endpoint target driver. This provides an overview of the driver
requirements, capabilities and limitations. A user guide describing how
to setup a NVMe PCI endpoint device using this driver is also provided.

This document is made accessible also from the PCI endpoint
documentation using a link. Furthermore, since the existing nvme
documentation was not accessible from the top documentation index, an
index file is added to Documentation/nvme and this index listed as
"NVMe Subsystem" in the "Storage interfaces" section of the subsystem
API index.

Signed-off-by: Damien Le Moal <dlemoal@kernel.org>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Acked-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: Keith Busch <kbusch@kernel.org>
  • Loading branch information
Damien Le Moal authored and Keith Busch committed Jan 11, 2025
1 parent 0faa0fe commit 002ec8f
Show file tree
Hide file tree
Showing 5 changed files with 395 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/PCI/endpoint/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ PCI Endpoint Framework
pci-ntb-howto
pci-vntb-function
pci-vntb-howto
pci-nvme-function

function/binding/pci-test
function/binding/pci-ntb
13 changes: 13 additions & 0 deletions Documentation/PCI/endpoint/pci-nvme-function.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. SPDX-License-Identifier: GPL-2.0
=================
PCI NVMe Function
=================

:Author: Damien Le Moal <dlemoal@kernel.org>

The PCI NVMe endpoint function implements a PCI NVMe controller using the NVMe
subsystem target core code. The driver for this function resides with the NVMe
subsystem as drivers/nvme/target/nvmet-pciep.c.

See Documentation/nvme/nvme-pci-endpoint-target.rst for more details.
12 changes: 12 additions & 0 deletions Documentation/nvme/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. SPDX-License-Identifier: GPL-2.0
==============
NVMe Subsystem
==============

.. toctree::
:maxdepth: 2
:numbered:

feature-and-quirk-policy
nvme-pci-endpoint-target
Loading

0 comments on commit 002ec8f

Please sign in to comment.