00001 /** ============================================================================ 00002 * @file dra44xgem_hal.h 00003 * 00004 * @path $(DSPLINK)/gpp/inc/sys/arch/DRA44XGEM/ 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 (DRA44XGEM_HAL_H) 00044 #define DRA44XGEM_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 * @name DRA44XGEM_HalObj 00065 * 00066 * @brief Hardware Abstraction object. 00067 * 00068 * @param interface 00069 * Pointer to HAL interface table. 00070 * @param baseCfgBus 00071 * base address of the configuration bus peripherals memory range. 00072 * @param offsetSysModule 00073 * Offset of the system module from CFG base. 00074 * ============================================================================ 00075 */ 00076 typedef struct DRA44XGEM_HalObj_tag { 00077 HAL_Interface * interface ; 00078 Uint32 baseCfgBus ; 00079 Uint32 offsetSysModule ; 00080 } DRA44XGEM_HalObj ; 00081 00082 00083 /** ============================================================================ 00084 * @func DRA44XGEM_halInitialize 00085 * 00086 * @brief Initializes the HAL object. 00087 * 00088 * @param halObj. 00089 * Pointer to HAL object. 00090 * @param initParams. 00091 * Parameters for initialize (optional). 00092 * 00093 * @return DSP_SOK 00094 * Operation successfully completed. 00095 * DSP_EFAIL 00096 * All other error conditions. 00097 * 00098 * @pre None. 00099 * 00100 * @post None. 00101 * 00102 * @see None 00103 * ============================================================================ 00104 */ 00105 NORMAL_API 00106 DSP_STATUS 00107 DRA44XGEM_halInit (IN Pvoid * halObj, 00108 IN Pvoid initParams) ; 00109 00110 00111 /** ============================================================================ 00112 * @func DRA44XGEM_halExit 00113 * 00114 * @brief Finalizes the HAL object. 00115 * 00116 * @param halObj. 00117 * Pointer to HAL object. 00118 * 00119 * @return DSP_SOK 00120 * Operation successfully completed. 00121 * DSP_EFAIL 00122 * All other error conditions. 00123 * 00124 * @pre None. 00125 * 00126 * @post None. 00127 * 00128 * @see None 00129 * ============================================================================ 00130 */ 00131 NORMAL_API 00132 DSP_STATUS 00133 DRA44XGEM_halExit (IN Pvoid * halObj) ; 00134 00135 00136 #if defined (__cplusplus) 00137 } 00138 #endif 00139 00140 00141 #endif /* !defined (DRA44XGEM_HAL_H) */