clk_wiz
Vitis Drivers API Documentation
xclk_wiz.h File Reference

Data Structures

struct  XClk_Wiz_Config
 The configuration structure for CLK_WIZ Controller This structure passes the hardware building information to the driver. More...
 
struct  XClk_Wiz
 The XClk_Wiz driver instance data. More...
 

Macros

Interrupt Types for setting Callbacks
#define XCLK_WIZ_HANDLER_CLK_OUTOF_RANGE   1
 
#define XCLK_WIZ_HANDLER_CLK_GLITCH   2
 
#define XCLK_WIZ_HANDLER_CLK_STOP   3
 
#define XCLK_WIZ_HANDLER_CLK_OTHER_ERROR   4
 
#define XCLK_M_MIN   4
 
#define XCLK_M_MAX   432
 
#define XCLK_D_MIN   1
 
#define XCLK_D_MAX   123
 
#define XCLK_VCO_MIN   2160
 
#define XCLK_VCO_MAX   4320
 
#define XCLK_O_MIN   2
 
#define XCLK_O_MAX   511
 
#define XCLK_US_VCO_MAX   1600
 
#define XCLK_US_VCO_MIN   800
 
#define XCLK_US_M_MIN   2
 
#define XCLK_US_M_MAX   128
 
#define XCLK_US_D_MAX   106
 
#define XCLK_US_D_MIN   1
 
#define XCLK_US_O_MAX   128
 
#define XCLK_US_O_MIN   1
 
#define XCLK_MHZ   1000000
 

Typedefs

typedef void(* XClk_Wiz_CallBack )(void *CallBackRef, u32 Mask)
 Callback type for all interrupts defined. More...
 

Functions

XClk_Wiz_ConfigXClk_Wiz_LookupConfig (u32 DeviceId)
 Look up the hardware configuration for a device instance. More...
 
u32 XClk_Wiz_SetRate (XClk_Wiz *InstancePtr, u64 SetRate)
 Change the frequency to the given rate. More...
 
u32 XClk_Wiz_CfgInitialize (XClk_Wiz *InstancePtr, XClk_Wiz_Config *CfgPtr, UINTPTR EffectiveAddr)
 Initialize the XClk_Wiz instance provided by the caller based on the given Config structure. More...
 
void XClk_Wiz_GetInterruptSettings (XClk_Wiz *InstancePtr)
 XClk_Wiz_GetInterruptSettings will get the information from clock wizard IER and ISR Registers. More...
 
int XClk_Wiz_SetCallBack (XClk_Wiz *InstancePtr, u32 HandleType, void *CallBackFunc, void *CallBackRef)
 This routine installs an asynchronous callback function for the given HandlerType: More...
 
u32 XClk_Wiz_EnableClock (XClk_Wiz *InstancePtr, u32 ClockId)
 Enable Clock for the given ClockId. More...
 
u32 XClk_Wiz_DisableClock (XClk_Wiz *InstancePtr, u32 ClockId)
 Disable Clock for the given ClockId. More...
 
void XClk_Wiz_SetInputRate (XClk_Wiz *InstancePtr, double Rate)
 Change the Input frequency to the given rate. More...
 
u32 XClk_Wiz_WaitForLock (XClk_Wiz *InstancePtr)
 Wait till the clocking wizard is locked to the frequency. More...