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 drvCH34.h 98 /// @brief CH34 Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /////////////////////////////////////////////////////////////////////////////////////////////////// 101 102 #ifndef __DRV_CH34_H__ 103 #define __DRV_CH34_H__ 104 105 #ifdef __cplusplus 106 extern "C" 107 { 108 #endif 109 110 111 //------------------------------------------------------------------------------------------------- 112 // Driver Capability 113 //------------------------------------------------------------------------------------------------- 114 115 //------------------------------------------------------------------------------------------------- 116 // Macro and Define 117 //------------------------------------------------------------------------------------------------- 118 119 /// ATTRIBUTE_INFO_EX version of current CH34 lib 120 #define ATTRIBUTE_INFO_VERSION 1 121 #define SET_DAC_OUTPUT_SWING_VERSION 1 122 #define SET_SIGMA_DELTA_GAIN_VERSION 1 123 124 /// Version string. 125 #define CH34_DRV_VERSION /* Character String for DRV/API version */ \ 126 MSIF_TAG, /* 'MSIF' */ \ 127 MSIF_CLASS, /* '00' */ \ 128 MSIF_CUS, /* 0x0000 */ \ 129 MSIF_MOD, /* 0x0000 */ \ 130 MSIF_CHIP, \ 131 MSIF_CPU, \ 132 {'C','H','3','4'}, /* IP__ */ \ 133 {'0','1'}, /* 0.0 ~ Z.Z */ \ 134 {'0','1'}, /* 00 ~ 99 */ \ 135 {'0','0','0','0','0','0','0','0'}, /* CL# */ \ 136 MSIF_OS 137 138 139 //------------------------------------------------------------------------------------------------- 140 // Type and Structure 141 //------------------------------------------------------------------------------------------------- 142 143 typedef enum 144 { 145 ///failed 146 En_Drv_CH34_FAIL = 0, 147 ///success 148 En_Drv_CH34_OK, 149 ///invalid parameter 150 En_Drv_CH34_INVALID_PARAM, 151 ///access not allow 152 En_Drv_CH34_NotSupport, 153 }CH34_Drv_Result; 154 155 typedef enum 156 { 157 E_CH34_VIDEO_SYS_NTSC = 0, ///< NTSC 158 E_CH34_VIDEO_SYS_PAL, ///< PAL 159 E_CH34_VIDEO_SYS_NUM, 160 } E_CH34_VIDEO_SYS; 161 162 typedef enum 163 { 164 E_CH34_AUDIO_SYS_MONO = 0, ///< MONO 165 E_CH34_AUDIO_SYS_BTSC, ///< BTSC_STEREO 166 E_CH34_AUDIO_SYS_BTSC_SAP, ///< BTSC_SAP 167 E_CH34_AUDIO_SYS_A2, ///< A2 168 E_CH34_AUDIO_SYS_NUM, 169 } E_CH34_AUDIO_SYS; 170 171 typedef enum 172 { 173 E_CH34_CH3 = 0, ///< ch3 174 E_CH34_CH4, ///< ch4 175 E_CH34_NUM, 176 } E_CH34_CHANNEL; 177 178 typedef enum{ 179 E_CH34_SPEC_DEFAULT = 0, ///< Default 180 E_CH34_SPEC_ABNT_NBR_15604, ///< ABNT_NBR_15604 spec 181 } E_CH34_SPEC_SELECT; 182 183 typedef enum{ 184 E_CH34_DAC_SWING_LEVEL0 = 0, ///< Dac output swing level0 185 E_CH34_DAC_SWING_LEVEL1, ///< Dac output swing level1 186 E_CH34_DAC_SWING_LEVEL2, ///< Dac output swing level2 187 E_CH34_DAC_SWING_LEVEL3, ///< Dac output swing level3 188 } E_CH34_DAC_SWING_LEVEL; 189 190 typedef enum 191 { 192 E_CH34_SIGMA_DELTA_GAIN_LEVEL0 = 0, ///< Sigma Delta Gain level0, 0.9375 193 E_CH34_SIGMA_DELTA_GAIN_LEVEL1, ///< Sigma Delta Gain level1, 0.875 194 E_CH34_SIGMA_DELTA_GAIN_LEVEL2, ///< Sigma Delta Gain level2, 0.75 195 E_CH34_SIGMA_DELTA_GAIN_LEVEL3, ///< Sigma Delta Gain level3, 0.5 196 } E_CH34_SIGMA_DELTA_GAIN_LEVEL; 197 198 typedef enum 199 { 200 CH34_CMD_NONE = 0, 201 CH34_CMD_SET_DAC_OUTPUT_SWING, 202 CH34_CMD_SET_SIGMA_DELTA_GAIN, 203 CH34_CMD_NUMBER, 204 } CH34_CTRL_ID; 205 206 typedef struct{ 207 MS_U32 u32AttributeInfo_Version; ///<Version of current structure. Please always set to "ATTRIBUTE_INFO_VERSION" as input 208 MS_U16 u16AttributeInfo_Length; ///<Length of this structure, u16AttributeInfo_Length=sizeof(CH34_ATTRIBUTE_INFO) 209 E_CH34_CHANNEL eChannel; 210 E_CH34_VIDEO_SYS eVideoSys; 211 E_CH34_AUDIO_SYS eAudioSys; 212 E_CH34_SPEC_SELECT eSpecSelect; 213 } CH34_ATTRIBUTE_INFO; 214 215 typedef struct{ 216 MS_U32 u32SetDACOutputSwing_Version; ///<Version of current structure. Please always set to "SET_DAC_OUTPUT_SWING_VERSION" as input 217 MS_U16 u16SetDACOutputSwing_Length; ///<Length of this structure, u16SetDACOutputSwing_Length=sizeof(CH34_SET_DAC_OUTPUT_SWING) 218 E_CH34_DAC_SWING_LEVEL eDACSwingLevel; 219 } CH34_SET_DAC_OUTPUT_SWING; 220 221 typedef struct{ 222 MS_U32 u32SetSigmaDeltaGain_Version; ///<Version of current structure. Please always set to "SET_SIGMA_DELTA_GAIN_VERSION" as input 223 MS_U16 u16SetSigmaDeltaGain_Length; ///<Length of this structure, u16SetSigmaDeltaGain_Length=sizeof(CH34_SET_SIGMA_DELTA_GAIN) 224 E_CH34_SIGMA_DELTA_GAIN_LEVEL eSigmaDeltaGainLevel; 225 } CH34_SET_SIGMA_DELTA_GAIN; 226 227 #define CH34_TABLE_OFFSET 4 228 #define CH34_TABLE_MAX_DEPTH 2000 229 230 //------------------------------------------------------------------------------------------------- 231 // Function and Variable 232 //------------------------------------------------------------------------------------------------- 233 234 CH34_Drv_Result MDrv_Ch34_Init(void); 235 CH34_Drv_Result MDrv_Ch34_TurnOnOff(MS_BOOL bOn); 236 CH34_Drv_Result MDrv_Ch34_SetMode(E_CH34_CHANNEL channel, E_CH34_VIDEO_SYS videosys, E_CH34_AUDIO_SYS audiosys); 237 CH34_Drv_Result MDrv_Ch34_WriteCH34Table(MS_U8* pTable); 238 CH34_Drv_Result MDrv_Ch34_SetAttribute(CH34_ATTRIBUTE_INFO* pInfo); 239 MS_BOOL MDrv_Ch34_GeneralCtrl(MS_U32 u32Cmd, void* pBuf, MS_U32 u32BufSize); 240 241 #ifdef __cplusplus 242 } 243 #endif 244 245 246 #endif // __DRV_CH34_H__ 247 248