marvell/services/proslic/si3217x_intf.h

/*
** Copyright (c) 2007-2017 by Silicon Laboratories
**
** $Id: si3217x_intf.h 6437 2017-04-25 23:35:31Z nizajerk $
**
** Si3217x_Intf.h
** Si3217x ProSLIC interface header file
**
** Author(s):
** laj
**
** Distributed by:
** Silicon Laboratories, Inc
**
** This file contains proprietary information.
** No dissemination allowed without prior written permission from
** Silicon Laboratories, Inc.
**
** File Description:
** This is the header file for the ProSLIC driver.
**
**
*/

#ifndef SI3217X_INTF_H
#define SI3217X_INTF_H


/* The following macros are for backward compatibility */
#define Si3217x_CheckCIDBuffer          ProSLIC_CheckCIDBuffer
#define Si3217x_DCFeedSetup(PCHAN, NDX) Si3217x_DCFeedSetupCfg((PCHAN),Si3217x_DCfeed_Presets, (NDX))
#define Si3217x_DisableCID              ProSLIC_DisableCID
#define Si3217x_DisableInterrupts       ProSLIC_DisableInterrupts
#define Si3217x_DTMFReadDigit           ProSLIC_DTMFReadDigit
#define Si3217x_EnableCID               ProSLIC_EnableCID
#define Si3217x_GetInterrupts           ProSLIC_GetInterrupts
#define Si3217x_GetLBCalResult          ProSLIC_GetLBCalResult
#define Si3217x_GetLBCalResultPacked    ProSLIC_GetLBCalResultPacked
#define Si3217x_GetPLLFreeRunStatus     ProSLIC_GetPLLFreeRunStatus
#define Si3217x_GPIOControl             ProSLIC_GPIOControl
#define Si3217x_Init(PCHAN, SZ)         Si3217x_Init_with_Options((PCHAN), (SZ), INIT_NO_OPT)
#define Si3217x_LoadPatch               ProSLIC_LoadPatch
#define Si3217x_LoadPreviousLBCal       ProSLIC_LoadPreviousLBCal
#define Si3217x_LoadPreviousLBCalPacked ProSLIC_LoadPreviousLBCalPacked
#define Si3217x_LoadRegTables           ProSLIC_LoadRegTables
#define Si3217x_ModemDetSetup(PCH, NDX) ProSLIC_UnsupportedFeatureNoArg((PCH), "Si3217x_ModemDetSetup")
#define Si3217x_ModifyCIDStartBits      ProSLIC_ModifyCIDStartBits
#define Si3217x_PCMStart                ProSLIC_PCMStart
#define Si3217x_PCMStop                 ProSLIC_PCMStop
#define Si3217x_PCMTimeSlotSetup        ProSLIC_PCMTimeSlotSetup
#define Si3217x_PLLFreeRunStart         ProSLIC_PLLFreeRunStart
#define Si3217x_PLLFreeRunStop          ProSLIC_PLLFreeRunStop
#define Si3217x_PolRev                  ProSLIC_PolRev
#define Si3217x_PringDebugRAM           ProSLIC_PrintDebugRAM
#define Si3217x_PrintDebugData          ProSLIC_PrintDebugData
#define Si3217x_PrintDebugReg           ProSLIC_PrintDebugReg
#define Si3217x_PulseMeterDisable       ProSLIC_PulseMeterDisable
#define Si3217x_PulseMeterEnable        ProSLIC_PulseMeterEnable
#define Si3217x_PulseMeterStart         ProSLIC_PulseMeterStart
#define Si3217x_PulseMeterStop          ProSLIC_PulseMeterStop
#define Si3217x_ReadHookStatus          ProSLIC_ReadHookStatus
#define Si3217x_ReadRAM                 ProSLIC_ReadRAM
#define Si3217x_ReadReg                 ProSLIC_ReadReg
#define Si3217x_Reset                   SiVoice_Reset
#define Si3217x_RingStart               ProSLIC_RingStart
#define Si3217x_RingStop                ProSLIC_RingStop
#define Si3217x_SendCID                 ProSLIC_SendCID
#define Si3217x_SetLoopbackMode         ProSLIC_SetLoopbackMode
#define Si3217x_SetMuteStatus           ProSLIC_SetMuteStatus
#define Si3217x_SetPowersaveMode        ProSLIC_SetPowersaveMode
#define Si3217x_SetProfile(PCH, PRESET) ProSLIC_UnsupportedFeatureNoArg((PCH), "Si3217x_SetProfile")
#define Si3217x_ToneGenStart            ProSLIC_ToneGenStart
#define Si3217x_ToneGenStop             ProSLIC_ToneGenStop
#define Si3217x_VerifyPatch		          ProSLIC_VerifyPatch
#define Si3217x_WriteRAM                ProSLIC_WriteRAM
#define Si3217x_WriteReg                ProSLIC_WriteReg
#define Si3217x_VerifyControlInterface  ProSLIC_VefifyControlInterface
#define Si3217x_ShutdownChannel         ProSLIC_PowerDownConverter
#define Si3217x_PowerDownConverter      ProSLIC_PowerDownConverter
#define Si3217x_ToneGenSetup            ProSLIC_ToneGenSetup
#define Si3217x_FSKSetup                ProSLIC_FSKSetup
#define Si3217x_SetLinefeedStatusBroadcast   ProSLIC_SetLinefeedStatusBroadcast
#define Si3217x_SetLinefeedStatus       ProSLIC_SetLinefeedStatus

