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) 2008-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 /// 97 /// @file drvIRQ.h 98 /// @brief IRQ Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 /*! \defgroup G_IRQ IRQ interface 103 * \ingroup G_PERIPHERAL 104 *! \defgroup G_IRQ_INIT Initialization Task relative 105 * \ingroup G_IRQ 106 *! \defgroup G_IRQ_EnDecrypt En/Decrypt Task relative 107 * \ingroup G_IRQ 108 *! \defgroup G_IRQ_SHA Hash relative 109 * \ingroup G_IRQ 110 *! \defgroup G_IRQ_OTHER other relative 111 * \ingroup G_IRQ 112 *! \defgroup G_IRQ_ToBeModified IRQ api to be modified 113 * \ingroup G_IRQ 114 *! \defgroup G_IRQ_ToBeRemove IRQ api to be removed 115 * \ingroup G_IRQ 116 */ 117 118 #ifndef _DRV_IRQ_H_ 119 #define _DRV_IRQ_H_ 120 121 #include"MsIRQ.h" 122 123 #ifdef __cplusplus 124 extern "C" 125 { 126 #endif 127 128 #include "MsTypes.h" 129 130 //------------------------------------------------------------------------------------------------- 131 // Driver Capability 132 //------------------------------------------------------------------------------------------------- 133 #define MSIF_DRVIRQ_LIB_CODE {'I','R','Q',' '} //Lib code 134 #define MSIF_DRVIRQ_LIBVER {'0','1'} //LIB version 135 #define MSIF_DRVIRQ_BUILDNUM {'0','3'} //Build Number 136 #define MSIF_DRVIRQ_CHANGELIST {'0','0','5','5','5','6','7','9'} //P4 ChangeList Number 137 138 #define DRVIRQ_DRV_VERSION /* Character String for DRV/API version */ \ 139 MSIF_TAG, /* 'MSIF' */ \ 140 MSIF_CLASS, /* '00' */ \ 141 MSIF_CUS, /* 0x0000 */ \ 142 MSIF_MOD, /* 0x0000 */ \ 143 MSIF_CHIP, \ 144 MSIF_CPU, \ 145 MSIF_DRVIRQ_LIB_CODE, /* IP__ */ \ 146 MSIF_DRVIRQ_LIBVER, /* 0.0 ~ Z.Z */ \ 147 MSIF_DRVIRQ_BUILDNUM, /* 00 ~ 99 */ \ 148 MSIF_DRVIRQ_CHANGELIST, /* CL# */ \ 149 MSIF_OS 150 151 //------------------------------------------------------------------------------------------------- 152 // Macro and Define 153 //------------------------------------------------------------------------------------------------- 154 // TICK_TIMER 155 #define MDRV_RISC32_TIMER 0x80 156 // PIC 157 #define MDRV_RISC32_UART 0x81 158 159 //------------------------------------------------------------------------------------------------- 160 // Type and Structure 161 //------------------------------------------------------------------------------------------------- 162 ///Define CPU to CPU interrupt type 163 typedef enum 164 { 165 E_IRQ_CPU0_2_CPU1, ///< 8051 to AEON 166 E_IRQ_CPU0_2_CPU2, ///< 8051 to BEON 167 E_IRQ_CPU1_2_CPU0, ///< AEON to 8051 168 E_IRQ_CPU1_2_CPU2, ///< AEON to BEON 169 E_IRQ_CPU2_2_CPU0, ///< BEON to 8051 170 E_IRQ_CPU2_2_CPU1, ///< BEON to AEON 171 }IRQ_CPU_TYPE; 172 173 //------------------------------------------------------------------------------------------------- 174 // Function and Variable 175 //------------------------------------------------------------------------------------------------- 176 //------------------------------------------------------------------------------------------------- 177 /// MOBF Encrypt 178 /// @ingroup G_IRQ_ToBeRemove 179 /// @param u32Key \b IN: Key 180 /// @param bEnable \b IN: TRUE/FLASE 181 /// @return DRVAESDMA_OK : Success 182 /// @return Others : Fail 183 //------------------------------------------------------------------------------------------------- 184 void MDrv_IRQ_Detech(MS_U32 u32Vector); 185 //------------------------------------------------------------------------------------------------- 186 /// MOBF Encrypt 187 /// @ingroup G_IRQ_ToBeRemove 188 /// @param u32Key \b IN: Key 189 /// @param bEnable \b IN: TRUE/FLASE 190 /// @return DRVAESDMA_OK : Success 191 /// @return Others : Fail 192 //------------------------------------------------------------------------------------------------- 193 void MDrv_IRQ_Attach(MS_U32 u32Vector, void *pIntCb); 194 //------------------------------------------------------------------------------------------------- 195 /// MOBF Encrypt 196 /// @ingroup G_IRQ_ToBeRemove 197 /// @param u32Key \b IN: Key 198 /// @param bEnable \b IN: TRUE/FLASE 199 /// @return DRVAESDMA_OK : Success 200 /// @return Others : Fail 201 //------------------------------------------------------------------------------------------------- 202 void MDrv_IRQ_Restore(void); 203 //------------------------------------------------------------------------------------------------- 204 /// MOBF Encrypt 205 /// @ingroup G_IRQ_ToBeRemove 206 /// @param u32Key \b IN: Key 207 /// @param bEnable \b IN: TRUE/FLASE 208 /// @return DRVAESDMA_OK : Success 209 /// @return Others : Fail 210 //------------------------------------------------------------------------------------------------- 211 void MDrv_IRQ_MaskAll(void); 212 //------------------------------------------------------------------------------------------------- 213 /// MOBF Encrypt 214 /// @ingroup G_IRQ_ToBeRemove 215 /// @param u32Key \b IN: Key 216 /// @param bEnable \b IN: TRUE/FLASE 217 /// @return DRVAESDMA_OK : Success 218 /// @return Others : Fail 219 //------------------------------------------------------------------------------------------------- 220 void MDrv_IRQ_UnMaskAll(void); 221 //------------------------------------------------------------------------------------------------- 222 /// MOBF Encrypt 223 /// @ingroup G_IRQ_ToBeRemove 224 /// @param u32Key \b IN: Key 225 /// @param bEnable \b IN: TRUE/FLASE 226 /// @return DRVAESDMA_OK : Success 227 /// @return Others : Fail 228 //------------------------------------------------------------------------------------------------- 229 void MDrv_IRQ_Mask(MS_U32 u32Vector); 230 //------------------------------------------------------------------------------------------------- 231 /// MOBF Encrypt 232 /// @ingroup G_IRQ_ToBeRemove 233 /// @param u32Key \b IN: Key 234 /// @param bEnable \b IN: TRUE/FLASE 235 /// @return DRVAESDMA_OK : Success 236 /// @return Others : Fail 237 //------------------------------------------------------------------------------------------------- 238 void MDrv_IRQ_UnMask(MS_U32 u32Vector); 239 //------------------------------------------------------------------------------------------------- 240 /// MOBF Encrypt 241 /// @ingroup G_IRQ_ToBeRemove 242 /// @param u32Key \b IN: Key 243 /// @param bEnable \b IN: TRUE/FLASE 244 /// @return DRVAESDMA_OK : Success 245 /// @return Others : Fail 246 //------------------------------------------------------------------------------------------------- 247 void MDrv_IRQ_NotifyCpu(IRQ_CPU_TYPE eType); 248 //------------------------------------------------------------------------------------------------- 249 /// MOBF Encrypt 250 /// @ingroup G_IRQ_ToBeRemove 251 /// @param u32Key \b IN: Key 252 /// @param bEnable \b IN: TRUE/FLASE 253 /// @return DRVAESDMA_OK : Success 254 /// @return Others : Fail 255 //------------------------------------------------------------------------------------------------- 256 MS_BOOL MDrv_IRQ_Init(void); 257 //------------------------------------------------------------------------------------------------- 258 /// MOBF Encrypt 259 /// @ingroup G_IRQ_ToBeRemove 260 /// @param u32Key \b IN: Key 261 /// @param bEnable \b IN: TRUE/FLASE 262 /// @return DRVAESDMA_OK : Success 263 /// @return Others : Fail 264 //------------------------------------------------------------------------------------------------- 265 MS_BOOL MDrv_IRQ_InISR(void); 266 //------------------------------------------------------------------------------------------------- 267 /// MOBF Encrypt 268 /// @ingroup G_IRQ_ToBeRemove 269 /// @param u32Key \b IN: Key 270 /// @param bEnable \b IN: TRUE/FLASE 271 /// @return DRVAESDMA_OK : Success 272 /// @return Others : Fail 273 //------------------------------------------------------------------------------------------------- 274 MS_U32 MDrv_IRQ_SetPowerState(EN_POWER_MODE u16PowerState); 275 276 277 #ifdef __cplusplus 278 } 279 #endif 280 281 #endif // _DRV_IRQ_H_ 282 283