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_SERFLASH_V2_H_ 103 #define _DRV_SERFLASH_V2_H_ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 //------------------------------------------------------------------------------------------------- 111 // Defines 112 //------------------------------------------------------------------------------------------------- 113 // below for utopia20 structure 114 115 116 typedef enum { 117 MDrv_CMD_SERFLASH_GetInfo, 118 MDrv_CMD_SERFLASH_GetLibVer, 119 MDrv_CMD_SERFLASH_GetStatus, 120 MDrv_CMD_SERFLASH_SetDbgLevel, 121 MDrv_CMD_SERFLASH_SetWPInfo, 122 MDrv_CMD_SERFLASH_SetMcuCSCallBack, 123 MDrv_CMD_SERFLASH_SetFlashWPCallBack, 124 MDrv_CMD_SERFLASH_DetectType, 125 MDrv_CMD_SERFLASH_DetectSize, 126 MDrv_CMD_SERFLASH_Set2XRead, 127 MDrv_CMD_SERFLASH_SetCKG, 128 MDrv_CMD_SERFLASH_ClkDiv, 129 MDrv_CMD_SERFLASH_SetMode, 130 MDrv_CMD_SERFLASH_ReadUID, 131 MDrv_CMD_SERFLASH_ChipSelect, 132 MDrv_CMD_SERFLASH_Init, 133 MDrv_CMD_SERFLASH_ReadID, 134 MDrv_CMD_SERFLASH_Read, 135 MDrv_CMD_SERFLASH_EraseChip, 136 MDrv_CMD_SERFLASH_AddressToBlock, 137 MDrv_CMD_SERFLASH_BlockToAddress, 138 MDrv_CMD_SERFLASH_AddressErase, 139 MDrv_CMD_SERFLASH_BlockErase, 140 MDrv_CMD_SERFLASH_SectorErase, 141 MDrv_CMD_SERFLASH_CheckWriteDone, 142 MDrv_CMD_SERFLASH_Write, 143 MDrv_CMD_SERFLASH_DMA, 144 MDrv_CMD_SERFLASH_WriteProtect, 145 MDrv_CMD_SERFLASH_WriteProtect_Enable_All_Range, 146 MDrv_CMD_SERFLASH_WriteProtect_Disable_All_Range, 147 MDrv_CMD_SERFLASH_WriteProtect_Disable_Range_Set, 148 MDrv_CMD_SERFLASH_WriteProtect_Area, 149 MDrv_CMD_SERFLASH_ReadStatusRegister, 150 MDrv_CMD_SERFLASH_ReadStatusRegister2, 151 MDrv_CMD_SERFLASH_WriteStatusRegister, 152 MDrv_CMD_SERFLASH_CopyHnd, 153 MDrv_CMD_SERFLASH_SetGPIO, 154 } eSerflashIoctlOpt; 155 156 //------------------------------------------------------------------------------------------------- 157 // Macros 158 //------------------------------------------------------------------------------------------------- 159 160 161 //------------------------------------------------------------------------------------------------- 162 // Type and Structure Declaration 163 //------------------------------------------------------------------------------------------------- 164 165 typedef struct _SERFLASH_READID 166 { 167 MS_U8 *pu8FlashID; 168 MS_U32 u32IDSize; 169 }SERFLASH_READID, *PSERFLASH_READID; 170 171 typedef struct _SERFLASH_READ 172 { 173 MS_U32 u32FlashAddr; 174 MS_U32 u32FlashSize; 175 MS_U8 *user_buffer; 176 }SERFLASH_READ, *PSERFLASH_READ; 177 178 typedef struct _SERFLASH_ADDRTOBLK 179 { 180 MS_U32 u32FlashAddr; 181 MS_U32 *pu32BlockIndex; 182 }SERFLASH_ADDRTOBLK, *PSERFLASH_ADDRTOBLK; 183 184 typedef struct _SERFLASH_BLKTOADDR 185 { 186 MS_U32 u32BlockIndex; 187 MS_U32 *pu32FlashAddr; 188 }SERFLASH_BLKTOADDR, *PSERFLASH_BLKTOADDR; 189 190 typedef struct _SERFLASH_ADDRERASE 191 { 192 MS_U32 u32StartAddr; 193 MS_U32 u32EraseSize; 194 MS_BOOL bWait; 195 }SERFLASH_ADDRERASE, *PSERFLASH_ADDRERASE; 196 197 typedef struct _SERFLASH_BLKERASE 198 { 199 MS_U32 u32StartBlock; 200 MS_U32 u32EndBlock; 201 MS_BOOL bWait; 202 }SERFLASH_BLKERASE, *PSERFLASH_BLKERASE; 203 204 typedef struct _SERFLASH_SECERASE 205 { 206 MS_U32 u32StartAddr; 207 MS_U32 u32EndAddr; 208 }SERFLASH_SECERASE, *PSERFLASH_SECERASE; 209 210 typedef struct _SERFLASH_WRITE 211 { 212 MS_U32 u32FlashAddr; 213 MS_U32 u32FlashSize; 214 MS_U8 *user_buffer; 215 }SERFLASH_WRITE, *PSERFLASH_WRITE; 216 217 typedef struct _SERFLASH_DMA 218 { 219 MS_U32 u32FlashStart; 220 MS_U32 u32DRAMStart; 221 MS_U32 u32Size; 222 }SERFLASH_DMA, *PSERFLASH_DMA; 223 224 typedef struct _SERFLASH_WP 225 { 226 MS_BOOL bEnable; 227 }SERFLASH_WP, *PSERFLASH_WP; 228 229 typedef struct _SERFLASH_WPDISABLERANGESET 230 { 231 MS_U32 u32DisableLowerBound; 232 MS_U32 u32DisableSize; 233 }SERFLASH_WPDISABLERANGESET, *PSERFLASH_WPDISABLERANGESET; 234 235 typedef struct _SERFLASH_WPAREA 236 { 237 MS_BOOL bEnableAllArea; 238 MS_U8 u8BlockProtectBits; 239 }SERFLASH_WPAREA, *PSERFLASH_WPAREA; 240 241 typedef struct _SERFLASH_COPYHND 242 { 243 MS_PHYADDR u32FlashAddr; 244 MS_PHYADDR u32DstAddr; 245 MS_U32 u32Len; 246 SPIDMA_Dev eDstDev; 247 MS_U8 u8OpCfg; 248 }SERFLASH_COPYHND, *PSERFLASH_COPYHND; 249 250 typedef struct _SERFLASH_GETSTATUS 251 { 252 SERFLASH_DrvStatus* pDrvStatus; 253 }SERFLASH_GETSTATUS, *PSERFLASH_GETSTATUS; 254 255 typedef struct _SERFLASH_GETLIBVER 256 { 257 const MSIF_Version **ppVersion; 258 }SERFLASH_GETLIBVER, *PSERFLASH_GETLIBVER; 259 260 typedef struct _SERFLASH_SETDBGLEVEL 261 { 262 MS_U8 u8DbgLevel; 263 }SERFLASH_SETDBGLEVEL, *PSERFLASH_SETDBGLEVEL; 264 265 typedef struct _SERFLASH_SETWPINFO 266 { 267 MS_BOOL bWPInfo; 268 }SERFLASH_SETWPINFO, *PSERFLASH_SETWPINFO; 269 270 typedef struct _SERFLASH_SETMCUCSCB 271 { 272 ms_Mcu_ChipSelect_CB ChipSel_cb; 273 }SERFLASH_SETMCUCSCB, *PSERFLASH_SETMCUCSCB; 274 275 typedef struct _SERFLASH_SETFLASHWPCB 276 { 277 ms_Flash_SetHWWP_CB FlashWP_cb; 278 }SERFLASH_SETFLASHWPCB, *PSERFLASH_SETFLASHWPCB; 279 280 typedef struct _SERFLASH_DETECTSIZE 281 { 282 MS_U32 *u32FlashSize; 283 }SERFLASH_DETECTSIZE, *PSERFLASH_DETECTSIZE; 284 285 typedef struct _SERFLASH_SET2XREAD 286 { 287 MS_BOOL b2XMode; 288 }SERFLASH_SET2XREAD, *PSERFLASH_SET2XREAD; 289 290 typedef struct _SERFLASH_SETCKG 291 { 292 SPI_DrvCKG eCKGspi; 293 }SERFLASH_SETCKG, *PSERFLASH_SETCKG; 294 295 typedef struct _SERFLASH_CLKDIV 296 { 297 SPI_DrvClkDiv eClkDivspi; 298 }SERFLASH_CLKDIV, *PSERFLASH_CLKDIV; 299 300 typedef struct _SERFLASH_SETMODE 301 { 302 MS_BOOL bXiuRiu; 303 }SERFLASH_SETMODE, *PSERFLASH_SETMODE; 304 305 typedef struct _SERFLASH_CHIPSELECT 306 { 307 MS_U8 u8FlashIndex; 308 }SERFLASH_CHIPSELECT, *PSERFLASH_CHIPSELECT; 309 310 typedef struct _SERFLASH_READSTATUSREG 311 { 312 MS_U8 *pu8StatusReg; 313 }SERFLASH_READSTATUSREG, *PSERFLASH_READSTATUSREG; 314 315 typedef struct _SERFLASH_READSTATUSREG2 316 { 317 MS_U8 *pu8StatusReg; 318 }SERFLASH_READSTATUSREG2, *PSERFLASH_READSTATUSREG2; 319 320 typedef struct _SERFLASH_WRITESTATUSREG 321 { 322 MS_U16 u16StatusReg; 323 }SERFLASH_WRITESTATUSREG, *PSERFLASH_WRITESTATUSREG; 324 325 typedef struct _SERFLASH_SETGPIO 326 { 327 MS_BOOL bSwitch; 328 }SERFLASH_SETGPIO, *PSERFLASH_SETGPIO; 329 330 //------------------------------------------------------------------------------------------------- 331 // Extern Global Variabls 332 //------------------------------------------------------------------------------------------------- 333 334 //------------------------------------------------------------------------------------------------- 335 // Extern Functions 336 //------------------------------------------------------------------------------------------------- 337 338 ////////////////////////////////////////////////////////////// 339 340 #ifdef __cplusplus 341 } 342 #endif 343 344 #endif // _DRV_SERFLASH_V2_H_ 345 346