APIs for AASRC

Introduction

This module contains APIs to program and use the AASRC module. The APIs can be used by other drivers to get access to AASRC hardware module and also by applications to convert sample rates of audio streams.

Sub Modules
	AASRC Channel Configuration APIs
	AASRC Channel Types
	AASRC Clock Zone Configuration
	AASRC DMA
	AASRC Soc Specific Parameters
	AASRC Transactions

Files
file	aasrc/v0/aasrc.h
	AASRC Driver API/interface file.

Data Structures
struct	AASRC_OpenParams
	AASRC Parameters. More...
struct	AASRC_Attrs
	AASRC hardware instance attributes - used during init time. More...
struct	AASRC_Object
	AASRC driver object. More...
struct	AASRC_Config
	AASRC global configuration array. More...

Functions
void	AASRC_init (void)
	This function initializes the AASRC module. More...
void	AASRC_deinit (void)
	This function de-initializes the AASRC module. More...
static void	AASRC_OpenParamsInit (AASRC_Object *drvObj)
	Function to initialize the AASRC_OpenParams struct to its defaults. More...
AASRC_Handle	AASRC_open (uint8_t instNum, const AASRC_OpenParams *openParams)
	This function opens a given AASRC IP Core. More...
void	AASRC_close (AASRC_Handle drvHandle)
	Function to close a AASRC IP Core specified by the AASRC handle. More...
AASRC_Handle	AASRC_getHandle (uint32_t index)
	This function returns the handle of an open AASRC Instance from the instance index. More...
void	AASRC_softReset (AASRC_Handle drvHandle)
	Function to soft reset a AASRC IP Core specified by the AASRC handle. More...

Function Documentation

AASRC_init()

void AASRC_init

(

void

)

This function initializes the AASRC module.

AASRC_deinit()

void AASRC_deinit

(

void

)

This function de-initializes the AASRC module.

AASRC_OpenParamsInit()

static void AASRC_OpenParamsInit ( AASRC_Object *  drvObj )

inlinestatic

Function to initialize the AASRC_OpenParams struct to its defaults.

Parameters

drvObj

Pointer to AASRC_Object structure for initialization of OpenParams with default

AASRC_open()

AASRC_Handle AASRC_open	(	uint8_t	instNum,
		const AASRC_OpenParams *	openParams
	)

This function opens a given AASRC IP Core.

Precondition

AASRC driver parameters have to be initialized using AASRC_init()

Parameters

instNum	Index of config to use in the AASRC_Config array
openParams	Pointer to parameters to open the driver with

Returns

A AASRC_Handle on success or a NULL on an error or if it has been opened already

See also

AASRC_init()

AASRC_close()

AASRC_close()

void AASRC_close

(

AASRC_Handle

drvHandle

)

Function to close a AASRC IP Core specified by the AASRC handle.

Precondition

AASRC_open() has to be called first

Parameters

drvHandle

AASRC_Handle returned from AASRC_open()

See also

AASRC_open()

AASRC_getHandle()

AASRC_Handle AASRC_getHandle

(

uint32_t

index

)

This function returns the handle of an open AASRC Instance from the instance index.

Precondition

AASRC controller has been opened using AASRC_open()

Parameters

index

Index of config to use in the AASRC_Config array

Returns

A AASRC_Handle if it has been opened already or NULL otherwise

See also

AASRC_init()

AASRC_open()

AASRC_softReset()

void AASRC_softReset

(

AASRC_Handle

drvHandle

)

Function to soft reset a AASRC IP Core specified by the AASRC handle.

Precondition

AASRC_open() has to be called first

Parameters

drvHandle

AASRC_Handle returned from AASRC_open()

See also

AASRC_open()

Variable Documentation

gAasrcConfig

AASRC_Config gAasrcConfig[]

extern

Externally defined driver configuration array.

gAasrcInstNum

uint8_t gAasrcInstNum

extern

Externally defined driver configuration array size.

gAasrcConfigChNum

uint8_t gAasrcConfigChNum[]

extern

Externally defined channel configuration array size

gAasrcRxClkZoneNum

uint8_t gAasrcRxClkZoneNum[]

extern

Externally defined Rx Clockzone configuration array size

gAasrcTxClkZoneNum

uint8_t gAasrcTxClkZoneNum[]

extern

Externally defined Tx Clockzone configuration array size