mt2063.h

microtune 公司 硅高频头 源码

/*****************************************************************************
**
**  Name: mt2063.h
**
**  Copyright 2007 Microtune, Inc. All Rights Reserved
**
**  This source code file contains confidential information and/or trade
**  secrets of Microtune, Inc. or its affiliates and is subject to the
**  terms of your confidentiality agreement with Microtune, Inc. or one of
**  its affiliates, as applicable.
**
*****************************************************************************/

/*****************************************************************************
**
**  Name: mt2063.h
**
**  Description:    Microtune MT2063 B0/B1 Tuner software interface
**                  Supports tuners with Part/Rev codes: 0x9B, 0x9C.
**
**  Functions
**  Implemented:    UData_t  MT2063_Open
**                  UData_t  MT2063_Close
**                  UData_t  MT2063_GetGPIO
**                  UData_t  MT2063_GetLocked
**                  UData_t  MT2063_GetParam
**                  UData_t  MT2063_GetPowerMaskBits
**                  UData_t  MT2063_GetReg
**                  UData_t  MT2063_GetTemp
**                  UData_t  MT2063_GetUserData
**                  UData_t  MT2063_ReInit
**                  UData_t  MT2063_SetGPIO
**                  UData_t  MT2063_SetParam
**                  UData_t  MT2063_SetPowerMaskBits
**                  UData_t  MT2063_ClearPowerMaskBits
**                  UData_t  MT2063_SetReg
**                  UData_t  MT2063_Tune
**
**  References:     AN-xxxxx: MT2063 Programming Procedures Application Note
**                  MicroTune, Inc.
**                  AN-00010: MicroTuner Serial Interface Application Note
**                  MicroTune, Inc.
**
**  Enumerations
**  Defined:        MT2063_Ext_SRO
**                  MT2063_Param
**                  MT2063_Mask_Bits
**                  MT2063_GPIO_Attr;
**                  MT2063_Temperature
**
**  Exports:        None
**
**  Dependencies:   MT_ReadSub(hUserData, IC_Addr, subAddress, *pData, cnt);
**                  - Read byte(s) of data from the two-wire bus.
**
**                  MT_WriteSub(hUserData, IC_Addr, subAddress, *pData, cnt);
**                  - Write byte(s) of data to the two-wire bus.
**
**                  MT_Sleep(hUserData, nMinDelayTime);
**                  - Delay execution for nMinDelayTime milliseconds
**
**  CVS ID:         $Id: mt2063.h,v 1.2 2008/01/16 12:09:53 software Exp $
**  CVS Source:     $Source: /export/home/cvsroot/software/tuners/MT2063/mt2063.h,v $
**
**  Revision History:
**
**   SCR      Date      Author  Description
**  -------------------------------------------------------------------------
**   138   06-19-2007    DAD    Ver 1.00: Initial, derived from mt2067_b.
**   N/A   08-01-2007    PINZ   Changed Analog & DVB-T settings and added 
**                              SAW-less receiver mode.
**   155   10-01-2007    DAD    Ver 1.06: Add receiver mode for SECAM positive
**                                        modulation
**                                        (MT2063_ANALOG_TV_POS_NO_RFAGC_MODE)
**   N/A   10-22-2007    PINZ   Ver 1.07: Changed some Registers at init to have 
**                                        the same settings as with MT Launcher 
**   N/A   10-30-2007    PINZ             Add SetParam VGAGC & VGAOI
**                                        Add SetParam DNC_OUTPUT_ENABLE
**                                        Removed VGAGC from receiver mode, 
**                                        default now 1 
**   N/A   10-31-2007    PINZ   Ver 1.08: Add SetParam TAGC, removed from rcvr-mode
**                                        Add SetParam AMPGC, removed from rcvr-mode
**                                        Corrected names of GCU values
**                                        Actualized Receiver-Mode values
**
*****************************************************************************/
#if !defined( __MT2063_H )
#define __MT2063_H

#include "mt_userdef.h"

