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 #ifndef _HAL_PM_H_ 95 #define _HAL_PM_H_ 96 97 //////////////////////////////////////////////////////////////////////////////// 98 /// @file halPM.h 99 /// @author MStar Semiconductor Inc. 100 /// @brief PM control hal 101 //////////////////////////////////////////////////////////////////////////////// 102 103 //////////////////////////////////////////////////////////////////////////////// 104 // Header Files 105 //////////////////////////////////////////////////////////////////////////////// 106 107 //////////////////////////////////////////////////////////////////////////////// 108 // Define & data type 109 //////////////////////////////////////////////////////////////////////////////// 110 typedef enum 111 { 112 PM_RTCIDX_0 = 0, 113 PM_RTCIDX_1 = 1, 114 PM_RTCIDX_MAX = PM_RTCIDX_1, 115 116 } PM_RtcIndex; 117 //////////////////////////////////////////////////////////////////////////////// 118 // Extern function 119 //////////////////////////////////////////////////////////////////////////////// 120 MS_U8 HAL_PM_ReadByte(MS_U32 u32RegAddr); 121 MS_U16 HAL_PM_Read2Byte(MS_U32 u32RegAddr); 122 MS_U32 HAL_PM_Read4Byte(MS_U32 u32RegAddr); 123 MS_BOOL HAL_PM_WriteByte(MS_U32 u32RegAddr, MS_U8 u8Val); 124 MS_BOOL HAL_PM_Write2Byte(MS_U32 u32RegAddr, MS_U16 u16Val); 125 MS_BOOL HAL_PM_Write4Byte(MS_U32 u32RegAddr, MS_U32 u32Val); 126 MS_BOOL HAL_PM_ReadRegBit(MS_U32 u32RegAddr, MS_U8 u8Mask); 127 MS_BOOL HAL_PM_WriteRegBit(MS_U32 u32RegAddr, MS_BOOL bEnable, MS_U8 u8Mask); 128 MS_BOOL HAL_PM_WriteByteMask(MS_U32 u32RegAddr, MS_U8 u8ValIn, MS_U8 u8Msk); 129 void HAL_PM_SetIOMapBase(MS_VIRT virtBase); 130 MS_VIRT HAL_PM_GetIOMapBase(void); 131 //void HAL_PM_Dump_AllReg(void); 132 void HAL_PM_RtcInit(MS_U8 u8RtcIndex, MS_U32 u32RtcCtrlWord); 133 void HAL_PM_RTC_DisableInit(MS_U8 u8RtcIndex); 134 void HAL_PM_RtcSetCounter(MS_U8 u8RtcIndex, MS_U32 u32RtcSetCounter); 135 MS_U32 HAL_PM_RtcGetCounter(MS_U8 u8RtcIndex); 136 void HAL_PM_RtcSetMatchCounter(MS_U8 u8RtcIndex, MS_U32 u32RtcSetMatchCounter); 137 MS_U32 HAL_PM_RtcGetMatchCounter(MS_U8 u8RtcIndex); 138 void HAL_PM_SetSPIOffsetForMCU(MS_U32 BANK); 139 void HAL_PM_SetSRAMOffsetForMCU(void); 140 MS_BOOL HAL_PM_SetDRAMOffsetForMCU(MS_U32 u32Offset); 141 MS_U8 HAL_PM_PowerOnMode(void); 142 MS_U8 HAL_PM_GetWakeupSource(void); 143 MS_U8 HAL_PM_GetWakeupKey(void); 144 void HAL_PM_Disable51(void); 145 MS_BOOL HAL_PM_isRunning(void); 146 void HAL_PM_SetBackGroundTrigger(MS_BOOL bTrigger); 147 MS_BOOL HAL_PM_GetBackGroundActive(void); 148 149 void HAL_PM_GPIO4_SetPower(MS_BOOL bOn); 150 151 void HAL_PM_SetScratchPad(MS_U8 u8PadNum,MS_U16 u16Val); 152 MS_BOOL HAL_PM_GetScratchPad(MS_U8 u8PadNum,MS_U16 *u16Val); 153 154 MS_BOOL HAL_PM_GetVersion(MS_U8 *u8Val); 155 MS_U16 HAL_PM_GetSRAMSize(void); 156 MS_U8 HAL_PM_GetIRPowerOnKey(void); 157 void HAL_PM_SetWakupDevice(MS_U16 u16WakeSrc); 158 void HAL_PM_GetRT51Status(void); 159 #endif //_HAL_PM_H_ 160 161