xref: /utopia/UTPA2-700.0.x/mxlib/hal/maxim/halCHIP.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ////////////////////////////////////////////////////////////////////////////////
94 
95 #ifndef _HAL_CHIP_H_
96 #define _HAL_CHIP_H_
97 
98 
99 
100 #ifdef __cplusplus
101 extern "C"
102 {
103 #endif
104 
105 //-------------------------------------------------------------------------------------------------
106 //  Macro and Define
107 //-------------------------------------------------------------------------------------------------
108 
109 typedef enum
110 {
111   E_CHIP_MIU_0 = 0,
112   E_CHIP_MIU_1,
113   E_CHIP_MIU_2,
114   E_CHIP_MIU_3,
115   E_CHIP_MIU_NUM,
116 } CHIP_MIU_ID;
117 
118 #define ARM_CLOCK_FREQ             1008000000
119 #define MIPS_CLOCK_FREQ            900000000
120 #define AEON_CLOCK_FREQ            240000000
121 #define XTAL_CLOCK_FREQ            12000000
122 
123 #define HAL_MIU0_BASE               0x00000000UL
124 #if defined(__AEONR2__)
125 #define HAL_MIU1_BASE               0x40000000UL // 1512MB
126 #define HAL_MIU2_BASE               0xC0000000UL //
127 #else
128 #define HAL_MIU1_BASE               0x80000000UL // 1512MB
129 #define HAL_MIU2_BASE               0xC0000000UL //
130 #endif
131 
132 
133 #define HAL_MIU0_BUS_BASE           0x20000000UL  // MIU0 Low 256MB
134 #define HAL_MIU1_BUS_BASE           0xA0000000UL  // MIU1 Low 256MB MUJI: 0xA0000000UL
135 #define HAL_MIU2_BUS_BASE           0x300000000UL // 64 bit mapping
136 
137 #define _phy_to_miu_offset(MiuSel, Offset, PhysAddr) if (PhysAddr < HAL_MIU1_BASE) \
138                                                         {MiuSel = E_CHIP_MIU_0; Offset = PhysAddr;} \
139                                                      else if ((PhysAddr >= HAL_MIU1_BASE) && (PhysAddr < HAL_MIU2_BASE)) \
140                                                          {MiuSel = E_CHIP_MIU_1; Offset = PhysAddr - HAL_MIU1_BASE;} \
141                                                      else \
142                                                          {MiuSel = E_CHIP_MIU_2; Offset = PhysAddr - HAL_MIU2_BASE;}
143 
144 #define _miu_offset_to_phy(MiuSel, Offset, PhysAddr) if (MiuSel == E_CHIP_MIU_0) \
145                                                         {PhysAddr = Offset;} \
146                                                      else if (MiuSel == E_CHIP_MIU_1) \
147                                                          {PhysAddr = Offset + HAL_MIU1_BASE;} \
148                                                      else \
149                                                          {PhysAddr = Offset + HAL_MIU2_BASE;}
150 
151 #define SUPPORT TRUE
152 #define NONSUPPORT FALSE
153 
154 #define CHIP_IP_MFE SUPPORT
155 #define CHIP_IP_VE SUPPORT
156 #define CHIP_IP_AVD SUPPORT
157 #define CHIP_IP_DEMOD SUPPORT
158 #define CHIP_IP_VBI SUPPORT
159 #define CHIP_IP_VIF SUPPORT
160 #define CHIP_IP_DMX SUPPORT
161 #define CHIP_IP_CEC SUPPORT
162 #define CHIP_IP_MBX SUPPORT
163 #define CHIP_IP_SWI2C SUPPORT
164 #define CHIP_IP_BDMA SUPPORT
165 #define CHIP_IP_CPU SUPPORT
166 #define CHIP_IP_GPIO SUPPORT
167 #define CHIP_IP_HWI2C SUPPORT
168 #define CHIP_IP_IR SUPPORT
169 #define CHIP_IP_MIU SUPPORT
170 #define CHIP_IP_MPIF NONSUPPORT
171 #define CHIP_IP_MSPI SUPPORT
172 #define CHIP_IP_PM SUPPORT
173 #define CHIP_IP_PWM SUPPORT
174 #define CHIP_IP_PWS SUPPORT
175 #define CHIP_IP_RTC SUPPORT
176 #define CHIP_IP_SAR SUPPORT
177 #define CHIP_IP_URDMA SUPPORT
178 #define CHIP_IP_WDT SUPPORT
179 #define CHIP_IP_AESDMA SUPPORT
180 #define CHIP_IP_CA NONSUPPORT
181 #define CHIP_IP_PCMCIA SUPPORT
182 #define CHIP_IP_SC SUPPORT
183 #define CHIP_IP_GPD SUPPORT
184 #define CHIP_IP_JPEG SUPPORT
185 #define CHIP_IP_VDEC SUPPORT
186 #define CHIP_IP_ACE SUPPORT
187 #define CHIP_IP_DAC NONSUPPORT
188 #define CHIP_IP_DDC2BI SUPPORT
189 #define CHIP_IP_DIP SUPPORT
190 #define CHIP_IP_DLC SUPPORT
191 #define CHIP_IP_GOP SUPPORT
192 #define CHIP_IP_HDMITX NONSUPPORT
193 #define CHIP_IP_MHL SUPPORT
194 #define CHIP_IP_MVOP SUPPORT
195 #define CHIP_IP_PNL SUPPORT
196 #define CHIP_IP_XC SUPPORT
197 #define CHIP_IP_GFX SUPPORT
198 #define CHIP_IP_AUDIO SUPPORT
199 #define CHIP_IP_SERFLASH SUPPORT
200 
201 //-------------------------------------------------------------------------------------------------
202 //  Type and Structure
203 //-------------------------------------------------------------------------------------------------
204 
205 
206 //-------------------------------------------------------------------------------------------------
207 //  Function and Variable
208 //-------------------------------------------------------------------------------------------------
209 void    CHIP_InitISR(void);
210 MS_BOOL CHIP_InISRContext(void);
211 MS_BOOL CHIP_AttachISR(InterruptNum eIntNum, InterruptCb pIntCb);
212 MS_BOOL CHIP_DetachISR(InterruptNum eIntNum);
213 MS_BOOL CHIP_EnableIRQ(InterruptNum eIntNum);
214 MS_BOOL CHIP_DisableIRQ(InterruptNum eIntNum);
215 MS_BOOL CHIP_EnableAllInterrupt(void);
216 MS_BOOL CHIP_DisableAllInterrupt(void);
217 MS_BOOL CHIP_DebugIRQ(InterruptNum eIntNum, IrqDebugOpt eIrqDebugOpt);
218 MS_BOOL CHIP_CompleteIRQ(InterruptNum eIntNum);
219 
220 
221 #ifdef __cplusplus
222 }
223 #endif
224 
225 #endif // _HAL_CHIP_H_
226 
227