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 drvBDMA_v2.h 98 /// @brief MIU Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef _DRV_BDMA_V2_H_ 103 #define _DRV_BDMA_V2_H_ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 #include "UFO.h" 111 //------------------------------------------------------------------------------------------------- 112 // Defines 113 //------------------------------------------------------------------------------------------------- 114 // below for utopia20 structure 115 116 typedef enum { 117 MDrv_CMD_BDMA_MemCopy, 118 MDrv_CMD_BDMA_Search, 119 MDrv_CMD_BDMA_CRC32, 120 MDrv_CMD_BDMA_Pattern_Fill, 121 MDrv_CMD_BDMA_FlashCopy2Dram, 122 MDrv_CMD_BDMA_MOBFSearch, 123 MDrv_CMD_BDMA_GetStatus, 124 MDrv_CMD_BDMA_GetInfo, 125 MDrv_CMD_BDMA_GetLibVer, 126 MDrv_CMD_BDMA_GetMinSize, 127 MDrv_CMD_BDMA_SetDbgLevel, 128 MDrv_CMD_BDMA_SetSPIOffsetForMCU, 129 MDrv_CMD_BDMA_WaitFlashDone, 130 MDrv_CMD_BDMA_Init, 131 MDrv_CMD_BDMA_CopyHnd, 132 } eBdmaIoctlOpt; 133 134 ////////////////////////////////////////////////////////////// 135 136 //------------------------------------------------------------------------------------------------- 137 // Macros 138 //------------------------------------------------------------------------------------------------- 139 140 141 //------------------------------------------------------------------------------------------------- 142 // Type and Structure Declaration 143 //------------------------------------------------------------------------------------------------- 144 typedef struct _BDMA_API_V1 145 { 146 }BDMA_API_V1; 147 148 typedef struct _BDMA_API_V2 149 { 150 }BDMA_API_V2; 151 152 #ifdef BIFROST_32BIT_MODE 153 // below are for utopia20 cmd and parameters structure 154 typedef struct _BDMA_INIT_PARAM 155 { 156 MS_U32 u64Miu1Base; 157 }BDMA_INIT_PARAM, *PBDMA_INIT_PARAM; 158 // for cmd MDrv_CMD_BDMA_MemCopy 159 typedef struct _BDMA_MEMCOPY_PARAM 160 { 161 MS_U32 phy64SrcAddr; 162 MS_U32 phy64DstAddr; 163 MS_U32 u32Len; 164 }BDMA_MEMCOPY_PARAM, *PBDMA_MEMCOPY_PARAM; 165 166 // for cmd MDrv_CMD_BDMA_Search 167 typedef struct DLL_PACKED _BDMA_SEARCH_PARAM 168 { 169 MS_PHYADDR u32Addr; 170 MS_U32 u32Len; 171 MS_U32 u32Pattern; 172 MS_U32 u32ExcluBit; 173 BDMA_SrcDev eDev; 174 #if defined(UFO_PUBLIC_HEADER_212) || defined(UFO_PUBLIC_HEADER_300) || defined(UFO_PUBLIC_HEADER_500) || defined(UFO_PUBLIC_HEADER_500_3) 175 MS_U32* pSearchAddr; 176 #else 177 MS_U32 pSearchAddr; 178 #endif 179 }BDMA_SEARCH_PARAM, *PBDMA_SEARCH_PARAM; 180 181 // for cmd MDrv_CMD_BDMA_CRC32 182 typedef struct _BDMA_CRC32_PARAM 183 { 184 MS_U32 phy64Addr; 185 MS_U32 u32Len; 186 MS_U32 u32Poly; 187 MS_U32 u32Seed; 188 BDMA_SrcDev eDev; 189 MS_BOOL bReflect; 190 MS_U32 u32CRC32; 191 }BDMA_CRC32_PARAM, *PBDMA_CRC32_PARAM; 192 193 // for cmd MDrv_CMD_BDMA_Pattern_Fill 194 typedef struct _BDMA_PATTERN_FILL_PARAM 195 { 196 MS_PHYADDR u32Addr; 197 MS_U32 u32Len; 198 MS_U32 u32Pattern; 199 BDMA_DstDev eDev; 200 }BDMA_PATTERN_FILL_PARAM, *PBDMA_PATTERN_FILL_PARAM; 201 202 // for cmd MDrv_CMD_BDMA_FlashCopy2Dram 203 typedef struct DLL_PACKED _BDMA_FLASHCOPY2DRAM_PARAM 204 { 205 MS_PHYADDR u32FlashAddr; 206 MS_PHYADDR u32DramAddr; 207 MS_U32 u32Len; 208 }BDMA_FLASHCOPY2DRAM_PARAM, *PBDMA_FLASHCOPY2DRAM_PARAM; 209 210 // for cmd MDrv_CMD_BDMA_CopyHnd 211 typedef struct DLL_PACKED _BDMA_COPYHND_PARAM 212 { 213 MS_U32 phy64SrcAddr; 214 MS_U32 phy64DstAddr; 215 MS_U32 u32Len; 216 BDMA_CpyType eCpyType; 217 MS_U8 u8OpCfg; 218 }BDMA_COPYHND_PARAM, *PBDMA_COPYHND_PARAM; 219 220 // for cmd MDrv_CMD_BDMA_MOBFSearch 221 #ifdef MOBF_ENABLE 222 typedef struct DLL_PACKED _BDMA_MOBFSEARCH_PARAM 223 { 224 MS_U32 phy64Addr; 225 MS_U32 u32Len; 226 BDMA_MOBF_PS* pMobfPsCfg; 227 BDMA_SrcDev eDev; 228 MS_U32 phy64SearchAddr; 229 }BDMA_MOBFSEARCH_PARAM, *PBDMA_MOBFSEARCH_PARAM; 230 #endif 231 #else 232 // below are for utopia20 cmd and parameters structure 233 typedef struct _BDMA_INIT_PARAM 234 { 235 MS_PHY u64Miu1Base; 236 }BDMA_INIT_PARAM, *PBDMA_INIT_PARAM; 237 // for cmd MDrv_CMD_BDMA_MemCopy 238 typedef struct _BDMA_MEMCOPY_PARAM 239 { 240 MS_PHY phy64SrcAddr; 241 MS_PHY phy64DstAddr; 242 MS_U32 u32Len; 243 }BDMA_MEMCOPY_PARAM, *PBDMA_MEMCOPY_PARAM; 244 245 // for cmd MDrv_CMD_BDMA_Search 246 typedef struct DLL_PACKED _BDMA_SEARCH_PARAM 247 { 248 MS_PHYADDR u32Addr; 249 MS_U32 u32Len; 250 MS_U32 u32Pattern; 251 MS_U32 u32ExcluBit; 252 BDMA_SrcDev eDev; 253 #if defined(UFO_PUBLIC_HEADER_212) || defined(UFO_PUBLIC_HEADER_300) || defined(UFO_PUBLIC_HEADER_500) || defined(UFO_PUBLIC_HEADER_500_3) 254 MS_U32* pSearchAddr; 255 #else 256 MS_U32 pSearchAddr; 257 #endif 258 }BDMA_SEARCH_PARAM, *PBDMA_SEARCH_PARAM; 259 260 // for cmd MDrv_CMD_BDMA_CRC32 261 typedef struct _BDMA_CRC32_PARAM 262 { 263 MS_PHY phy64Addr; 264 MS_U32 u32Len; 265 MS_U32 u32Poly; 266 MS_U32 u32Seed; 267 BDMA_SrcDev eDev; 268 MS_BOOL bReflect; 269 MS_U32 u32CRC32; 270 }BDMA_CRC32_PARAM, *PBDMA_CRC32_PARAM; 271 272 // for cmd MDrv_CMD_BDMA_Pattern_Fill 273 typedef struct _BDMA_PATTERN_FILL_PARAM 274 { 275 MS_PHYADDR u32Addr; 276 MS_U32 u32Len; 277 MS_U32 u32Pattern; 278 BDMA_DstDev eDev; 279 }BDMA_PATTERN_FILL_PARAM, *PBDMA_PATTERN_FILL_PARAM; 280 281 // for cmd MDrv_CMD_BDMA_FlashCopy2Dram 282 typedef struct DLL_PACKED _BDMA_FLASHCOPY2DRAM_PARAM 283 { 284 MS_PHYADDR u32FlashAddr; 285 MS_PHYADDR u32DramAddr; 286 MS_U32 u32Len; 287 }BDMA_FLASHCOPY2DRAM_PARAM, *PBDMA_FLASHCOPY2DRAM_PARAM; 288 289 // for cmd MDrv_CMD_BDMA_CopyHnd 290 typedef struct DLL_PACKED _BDMA_COPYHND_PARAM 291 { 292 MS_PHY phy64SrcAddr; 293 MS_PHY phy64DstAddr; 294 MS_U32 u32Len; 295 BDMA_CpyType eCpyType; 296 MS_U8 u8OpCfg; 297 }BDMA_COPYHND_PARAM, *PBDMA_COPYHND_PARAM; 298 299 // for cmd MDrv_CMD_BDMA_MOBFSearch 300 #ifdef MOBF_ENABLE 301 typedef struct DLL_PACKED _BDMA_MOBFSEARCH_PARAM 302 { 303 MS_PHY phy64Addr; 304 MS_U32 u32Len; 305 BDMA_MOBF_PS* pMobfPsCfg; 306 BDMA_SrcDev eDev; 307 MS_PHY phy64SearchAddr; 308 }BDMA_MOBFSEARCH_PARAM, *PBDMA_MOBFSEARCH_PARAM; 309 #endif 310 #endif 311 312 // for cmd MDrv_CMD_BDMA_GetStatus 313 typedef struct DLL_PACKED _BDMA_GETSTATUS_PARAM 314 { 315 BDMA_Status *pStatus; 316 }BDMA_GETSTATUS_PARAM, *PBDMA_GETSTATUS_PARAM; 317 318 319 // for cmd MDrv_CMD_BDMA_GetInfo 320 typedef struct _BDMA_GETINFO_PARAM 321 { 322 MS_U8 u8ChNum; 323 MS_U16 u16ChipVer; 324 MS_U32 u32IOMap; 325 MS_U32 u32MIU1Base; 326 MS_S32 s32Mutex; 327 MS_BOOL bInit; 328 BDMA_DbgLv eDbgLv; 329 BDMA_HwInfo sHwCap; 330 }BDMA_GETINFO_PARAM, *PBDMA_GETINFO_PARAM; 331 332 // for cmd MDrv_CMD_BDMA_GetLibVer 333 typedef struct DLL_PACKED _BDMA_GETLIBVER_PARAM 334 { 335 const MSIF_Version **ppVersion; 336 }BDMA_GETLIBVER_PARAM, *PBDMA_GETLIBVER_PARAM; 337 338 // for cmd MDrv_CMD_BDMA_GetMinSize 339 typedef struct _BDMA_GETMINSIZE_PARAM 340 { 341 MS_U32 u32MinSize; 342 }BDMA_GETMINSIZE_PARAM, *PBDMA_GETMINSIZE_PARAM; 343 344 // for cmd MDrv_CMD_BDMA_SetDbgLevel 345 typedef struct _BDMA_SETDBGLEVEL_PARAM 346 { 347 BDMA_DbgLv eLevel; 348 }BDMA_SETDBGLEVEL_PARAM, *PBDMA_SETDBGLEVEL_PARAM; 349 350 //------------------------------------------------------------------------------------------------- 351 // Extern Global Variabls 352 //------------------------------------------------------------------------------------------------- 353 354 //------------------------------------------------------------------------------------------------- 355 // Extern Functions 356 //------------------------------------------------------------------------------------------------- 357 358 ////////////////////////////////////////////////////////////// 359 360 #ifdef __cplusplus 361 } 362 #endif 363 364 #endif // _DRV_BDMA_V2_H_ 365 366