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 //------------------------------------------------------------------------------------------------- 111 // Defines 112 //------------------------------------------------------------------------------------------------- 113 // below for utopia20 structure 114 115 typedef enum { 116 MDrv_CMD_BDMA_MemCopy, 117 MDrv_CMD_BDMA_Search, 118 MDrv_CMD_BDMA_CRC32, 119 MDrv_CMD_BDMA_Pattern_Fill, 120 MDrv_CMD_BDMA_FlashCopy2Dram, 121 MDrv_CMD_BDMA_MOBFSearch, 122 MDrv_CMD_BDMA_GetStatus, 123 MDrv_CMD_BDMA_GetInfo, 124 MDrv_CMD_BDMA_GetLibVer, 125 MDrv_CMD_BDMA_GetMinSize, 126 MDrv_CMD_BDMA_SetDbgLevel, 127 MDrv_CMD_BDMA_SetSPIOffsetForMCU, 128 MDrv_CMD_BDMA_WaitFlashDone, 129 } eBdmaIoctlOpt; 130 131 ////////////////////////////////////////////////////////////// 132 133 //------------------------------------------------------------------------------------------------- 134 // Macros 135 //------------------------------------------------------------------------------------------------- 136 137 138 //------------------------------------------------------------------------------------------------- 139 // Type and Structure Declaration 140 //------------------------------------------------------------------------------------------------- 141 typedef struct _BDMA_API_V1 142 { 143 }BDMA_API_V1; 144 145 typedef struct _BDMA_API_V2 146 { 147 }BDMA_API_V2; 148 149 // below are for utopia20 cmd and parameters structure 150 // for cmd MDrv_CMD_BDMA_MemCopy 151 typedef struct _BDMA_MEMCOPY_PARAM 152 { 153 MS_PHY phy64SrcAddr; 154 MS_PHY phy64DstAddr; 155 MS_U32 u32Len; 156 }BDMA_MEMCOPY_PARAM, *PBDMA_MEMCOPY_PARAM; 157 158 // for cmd MDrv_CMD_BDMA_Search 159 typedef struct _BDMA_SEARCH_PARAM 160 { 161 MS_PHYADDR u32Addr; 162 MS_U32 u32Len; 163 MS_U32 u32Pattern; 164 MS_U32 u32ExcluBit; 165 BDMA_SrcDev eDev; 166 MS_U32* pSearchAddr; 167 }BDMA_SEARCH_PARAM, *PBDMA_SEARCH_PARAM; 168 169 // for cmd MDrv_CMD_BDMA_CRC32 170 typedef struct _BDMA_CRC32_PARAM 171 { 172 MS_PHY phy64Addr; 173 MS_U32 u32Len; 174 MS_U32 u32Poly; 175 MS_U32 u32Seed; 176 BDMA_SrcDev eDev; 177 MS_BOOL bReflect; 178 MS_U32 u32CRC32; 179 }BDMA_CRC32_PARAM, *PBDMA_CRC32_PARAM; 180 181 // for cmd MDrv_CMD_BDMA_Pattern_Fill 182 typedef struct _BDMA_PATTERN_FILL_PARAM 183 { 184 MS_PHYADDR u32Addr; 185 MS_U32 u32Len; 186 MS_U32 u32Pattern; 187 BDMA_DstDev eDev; 188 }BDMA_PATTERN_FILL_PARAM, *PBDMA_PATTERN_FILL_PARAM; 189 190 // for cmd MDrv_CMD_BDMA_FlashCopy2Dram 191 typedef struct _BDMA_FLASHCOPY2DRAM_PARAM 192 { 193 MS_PHYADDR u32FlashAddr; 194 MS_PHYADDR u32DramAddr; 195 MS_U32 u32Len; 196 }BDMA_FLASHCOPY2DRAM_PARAM, *PBDMA_FLASHCOPY2DRAM_PARAM; 197 198 // for cmd MDrv_CMD_BDMA_MOBFSearch 199 #ifdef MOBF_ENABLE 200 typedef struct _BDMA_MOBFSEARCH_PARAM 201 { 202 MS_PHY phy64Addr; 203 MS_U32 u32Len; 204 BDMA_MOBF_PS* pMobfPsCfg; 205 BDMA_SrcDev eDev; 206 MS_PHY phy64SearchAddr; 207 }BDMA_MOBFSEARCH_PARAM, *PBDMA_MOBFSEARCH_PARAM; 208 #endif 209 210 // for cmd MDrv_CMD_BDMA_GetStatus 211 typedef struct _BDMA_GETSTATUS_PARAM 212 { 213 BDMA_Status *pStatus; 214 }BDMA_GETSTATUS_PARAM, *PBDMA_GETSTATUS_PARAM; 215 216 217 // for cmd MDrv_CMD_BDMA_GetInfo 218 typedef struct _BDMA_GETINFO_PARAM 219 { 220 MS_U8 u8ChNum; 221 MS_U16 u16ChipVer; 222 MS_U32 u32IOMap; 223 MS_U32 u32MIU1Base; 224 MS_S32 s32Mutex; 225 MS_BOOL bInit; 226 BDMA_DbgLv eDbgLv; 227 BDMA_HwInfo sHwCap; 228 }BDMA_GETINFO_PARAM, *PBDMA_GETINFO_PARAM; 229 230 // for cmd MDrv_CMD_BDMA_GetLibVer 231 typedef struct _BDMA_GETLIBVER_PARAM 232 { 233 const MSIF_Version **ppVersion; 234 }BDMA_GETLIBVER_PARAM, *PBDMA_GETLIBVER_PARAM; 235 236 // for cmd MDrv_CMD_BDMA_GetMinSize 237 typedef struct _BDMA_GETMINSIZE_PARAM 238 { 239 MS_U32 u32MinSize; 240 }BDMA_GETMINSIZE_PARAM, *PBDMA_GETMINSIZE_PARAM; 241 242 // for cmd MDrv_CMD_BDMA_SetDbgLevel 243 typedef struct _BDMA_SETDBGLEVEL_PARAM 244 { 245 BDMA_DbgLv eLevel; 246 }BDMA_SETDBGLEVEL_PARAM, *PBDMA_SETDBGLEVEL_PARAM; 247 248 //------------------------------------------------------------------------------------------------- 249 // Extern Global Variabls 250 //------------------------------------------------------------------------------------------------- 251 252 //------------------------------------------------------------------------------------------------- 253 // Extern Functions 254 //------------------------------------------------------------------------------------------------- 255 256 ////////////////////////////////////////////////////////////// 257 258 #ifdef __cplusplus 259 } 260 #endif 261 262 #endif // _DRV_BDMA_V2_H_ 263 264