audio_formatter
Xilinx SDK Drivers API Documentation
xaudioformatter.h File Reference

Overview

Initialization & Configuration

The device driver enables higher layer software (e.g., an application) to communicate to the Audio Formatter core.

XAudioFormatter_CfgInitialize() API is used to initialize the Audio Formatter core. The user needs to first call the XAudioFormatter_LookupConfig() API which returns the Configuration structure pointer which is passed as a parameter to the XAudioFormatter_CfgInitialize() API.

Interrupts The driver does the interrupt handling, and dispatch to the user application through callback functions that user has registered.

Virtual Memory

This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.

Threads

This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.

Asserts

Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.

Data Structures

struct  XAudioFormatter_Config
 This typedef contains configuration information for a audio formatter core. More...
 
struct  XAudioFormatter
 The audio formatter driver instance data structure. More...
 
struct  XAudioFormatterHwParams
 This typedef contains hw params information for a audio formatter core. More...
 

Macros

#define XAUDFMT_H_
 Prevent circular inclusions by using protection macros. More...
 

Functions

XAudioFormatter_ConfigXAudioFormatter_LookupConfig (u16 DeviceId)
 XAudioFormatter_LookupConfig returns a reference to an XAudioFormatter_Config structure based on the unique device id, DeviceId. More...
 
u32 XAudioFormatter_CfgInitialize (XAudioFormatter *InstancePtr, XAudioFormatter_Config *CfgPtr)
 This function initializes the audio formatter core instance. More...
 
void XAudioFormatter_InterruptEnable (XAudioFormatter *InstancePtr, u32 Mask)
 This function enables the interrupts for audio formatter core. More...
 
void XAudioFormatter_InterruptDisable (XAudioFormatter *InstancePtr, u32 Mask)
 This function disables the interrupts for audio formatter core. More...
 
void XAudioFormatterDMAStart (XAudioFormatter *InstancePtr)
 This function starts the dma for audio formatter core. More...
 
void XAudioFormatterDMAStop (XAudioFormatter *InstancePtr)
 This function stops the dma for audio formatter core. More...
 
void XAudioFormatterSetHwParams (XAudioFormatter *InstancePtr, XAudioFormatterHwParams *hw_params)
 This function sets the hw params for audio formatter core. More...
 
void XAudioFormatter_InterruptClear (XAudioFormatter *InstancePtr, u32 mask)
 This function clears the interrupts for audio formatter core. More...
 
void XAudioFormatterDMAReset (XAudioFormatter *InstancePtr)
 This function soft resets the audio formatter DMA core. More...
 
void XAudioFormatterSetFsMultiplier (XAudioFormatter *InstancePtr, u32 Mclk, u32 Fs)
 This function calculates the Fs multiplier value. More...
 
u32 XAudioFormatterGetDMATransferCount (XAudioFormatter *InstancePtr)
 This function returns the No. More...
 
void XSdiAud_GetChStat (XAudioFormatter *InstancePtr, u8 *ChStatBuf)
 This function reads all the Channel Status registers and writes to a buffer. More...
 
void XAudioFormatterSetS2MMTimeOut (XAudioFormatter *InstancePtr, u32 TimeOut)
 This function sets the S2MM timeout. More...