| spdif Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Data Structures | Typedefs | Functions
xspdif.h File Reference

## Data Structures
struct | XSpdif_Config
| This typedef contains configuration information for the XSpdif. More...
struct | XSpdif
| The XSpdif driver instance data. More...

## Typedefs
typedef void(* | XSpdif_Callback )(void *CallbackRef)
| Callback function data type for handling interrupt requests from the XSpdif peripheral. More...

## Enumerations
Handler Types
enum | XSpdif_HandlerType { XSPDIF_HANDLER_TX_OR_RX_FIFO_FULL = 0, XSPDIF_HANDLER_TX_OR_RX_FIFO_EMPTY, XSPDIF_HANDLER_START_OF_BLOCK, XSPDIF_HANDLER_BMC_ERROR, XSPDIF_HANDLER_PREAMBLE_ERROR, XSPDIF_NUM_HANDLERS }
| These constants specify different types of handlers and is used to differentiate interrupt requests from the XSpdif peripheral. More...

## Functions
XSpdif_Config * | XSpdif_LookupConfig (u16 DeviceId)
| This function returns a reference to an XSpdif_Config structure based on the core id, DeviceId. More...
int | XSpdif_Initialize (XSpdif *InstancePtr, u16 DeviceId)
| Initializes a specific Xspdif instance such that the driver is ready to use. More...
int | XSpdif_CfgInitialize (XSpdif *InstancePtr, XSpdif_Config *CfgPtr, UINTPTR EffectiveAddr)
| This function initializes the XSpdif. More...
void | XSpdif_Enable (XSpdif *InstancePtr, u8 Enable)
| This function enables/disables the XSpdif. More...
void | XSpdif_SetClkConfig (XSpdif *InstancePtr, u8 Clk_DivNum)
| This function sets the clock configuration bits. More...
u32 | XSpdif_GetFs (XSpdif *InstancePtr, u32 AudClk)
| This function calculates the Sampling Frequency (Fs) and returns it's value. More...
void | XSpdif_SoftReset (XSpdif *InstancePtr)
| This function is used to soft reset the interrupt registers. More...
void | XSpdif_ResetFifo (XSpdif *InstancePtr)
| This function resets the Fifo. More...
void | XSpdif_IntrHandler (void *InstancePtr)
| This function is the interrupt handler for the XSpdif driver. More...
int | XSpdif_SetHandler (XSpdif *InstancePtr, XSpdif_HandlerType HandlerType, XSpdif_Callback FuncPtr, void *CallbackRef)
| This function installs an asynchronous callback function for the given HandlerType: More...
void | XSpdif_Rx_GetChStat (XSpdif *InstancePtr, u8 *ChStatBuf)
| This function reads all the Channel Status registers and writes to a buffer. More...
void | XSpdif_Rx_GetChA_UserData (XSpdif *InstancePtr, u8 *ChA_UserDataBuf)
| This function reads the Channel A user data and writes to a buffer. More...
void | XSpdif_Rx_GetChB_UserData (XSpdif *InstancePtr, u8 *ChB_UserDataBuf)
| This function reads the Channel B user data and writes to a buffer. More...