00001 /** ============================================================================ 00002 * @file omap2530_hal.h 00003 * 00004 * @path $(DSPLINK)/gpp/inc/sys/arch/OMAP2530/ 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 (OMAP2530_HAL_H) 00044 #define OMAP2530_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 /* ----------------------------------- OSAL Headers */ 00058 #include <osal.h> 00059 00060 00061 00062 #if defined (__cplusplus) 00063 extern "C" { 00064 #endif 00065 00066 00067 /** ============================================================================ 00068 * @name OMAP2530_HalObj 00069 * 00070 * @brief Hardware Abstraction object. 00071 * 00072 * @param interface 00073 * Pointer to HAL interface table. 00074 * @param isrObject 00075 * MMU fault isr object. 00076 * @param generalCtrlBase 00077 * base address of the control module. 00078 * @param mailboxBase 00079 * base address of the mailbox module. 00080 * @param mmuBase 00081 * base address of the MMU module. 00082 * @param prcmBase 00083 * base address of the PRCM module. 00084 * @param tlbIndex 00085 * TLB entry of the MMU module. 00086 * @param procId 00087 * Processor ID. 00088 * @param type 00089 * Flag to verify the static or dynamic entry. 00090 * ============================================================================ 00091 */ 00092 typedef struct OMAP2530_HalObj_tag { 00093 HAL_Interface * interface ; 00094 IsrObject * isrObject ; 00095 Uint32 generalCtrlBase ; 00096 Uint32 mailboxBase ; 00097 Uint32 mmuBase ; 00098 Uint32 prcmBase ; 00099 Uint32 tlbIndex ; 00100 Uint32 procId ; 00101 Bool type ; 00102 } OMAP2530_HalObj ; 00103 00104 00105 /** ============================================================================ 00106 * @func OMAP2530_halInitialize 00107 * 00108 * @brief Initializes the HAL object. 00109 * 00110 * @param halObj. 00111 * Pointer to HAL object. 00112 * @param initParams. 00113 * Parameters for initialize (optional). 00114 * 00115 * @return DSP_SOK 00116 * Operation successfully completed. 00117 * DSP_EFAIL 00118 * All other error conditions. 00119 * 00120 * @pre None. 00121 * 00122 * @post None. 00123 * 00124 * @see None 00125 * ============================================================================ 00126 */ 00127 NORMAL_API 00128 DSP_STATUS 00129 OMAP2530_halInit (IN Pvoid * halObj, 00130 IN Pvoid initParams) ; 00131 00132 00133 /** ============================================================================ 00134 * @func OMAP2530_halExit 00135 * 00136 * @brief Finalizes the HAL object. 00137 * 00138 * @param halObj. 00139 * Pointer to HAL object. 00140 * 00141 * @return DSP_SOK 00142 * Operation successfully completed. 00143 * DSP_EFAIL 00144 * All other error conditions. 00145 * 00146 * @pre None. 00147 * 00148 * @post None. 00149 * 00150 * @see None 00151 * ============================================================================ 00152 */ 00153 NORMAL_API 00154 DSP_STATUS 00155 OMAP2530_halExit (IN Pvoid * halObj) ; 00156 00157 00158 #if defined (__cplusplus) 00159 } 00160 #endif 00161 00162 00163 #endif /* !defined (OMAP2530_HAL_H) */