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-2008 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 #ifndef _HAL_SEAL_H_ 96 #define _HAL_SEAL_H_ 97 98 99 //------------------------------------------------------------------------------------------------- 100 // Macro and Define 101 //------------------------------------------------------------------------------------------------- 102 #define _FUNC_NOT_USED() do {} while ( 0 ) 103 104 #define SEAL_SECURE_RANGE_ALIGN (0x1000) //4k bytes for secure range alignement 105 #define SEAL_IMI_RANGE_ALIGN (0x400) //1k bytes for IMI range alignment 106 #define SEAL_NONPM_GROUP_NUM (16) 107 #define SEAL_NONPM_GROUP_IP_NUM (16) 108 #define SEAL_NONPM_TBL_IP_NUM (SEAL_NONPM_GROUP_NUM*SEAL_NONPM_GROUP_IP_NUM) 109 #define SEAL_PM_GROUP_NUM (4) 110 #define SEAL_PM_GROUP_IP_NUM (16) 111 #define SEAL_PM_TBL_IP_NUM (SEAL_PM_GROUP_NUM*SEAL_PM_GROUP_IP_NUM) 112 #define SEAL_PROCESSOR_GROUP_NUM (1) 113 #define SEAL_PROCESSOR_NUM_PERGROUP (9) 114 #define SEAL_TBL_PROCESSOR_NUM (SEAL_PROCESSOR_GROUP_NUM*SEAL_PROCESSOR_NUM_PERGROUP) 115 #define SEAL_LOCK_GROUP_NUM (7UL) 116 #define SEAL_LOCK_NUM_PERGROUP (16UL) 117 #define SEAL_TBL_LOCK_NUM (SEAL_LOCK_GROUP_NUM*SEAL_LOCK_NUM_PERGROUP) 118 //------------------------------------------------------------------------------------------------- 119 // Type and Structure 120 //------------------------------------------------------------------------------------------------- 121 122 typedef enum 123 { 124 E_HAL_MIU_DEV0, 125 E_HAL_MIU_DEV1, 126 E_HAL_MIU_NUM, 127 }eHalMiu_Dev; 128 129 typedef enum 130 { 131 E_HAL_SEAL_SECURE_RANGE_ID0, 132 E_HAL_SEAL_SECURE_RANGE_ID1, 133 E_HAL_SEAL_SECURE_RANGE_ID2, 134 E_HAL_SEAL_SECURE_RANGE_ID3, 135 E_HAL_SEAL_SECURE_RANGE_ID4, 136 E_HAL_SEAL_SECURE_RANGE_ID5, 137 E_HAL_SEAL_SECURE_RANGE_ID6, 138 E_HAL_SEAL_SECURE_RANGE_ID7, 139 E_HAL_SEAL_SECURE_RANGE_ID8, 140 E_HAL_SEAL_SECURE_RANGE_ID9, 141 E_HAL_SEAL_SECURE_RANGE_ID10, 142 E_HAL_SEAL_SECURE_RANGE_ID11, 143 E_HAL_SEAL_SECURE_RANGE_ID12, 144 E_HAL_SEAL_SECURE_RANGE_ID13, 145 E_HAL_SEAL_SECURE_RANGE_ID14, 146 E_HAL_SEAL_SECURE_RANGE_ID15, 147 E_HAL_SEAL_SECURE_RANGE_NUM, 148 }eHalSeal_SecureRangeId; 149 150 typedef enum 151 { 152 E_HAL_SEAL_DBBUS, 153 E_HAL_SEAL_MCU51, 154 E_HAL_SEAL_CPU2, 155 E_HAL_SEAL_VD_R2, 156 E_HAL_SEAL_SECURE_R2, 157 E_HAL_SEAL_SC, 158 E_HAL_SEAL_CMDQ, 159 E_HAL_SEAL_PROCESSOR_NUM, 160 }eHalSeal_ProcessorId; 161 //------------------------------------------------------------------------------------------------- 162 // Function and Variable 163 //------------------------------------------------------------------------------------------------- 164 void HAL_SEAL_SetIOMapBase(MS_U32 u32NonPmBaseAddr, MS_U32 u32PmBaseAddr); 165 MS_BOOL HAL_Seal_SecureRangeSet(MS_U8 u8SecureRangeId, MS_U64 u64StartAddr, MS_U64 u64EndAddr, MS_U32 u32Attribute); 166 MS_BOOL HAL_Seal_SecureRangeQuery(MS_U8 u8MiuDev, MS_U8 u8SecureRangeId, MS_U32 *pAttribute, MS_U64 *pStartAddr, MS_U64 *pEndAddr); 167 MS_BOOL HAL_Seal_IMI_RangeSet(MS_U32 u32StartAddr, MS_U32 u32EndAddr, MS_BOOL bEnable); 168 MS_BOOL HAL_Seal_GetMiuHitFlag(MS_U8 u8MiuDev); 169 MS_U8 HAL_Seal_GetMiuHitRangeID(MS_U8 u8MiuDev); 170 MS_U8 HAL_Seal_GetMiuHitClientID(MS_U8 u8MiuDev); 171 MS_BOOL HAL_Seal_GetMiuSecureFlag(MS_U8 u8MiuDev); 172 MS_BOOL HAL_Seal_GetMiuWriteFlag(MS_U8 u8MiuDev); 173 MS_U64 HAL_Seal_GetMiuHitAddr(MS_U8 u8MiuDev); 174 MS_BOOL HAL_Seal_ClearMiuHitLog(MS_U8 u8MiuDev); 175 MS_BOOL HAL_Seal_SecureRangeLock(MS_U8 u8MiuDev, MS_U8 u8SecureRangeId); 176 MS_BOOL HAL_Seal_NonSecureProcessorSet(MS_U8 u8ProcessorId, MS_BOOL bNonSecure); 177 MS_BOOL HAL_Seal_NonSecureProcessorQuery(MS_U8 u8ProcessorId, MS_BOOL *pNonSecure); 178 MS_BOOL HAL_Seal_SecureSlaveSet(MS_U32 u32SlaveId, MS_BOOL bSecure); 179 MS_BOOL HAL_Seal_SecureSlaveQuery(MS_U32 u32SlaveId, MS_BOOL *pSecure); 180 MS_BOOL HAL_Seal_SecureMasterSet(MS_U32 u32MasterId, MS_BOOL bSecure); 181 MS_BOOL HAL_Seal_SecureMasterQuery(MS_U32 u32MasterId, MS_BOOL *pSecure); 182 MS_BOOL HAL_Seal_BufferLock(MS_U8 u8SecureBufferLockId, MS_BOOL bLock); 183 MS_BOOL HAL_Seal_QueryBufferLocked(eSeal_Lock eLockId, MS_BOOL* bLocked); 184 MS_BOOL HAL_Seal_MaskInterruptFlag(MS_U8 u8MiuDev, MS_BOOL bMask); 185 MS_BOOL HAL_SEAL_POWER_SUSPEND(void); 186 MS_BOOL HAL_SEAL_POWER_RESUME(void); 187 #endif // _HAL_SEAL_H_ 188 189