main.doxygen

Go to the documentation of this file.

/** @mainpage Overview
 *
 * This is the API reference documentation for the OneCore Storage User Space
 * FC/FCoE Target RAMD driver (Uspace ocs fc_ramd).<br>
 *
 * The Uspace ocs_fc_ramd driver uses the Emulex RAMD target back-end (usually called "RAMD").
 * It implements a non-persistent RAM disk
 * backing store. The driver implements a number of SCSI commands, 
 * and appears to initiators as a valid SCSI block device.
 * There is no initiator functionality provided for this driver.
 *
 * The Uspace ocs_fc_ramd driver uses the same front-end (base driver) and 
 * target (Emulex RAMD) components as the Linux ocs_fc_ramd driver.
 * The one exception is the PCI sub-component under the Linux OS component.
 * For user space drivers, the PCI functionality is managed in the
 * <a href="kernel_mod_overview.html">Kernel Module</a>.
 *
 * Figure&nbsp;1 shows the framework for the Uspace ocs_fc_ramd driver.
 *
 * <img src="elx_uspace_ocs_fc_ramd_block.jpg" alt="Figure 1 - Uspace ocs_fc_ramd Driver High-Level Block Diagram"/>
 * 
 * For detailed information about the driver architecture and design, also see
 * the <i><a href="../../../../../doc/ocs_driver_design_manual.pdf" target="_blank">OneCore Storage Driver Design Manual</a></i>.
 * For instructions on building and installing the Uspace ocs_fc_ramd driver, see the 
 * “User Space Linux FC/FCoE Target RAMD Driver (Uspace ocs_fc_ramd)” section under “Building and Installing” 
 * in the <i><a href="../../../../../doc/ocs_sdk_quick_start_guide.pdf" target="_blank">OneCore Storage SDK Quick Start Guide</a></i>.
 *
 *
 * @section component_desc Component APIs
 *
 * As shown in Figure 1, the Uspace ocs_fc_ramd driver is composed of multiple component layers.
 * Each component layer provides its own set of APIs that are described in the following sections.
 *
 * <h2><a href="ramd_api_overview.html">Back-end Target APIs and State Machine Functions</a></h2>
 * \li \ref scsi_api_target
 * \li \ref scsi_cmd
 * \li \ref io_sm
 * \li \ref ramdisc
 *
 * <h2><a href="fc_transport_api_overview.html">Transport APIs and State Machine Functions</a></h2>
 * \li \ref scsi_api_base
 * \li \ref domain_sm
 * \li \ref sport_sm
 * \li \ref device_sm
 * \li \ref p2p_sm
 * \li \ref fabric_sm
 * \li \ref ns_sm
 * \li \ref unsol
 * \li \ref els_api
 *
 * <h2><a href="fc_hal_api_overview.html">Hardware Abstraction Layer (HAL) APIs</a></h2>
 * \li \ref devInitShutdown
 * \li \ref domain
 * \li \ref port
 * \li \ref node
 * \li \ref io
 * \li \ref interrupt
 *
 * <h2><a href="fc_sli4_api_overview.html">SLI-4 APIs</a></h2>
 * \li \ref sli
 * \li \ref sli_fc
 *
 * <h2><a href="uspace_linux_os_overview.html">OS APIs</a></h2>
 * \li \ref os
 *
 * <h2><a href="kernel_mod_overview.html">Kernel Module</a></h2>
 * \li \ref kernel_mod_overview
 *
 * <h2><a href="mgmt_api_overview.html">Management APIs</a></h2>
 * \li \ref mgmt
 *
 * <h2><a href="fc_general_purpose_overview.html">General Purpose APIs</a></h2>
 * \li \ref spv
 * \li \ref debug
 *
 */
     
 /**
 * @page kernel_mod_overview Kernel Module Overview
 *
 * <div class="overview">
 * <img src="elx_uspace_ocs_fc_ramd_kernel.jpg" alt="Kernel Module" title="Kernel Module" align="right"/>
 * The Uspace ocs_fc_ramd driver includes a small kernel module (ocs_uspace.ko).
 * This kernel module provides access to PCI resources, as well as managing DMA
 * memory buffers.<br> <br>
 * Kernel module functionality includes:
 *  - Read/write PCI configuration space registers
 *  - Read/write per PCI function BAR memory regions
 *  - Mapping of per PCI function BAR memory regions to user space
 *  - Allocation of and freeing of kernel resident DMA buffers, mapping buffers to
 * user space
 *  - DMA buffer synchronization (maintaining cache coherency)
 *  - Wait on interrupt
 *
 * The files for the kernel module are located in the 
 * <a href="../../../../linux/ocs_uspace/" target="_blank">
 * driver/linux/ocs_uspace/</a> directory.
 * </div>
 *
 */