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 apiXC_Dlc.h 98 /// @brief DLC API layer Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 /*! \defgroup Video Video modules 103 104 * \defgroup XC_BE XC_BE modules 105 * \ingroup Video 106 107 XC_BE is used for\n 108 1. Dynamic Backlight Curve : Calculate the DBC base on average value.\n 109 For more information,see \link DBC DBC interface (apiXC_DBC.h) \endlink 110 111 * \defgroup DBC DBC interface (apiXC_DBC.h) 112 * \ingroup XC_BE 113 114 - Dynamic Backlight Curve : Calculate the DBC base on average value. 115 116 <b> Operation Code Flow: </b> \n 117 check flow chart directly. 118 \image html apiXC_DLC_DBC_init_flow.png 119 120 * \defgroup DBC_INIT DBC init control 121 * \ingroup DBC 122 123 *! \defgroup DBC_FEATURE DBC feature operation 124 * \ingroup DBC 125 126 *! \defgroup DBC_INFO DBC Infomation pool 127 * \ingroup DBC 128 129 *! \defgroup DBC_ToBeModified DBC api to be modified 130 * \ingroup DBC 131 132 *! \defgroup DBC_ToBeRemove DBC api to be removed 133 * \ingroup DBC 134 */ 135 136 137 #ifndef _API_XC_DBC_H_ 138 #define _API_XC_DBC_H_ 139 140 #ifdef __cplusplus 141 extern "C" 142 { 143 #endif 144 145 //------------------------------------------------------------------------------------------------- 146 /// DLC DBC initilization 147 /// @ingroup DBC_INIT 148 // @param DLC_DBC_MFinit \b IN: TBD 149 //------------------------------------------------------------------------------------------------- 150 void MApi_XC_DLC_DBC_Init(XC_DLC_DBC_MFinit DLC_DBC_MFinit); 151 152 //------------------------------------------------------------------------------------------------- 153 /// DBC initilization 154 /// @ingroup DBC_INIT 155 //------------------------------------------------------------------------------------------------- 156 void MApi_XC_DBC_Init(void); 157 158 //------------------------------------------------------------------------------------------------- 159 /// DLC DBC set status 160 /// @ingroup DBC_FEATURE 161 // @param bDBCEnable \b IN: TBD 162 //------------------------------------------------------------------------------------------------- 163 void MApi_XC_DLC_DBC_Setstatus(MS_BOOL bDBCEnable); 164 165 //------------------------------------------------------------------------------------------------- 166 /// DLC DBC get status 167 /// @ingroup DBC_INFO 168 /// @return @ref MS_BOOL 169 //------------------------------------------------------------------------------------------------- 170 MS_BOOL MApi_XC_DLC_DBC_Getstatus(void); 171 172 //------------------------------------------------------------------------------------------------- 173 /// Set DBC Ready Mode 174 /// @ingroup DBC_FEATURE 175 // @param bDBCReady \b IN: TBD 176 //------------------------------------------------------------------------------------------------- 177 void MApi_XC_DLC_DBC_SetReady(MS_BOOL bDBCReady); 178 179 //------------------------------------------------------------------------------------------------- 180 /// Set DLC DBC Debug Mode 181 /// @ingroup DBC_FEATURE 182 // @param ucDBC_DebugMode \b IN: TBD 183 //------------------------------------------------------------------------------------------------- 184 void MApi_XC_DLC_DBC_SetDebugMode(MS_U8 ucDBC_DebugMode); 185 186 //------------------------------------------------------------------------------------------------- 187 /// DLC DBC Debug Mode Status 188 /// @ingroup DBC_INFO 189 /// @return @ref MS_U8 190 //------------------------------------------------------------------------------------------------- 191 MS_U8 MApi_XC_DLC_DBC_GetDebugMode(void); 192 193 //------------------------------------------------------------------------------------------------- 194 /// DLC DBC update PWM 195 /// @ingroup DBC_FEATURE 196 /// @param u8PWMvalue \b IN: PWM value to set the lumming 197 //------------------------------------------------------------------------------------------------- 198 void MApi_XC_DLC_DBC_UpdatePWM(MS_U8 u8PWMvalue); 199 200 //------------------------------------------------------------------------------------------------- 201 /// DLC DBC handler 202 /// @ingroup DBC_FEATURE 203 /// @return @ref MS_U16 204 //------------------------------------------------------------------------------------------------- 205 MS_U16 MApi_XC_DLC_DBC_Handler(void); 206 207 //------------------------------------------------------------------------------------------------- 208 /// DLC DBC adjsut YC gain 209 /// @ingroup DBC_FEATURE 210 //------------------------------------------------------------------------------------------------- 211 void MApi_XC_DLC_DBC_AdjustYCGain(void); 212 213 //------------------------------------------------------------------------------------------------- 214 /// DLC DBC YC gain initilization 215 /// @ingroup DBC_INIT 216 // @param u8YGain_M \b IN: TBD 217 // @param u8YGain_L \b IN: TBD 218 // @param u8CGain_M \b IN: TBD 219 // @param u8CGain_L \b IN: TBD 220 //------------------------------------------------------------------------------------------------- 221 void MApi_XC_DLC_DBC_YCGainInit(MS_U8 u8YGain_M, MS_U8 u8YGain_L, MS_U8 u8CGain_M, MS_U8 u8CGain_L); 222 223 //------------------------------------------------------------------------------------------------- 224 /// DLC DBC reset 225 /// @ingroup DBC_FEATURE 226 //------------------------------------------------------------------------------------------------- 227 void MApi_XC_DLC_DBC_Reset(void); 228 229 //------------------------------------------------------------------------------------------------- 230 /// @brief callback functions & struct used to support debug command. 231 //------------------------------------------------------------------------------------------------- 232 typedef void (*MApi_XC_DBC_OnOff_Callback)(MS_BOOL/*On/Off*/); 233 234 //------------------------------------------------------------------------------------------------- 235 /// @brief callback functions & struct used to support debug command. 236 //------------------------------------------------------------------------------------------------- 237 typedef void (*MApi_XC_DBC_AdjustBackLight_Callback)(MS_U32 /*PWM_VALUE*/); 238 239 //------------------------------------------------------------------------------------------------- 240 /// @brief structure used to support debug command. 241 //------------------------------------------------------------------------------------------------- 242 typedef struct { 243 MS_U8 *pCmdBuff; ///<1. command buffer from UART 244 MApi_XC_DBC_OnOff_Callback fnDBC_AP_OnOff; ///<2. Function to control DBC on/off 245 MApi_XC_DBC_AdjustBackLight_Callback fnDBC_AdjustBacklight; ///<3. Functoin to control backlight 246 MApi_XC_DLC_Print_Callback fnDBC_Putchar; ///<4. User putchar function 247 }tDBC_CONTROL_PARAMS; 248 249 //------------------------------------------------------------------------------------------------- 250 /// @brief uart debug command decoder for Dynamic Backlight Control. 251 /// @ingroup DBC_FEATURE 252 /// @param params passin params. 253 //------------------------------------------------------------------------------------------------- 254 void MApi_XC_DBC_DecodeExtCmd(tDBC_CONTROL_PARAMS *params ); 255 256 #ifdef __cplusplus 257 } 258 #endif 259 260 #endif // _API_XC_DBC_H_ 261