iic
Xilinx SDK Drivers API Documentation
XIic Struct Reference

The XIic driver instance data. More...

Data Fields

XIicStats Stats
 Statistics. More...
 
UINTPTR BaseAddress
 Device base address. More...
 
int Has10BitAddr
 TRUE when 10 bit addressing in design. More...
 
int IsReady
 Device is initialized and ready. More...
 
int IsStarted
 Device has been started. More...
 
int AddrOfSlave
 Slave Address writing to. More...
 
u32 Options
 Current operating options. More...
 
u8 * SendBufferPtr
 Buffer to send (state) More...
 
u8 * RecvBufferPtr
 Buffer to receive (state) More...
 
u8 TxAddrMode
 State of Tx Address transmission. More...
 
int SendByteCount
 Number of data bytes in buffer (state) More...
 
int RecvByteCount
 Number of empty bytes in buffer (state) More...
 
u32 BNBOnly
 TRUE when BNB interrupt needs to. More...
 
u8 GpOutWidth
 General purpose output width. More...
 
XIic_StatusHandler StatusHandler
 Status Handler. More...
 
void * StatusCallBackRef
 Callback reference for status handler. More...
 
XIic_Handler RecvHandler
 Receive Handler. More...
 
void * RecvCallBackRef
 Callback reference for Recv handler. More...
 
XIic_Handler SendHandler
 Send Handler. More...
 
void * SendCallBackRef
 Callback reference for send handler. More...
 
int IsDynamic
 TRUE when Dynamic control is used. More...
 
int IsSlaveSetAckOff
 TRUE when Slave has set the ACK Off. More...
 

Detailed Description

The XIic driver instance data.

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

Field Documentation

◆ AddrOfSlave

int XIic::AddrOfSlave

Slave Address writing to.

Referenced by XIic_DynMasterRecv(), XIic_GetAddress(), XIic_MasterRecv(), and XIic_SetAddress().

◆ BaseAddress

◆ BNBOnly

u32 XIic::BNBOnly

TRUE when BNB interrupt needs to.

call callback

◆ GpOutWidth

u8 XIic::GpOutWidth

General purpose output width.

Referenced by XIic_GetGpOutput(), and XIic_SetGpOutput().

◆ Has10BitAddr

int XIic::Has10BitAddr

TRUE when 10 bit addressing in design.

Referenced by XIic_GetAddress(), and XIic_SetAddress().

◆ IsDynamic

int XIic::IsDynamic

TRUE when Dynamic control is used.

◆ IsReady

◆ IsSlaveSetAckOff

int XIic::IsSlaveSetAckOff

TRUE when Slave has set the ACK Off.

◆ IsStarted

int XIic::IsStarted

Device has been started.

Referenced by XIic_CfgInitialize(), and XIic_Stop().

◆ Options

u32 XIic::Options

Current operating options.

Referenced by XIic_GetOptions(), and XIic_SetOptions().

◆ RecvBufferPtr

u8* XIic::RecvBufferPtr

Buffer to receive (state)

Referenced by XIic_SlaveRecv(), and XIic_SlaveSend().

◆ RecvByteCount

int XIic::RecvByteCount

Number of empty bytes in buffer (state)

Referenced by XIic_SlaveRecv().

◆ RecvCallBackRef

void* XIic::RecvCallBackRef

Callback reference for Recv handler.

Referenced by XIic_SetRecvHandler().

◆ RecvHandler

XIic_Handler XIic::RecvHandler

Receive Handler.

Referenced by XIic_CfgInitialize(), and XIic_SetRecvHandler().

◆ SendBufferPtr

u8* XIic::SendBufferPtr

Buffer to send (state)

Referenced by XIic_SlaveRecv(), and XIic_SlaveSend().

◆ SendByteCount

int XIic::SendByteCount

Number of data bytes in buffer (state)

Referenced by XIic_SlaveSend().

◆ SendCallBackRef

void* XIic::SendCallBackRef

Callback reference for send handler.

Referenced by XIic_SetSendHandler().

◆ SendHandler

XIic_Handler XIic::SendHandler

Send Handler.

Referenced by XIic_SetSendHandler().

◆ Stats

XIicStats XIic::Stats

Statistics.

Referenced by XIic_ClearStats(), XIic_GetStats(), and XIic_InterruptHandler().

◆ StatusCallBackRef

void* XIic::StatusCallBackRef

Callback reference for status handler.

Referenced by XIic_SetStatusHandler().

◆ StatusHandler

XIic_StatusHandler XIic::StatusHandler

Status Handler.

Referenced by XIic_SetStatusHandler().

◆ TxAddrMode

u8 XIic::TxAddrMode

State of Tx Address transmission.