tmbsltda18271.h

nxp silicon tuner 18271 sample code

/**
Copyright (C) 2008 NXP B.V., All Rights Reserved.
This source code and any compilation or derivative thereof is the proprietary
information of NXP B.V. and is confidential in nature. Under no circumstances
is this software to be  exposed to or placed under an Open Source License of
any type without the expressed written permission of NXP B.V.
*
* \file          tmbslTDA18271.h
*                %version: 27.4 %
*
* \date          %date_modified%
*
* \brief         Describe briefly the purpose of this file.
*
* REFERENCE DOCUMENTS :
*
* Detailed description may be added here.
*
* \section info Change Information
*
* \verbatim
Date          Modified by CRPRNr  TASKNr  Maintenance description
-------------|-----------|-------|-------|-----------------------------------
|            |           |       |
-------------|-----------|-------|-------|-----------------------------------
|            |           |       |
-------------|-----------|-------|-------|-----------------------------------
\endverbatim
*
*/

#ifndef _TMBSL_TDA18271_H
#define _TMBSL_TDA18271_H

/*------------------------------------------------------------------------------*/
/* Standard include files:                                                      */
/*------------------------------------------------------------------------------*/

/*------------------------------------------------------------------------------*/
/* Project include files:                                                       */
/*------------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif

    /*------------------------------------------------------------------------------*/
    /* Types and defines:                                                           */
    /*------------------------------------------------------------------------------*/

    /* SW Error codes */
#define TDA18271_ERR_BASE               (CID_COMP_TUNER | CID_LAYER_BSL)
#define TDA18271_ERR_COMP               (CID_COMP_TUNER | CID_LAYER_BSL | TM_ERR_COMP_UNIQUE_START)

