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 /// @file apiXC_Auto_EX.h 94 /// @brief XC api for Auto 95 /// @author MStar Semiconductor Inc. 96 /// 97 //////////////////////////////////////////////////////////////////////////////// 98 #ifndef _APIXC_AUTO_EX_H_ 99 #define _APIXC_AUTO_EX_H_ 100 101 // Common Definition 102 #include "MsCommon.h" 103 #include "MsOS.h" 104 105 // Driver 106 //#include "drvXC_IOPort_EX.h" 107 108 // Api 109 #include "apiXC_EX.h" 110 #include "apiXC_Adc_EX.h" 111 112 113 #ifdef __cplusplus 114 extern "C" 115 { 116 #endif 117 118 //------------------------------------------------------------------------------------------------- 119 // Include Files 120 //------------------------------------------------------------------------------------------------- 121 122 //------------------------------------------------------------------------------------------------- 123 // Macro and Define 124 //------------------------------------------------------------------------------------------------- 125 #define XC_AUTO_EX_SIGNAL_INFO_VERSION 1 126 127 //------------------------------------------------------------------------------------------------- 128 // Type and Structure 129 //------------------------------------------------------------------------------------------------- 130 typedef enum 131 { 132 E_XC_AUTO_EX_TUNE_NULL = 0x00, 133 134 // Basic auto-tune 135 E_XC_AUTO_EX_TUNE_VALID_DATA = 0x01, 136 E_XC_AUTO_EX_TUNE_POSITION = 0x02, 137 E_XC_AUTO_EX_TUNE_FREQ = 0x04, 138 E_XC_AUTO_EX_TUNE_PHASE = 0x08, 139 E_XC_AUTO_EX_TUNE_BASIC = E_XC_AUTO_EX_TUNE_VALID_DATA | E_XC_AUTO_EX_TUNE_POSITION | E_XC_AUTO_EX_TUNE_FREQ | E_XC_AUTO_EX_TUNE_PHASE, 140 141 // Auto-tune RGB Color 142 E_XC_AUTO_EX_TUNE_RGB_OFFSET = 0x10, 143 E_XC_AUTO_EX_TUNE_RGB_GAIN = 0X20, 144 E_XC_AUTO_EX_TUNE_RGB_COLOR = E_XC_AUTO_EX_TUNE_RGB_OFFSET | E_XC_AUTO_EX_TUNE_RGB_GAIN, 145 146 // Auto-tune YUV Color 147 E_XC_AUTO_EX_TUNE_YUV_COLOR = 0X40, 148 149 E_XC_AUTO_EX_TUNE_SCART_RGB_GAIN = 0x80, 150 151 // Advance auto-tune 152 E_XC_AUTO_EX_TUNE_ADVANCE = E_XC_AUTO_EX_TUNE_BASIC | E_XC_AUTO_EX_TUNE_RGB_COLOR, 153 } XC_Auto_EX_TuneType; 154 155 typedef enum 156 { 157 E_XC_AUTO_EX_INTERNAL_CALIBRATION, 158 E_XC_AUTO_EX_EXTERNAL_CALIBRATION, 159 } XC_Auto_EX_CalibrationType; 160 161 typedef enum 162 { 163 E_XC_AUTO_EX_HW_CALIBRATION, 164 E_XC_AUTO_EX_SW_CALIBRATION, 165 } XC_Auto_EX_CalibrationMode; 166 167 typedef struct 168 { 169 MS_U16 u16HorizontalStart; ///< horizontal start 170 MS_U16 u16VerticalStart; ///< vertical start 171 MS_U16 u16HorizontalTotal; ///< ADC horizontal total 172 MS_U16 u16HResolution; ///< H size 173 MS_U8 u8Phase; ///< obsolete 174 } XC_Auto_EX_Signal_Info; 175 176 typedef struct 177 { 178 MS_U16 u16Version; ///< version 179 MS_U16 u16HorizontalStart; ///< horizontal start 180 MS_U16 u16VerticalStart; ///< vertical start 181 MS_U16 u16HorizontalTotal; ///< ADC horizontal total 182 MS_U16 u16HResolution; ///< H size 183 MS_U16 u16Phase; ///< ADC phase 184 } XC_Auto_EX_Signal_Info_Ex; 185 186 //------------------------------------------------------------------------------------------------- 187 // Function and Variable 188 //------------------------------------------------------------------------------------------------- 189 //************************************************************************* 190 //Function name: MApi_XC_Auto_EX_Geometry 191 //Passing parameter: 192 // enAutoTuneType: Auto function select 193 // ActiveInfo: Current PC mode setting 194 // StandardInfo: Standard mode. (This is singal information of stardard) 195 //Return parameter: 196 // MS_BOOL: Success status. (If faile, return FALSE.) 197 //Description: Auto-tune for PC mode 198 //************************************************************************* 199 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_Geometry(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_TuneType enAutoTuneType, XC_Auto_EX_Signal_Info *ActiveInfo, XC_Auto_EX_Signal_Info *StandardInfo, XC_EX_SCALER_WIN eWindow); 200 201 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_Geometry_Ex(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_TuneType enAutoTuneType, XC_Auto_EX_Signal_Info_Ex *ActiveInfo, XC_Auto_EX_Signal_Info_Ex *StandardInfo, XC_EX_SCALER_WIN eWindow); 202 203 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_StopAutoGeometry(XC_DEVICE_ID *pDeviceId); // Call MApi_XC_Auto_EX_Geometry to restart auto geometry again. 204 205 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_GainOffset(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_CalibrationType type, XC_Auto_EX_TuneType enAutoTuneType, XC_ADC_EX_AdcGainOffsetSetting *pstADCSetting, XC_EX_SCALER_WIN eWindow); 206 207 //*************************************************************************** 208 ///-This function is to get fixed gain for HW calibration 209 /// @param enAutoTuneType \b IN:tune type 210 /// @param pstADCSetting \b OUT:gain value 211 /// @return @ref MS_BOOL 212 //*************************************************************************** 213 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_GetHWFixedGainOffset(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_TuneType enAutoTuneType, XC_ADC_EX_AdcGainOffsetSetting *pstADCSetting); 214 215 //*************************************************************************** 216 ///-This function is to set ValidDataThreshold by customer 217 /// @param Value \b IN:ValidDataThreshold 218 /// @return @ref MS_BOOL 219 //*************************************************************************** 220 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_SetValidData(XC_DEVICE_ID *pDeviceId, MS_U8 Value); 221 222 /******************************************************************************/ 223 /// -This function will recalibration ADC offset, must be called when mode change. 224 /// @param bEnable \b IN: 225 /// - 0: Disable offset recalibration 226 /// - 1: Enable offset recalibration 227 /// @param bIsYPbPrFlag \b IN: to tell if YPbPr in 228 /// - 0: Vga mode 229 /// - 1: YPbPr mode 230 /******************************************************************************/ 231 DLL_PUBLIC void MApi_XC_Auto_EX_AutoOffset(XC_DEVICE_ID *pDeviceId, MS_BOOL bEnable, MS_BOOL bIsYPbPrFlag); 232 233 /******************************************************************************/ 234 /// -This function will try to get the actual mode width for VGA 235 /// @param eWindow \b IN: Window 236 /// @param pSignalInfo \b IN: Input signal info for distinguish 237 /// Note: The result of "MApi_XC_Auto_EX_DetectWidth" will highly depends on the HTT value of pSignalInfo 238 /******************************************************************************/ 239 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_DetectWidth(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_Signal_Info_Ex *pSignalInfo , XC_EX_SCALER_WIN eWindow); 240 241 //*************************************************************************** 242 ///-This function is to set HW or Sw calibration 243 /// @param eMode \b IN: HW or SW mode for calibration 244 /// @return @ref MS_BOOL 245 //*************************************************************************** 246 DLL_PUBLIC MS_BOOL MApi_XC_Auto_EX_SetCalibrationMode(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_CalibrationMode eMode); 247 248 //*************************************************************************** 249 ///-This function is to get HW or Sw calibration 250 /// @param eMode \b OUT: HW or SW mode for calibration 251 //*************************************************************************** 252 DLL_PUBLIC void MApi_XC_Auto_EX_GetCalibrationMode(XC_DEVICE_ID *pDeviceId, XC_Auto_EX_CalibrationMode *eMode); 253 254 255 #ifdef __cplusplus 256 } 257 #endif 258 259 #endif /* _APIXC_AUTO_EX_H_ */ 260