Commit eeb08505 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

doc: add a page about NVMe library NVMe-oF support 



Change-Id: I64afae66273a487c7232bb22f380e324e725d4e2
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent b6d6cd8e

doc/Doxyfile

+1 −0
Original line number Diff line number Diff line
@@ -766,6 +766,7 @@ INPUT = ../include/spdk \ 
                         ioat/index.md \

                         nvme/index.md \

                         nvme/async_completion.md \

                         nvme/fabrics.md \

                         nvme/initialization.md \

                         nvme/io_submission.md \

                         nvmf/index.md \

doc/nvme/fabrics.md

0 → 100644
+24 −0
Original line number Diff line number Diff line 
# NVMe over Fabrics Host Support {#nvme_fabrics_host}



The NVMe driver supports connecting to remote NVMe-oF targets and

interacting with them in the same manner as local NVMe controllers.



# Specifying Remote NVMe over Fabrics Targets {#nvme_fabrics_trid}



The method for connecting to a remote NVMe-oF target is very similar

to the normal enumeration process for local PCIe-attached NVMe devices.

To connect to a remote NVMe over Fabrics subsystem, the user may call

spdk_nvme_probe() with the `trid` parameter specifying the address of

the NVMe-oF target.

The caller may fill out the spdk_nvme_transport_id structure manually

or use the spdk_nvme_transport_id_parse() function to convert a

human-readable string representation into the required structure.



The spdk_nvme_transport_id may contain the address of a discovery service

or a single NVM subsystem.  If a discovery service address is specified,

the NVMe library will call the spdk_nvme_probe() `probe_cb` for each

discovered NVM subsystem, which allows the user to select the desired

subsystems to be attached.  Alternatively, if the address specifies a

single NVM subsystem directly, the NVMe library will call `probe_cb`

for just that subsystem; this allows the user to skip the discovery step

and connect directly to a subsystem with a known address.

doc/nvme/index.md

+1 −0
Original line number Diff line number Diff line
@@ -22,3 +22,4 @@ spdk_nvme_ctrlr_process_admin_completions() | @copybrief spdk_nvme_ctrlr_process 
- @ref nvme_initialization

- @ref nvme_io_submission

- @ref nvme_async_completion

- @ref nvme_fabrics_host

doc/nvmf/index.md

+2 −0
Original line number Diff line number Diff line 
# NVMe over Fabrics {#nvmf}



- @ref nvmf_getting_started



@sa @ref nvme_fabrics_host