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 #include "regTCF.h" 101 102 #ifndef __HAL_TCF_H__ 103 #define __HAL_TCF_H__ 104 105 106 //-------------------------------------------------------------------------------------------------- 107 // Driver Compiler Option 108 //-------------------------------------------------------------------------------------------------- 109 #undef TCF_CFKE 110 111 //-------------------------------------------------------------------------------------------------- 112 // Macro of bit operations 113 //-------------------------------------------------------------------------------------------------- 114 typedef struct // MSTAR_CF_VERSION // 115 { 116 MS_U8 _u8VersionEpoch; 117 MS_U8 _u8ManufacturerId; 118 MS_U8 _u8NetlistVersion; 119 MS_U8 _u8VersionBuildId; 120 } HAL_CF_VERSION_INFO; 121 122 typedef struct // MSTAR_CF_FEATURE // 123 { 124 MS_U32 _u32FeatureVector; 125 } HAL_CF_FEATURE_VECTOR; 126 127 typedef struct // MSTAR_CF_TRANS_STATUS // 128 { 129 MS_U8 _eTransStatus; 130 MS_U8 _u8UseNvmKey; 131 MS_U8 _eOperationType; 132 MS_U8 _eDecmSrc; 133 MS_U8 _eOutputUsage; 134 MS_U8 _u8ProductRange; 135 MS_U8 _u8ProductOffset; 136 } HAL_CF_TRANS_STATUS; 137 138 typedef struct // MSTAR_CF_CF_STATUS // 139 { 140 MS_U8 _eNvmStatus; 141 MS_U8 _eDiffStatus; 142 MS_U8 _u8RecentReset; 143 MS_U8 _u8CfAlert; 144 MS_U8 _u8DevelopmentMode; 145 MS_U8 _u8FuseActivate; 146 MS_U8 _u8FuseBlock; 147 } HAL_CF_CF_STATUS; 148 149 150 151 typedef struct 152 { 153 MS_U8 _u8CwcPid; 154 MS_U8 _u8CwcFld; 155 MS_U8 _u8CwcFscb; 156 MS_U8 _u8CwcScb; 157 MS_U8 _u8CwcTsid; 158 MS_U8 _u8CwcDst; 159 } HAL_CFB_CWCCFG; 160 161 typedef enum 162 { 163 E_CFB_DST_KT, 164 E_CFB_DST_DMA_SK0, 165 E_CFB_DST_DMA_SK1, 166 E_CFB_DST_DMA_SK2, 167 E_CFB_DST_DMA_SK3, 168 E_CFB_DST_TSIO, 169 170 E_HAL_CFB_DST_KT =0x0000, 171 E_HAL_CFB_DST_DMA_SK0 =0x0001, 172 E_HAL_CFB_DST_DMA_SK1 =0x0101, 173 E_HAL_CFB_DST_DMA_SK2 =0x0201, 174 E_HAL_CFB_DST_DMA_SK3 =0x0301, 175 E_HAL_CFB_DST_TSIO =0x0002, 176 } HAL_CFB_CWC_DST; 177 178 //////////////////////////////////////////////// 179 // HAL API 180 //////////////////////////////////////////////// 181 void HAL_CF_SetBank(MS_VIRT u32NonPmBankAddr); 182 void HAL_CF_Clk(MS_BOOL bEnable); 183 184 void HAL_CF_Version_Info(HAL_CF_VERSION_INFO *_pstVersion); 185 void HAL_CF_Trans_Status(HAL_CF_TRANS_STATUS *_pstTransStatus); 186 void HAL_CF_Cf_Status(HAL_CF_CF_STATUS *_pstCfStatus); 187 void HAL_CF_Cf_FeatureVector(HAL_CF_FEATURE_VECTOR *_pstCfFeature); 188 189 MS_U8 HAL_CF_Get_Trans_Status(void); 190 MS_U8 HAL_CF_Get_Operation_Type(void); 191 MS_U8 HAL_CF_Get_CwcValid(void); 192 MS_U32 HAL_CF_Read_Input(void); 193 MS_U32 HAL_CF_Read_Output(void); 194 void HAL_CF_Write_Input(MS_U32 u32Cmd); 195 void HAL_CF_Write_Output(MS_U32 u32Cmd); 196 MS_U8 HAL_CF_Get_CF_IsFinished(void); 197 198 199 MS_U8 HAL_CFB_Init(void); 200 MS_U8 HAL_CFB_Enable(void); 201 MS_U8 HAL_CFB_Reset(void); 202 203 void HAL_CFB_Set_Use_Case(MS_U8 u8UseCase); 204 void HAL_CFB_Set_Otp_Key(MS_U8 u8OtpKeyIdx); 205 void HAL_CFB_Set_CACWC_Src(MS_U8 u8CAcwcSrc); 206 void HAL_CFB_SET_CACWC(MS_U32 *pCACWC); 207 void HAL_CFB_SET_EPK(MS_U32 *pEPK); 208 void HAL_CFB_SET_EFUV(MS_U32 *pEFUV); 209 void HAL_CFB_Set_Cwc_Cfg(HAL_CFB_CWCCFG *pstCwcCfg); 210 211 MS_BOOL HAL_CFB_Is_Ready(void); 212 MS_BOOL HAL_CFB_Is_Done(void); 213 214 ////// 215 MS_BOOL HAL_CFB_DBG_KT_Response(void); 216 MS_U8 HAL_CFB_DBG_CFB_FSM(void); 217 218 #endif // #ifndef __HAL_TCF_H__ 219