doc/nvme: move pages to separate text files (149ee30e) · Commits · Public Repositories / spdk

doc/Doxyfile

+5 −2

Original line number	Diff line number	Diff line
		@@ -758,11 +758,14 @@ WARN_LOGFILE =
		# spaces.
		# Note: If this tag is empty the current directory is searched.

		INPUT = ../lib/nvme \
		INPUT = ../lib/nvme/nvme_impl.h \
		../include/spdk \
		mainpage.txt \
		ioat/index.txt \
		nvme/index.txt
		nvme/index.txt \
		nvme/async_completion.txt \
		nvme/initialization.txt \
		nvme/io_submission.txt

		# This tag can be used to specify the character encoding of the source files
		# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/nvme/async_completion.txt

0 → 100644

+70 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) Intel Corporation.
		* All rights reserved.
		*
		* Redistribution and use in source and binary forms, with or without
		* modification, are permitted provided that the following conditions
		* are met:
		*
		* * Redistributions of source code must retain the above copyright
		* notice, this list of conditions and the following disclaimer.
		* * Redistributions in binary form must reproduce the above copyright
		* notice, this list of conditions and the following disclaimer in
		* the documentation and/or other materials provided with the
		* distribution.
		* * Neither the name of Intel Corporation nor the names of its
		* contributors may be used to endorse or promote products derived
		* from this software without specific prior written permission.
		*
		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/**

		\page nvme_async_completion NVMe Asynchronous Completion

		The userspace NVMe driver follows an asynchronous polled model for
		I/O completion.

		\section nvme_async_io I/O commands

		The application may submit I/O from one or more threads on one or more queue pairs
		and must call spdk_nvme_qpair_process_completions()
		for each queue pair that submitted I/O.

		When the application calls spdk_nvme_qpair_process_completions(),
		if the NVMe driver detects completed I/Os that were submitted on that queue,
		it will invoke the registered callback function
		for each I/O within the context of spdk_nvme_qpair_process_completions().

		\section nvme_async_admin Admin commands

		The application may submit admin commands from one or more threads
		and must call spdk_nvme_ctrlr_process_admin_completions()
		from at least one thread to receive admin command completions.
		The thread that processes admin completions need not be the same thread that submitted the
		admin commands.

		When the application calls spdk_nvme_ctrlr_process_admin_completions(),
		if the NVMe driver detects completed admin commands submitted from any thread,
		it will invote the registered callback function
		for each command within the context of spdk_nvme_ctrlr_process_admin_completions().

		It is the application's responsibility to manage the order of submitted admin commands.
		If certain admin commands must be submitted while no other commands are outstanding,
		it is the application's responsibility to enforce this rule
		using its own synchronization method.

		*/

doc/nvme/initialization.txt

0 → 100644

+52 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) Intel Corporation.
		* All rights reserved.
		*
		* Redistribution and use in source and binary forms, with or without
		* modification, are permitted provided that the following conditions
		* are met:
		*
		* * Redistributions of source code must retain the above copyright
		* notice, this list of conditions and the following disclaimer.
		* * Redistributions in binary form must reproduce the above copyright
		* notice, this list of conditions and the following disclaimer in
		* the documentation and/or other materials provided with the
		* distribution.
		* * Neither the name of Intel Corporation nor the names of its
		* contributors may be used to endorse or promote products derived
		* from this software without specific prior written permission.
		*
		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/**
		* \page nvme_initialization NVMe Initialization

		\msc

		app [label="Application"], nvme [label="NVMe Driver"];
		app=>nvme [label="nvme_probe()"];
		app<<nvme [label="probe_cb(pci_dev)"];
		nvme=>nvme [label="nvme_attach(devhandle)"];
		nvme=>nvme [label="nvme_ctrlr_start(nvme_controller ptr)"];
		nvme=>nvme [label="identify controller"];
		nvme=>nvme [label="create queue pairs"];
		nvme=>nvme [label="identify namespace(s)"];
		app<<nvme [label="attach_cb(pci_dev, nvme_controller)"];
		app=>app [label="create block devices based on controller's namespaces"];

		\endmsc

		*/

doc/nvme/io_submission.txt

0 → 100644

+47 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) Intel Corporation.
		* All rights reserved.
		*
		* Redistribution and use in source and binary forms, with or without
		* modification, are permitted provided that the following conditions
		* are met:
		*
		* * Redistributions of source code must retain the above copyright
		* notice, this list of conditions and the following disclaimer.
		* * Redistributions in binary form must reproduce the above copyright
		* notice, this list of conditions and the following disclaimer in
		* the documentation and/or other materials provided with the
		* distribution.
		* * Neither the name of Intel Corporation nor the names of its
		* contributors may be used to endorse or promote products derived
		* from this software without specific prior written permission.
		*
		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		/**

		\page nvme_io_submission NVMe I/O Submission

		I/O is submitted to an NVMe namespace using nvme_ns_cmd_xxx functions
		defined in nvme_ns_cmd.c. The NVMe driver submits the I/O request
		as an NVMe submission queue entry on the queue pair specified in the command.
		The application must poll for I/O completion on each queue pair with outstanding I/O
		to receive completion callbacks.

		\sa spdk_nvme_ns_cmd_read, spdk_nvme_ns_cmd_write, spdk_nvme_ns_cmd_deallocate,
		spdk_nvme_ns_cmd_flush, spdk_nvme_qpair_process_completions

		*/

lib/nvme/nvme.c

+0 −25

Original line number	Diff line number	Diff line
		@@ -33,10 +33,6 @@

		#include "nvme_internal.h"

		/** \file
		*
		*/

		struct nvme_driver g_nvme_driver = {
		.lock = NVME_MUTEX_INITIALIZER,
		.init_ctrlrs = TAILQ_HEAD_INITIALIZER(g_nvme_driver.init_ctrlrs),
		@@ -45,27 +41,6 @@ struct nvme_driver g_nvme_driver = {

		int32_t spdk_nvme_retry_count;


		/**
		* \page nvme_initialization NVMe Initialization

		\msc

		app [label="Application"], nvme [label="NVMe Driver"];
		app=>nvme [label="nvme_probe()"];
		app<<nvme [label="probe_cb(pci_dev)"];
		nvme=>nvme [label="nvme_attach(devhandle)"];
		nvme=>nvme [label="nvme_ctrlr_start(nvme_controller ptr)"];
		nvme=>nvme [label="identify controller"];
		nvme=>nvme [label="create queue pairs"];
		nvme=>nvme [label="identify namespace(s)"];
		app<<nvme [label="attach_cb(pci_dev, nvme_controller)"];
		app=>app [label="create block devices based on controller's namespaces"];

		\endmsc

		*/

		static struct spdk_nvme_ctrlr *
		nvme_attach(void *devhandle)
		{

Admin message