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 drvMIU_v2.h 98 /// @brief MIU Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef _DRV_MIU_V2_H_ 103 #define _DRV_MIU_V2_H_ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 #include "MsTypes.h" 111 #include "UFO.h" 112 113 //------------------------------------------------------------------------------------------------- 114 // Defines 115 //------------------------------------------------------------------------------------------------- 116 typedef enum _eMIUIoctlCmd 117 { 118 MDrv_CMD_MIU_Init, 119 MDrv_CMD_MIU_Mask_Req_OPM_R, 120 MDrv_CMD_MIU_Mask_Req_DNRB_R, 121 MDrv_CMD_MIU_Mask_Req_DNRB_W, 122 MDrv_CMD_MIU_Mask_Req_DNRB_RW, 123 MDrv_CMD_MIU_Mask_Req_SC_RW, 124 MDrv_CMD_MIU_Mask_Req_MVOP_R, 125 MDrv_CMD_MIU_Mask_Req_MVD_R, 126 MDrv_CMD_MIU_Mask_Req_MVD_W, 127 MDrv_CMD_MIU_Mask_Req_MVD_RW, 128 MDrv_CMD_MIU_Mask_Req_AUDIO_RW, 129 MDrv_CMD_MIU_Mask_Req, 130 MDrv_CMD_MIU_UnMask_Req, 131 MDrv_CMD_MIU_SetSsc, 132 MDrv_CMD_MIU_SetSscValue, 133 MDrv_CMD_MIU_Protect, 134 MDrv_CMD_MIU_ProtectEx, 135 MDrv_CMD_MIU_SelMIU, 136 MDrv_CMD_MIU_GetProtectInfo, 137 MDrv_CMD_MIU_SetGroupPriority, 138 MDrv_CMD_MIU_SetHighPriority, 139 MDrv_CMD_MIU_PrintProtectInfo, 140 MDrv_CMD_MIU_Dram_Size, 141 MDrv_CMD_MIU_ProtectAlign, 142 MDrv_CMD_MIU_GetDramType, 143 144 }eMIUIoctlCmd; 145 146 //------------------------------------------------------------------------------------------------- 147 // Macros 148 //------------------------------------------------------------------------------------------------- 149 150 151 //------------------------------------------------------------------------------------------------- 152 // Type and Structure Declaration 153 //------------------------------------------------------------------------------------------------- 154 155 //------------------------------------------------------------------------------------------------- 156 // Extern Global Variabls 157 //------------------------------------------------------------------------------------------------- 158 159 //------------------------------------------------------------------------------------------------- 160 // Extern Functions 161 //------------------------------------------------------------------------------------------------- 162 163 ////////////////////////////////////////////////////////////// 164 // below are for utopia20 cmd and parameters structure 165 // for below cmds 166 // MDrv_CMD_MIU_Mask_Req_OPM_R, 167 // MDrv_CMD_MIU_Mask_Req_DNRB_R, 168 // MDrv_CMD_MIU_Mask_Req_DNRB_W, 169 // MDrv_CMD_MIU_Mask_Req_DNRB_RW, 170 // MDrv_CMD_MIU_Mask_Req_SC_RW, 171 // MDrv_CMD_MIU_Mask_Req_MVOP_R, 172 // MDrv_CMD_MIU_Mask_Req_MVD_R, 173 // MDrv_CMD_MIU_Mask_Req_MVD_W, 174 // MDrv_CMD_MIU_Mask_Req_MVD_RW, 175 // MDrv_CMD_MIU_Mask_Req_AUDIO_RW, 176 177 typedef struct _MIU_RET 178 { 179 MS_BOOL bRet; 180 }MIU_RET, *PMIU_RET; 181 182 typedef struct _MIU_MASK 183 { 184 MS_U8 u8Mask; 185 MS_U8 u8Miu; 186 }MIU_MIU_MASK, *PMIU_MIU_MASK; 187 188 // for below cmds MDrv_CMD_MIU_Mask_Req, MDrv_CMD_MIU_UnMask_Req 189 typedef struct _MIU_MIUREQ_MASK 190 { 191 MS_U8 u8Miu; 192 eMIUClientID eClientID; 193 }MIU_MIUREQ_MASK, *PMIU_MIUREQ_MASK; 194 195 // for below cmds MDrv_CMD_MIU_SetSsc 196 typedef struct _MIU_SET_SSC 197 { 198 MS_U16 u16Fmodulation; 199 MS_U16 u16FDeviation; 200 MS_BOOL bEnable; 201 MS_BOOL bRet; 202 }MIU_SET_SSC, *PMIU_SET_SSC; 203 204 // for below cmds MDrv_CMD_MIU_SetSscValue 205 typedef struct _MIU_SET_SSCVALUE 206 { 207 MS_U8 u8MiuDev; 208 MS_U16 u16Fmodulation; 209 MS_U16 u16FDeviation; 210 MS_BOOL bEnable; 211 MS_BOOL bRet; 212 }MIU_SET_SSCVALUE, *PMIU_SET_SSCVALUE; 213 214 // for below cmds MDrv_CMD_MIU_Protect 215 216 typedef MS_U8 MIU_PROYECT_ID[16]; 217 218 #ifdef BIFROST_32BIT_MODE 219 typedef struct DLL_PACKED _MIU_PROTECT 220 { 221 MS_U8 u8Blockx; 222 MS_U8 *pu8ProtectId; 223 #if defined(UFO_PUBLIC_HEADER_212)||defined(UFO_PUBLIC_HEADER_300) 224 MS_U32 u32Start; 225 MS_U32 u32End; 226 #else 227 MS_U32 phy64Start; 228 MS_U32 phy64End; 229 #endif 230 MS_BOOL bSetFlag; 231 MS_BOOL bRet; 232 }MIU_PROTECT, *PMIU_PROTECT; 233 #else 234 typedef struct DLL_PACKED _MIU_PROTECT 235 { 236 MS_U8 u8Blockx; 237 MS_U8 *pu8ProtectId; 238 #if defined(UFO_PUBLIC_HEADER_212)||defined(UFO_PUBLIC_HEADER_300) 239 MS_U32 u32Start; 240 MS_U32 u32End; 241 #else 242 MS_PHY phy64Start; 243 MS_PHY phy64End; 244 #endif 245 MS_BOOL bSetFlag; 246 MS_BOOL bRet; 247 }MIU_PROTECT, *PMIU_PROTECT; 248 #endif 249 250 // for below cmds MDrv_CMD_MIU_ProtectEx 251 typedef struct _MIU_PROTECTEx 252 { 253 MS_U8 u8Blockx; 254 MS_U32 *pu32ProtectId; 255 MS_PHY phy64Start; 256 MS_PHY phy64End; 257 MS_BOOL bSetFlag; 258 }MIU_PROTECTEx, *PMIU_PROTECTEx; 259 260 261 // for below cmds MDrv_CMD_MIU_SelMIU 262 typedef struct _MIU_SELMIU 263 { 264 eMIUClientID eClientID; 265 eMIU_SelType eType; 266 MS_BOOL bRet; 267 }MIU_SELMIU, *PMIU_SELMIU; 268 269 // for below cmds MDrv_CMD_MIU_GetDramType 270 typedef struct _MIU_GETDRAMTYPE 271 { 272 MIU_ID eMiu; 273 MIU_DDR_TYPE* pType; 274 }MIU_GETDRAMTYPE, *PMIU_GETDRAMTYPE; 275 276 // for below cmds MDrv_CMD_MIU_GetProtectInfo 277 typedef struct DLL_PACKED _MIU_GETPROTECTINFO 278 { 279 MS_U8 u8MiuDev; 280 MIU_PortectInfo *pInfo; 281 MS_BOOL bRet; 282 }MIU_GETPROTECTINFO, *PMIU_GETPROTECTINFO; 283 284 // for below cmds MDrv_CMD_MIU_SetGroupPriority 285 typedef struct _MIU_SETGROUPPRIORITY 286 { 287 MS_U8 u8MiuDev; 288 MIU_GroupPriority sPriority; 289 MS_BOOL bRet; 290 }MIU_SETGROUPPRIORITY, *PMIU_SETGROUPPRIORITY; 291 292 293 // for below cmds MDrv_CMD_MIU_SetHighPriority 294 typedef struct _MIU_SETHIGHPRIORITY 295 { 296 MS_U8 u8MiuDev; 297 eMIUClientID eClientID; 298 MS_BOOL bMask; 299 MS_BOOL bRet; 300 }MIU_SETHIGHPRIORITY, *PMIU_SETHIGHPRIORITY; 301 302 // for below cmds MDrv_CMD_MIU_Dram_Size 303 typedef struct _MIU_DRAM_SIZE 304 { 305 MS_U8 u8MiuDev; 306 MS_U8 DramSize; 307 MS_BOOL bRet; 308 }MIU_DRAM_SIZE, *PMIU_DRAM_SIZE; 309 310 // for below cmds MDrv_CMD_MIU_ProtectAlign 311 typedef struct DLL_PACKED _MIU_PROTECT_ALIGN 312 { 313 MS_U32 *u32PageShift; 314 MS_BOOL bRet; 315 }MIU_PROTECT_ALIGN, *PMIU_PROTECT_ALIGN; 316 317 #ifdef __cplusplus 318 } 319 #endif 320 321 #endif // _DRV_MIU_V2_H_ 322 323