#define Si3217x_MWIEnable                    ProSLIC_MWIEnable
#define Si3217x_MWIDisable                   ProSLIC_MWIDisable
#define Si3217x_SetMWIState                  ProSLIC_SetMWIState
#define Si3217x_GetMWIState                  ProSLIC_GetMWIState
#define Si3217x_MWISetup(PCHAN,VPK,LCR)      ProSLIC_MWISetV(PCHAN,VPK)


/* DC Feed */
#ifndef DISABLE_DCFEED_SETUP
extern Si3217x_DCfeed_Cfg Si3217x_DCfeed_Presets[];
#endif
/*
**
** PROSLIC INITIALIZATION FUNCTIONS
**
*/

/*
** Function: PROSLIC_ShutdownChannel
**
** Description:
** Safely shutdown channel w/o interruption to
** other active channels
**
** Input Parameters:
** pProslic: pointer to PROSLIC object
**
** Return:
** none
*/
int Si3217x_ShutdownChannel (proslicChanType_ptr hProslic);

/*
** Function: PROSLIC_Init_MultiBOM
**
** Description:
** Initializes the ProSLIC w/ selected general parameters
**
** Input Parameters:
** pProslic: pointer to PROSLIC object
** size:     number of channels
** preset:   General configuration preset
**
** Return:
** none
*/
#ifdef SIVOICE_MULTI_BOM_SUPPORT
int Si3217x_Init_MultiBOM (proslicChanType_ptr *hProslic,int size,int preset);
#endif

/*
** Function: Si3217x_Init_with_Options
**
** Description:
** Initializes the ProSLIC with an option.
**
** Input Parameters:
** pProslic: pointer to PROSLIC object
** size - number of continuous channels to initialize
** init_opt - which initialization type to do.
**
** Return:
** none
*/
int Si3217x_Init_with_Options (proslicChanType_ptr *pProslic, int size,
                               initOptionsType init_opt);

/*
** Function: Si3217x_PowerUpConverter
**
** Description:
** Powers all DC/DC converters sequentially with delay to minimize
** peak power draw on VDC.
**
** Returns:
** int (error)
**
*/
int Si3217x_PowerUpConverter(proslicChanType_ptr hProslic);

