![]() |
i2srx
Xilinx SDK Drivers API Documentation
|
Data Structures | |
struct | XI2srx_Config |
This typedef contains configuration information for the XI2s Receiver. More... | |
struct | XI2s_Rx |
The XI2s Receiver driver instance data. More... | |
Typedefs | |
typedef void(* | XI2s_Rx_Callback) (void *CallbackRef) |
Callback function data type for handling interrupt requests from the XI2s Receiver peripheral. More... | |
Enumerations | |
enum | XI2s_Rx_ChMuxInput { XI2S_RX_CHMUX_DISABLED = 0, XI2S_RX_CHMUX_XI2S_01, XI2S_RX_CHMUX_XI2S_23, XI2S_RX_CHMUX_XI2S_45, XI2S_RX_CHMUX_XI2S_67, XI2S_RX_CHMUX_WAVEGEN } |
This typedef specifies the input sources of the the XI2s Receiver. More... | |
enum | XI2s_Rx_Justification { XI2S_RX_JUSTIFY_LEFT = 0, XI2S_RX_JUSTIFY_RIGHT } |
This typedef specifies the justification of the the XI2s Receiver. More... | |
Handler Types | |
enum | XI2s_Rx_HandlerType { XI2S_RX_HANDLER_AES_BLKCMPLT = 0, XI2S_RX_HANDLER_AUD_OVRFLW, XI2S_RX_NUM_HANDLERS } |
These constants specify different types of handlers and is used to differentiate interrupt requests from the XI2s Receiver peripheral. More... | |
enum | XI2s_Rx_ChannelId { XI2S_RX_CHID0 = 0, XI2S_RX_CHID1, XI2S_RX_CHID2, XI2S_RX_CHID3, XI2S_RX_NUM_CHANNELS } |
These constants specify different channel ID's. More... | |
Functions | |
int | XI2s_Rx_SelfTest (XI2s_Rx *InstancePtr) |
Runs a self-test on the driver/device. More... | |
XI2srx_Config * | XI2s_Rx_LookupConfig (u16 DeviceId) |
This function returns a reference to an XI2srx_Config structure based on the core id, DeviceId. More... | |
int | XI2s_Rx_Initialize (XI2s_Rx *InstancePtr, u16 DeviceId) |
Initializes a specific XI2s_Rx instance such that the driver is ready to use. More... | |
int | XI2s_Rx_CfgInitialize (XI2s_Rx *InstancePtr, XI2srx_Config *CfgPtr, UINTPTR EffectiveAddr) |
This function initializes the XI2s Receiver. More... | |
void | XI2s_Rx_Enable (XI2s_Rx *InstancePtr, u8 Enable) |
This function enables/disables the XI2s Receiver. More... | |
void | XI2s_Rx_LatchAesChannelStatus (XI2s_Rx *InstancePtr) |
This function requests the XI2s Receiver to latch the AES Channel Status bits from the registers. More... | |
int | XI2s_Rx_SetChMux (XI2s_Rx *InstancePtr, XI2s_Rx_ChannelId ChID, XI2s_Rx_ChMuxInput InputSource) |
This function sets the input source for the specified AXI-Stream channel pair. More... | |
u32 | XI2s_Rx_SetSclkOutDiv (XI2s_Rx *InstancePtr, u32 MClk, u32 Fs) |
This function calculates the SCLK Output divider value of the I2s timing generator. More... | |
void | XI2s_Rx_IntrEnable (XI2s_Rx *InstancePtr, u32 Mask) |
This function enables the specified interrupt of the XI2s Receiver. More... | |
void | XI2s_Rx_IntrDisable (XI2s_Rx *InstancePtr, u32 Mask) |
This function disables the specified interrupt of the XI2s Receiver. More... | |
void | XI2s_Rx_JustifyEnable (XI2s_Rx *InstancePtr, u8 Enable) |
This function enables/disables the justification. More... | |
void | XI2s_Rx_Justify (XI2s_Rx *InstancePtr, XI2s_Rx_Justification Justify) |
This function is to enable right/left justification. More... | |
void | XI2s_Rx_IntrHandler (void *InstancePtr) |
This function is the interrupt handler for the XI2s Receiver driver. More... | |
int | XI2s_Rx_SetHandler (XI2s_Rx *InstancePtr, XI2s_Rx_HandlerType HandlerType, XI2s_Rx_Callback FuncPtr, void *CallbackRef) |
This function installs an asynchronous callback function for the given HandlerType: More... | |
void | XI2s_Rx_LogDisplay (XI2s_Rx *InstancePtr) |
This function prints the contents of the logging buffer. More... | |
void | XI2s_Rx_LogReset (XI2s_Rx *InstancePtr) |
This function clears the contents of the logging buffer. More... | |
void | XI2s_Rx_LogWrite (XI2s_Rx *InstancePtr, XI2s_Rx_LogEvt Event, u8 Data) |
This function writes XI2s Receiver logs into the buffer. More... | |
XI2s_Rx_LogItem * | XI2s_Rx_LogRead (XI2s_Rx *InstancePtr) |
This function returns the next item in the logging buffer. More... | |
void | XI2s_Rx_SetAesChStatus (XI2s_Rx *InstancePtr, u8 *AesChStatusBuf) |
This function sets the AES Channel Status bits to insert. More... | |
void | XI2s_Rx_ClrAesChStatRegs (XI2s_Rx *InstancePtr) |
This function clears the captured AES Channel Status bits. More... | |