sdiaud
Xilinx SDK Drivers API Documentation
Sdiaud_v1_0

Functions

void XSdiAud_IntrHandler (void *InstancePtr)
 This function is the interrupt handler for the XSdiaud driver. More...
 
int XSdiAud_SetHandler (XSdiAud *InstancePtr, XSdiAud_HandlerType HandlerType, XSdiAud_Callback FuncPtr, void *CallbackRef)
 This function installs an asynchronous callback function for the given HandlerType. More...
 
XSdiAud_ConfigXSdiAud_LookupConfig (u16 DeviceId)
 This function returns a reference to an XSdiAud_Config structure based on the core id, DeviceId. More...
 
int XSdiAud_Initialize (XSdiAud *InstancePtr, u16 DeviceId)
 Initializes a specific XsdiAud instance such that the driver is ready to use. More...
 

Function Documentation

◆ XSdiAud_Initialize()

int XSdiAud_Initialize ( XSdiAud InstancePtr,
u16  DeviceId 
)

#include <xsdiaud_sinit.c>

Initializes a specific XsdiAud instance such that the driver is ready to use.

Parameters
InstancePtris a pointer to the XSdiAud instance to be worked on.
DeviceIdis the unique id of the device controlled by this XSdiAud instance. Passing in a device id associates the generic XSdiAud instance to a specific device, as chosen by the caller or application developer.
Returns
  • XST_SUCCESS if successful.
  • XST_DEVICE_NOT_FOUND if the device was not found in the configuration such that initialization could not be accomplished.
  • XST_FAILURE if version mismatched

References XSdiAud_Config::BaseAddress, XSdiAud_CfgInitialize(), and XSdiAud_LookupConfig().

Referenced by SdiAud_SelfTestExample().

◆ XSdiAud_IntrHandler()

void XSdiAud_IntrHandler ( void *  InstancePtr)

#include <xsdiaud_intr.c>

This function is the interrupt handler for the XSdiaud driver.

This handler reads the pending interrupt from the XSdiaud peripheral, determines the source of the interrupts, clears the interrupts and calls call backs accordingly.

Parameters
InstancePtris a pointer to the XSdiaud instance.
Returns
None.
Note
None.

References XSdiAud::IsReady.

◆ XSdiAud_LookupConfig()

XSdiAud_Config* XSdiAud_LookupConfig ( u16  DeviceId)

#include <xsdiaud_sinit.c>

This function returns a reference to an XSdiAud_Config structure based on the core id, DeviceId.

The return value will refer to an entry in the device configuration table defined in the xsdiaud_g.c file.

Parameters
DeviceIdis the unique core ID of the XSdiAud core for the lookup operation.
Returns
returns a reference to a config record in the configuration table corresponding to DeviceId, or NULL if no match is found.
Note
None.

Referenced by XSdiAud_Initialize().

◆ XSdiAud_SetHandler()

int XSdiAud_SetHandler ( XSdiAud InstancePtr,
XSdiAud_HandlerType  HandlerType,
XSdiAud_Callback  FuncPtr,
void *  CallbackRef 
)

#include <xsdiaud_intr.c>

This function installs an asynchronous callback function for the given HandlerType.

HandlerType                               Callback Function
------------------------------------      ----------------------------------
(XSDIAUD_HANDLER_AUD_GRP_CHNG_DET)        GrpChangeDetHandler
(XSDIAUD_HANDLER_CNTRL_PKT_CHNG_DET)      CntrlPktDetHandler
(XSDIAUD_HANDLER_CHSTAT_CHNG_DET)         StatChangeDetHandler
(XSDIAUD_HANDLER_FIFO_OVRFLW_DET)         FifoOvrflwDetHandler
(XSDIAUD_HANDLER_PARITY_ERR_DET)          ParityErrDetHandler
(XSDIAUD_HANDLER_CHECKSUM_ERR_DET)        ChecksumErrDetHandler
Parameters
InstancePtris a pointer to the XSdiAud core instance.
HandlerTypespecifies the type of handler.
FuncPtris a pointer to the callback function.
CallbackRefis a reference pointer passed on actual calling of the callback function.
Returns
  • XST_SUCCESS if callback function installed successfully.
  • XST_INVALID_PARAM when HandlerType is invalid.
Note
Invoking this function for a handler that already has been installed replaces it with the new handler.