//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all 
// or part of MStar Software is expressly prohibited, unless prior written 
// permission has been granted by MStar. 
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.  
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software. 
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s 
//    confidential information in strictest confidence and not disclose to any
//    third party.  
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.  
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or 
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.  
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2006-2009 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// (!ĦħMStar Confidential Information!ĦL) by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
////////////////////////////////////////////////////////////////////////////////
#ifndef _HAL_VBI_H
#define _HAL_VBI_H

 /********************************************************************************/
/*                                                        Functions                                                                   */
/********************************************************************************/
void VBI_TTXInit(MS_VIRT ptrAddr);
void VBI_WSSInit(MS_VIRT ptrAddr);
MS_BOOL VBI_TTX_CheckCircuitReady(void);
MS_U16 VBI_TTX_GetPacketCount(void);
MS_U16 VBI_GetWSS_Count(void);
MS_U16 VBI_GetVPS_Count(void);
void VBI_TTX_InitSlicer(MS_PHY addr, MS_U16 packetCount);
void VBI_TTX_EnableSlicer(MS_BOOL bEnable);
MS_U8 VBI_TTX_GetHardware_Indication(void);
void VBI_GetVPS_Data(MS_U8 *byte1, MS_U8 *byte2, MS_U8 *byte3, MS_U8 *byte4);
MS_U16 VBI_GetWSS_Data(void);
void VBI_Set_PalNC_VideoStandard(void);
void VBI_Set_Secam_VideoStandard(void);
void VBI_Set_Pal_VideoStandard(void);
void VBI_TTX_EnableInterrupt(MS_BOOL bEnable);
MS_U8 VBI_TTX_ReadIRQ(void);
void VBI_TTX_ClearIRQ(void);
void VBI_TTX_EnableLine(MS_U16 StartLine, MS_U16 EndLine);
void VBI_TTX_DMA_CopyPacket(MS_PHY src_addr, MS_PHY dest_addr, MS_U8 aPacketType);

/*
 *  ClosedCaption
 */
void VBI_CC_Init(MS_VIRT ptrRiuAddr, MS_PHY ptrAddr, MS_U16 u8Len);
void VBI_CC_YPbPr_Init(MS_U8 cvbs_no);
MS_U8 VBI_CC_DataRateSet(MS_U8 *ptable);
MS_U8 VBI_CC_GetPacketCnt(void);
MS_U8 VBI_CC_GetByteFoundIndication(void);
void VBI_SetCCFrameCnt(MS_U8 cnt);
void VBI_CC_EnableSlicer(MS_BOOL bEnable);
void VBI_CC_SetCCLine(MS_U16 StartLine, MS_U16 EndLine, MS_U8 val);
MS_U32 VBI_CC_GetPacket(void);
MS_BOOL VBI_CC_SetSCWindowLen(MS_U8 u8Len);
/*
 * Others
 */
void VBI_SetWssVpsByteNum(MS_U8 cnt);
MS_BOOL VBI_ProtectMemory(MS_BOOL bEnable, MS_PHY phyAddr, MS_U32 u32Size);
void VBI_RegStateStore(void);
void VBI_RegStateRestore(void);

#endif