xdfemix_examples.c File Reference

Overview

This file contains the examples main function.

Note: MGT si570 oscillator is set to 152.25MHz by default. The DFE IP wrapper requires MGT clock to be set to 122.88MHz (some IP use 61.44MHz). Prerequisite is to set the MGT si570 oscillator to the required IP before running the example code. This is for the ZCU670 production platform.

MODIFICATION HISTORY:

Ver   Who    Date     Changes



1.0   dc     12/06/20 Initial version
      dc     01/04/21 Set mgt si570 oscillator to 122.88MHz
      dc     02/02/21 Remove hard coded device node name
      dc     02/15/21 align driver to curent specification
      dc     02/22/21 include HW in versioning
      dc     04/06/21 Register with full node name
      dc     04/08/21 Set sequence length only once
      dc     04/14/21 Add FIR_ENABLE/MIXER_ENABLE register support
1.1   dc     07/13/21 Update to common latency requirements
      dc     07/21/21 Add and reorganise examples
1.2   dc     11/01/21 Add multi AddCC, RemoveCC and UpdateCC
1.3   dc     03/21/22 Add prefix to global variables
1.6   cog    07/18/23 Modify example for SDT flow
1.7   cog    04/20/24 Configure si570 in Linux examples

Functions
int	XDfeSi570_SetMgtOscillator (double CurrentFrequency, double NewFrequency)
	This function: initialize I2C bus, reads current state of si570, calculates parameters for si570 MGT oscillator new frequency, writes them to si570 and resets PL to use the new frequency. More...
int	XDfeMix_SelfTestExample ()
	This function runs the DFE Mixer device using the driver APIs. More...
int	XDfeMix_AddCCExample ()
	This function runs the DFE Mixer device using the driver APIs. More...
int	XDfeMix_MultiAddCCExample ()
	This example configures Mixer driver for one CC with multiAddCC APIs. More...
int	main (void)
	Main function that initialise si570 and runs examples. More...

Function Documentation

int main

(

void

)

Main function that initialise si570 and runs examples.

Parameters

None.

Returns

• XST_SUCCESS if the example has completed successfully.
• XST_FAILURE if the example has failed.

References XDfeMix_AddCCExample(), XDfeMix_MultiAddCCExample(), XDfeMix_SelfTestExample(), XDfeSi570_SetMgtOscillator(), XST_FAILURE, and XST_SUCCESS.

int XDfeMix_SelfTestExample

(

)

This function runs the DFE Mixer device using the driver APIs.

This function does the following tasks:

• Create and system initialize the device driver instance.
• Read SW and HW version numbers.
• Reset the device.
• Configure the device.
• Initialize the device.
• Activate the device.
• DeActivate the device.

Returns

• XST_SUCCESS if the example has completed successfully.
• XST_FAILURE if the example has failed.

References XDfeMix_Version::Major, XDfeMix_Version::Minor, XDfeMix_Version::Patch, XDfeMix_Version::Revision, XDfeMix_Init::TuserSelect, XDfeMix_Activate(), XDfeMix_Configure(), XDfeMix_Deactivate(), XDfeMix_GetVersions(), XDfeMix_Initialize(), XDfeMix_InstanceClose(), XDfeMix_InstanceInit(), XDfeMix_Reset(), XST_FAILURE, and XST_SUCCESS.

Referenced by main().

int XDfeSi570_SetMgtOscillator	(	double	CurrentFrequency,
		double	NewFrequency
	)

This function: initialize I2C bus, reads current state of si570, calculates parameters for si570 MGT oscillator new frequency, writes them to si570 and resets PL to use the new frequency.

Parameters

CurrentFrequency	MGT oscillator current frequency.
NewFrequency	MGT oscillator new frequency.

Returns

None

Note

None

References XST_FAILURE, and XST_SUCCESS.

Referenced by main().