This is AASRC data transfer related APIs, parameters and local functions
Files | |
| file | aasrc_transactions.h |
| AASRC transactions, transfer objects and parameters. | |
Data Structures | |
| struct | AASRC_Transaction |
| Data structure used with transfer call. More... | |
| struct | AASRC_TransferObj |
| AASRC Transfer Data structure stored in Channel object. 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... | |
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... | |
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... | |
| #define AASRC_TRANSFER_STATUS_QUEUED (0U) |
I/O buffer queued and pending.
| #define AASRC_TRANSFER_STATUS_LOADED (1U) |
I/O buffer fetched from queue, waiting for interrupt to fire.
| #define AASRC_TRANSFER_STATUS_STARTED (2U) |
I/O started processing.
| #define AASRC_TRANSFER_STATUS_COMPLETED (3U) |
I/O completed successfully.
| #define AASRC_TRANSFER_STATUS_CANCELLED (4U) |
I/O cancelled. Returned by incomplete read or write requests.
| #define AASRC_TRANSFER_STATUS_FAILED (5U) |
Generic failure condition.
| #define AASRC_TRANSFER_STATUS_ERROR (6U) |
ASRC channel has gone into an error.
| #define AASRC_TRANSFER_STATUS_TIMEOUT (7U) |
I/O timeout occurred.
| #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.
| #define AASRC_TRANSFER_MODE_DMA (1U) |
AASRC read/write APIs does not block code execution and will use DMA for transfers.
| #define AASRC_MAX_TXN_WORD_COUNT (1024U*1024U*512U) |
| #define AASRC_WORD_SIZE_IN_BYTES (4U) |
| #define AASRC_WORD_SIZE_IN_BITS (32U) |
| 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.
| chHandle | channel handle to identify AASRC channel (returned from AASRC_chOpen()) |
| transaction* | Pointer to a AASRC_Transaction |
| 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.
| chHandle | channel handle to identify AASRC channel (returned from AASRC_chOpen()) |
| transactionRx* | Pointer to a receive AASRC_Transaction |
| transactionTx* | Pointer to a transmit AASRC_Transaction |
| int32_t AASRC_queueTransactionRx | ( | AASRC_ChHandle | chHandle, |
| AASRC_Transaction * | transaction | ||
| ) |
Function submit transactions to AASRC input queue.
submits transactions to AASRC input queue to be written to AASRC input fifo
| chHandle | [IN] channel handle to identify AASRC channel (returned from AASRC_chOpen()) |
| transaction* | [IN] Pointer to AASRC transaction to be queued in AASRC input |
| int32_t AASRC_queueTransactionTx | ( | AASRC_ChHandle | chHandle, |
| AASRC_Transaction * | transaction | ||
| ) |
Function submit transactions to AASRC output queue.
submits transactions to AASRC output queue to receive data from AASRC output fifo
| chHandle | [IN] channel handle to identify AASRC channel (returned from AASRC_chOpen()) |
| transaction* | [IN] Pointer to AASRC transaction to be queued for AASRC output |