Commit 0be12ad7 authored by Ben Walker's avatar Ben Walker Committed by Jim Harris
Browse files

doc: Convert nvme docs to markdown 



Change-Id: Ifc9c79886f05c6a3abd1553021a65724e53dd5c0
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 55ca1581

doc/Doxyfile

+4 −4
Original line number Diff line number Diff line
@@ -762,10 +762,10 @@ INPUT = ../include/spdk \ 
                         index.md \

                         directory_structure.md \

                         ioat/index.txt \

                         nvme/index.txt \

                         nvme/async_completion.txt \

                         nvme/initialization.txt \

                         nvme/io_submission.txt \

                         nvme/index.md \

                         nvme/async_completion.md \

                         nvme/initialization.md \

                         nvme/io_submission.md \

                         nvmf/index.txt \

                         nvmf/getting_started.txt \

                         iscsi/index.txt \

doc/index.md

+1 −1
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ which avoids kernel context switches and eliminates interrupt handling overhead. 


## Modules {#modules}



- \ref nvme

- @ref nvme

- \ref nvmf

- \ref ioat

- \ref iscsi

doc/nvme/async_completion.txt→doc/nvme/async_completion.md

+33 −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

# NVMe Asynchronous Completion {#nvme_async_completion}



The userspace NVMe driver follows an asynchronous polled model for

I/O completion.



\section nvme_async_io I/O commands

# I/O commands {#nvme_async_io}



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()
@@ -49,7 +14,7 @@ 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

# Admin commands {#nvme_async_admin}



The application may submit admin commands from one or more threads

and must call spdk_nvme_ctrlr_process_admin_completions()
@@ -66,5 +31,3 @@ It is the application's responsibility to manage the order of submitted admin co 
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/index.md

0 → 100644
+22 −0
Original line number Diff line number Diff line 
# NVMe Driver {#nvme}



# Public Interface {#nvme_interface}



- spdk/nvme.h



# Key Functions {#nvme_key_functions}



Function                                | Description

--------------------------------------- | -----------

spdk_nvme_probe()                       | @copybrief spdk_nvme_probe()

spdk_nvme_ns_cmd_read()                 | @copybrief spdk_nvme_ns_cmd_read()

spdk_nvme_ns_cmd_write()                | @copybrief spdk_nvme_ns_cmd_write()

spdk_nvme_ns_cmd_dataset_management()   | @copybrief spdk_nvme_ns_cmd_dataset_management()

spdk_nvme_ns_cmd_flush()                | @copybrief spdk_nvme_ns_cmd_flush()

spdk_nvme_qpair_process_completions()   | @copybrief spdk_nvme_qpair_process_completions()



# Key Concepts {#nvme_key_concepts}



- @ref nvme_initialization

- @ref nvme_io_submission

- @ref nvme_async_completion

doc/nvme/index.txt

deleted100644 → 0
+0 −59
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 NVMe Driver



\section nvme_interface Public Interface



- spdk/nvme.h



\section nvme_key_functions Key Functions



Function                                | Description

--------------------------------------- | -----------

spdk_nvme_probe()                       | \copybrief spdk_nvme_probe()

spdk_nvme_ns_cmd_read()                 | \copybrief spdk_nvme_ns_cmd_read()

spdk_nvme_ns_cmd_write()                | \copybrief spdk_nvme_ns_cmd_write()

spdk_nvme_ns_cmd_dataset_management()   | \copybrief spdk_nvme_ns_cmd_dataset_management()

spdk_nvme_ns_cmd_flush()                | \copybrief spdk_nvme_ns_cmd_flush()

spdk_nvme_qpair_process_completions()   | \copybrief spdk_nvme_qpair_process_completions()



\section nvme_key_concepts Key Concepts



- \ref nvme_initialization

- \ref nvme_io_submission

- \ref nvme_async_completion



*/