xref: /utopia/UTPA2-700.0.x/modules/demodulator/drv/dmd/u3/Int_DVBC/drvDMD.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<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-2007 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��) 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.
//
////////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////////////////////////
///
/// @file   drvDMD.h
/// @brief  DVBC Demodulator Driver Interface
/// @author MStar Semiconductor,Inc.
///////////////////////////////////////////////////////////////////////////////////////////////////

#ifndef _DRV_DMD_H_
#define _DRV_DMD_H_



#ifdef __cplusplus
extern "C"
{
#endif

//-------------------------------------------------------------------------------------------------
//  Driver Capability
//-------------------------------------------------------------------------------------------------


//-------------------------------------------------------------------------------------------------
//  Macro and Define
//-------------------------------------------------------------------------------------------------


//-------------------------------------------------------------------------------------------------
//  Type and Structure
//-------------------------------------------------------------------------------------------------

/// Mdulation constellation scheme
typedef enum _DMD_QamType
{
    E_DMD_QAM16  = 0,                                                   ///< QAM 16
    E_DMD_QAM32  = 1,                                                   ///< QAM 32
    E_DMD_QAM64  = 2,                                                   ///< QAM 64
    E_DMD_QAM128 = 3,                                                   ///< QAM 128
    E_DMD_QAM256 = 4,                                                   ///< QAM 256

    E_DMD_QAM_LASTNUM,
} __attribute__((packed)) DMD_QAMType;

/// Demodulation IQ type
typedef enum _DMD_IQType
{
    E_DMD_IQ_NORMAL = 0,                                                ///< IQ Normal
    E_DMD_IQ_INVERT = 1,                                                ///< IQ Invert
} __attribute__((packed)) DMD_IQType;

/// Demodulation tap assign
typedef enum _DMD_TapAssign
{
    E_DMD_TAP_PRE  = 0,                                                 ///< PreTap assign
    E_DMD_TAP_POST = 1,                                                 ///< PostTap assign
} __attribute__((packed)) DMD_TapAssign;


#if   1//(FRONTEND_DEMOD_TYPE == DEMOD_MSDVBC)

/// Demodulator auto tune control
typedef struct
{
    // Demodulator option
    MS_BOOL                         bX4CFE_en;                          ///< Carrier frequency estimation
    MS_BOOL                         bPPD_en;                            ///< Tap assign estimation
    MS_BOOL                         bIQAutoSwap_en;                     ///< IQ mode auto swap
    MS_BOOL                         bQAMScan_en;                        ///< QAM type auto scan
    MS_BOOL                         bFHO_en;                            ///< FHO
	MS_BOOL							(*fptTunerSet)(MS_U32);				///< Tuner set freq function pointer
} DMD_Mode;

/// Demodulator tune parameter
typedef struct
{
    // Channel setting
    MS_U32                          u32SymRate;                         ///< Symbol rate (Ksym/sec)

    // Channel characteristic
    DMD_QAMType                     eQamType;                           ///< QAM type
    DMD_IQType                      eIQSwap;                            ///< IQ type
    DMD_TapAssign                   eTapAssign;                         ///< Tap assign
    MS_U32                          u32FreqOffset;                      ///< Carrier frequency offset
	MS_U8							u8TuneFreqOffset;					///< Request Tuner offset
	MS_U32							u32TunerFreq;						///< Request Tuner offset
} DMD_Param;

/// Demodulator special status parameter
typedef struct
{
	MS_BOOL							bRtyTunerFreq;						///< Tuner freq retry flag
	MS_BOOL							bRtyTunerOvr;						///< Retry over indicator for freq offset retry
	MS_S32							s32TunerFreqOffset;					///< Demod request tuner freq offset
}DMD_Status;

#else

typedef struct
{
    // N/A
} DMD_Mode;

// Device dependant parameter
typedef struct
{
    // N/A
} DMD_Param;

typedef struct
{
	// N/A
}DMD_Status;

#endif


//-------------------------------------------------------------------------------------------------
//  Function and Variable
//-------------------------------------------------------------------------------------------------
extern MS_BOOL MDrv_Dmd_Init(void);
extern MS_BOOL MDrv_Dmd_Open(void);
extern MS_BOOL MDrv_Dmd_Close(void);
extern MS_BOOL MDrv_Dmd_Reset(void);
extern MS_BOOL MDrv_Dmd_Restart(DMD_Param *pParam);
extern MS_BOOL MDrv_Dmd_SetMode(DMD_Mode *pMode);
extern MS_BOOL MDrv_Dmd_TsOut(MS_BOOL bEnable);
extern MS_BOOL MDrv_Dmd_PowerOnOff(MS_BOOL bPowerOn);
extern MS_BOOL MDrv_Dmd_SetBW(MS_U32 u32BW);
extern MS_BOOL MDrv_Dmd_GetBW(MS_U32 *pu32BW);
extern MS_BOOL MDrv_Dmd_GetLock(MS_BOOL *pbLock);
extern MS_BOOL MDrv_Dmd_GetSNR(MS_U32 *pu32SNR);
extern MS_BOOL MDrv_Dmd_GetBER(float *pfBER);
extern MS_BOOL MDrv_Dmd_GetPWR(MS_S32 *ps32Signal);
extern MS_BOOL MDrv_Dmd_GetParam(DMD_Param *pParam);
extern MS_BOOL MDrv_Dmd_Config(MS_U8 *pRegParam);

#ifdef __cplusplus
}
#endif


#endif // _DRV_DMD_H_