Skip to content

Commit 002ec8f

Browse files
damien-lemoalkeithbusch
authored andcommitted
Documentation: Document the NVMe PCI endpoint target driver
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>
1 parent 0faa0fe commit 002ec8f

File tree

5 files changed

+395
-0
lines changed

5 files changed

+395
-0
lines changed

Documentation/PCI/endpoint/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ PCI Endpoint Framework
1515
pci-ntb-howto
1616
pci-vntb-function
1717
pci-vntb-howto
18+
pci-nvme-function
1819

1920
function/binding/pci-test
2021
function/binding/pci-ntb
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=================
4+
PCI NVMe Function
5+
=================
6+
7+
:Author: Damien Le Moal <dlemoal@kernel.org>
8+
9+
The PCI NVMe endpoint function implements a PCI NVMe controller using the NVMe
10+
subsystem target core code. The driver for this function resides with the NVMe
11+
subsystem as drivers/nvme/target/nvmet-pciep.c.
12+
13+
See Documentation/nvme/nvme-pci-endpoint-target.rst for more details.

Documentation/nvme/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
==============
4+
NVMe Subsystem
5+
==============
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
:numbered:
10+
11+
feature-and-quirk-policy
12+
nvme-pci-endpoint-target

0 commit comments

Comments
 (0)