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>
53 lines
2.2 KiB
Plaintext
53 lines
2.2 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_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
|
|
|
|
*/
|