#define TDA18271_ERR_BAD_UNIT_NUMBER    (TDA18271_ERR_BASE + TM_ERR_BAD_UNIT_NUMBER)
#define TDA18271_ERR_NOT_INITIALIZED    (TDA18271_ERR_BASE + TM_ERR_NOT_INITIALIZED)
#define TDA18271_ERR_INIT_FAILED        (TDA18271_ERR_BASE + TM_ERR_INIT_FAILED)
#define TDA18271_ERR_BAD_PARAMETER      (TDA18271_ERR_BASE + TM_ERR_BAD_PARAMETER)
#define TDA18271_ERR_NOT_SUPPORTED      (TDA18271_ERR_BASE + TM_ERR_NOT_SUPPORTED)
#define TDA18271_ERR_HW_FAILED          (TDA18271_ERR_COMP + 0x0001)
#define TDA18271_ERR_NOT_READY          (TDA18271_ERR_COMP + 0x0002)
#define TDA18271_ERR_BAD_VERSION        (TDA18271_ERR_COMP + 0x0003)


    typedef enum _tmTDA18271PowerState_t {
        tmTDA18271_PowerNormalMode = 0,                 /* Device normal mode */
        tmTDA18271_PowerSleepMode,                      /* Device sleep mode */
        tmTDA18271_PowerStandbyWith16MHz,               /* Device standby with 16Mhz */
        tmTDA18271_PowerStandbyWith16MHzAndLoopThrough, /* Device standby with 16Mhz and loop through */
        tmTDA18271_PowerStandbyWithLoopThrough,         /* Device standby with loop through */
        tmTDA18271_PowerNotSupported                    /* Not supported power mode */
    } tmTDA18271PowerState_t, *ptmTDA18271PowerState_t;

    typedef enum _tmTDA18271StandardMode_t {
        tmTDA18271_DVBT_6MHz = 0,                       /* Digital TV DVB-T 6MHz */
        tmTDA18271_DVBT_7MHz,                           /* Digital TV DVB-T 7MHz */
        tmTDA18271_DVBT_8MHz,                           /* Digital TV DVB-T 8MHz */
        tmTDA18271_ANLG_MN,                             /* Analog TV M/N */
        tmTDA18271_ANLG_B,                              /* Analog TV B */
        tmTDA18271_ANLG_GH,                             /* Analog TV G/H */
        tmTDA18271_ANLG_I,                              /* Analog TV I */
        tmTDA18271_ANLG_DK,                             /* Analog TV D/K */
        tmTDA18271_ANLG_L,                              /* Analog TV L */
        tmTDA18271_ANLG_LL,                             /* Analog TV L' */
        tmTDA18271_FM_Radio,                            /* Analog FM Radio */
        tmTDA18271_QAM_6MHz,                            /* Digital TV QAM 6MHz */
        tmTDA18271_QAM_8MHz,                            /* Digital TV QAM 8MHz */
        tmTDA18271_ISDBT_6MHz,                          /* Digital TV ISDBT 6MHz */
        tmTDA18271_ATSC_6MHz,                           /* Digital TV ATSC 6MHz */
        tmTDA18271_DMBT_8MHz,                           /* Digital TV DMB-T 8MHz */
        tmTDA18271_StdNotSupported                      /* Not supported standard */
    } tmTDA18271StandardMode_t, *ptmTDA18271StandardMode_t;

    typedef enum _tmTDA18271LPFc_t {
        tmTDA18271_LPFc_6MHz = 0,                       /* 6MHz LPFc */
        tmTDA18271_LPFc_7MHz = 1,                       /* 7MHz LPFc */
        tmTDA18271_LPFc_8MHz = 2,                       /* 8MHz LPFc */
        tmTDA18271_LPFc_9MHz = 3                        /* 9MHz LPFc */
    } tmTDA18271LPFc_t, *ptmTDA18271LPFc_t;

    typedef enum _tmTDA18271IF_Level_t {
        tmTDA18271_IF_LVL_0dB = 0,                      /*     0dB IF Level */
        tmTDA18271_IF_LVL_min_4dB = 1,                  /*    -4dB IF Level */
        tmTDA18271_IF_LVL_min_6dB = 2,                  /*    -6dB IF Level */
        tmTDA18271_IF_LVL_min_10_4dB = 6,               /* -10.4dB IF Level */
        tmTDA18271_IF_LVL_min_12dB = 7                  /*   -12dB IF Level */
    } tmTDA18271IF_Level_t, *ptmTDA18271IF_Level_t;

    typedef struct _tmTDA18271StdCoefficients
    {
        UInt32 uIF;                                     /* IF in Hz */
        UInt8 uAGCK_Mode;                               /* AGCK_Mode */
        UInt8 uLPFc;                                    /* LPFc */
        UInt8 uIF_Level;                                /* IF Output Level */
        UInt8 uIF_Notch;                                /* IF Notch */
        UInt8 uRF_IF_AGC_Top;                           /* RF & IF AGC Top */
        UInt8 uFM_RFn;                                  /* FM RFn */
    } tmTDA18271StdCoefficients, *ptmTDA18271StdCoefficients;


    tmErrorCode_t
        tmbslTDA18211Init(
        tmUnitSelect_t              tUnit,      /*  I: Unit number */
        tmbslFrontEndDependency_t*  psSrvFunc   /*  I: setup parameters */
        );
    tmErrorCode_t 
        tmbslTDA18271DeInit (
        tmUnitSelect_t  tUnit   /*  I: Unit number */
        );
    tmErrorCode_t
        tmbslTDA18271GetSWVersion (
        ptmSWVersion_t  pSWVersion  /*  I: Receives SW Version */
        );
    tmErrorCode_t
        tmbslTDA18271SetPowerState (
        tmUnitSelect_t          tUnit,      /*  I: Unit number */
        tmTDA18271PowerState_t  powerState  /*  I: Power state of this device */
        );
    tmErrorCode_t
        tmbslTDA18271GetPowerState (
        tmUnitSelect_t            tUnit,        /*  I: Unit number */
        tmTDA18271PowerState_t    *pPowerState  /*  O: Power state of this device */
        );
    tmErrorCode_t
        tmbslTDA18271SetStandardMode (
        tmUnitSelect_t              tUnit,          /*  I: Unit number */
        tmTDA18271StandardMode_t    StandardMode    /*  I: Standard mode of this device */
        );
    tmErrorCode_t
        tmbslTDA18271GetStandardMode (
        tmUnitSelect_t              tUnit,          /*  I: Unit number */
        tmTDA18271StandardMode_t    *pStandardMode  /*  O: Standard mode of this device */
        );
    tmErrorCode_t
        tmbslTDA18271SetRf(
        tmUnitSelect_t  tUnit,  /*  I: Unit number */
        UInt32          uRF     /*  I: RF frequency in hertz */
        );
    tmErrorCode_t
        tmbslTDA18271GetRf(
        tmUnitSelect_t  tUnit,  /*  I: Unit number */
        UInt32*         pRF     /*  O: RF frequency in hertz */
        );
    tmErrorCode_t
        tmbslTDA18271Reset(
        tmUnitSelect_t tUnit    /* I: Unit number */
        );
    tmErrorCode_t
        tmbslTDA18271GetIF(
        tmUnitSelect_t  tUnit,  /* I: Unit number */
        UInt32*         puIF    /* O: IF Frequency in hertz */
        );
    tmErrorCode_t
        tmbslTDA18271GetLockStatus(
        tmUnitSelect_t          tUnit,      /* I: Unit number */
        tmbslFrontEndState_t*   pLockStatus /* O: PLL Lock status */
        );



#ifdef __cplusplus
}
#endif

#endif /* _TMBSL_TDA18271_H */