9322c25808
Reference the public headers in the way that apps should include them (e.g. spdk/nvme.h rather than just nvme.h). Change-Id: I0489d906e9c55ff00ffa4e8c9532b0941ce69449 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
59 lines
2.3 KiB
Plaintext
59 lines
2.3 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.
|
|
*/
|
|
|
|
/*!
|
|
|
|
\mainpage SPDK Userspace NVMe Driver
|
|
|
|
\section interface Public Interface
|
|
|
|
- spdk/nvme.h
|
|
|
|
\section key_functions Key Functions
|
|
|
|
- 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_deallocate() \copybrief spdk_nvme_ns_cmd_deallocate()
|
|
- spdk_nvme_ns_cmd_flush() \copybrief spdk_nvme_ns_cmd_flush()
|
|
- spdk_nvme_ctrlr_process_io_completions() \copybrief spdk_nvme_ctrlr_process_io_completions()
|
|
|
|
\section key_concepts Key Concepts
|
|
|
|
- \ref nvme_driver_integration
|
|
- \ref nvme_initialization
|
|
- \ref nvme_io_submission
|
|
- \ref nvme_async_completion
|
|
|
|
*/
|