xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvVBI.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1*53ee8cc1Swenshuai.xi //<MStar Software>
2*53ee8cc1Swenshuai.xi //******************************************************************************
3*53ee8cc1Swenshuai.xi // MStar Software
4*53ee8cc1Swenshuai.xi // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5*53ee8cc1Swenshuai.xi // All software, firmware and related documentation herein ("MStar Software") are
6*53ee8cc1Swenshuai.xi // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7*53ee8cc1Swenshuai.xi // law, including, but not limited to, copyright law and international treaties.
8*53ee8cc1Swenshuai.xi // Any use, modification, reproduction, retransmission, or republication of all
9*53ee8cc1Swenshuai.xi // or part of MStar Software is expressly prohibited, unless prior written
10*53ee8cc1Swenshuai.xi // permission has been granted by MStar.
11*53ee8cc1Swenshuai.xi //
12*53ee8cc1Swenshuai.xi // By accessing, browsing and/or using MStar Software, you acknowledge that you
13*53ee8cc1Swenshuai.xi // have read, understood, and agree, to be bound by below terms ("Terms") and to
14*53ee8cc1Swenshuai.xi // comply with all applicable laws and regulations:
15*53ee8cc1Swenshuai.xi //
16*53ee8cc1Swenshuai.xi // 1. MStar shall retain any and all right, ownership and interest to MStar
17*53ee8cc1Swenshuai.xi //    Software and any modification/derivatives thereof.
18*53ee8cc1Swenshuai.xi //    No right, ownership, or interest to MStar Software and any
19*53ee8cc1Swenshuai.xi //    modification/derivatives thereof is transferred to you under Terms.
20*53ee8cc1Swenshuai.xi //
21*53ee8cc1Swenshuai.xi // 2. You understand that MStar Software might include, incorporate or be
22*53ee8cc1Swenshuai.xi //    supplied together with third party`s software and the use of MStar
23*53ee8cc1Swenshuai.xi //    Software may require additional licenses from third parties.
24*53ee8cc1Swenshuai.xi //    Therefore, you hereby agree it is your sole responsibility to separately
25*53ee8cc1Swenshuai.xi //    obtain any and all third party right and license necessary for your use of
26*53ee8cc1Swenshuai.xi //    such third party`s software.
27*53ee8cc1Swenshuai.xi //
28*53ee8cc1Swenshuai.xi // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29*53ee8cc1Swenshuai.xi //    MStar`s confidential information and you agree to keep MStar`s
30*53ee8cc1Swenshuai.xi //    confidential information in strictest confidence and not disclose to any
31*53ee8cc1Swenshuai.xi //    third party.
32*53ee8cc1Swenshuai.xi //
33*53ee8cc1Swenshuai.xi // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34*53ee8cc1Swenshuai.xi //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35*53ee8cc1Swenshuai.xi //    without limitation, any warranties of merchantability, non-infringement of
36*53ee8cc1Swenshuai.xi //    intellectual property rights, fitness for a particular purpose, error free
37*53ee8cc1Swenshuai.xi //    and in conformity with any international standard.  You agree to waive any
38*53ee8cc1Swenshuai.xi //    claim against MStar for any loss, damage, cost or expense that you may
39*53ee8cc1Swenshuai.xi //    incur related to your use of MStar Software.
40*53ee8cc1Swenshuai.xi //    In no event shall MStar be liable for any direct, indirect, incidental or
41*53ee8cc1Swenshuai.xi //    consequential damages, including without limitation, lost of profit or
42*53ee8cc1Swenshuai.xi //    revenues, lost or damage of data, and unauthorized system use.
43*53ee8cc1Swenshuai.xi //    You agree that this Section 4 shall still apply without being affected
44*53ee8cc1Swenshuai.xi //    even if MStar Software has been modified by MStar in accordance with your
45*53ee8cc1Swenshuai.xi //    request or instruction for your use, except otherwise agreed by both
46*53ee8cc1Swenshuai.xi //    parties in writing.
47*53ee8cc1Swenshuai.xi //
48*53ee8cc1Swenshuai.xi // 5. If requested, MStar may from time to time provide technical supports or
49*53ee8cc1Swenshuai.xi //    services in relation with MStar Software to you for your use of
50*53ee8cc1Swenshuai.xi //    MStar Software in conjunction with your or your customer`s product
51*53ee8cc1Swenshuai.xi //    ("Services").
52*53ee8cc1Swenshuai.xi //    You understand and agree that, except otherwise agreed by both parties in
53*53ee8cc1Swenshuai.xi //    writing, Services are provided on an "AS IS" basis and the warranty
54*53ee8cc1Swenshuai.xi //    disclaimer set forth in Section 4 above shall apply.
55*53ee8cc1Swenshuai.xi //
56*53ee8cc1Swenshuai.xi // 6. Nothing contained herein shall be construed as by implication, estoppels
57*53ee8cc1Swenshuai.xi //    or otherwise:
58*53ee8cc1Swenshuai.xi //    (a) conferring any license or right to use MStar name, trademark, service
59*53ee8cc1Swenshuai.xi //        mark, symbol or any other identification;
60*53ee8cc1Swenshuai.xi //    (b) obligating MStar or any of its affiliates to furnish any person,
61*53ee8cc1Swenshuai.xi //        including without limitation, you and your customers, any assistance
62*53ee8cc1Swenshuai.xi //        of any kind whatsoever, or any information; or
63*53ee8cc1Swenshuai.xi //    (c) conferring any license or right under any intellectual property right.
64*53ee8cc1Swenshuai.xi //
65*53ee8cc1Swenshuai.xi // 7. These terms shall be governed by and construed in accordance with the laws
66*53ee8cc1Swenshuai.xi //    of Taiwan, R.O.C., excluding its conflict of law rules.
67*53ee8cc1Swenshuai.xi //    Any and all dispute arising out hereof or related hereto shall be finally
68*53ee8cc1Swenshuai.xi //    settled by arbitration referred to the Chinese Arbitration Association,
69*53ee8cc1Swenshuai.xi //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70*53ee8cc1Swenshuai.xi //    Rules of the Association by three (3) arbitrators appointed in accordance
71*53ee8cc1Swenshuai.xi //    with the said Rules.
72*53ee8cc1Swenshuai.xi //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73*53ee8cc1Swenshuai.xi //    be English.
74*53ee8cc1Swenshuai.xi //    The arbitration award shall be final and binding to both parties.
75*53ee8cc1Swenshuai.xi //
76*53ee8cc1Swenshuai.xi //******************************************************************************
77*53ee8cc1Swenshuai.xi //<MStar Software>
78*53ee8cc1Swenshuai.xi ////////////////////////////////////////////////////////////////////////////////
79*53ee8cc1Swenshuai.xi //
80*53ee8cc1Swenshuai.xi // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81*53ee8cc1Swenshuai.xi // All rights reserved.
82*53ee8cc1Swenshuai.xi //
83*53ee8cc1Swenshuai.xi // Unless otherwise stipulated in writing, any and all information contained
84*53ee8cc1Swenshuai.xi // herein regardless in any format shall remain the sole proprietary of
85*53ee8cc1Swenshuai.xi // MStar Semiconductor Inc. and be kept in strict confidence
86*53ee8cc1Swenshuai.xi // (!��MStar Confidential Information!�L) by the recipient.
87*53ee8cc1Swenshuai.xi // Any unauthorized act including without limitation unauthorized disclosure,
88*53ee8cc1Swenshuai.xi // copying, use, reproduction, sale, distribution, modification, disassembling,
89*53ee8cc1Swenshuai.xi // reverse engineering and compiling of the contents of MStar Confidential
90*53ee8cc1Swenshuai.xi // Information is unlawful and strictly prohibited. MStar hereby reserves the
91*53ee8cc1Swenshuai.xi // rights to any and all damages, losses, costs and expenses resulting therefrom.
92*53ee8cc1Swenshuai.xi //
93*53ee8cc1Swenshuai.xi ////////////////////////////////////////////////////////////////////////////////
94*53ee8cc1Swenshuai.xi 
95*53ee8cc1Swenshuai.xi ///////////////////////////////////////////////////////////////////////////////////////////////////
96*53ee8cc1Swenshuai.xi ///
97*53ee8cc1Swenshuai.xi /// @file   drvVBI.h
98*53ee8cc1Swenshuai.xi /// @brief  MStar VBI Driver Interface
99*53ee8cc1Swenshuai.xi /// @author MStar Semiconductor Inc.
100*53ee8cc1Swenshuai.xi /// @version 1.0
101*53ee8cc1Swenshuai.xi ///////////////////////////////////////////////////////////////////////////////////////////////////
102*53ee8cc1Swenshuai.xi 
103*53ee8cc1Swenshuai.xi //-------------------------------------------------
104*53ee8cc1Swenshuai.xi /*! \defgroup VBI VBI interface
105*53ee8cc1Swenshuai.xi     \ingroup  VBI
106*53ee8cc1Swenshuai.xi 
107*53ee8cc1Swenshuai.xi     <b> Operation Code Flow: </b> \n
108*53ee8cc1Swenshuai.xi     \image html vbi1.png
109*53ee8cc1Swenshuai.xi     \image html vbi2.png
110*53ee8cc1Swenshuai.xi 
111*53ee8cc1Swenshuai.xi   *! \defgroup VBI_General VBI general functions
112*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
113*53ee8cc1Swenshuai.xi 
114*53ee8cc1Swenshuai.xi   *! \defgroup VBI_Task VBI process functions.
115*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
116*53ee8cc1Swenshuai.xi 
117*53ee8cc1Swenshuai.xi   *! \defgroup VBI_TTX VBI TTX related functions
118*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
119*53ee8cc1Swenshuai.xi 
120*53ee8cc1Swenshuai.xi   *! \defgroup VBI_CC VBI CC related functions
121*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
122*53ee8cc1Swenshuai.xi 
123*53ee8cc1Swenshuai.xi   *! \defgroup VBI_STR VBI STR functions
124*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
125*53ee8cc1Swenshuai.xi 
126*53ee8cc1Swenshuai.xi   *! \defgroup VBI_ToBeModified VBI api to be modified
127*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
128*53ee8cc1Swenshuai.xi 
129*53ee8cc1Swenshuai.xi   *! \defgroup VBI_TTX_ToBeModified VBI TTX api to be modified
130*53ee8cc1Swenshuai.xi   *   \ingroup   VBI_ToBeModified
131*53ee8cc1Swenshuai.xi 
132*53ee8cc1Swenshuai.xi   *! \defgroup VBI_ToBeRemove VBI api to be removed
133*53ee8cc1Swenshuai.xi   *   \ingroup   VBI
134*53ee8cc1Swenshuai.xi   */
135*53ee8cc1Swenshuai.xi //-------------------------------------------------
136*53ee8cc1Swenshuai.xi 
137*53ee8cc1Swenshuai.xi #ifndef _DRV_VBI_H
138*53ee8cc1Swenshuai.xi #define _DRV_VBI_H
139*53ee8cc1Swenshuai.xi 
140*53ee8cc1Swenshuai.xi #include "MsTypes.h"
141*53ee8cc1Swenshuai.xi #include "MsDevice.h"
142*53ee8cc1Swenshuai.xi 
143*53ee8cc1Swenshuai.xi #include "ULog.h"
144*53ee8cc1Swenshuai.xi 
145*53ee8cc1Swenshuai.xi #ifdef __cplusplus
146*53ee8cc1Swenshuai.xi extern "C"
147*53ee8cc1Swenshuai.xi {
148*53ee8cc1Swenshuai.xi #endif
149*53ee8cc1Swenshuai.xi 
150*53ee8cc1Swenshuai.xi #define VBI_UTOPIA20 (1)
151*53ee8cc1Swenshuai.xi 
152*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
153*53ee8cc1Swenshuai.xi //  Driver Capability
154*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
155*53ee8cc1Swenshuai.xi 
156*53ee8cc1Swenshuai.xi 
157*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
158*53ee8cc1Swenshuai.xi //  Macro and Define
159*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
160*53ee8cc1Swenshuai.xi #define VBI_TTX_DATA_LENGTH 48
161*53ee8cc1Swenshuai.xi 
162*53ee8cc1Swenshuai.xi #define MSIF_VBI_LIB_CODE                   {'V','B','I','_'} //Lib code
163*53ee8cc1Swenshuai.xi #define MSIF_VBI_LIBVER                        {'0','0'}      //LIB version
164*53ee8cc1Swenshuai.xi #define MSIF_VBI_BUILDNUM                 {'0','2' }    //Build Number
165*53ee8cc1Swenshuai.xi #define MSIF_VBI_CHANGELIST             {'0','0','5','6','5','9','8','0'} //P4 ChangeList Number
166*53ee8cc1Swenshuai.xi #define VBI_VER                  /* Character String for DRV/API version             */  \
167*53ee8cc1Swenshuai.xi     MSIF_TAG,                           /* 'MSIF'                                           */  \
168*53ee8cc1Swenshuai.xi     MSIF_CLASS,                         /* '00'                                             */  \
169*53ee8cc1Swenshuai.xi     MSIF_CUS,                           /* 0x0000                                           */  \
170*53ee8cc1Swenshuai.xi     MSIF_MOD,                           /* 0x0000                                           */  \
171*53ee8cc1Swenshuai.xi     MSIF_CHIP,                                                                                  \
172*53ee8cc1Swenshuai.xi     MSIF_CPU,                                                                                   \
173*53ee8cc1Swenshuai.xi     MSIF_VBI_LIB_CODE,                  /* IP__                                             */  \
174*53ee8cc1Swenshuai.xi     MSIF_VBI_LIBVER,                       /* 0.0 ~ Z.Z                                        */  \
175*53ee8cc1Swenshuai.xi     MSIF_VBI_BUILDNUM,                 /* 00 ~ 99                                          */  \
176*53ee8cc1Swenshuai.xi     MSIF_VBI_CHANGELIST,             /* CL#                                              */  \
177*53ee8cc1Swenshuai.xi     MSIF_OS
178*53ee8cc1Swenshuai.xi 
179*53ee8cc1Swenshuai.xi 
180*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
181*53ee8cc1Swenshuai.xi //  Type and Structure
182*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
183*53ee8cc1Swenshuai.xi typedef enum
184*53ee8cc1Swenshuai.xi {
185*53ee8cc1Swenshuai.xi     VBI_VIDEO_SECAM,
186*53ee8cc1Swenshuai.xi     VBI_VIDEO_PAL_NC,
187*53ee8cc1Swenshuai.xi     VBI_VIDEO_PAL_M,
188*53ee8cc1Swenshuai.xi     VBI_VIDEO_NTSC,
189*53ee8cc1Swenshuai.xi     VBI_VIDEO_NTSC443_PAL60,
190*53ee8cc1Swenshuai.xi     VBI_VIDEO_PAL,
191*53ee8cc1Swenshuai.xi     VBI_VIDEO_OTHERS
192*53ee8cc1Swenshuai.xi } VBI_VIDEO_STANDARD;
193*53ee8cc1Swenshuai.xi 
194*53ee8cc1Swenshuai.xi typedef enum
195*53ee8cc1Swenshuai.xi {
196*53ee8cc1Swenshuai.xi     E_VBI_TELETEXT,
197*53ee8cc1Swenshuai.xi     E_VBI_CC
198*53ee8cc1Swenshuai.xi } VBI_INIT_TYPE;
199*53ee8cc1Swenshuai.xi 
200*53ee8cc1Swenshuai.xi typedef struct
201*53ee8cc1Swenshuai.xi {
202*53ee8cc1Swenshuai.xi     MS_U8   u8NoInfo;
203*53ee8cc1Swenshuai.xi } VBI_DrvInfo;
204*53ee8cc1Swenshuai.xi 
205*53ee8cc1Swenshuai.xi typedef struct
206*53ee8cc1Swenshuai.xi {
207*53ee8cc1Swenshuai.xi     VBI_INIT_TYPE   eInitType;
208*53ee8cc1Swenshuai.xi } VBI_DrvStatus;
209*53ee8cc1Swenshuai.xi 
210*53ee8cc1Swenshuai.xi typedef struct
211*53ee8cc1Swenshuai.xi {
212*53ee8cc1Swenshuai.xi     MS_BOOL _bSuspend;
213*53ee8cc1Swenshuai.xi     VBI_INIT_TYPE eInitType;
214*53ee8cc1Swenshuai.xi     MS_VIRT _ptrVBIRiuBaseAddr;
215*53ee8cc1Swenshuai.xi 
216*53ee8cc1Swenshuai.xi     // TTX buffer address & buffer size
217*53ee8cc1Swenshuai.xi     MS_PHY  _TTXBufAddr;
218*53ee8cc1Swenshuai.xi     MS_U16  _TTXBufLen;
219*53ee8cc1Swenshuai.xi 
220*53ee8cc1Swenshuai.xi     // CC buffer address & buffer size
221*53ee8cc1Swenshuai.xi     MS_PHY  _CCBufAddr;
222*53ee8cc1Swenshuai.xi     MS_U16  _CCBufLen;
223*53ee8cc1Swenshuai.xi 
224*53ee8cc1Swenshuai.xi     // callback info
225*53ee8cc1Swenshuai.xi     MS_PHY  _cbBufferAddr;
226*53ee8cc1Swenshuai.xi     MS_U32  _cbBufferLength;
227*53ee8cc1Swenshuai.xi     MS_U8  *_pCbVABuff;
228*53ee8cc1Swenshuai.xi 
229*53ee8cc1Swenshuai.xi     MS_BOOL  _bTTXSupported;
230*53ee8cc1Swenshuai.xi     MS_BOOL  _bVBIInit;
231*53ee8cc1Swenshuai.xi     MS_U16  _u16VBIDbgSwitch;
232*53ee8cc1Swenshuai.xi } VBI_StoreInfo;
233*53ee8cc1Swenshuai.xi 
234*53ee8cc1Swenshuai.xi /*
235*53ee8cc1Swenshuai.xi  * ClosedCaption
236*53ee8cc1Swenshuai.xi  */
237*53ee8cc1Swenshuai.xi typedef enum
238*53ee8cc1Swenshuai.xi {
239*53ee8cc1Swenshuai.xi     VBI_CC_PACKET_COUNT,
240*53ee8cc1Swenshuai.xi     VBI_CC_BYTE_FOUND_INDICATION,
241*53ee8cc1Swenshuai.xi     VBI_CC_DATA_GET
242*53ee8cc1Swenshuai.xi 
243*53ee8cc1Swenshuai.xi } EN_VBI_INFO;
244*53ee8cc1Swenshuai.xi 
245*53ee8cc1Swenshuai.xi /* Error code */
246*53ee8cc1Swenshuai.xi typedef enum
247*53ee8cc1Swenshuai.xi {
248*53ee8cc1Swenshuai.xi     VBI_ERRORCODE_SUCCESS            = 0x0000,
249*53ee8cc1Swenshuai.xi     VBI_ERRORCODE_FAIL               = 0x0001
250*53ee8cc1Swenshuai.xi 
251*53ee8cc1Swenshuai.xi } EN_VBI_ERRORCODE;
252*53ee8cc1Swenshuai.xi 
253*53ee8cc1Swenshuai.xi typedef enum
254*53ee8cc1Swenshuai.xi {
255*53ee8cc1Swenshuai.xi     EN_TTX_DMA_HEADER,
256*53ee8cc1Swenshuai.xi     EN_TTX_DMA_PACKET1_TO_25,
257*53ee8cc1Swenshuai.xi     EN_TTX_DMA_PACKET26_28_29,
258*53ee8cc1Swenshuai.xi     EN_TTX_DMA_PACKET27,
259*53ee8cc1Swenshuai.xi     EN_TTX_DMA_BTT,
260*53ee8cc1Swenshuai.xi     EN_TTX_DMA_AIT,
261*53ee8cc1Swenshuai.xi } EN_TTX_DMA_TYPE;
262*53ee8cc1Swenshuai.xi 
263*53ee8cc1Swenshuai.xi typedef enum
264*53ee8cc1Swenshuai.xi {
265*53ee8cc1Swenshuai.xi     VBI_INIT,
266*53ee8cc1Swenshuai.xi     VBI_EXIT,
267*53ee8cc1Swenshuai.xi     VBI_SUSPEND,
268*53ee8cc1Swenshuai.xi     VBI_RESUME,
269*53ee8cc1Swenshuai.xi } EN_VBI_CMD;
270*53ee8cc1Swenshuai.xi 
271*53ee8cc1Swenshuai.xi typedef MS_U32(*VBI_CB_FN)(MS_U8 *pVBILine, MS_U32 length);
272*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
273*53ee8cc1Swenshuai.xi //  Function and Variable
274*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
275*53ee8cc1Swenshuai.xi 
276*53ee8cc1Swenshuai.xi // must have functions
277*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
278*53ee8cc1Swenshuai.xi /// Get VBI lib version.
279*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
280*53ee8cc1Swenshuai.xi /// @param  pFN             \b OUT: return vbi lib version.
281*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
282*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
283*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
284*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_GetLibVer(const MSIF_Version **ppVersion);                  ///< Get version (without Mutex protect)
285*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
286*53ee8cc1Swenshuai.xi /// Get VBI module info.
287*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
288*53ee8cc1Swenshuai.xi /// @return VBI_DrvInfo
289*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
290*53ee8cc1Swenshuai.xi // const VBI_DrvInfo * MDrv_VBI_GetInfo(void);              ///< Get info from driver (without Mutex protect)
291*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
292*53ee8cc1Swenshuai.xi /// Get VBI Driver Status.
293*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
294*53ee8cc1Swenshuai.xi /// @param  pDrvStatus    \b OUT: driver status.
295*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
296*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
297*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
298*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_GetStatus(VBI_DrvStatus *pDrvStatus);   ///< Get VBI current status
299*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
300*53ee8cc1Swenshuai.xi /// Set VBI Debug Level.
301*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
302*53ee8cc1Swenshuai.xi /// @param  u16DbgSwitch    \b IN: debug level.
303*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
304*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
305*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
306*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_SetDbgLevel(MS_U16 u16DbgSwitch);       ///< Set debug level (without Mutex protect)
307*53ee8cc1Swenshuai.xi 
308*53ee8cc1Swenshuai.xi //-----------------
309*53ee8cc1Swenshuai.xi // VBI_General
310*53ee8cc1Swenshuai.xi //-----------------
311*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
312*53ee8cc1Swenshuai.xi /// Initialize VBI module
313*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
314*53ee8cc1Swenshuai.xi /// @param  type      \b IN: VBI type (Teletext/CC)
315*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
316*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
317*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
318*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_Init(VBI_INIT_TYPE type);
319*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
320*53ee8cc1Swenshuai.xi /// Finalize VBI module
321*53ee8cc1Swenshuai.xi /// @ingroup VBI_General
322*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
323*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
324*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
325*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_Exit(void);
326*53ee8cc1Swenshuai.xi 
327*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
328*53ee8cc1Swenshuai.xi /// Set Callback to VBI driver, the CB will be called if VBI interrupt is catched
329*53ee8cc1Swenshuai.xi /// @ingroup VBI_Task
330*53ee8cc1Swenshuai.xi /// @param  pFN              \b IN: call back function pointer.
331*53ee8cc1Swenshuai.xi /// @param  bufferAddr    \b IN: the physical address of buffer which will store VBI data and pass pointer to CB
332*53ee8cc1Swenshuai.xi /// @param  length           \b IN: the data lebgth of th input buffer. Note: it should be the multiple of VBI_TTX_DATA_LENGTH
333*53ee8cc1Swenshuai.xi /// @return None
334*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
335*53ee8cc1Swenshuai.xi // void MDrv_VBI_RegisterCB(VBI_CB_FN pFN, MS_PHY bufferAddr, MS_U32 length);
336*53ee8cc1Swenshuai.xi 
337*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
338*53ee8cc1Swenshuai.xi /// Reset TTX Ring Buffer
339*53ee8cc1Swenshuai.xi /// @ingroup VBI_Task
340*53ee8cc1Swenshuai.xi /// @return None
341*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
342*53ee8cc1Swenshuai.xi void MDrv_VBI_RingBuffer_Reset(void);
343*53ee8cc1Swenshuai.xi 
344*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
345*53ee8cc1Swenshuai.xi /// Initialize TTX Slicer.
346*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
347*53ee8cc1Swenshuai.xi /// @param  bufferAddr     \b IN: TTX buffer address.
348*53ee8cc1Swenshuai.xi /// @param  packetCount  \b IN: TTX packet count.
349*53ee8cc1Swenshuai.xi /// @return None
350*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
351*53ee8cc1Swenshuai.xi void MDrv_VBI_InitializeTTXSlicer(MS_PHY bufferAddr, MS_U16 packetCount);
352*53ee8cc1Swenshuai.xi 
353*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
354*53ee8cc1Swenshuai.xi /// Enable TTX Slicer.
355*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
356*53ee8cc1Swenshuai.xi /// @param bEnable     \b IN: enable or disable TTX slicer.
357*53ee8cc1Swenshuai.xi /// @return None
358*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
359*53ee8cc1Swenshuai.xi void MDrv_VBI_EnableTTXSlicer(MS_BOOL bEnable);
360*53ee8cc1Swenshuai.xi 
361*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
362*53ee8cc1Swenshuai.xi /// VPS Is Ready or Not. (Refine function name: MDrv_VBI_TTX_IsVPS_Ready)
363*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
364*53ee8cc1Swenshuai.xi /// @return TRUE  : VPS is ready.
365*53ee8cc1Swenshuai.xi /// @return FALSE : VPS is not ready.
366*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
367*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_IsVPS_Ready(void);
368*53ee8cc1Swenshuai.xi 
369*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
370*53ee8cc1Swenshuai.xi /// TTX Is Ready or Not.
371*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
372*53ee8cc1Swenshuai.xi /// @return TRUE  : TTX is ready.
373*53ee8cc1Swenshuai.xi /// @return FALSE : TTX is not ready.
374*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
375*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_IsTTX_Ready(void);
376*53ee8cc1Swenshuai.xi 
377*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
378*53ee8cc1Swenshuai.xi /// WSS Is Ready or Not. (Refine function name: MDrv_VBI_TTX_IsWSS_Ready)
379*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
380*53ee8cc1Swenshuai.xi /// @return TRUE  : WSS is ready.
381*53ee8cc1Swenshuai.xi /// @return FALSE : WSS is not ready.
382*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
383*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_IsWSS_Ready(void);
384*53ee8cc1Swenshuai.xi 
385*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
386*53ee8cc1Swenshuai.xi /// Get WSS Data. (Refine function name: MDrv_VBI_TTX_GetWSS_Data)
387*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
388*53ee8cc1Swenshuai.xi /// @return : WSS data
389*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
390*53ee8cc1Swenshuai.xi MS_U16 MDrv_VBI_GetWSS_Data(void);
391*53ee8cc1Swenshuai.xi 
392*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
393*53ee8cc1Swenshuai.xi /// Get VPS Data. (Refine function name: MDrv_VBI_TTX_GetVPS_Data)
394*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
395*53ee8cc1Swenshuai.xi /// @param  lowerWord    \b OUT: VPS lower data.
396*53ee8cc1Swenshuai.xi /// @param  higherWord   \b OUT: VPS higher data.
397*53ee8cc1Swenshuai.xi /// @return None
398*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
399*53ee8cc1Swenshuai.xi void MDrv_VBI_GetVPS_Data(MS_U8 *lowerWord, MS_U8 *higherWord);
400*53ee8cc1Swenshuai.xi 
401*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
402*53ee8cc1Swenshuai.xi /// Set Video Standard. (Refine function name: MDrv_VBI_TTX_SetVideoStandard)
403*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
404*53ee8cc1Swenshuai.xi /// @param  lowerWord    \b IN: type (NTSC/PAL/SECAM). See VBI_VIDEO_STANDARD.
405*53ee8cc1Swenshuai.xi /// @return None
406*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
407*53ee8cc1Swenshuai.xi void MDrv_VBI_SetVideoStandard(VBI_VIDEO_STANDARD eStandard);
408*53ee8cc1Swenshuai.xi 
409*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
410*53ee8cc1Swenshuai.xi /// Check TTX circuit ready.
411*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
412*53ee8cc1Swenshuai.xi /// @return TRUE  : TTX circuit is ready.
413*53ee8cc1Swenshuai.xi /// @return FALSE : TTX circuit is not ready.
414*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
415*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_TTX_CheckCircuitReady(void);
416*53ee8cc1Swenshuai.xi 
417*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
418*53ee8cc1Swenshuai.xi /// Get TTX Packet Count.
419*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
420*53ee8cc1Swenshuai.xi /// @return : TTX packet count
421*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
422*53ee8cc1Swenshuai.xi // MS_U16 MDrv_VBI_TTX_GetPacketCount(void);
423*53ee8cc1Swenshuai.xi 
424*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
425*53ee8cc1Swenshuai.xi /// Check if the TTX packet in VBI buffer is empty.
426*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
427*53ee8cc1Swenshuai.xi /// @return TRUE  : TTX buffer is empty.
428*53ee8cc1Swenshuai.xi /// @return FALSE : TTX buffer is not empty.
429*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
430*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_TTX_PacketBufferIsEmpty(void);
431*53ee8cc1Swenshuai.xi 
432*53ee8cc1Swenshuai.xi // Get all of the packets in the VBI buffer (if the input buffer is big enough)
433*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
434*53ee8cc1Swenshuai.xi /// Get TTX Packets. (Get all of the packets in the VBI buffer (if the input buffer is big enough))
435*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
436*53ee8cc1Swenshuai.xi /// @param  dataAddr   \b IN:   Data address.
437*53ee8cc1Swenshuai.xi /// @param  length       \b OUT: Packet length.
438*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
439*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
440*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
441*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_TTX_GetPackets(MS_PHY dataAddr, MS_U32 *length);
442*53ee8cc1Swenshuai.xi 
443*53ee8cc1Swenshuai.xi // Get 1 of the packets in the VBI buffer
444*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
445*53ee8cc1Swenshuai.xi /// Get TTX Packets. (Get 1 of the packets in the VBI buffer)
446*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
447*53ee8cc1Swenshuai.xi /// @param  packetAddress   \b OUT: Packet address
448*53ee8cc1Swenshuai.xi /// @return TRUE  : Get TTX packet successfully.
449*53ee8cc1Swenshuai.xi /// @return FALSE : Get TTX packet unsuccessfully.
450*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
451*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_TTX_GetPacket(MS_PHY *packetAddress);
452*53ee8cc1Swenshuai.xi 
453*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
454*53ee8cc1Swenshuai.xi /// Check if there is a packet buffer overflow. If there is an overflow,
455*53ee8cc1Swenshuai.xi /// the the packet buffer should be cleared from the reading task.
456*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
457*53ee8cc1Swenshuai.xi /// @return TRUE  : TTX buffer is overflow.
458*53ee8cc1Swenshuai.xi /// @return FALSE : Otherwise.
459*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
460*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_TTX_PacketBufferIsOverflow( void );
461*53ee8cc1Swenshuai.xi 
462*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
463*53ee8cc1Swenshuai.xi /// Resuren the nomber of packet buffer overflows since the last reset or creation.
464*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
465*53ee8cc1Swenshuai.xi /// @return : The number of packet buffer overflows.
466*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
467*53ee8cc1Swenshuai.xi MS_U16 MDrv_VBI_TTX_PacketBufferGetNoOfOverflows( void );
468*53ee8cc1Swenshuai.xi 
469*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
470*53ee8cc1Swenshuai.xi /// Set TTX Enable Line
471*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX
472*53ee8cc1Swenshuai.xi /// @param  StartLine   \b IN: TTX start line
473*53ee8cc1Swenshuai.xi /// @param  EndLine    \b IN: TTX end line
474*53ee8cc1Swenshuai.xi /// @return None
475*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
476*53ee8cc1Swenshuai.xi void MDrv_VBI_TTX_EnableLine(MS_U16 StartLine, MS_U16 EndLine);
477*53ee8cc1Swenshuai.xi 
478*53ee8cc1Swenshuai.xi 
479*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
480*53ee8cc1Swenshuai.xi /// Restrict vbi memory buffer range.
481*53ee8cc1Swenshuai.xi /// @ingroup VBI_Task
482*53ee8cc1Swenshuai.xi /// @param  bEnable    \b IN: set enable protect.
483*53ee8cc1Swenshuai.xi /// @param  phyAddr   \b IN: start address of the range.
484*53ee8cc1Swenshuai.xi /// @param  u32Size    \b IN: size of the range.
485*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
486*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
487*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
488*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_ProtectMemory(MS_BOOL bEnable, MS_PHY phyAddr, MS_U32 u32Size);
489*53ee8cc1Swenshuai.xi 
490*53ee8cc1Swenshuai.xi /*
491*53ee8cc1Swenshuai.xi  *  ClosedCaption
492*53ee8cc1Swenshuai.xi  */
493*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
494*53ee8cc1Swenshuai.xi /// Initialize CC Slicer.
495*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
496*53ee8cc1Swenshuai.xi /// @param  u32RiuAddr     \b IN: VBI CC RIU address.
497*53ee8cc1Swenshuai.xi /// @param  bufferAddr      \b IN: VBI CC buffer address.
498*53ee8cc1Swenshuai.xi /// @param  packetCount   \b IN: VBI CC packet count.
499*53ee8cc1Swenshuai.xi /// @return None
500*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
501*53ee8cc1Swenshuai.xi void MDrv_VBI_CC_InitSlicer(MS_VIRT u32RiuAddr, MS_PHY bufferAddr, MS_U16 packetCount);
502*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
503*53ee8cc1Swenshuai.xi /// Initialize CC CVBS number.
504*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
505*53ee8cc1Swenshuai.xi /// @param  cvbs_no     \b IN: CVBS number.
506*53ee8cc1Swenshuai.xi /// @return None
507*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
508*53ee8cc1Swenshuai.xi void MDrv_VBI_CC_InitYPbYr(MS_U8 cvbs_no);
509*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
510*53ee8cc1Swenshuai.xi /// Enable CC Slicer.
511*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
512*53ee8cc1Swenshuai.xi /// @param  bEnable     \b IN: enable or disable CC slicer.
513*53ee8cc1Swenshuai.xi /// @return None
514*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
515*53ee8cc1Swenshuai.xi void MDrv_VBI_CC_EnableSlicer(MS_BOOL bEnable);
516*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
517*53ee8cc1Swenshuai.xi /// Set CC Data Rate.
518*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
519*53ee8cc1Swenshuai.xi /// @param  ptable    \b OUT: data rate table.
520*53ee8cc1Swenshuai.xi /// @return : Data rate or 0 when failed
521*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
522*53ee8cc1Swenshuai.xi MS_U8 MDrv_VBI_CC_SetDataRate(MS_U8 *ptable);
523*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
524*53ee8cc1Swenshuai.xi /// Set CC Frame Count.
525*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
526*53ee8cc1Swenshuai.xi /// @param  cnt     \b IN: frame count.
527*53ee8cc1Swenshuai.xi /// @return None
528*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
529*53ee8cc1Swenshuai.xi void MDrv_VBI_CC_SetFrameCnt(MS_U8 cnt);
530*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
531*53ee8cc1Swenshuai.xi /// Get CC Information.
532*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
533*53ee8cc1Swenshuai.xi /// @param  selector  \b IN: CC function select.
534*53ee8cc1Swenshuai.xi /// @return : packet count or indication
535*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
536*53ee8cc1Swenshuai.xi MS_U32 MDrv_VBI_CC_GetInfo(MS_U32 selector);
537*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
538*53ee8cc1Swenshuai.xi /// Enable CC Line.
539*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
540*53ee8cc1Swenshuai.xi /// @param  StartLine    \b IN: start line.
541*53ee8cc1Swenshuai.xi /// @param  EndLine     \b IN: end line.
542*53ee8cc1Swenshuai.xi /// @param  mode        \b IN: NTSC/PAL/SECAM mode.
543*53ee8cc1Swenshuai.xi /// @return None
544*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
545*53ee8cc1Swenshuai.xi void MDrv_VBI_CC_EnableLine(MS_U16 StartLine, MS_U16 EndLine, MS_U8 mode);
546*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
547*53ee8cc1Swenshuai.xi /// Fresh memory to avoid cache coherence issue. (Use MsOS function)
548*53ee8cc1Swenshuai.xi /// @ingroup VBI_ToBeRemove
549*53ee8cc1Swenshuai.xi /// @param  u32Start    \b IN: start address (must be 16-B aligned and in cacheable area).
550*53ee8cc1Swenshuai.xi /// @param  u32Size     \b IN: size (must be 16-B aligned).
551*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
552*53ee8cc1Swenshuai.xi /// @return FALSE : Fail due to invalide parameter
553*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
554*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_SyncMemory( MS_U32 u32Start, MS_U32 u32Size );
555*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
556*53ee8cc1Swenshuai.xi /// Set CC SC window length.
557*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
558*53ee8cc1Swenshuai.xi /// @param  u8Len  \b IN: windows length.
559*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
560*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
561*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
562*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_CC_SetSCWindowLen(MS_U8 u8Len);
563*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
564*53ee8cc1Swenshuai.xi /// Set CC standard.
565*53ee8cc1Swenshuai.xi /// @ingroup VBI_CC
566*53ee8cc1Swenshuai.xi /// @param  eStandard  \b IN: video standard.
567*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
568*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
569*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
570*53ee8cc1Swenshuai.xi MS_BOOL MDrv_VBI_CC_SetVideoStandard(VBI_VIDEO_STANDARD eStandard);
571*53ee8cc1Swenshuai.xi 
572*53ee8cc1Swenshuai.xi /*
573*53ee8cc1Swenshuai.xi  *  Others
574*53ee8cc1Swenshuai.xi  */
575*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
576*53ee8cc1Swenshuai.xi /// Set WSS/VPS Byte Number. (Refine function name: MDrv_VBI_TTX_WSS_SetVpsByteNum)
577*53ee8cc1Swenshuai.xi /// @ingroup VBI_TTX_ToBeModified
578*53ee8cc1Swenshuai.xi /// @param  cnt    \b IN: byte number.
579*53ee8cc1Swenshuai.xi /// @return None
580*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
581*53ee8cc1Swenshuai.xi void MDrv_VBI_WSS_SetVpsByteNum(MS_U8 cnt);
582*53ee8cc1Swenshuai.xi 
583*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
584*53ee8cc1Swenshuai.xi /// Save VBI driver states to DRAM.
585*53ee8cc1Swenshuai.xi /// @ingroup VBI_STR
586*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
587*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
588*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
589*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_Suspend(void);
590*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
591*53ee8cc1Swenshuai.xi /// Restore VBI driver states from DRAM
592*53ee8cc1Swenshuai.xi /// @ingroup VBI_STR
593*53ee8cc1Swenshuai.xi /// @return TRUE  : Succeed
594*53ee8cc1Swenshuai.xi /// @return FALSE : Fail
595*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
596*53ee8cc1Swenshuai.xi // MS_BOOL MDrv_VBI_Resume(void);
597*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
598*53ee8cc1Swenshuai.xi /// Control VBI STR functions.
599*53ee8cc1Swenshuai.xi /// @ingroup VBI_STR
600*53ee8cc1Swenshuai.xi /// @param  u16PowerState  \b IN: STR power mode. (to control STR suspend & resume case.)
601*53ee8cc1Swenshuai.xi /// @return : Utopia status - UTOPIA_STATUS_SUCCESS (Succeed) or UTOPIA_STATUS_FAIL (Fail)
602*53ee8cc1Swenshuai.xi //-------------------------------------------------------------------------------------------------
603*53ee8cc1Swenshuai.xi MS_U32  MDrv_VBI_SetPowerState(EN_POWER_MODE u16PowerState);
604*53ee8cc1Swenshuai.xi 
605*53ee8cc1Swenshuai.xi #ifdef __cplusplus
606*53ee8cc1Swenshuai.xi }
607*53ee8cc1Swenshuai.xi #endif
608*53ee8cc1Swenshuai.xi 
609*53ee8cc1Swenshuai.xi #endif
610*53ee8cc1Swenshuai.xi 
611