#if defined( __cplusplus )
extern "C"                     /* Use "C" external linkage                  */
{
#endif

/*
**  Values returned by the MT2063's on-chip temperature sensor
**  to be read/written.
*/
typedef enum
{
    MT2063_T_0C = 0,                    /*  Temperature approx 0C           */
    MT2063_T_10C,                       /*  Temperature approx 10C          */
    MT2063_T_20C,                       /*  Temperature approx 20C          */
    MT2063_T_30C,                       /*  Temperature approx 30C          */
    MT2063_T_40C,                       /*  Temperature approx 40C          */
    MT2063_T_50C,                       /*  Temperature approx 50C          */
    MT2063_T_60C,                       /*  Temperature approx 60C          */
    MT2063_T_70C,                       /*  Temperature approx 70C          */
    MT2063_T_80C,                       /*  Temperature approx 80C          */
    MT2063_T_90C,                       /*  Temperature approx 90C          */
    MT2063_T_100C,                      /*  Temperature approx 100C         */
    MT2063_T_110C,                      /*  Temperature approx 110C         */
    MT2063_T_120C,                      /*  Temperature approx 120C         */
    MT2063_T_130C,                      /*  Temperature approx 130C         */
    MT2063_T_140C,                      /*  Temperature approx 140C         */
    MT2063_T_150C,                      /*  Temperature approx 150C         */
} MT2063_Temperature;


/*
** Parameters for selecting GPIO bits
*/
typedef enum
{
    MT2063_GPIO_IN,
    MT2063_GPIO_DIR,
    MT2063_GPIO_OUT,
} MT2063_GPIO_Attr;

typedef enum
{
    MT2063_GPIO0,
    MT2063_GPIO1,
    MT2063_GPIO2,
} MT2063_GPIO_ID;


/*
**  Parameter for function MT2063_SetExtSRO that specifies the external
**  SRO drive frequency.
**
**  MT2063_EXT_SRO_OFF is the power-up default value.
*/
typedef enum
{
    MT2063_EXT_SRO_OFF,                 /*  External SRO drive off          */
    MT2063_EXT_SRO_BY_4,                /*  External SRO drive divide by 4  */
    MT2063_EXT_SRO_BY_2,                /*  External SRO drive divide by 2  */
    MT2063_EXT_SRO_BY_1                 /*  External SRO drive divide by 1  */
} MT2063_Ext_SRO;


/*
**  Parameter for function MT2063_SetPowerMask that specifies the power down
**  of various sections of the MT2063.
*/
typedef enum 
{
    MT2063_REG_SD   = 0x0040,   /* Shutdown regulator                 */
    MT2063_SRO_SD   = 0x0020,   /* Shutdown SRO                       */
    MT2063_AFC_SD   = 0x0010,   /* Shutdown AFC A/D                   */
    MT2063_PD_SD    = 0x0002,   /* Enable power detector shutdown     */
    MT2063_PDADC_SD = 0x0001,   /* Enable power detector A/D shutdown */
    MT2063_VCO_SD   = 0x8000,   /* Enable VCO shutdown                */
    MT2063_LTX_SD   = 0x4000,   /* Enable LTX shutdown                */
    MT2063_LT1_SD   = 0x2000,   /* Enable LT1 shutdown                */
    MT2063_LNA_SD   = 0x1000,   /* Enable LNA shutdown                */
    MT2063_UPC_SD   = 0x0800,   /* Enable upconverter shutdown        */
    MT2063_DNC_SD   = 0x0400,   /* Enable downconverter shutdown      */
    MT2063_VGA_SD   = 0x0200,   /* Enable VGA shutdown                */
    MT2063_AMP_SD   = 0x0100,   /* Enable AMP shutdown                */
    MT2063_ALL_SD   = 0xFF73,   /* All shutdown bits for this tuner   */
    MT2063_NONE_SD  = 0x0000    /* No shutdown bits                   */
} MT2063_Mask_Bits;


/*
**  Parameter for function MT2063_GetParam & MT2063_SetParam that
**  specifies the tuning algorithm parameter to be read/written.
*/
typedef enum
{
    /*  tuner address                                  set by MT2063_Open() */
    MT2063_IC_ADDR,

    /*  max number of MT2063 tuners     set by MT_TUNER_CNT in mt_userdef.h */
    MT2063_MAX_OPEN,

    /*  current number of open MT2063 tuners           set by MT2063_Open() */
    MT2063_NUM_OPEN,

    /*  crystal frequency                            (default: 16000000 Hz) */
    MT2063_SRO_FREQ,

    /*  min tuning step size                            (default: 50000 Hz) */
    MT2063_STEPSIZE,

    /*  input center frequency                         set by MT2063_Tune() */
    MT2063_INPUT_FREQ,

    /*  LO1 Frequency                                  set by MT2063_Tune() */
    MT2063_LO1_FREQ,

    /*  LO1 minimum step size                          (default: 250000 Hz) */
    MT2063_LO1_STEPSIZE,

    /*  LO1 FracN keep-out region                      (default: 999999 Hz) */
    MT2063_LO1_FRACN_AVOID,

    /*  Current 1st IF in use                          set by MT2063_Tune() */
    MT2063_IF1_ACTUAL,

    /*  Requested 1st IF                               set by MT2063_Tune() */
    MT2063_IF1_REQUEST,

    /*  Center of 1st IF SAW filter                (default: 1218000000 Hz) */
    MT2063_IF1_CENTER,

    /*  Bandwidth of 1st IF SAW filter               (default: 20000000 Hz) */
    MT2063_IF1_BW,

    /*  zero-IF bandwidth                             (default: 2000000 Hz) */
    MT2063_ZIF_BW,

    /*  LO2 Frequency                                  set by MT2063_Tune() */
    MT2063_LO2_FREQ,

    /*  LO2 minimum step size                           (default: 50000 Hz) */
    MT2063_LO2_STEPSIZE,

    /*  LO2 FracN keep-out region                      (default: 374999 Hz) */
    MT2063_LO2_FRACN_AVOID,

    /*  output center frequency                        set by MT2063_Tune() */
    MT2063_OUTPUT_FREQ,

    /*  output bandwidth                               set by MT2063_Tune() */
    MT2063_OUTPUT_BW,

    /*  min inter-tuner LO separation                 (default: 1000000 Hz) */
    MT2063_LO_SEPARATION,

    /*  ID of avoid-spurs algorithm in use            compile-time constant */
    MT2063_AS_ALG,

    /*  max # of intra-tuner harmonics                       (default: 15)  */
    MT2063_MAX_HARM1,

    /*  max # of inter-tuner harmonics                        (default: 7)  */
    MT2063_MAX_HARM2,

    /*  # of 1st IF exclusion zones used               set by MT2063_Tune() */
    MT2063_EXCL_ZONES,

    /*  # of spurs found/avoided                       set by MT2063_Tune() */
    MT2063_NUM_SPURS,

    /*  >0 spurs avoided                               set by MT2063_Tune() */
    MT2063_SPUR_AVOIDED,

    /*  >0 spurs in output (mathematically)            set by MT2063_Tune() */
    MT2063_SPUR_PRESENT,

    /* GCU Mode: 1 - Automatic, 0- Manual                                   */
    MT2063_GCU_AUTO,

    /* Receiver Mode for some parameters. 1 is DVB-T                        */
    MT2063_RCVR_MODE,

    /* Trigger ATN change                                                   */
    MT2063_BYPATNUP,
    MT2063_BYPATNDN,

    /* directly set LNA attenuation, parameter is value to set              */
    MT2063_ACLNA,

    /* inc. LNA att one db.  Parameter is upper limit of increment.         */
    MT2063_ACLNA_INCR,

    /* dec. LNA att one db.  Parameter is lower limit of decrement.         */
    MT2063_ACLNA_DECR,

    /* directly set ATN attenuation.  Paremeter is value to set.            */
    MT2063_ACRF,

    /* inc. ATN att one db.  Parameter is upper limit of increment.         */
    MT2063_ACRF_INCR,

    /* dec. LNA att one db.  Parameter is upper limit of increment.         */
    MT2063_ACRF_DECR,

    /* directly set FIF attenuation.  Paremeter is value to set.            */
    MT2063_ACFIF,

    /* inc. FIF att one db.  Parameter is upper limit of increment.         */
    MT2063_ACFIF_INCR,

    /* dec. FIF att one db.  Parameter is upper limit of increment.         */
    MT2063_ACFIF_DECR,

    /*  Power Detector 1 level                                              */
    MT2063_PD1,

    /*  Power Detector 1 level target                                       */
    MT2063_PD1_TGT,

    /*  Power Detector 2 level                                              */
    MT2063_PD2,

    /*  Power Detector 2 level target                                       */
    MT2063_PD2_TGT,

    /*  Selects, which DNC is activ                                         */
    MT2063_DNC_OUTPUT_ENABLE,

    /*  VGA gain code                                                       */
    MT2063_VGAGC,

    /*  VGA bias current                                                    */
    MT2063_VGAOI,

    /*  TAGC, determins the speed of the AGC                                */
    MT2063_TAGC,

    /*  AMP gain code                                                       */
    MT2063_AMPGC,

    MT2063_EOP                    /*  last entry in enumerated list         */

} MT2063_Param;


/*
**  Parameter for selecting tuner mode
*/
typedef enum
{
    MT2063_CABLE_QAM = 0,            /* Digital cable              */
    MT2063_CABLE_ANALOG,             /* Analog cable               */
    MT2063_OFFAIR_COFDM,             /* Digital offair             */
    MT2063_OFFAIR_COFDM_SAWLESS,     /* Digital offair without SAW */
    MT2063_OFFAIR_ANALOG,            /* Analog offair              */
    MT2063_OFFAIR_8VSB,              /* Analog offair              */
    MT2063_NUM_RCVR_MODES
} MT2063_RCVR_MODES;


/*  
**  Possible values for MT2063_DNC_OUTPUT  
*/ 
typedef enum {
    MT2063_DNC_NONE = 0,
    MT2063_DNC_1,
    MT2063_DNC_2,
    MT2063_DNC_BOTH
} MT2063_DNC_Output_Enable;


/* ====== Functions which are declared in MT2063.c File ======= */

/******************************************************************************
**