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 0x00UL 88 #define CHIPREV_U02 0x01UL 89 90 #define EFUSE_ADDRESS_MASK 0x007FUL 91 #define EFUSE_OFFSET_HDCP_FSM0 0x0010UL 92 #define EFUSE_OFFSET_HDCP_FSM1 0x0028UL 93 #define EFUSE_OFFSET_HASH_FSM0 0x0002UL // bank 2 94 95 //efuse FSM0 96 #define REG_EFUSE_FSM0_TRIG 0x2000UL 97 #define REG_EFUSE_FSM0_CTRL 0x2002UL 98 #define REG_EFUSE_FSM0_RDATA_15_0 0x2060UL 99 #define REG_EFUSE_FSM0_RDATA_31_16 0x2062UL 100 #define REG_EFUSE_FSM0_RDATA_47_32 0x2064UL 101 #define REG_EFUSE_FSM0_RDATA_63_48 0x2066UL 102 103 //efuse FSM1 104 #define REG_EFUSE_FSM1_TRIG 0x204CUL 105 #define REG_EFUSE_FSM1_CTRL 0x204EUL 106 #define REG_EFUSE_FSM1_RDATA_15_0 0x2080UL 107 #define REG_EFUSE_FSM1_RDATA_31_16 0x2082UL 108 #define REG_EFUSE_FSM1_RDATA_47_32 0x2084UL 109 #define REG_EFUSE_FSM1_RDATA_63_48 0x2086UL 110 111 //efuse 32*32 112 #define REG_RESERVED4_15_0 0x2050UL //0X28 113 #define REG_RESERVED4_31_16 0x2052UL //0X29 114 #define REG_EFUSE_128_RD_15_0 0x2058UL //0X2c 115 #define REG_EFUSE_128_RD_31_16 0x205AUL //0X2d 116 #define REG_EFUSE_32_RD_15_0 0x205CUL //0X2e 117 #define REG_EFUSE_32_RD_31_16 0x205EUL //0X2f 118 #define FLAG_EFUSE_DATA_BUSY 0x2000UL //0x28[13], 1: Busy, 0:Idle 119 //0x29[13], 1: Busy, 0:Idle 120 121 #define MAX_TIMEOUT_COUNT 100UL 122 123 //------------------------------------------------------------------------------------------------- 124 // Type and Structure 125 //------------------------------------------------------------------------------------------------- 126 typedef struct 127 { 128 MS_U32 u32ChipTopBase; 129 MS_U32 u32PmTopBase; // REG_PM_BASE 130 131 } hal_sys_base_t; 132 133 //------------------------------------------------------------------------------------------------- 134 // Function and Variable 135 //------------------------------------------------------------------------------------------------- 136 void SYS_Init(MS_PHY phy64baseaddr); 137 MS_U8 SYS_GetChipRev(void); 138 MS_U16 SYS_GetChipID(void); 139 const SYS_Info* SYS_GetInfo(void); 140 void SYS_ResetCPU(void); 141 MS_U8 SYS_VIF_ReadByteByVDMbox(MS_U32 u32Reg); 142 void SYS_VIF_WriteByteByVDMbox(MS_U32 u32Reg, MS_U8 u8Val); 143 void SYS_VIF_WriteByteMaskByVDMbox(MS_U32 u32Reg, MS_U8 u8Val, MS_U8 u8Mask); 144 void SYS_VIF_WriteRegBitByVDMbox(MS_U32 u32Reg, MS_U8 bEnable, MS_U8 u8Mask); 145 MS_U16 SYS_VIF_Read2ByteByVDMbox(MS_U32 u32Reg); 146 void HAL_SYS_RFAGC_Tristate(MS_BOOL bEnable); 147 void HAL_SYS_IFAGC_Tristate(MS_BOOL bEnable); 148 void HAL_SYS_SetAGCPadMux(SYS_AGC_PAD_SET eAgcPadMux); 149 MS_BOOL HAL_SYS_SetPadMux(SYS_PAD_MUX_SET ePadMuxType,SYS_PAD_SEL ePadSel); 150 MS_BOOL HAL_SYS_SetPCMCardDetectMode(SYS_PCM_CD_MODE ePCMCDMode); 151 MS_BOOL HAL_SYS_DisableDebugPort(void); 152 MS_BOOL HAL_SYS_EnableDebugPort(void); 153 MS_BOOL HAL_SYS_SetTSOutClockPhase(MS_U16 u16Val); 154 MS_BOOL HAL_SYS_SetTSClockPhase(SYS_PAD_MUX_SET ePadMuxType,MS_U16 u16Val); 155 156 void HAL_SYS_SetEfuseIOMapBase(MS_VIRT u32Base); 157 MS_U16 HAL_SYS_EfuseRead2Byte(MS_U32 u32RegAddr); 158 MS_U16 HAL_SYS_EfuseWrite2Byte(MS_U32 u32RegAddr, MS_U16 u16Val); 159 void HAL_SYS_SetOtpIOMapBase(MS_VIRT u32Base); 160 MS_U32 HAL_SYS_ReadRSAKey(MS_U16 u16ReadAddr); 161 MS_BOOL HAL_SYS_Query(E_SYS_QUERY id); 162 MS_U32 HAL_SYS_QueryDolbyHashInfo(E_SYS_DOLBY_HASH_INFO index); 163 E_SYS_CHIP_TYPE HAL_SYS_GetChipType(void); 164 void HAL_SYS_SetChipType(E_SYS_CHIP_TYPE Type); 165 MS_U16 HAL_SYS_ReadBrickTerminatorStatus(void); 166 void HAL_SYS_WriteBrickTerminatorStatus(MS_U16 u16Status); 167 void HAL_SYS_GetEfuseDid(MS_U16 *u16efuse_did); 168 MS_BOOL HAL_SYS_ReadEfuseHDCPKey(MS_U16 u16ReadAddr, MS_U32 *u32HDCPKey); 169 MS_U32 HAL_SYS_GetMemcConfg(MS_U32 eSource, MS_U32 eTiming, MS_BOOL *retEnMemc); 170 MS_U32 HAL_SYS_GetXcByPartConfg (MS_U32 eSource, MS_U32 eInputTiming, MS_U32 eOutputTiming, MS_BOOL *retEn); 171 void HAL_SYS_GetDolbyKeyCustomer(MS_U8 * u8pkey); 172 173 #endif // _HAL_SYS_H_ 174 175