269 lines
11 KiB
C
269 lines
11 KiB
C
/*
|
|
* The Clear BSD License
|
|
* Copyright (c) 2015, Freescale Semiconductor, Inc.
|
|
* Copyright 2016-2017 NXP
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted (subject to the limitations in the disclaimer below) provided
|
|
* that the following conditions are met:
|
|
*
|
|
* o Redistributions of source code must retain the above copyright notice, this list
|
|
* of conditions and the following disclaimer.
|
|
*
|
|
* o 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.
|
|
*
|
|
* o Neither the name of the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
|
|
* 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 HOLDER 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 _FSL_SAI_EDMA_H_
|
|
#define _FSL_SAI_EDMA_H_
|
|
|
|
#include "fsl_sai.h"
|
|
#include "fsl_edma.h"
|
|
|
|
/*!
|
|
* @addtogroup sai_edma
|
|
* @{
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
|
|
/*! @name Driver version */
|
|
/*@{*/
|
|
#define FSL_SAI_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 1, 4)) /*!< Version 2.1.4 */
|
|
/*@}*/
|
|
|
|
typedef struct _sai_edma_handle sai_edma_handle_t;
|
|
|
|
/*! @brief SAI eDMA transfer callback function for finish and error */
|
|
typedef void (*sai_edma_callback_t)(I2S_Type *base, sai_edma_handle_t *handle, status_t status, void *userData);
|
|
|
|
/*! @brief SAI DMA transfer handle, users should not touch the content of the handle.*/
|
|
struct _sai_edma_handle
|
|
{
|
|
edma_handle_t *dmaHandle; /*!< DMA handler for SAI send */
|
|
uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
|
|
uint8_t bytesPerFrame; /*!< Bytes in a frame */
|
|
uint8_t channel; /*!< Which data channel */
|
|
uint8_t count; /*!< The transfer data count in a DMA request */
|
|
uint32_t state; /*!< Internal state for SAI eDMA transfer */
|
|
sai_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
|
|
void *userData; /*!< User callback parameter */
|
|
uint8_t tcd[(SAI_XFER_QUEUE_SIZE + 1U) * sizeof(edma_tcd_t)]; /*!< TCD pool for eDMA transfer. */
|
|
sai_transfer_t saiQueue[SAI_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
|
|
size_t transferSize[SAI_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
|
|
volatile uint8_t queueUser; /*!< Index for user to queue transfer. */
|
|
volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
|
|
};
|
|
|
|
/*******************************************************************************
|
|
* APIs
|
|
******************************************************************************/
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*!
|
|
* @name eDMA Transactional
|
|
* @{
|
|
*/
|
|
|
|
/*!
|
|
* @brief Initializes the SAI eDMA handle.
|
|
*
|
|
* This function initializes the SAI master DMA handle, which can be used for other SAI master transactional APIs.
|
|
* Usually, for a specified SAI instance, call this API once to get the initialized handle.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param base SAI peripheral base address.
|
|
* @param callback Pointer to user callback function.
|
|
* @param userData User parameter passed to the callback function.
|
|
* @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
|
|
*/
|
|
void SAI_TransferTxCreateHandleEDMA(
|
|
I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
|
|
|
|
/*!
|
|
* @brief Initializes the SAI Rx eDMA handle.
|
|
*
|
|
* This function initializes the SAI slave DMA handle, which can be used for other SAI master transactional APIs.
|
|
* Usually, for a specified SAI instance, call this API once to get the initialized handle.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param base SAI peripheral base address.
|
|
* @param callback Pointer to user callback function.
|
|
* @param userData User parameter passed to the callback function.
|
|
* @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
|
|
*/
|
|
void SAI_TransferRxCreateHandleEDMA(
|
|
I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
|
|
|
|
/*!
|
|
* @brief Configures the SAI Tx audio format.
|
|
*
|
|
* The audio format can be changed at run-time. This function configures the sample rate and audio data
|
|
* format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param format Pointer to SAI audio data format structure.
|
|
* @param mclkSourceClockHz SAI master clock source frequency in Hz.
|
|
* @param bclkSourceClockHz SAI bit clock source frequency in Hz. If bit clock source is master
|
|
* clock, this value should equals to masterClockHz in format.
|
|
* @retval kStatus_Success Audio format set successfully.
|
|
* @retval kStatus_InvalidArgument The input argument is invalid.
|
|
*/
|
|
void SAI_TransferTxSetFormatEDMA(I2S_Type *base,
|
|
sai_edma_handle_t *handle,
|
|
sai_transfer_format_t *format,
|
|
uint32_t mclkSourceClockHz,
|
|
uint32_t bclkSourceClockHz);
|
|
|
|
/*!
|
|
* @brief Configures the SAI Rx audio format.
|
|
*
|
|
* The audio format can be changed at run-time. This function configures the sample rate and audio data
|
|
* format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param format Pointer to SAI audio data format structure.
|
|
* @param mclkSourceClockHz SAI master clock source frequency in Hz.
|
|
* @param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is the master
|
|
* clock, this value should equal to masterClockHz in format.
|
|
* @retval kStatus_Success Audio format set successfully.
|
|
* @retval kStatus_InvalidArgument The input argument is invalid.
|
|
*/
|
|
void SAI_TransferRxSetFormatEDMA(I2S_Type *base,
|
|
sai_edma_handle_t *handle,
|
|
sai_transfer_format_t *format,
|
|
uint32_t mclkSourceClockHz,
|
|
uint32_t bclkSourceClockHz);
|
|
|
|
/*!
|
|
* @brief Performs a non-blocking SAI transfer using DMA.
|
|
*
|
|
* @note This interface returns immediately after the transfer initiates. Call
|
|
* SAI_GetTransferStatus to poll the transfer status and check whether the SAI transfer is finished.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param xfer Pointer to the DMA transfer structure.
|
|
* @retval kStatus_Success Start a SAI eDMA send successfully.
|
|
* @retval kStatus_InvalidArgument The input argument is invalid.
|
|
* @retval kStatus_TxBusy SAI is busy sending data.
|
|
*/
|
|
status_t SAI_TransferSendEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
|
|
|
|
/*!
|
|
* @brief Performs a non-blocking SAI receive using eDMA.
|
|
*
|
|
* @note This interface returns immediately after the transfer initiates. Call
|
|
* the SAI_GetReceiveRemainingBytes to poll the transfer status and check whether the SAI transfer is finished.
|
|
*
|
|
* @param base SAI base pointer
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param xfer Pointer to DMA transfer structure.
|
|
* @retval kStatus_Success Start a SAI eDMA receive successfully.
|
|
* @retval kStatus_InvalidArgument The input argument is invalid.
|
|
* @retval kStatus_RxBusy SAI is busy receiving data.
|
|
*/
|
|
status_t SAI_TransferReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
|
|
|
|
/*!
|
|
* @brief Terminate all SAI send.
|
|
*
|
|
* This function will clear all transfer slots buffered in the sai queue. If users only want to abort the
|
|
* current transfer slot, please call SAI_TransferAbortSendEDMA.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
*/
|
|
void SAI_TransferTerminateSendEDMA(I2S_Type *base, sai_edma_handle_t *handle);
|
|
|
|
/*!
|
|
* @brief Terminate all SAI receive.
|
|
*
|
|
* This function will clear all transfer slots buffered in the sai queue. If users only want to abort the
|
|
* current transfer slot, please call SAI_TransferAbortReceiveEDMA.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
*/
|
|
void SAI_TransferTerminateReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle);
|
|
|
|
/*!
|
|
* @brief Aborts a SAI transfer using eDMA.
|
|
*
|
|
* This function only aborts the current transfer slots, the other transfer slots' information still kept
|
|
* in the handler. If users want to terminate all transfer slots, just call SAI_TransferTerminateSendEDMA.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
*/
|
|
void SAI_TransferAbortSendEDMA(I2S_Type *base, sai_edma_handle_t *handle);
|
|
|
|
/*!
|
|
* @brief Aborts a SAI receive using eDMA.
|
|
*
|
|
* This function only aborts the current transfer slots, the other transfer slots' information still kept
|
|
* in the handler. If users want to terminate all transfer slots, just call SAI_TransferTerminateReceiveEDMA.
|
|
*
|
|
* @param base SAI base pointer
|
|
* @param handle SAI eDMA handle pointer.
|
|
*/
|
|
void SAI_TransferAbortReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle);
|
|
|
|
/*!
|
|
* @brief Gets byte count sent by SAI.
|
|
*
|
|
* @param base SAI base pointer.
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param count Bytes count sent by SAI.
|
|
* @retval kStatus_Success Succeed get the transfer count.
|
|
* @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
|
|
*/
|
|
status_t SAI_TransferGetSendCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
|
|
|
|
/*!
|
|
* @brief Gets byte count received by SAI.
|
|
*
|
|
* @param base SAI base pointer
|
|
* @param handle SAI eDMA handle pointer.
|
|
* @param count Bytes count received by SAI.
|
|
* @retval kStatus_Success Succeed get the transfer count.
|
|
* @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
|
|
*/
|
|
status_t SAI_TransferGetReceiveCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
|
|
|
|
/*! @} */
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
* @}
|
|
*/
|
|
#endif
|