aasrc_transactions.h File Reference

Introduction

AASRC transactions, transfer objects and parameters.

Go to the source code of this file.

Data Structures
struct	AASRC_Transaction
	Data structure used with transfer call. More...
struct	AASRC_TransferObj
	AASRC Transfer Data structure stored in Channel object. More...

Macros
#define	AASRC_MAX_TXN_WORD_COUNT   (1024U*1024U*512U)
#define	AASRC_WORD_SIZE_IN_BYTES   (4U)
#define	AASRC_WORD_SIZE_IN_BITS   (32U)
Transfer Status Code
Status codes that are set by the AASRC driver
#define	AASRC_TRANSFER_STATUS_QUEUED   (0U)
	I/O buffer queued and pending. More...
#define	AASRC_TRANSFER_STATUS_LOADED   (1U)
	I/O buffer fetched from queue, waiting for interrupt to fire. More...
#define	AASRC_TRANSFER_STATUS_STARTED   (2U)
	I/O started processing. More...
#define	AASRC_TRANSFER_STATUS_COMPLETED   (3U)
	I/O completed successfully. More...
#define	AASRC_TRANSFER_STATUS_CANCELLED   (4U)
	I/O cancelled. Returned by incomplete read or write requests. More...
#define	AASRC_TRANSFER_STATUS_FAILED   (5U)
	Generic failure condition. More...
#define	AASRC_TRANSFER_STATUS_ERROR   (6U)
	ASRC channel has gone into an error. More...
#define	AASRC_TRANSFER_STATUS_TIMEOUT   (7U)
	I/O timeout occurred. More...
AASRC Transfer Mode
#define	AASRC_TRANSFER_MODE_INTERRUPT   (0U)
	AASRC read/write APIs does not block code execution and will call a AASRC_TxnCallbackFxn This mode can be used in a Task, Swi, or Hwi context. More...
#define	AASRC_TRANSFER_MODE_DMA   (1U)
	AASRC read/write APIs does not block code execution and will use DMA for transfers. More...

Typedefs
typedef void(*	AASRC_TxnCallbackFxn) (AASRC_ChHandle chHandle, AASRC_Transaction *transaction)
	The definition of a callback function used by the AASRC driver when used in Callback Mode. More...
typedef void(*	AASRC_ChErrorCallbackFxn) (AASRC_ChHandle chHandle, AASRC_Transaction *transactionRx, AASRC_Transaction *transactionTx)
	The definition of a channel error callback function used by the AASRC driver when used in Callback Mode. More...

Functions
int32_t	AASRC_queueTransactionRx (AASRC_ChHandle chHandle, AASRC_Transaction *transaction)
	Function submit transactions to AASRC input queue. More...
int32_t	AASRC_queueTransactionTx (AASRC_ChHandle chHandle, AASRC_Transaction *transaction)
	Function submit transactions to AASRC output queue. More...