aasrc_transactions.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef AASRC_TRANSACTIONS_H_
#define AASRC_TRANSACTIONS_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define AASRC_TRANSFER_STATUS_QUEUED           (0U)
 
#define AASRC_TRANSFER_STATUS_LOADED           (1U)
 
#define AASRC_TRANSFER_STATUS_STARTED          (2U)
 
#define AASRC_TRANSFER_STATUS_COMPLETED        (3U)
 
#define AASRC_TRANSFER_STATUS_CANCELLED        (4U)
 
#define AASRC_TRANSFER_STATUS_FAILED           (5U)
 
#define AASRC_TRANSFER_STATUS_ERROR            (6U)
 
#define AASRC_TRANSFER_STATUS_TIMEOUT          (7U)
 
#define AASRC_TRANSFER_MODE_INTERRUPT           (0U)
 
#define AASRC_TRANSFER_MODE_DMA                 (1U)
 
/* Limits the maximum number of words for an AASRC_Transaction
   This equals 2GB of data for 32 bit samples. */
#define AASRC_MAX_TXN_WORD_COUNT                (1024U*1024U*512U)
 
/* AASRC driver will always use 32 bit words for data read/write for aglignment,
   but the sample size can be 16, 18, 20, 24 bits */
#define AASRC_WORD_SIZE_IN_BYTES                (4U)
#define AASRC_WORD_SIZE_IN_BITS                 (32U)
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    QueueP_Elem qElem;
    void *buf;
    uint32_t sampleCount;
    int32_t status;
    void *args;
} AASRC_Transaction;
 
 
typedef void (*AASRC_TxnCallbackFxn) (AASRC_ChHandle chHandle,
                                      AASRC_Transaction *transaction);
 
typedef void (*AASRC_ChErrorCallbackFxn) (AASRC_ChHandle chHandle,
                                          AASRC_Transaction *transactionRx,
                                          AASRC_Transaction *transactionTx);
typedef struct
{
    uint32_t xferTotSampleCount;
    uint32_t xferCurrSampleCount;
    AASRC_Transaction *transaction;
    AASRC_TxnCallbackFxn cbFxn;
    AASRC_Transaction txnLoopjob;
    bool loopjobEnable;
    /*< Flag to enable loopjob. when enabled loopjob buffer is transmitted if application fails to load buffers.*/
} AASRC_TransferObj;
 
/* ========================================================================== */
/*                      API Function Declarations                             */
/* ========================================================================== */
 
int32_t AASRC_queueTransactionRx(AASRC_ChHandle chHandle, AASRC_Transaction *transaction);
 
int32_t AASRC_queueTransactionTx(AASRC_ChHandle chHandle, AASRC_Transaction *transaction);
 
/* ========================================================================== */
/*                       Local Function Definitions                           */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef AASRC_TRANSACTIONS_H_ */