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 // file halTCF.h 97 // @brief TCF HAL 98 // @author MStar Semiconductor,Inc. 99 //////////////////////////////////////////////////////////////////////////////////////////////////// 100 #ifndef __HAL_TCF_H__ 101 #define __HAL_TCF_H__ 102 103 104 //-------------------------------------------------------------------------------------------------- 105 // Driver Compiler Option 106 //-------------------------------------------------------------------------------------------------- 107 108 //-------------------------------------------------------------------------------------------------- 109 // Macro of bit operations 110 //-------------------------------------------------------------------------------------------------- 111 typedef struct // MSTAR_CF_VERSION // 112 { 113 MS_U8 _u8VersionEpoch; 114 MS_U8 _u8ManufacturerId; 115 MS_U8 _u8NetlistVersion; 116 MS_U8 _u8VersionBuildId; 117 } HAL_CF_VERSION_INFO; 118 119 typedef struct // MSTAR_CF_FEATURE // 120 { 121 MS_U32 _u32FeatureVector; 122 } HAL_CF_FEATURE_VECTOR; 123 124 typedef struct // MSTAR_CF_TRANS_STATUS // 125 { 126 MS_U8 _eTransStatus; 127 MS_U8 _u8UseNvmKey; 128 MS_U8 _eOperationType; 129 MS_U8 _eDecmSrc; 130 MS_U8 _eOutputUsage; 131 MS_U8 _u8ProductRange; 132 MS_U8 _u8ProductOffset; 133 } HAL_CF_TRANS_STATUS; 134 135 typedef struct // MSTAR_CF_CF_STATUS // 136 { 137 MS_U8 _eNvmStatus; 138 MS_U8 _eDiffStatus; 139 MS_U8 _u8RecentReset; 140 MS_U8 _u8CfAlert; 141 MS_U8 _u8DevelopmentMode; 142 MS_U8 _u8FuseActivate; 143 MS_U8 _u8FuseBlock; 144 } HAL_CF_CF_STATUS; 145 146 147 148 typedef struct 149 { 150 MS_U8 _u8CwcPid; 151 MS_U8 _u8CwcFld; 152 MS_U8 _u8CwcFscb; 153 MS_U8 _u8CwcScb; 154 MS_U8 _u8CwcTsid; 155 } HAL_CFB_CWCCFG; 156 157 158 //////////////////////////////////////////////// 159 // HAL API 160 //////////////////////////////////////////////// 161 void HAL_TCF_SetBank(MS_U32 u32NonPmBankAddr); 162 void HAL_TCF_Clk(MS_BOOL bEnable); 163 164 165 // CF 166 // 167 void HAL_CF_Version_Info(HAL_CF_VERSION_INFO *_pstVersion); 168 void HAL_CF_Trans_Status(HAL_CF_TRANS_STATUS *_pstTransStatus); 169 void HAL_CF_Cf_Status(HAL_CF_CF_STATUS *_pstCfStatus); 170 void HAL_CF_Cf_FeatureVector(HAL_CF_FEATURE_VECTOR *_pstCfFeature); 171 172 MS_U8 HAL_CF_Get_Trans_Status(void); 173 MS_U8 HAL_CF_Get_Operation_Type(void); 174 MS_U8 HAL_CF_Get_CwcValid(void); 175 MS_U32 HAL_CF_Read_Input(void); 176 MS_U32 HAL_CF_Read_Output(void); 177 void HAL_CF_Write_Input(MS_U32 u32Cmd); 178 void HAL_CF_Write_Output(MS_U32 u32Cmd); 179 MS_U8 HAL_CF_Get_CF_IsFinished(void); 180 181 182 // CFKE 183 // 184 MS_U8 HAL_CFKE_Get_OperationStatus(void); 185 MS_U8 HAL_CFKE_Get_OperationCount(void); 186 MS_U8 HAL_CFKE_Get_ErrorCode(void); 187 MS_U8 HAL_CFKE_Get_OperationType(void); 188 MS_U8 HAL_CFKE_Get_DiffAllowNonUnw(void); 189 MS_U8 HAL_CFKE_Get_DiffAllowCk(void); 190 MS_U8 HAL_CFKE_Get_DiffContentOutputAllowed(void); 191 192 MS_U32 HAL_CFKE_Read_Command(void); 193 void HAL_CFKE_Write_Command(MS_U32 u32Cmd); 194 195 MS_U32 HAL_CFKE_Read_Platform(void); 196 MS_BOOL HAL_CFKE_IsTransactionDone(void); 197 198 MS_U32 HAL_CFKE_Read_UnwPath(void); 199 void HAL_CFKE_Write_UnwPath(MS_U32 u32Cmd); 200 201 MS_U32 HAL_CFKE_Read_Validator0(void); 202 void HAL_CFKE_Write_Validator0(MS_U32 u32Cmd); 203 MS_U32 HAL_CFKE_Read_Validator1(void); 204 void HAL_CFKE_Write_Validator1(MS_U32 u32Cmd); 205 206 void HAL_CFKE_Write_SlotA(MS_U32 u32Cmd); 207 void HAL_CFKE_Write_SlotB(MS_U32 u32Cmd); 208 void HAL_CFKE_Write_SlotC(MS_U32 u32Cmd); 209 void HAL_CFKE_Write_SlotD(MS_U32 u32Cmd); 210 void HAL_CFKE_Write_UserHash(MS_U32 u32Cmd); 211 212 213 // CRIKL 214 // Mirror of CF, CFKE Resigers 215 MS_U32 HAL_CRIKL_Read_CfStatus(void); 216 MS_U32 HAL_CRIKL_Read_CfkeStatus(void); 217 MS_U32 HAL_CRIKL_Read_CfPlatform(void); 218 MS_U32 HAL_CRIKL_Read_CfFeature(void); 219 220 // Key Table control 221 void HAL_CRIKL_Set_KTIndex( MS_U8 eScmbCtl, MS_U8 u8DscmbId); 222 void HAL_CRIKL_Write_KTPara_High_HalfWord(MS_U16 u16HalfWord); 223 void HAL_CRIKL_Write_KTPara_2nd_HalfWord(MS_U16 u16HalfWord); 224 void HAL_CRIKL_Write_KTPara_3rd_HalfWord(MS_U16 u16HalfWord); 225 void HAL_CRIKL_Write_KTPara_Low_HalfWord(MS_U16 u16HalfWord); 226 MS_U16 HAL_CRIKL_Read_KTIndex(void); 227 MS_U16 HAL_CRIKL_Read_KTPara_High_HalfWord(void); 228 MS_U16 HAL_CRIKL_Read_KTPara_2nd_HalfWord(void); 229 MS_U16 HAL_CRIKL_Read_KTPara_3rd_HalfWord(void); 230 MS_U16 HAL_CRIKL_Read_KTPara_Low_HalfWord(void); 231 // Key Slot control 232 void HAL_CRIKL_Set_KSIndex(MS_U8 u8KsIdx); 233 void HAL_CRIKL_Write_KSPara_High_HalfWord(MS_U16 u16HalfWord); 234 void HAL_CRIKL_Write_KSPara_2nd_HalfWord(MS_U16 u16HalfWord); 235 void HAL_CRIKL_Write_KSPara_3rd_HalfWord(MS_U16 u16HalfWord); 236 void HAL_CRIKL_Write_KSPara_Low_HalfWord(MS_U16 u16HalfWord); 237 MS_U16 HAL_CRIKL_Read_KSIndex(void); 238 MS_U16 HAL_CRIKL_Read_KSPara_High_HalfWord(void); 239 MS_U16 HAL_CRIKL_Read_KSPara_2nd_HalfWord(void); 240 MS_U16 HAL_CRIKL_Read_KSPara_3rd_HalfWord(void); 241 MS_U16 HAL_CRIKL_Read_KSPara_Low_HalfWord(void); 242 243 // Key Parameter 244 void HAL_CRIKL_Reset_KeyPara(void); 245 void HAL_CRIKL_Write_KeyPara(MS_BOOL bDscmbKey); 246 247 void HAL_CRIKL_Setup_VendorNo(MS_BOOL bDscmbKey, MS_U8 u8VendorNo); 248 void HAL_CRIKL_Setup_VendorAtt(MS_BOOL bDscmbKey, MS_U16 u16VendorAtt); 249 void HAL_CRIKL_Setup_OutputAllowed(MS_BOOL bDscmbKey, MS_U8 u8OutputAllowed); 250 void HAL_CRIKL_Setup_bMultiEng(MS_BOOL bDscmbKey, MS_BOOL bMultiEng); 251 void HAL_CRIKL_Setup_bLsb64(MS_BOOL bDscmbKey, MS_BOOL bLsb64); 252 void HAL_CRIKL_Setup_KeySize(MS_BOOL bDscmbKey, MS_U8 eKeySize); 253 void HAL_CRIKL_Setup_KeyEngine(MS_BOOL bDscmbKey, MS_U8 uKeyEng); 254 void HAL_CRIKL_Setup_Drop(MS_BOOL bDscmbKey, MS_U8 u8Drop); 255 void HAL_CRIKL_Setup_Cnt(MS_BOOL bDscmbKey, MS_U8 u8Cnt); 256 void HAL_CRIKL_Setup_KeyDest(MS_BOOL bDscmbKey, MS_U8 u8KeyDest); 257 void HAL_CRIKL_Setup_OpType(MS_BOOL bDscmbKey, MS_U8 u8Op); 258 void HAL_CRIKL_Setup_KteSel(MS_BOOL bDscmbKey, MS_U8 eKteSel); 259 void HAL_CRIKL_Setup_bLock(MS_BOOL bDscmbKey, MS_BOOL bLock); 260 void HAL_CRIKL_Setup_bParaValid(MS_BOOL bDscmbKey, MS_BOOL bParaValid); 261 void HAL_CRIKL_Setup_bKlEn(MS_BOOL bDscmbKey, MS_BOOL bKlEn); 262 263 #endif // #ifndef __HAL_TCF_H__ 264