diff options
| author | Damien Le Moal <dlemoal@kernel.org> | 2025-01-04 13:59:51 +0900 |
|---|---|---|
| committer | Keith Busch <kbusch@kernel.org> | 2025-01-10 19:30:49 -0800 |
| commit | 002ec8f1c69d3722a033eaf45102ba747ae80e94 (patch) | |
| tree | 027a39fdac9f7156c34727b71341db236a9bc739 /Documentation/PCI | |
| parent | 0faa0fe6f90ea59b10d1b0f15ce0eb0c18eff186 (diff) | |
| download | linux-002ec8f1c69d3722a033eaf45102ba747ae80e94.tar.gz linux-002ec8f1c69d3722a033eaf45102ba747ae80e94.tar.bz2 linux-002ec8f1c69d3722a033eaf45102ba747ae80e94.zip | |
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>
Diffstat (limited to 'Documentation/PCI')
| -rw-r--r-- | Documentation/PCI/endpoint/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/PCI/endpoint/pci-nvme-function.rst | 13 |
2 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst index 4d2333e7ae06..dd1f62e731c9 100644 --- a/Documentation/PCI/endpoint/index.rst +++ b/Documentation/PCI/endpoint/index.rst @@ -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 diff --git a/Documentation/PCI/endpoint/pci-nvme-function.rst b/Documentation/PCI/endpoint/pci-nvme-function.rst new file mode 100644 index 000000000000..df57b8e7d066 --- /dev/null +++ b/Documentation/PCI/endpoint/pci-nvme-function.rst @@ -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. |