149ee30ee8
This makes it easier to find the larger doc comments that produce separate pages. It also allows removing the lib/nvme directory from the Doxyfile, so only the public API headers are used to generate documentation. Change-Id: I8c46edb8067a91dda5b23fb0864efd3dd8aaeba5 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
71 lines
3.1 KiB
Plaintext
71 lines
3.1 KiB
Plaintext
/*-
|
|
* 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.
|
|
|
|
*/
|