00001 /** ============================================================================ 00002 * @file drx416gem_hal.h 00003 * 00004 * @path $(DSPLINK)/gpp/inc/sys/arch/DRX416GEM/ 00005 * 00006 * @brief Hardware Abstraction Layer. 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_HAL_H) 00044 #define DRX416GEM_HAL_H 00045 00046 00047 /* ----------------------------------- DSP/BIOS Link */ 00048 #include <dsplink.h> 00049 #include <_dsplink.h> 00050 00051 /* ----------------------------------- Trace & Debug */ 00052 #include <_trace.h> 00053 00054 /* ----------------------------------- Hardware Abstraction Layer */ 00055 #include <hal.h> 00056 00057 00058 #if defined (__cplusplus) 00059 extern "C" { 00060 #endif 00061 00062 00063 /* ============================================================================ 00064 * @macro REG 00065 * 00066 * @brief Regsiter access method. 00067 * ============================================================================ 00068 */ 00069 #define REG(x) *((volatile Uint32 *) (x)) 00070 00071 00072 /** ============================================================================ 00073 * @name DRX416GEM_HalObj 00074 * 00075 * @brief Hardware Abstraction object. 00076 * 00077 * @param interface 00078 * Pointer to HAL interface table. 00079 * @param baseCfgBus 00080 * base address of the configuration bus peripherals memory range. 00081 * @param offsetSysModule 00082 * Offset of the system module from CFG base. 00083 * ============================================================================ 00084 */ 00085 typedef struct DRX416GEM_HalObj_tag { 00086 HAL_Interface * interface ; 00087 Uint32 baseCfgBus ; 00088 Uint32 offsetSysModule ; 00089 } DRX416GEM_HalObj ; 00090 00091 00092 /** ============================================================================ 00093 * @func DRX416GEM_halInitialize 00094 * 00095 * @brief Initializes the HAL object. 00096 * 00097 * @param halObj. 00098 * Pointer to HAL object. 00099 * @param initParams. 00100 * Parameters for initialize (optional). 00101 * 00102 * @return DSP_SOK 00103 * Operation successfully completed. 00104 * DSP_EFAIL 00105 * All other error conditions. 00106 * 00107 * @pre None. 00108 * 00109 * @post None. 00110 * 00111 * @see None 00112 * ============================================================================ 00113 */ 00114 NORMAL_API 00115 DSP_STATUS 00116 DRX416GEM_halInit (IN Pvoid * halObj, 00117 IN Pvoid initParams) ; 00118 00119 00120 /** ============================================================================ 00121 * @func DRX416GEM_halExit 00122 * 00123 * @brief Finalizes the HAL object. 00124 * 00125 * @param halObj. 00126 * Pointer to HAL object. 00127 * 00128 * @return DSP_SOK 00129 * Operation successfully completed. 00130 * DSP_EFAIL 00131 * All other error conditions. 00132 * 00133 * @pre None. 00134 * 00135 * @post None. 00136 * 00137 * @see None 00138 * ============================================================================ 00139 */ 00140 NORMAL_API 00141 DSP_STATUS 00142 DRX416GEM_halExit (IN Pvoid * halObj) ; 00143 00144 00145 #if defined (__cplusplus) 00146 } 00147 #endif 00148 00149 00150 #endif /* !defined (DRX416GEM_HAL_H) */