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_SAR_H_ 96 #define _HAL_SAR_H_ 97 98 99 //------------------------------------------------------------------------------------------------- 100 // Macro and Define 101 //------------------------------------------------------------------------------------------------- 102 #define HAL_SAR_CH1 0 103 #define HAL_SAR_CH2 1 104 #define HAL_SAR_CH3 2 105 #define HAL_SAR_CH4 3 106 #define HAL_SAR_CH5 4 107 #define HAL_SAR_CH6 5 108 #define HAL_SAR_CH7 6 109 #define HAL_SAR_CH8 7 110 //sar channel max channel id 111 #define HAL_SAR_CH_MAXID (HAL_SAR_CH8+1) 112 #define HAL_SAR_ADC_DATA_MAX 0xFF 113 114 #define HAL_SAR_LEVEL 1 115 #define HAL_SAR_EDGE 0 116 #define HAL_SAR_FREERUN 1 117 #define HAL_SAR_ONESHOT 0 118 119 #define HAL_SAR_KPD_SUPPCHS 5 120 #define HAL_SAR_KPD_AVLBCHS 5 121 122 //Support RGB ADC HSync Channel Switch 123 #define HAL_SAR_ADC_HSYNC_CH0 0 124 #define HAL_SAR_ADC_HSYNC_CH1 1 125 #define HAL_SAR_ADC_HSYNC_CH2 2 126 #define HAL_SAR_ADC_HSYNC_CH3 3 127 #define HAL_SAR_ADC_HSYNC_MAX 4 128 129 //------------------------------------------------------------------------------------------------- 130 // Type and Structure 131 //------------------------------------------------------------------------------------------------- 132 typedef void(*HAL_SAR_IsrProc)(void* pData); 133 134 typedef struct 135 { 136 MS_U8 u8UpBnd; //upper bound 137 MS_U8 u8LoBnd; //low bound 138 } HAL_SAR_BndCfg; 139 140 typedef struct 141 { 142 MS_U8 u8SARChID; 143 HAL_SAR_BndCfg tSARChBnd; 144 MS_U8 u8KeyLevelNum; 145 MS_U8 u8KeyThreshold[8]; 146 MS_U8 u8KeyCode[8]; 147 } HAL_SAR_RegCfg; 148 149 //------------------------------------------------------------------------------------------------- 150 // Function and Variable 151 //------------------------------------------------------------------------------------------------- 152 void HAL_SAR_SetIOMapBase(MS_VIRT virtBase); 153 MS_VIRT HAL_SAR_GetIOMapBase(void); 154 void HAL_SAR_SetIOMapBase_NPM(MS_VIRT virtBase); 155 MS_VIRT HAL_SAR_GetIOMapBase_NPM(void); 156 157 MS_U8 HAL_SAR_CfgChannelBound(MS_U8 u8Channel ,HAL_SAR_BndCfg *psarBndCfg); 158 void HAL_SAR_CfgSingleChannel(MS_U8 u8Channel); 159 void HAL_SAR_CfgTriggerMode(MS_U8 u8Mode); 160 void HAL_SAR_CfgSingleChannelEn(MS_U8 bEnable); 161 void HAL_SAR_CfgDigitOperMode(MS_U8 u8Mode); 162 void HAL_SAR_CfgDigitPowerdown(MS_U8 bEnable); 163 void HAL_SAR_CfgStart(MS_U8 bEnable); 164 void HAL_SAR_CfgAtopPowerdown(MS_U8 bEnable); 165 void HAL_SAR_CfgAtopFreeRun(MS_U8 bEnable); 166 void HAL_SAR_CfgSelection(MS_U8 bEnable); 167 void HAL_SAR_CfgHighChannel(MS_U8 bEnable); 168 void HAL_SAR_CfgClockSamplePeriod(MS_U8 u8ClkSmpPrd); 169 void HAL_SAR_CfgAanlogInputSelect(MS_U8 u8Channel, MS_BOOL bEnable); 170 void HAL_SAR_CfgOutputEnable(MS_U8 u8Channel, MS_BOOL bEnable); 171 void HAL_SAR_SetOutput(MS_U8 u8Channel, MS_BOOL bHighLow); 172 MS_BOOL HAL_SAR_GetInput(MS_U8 u8Channel); 173 void HAL_SAR_CfgIntMask(MS_U8 bEnable); 174 void HAL_SAR_CfgIntClear(MS_U8 bEnable); 175 void HAL_SAR_CfgIntForce(MS_U8 bEnable); 176 MS_U8 HAL_SAR_GetIntStatus(void); 177 MS_U8 HAL_SAR_GetChannelADC(MS_U8 u8Channel); 178 MS_BOOL HAL_SAR_SetAdcHSyncChannel(MS_U8 u8Channel); 179 MS_BOOL HAL_SAR_Interrupt_EN(MS_U8 u8Channel, MS_BOOL bEnable); 180 MS_BOOL HAL_SAR_Wakeup_EN(MS_BOOL bEnable); 181 void HAL_SAR_CLR_INT(MS_U8 u8Channel); 182 MS_BOOL HAL_SAR_INT_Status(MS_U8 u8Channel); 183 void HAL_SAR_SET_LEVEL(MS_BOOL bLevel); 184 185 186 #endif // _HAL_SAR_H_ 187 188