audio_formatter
Xilinx SDK Drivers API Documentation
Audio_formatter_v1_0

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

void XAudioFormatterDMAReset (XAudioFormatter *InstancePtr)
 This function soft resets the audio formatter DMA core. More...
 
u32 XAudioFormatter_CfgInitialize (XAudioFormatter *InstancePtr, XAudioFormatter_Config *CfgPtr)
 This function initializes the audio formatter core instance. More...
 
void XAudioFormatter_InterruptClear (XAudioFormatter *InstancePtr, u32 mask)
 This function clears the interrupts for audio formatter core. 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...
 
u32 XAudioFormatterGetDMATransferCount (XAudioFormatter *InstancePtr)
 This function returns the No. More...
 
void XAudioFormatterSetS2MMTimeOut (XAudioFormatter *InstancePtr, u32 TimeOut)
 This function sets the S2MM timeout. More...
 
void XAudioFormatterSetFsMultiplier (XAudioFormatter *InstancePtr, u32 Mclk, u32 Fs)
 This function calculates the Fs multiplier value. More...
 
void XSdiAud_GetChStat (XAudioFormatter *InstancePtr, u8 *ChStatBuf)
 This function reads all the Channel Status registers and writes to a buffer. More...
 
XAudioFormatter_ConfigXAudioFormatter_LookupConfig (u16 DeviceId)
 XAudioFormatter_LookupConfig returns a reference to an XAudioFormatter_Config structure based on the unique device id, DeviceId. More...
 

Macro Definition Documentation

◆ XAUDFMT_H_

#define XAUDFMT_H_

#include <xaudioformatter.h>

Prevent circular inclusions by using protection macros.

Function Documentation

◆ XAudioFormatter_CfgInitialize()

u32 XAudioFormatter_CfgInitialize ( XAudioFormatter InstancePtr,
XAudioFormatter_Config CfgPtr 
)

#include <xaudioformatter.c>

This function initializes the audio formatter core instance.

Parameters
InstancePtris a pointer to the XAudioFormatter instance.
CfgPtris a reference to a structure containing information about a specific XAudioFormatter instance.
Returns
  • XST_SUCCESS if initialization was successful.
Note
None.

References XAudioFormatter::Config.

◆ XAudioFormatter_InterruptClear()

void XAudioFormatter_InterruptClear ( XAudioFormatter InstancePtr,
u32  mask 
)

#include <xaudioformatter.c>

This function clears the interrupts for audio formatter core.

Parameters
InstancePtris a pointer to the XAudioFormatter instance.
offsetthis is the offset to S2MM or MM2S.
Returns
None.
Note
None.

References XAudioFormatter::IsReady.

◆ XAudioFormatter_InterruptDisable()

void XAudioFormatter_InterruptDisable ( XAudioFormatter InstancePtr,
u32  Mask 
)

#include <xaudioformatter.c>

This function disables the interrupts for audio formatter core.

Parameters
InstancePtris a pointer to the XAudioFormatter instance.
Maskis the interrupt mask.
Returns
None.
Note
None.

References XAudioFormatter::IsReady.

◆ XAudioFormatter_InterruptEnable()

void XAudioFormatter_InterruptEnable ( XAudioFormatter InstancePtr,
u32  Mask 
)

#include <xaudioformatter.c>

This function enables the interrupts for audio formatter core.

Parameters
InstancePtris a pointer to the XAudioFormatter instance.
Maskis the interrupt mask.
Returns
None.
Note
None.

References XAudioFormatter::IsReady.

◆ XAudioFormatter_LookupConfig()

XAudioFormatter_Config * XAudioFormatter_LookupConfig ( u16  DeviceId)

#include <xaudioformatter.h>

XAudioFormatter_LookupConfig returns a reference to an XAudioFormatter_Config structure based on the unique device id, DeviceId.

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

Parameters
DeviceIdis the unique device ID of the device for the lookup operation.
Returns
CfgPtr is a reference to a config record in the configuration table (in xaudioformatter_g.c) corresponding to DeviceId, or NULL if no match is found.
Note
None.

◆ XAudioFormatterDMAReset()

void XAudioFormatterDMAReset ( XAudioFormatter InstancePtr)

#include <xaudioformatter.c>

This function soft resets the audio formatter DMA core.

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

◆ XAudioFormatterDMAStart()

void XAudioFormatterDMAStart ( XAudioFormatter InstancePtr)

#include <xaudioformatter.c>

This function starts the dma for audio formatter core.

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

References XAudioFormatter::IsReady.

◆ XAudioFormatterDMAStop()

void XAudioFormatterDMAStop ( XAudioFormatter InstancePtr)

#include <xaudioformatter.c>

This function stops the dma for audio formatter core.

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

References XAudioFormatter::IsReady.

◆ XAudioFormatterGetDMATransferCount()

u32 XAudioFormatterGetDMATransferCount ( XAudioFormatter InstancePtr)

#include <xaudioformatter.c>

This function returns the No.

of bytes of data read from memory..

Parameters
InstancePtris a pointer to the Audio Formatter instance.
Returns
- No. of bytes of data read from memory.

References XAudioFormatter::IsReady.

◆ XAudioFormatterSetFsMultiplier()

void XAudioFormatterSetFsMultiplier ( XAudioFormatter InstancePtr,
u32  Mclk,
u32  Fs 
)

#include <xaudioformatter.c>

This function calculates the Fs multiplier value.

Parameters
InstancePtris a pointer to the Audio Formatter instance.
MClkis the frequency of the MClk.
Fsis the sampling frequency of the system.
Returns
- None

References XAudioFormatter::IsReady.

◆ XAudioFormatterSetHwParams()

void XAudioFormatterSetHwParams ( XAudioFormatter InstancePtr,
XAudioFormatterHwParams hw_params 
)

#include <xaudioformatter.c>

This function sets the hw params for audio formatter core.

Parameters
InstancePtris a pointer to the XAudioFormatter instance.
hw_paramsis a pointer to the XAudioFormatterHwParams structure which contains the no. of channels, bit width, no. of periods, bytes per period, bytes per channel and buffer address.
Returns
None.
Note
None.

References XAudioFormatter::IsReady.

◆ XAudioFormatterSetS2MMTimeOut()

void XAudioFormatterSetS2MMTimeOut ( XAudioFormatter InstancePtr,
u32  TimeOut 
)

#include <xaudioformatter.c>

This function sets the S2MM timeout.

Parameters
InstancePtris a pointer to the Audio Formatter instance.
TimeOutis the Timeout value after which all the data is flushed to memory if there is no incoming data from any channel.
Returns
- None

References XAudioFormatter::IsReady.

◆ XSdiAud_GetChStat()

void XSdiAud_GetChStat ( XAudioFormatter InstancePtr,
u8 *  ChStatBuf 
)

#include <xaudioformatter.c>

This function reads all the Channel Status registers and writes to a buffer.

Parameters
InstancePtris a pointer to the Audio Formatter instance.
ChStatBufis a pointer to a buffer.
Returns
None.