xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvCPU_v2.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) 2006-2007 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_v2.h
98 /// @brief  MIU Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_CPU_V2_H_
103 #define _DRV_CPU_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 //-------------------------------------------------------------------------------------------------
111 // Defines
112 //-------------------------------------------------------------------------------------------------
113 // below for utopia20 structure
114 
115 typedef enum {
116     MDrv_CMD_CPU_InitFront,
117     MDrv_CMD_CPU_InitEnd,
118     MDrv_CMD_CPU_Disable,
119     MDrv_CMD_CPU_Enable,
120     MDrv_CMD_CPU_SetHost,
121     MDrv_CMD_CPU_GetInfo,
122     MDrv_CMD_CPU_GetLibVer,
123     MDrv_CMD_CPU_GetStatus,
124     MDrv_CMD_CPU_SetDbgLevel,
125     MDrv_CMD_CPU_GetBase,
126     MDrv_CMD_CPU_QueryClock,
127 } eCPUIoctlOpt;
128 
129 typedef enum
130 {
131     CPU_MODULE_V1,
132     CPU_MODULE_V2,
133 } eCPUModuleVersion;
134 
135 //////////////////////////////////////////////////////////////
136 
137 //-------------------------------------------------------------------------------------------------
138 // Macros
139 //-------------------------------------------------------------------------------------------------
140 
141 
142 //-------------------------------------------------------------------------------------------------
143 // Type and Structure Declaration
144 //-------------------------------------------------------------------------------------------------
145 typedef struct _CPU_API_V1
146 {
147 }CPU_API_V1;
148 
149 typedef struct _CPU_API_V2
150 {
151 }CPU_API_V2;
152 
153 // below are for utopia20 cmd and parameters structure
154 // for cmd MDrv_COPRO_Init_End
155 typedef struct _CPU_INITEND_PARAM
156 {
157     MS_U32 u32_ADR;
158 }CPU_INITEND_PARAM, *PCPU_INITEND_PARAM;
159 
160 // for cmd MDrv_COPRO_Enable
161 typedef struct _CPU_ENABLE_PARAM
162 {
163     MS_U32 u32_ADR;
164 }CPU_ENABLE_PARAM, *PCPU_ENABLE_PARAM;
165 
166 // for cmd MDrv_SetBEON_Host
167 typedef struct _CPU_SETHOST_PARAM
168 {
169     MS_BOOL bHost;
170 }CPU_SETHOST_PARAM, *PCPU_SETHOST_PARAM;
171 
172 // for cmd MDrv_COPRO_GetLibVer
173 typedef struct _CPU_GETLIBVER_PARAM
174 {
175     const MSIF_Version **ppVersion;
176 }CPU_GETLIBVER_PARAM, *PCPU_GETLIBVER_PARAM;
177 
178 // for cmd MDrv_COPRO_GetStatus
179 typedef struct _CPU_GETSTATUS_PARAM
180 {
181     COPRO_DrvStatus *pStatus;
182 }CPU_GETSTATUS_PARAM, *PCPU_GETSTATUS_PARAM;
183 
184 // for cmd MDrv_COPRO_SetDbgLevel
185 typedef struct _CPU_SETDBGLEVEL_PARAM
186 {
187     MS_U8 u8Level;
188 }CPU_SETDBGLEVEL_PARAM, *PCPU_SETDBGLEVEL_PARAM;
189 
190 // for cmd MDrv_COPRO_GetInfo
191 typedef struct _CPU_GETINFO_PARAM
192 {
193     MS_BOOL     bInit;
194     MS_U32      u32Addr;
195 }CPU_GETINFO_PARAM, *PCPU_GETINFO_PARAM;
196 
197 //-------------------------------------------------------------------------------------------------
198 // Extern Global Variabls
199 //-------------------------------------------------------------------------------------------------
200 
201 //-------------------------------------------------------------------------------------------------
202 // Extern Functions
203 //-------------------------------------------------------------------------------------------------
204 
205 //////////////////////////////////////////////////////////////
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 
211 #endif // _DRV_CPU_V2_H_
212 
213