/*
** Function: PROSLIC_EnableInterrupts
**
** Description:
** Enables interrupts
**
** Input Parameters:
** hProslic: pointer to Proslic object
**
** Return:
**
*/
int Si3217x_EnableInterrupts (proslicChanType_ptr hProslic);

/*
**
** PROSLIC CONFIGURATION FUNCTIONS
**
*/

/*
** Function: PROSLIC_RingSetup
**
** Description:
** configure ringing
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pRingSetup: pointer to ringing config structure
**
** Return:
** none
*/
int Si3217x_RingSetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_DTMFDecodeSetup
**
** Description:
** configure dtmf decode
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pDTMFDec: pointer to dtmf decoder config structure
**
** Return:
** none
*/
int Si3217x_DTMFDecodeSetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_ZsynthSetup
**
** Description:
** configure impedance synthesis
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pZynth: pointer to zsynth config structure
**
** Return:
** none
*/
int Si3217x_ZsynthSetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_GciCISetup
**
** Description:
** configure CI bits (GCI mode)
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pCI: pointer to ringing config structure
**
** Return:
** none
*/
int Si3217x_GciCISetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_AudioGainSetup
**
** Description:
** configure audio gains
**
** Input Parameters:
** pProslic: pointer to Proslic object
** preset:   impedance preset to scale
**
** Return:
** none
*/
int Si3217x_TXAudioGainSetup (proslicChanType *pProslic, int preset);
int Si3217x_RXAudioGainSetup (proslicChanType *pProslic, int preset);
#define Si3217x_AudioGainSetup ProSLIC_AudioGainSetup

/*
** Function: PROSLIC_TXAudioGainScale
**
** Description:
** configure audio gains
**
** Input Parameters:
** pProslic:  pointer to Proslic object
** preset:    pointer to audio gains config structure
** pga_scale: pga_scaling constant
** eq_scale:  equalizer scaling constant
**
** Return:
** none
*/
int Si3217x_TXAudioGainScale (proslicChanType *pProslic, int preset,
                              uInt32 pga_scale, uInt32 eq_scale);

/*
** Function: PROSLIC_RXAudioGainScale
**
** Description:
** configure audio gains
**
** Input Parameters:
** pProslic:  pointer to Proslic object
** preset:    pointer to audio gains config structure
** pga_scale: pga_scaling constant
** eq_scale:  equalizer scaling constant
**
** Return:
** none
*/
int Si3217x_RXAudioGainScale (proslicChanType *pProslic, int preset,
                              uInt32 pga_scale, uInt32 eq_scale);

/*
** Function: PROSLIC_AudioEQSetup
**
** Description:
** configure audio equalizers
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pAudioEQ: pointer to ringing config structure
**
** Return:
** none
*/
int Si3217x_AudioEQSetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_DCFeedSetup
**
** Description:
** configure dc feed
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pDcFeed: pointer to dc feed config structure
**
** Return:
** none
*/
int Si3217x_DCFeedSetupCfg (proslicChanType *pProslic, ProSLIC_DCfeed_Cfg *cfg,
                            int preset);

/*
** Function: PROSLIC_GPIOSetup
**
** Description:
** configure gpio
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pGpio: pointer to gpio config structure
**
** Return:
** none
*/
int Si3217x_GPIOSetup (proslicChanType *pProslic);

/*
** Function: PROSLIC_PCMSetup
**
** Description:
** configure pcm
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pPcm: pointer to pcm config structure
**
** Return:
** none
*/
int Si3217x_PCMSetup(proslicChanType *pProslic, int preset);

/*
**
** PROSLIC CONTROL FUNCTIONS
**
*/

/*
** Function: PROSLIC_GetInterrupts
**
** Description:
** Enables interrupts
**
** Input Parameters:
** hProslic: pointer to Proslic object
** pIntData: pointer to interrupt info retrieved
**
** Return:
**
*/
int Si3217x_GetInterrupts (proslicChanType_ptr hProslic,
                           proslicIntType *pIntData);

