xdfeequ.h File Reference

Data Structures
struct	XDfeEqu_Version
	Logicore version. More...
struct	XDfeEqu_Trigger
	Trigger configuration. More...
struct	XDfeEqu_TriggerCfg
	All IP triggers. More...
struct	XDfeEqu_ModelParameters
	Equalizer Filter model parameters structure. More...
struct	XDfeEqu_Cfg
	Configuration. More...
struct	XDfeEqu_Coefficients
	Equalizer Coefficients Structure. More...
struct	XDfeEqu_EqConfig
	Equalizer Configuration Structure. More...
struct	XDfeEqu_Status
	Equalizer Status. More...
struct	XDfeEqu_InterruptMask
	Event status and interrupt mask. More...
struct	XDfeEqu_Config
	Equalizer Config Structure. More...
struct	XDfeEqu
	Equalizer Structure. More...

Macros
#define	XDFEEQU_MAX_NUM_INSTANCES   (10U)
	Maximum number of driver instances running at the same time. More...
#define	XST_SUCCESS   (0L)
	Success flag. More...
#define	XST_FAILURE   (1L)
	Failure flag. More...
#define	XDFEEQU_NODE_NAME_MAX_LENGTH   (50U)
	Node name maximum length. More...
#define	XDFEEQU_ANT_NUM_MAX   (8U)
	Maximum anntena number. More...
#define	XDFEEQU_CHANNEL_NUM   (8U)
	Maximum channel number. More...
#define	XDFEEQU_MAX_NUMBER_OF_UNITS_COMPLEX   (0x3U)
	Complex units number. More...
#define	XDFEEQU_MAX_NUMBER_OF_UNITS_REAL   (0x6U)
	Real units number. More...
#define	XDFEEQU_NUM_COEFF   (24U)
	Maximum number of coefficents. More...
#define	XDFEEQU_DATAPATH_MODE_REAL   (0U)
	Real mode. More...
#define	XDFEEQU_DATAPATH_MODE_COMPLEX   (1U)
	Complex mode. More...

Enumerations
enum	XDfeEqu_StateId {   XDFEEQU_STATE_NOT_READY = 0, XDFEEQU_STATE_READY, XDFEEQU_STATE_RESET, XDFEEQU_STATE_CONFIGURED,   XDFEEQU_STATE_INITIALISED, XDFEEQU_STATE_OPERATIONAL }

Functions
XDfeEqu *	XDfeEqu_InstanceInit (const char *DeviceNodeName)
	API initialises one instance of an Equalizer driver. More...
void	XDfeEqu_InstanceClose (XDfeEqu *InstancePtr)
	API closes the instance of an Equalizer driver and moves the state machine to a Not Ready state. More...
void	XDfeEqu_Reset (XDfeEqu *InstancePtr)
	Resets Equalizer and puts block into a reset state. More...
void	XDfeEqu_Configure (XDfeEqu *InstancePtr, XDfeEqu_Cfg *Cfg)
	Reads configuration from device tree/xparameters.h and IP registers. More...
void	XDfeEqu_Initialize (XDfeEqu *InstancePtr, const XDfeEqu_EqConfig *Config)
	DFE Equalizer driver one time initialisation and moves the state machine to a Initialised state. More...
void	XDfeEqu_Activate (XDfeEqu *InstancePtr, bool EnableLowPower)
	Activates channel Equalizer moves the state machine to an Activated state. More...
void	XDfeEqu_Deactivate (XDfeEqu *InstancePtr)
	Deactivates Equalizer and moves the state machine to Initialised state. More...
XDfeEqu_StateId	XDfeEqu_GetStateID (XDfeEqu *InstancePtr)
	Gets a state machine state id. More...
void	XDfeEqu_Update (const XDfeEqu *InstancePtr, const XDfeEqu_EqConfig *Config)
	Updates Equalizer mode. More...
void	XDfeEqu_GetTriggersCfg (const XDfeEqu *InstancePtr, XDfeEqu_TriggerCfg *TriggerCfg)
	Returns current trigger configuration. More...
void	XDfeEqu_SetTriggersCfg (const XDfeEqu *InstancePtr, XDfeEqu_TriggerCfg *TriggerCfg)
	Sets trigger configuration. More...
void	XDfeEqu_LoadCoefficients (const XDfeEqu *InstancePtr, u32 ChannelField, u32 Mode, u32 Shift, const XDfeEqu_Coefficients *EqCoeffs)
	Sets Equalizer filter coefficients in Real, Complex or Matrix mode. More...
void	XDfeEqu_GetEventStatus (const XDfeEqu *InstancePtr, XDfeEqu_Status *Status)
	Gets event status. More...
void	XDfeEqu_ClearEventStatus (const XDfeEqu *InstancePtr, const XDfeEqu_Status *Status)
	Clears Equalizer status. More...
void	XDfeEqu_SetInterruptMask (const XDfeEqu *InstancePtr, const XDfeEqu_InterruptMask *InterruptMask)
	Enables an Equalizer status for channel ID. More...
void	XDfeEqu_GetInterruptMask (const XDfeEqu *InstancePtr, XDfeEqu_InterruptMask *InterruptMask)
	Gets interrupt mask. More...
void	XDfeEqu_GetActiveSets (const XDfeEqu *InstancePtr, u32 *RealSet, u32 *ImagSet)
	Gets used coefficients settings. More...
void	XDfeEqu_SetTUserDelay (const XDfeEqu *InstancePtr, u32 Delay)
	Sets the delay, which will be added to TUSER and TLAST (delay matched through the IP). More...
u32	XDfeEqu_GetTUserDelay (const XDfeEqu *InstancePtr)
	Reads the delay, which will be added to TUSER and TLAST (delay matched through the IP). More...
u32	XDfeEqu_GetTDataDelay (const XDfeEqu *InstancePtr, u32 Tap)
	Returns data latency + tap, where the tap is between 0 and 23 in real mode and between 0 and 11 in complex mode. More...
void	XDfeEqu_GetVersions (const XDfeEqu *InstancePtr, XDfeEqu_Version *SwVersion, XDfeEqu_Version *HwVersion)
	This API gets the driver and HW design version. More...