AM275 FreeRTOS SDK  11.01.00

Introduction

This is AASRC Channel Types

Files

file  aasrc_types.h
 AASRC Driver API/interface data types file.
 

Typedefs

typedef void * AASRC_Handle
 A handle that is returned from a AASRC_open() call. More...
 
typedef void * AASRC_ClkZoneHandle
 AASRC clock zone handle whic points to clk_zone structure. More...
 
typedef void * AASRC_ChHandle
 AASRC channel handle which points to AASRC channnel status and configs. More...
 
typedef void * AASRC_DmaHandle
 AASRC udma handle which points to udma instance. More...
 

AASRC Error Codes

Error codes returned by AASRC APIs

#define AASRC_SOK   ( (int32_t) (0))
 API call successful. More...
 
#define AASRC_EFAIL   (-(int32_t) (1))
 API call returned with error as failed. Used for generic error. It may be some hardware failure and/or software failure. More...
 
#define AASRC_EBADARGS   (-(int32_t) (2))
 API call returned with error as bad arguments. Typically, NULL pointer passed to the API where its not expected. More...
 
#define AASRC_EINVALID_PARAMS   (-(int32_t) (3))
 API call returned with error as invalid parameters. Typically when parameters passed are not valid or out of range. More...
 
#define AASRC_ETIMEOUT   (-(int32_t) (4))
 API call returned with error as timed out. Typically API is waiting for some condition and returned as condition not happened in the timeout period. More...
 
#define AASRC_EALLOC   (-(int32_t) (5))
 API call returned with error as allocation failed. More...
 

AASRC Channel Types

This represents the different types of channels that can be requested from AASRC IP. MONO - single audio channel STEREO - two synchronous audio channels GROUP - three or more synchronous audio channels

#define AASRC_MONO   (0U)
 
#define AASRC_STEREO   (1U)
 
#define AASRC_GROUP   (2U)
 

Macro Definition Documentation

◆ AASRC_SOK

#define AASRC_SOK   ( (int32_t) (0))

API call successful.

◆ AASRC_EFAIL

#define AASRC_EFAIL   (-(int32_t) (1))

API call returned with error as failed. Used for generic error. It may be some hardware failure and/or software failure.

◆ AASRC_EBADARGS

#define AASRC_EBADARGS   (-(int32_t) (2))

API call returned with error as bad arguments. Typically, NULL pointer passed to the API where its not expected.

◆ AASRC_EINVALID_PARAMS

#define AASRC_EINVALID_PARAMS   (-(int32_t) (3))

API call returned with error as invalid parameters. Typically when parameters passed are not valid or out of range.

◆ AASRC_ETIMEOUT

#define AASRC_ETIMEOUT   (-(int32_t) (4))

API call returned with error as timed out. Typically API is waiting for some condition and returned as condition not happened in the timeout period.

◆ AASRC_EALLOC

#define AASRC_EALLOC   (-(int32_t) (5))

API call returned with error as allocation failed.

◆ AASRC_MONO

#define AASRC_MONO   (0U)

◆ AASRC_STEREO

#define AASRC_STEREO   (1U)

◆ AASRC_GROUP

#define AASRC_GROUP   (2U)

Typedef Documentation

◆ AASRC_Handle

typedef void* AASRC_Handle

A handle that is returned from a AASRC_open() call.

◆ AASRC_ClkZoneHandle

typedef void* AASRC_ClkZoneHandle

AASRC clock zone handle whic points to clk_zone structure.

◆ AASRC_ChHandle

typedef void* AASRC_ChHandle

AASRC channel handle which points to AASRC channnel status and configs.

◆ AASRC_DmaHandle

typedef void* AASRC_DmaHandle

AASRC udma handle which points to udma instance.