diff --git a/include/spdk/assert.h b/include/spdk/assert.h index b626879d64..6035ff3cb2 100644 --- a/include/spdk/assert.h +++ b/include/spdk/assert.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * Runtime and compile-time assert macros + */ + #ifndef SPDK_ASSERT_H #define SPDK_ASSERT_H diff --git a/include/spdk/barrier.h b/include/spdk/barrier.h index 637c64d564..f6464a6355 100644 --- a/include/spdk/barrier.h +++ b/include/spdk/barrier.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * Memory barriers + */ + #ifndef SPDK_BARRIER_H #define SPDK_BARRIER_H diff --git a/include/spdk/file.h b/include/spdk/file.h index 5cb17691d4..1edfae146e 100644 --- a/include/spdk/file.h +++ b/include/spdk/file.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * OS filesystem utility functions + */ + #ifndef SPDK_FILE_H #define SPDK_FILE_H diff --git a/include/spdk/ioat.h b/include/spdk/ioat.h index 8a1fdba2e4..27e79b671f 100644 --- a/include/spdk/ioat.h +++ b/include/spdk/ioat.h @@ -32,7 +32,7 @@ */ /** \file - * This file defines the public interface to the I/OAT DMA engine driver. + * I/OAT DMA engine driver public interface */ #ifndef SPDK_IOAT_H diff --git a/include/spdk/ioat_spec.h b/include/spdk/ioat_spec.h index f8ed7a98ed..97af2536fd 100644 --- a/include/spdk/ioat_spec.h +++ b/include/spdk/ioat_spec.h @@ -31,6 +31,11 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * \file + * I/OAT specification definitions + */ + #ifndef SPDK_IOAT_SPEC_H #define SPDK_IOAT_SPEC_H diff --git a/include/spdk/mmio.h b/include/spdk/mmio.h index 3674fdecc3..041eed6fbd 100644 --- a/include/spdk/mmio.h +++ b/include/spdk/mmio.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * Memory-mapped I/O utility functions + */ + #ifndef SPDK_MMIO_H #define SPDK_MMIO_H diff --git a/include/spdk/nvme.h b/include/spdk/nvme.h index 4212e330fd..253dcfcf86 100644 --- a/include/spdk/nvme.h +++ b/include/spdk/nvme.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * NVMe driver public API + */ + #ifndef SPDK_NVME_H #define SPDK_NVME_H @@ -44,10 +48,6 @@ extern "C" { #include "spdk/pci.h" #include "nvme_spec.h" -/** \file - * - */ - #define SPDK_NVME_DEFAULT_RETRY_COUNT (4) extern int32_t spdk_nvme_retry_count; diff --git a/include/spdk/nvme_intel.h b/include/spdk/nvme_intel.h index bac0be2c9a..8caeafb341 100644 --- a/include/spdk/nvme_intel.h +++ b/include/spdk/nvme_intel.h @@ -31,6 +31,14 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * \file + * Intel NVMe vendor-specific definitions + * + * Reference: + * http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/ssd-dc-p3700-spec.pdf + */ + #ifndef SPDK_NVME_INTEL_H #define SPDK_NVME_INTEL_H @@ -43,13 +51,6 @@ extern "C" { #include "spdk/assert.h" -/** - * \file - * - * reference: - * http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/ssd-dc-p3700-spec.pdf - */ - enum spdk_nvme_intel_feat { SPDK_NVME_INTEL_FEAT_MAX_LBA = 0xC1, SPDK_NVME_INTEL_FEAT_NATIVE_MAX_LBA = 0xC2, diff --git a/include/spdk/nvme_spec.h b/include/spdk/nvme_spec.h index fef8ce527a..19d972b54b 100644 --- a/include/spdk/nvme_spec.h +++ b/include/spdk/nvme_spec.h @@ -31,6 +31,11 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * \file + * NVMe specification definitions + */ + #ifndef SPDK_NVME_SPEC_H #define SPDK_NVME_SPEC_H @@ -43,11 +48,6 @@ extern "C" { #include "spdk/assert.h" -/** - * \file - * - */ - /** * Use to mark a command to apply to all namespaces, or to retrieve global * log pages. diff --git a/include/spdk/pci.h b/include/spdk/pci.h index 7d71e79f3c..9f34745529 100644 --- a/include/spdk/pci.h +++ b/include/spdk/pci.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * PCI driver abstraction layer + */ + #ifndef SPDK_PCI_H #define SPDK_PCI_H diff --git a/include/spdk/pci_ids.h b/include/spdk/pci_ids.h index 84edc5e5a5..1948325627 100644 --- a/include/spdk/pci_ids.h +++ b/include/spdk/pci_ids.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * PCI device ID list + */ + #ifndef SPDK_PCI_IDS #define SPDK_PCI_IDS diff --git a/include/spdk/string.h b/include/spdk/string.h index ffcc8a96c5..8dae365388 100644 --- a/include/spdk/string.h +++ b/include/spdk/string.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * String utility functions + */ + #ifndef SPDK_STRING_H #define SPDK_STRING_H diff --git a/include/spdk/vtophys.h b/include/spdk/vtophys.h index 146d8008f1..b4ee8bcf69 100644 --- a/include/spdk/vtophys.h +++ b/include/spdk/vtophys.h @@ -31,6 +31,10 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** \file + * Virtual to physical address translation + */ + #ifndef SPDK_VTOPHYS_H #define SPDK_VTOPHYS_H diff --git a/lib/nvme/nvme_impl.h b/lib/nvme/nvme_impl.h index 0b4485a756..79e219e543 100644 --- a/lib/nvme/nvme_impl.h +++ b/lib/nvme/nvme_impl.h @@ -31,6 +31,17 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/** + * \file + * NVMe driver integration callbacks + * + * This file describes the callback functions required to integrate + * the userspace NVMe driver for a specific implementation. This + * implementation is specific for DPDK. Users would + * revise it as necessary for their own particular environment if not + * using it within the DPDK framework. + */ + #ifndef __NVME_IMPL_H__ #define __NVME_IMPL_H__ @@ -55,16 +66,6 @@ #include "spdk/pci_ids.h" #include "spdk/nvme_spec.h" -/** - * \file - * - * This file describes the callback functions required to integrate - * the userspace NVMe driver for a specific implementation. This - * implementation is specific for DPDK for Storage. Users would - * revise it as necessary for their own particular environment if not - * using it within the DPDK for Storage framework. - */ - /** * \page nvme_driver_integration NVMe Driver Integration *