xref: /utopia/UTPA2-700.0.x/mxlib/include/drvCPU.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 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// @file   drvCPU.h
98 /// @brief  System Control Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_CPU_H_
103 #define _DRV_CPU_H_
104 
105 #include "MsTypes.h"
106 #include "MsDevice.h"
107 
108 #ifdef __cplusplus
109 extern "C"
110 {
111 #endif
112 
113 #define CPU_UTOPIA20       (1)
114 
115 //-------------------------------------------------------------------------------------------------
116 //  Driver Capability
117 //-------------------------------------------------------------------------------------------------
118 
119 //-------------------------------------------------------------------------------------------------
120 //  Macro and Define
121 //-------------------------------------------------------------------------------------------------
122 // #define COPRO_TYPE_DEF
123 /// Version string.
124 
125 #define MSIF_COPRO_LIB_CODE                     {'C','O','P','R'}    //Lib code
126 #define MSIF_COPRO_LIBVER                       {'0','2'}            //LIB version
127 #define MSIF_COPRO_BUILDNUM                     {'1','0'}            //Build Number
128 #define MSIF_COPRO_CHANGELIST                   {'0','0','5','5','7','0','9','3'} //P4 ChangeList Number
129 
130 #define COPRO_DRV_VERSION                       /* Character String for DRV/API version             */  \
131     MSIF_TAG,                             /* 'MSIF'                                           */  \
132     MSIF_CLASS,                           /* '00'                                             */  \
133     MSIF_CUS,                             /* 0x0000                                           */  \
134     MSIF_MOD,                             /* 0x0000                                           */  \
135     MSIF_CHIP,                                                                                  \
136     MSIF_CPU,                                                                                   \
137     MSIF_COPRO_LIB_CODE,                        /* IP__                                             */  \
138     MSIF_COPRO_LIBVER,                          /* 0.0 ~ Z.Z                                        */  \
139     MSIF_COPRO_BUILDNUM,                        /* 00 ~ 99                                          */  \
140     MSIF_COPRO_CHANGELIST,                      /* CL#                                              */  \
141     MSIF_OS
142 
143 
144 //-------------------------------------------------------------------------------------------------
145 //  Type and Structure
146 //-------------------------------------------------------------------------------------------------
147 typedef enum
148 {
149     E_COPRO_OK,
150     E_COPRO_FAIL,
151 } COPRO_Result;
152 
153 typedef struct _COPRO_DrvInfo
154 {
155     MS_BOOL     Init;
156     MS_U32      u32Addr;
157 } COPRO_DrvInfo;
158 
159 
160 typedef struct _COPRO_DrvStatus
161 {
162     MS_BOOL     HwBusy;
163 } COPRO_DrvStatus;
164 
165 typedef enum _COPRO_DbgLv
166 {
167     E_COPRO_DBGLV_NONE,           //no debug message
168     E_COPRO_DBGLV_ERR_ONLY,      //show error only
169     E_COPRO_DBGLV_INFO,          //show error & informaiton
170     E_COPRO_DBGLV_ALL           //show error, information & funciton name
171 }COPRO_DbgLv;
172 
173 typedef enum
174 {
175     Q_PARALLEL,
176     Q_STATE,
177     Q_MPEG2_FS,
178     Q_MPEG2,
179     Q_TSPLAYER_FS,
180     Q_TSPLAYER,
181     Q_VDPLAYER_FS,
182     Q_VDPLAYER,
183     Q_MBFS,
184     Q_IR,
185     Q_OBAMA,
186     Q_PRINT_MESSAGE,
187     Q_CIPLUS,
188     Q_DLNA,
189     Q_BTPD,
190     Q_KTV,
191     Q_SHWFS,
192     Q_APENGINE,
193     Q_MM,
194     Q_MHEG5,
195     Q_NWDEBUG, //add by Ian
196     Q_NUM,
197 } Q_TYPE;
198 
199 //-------------------------------------------------------------------------------------------------
200 //  Function and Variable
201 //-------------------------------------------------------------------------------------------------
202 #if (CPU_UTOPIA20)
203 #include "drvCPU_v2.h"
204 #endif
205 
206     //-------------------------------------------------------------------------------------------------
207     /// Reset and disable coprocessor
208     /// @ingroup DRV_CPU
209     ////-------------------------------------------------------------------------------------------------
210     void MDrv_COPRO_Disable(void);
211     //-------------------------------------------------------------------------------------------------
212     /// Enable coprocessor
213     /// @ingroup DRV_CPU
214     ////-------------------------------------------------------------------------------------------------
215     void MDrv_COPRO_Enable(MS_U32 u32_ADR);
216     //void MDrv_BEON_Init(MS_U16 u16BeonBinID, MS_U32 u32BEON_ADR, MS_U32 u32BEON_LEN);
217     //void MDrv_BEON_Init_ByAddr(MS_U32 u32BEON_ADR, MS_U32 u32BEON_LEN);
218     void  MDrv_SetBEON_Host(MS_BOOL bHost);
219     //-------------------------------------------------------------------------------------------------
220     /// Reset and disable coprocessor
221     /// @ingroup DRV_CPU
222     ////-------------------------------------------------------------------------------------------------
223     void   MDrv_COPRO_Init_Front(void);
224     //-------------------------------------------------------------------------------------------------
225     /// Reset and disable coprocessor
226     /// @ingroup DRV_CPU
227     ////-------------------------------------------------------------------------------------------------
228     void   MDrv_COPRO_Init_End(MS_U32 u32_ADR);
229     //-------------------------------------------------------------------------------------------------
230     /// Get the information of coprocessor
231     /// @ingroup DRV_CPU
232     ////-------------------------------------------------------------------------------------------------
233     const COPRO_DrvInfo* MDrv_COPRO_GetInfo(void);
234     //-------------------------------------------------------------------------------------------------
235     /// Get the version of library version
236     /// @ingroup DRV_CPU
237     ////-------------------------------------------------------------------------------------------------
238     COPRO_Result MDrv_COPRO_GetLibVer(const MSIF_Version **ppVersion);
239     //-------------------------------------------------------------------------------------------------
240     /// The the status of coprocessor
241     /// @ingroup DRV_CPU
242     ////-------------------------------------------------------------------------------------------------
243     COPRO_Result MDrv_COPRO_GetStatus(COPRO_DrvStatus *pStatus);
244     //-------------------------------------------------------------------------------------------------
245     /// Setting the debug level
246     /// @ingroup DRV_CPU
247     void MDrv_COPRO_SetDbgLevel(MS_U8 u8Level);
248     //-------------------------------------------------------------------------------------------------
249     /// Get IO base for H.K.
250     /// @ingroup DRV_CPU
251     ////-------------------------------------------------------------------------------------------------
252     MS_VIRT MDrv_COPRO_GetBase(void);
253     //-------------------------------------------------------------------------------------------------
254     /// Get the clock setting of CPU clock
255     /// @ingroup DRV_CPU
256     ////-------------------------------------------------------------------------------------------------
257     MS_U32 MDrv_CPU_QueryClock(void);
258     //-------------------------------------------------------------------------------------------------
259     /// Set the power status of power
260     /// @ingroup DRV_CPU
261     ////-------------------------------------------------------------------------------------------------
262     MS_U32 MDrv_CPU_SetPowerState(EN_POWER_MODE u16PowerState);
263     //-------------------------------------------------------------------------------------------------
264     /// Get DQ infromation
265     /// @ingroup DRV_CPU
266     ////-------------------------------------------------------------------------------------------------
267 	MS_U32 MDrv_CPU_GetDqmemInfo(MS_U32 *pu32_DqmemAddr, MS_U32 *pu32_DqmemSize);
268 
269 #if !defined(CONFIG_FRC)//frcr2_integration###
270 void MDrv_FRCR2_Init_Front(void);
271 void MDrv_FRCR2_Init_End(MS_U32 u32_ADR);
272 #endif
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 
278 #endif // _DRV_CPU_H_
279 
280