xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvCH34.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
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 /// Version string.
120 #define CH34_DRV_VERSION                /* Character String for DRV/API version             */  \
121     MSIF_TAG,                           /* 'MSIF'                                           */  \
122     MSIF_CLASS,                         /* '00'                                             */  \
123     MSIF_CUS,                           /* 0x0000                                           */  \
124     MSIF_MOD,                           /* 0x0000                                           */  \
125     MSIF_CHIP,                                                                                  \
126     MSIF_CPU,                                                                                   \
127     {'C','H','3','4'},                  /* IP__                                             */  \
128     {'0','1'},                          /* 0.0 ~ Z.Z                                        */  \
129     {'0','1'},                          /* 00 ~ 99                                          */  \
130     {'0','0','0','0','0','0','0','0'},  /* CL#                                              */  \
131     MSIF_OS
132 
133 
134 //-------------------------------------------------------------------------------------------------
135 //  Type and Structure
136 //-------------------------------------------------------------------------------------------------
137 
138 typedef enum
139 {
140     ///failed
141     En_Drv_CH34_FAIL = 0,
142     ///success
143     En_Drv_CH34_OK,
144     ///invalid parameter
145     En_Drv_CH34_INVALID_PARAM,
146     ///access not allow
147     En_Drv_CH34_NotSupport,
148 }CH34_Drv_Result;
149 
150 typedef enum
151 {
152     E_CH34_VIDEO_SYS_NTSC = 0,     ///< NTSC
153     E_CH34_VIDEO_SYS_PAL,          ///< PAL
154     E_CH34_VIDEO_SYS_NUM,
155 } E_CH34_VIDEO_SYS;
156 
157 typedef enum
158 {
159     E_CH34_AUDIO_SYS_MONO = 0,     ///< MONO
160     E_CH34_AUDIO_SYS_BTSC,         ///< BTSC_STEREO
161     E_CH34_AUDIO_SYS_BTSC_SAP,     ///< BTSC_SAP
162     E_CH34_AUDIO_SYS_A2,           ///< A2
163     E_CH34_AUDIO_SYS_NUM,
164 } E_CH34_AUDIO_SYS;
165 
166 typedef enum
167 {
168     E_CH34_CH3 = 0,     ///< ch3
169     E_CH34_CH4,          ///< ch4
170     E_CH34_NUM,
171 } E_CH34_CHANNEL;
172 
173 #define CH34_TABLE_OFFSET                  4
174 #define CH34_TABLE_MAX_DEPTH               2000
175 
176 //-------------------------------------------------------------------------------------------------
177 //  Function and Variable
178 //-------------------------------------------------------------------------------------------------
179 
180 CH34_Drv_Result MDrv_Ch34_Init(void);
181 // CH34_Drv_Result MDrv_Ch34_TurnOnOff(MS_BOOL bOn);
182 CH34_Drv_Result MDrv_Ch34_SetMode(E_CH34_CHANNEL channel, E_CH34_VIDEO_SYS videosys, E_CH34_AUDIO_SYS audiosys);
183 // CH34_Drv_Result MDrv_Ch34_WriteCH34Table(MS_U8* pTable);
184 
185 #ifdef __cplusplus
186 }
187 #endif
188 
189 
190 #endif // __DRV_CH34_H__
191 
192