00001 /** ============================================================================ 00002 * @file drx416gem_phy_shmem.h 00003 * 00004 * @path $(DSPLINK)/gpp/inc/sys/arch/DRX416GEM/PrOS/ 00005 * 00006 * @brief Physical Interface Abstraction Layer for DRX416GEM. 00007 * 00008 * @ver 1.65.00.03 00009 * ============================================================================ 00010 * @copyright Copyright (C) 2002-2009, Texas Instruments Incorporated - 00011 * http://www.ti.com/ 00012 * 00013 * Redistribution and use in source and binary forms, with or without 00014 * modification, are permitted provided that the following conditions 00015 * are met: 00016 * 00017 * * Redistributions of source code must retain the above copyright 00018 * notice, this list of conditions and the following disclaimer. 00019 * 00020 * * Redistributions in binary form must reproduce the above copyright 00021 * notice, this list of conditions and the following disclaimer in the 00022 * documentation and/or other materials provided with the distribution. 00023 * 00024 * * Neither the name of Texas Instruments Incorporated nor the names of 00025 * its contributors may be used to endorse or promote products derived 00026 * from this software without specific prior written permission. 00027 * 00028 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 00029 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 00030 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 00031 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 00032 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00033 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 00034 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 00035 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 00036 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 00037 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 00038 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00039 * ============================================================================ 00040 */ 00041 00042 00043 #if !defined (DRX416GEM_PHY_SHMEM_H) 00044 #define DRX416GEM_PHY_SHMEM_H 00045 00046 00047 /* ----------------------------------- DSP/BIOS Link */ 00048 #include <dsplink.h> 00049 00050 /* ----------------------------------- Hardware Abstraction Layer */ 00051 #include <hal.h> 00052 00053 00054 #if defined (__cplusplus) 00055 extern "C" { 00056 #endif 00057 00058 00059 /* ============================================================================ 00060 * @const OFFSET_SYSTEM_MODULE 00061 * 00062 * @brief Offset of the system module registers from the base of the CFG 00063 * memory. 00064 * ============================================================================ 00065 */ 00066 #define OFFSET_SYSTEM_MODULE 0x48000u 00067 00068 00069 /** ============================================================================ 00070 * @name DRX416GEM_shmemInterface 00071 * 00072 * @brief Interface functions exported by the Shared Driver subcomponent. 00073 * ============================================================================ 00074 */ 00075 extern HAL_Interface DRX416GEM_shmemInterface ; 00076 00077 00078 /* ============================================================================ 00079 * @func DRX416GEM_phyShmemInit 00080 * 00081 * @brief Initializes Shared Driver/device. 00082 * 00083 * @param halObject. 00084 * HAL object. 00085 * 00086 * @return DSP_SOK 00087 * Operation successfully completed. 00088 * DSP_EFAIL 00089 * All other error conditions. 00090 * 00091 * @pre None. 00092 * 00093 * @post None. 00094 * 00095 * @see None 00096 * ============================================================================ 00097 */ 00098 NORMAL_API 00099 DSP_STATUS 00100 DRX416GEM_phyShmemInit (IN Pvoid halObj) ; 00101 00102 00103 /* ============================================================================ 00104 * @func DRX416GEM_phyShmemExit 00105 * 00106 * @brief Finalizes Shared Driver/device. 00107 * 00108 * @param halObject. 00109 * HAL object. 00110 * 00111 * @return DSP_SOK 00112 * Operation successfully completed. 00113 * DSP_EFAIL 00114 * All other error conditions. 00115 * 00116 * @pre None. 00117 * 00118 * @post None. 00119 * 00120 * @see None 00121 * ============================================================================ 00122 */ 00123 NORMAL_API 00124 DSP_STATUS 00125 DRX416GEM_phyShmemExit (IN Pvoid halObj) ; 00126 00127 00128 #if defined (__cplusplus) 00129 } 00130 #endif 00131 00132 00133 #endif /* !defined (DRX416GEM_PHY_SHMEM_H) */