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 #ifndef _HAL_SYS_H_ 80 #define _HAL_SYS_H_ 81 82 //------------------------------------------------------------------------------------------------- 83 // Macro and Define 84 //------------------------------------------------------------------------------------------------- 85 #define UNUSED( var ) (void)((var) = (var)) 86 87 #define CHIPREV_U01 0x00 88 #define CHIPREV_U02 0x01 89 90 #define REG_EFUSE_SEL_READ_256 0x204A //0X25 91 92 #define REG_EFUSE_FSM_TRIGGER_0 0x2000 //0X00 93 #define REG_EFUSE_FSM_TRIGGER_1 0x204C //0X26 94 #define REG_EFUSE_FSM_SET_0 0x2002 //0x01 95 #define REG_EFUSE_FSM_SET_1 0x204E //0x27 96 #define REG_READ_FSM_0_0 0x2060 //0x30 97 #define REG_READ_FSM_0_1 0x2062 //0x31 98 #define REG_READ_FSM_0_2 0x2064 //0x32 99 #define REG_READ_FSM_0_3 0x2066 //0x33 100 #define REG_READ_FSM_1_0 0x2080 //0x40 101 #define REG_READ_FSM_1_1 0x2082 //0x41 102 #define REG_READ_FSM_1_2 0x2084 //0x42 103 #define REG_READ_FSM_1_3 0x2086 //0x43 104 105 106 //efuse FSM1 107 #define REG_EFUSE_FSM1_TRIG 0x204C 108 #define REG_EFUSE_FSM1_CTRL 0x204E 109 #define REG_EFUSE_FSM1_RDATA_15_0 0x2080 110 #define REG_EFUSE_FSM1_RDATA_31_16 0x2082 111 #define REG_EFUSE_FSM1_RDATA_47_32 0x2084 112 #define REG_EFUSE_FSM1_RDATA_63_48 0x2086 113 114 #define FLAG_EFUSE_DATA_BUSY 0x1 115 #define MAX_TIMEOUT_COUNT 100 116 117 //------------------------------------------------------------------------------------------------- 118 // Type and Structure 119 //------------------------------------------------------------------------------------------------- 120 typedef struct 121 { 122 MS_U32 u32ChipTopBase; 123 MS_U32 u32PmTopBase; // REG_PM_BASE 124 125 } hal_sys_base_t; 126 127 typedef enum 128 { 129 PAD_HOTPLUGD = 0x00, 130 PAD_HOTPLUGC = 0x01, 131 } E_SYS_CBUS_INFO; 132 133 typedef enum 134 { 135 SEL_ZQ_B = 0x00, 136 137 } E_SYS_DDR_AOTP_INFO; 138 139 typedef enum 140 { 141 GC_REF_TRIM_SEL = 0x00, 142 ActivateVIDEOefuse = 0x01, 143 GC_IDAC1_TRIM = 0x02, 144 GC_IDAC2_TRIM = 0x03, 145 GC_IDAC3_TRIM = 0x04, 146 147 } E_SYS_VIDEO_ATOP_INFO; 148 149 typedef enum 150 { 151 GCR_TX_TRIM_100T = 0x00, 152 GCR_TX_TRIM_10T = 0x01, 153 GCR_TX_RO_SEL = 0x02, 154 GCR_LPF_ZIN = 0x03, 155 156 } E_SYS_ETH_ATOP_INFO; 157 158 typedef enum 159 { 160 GCR_TRVBG = 0x00, 161 DATO_SAR_DATA = 0x01, 162 } E_SYS_PM_SAR_ATOP_INFO; 163 164 165 //------------------------------------------------------------------------------------------------- 166 // Function and Variable 167 //------------------------------------------------------------------------------------------------- 168 void SYS_Init(MS_U32 u32baseaddr); 169 MS_U8 SYS_GetChipRev(void); 170 MS_U16 SYS_GetChipID(void); 171 const SYS_Info* SYS_GetInfo(void); 172 void SYS_ResetCPU(void); 173 MS_U8 SYS_VIF_ReadByteByVDMbox(MS_U32 u32Reg); 174 void SYS_VIF_WriteByteByVDMbox(MS_U32 u32Reg, MS_U8 u8Val); 175 void SYS_VIF_WriteByteMaskByVDMbox(MS_U32 u32Reg, MS_U8 u8Val, MS_U8 u8Mask); 176 void SYS_VIF_WriteRegBitByVDMbox(MS_U32 u32Reg, MS_U8 bEnable, MS_U8 u8Mask); 177 MS_U16 SYS_VIF_Read2ByteByVDMbox(MS_U32 u32Reg); 178 void HAL_SYS_RFAGC_Tristate(MS_BOOL bEnable); 179 void HAL_SYS_IFAGC_Tristate(MS_BOOL bEnable); 180 void HAL_SYS_SetAGCPadMux(SYS_AGC_PAD_SET eAgcPadMux); 181 MS_BOOL HAL_SYS_SetPadMux(SYS_PAD_MUX_SET ePadMuxType,SYS_PAD_SEL ePadSel); 182 MS_BOOL HAL_SYS_SetPCMCardDetectMode(SYS_PCM_CD_MODE ePCMCDMode); 183 MS_BOOL HAL_SYS_DisableDebugPort(void); 184 MS_BOOL HAL_SYS_EnableDebugPort(void); 185 MS_BOOL HAL_SYS_SetTSOutClockPhase(MS_U16 u16Val); 186 MS_BOOL HAL_SYS_SetTSClockPhase(SYS_PAD_MUX_SET ePadMuxType,MS_U16 u16Val); 187 188 void HAL_SYS_SetEfuseIOMapBase(MS_VIRT u32Base); 189 MS_U16 HAL_SYS_EfuseRead2Byte(MS_U32 u32RegAddr); 190 MS_U16 HAL_SYS_EfuseWrite2Byte(MS_U32 u32RegAddr, MS_U16 u16Val); 191 void HAL_SYS_SetOtpIOMapBase(MS_U32 u32Base); 192 MS_U32 HAL_SYS_ReadRSAKey(MS_U16 u16ReadAddr); 193 MS_BOOL HAL_SYS_Query(E_SYS_QUERY id); 194 MS_U32 HAL_SYS_QueryDolbyHashInfo(E_SYS_DOLBY_HASH_INFO index); 195 E_SYS_CHIP_TYPE HAL_SYS_GetChipType(void); 196 void HAL_SYS_SetChipType(E_SYS_CHIP_TYPE Type); 197 MS_U16 HAL_SYS_ReadBrickTerminatorStatus(void); 198 void HAL_SYS_WriteBrickTerminatorStatus(MS_U16 u16Status); 199 void HAL_SYS_GetEfuseDid(MS_U16 *u16efuse_did); 200 MS_BOOL HAL_SYS_ReadEfuseHDCPKey(MS_U16 u16ReadAddr, MS_U32 *u32HDCPKey); 201 202 MS_U32 HAL_SYS_QueryCBUSInfo(E_SYS_CBUS_INFO index); 203 MS_U32 HAL_SYS_QueryDDRAOTPInfo(E_SYS_DDR_AOTP_INFO index); 204 MS_U32 HAL_SYS_QueryVIDEOATOPInfo(E_SYS_VIDEO_ATOP_INFO index); 205 MS_U32 HAL_SYS_QueryETHATOPInfo(E_SYS_ETH_ATOP_INFO index); 206 MS_U32 HAL_SYS_QueryPMSARATOPInfo(E_SYS_PM_SAR_ATOP_INFO index); 207 208 #endif // _HAL_SYS_H_ 209 210