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-2009 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 drvCA.h 98 /// @brief CA Driver Interface 99 /// @author MStar Semiconductor,Inc. 100 //////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef __DRV_CA_H__ 103 #define __DRV_CA_H__ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 #define MSIF_CA_LIB_CODE {'C','A', '_', '_'} //Lib code 111 #define MSIF_CA_LIBVER {'0','1'} //LIB version 112 #define MSIF_CA_BUILDNUM {'1','1'} //Build Number 113 #define MSIF_CA_CHANGELIST {'0','0','0','0','0','0','0','0'} //P4 ChangeList Number 114 115 #define CA_DRV_VERSION /* Character String for DRV/API version */ \ 116 MSIF_TAG, /* 'MSIF' */ \ 117 MSIF_CLASS, /* '00' */ \ 118 MSIF_CUS, /* 0x0000 */ \ 119 MSIF_MOD, /* 0x0000 */ \ 120 MSIF_CHIP, \ 121 MSIF_CPU, \ 122 MSIF_CA_LIB_CODE, /* IP__ */ \ 123 MSIF_CA_LIBVER, /* 0.0 ~ Z.Z */ \ 124 MSIF_CA_BUILDNUM, /* 00 ~ 99 */ \ 125 MSIF_CA_CHANGELIST, /* CL# */ \ 126 MSIF_OS 127 128 129 typedef enum 130 { 131 E_CA_DEBUG_PORT_I2C, 132 E_CA_DEBUG_PORT_JTAG, 133 E_CA_DEBUG_PORT_SCAN, 134 } CA_DEBUG_PORT; 135 136 typedef enum 137 { 138 E_CA_DEBUG_PORT_OPEN, 139 E_CA_DEBUG_PORT_PASSWD, 140 E_CA_DEBUG_PORT_CLOSE 141 } CA_DEBUG_PORT_MODE; 142 143 typedef enum 144 { 145 E_CA_LOCK_WRITE = 1 << 0, 146 E_CA_LOCK_READ = 1 << 1 147 } CA_LOCK_TYPE; 148 149 typedef enum 150 { 151 E_BOOT_LockWord_W0000_0511_Addr, 152 E_BOOT_LockWord_W0512_1023_Addr, 153 E_BOOT_LockWord_W1024_1535_Addr, 154 E_BOOT_LockWord_W1536_2047_Addr, 155 E_BOOT_LockWord_W2048_2559_Addr, 156 E_BOOT_LockWord_W2560_3071_Addr, 157 E_BOOT_LockWord_W3072_3583_Addr, 158 E_BOOT_LockWord_W3584_3759_Addr, 159 E_LockWord_v_PubOtpOID, 160 E_LockWord_v_PubOtpVID, 161 E_LockWord_v_pubOtpUniqueID1, 162 E_LockWord_v_pubOtpUniqueID2, 163 } CA_OTP_LOCK; 164 165 DLL_PUBLIC MS_BOOL MDrv_CA_Init(void); 166 // DLL_PUBLIC MS_U32 MDrv_CA_MaxDeviceIdSize(void); 167 168 //------------------------------------------------------------------------------------------------- 169 // The functions will read/write directly from/to OTP 170 //------------------------------------------------------------------------------------------------- 171 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_EnableSecureBoot(void); 172 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_IsSecureBootEnabled(void); 173 174 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_SetBlockLock(MS_U32 u32Start, MS_U32 u32End, CA_LOCK_TYPE eLockType); 175 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_GetBlockLock(MS_U32 *pu32Start, MS_U32 *pu32End, CA_LOCK_TYPE *eLockType); 176 177 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_SetRSAextID(MS_U32 u32Value); 178 // DLL_PUBLIC MS_U32 MDrv_CA_OTP_GetRSAextID(void); 179 180 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_SetHASH_REF_VER(MS_U32 u32HASH0_REF_VER, MS_U32 u32HASH2_REF_VER); 181 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_GetHASH_REF_VER(MS_U32 *pu32HASH0_REF_VER, MS_U32 *pu32HASH2_REF_VER); 182 183 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_SetDebugPortMode(CA_DEBUG_PORT eDebugPort, CA_DEBUG_PORT_MODE eMode); 184 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_GetDebugPortMode(CA_DEBUG_PORT eDebugPort, CA_DEBUG_PORT_MODE *eMode); 185 186 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_SetDeviceId(const MS_U8 *pu8Did, MS_U32 u32Size); 187 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_GetDeviceId(MS_U8 *pu8Did, MS_U32 u32Size); 188 189 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_EnableSecureCWMode(void); 190 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_IsSecureCWMode(void); 191 192 193 //------------------------------------------------------------------------------------------------- 194 // The OTP read/write 195 //------------------------------------------------------------------------------------------------- 196 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_IsBlank(MS_U32 addr); 197 // DLL_PUBLIC MS_U32 MDrv_CA_OTP_Read(MS_U32 addr); 198 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_Write(MS_U32 addr, MS_U32 value); 199 200 // DLL_PUBLIC MS_BOOL MDrv_CA_Locked(CA_OTP_LOCK eLock); 201 // DLL_PUBLIC MS_BOOL MDrv_CA_OTP_Lock(CA_OTP_LOCK eLock); 202 203 //------------------------------------------------------------------------------------------------- 204 // Hardware 16-bits Random number generator 205 //------------------------------------------------------------------------------------------------- 206 DLL_PUBLIC MS_U32 MDrv_CA_Random(void); 207 208 209 #ifdef __cplusplus 210 } 211 #endif 212 213 #endif 214