| devcfg Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Data Structures | Macros | Typedefs | Functions
xdevcfg.h File Reference

## Data Structures
struct | XDcfg_Config
| This typedef contains configuration information for the device. More...
struct | XDcfg
| The XDcfg driver instance data. More...

## Macros
#define | XDcfg_Unlock(InstancePtr)
| Unlock the Device Config Interface block. More...
#define | XDcfg_GetPsVersion(InstancePtr)
| Get the version number of the PS from the Miscellaneous Control Register. More...
#define | XDcfg_ReadMultiBootConfig(InstancePtr)
| Read the multiboot config register value. More...
#define | XDcfg_SelectIcapInterface(InstancePtr)
| Selects ICAP interface for reconfiguration after the initial configuration of the PL. More...
#define | XDcfg_SelectPcapInterface(InstancePtr)
| Selects PCAP interface for reconfiguration after the initial configuration of the PL. More...

## Typedefs
typedef void(* | XDcfg_IntrHandler )(void *CallBackRef, u32 Status)
| The handler data type allows the user to define a callback function to respond to interrupt events in the system. More...

## Functions
XDcfg_Config * | XDcfg_LookupConfig (u16 DeviceId)
| Lookup the device configuration based on the unique device ID. More...
int | XDcfg_SelfTest (XDcfg *InstancePtr)
| Run a self-test on the Device Configuration Interface. More...
int | XDcfg_CfgInitialize (XDcfg *InstancePtr, XDcfg_Config *ConfigPtr, u32 EffectiveAddress)
| Initialize the Device Config Interface driver. More...
void | XDcfg_EnablePCAP (XDcfg *InstancePtr)
| The functions enables the PCAP interface by setting the PCAP mode bit in the control register. More...
void | XDcfg_DisablePCAP (XDcfg *InstancePtr)
| The functions disables the PCAP interface by clearing the PCAP mode bit in the control register. More...
void | XDcfg_SetControlRegister (XDcfg *InstancePtr, u32 Mask)
| The function sets the contents of the Control Register. More...
void | XDcfg_ClearControlRegister (XDcfg *InstancePtr, u32 Mask)
| The function Clears the specified bit positions of the Control Register. More...
u32 | XDcfg_GetControlRegister (XDcfg *InstancePtr)
| The function reads the contents of the Control Register. More...
void | XDcfg_SetLockRegister (XDcfg *InstancePtr, u32 Data)
| The function sets the contents of the Lock Register. More...
u32 | XDcfg_GetLockRegister (XDcfg *InstancePtr)
| The function reads the contents of the Lock Register. More...
void | XDcfg_SetConfigRegister (XDcfg *InstancePtr, u32 Data)
| The function sets the contents of the Configuration Register with the given value. More...
u32 | XDcfg_GetConfigRegister (XDcfg *InstancePtr)
| The function reads the contents of the Configuration Register with the given value. More...
void | XDcfg_SetStatusRegister (XDcfg *InstancePtr, u32 Data)
| The function sets the contents of the Status Register. More...
u32 | XDcfg_GetStatusRegister (XDcfg *InstancePtr)
| The function reads the contents of the Status Register. More...
void | XDcfg_SetRomShadowRegister (XDcfg *InstancePtr, u32 Data)
| The function sets the contents of the ROM Shadow Control Register. More...
u32 | XDcfg_GetSoftwareIdRegister (XDcfg *InstancePtr)
| The function reads the contents of the Software ID Register. More...
void | XDcfg_SetMiscControlRegister (XDcfg *InstancePtr, u32 Mask)
| The function sets the bit mask for the feature in Miscellaneous Control Register. More...
u32 | XDcfg_GetMiscControlRegister (XDcfg *InstancePtr)
| The function reads the contents of the Miscellaneous Control Register. More...
u32 | XDcfg_IsDmaBusy (XDcfg *InstancePtr)
| This function checks if DMA command queue is full. More...
void | XDcfg_InitiateDma (XDcfg *InstancePtr, u32 SourcePtr, u32 DestPtr, u32 SrcWordLength, u32 DestWordLength)
| This function initiates the DMA transfer. More...
u32 | XDcfg_Transfer (XDcfg *InstancePtr, void *SourcePtr, u32 SrcWordLength, void *DestPtr, u32 DestWordLength, u32 TransferType)
| This function starts the DMA transfer. More...
void | XDcfg_IntrEnable (XDcfg *InstancePtr, u32 Mask)
| This function enables the specified interrupts in the device. More...
void | XDcfg_IntrDisable (XDcfg *InstancePtr, u32 Mask)
| This function disables the specified interrupts in the device. More...
u32 | XDcfg_IntrGetEnabled (XDcfg *InstancePtr)
| This function returns the enabled interrupts read from the Interrupt Mask Register. More...
u32 | XDcfg_IntrGetStatus (XDcfg *InstancePtr)
| This function returns the interrupt status read from Interrupt Status Register. More...
void | XDcfg_IntrClear (XDcfg *InstancePtr, u32 Mask)
| This function clears the specified interrupts in the Interrupt Status Register. More...
void | XDcfg_InterruptHandler (XDcfg *InstancePtr)
| The interrupt handler for the Device Config Interface. More...
void | XDcfg_SetHandler (XDcfg *InstancePtr, void *CallBackFunc, void *CallBackRef)
| This function sets the handler that will be called when an event (interrupt) occurs that needs application's attention. More...