/*
** Function: PROSLIC_PulseMeterSetup
**
** Description:
** configure pulse metering
**
** Input Parameters:
** pProslic: pointer to Proslic object
** pPulseCfg: pointer to pulse metering config structure
**
** Return:
** none
*/
int Si3217x_PulseMeterSetup (proslicChanType *pProslic, int preset);

/*
** Function: PROSLIC_dbgSetDCFeed
**
** Description:
** provision function for setting up
** dcfeed given desired open circuit voltage
** and loop current.
*/
int Si3217x_dbgSetDCFeed (proslicChanType *pProslic, uInt32 v_vlim_val,
                          uInt32 i_ilim_val, int32 preset);

/*
** Function: PROSLIC_dbgSetDCFeedVopen
**
** Description:
** provision function for setting up
** dcfeed given desired open circuit voltage
** and loop current.
*/
int Si3217x_dbgSetDCFeedVopen (proslicChanType *pProslic, uInt32 v_vlim_val,
                               int32 preset);


/*
** Function: PROSLIC_dbgSetDCFeedIloop
**
** Description:
** provision function for setting up
** dcfeed given desired open circuit voltage
** and loop current.
*/
int Si3217x_dbgSetDCFeedIloop (proslicChanType *pProslic, uInt32 i_ilim_val,
                               int32 preset);


/*
** Function: PROSLIC_dbgRingingSetup
**
** Description:
** Provision function for setting up
** Ring type, frequency, amplitude and dc offset.
** Main use will be by peek/poke applications.
*/
int Si3217x_dbgSetRinging (proslicChanType *pProslic,
                           ProSLIC_dbgRingCfg *ringCfg, int preset);

/*
** Function: PROSLIC_dbgSetRXGain
**
** Description:
** Provision function for setting up
** RX path gain.
*/
int Si3217x_dbgSetRXGain (proslicChanType *pProslic, int32 gain,
                          int impedance_preset, int audio_gain_preset);

/*
** Function: PROSLIC_dbgSetTXGain
**
** Description:
** Provision function for setting up
** TX path gain.
*/
int Si3217x_dbgSetTXGain (proslicChanType *pProslic, int32 gain,
                          int impedance_preset, int audio_gain_preset);


/*
** Function: PROSLIC_LineMonitor
**
** Description:
** Monitor line voltages and currents
*/
int Si3217x_LineMonitor(proslicChanType *pProslic, proslicMonitorType *monitor);


/*
** Function: PROSLIC_PSTNCheck
**
** Description:
** Continuous monitor of ilong to detect hot pstn line
*/
int Si3217x_PSTNCheck(proslicChanType *pProslic,
                      proslicPSTNCheckObjType *pstnCheckObj);


/*
** Function: PROSLIC_PSTNCheck
**
** Description:
** Continuous monitor of ilong to detect hot pstn line
*/
int Si3217x_DiffPSTNCheck(proslicChanType *pProslic,
                          proslicDiffPSTNCheckObjType *pstnCheckObj);

/*
** Function: PROSLIC_ReadMADCScaled
**
** Description:
** Read MADC (or other sensed voltages/currents) and
** return scaled value in int32 format
*/
int32 Si3217x_ReadMADCScaled(proslicChanType_ptr pProslic, uInt16 addr,
                             int32 scale);

/*
** Function: PROSLIC_SetDAAEnable
**
** Description:
** Enable FXO channel (Si32178 only)
*/
int Si3217x_SetDAAEnable(proslicChanType *pProslic, int enable);

/* 
** Function: Si3217x_GetChipInfo
** Description: Returns the specific chipset in the Si3217x family.
** Input parameters: channel pointer
** output: either RC_SPI_FAIL or RC_NONE.  channel pointer deviceId will be updated.
**/
int Si3217x_GetChipInfo(proslicChanType_ptr pProslic);

#endif