source: svn/newcon3bcm2_21bu/magnum/portinginterface/tnr/btnr_priv.h @ 44

/***************************************************************************
 *     Copyright (c) 2003-2011, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: btnr_priv.h $
 * $brcm_Revision: Hydra_Software_Devel/11 $
 * $brcm_Date: 5/4/11 4:22p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /magnum/portinginterface/tnr/btnr_priv.h $
 * 
 * Hydra_Software_Devel/11   5/4/11 4:22p atanugul
 * SW7231-32: Reverting back to version 9
 * 
 * Hydra_Software_Devel/10   5/3/11 3:20p vishk
 * SW7231-32: Implement the Nexus code to support the 3461 frontend chip.
 * Undo the changes done since version 8.
 * 
 * Hydra_Software_Devel/9   4/11/11 5:15p atanugul
 * SW3128-2: Add Get_Settings and SetSettings support to 3128 TNR PI
 * 
 * Hydra_Software_Devel/8   6/22/10 6:15p vishk
 * SW7420-839: Add support to program AGC gain to 31xx TNR PI
 * 
 * Hydra_Software_Devel/7   11/17/09 7:59p farshidf
 * SW7550-38: update the code to the latest nexus call
 * 
 * Hydra_Software_Devel/6   11/10/09 7:11p farshidf
 * 7550-38: add the tuner code
 * 
 * Hydra_Software_Devel/5   8/21/09 6:12p vishk
 * PR 57484: Bcm31xx: Add Power Management support for TNR
 * 
 * Hydra_Software_Devel/4   6/7/05 8:35a dlwin
 * PR 14682: Added additional functions for Docsis and general use.  New
 * function 'BTNR_GetInfo()' returns additional informtion for the tuner.
 * 
 * Hydra_Software_Devel/3   4/1/05 5:26p dlwin
 * PR 14682: Added semi-private functions for QamCm to use to AGC
 * readings.  This required for Docsis integration.
 * 
 * Hydra_Software_Devel/2   10/7/03 8:52a dlwin
 * Removed the need to call a create generic tuner  handle.
 * 
 * Hydra_Software_Devel/1   8/26/03 2:20p dlwin
 * Initial version
 * 
 ***************************************************************************/

#ifndef BTNR_PRIV_H__
#define BTNR_PRIV_H__


#ifdef __cplusplus
extern "C" {
#endif


/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Set Rf Freq. function.

Description:
    This is pointer to 'Custom' part of tuner module for setting the Rf Freq.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_SetRfFreqFunc)(
    void *hDevImp,                      /* Device handle */
    uint32_t freq,                      /* Requested tuner freq., in Hertz */
    BTNR_TunerMode tunerMode            /* Requested tuner mode */
    );

/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Get Rf Freq. function.

Description:
    This is pointer to 'Custom' part of tuner module for getting the
    current Rf Freq. setting.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_GetRfFreqFunc)(
    void *hDevImp,                      /* Device handle */
    uint32_t *freq,                     /* [output] Returns tuner freq., in Hertz */
    BTNR_TunerMode *tunerMode           /* [output] Returns tuner mode */
    );

/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Close function.

Description:
    This is pointer to 'Custom' part of tuner module for closing tuner module.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_CloseFunc)(
    BTNR_Handle hDev                    /* [in] Device handle */
    );

/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Get AGC register value.

Description:
    This is pointer to 'Custom' part of tuner module for getting the
    current AGC register value.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_GetAgcRegValFunc)(
    void *hDevImp,                      /* Device handle */
    uint32_t regOffset,                 /* [in] AGC register offset */
    uint32_t *agcVal                    /* [output] Returns AGC register value */
    );

/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Set AGC register value.

Description:
    This is pointer to 'Custom' part of tuner module for setting the
    current AGC register value.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_SetAgcRegValFunc)(
    void *hDevImp,                      /* Device handle */
    uint32_t regOffset,                 /* [in] AGC register offset */
    uint32_t *agcVal                    /* [input] Sets AGC register value */
    );

/***************************************************************************
Summary:
    This typedef defines the pointer to Tuner Get Info.

Description:
    This is pointer to tuner module for getting the tuner Info.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_GetInfoFunc)(
    void *hDevImp,                      /* Device handle */ 
     BTNR_TunerInfo *tnrInfo             /* [output] Tuner information */
    );

/***************************************************************************
Summary:
    This function gets the power-saver mode.

Description:
    This function returns the current power-saver mode.

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_GetPowerSaverFunc)(
    void *hDevImp,                          /* Device handle */
    BTNR_PowerSaverSettings *pwrSettings    /* Tuner power saver information */
    );

/***************************************************************************
Summary:
    This function enable the power-saver mode.

Description:
    This function is responsible for enabling/disabling the downstream tuner
    power-saver mode.  When the power-saver mode is enabled, the
    Qam In-Band Downstream tuner is shutdown. 


See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_SetPowerSaverFunc)(
    void *hDevImp,                          /* Device handle */
    BTNR_PowerSaverSettings *pwrSettings    /* Tuner power saver information */
    );

/***************************************************************************
Summary:
    This function gets the TNR settings

Description:
    This function gets the TNR settings

See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_GetSettingsFunc)(
    BTNR_Handle hDev,           /* Device handle */
    BTNR_Settings *settings     /* TNR settings. */
    );

/***************************************************************************
Summary:
    This function sets the TNR settings

Description:
    This function sets the TNR settings


See Also:
    BTNR_P_Handle

****************************************************************************/
typedef BERR_Code (*BTNR_SetSettingsFunc)(
    BTNR_Handle hDev,           /* Device handle */
    BTNR_Settings *settings     /* TNR settings. */
    );

/***************************************************************************
Summary:
    The private handle for Tuner module

Description:
    A private handle for BTNR device, not exposed any modules outside of
    BTNR.

See Also:

****************************************************************************/
typedef struct BTNR_P_Handle
{
    void *hDevImpl;                         /* Device Implementation handle */
    uint32_t magicId;                       /* Used to check if structure is corrupt */
    BTNR_SetRfFreqFunc pSetRfFreq;          /* ptr to tune tuner function */
    BTNR_GetRfFreqFunc pGetRfFreq;          /* ptr to get tuned frequency function */
    BTNR_GetAgcRegValFunc pGetAgcRegVal;    /* ptr to get AGC register value */
    BTNR_GetInfoFunc pGetInfo;              /* ptr to get Tuner information */
    BTNR_CloseFunc pClose;                  /* ptr to close tuner module function */
    BTNR_GetPowerSaverFunc pGetPowerSaver;  /* ptr to Get tuner power saver module function */
    BTNR_SetPowerSaverFunc pSetPowerSaver;  /* ptr to set tuner power saver module function */
    BTNR_SetAgcRegValFunc pSetAgcRegVal;    /* ptr to set AGC register value */
    BTNR_GetSettingsFunc pGetSettings;  /* ptr to Get tuner power saver module function */
    BTNR_SetSettingsFunc pSetSettings;  /* ptr to set tuner power saver module function */    
} BTNR_P_Handle;


#ifdef __cplusplus
}
#endif
 
#endif