dfeequ
Vitis Drivers API Documentation
Functions
xdfeequ_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     04/01/21 Set mgt si570 oscillator to 122.88MHz
      dc     02/02/21 Remove hard coded device node name
      dc     02/22/21 align driver to current specification
      dc     04/06/21 Register with full node name
      dc     04/07/21 Fix bare metal initialisation
1.1   dc     07/13/21 Update to common latency requirements
      dc     07/21/21 Add and reorganise examples
1.3   dc     03/21/22 Add prefix to global variables
1.5   cog    07/18/23 Modify example for SDT flow
1.6   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 XDfeEqu_SelfExample ()


 This function runs the DFE Equalizer device using the driver APIs.  More...


 


int XDfeEqu_PassThroughExample ()


 This function runs the DFE Equalizer device using the driver 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 XDfeEqu_PassThroughExample(), XDfeEqu_SelfExample(), XDfeSi570_SetMgtOscillator(), XST_FAILURE, and XST_SUCCESS.











      

        

          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

  

    
CurrentFrequencyMGT oscillator current frequency. 

    
NewFrequencyMGT oscillator new frequency.

  

  




Returns
None


Note
None 



References XST_FAILURE, and XST_SUCCESS.



Referenced by main().