iomodule
Xilinx SDK Drivers API Documentation
XIOModule Struct Reference

The XIOModule driver instance data. More...

Data Fields

u32 BaseAddress
 Base address of registers. More...
 
u32 IsReady
 Device initialized and ready. More...
 
u32 IsStarted
 Device has been started. More...
 
XIOModule_ConfigCfgPtr
 Pointer to inst config entry. More...
 
XIOModule_Uart_Stats Uart_Stats
 UART Statistics. More...
 
XIOModule_Buffer SendBuffer
 UART Send buffer. More...
 
XIOModule_Buffer ReceiveBuffer
 UART Receive buffer. More...
 
XIOModule_Handler RecvHandler
 UART Receive Handler. More...
 
void * RecvCallBackRef
 Callback ref for recv handler. More...
 
XIOModule_Handler SendHandler
 UART Send Handler. More...
 
void * SendCallBackRef
 Callback ref for send handler. More...
 
u32 CurrentUBRR
 UART Baud Rate Register value. More...
 
u32 UnhandledInterrupts
 Iomodule Interrupt Statistics. More...
 
u32 CurrentIER
 Interrupt Enable Register value. More...
 
u32 CurrentIMR
 Interrupt Mode Register value. More...
 
XIOModule_Timer_Stats Timer_Stats [XTC_DEVICE_TIMER_COUNT]
 Timer statistics. More...
 
u32 CurrentTLR [XTC_DEVICE_TIMER_COUNT]
 Timer Load Register values. More...
 
u8 CurrentTCSR [XTC_DEVICE_TIMER_COUNT]
 Timer Control Register values. More...
 
XIOModule_Timer_Handler Handler
 Timer Callback function. More...
 
void * CallBackRef
 Timer Callback handler ref. More...
 
u32 GpoValue [XGPO_DEVICE_COUNT]
 GPO current value. More...
 
u32 IoBaseAddress
 Base address of IO Bus. More...
 

Detailed Description

The XIOModule driver instance data.

The user is required to allocate a variable of this type for every iomodule device in the system. A pointer to a variable of this type is then passed to the driver API functions.

Field Documentation

◆ BaseAddress

◆ CallBackRef

void* XIOModule::CallBackRef

Timer Callback handler ref.

Referenced by XIOModule_SetHandler().

◆ CfgPtr

◆ CurrentIER

u32 XIOModule::CurrentIER

◆ CurrentIMR

u32 XIOModule::CurrentIMR

Interrupt Mode Register value.

Referenced by XIOModule_Timer_InterruptHandler().

◆ CurrentTCSR

u8 XIOModule::CurrentTCSR[XTC_DEVICE_TIMER_COUNT]

Timer Control Register values.

Referenced by XIOModel_Timer_GetOptions().

◆ CurrentTLR

u32 XIOModule::CurrentTLR[XTC_DEVICE_TIMER_COUNT]

Timer Load Register values.

Referenced by XIOModule_GetCaptureValue().

◆ CurrentUBRR

u32 XIOModule::CurrentUBRR

UART Baud Rate Register value.

◆ GpoValue

u32 XIOModule::GpoValue[XGPO_DEVICE_COUNT]

GPO current value.

◆ Handler

XIOModule_Timer_Handler XIOModule::Handler

Timer Callback function.

Referenced by XIOModule_SetHandler().

◆ IoBaseAddress

u32 XIOModule::IoBaseAddress

Base address of IO Bus.

◆ IsReady

◆ IsStarted

u32 XIOModule::IsStarted

Device has been started.

Referenced by XIOModule_Initialize(), XIOModule_Start(), and XIOModule_Stop().

◆ ReceiveBuffer

XIOModule_Buffer XIOModule::ReceiveBuffer

UART Receive buffer.

Referenced by XIOModule_CfgInitialize(), and XIOModule_ReceiveBuffer().

◆ RecvCallBackRef

void* XIOModule::RecvCallBackRef

Callback ref for recv handler.

Referenced by XIOModule_SetRecvHandler().

◆ RecvHandler

XIOModule_Handler XIOModule::RecvHandler

UART Receive Handler.

Referenced by XIOModule_CfgInitialize(), and XIOModule_SetRecvHandler().

◆ SendBuffer

XIOModule_Buffer XIOModule::SendBuffer

UART Send buffer.

Referenced by XIOModule_CfgInitialize().

◆ SendCallBackRef

void* XIOModule::SendCallBackRef

Callback ref for send handler.

Referenced by XIOModule_SetSendHandler().

◆ SendHandler

XIOModule_Handler XIOModule::SendHandler

UART Send Handler.

Referenced by XIOModule_SetSendHandler().

◆ Timer_Stats

Timer statistics.

◆ Uart_Stats

XIOModule_Uart_Stats XIOModule::Uart_Stats

UART Statistics.

Referenced by XIOModule_ClearStats(), and XIOModule_GetStats().

◆ UnhandledInterrupts

u32 XIOModule::UnhandledInterrupts

Iomodule Interrupt Statistics.