![]() |
devcfg
Xilinx SDK Drivers API Documentation
|
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 | |
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... | |
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... | |
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... | |
void | XDcfg_ResetHw (u32 BaseAddr) |
This function perform the reset sequence to the given devcfg interface by configuring the appropriate control bits in the devcfg specifc registers the devcfg reset squence involves the following steps Disable all the interuupts Clear the status Update relevant config registers with reset values Disbale the looopback mode and pcap rate enable. More... | |
Variables | |
XDcfg_Config | XDcfg_ConfigTable [1] |
This table contains configuration information for each Device Config Interface instance in the system. More... | |
#define XDcfg_GetPsVersion | ( | InstancePtr | ) |
Get the version number of the PS from the Miscellaneous Control Register.
InstancePtr | is a pointer to the instance of XDcfg driver. |
#define XDcfg_ReadMultiBootConfig | ( | InstancePtr | ) |
Read the multiboot config register value.
InstancePtr | is a pointer to the instance of XDcfg driver. |
#define XDcfg_SelectIcapInterface | ( | InstancePtr | ) |
Selects ICAP interface for reconfiguration after the initial configuration of the PL.
InstancePtr | is a pointer to the instance of XDcfg driver. |
#define XDcfg_SelectPcapInterface | ( | InstancePtr | ) |
Selects PCAP interface for reconfiguration after the initial configuration of the PL.
InstancePtr | is a pointer to the instance of XDcfg driver. |
#define XDcfg_Unlock | ( | InstancePtr | ) |
Unlock the Device Config Interface block.
InstancePtr | is a pointer to the instance of XDcfg driver. |
Referenced by XDcfg_CfgInitialize().
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.
This function is executed in interrupt context, so amount of processing should be minimized.
CallBackRef | is the callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked. Its type is unimportant to the driver component, so it is a void pointer. |
Status | is the Interrupt status of the XDcfg device. |
int XDcfg_CfgInitialize | ( | XDcfg * | InstancePtr, |
XDcfg_Config * | ConfigPtr, | ||
u32 | EffectiveAddress | ||
) |
Initialize the Device Config Interface driver.
This function must be called before other functions of the driver are called.
InstancePtr | is a pointer to the XDcfg instance. |
ConfigPtr | is the config structure. |
EffectiveAddress | is the base address for the device. It could be a virtual address if address translation is supported in the system, otherwise it is the physical address. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg_Config::DeviceId, XDcfg::IsReady, XDcfg::IsStarted, and XDcfg_Unlock.
Referenced by DcfgSelfTestExample(), XDcfgInterruptExample(), and XDcfgRegReadExample().
void XDcfg_ClearControlRegister | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
The function Clears the specified bit positions of the Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the 32 bit value which holds the bit positions to be cleared. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
void XDcfg_DisablePCAP | ( | XDcfg * | InstancePtr | ) |
The functions disables the PCAP interface by clearing the PCAP mode bit in the control register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, XDCFG_CTRL_PCAP_MODE_MASK, XDcfg_ReadReg, and XDcfg_WriteReg.
void XDcfg_EnablePCAP | ( | XDcfg * | InstancePtr | ) |
The functions enables the PCAP interface by setting the PCAP mode bit in the control register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, XDCFG_CTRL_PCAP_MODE_MASK, XDcfg_ReadReg, and XDcfg_WriteReg.
Referenced by XDcfgInterruptExample().
u32 XDcfg_GetConfigRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Configuration Register with the given value.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CFG_OFFSET, and XDcfg_ReadReg.
u32 XDcfg_GetControlRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, and XDcfg_ReadReg.
Referenced by XDcfg_SelfTest().
u32 XDcfg_GetLockRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Lock Register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_LOCK_OFFSET, and XDcfg_ReadReg.
u32 XDcfg_GetMiscControlRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Miscellaneous Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_MCTRL_OFFSET, and XDcfg_ReadReg.
u32 XDcfg_GetSoftwareIdRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Software ID Register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDcfg_ReadReg, and XDCFG_SW_ID_OFFSET.
u32 XDcfg_GetStatusRegister | ( | XDcfg * | InstancePtr | ) |
The function reads the contents of the Status Register.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDcfg_ReadReg, and XDCFG_STATUS_OFFSET.
void XDcfg_InitiateDma | ( | XDcfg * | InstancePtr, |
u32 | SourcePtr, | ||
u32 | DestPtr, | ||
u32 | SrcWordLength, | ||
u32 | DestWordLength | ||
) |
This function initiates the DMA transfer.
InstancePtr | is a pointer to the XDcfg instance. |
SourcePtr | contains a pointer to the source memory where the data is to be transferred from. |
SrcWordLength | is the number of words (32 bit) to be transferred for the source transfer. |
DestPtr | contains a pointer to the destination memory where the data is to be transferred to. |
DestWordLength | is the number of words (32 bit) to be transferred for the Destination transfer. |
The 2 LSBs of the SourcePtr (Source)/ DestPtr (Destination)address when equal to 2�b01 indicates the last DMA command of an overall transfer.
References XDcfg_Config::BaseAddr, XDcfg::Config, XDCFG_DMA_DEST_ADDR_OFFSET, XDCFG_DMA_DEST_LEN_OFFSET, XDCFG_DMA_SRC_ADDR_OFFSET, XDCFG_DMA_SRC_LEN_OFFSET, and XDcfg_WriteReg.
Referenced by XDcfg_GetConfigReg(), and XDcfg_Transfer().
void XDcfg_InterruptHandler | ( | XDcfg * | InstancePtr | ) |
The interrupt handler for the Device Config Interface.
Events are signaled to upper layer for proper handling.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_STS_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
void XDcfg_IntrClear | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
This function clears the specified interrupts in the Interrupt Status Register.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the bit-mask of the interrupts to be cleared. Bit positions of 1 will be cleared. Bit positions of 0 will not change the previous interrupt status. This mask is formed by OR'ing XDCFG_INT_* bits which are defined in xdevcfg_hw.h. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_STS_OFFSET, and XDcfg_WriteReg.
Referenced by XDcfg_GetConfigReg(), and XDcfgInterruptExample().
void XDcfg_IntrDisable | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
This function disables the specified interrupts in the device.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the bit-mask of the interrupts to be disabled. Bit positions of 1 will be disabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XDCFG_INT_* bits defined in xdevcfg_hw.h. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_MASK_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
Referenced by XDcfgInterruptExample().
void XDcfg_IntrEnable | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
This function enables the specified interrupts in the device.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the bit-mask of the interrupts to be enabled. Bit positions of 1 will be enabled. Bit positions of 0 will keep the previous setting. This mask is formed by OR'ing XDCFG_INT_* bits defined in xdevcfg_hw.h. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_MASK_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
Referenced by XDcfgInterruptExample().
u32 XDcfg_IntrGetEnabled | ( | XDcfg * | InstancePtr | ) |
This function returns the enabled interrupts read from the Interrupt Mask Register.
Use the XDCFG_INT_* constants defined in xdevcfg_hw.h to interpret the returned value.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_MASK_OFFSET, and XDcfg_ReadReg.
u32 XDcfg_IntrGetStatus | ( | XDcfg * | InstancePtr | ) |
This function returns the interrupt status read from Interrupt Status Register.
Use the XDCFG_INT_* constants defined in xdevcfg_hw.h to interpret the returned value.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_INT_STS_OFFSET, and XDcfg_ReadReg.
Referenced by XDcfg_GetConfigReg(), and XDcfgInterruptExample().
u32 XDcfg_IsDmaBusy | ( | XDcfg * | InstancePtr | ) |
This function checks if DMA command queue is full.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDcfg_ReadReg, XDCFG_STATUS_DMA_CMD_Q_F_MASK, and XDCFG_STATUS_OFFSET.
Referenced by XDcfg_Transfer().
XDcfg_Config * XDcfg_LookupConfig | ( | u16 | DeviceId | ) |
Lookup the device configuration based on the unique device ID.
The table contains the configuration info for each device in the system.
DeviceId | is the unique device ID of the device being looked up. |
References XDcfg_ConfigTable.
Referenced by DcfgSelfTestExample(), XDcfgInterruptExample(), and XDcfgRegReadExample().
void XDcfg_ResetHw | ( | u32 | BaseAddr | ) |
This function perform the reset sequence to the given devcfg interface by configuring the appropriate control bits in the devcfg specifc registers the devcfg reset squence involves the following steps Disable all the interuupts Clear the status Update relevant config registers with reset values Disbale the looopback mode and pcap rate enable.
BaseAddress | of the interface |
References XDCFG_CFG_OFFSET, XDCFG_CONFIG_RESET_VALUE, XDCFG_CTRL_OFFSET, XDCFG_CTRL_PCAP_RATE_EN_MASK, XDCFG_DMA_DEST_ADDR_OFFSET, XDCFG_DMA_DEST_LEN_OFFSET, XDCFG_DMA_SRC_ADDR_OFFSET, XDCFG_DMA_SRC_LEN_OFFSET, XDCFG_INT_MASK_OFFSET, XDCFG_INT_STS_OFFSET, XDCFG_MCTRL_OFFSET, XDCFG_MCTRL_PCAP_LPBK_MASK, XDcfg_ReadReg, and XDcfg_WriteReg.
int XDcfg_SelfTest | ( | XDcfg * | InstancePtr | ) |
Run a self-test on the Device Configuration Interface.
This test does a control register write and reads back the same value.
InstancePtr | is a pointer to the XDcfg instance. |
References XDcfg::IsReady, XDCFG_CTRL_NIDEN_MASK, XDcfg_GetControlRegister(), and XDcfg_SetControlRegister().
Referenced by DcfgSelfTestExample(), XDcfgInterruptExample(), and XDcfgRegReadExample().
void XDcfg_SetConfigRegister | ( | XDcfg * | InstancePtr, |
u32 | Data | ||
) |
The function sets the contents of the Configuration Register with the given value.
InstancePtr | is a pointer to the XDcfg instance. |
Data | is the 32 bit data to be written to the Register. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CFG_OFFSET, and XDcfg_WriteReg.
void XDcfg_SetControlRegister | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
The function sets the contents of the Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the 32 bit mask data to be written to the Register. The mask definitions are defined in the xdevcfg_hw.h file. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
Referenced by XDcfg_SelfTest(), XDcfg_Transfer(), and XDcfgInterruptExample().
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.
InstancePtr | is a pointer to the XDcfg instance |
CallBackFunc | is the address of the callback function. |
CallBackRef | is a user data item that will be passed to the callback function when it is invoked. |
References XDcfg::IsReady.
Referenced by XDcfgInterruptExample().
void XDcfg_SetLockRegister | ( | XDcfg * | InstancePtr, |
u32 | Data | ||
) |
The function sets the contents of the Lock Register.
These bits can only be set to a 1. They will be cleared after a Power On Reset.
InstancePtr | is a pointer to the XDcfg instance. |
Data | is the 32 bit data to be written to the Register. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_LOCK_OFFSET, and XDcfg_WriteReg.
void XDcfg_SetMiscControlRegister | ( | XDcfg * | InstancePtr, |
u32 | Mask | ||
) |
The function sets the bit mask for the feature in Miscellaneous Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
Mask | is the bit-mask of the feature to be set. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_MCTRL_OFFSET, XDcfg_ReadReg, and XDcfg_WriteReg.
void XDcfg_SetRomShadowRegister | ( | XDcfg * | InstancePtr, |
u32 | Data | ||
) |
The function sets the contents of the ROM Shadow Control Register.
InstancePtr | is a pointer to the XDcfg instance. |
Data | is the 32 bit data to be written to the Register. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_ROM_SHADOW_OFFSET, and XDcfg_WriteReg.
void XDcfg_SetStatusRegister | ( | XDcfg * | InstancePtr, |
u32 | Data | ||
) |
The function sets the contents of the Status Register.
InstancePtr | is a pointer to the XDcfg instance. |
Data | is the 32 bit data to be written to the Register. |
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_STATUS_OFFSET, and XDcfg_WriteReg.
u32 XDcfg_Transfer | ( | XDcfg * | InstancePtr, |
void * | SourcePtr, | ||
u32 | SrcWordLength, | ||
void * | DestPtr, | ||
u32 | DestWordLength, | ||
u32 | TransferType | ||
) |
This function starts the DMA transfer.
This function only starts the operation and returns before the operation may be completed. If the interrupt is enabled, an interrupt will be generated when the operation is completed, otherwise it is necessary to poll the Status register to determine when it is completed. It is the responsibility of the caller to determine when the operation is completed by handling the generated interrupt or polling the Status Register.
InstancePtr | is a pointer to the XDcfg instance. |
SourcePtr | contains a pointer to the source memory where the data is to be transferred from. |
SrcWordLength | is the number of words (32 bit) to be transferred for the source transfer. |
DestPtr | contains a pointer to the destination memory where the data is to be transferred to. |
DestWordLength | is the number of words (32 bit) to be transferred for the Destination transfer. |
TransferType | contains the type of PCAP transfer being requested. The definitions can be found in the xdevcfg.h file. |
The 2 LSBs of the SourcePtr (Source)/ DestPtr (Destination)address when equal to 2�b01 indicates the last DMA command of an overall transfer.
References XDcfg_Config::BaseAddr, XDcfg::Config, XDcfg::IsReady, XDCFG_CTRL_OFFSET, XDCFG_CTRL_PCAP_RATE_EN_MASK, XDcfg_InitiateDma(), XDcfg_IsDmaBusy(), XDCFG_MCTRL_OFFSET, XDCFG_MCTRL_PCAP_LPBK_MASK, XDcfg_ReadReg, XDcfg_SetControlRegister(), XDCFG_STATUS_OFFSET, XDCFG_STATUS_PCFG_INIT_MASK, and XDcfg_WriteReg.
Referenced by XDcfg_GetConfigReg(), and XDcfgInterruptExample().
XDcfg_Config XDcfg_ConfigTable[1] |
This table contains configuration information for each Device Config Interface instance in the system.
Referenced by XDcfg_LookupConfig().