/* * Copyright 2017 - 2020 NXP * All rights reserved. * * * SPDX-License-Identifier: BSD-3-Clause */ #ifndef _FSL_SAI_SDMA_H_ #define _FSL_SAI_SDMA_H_ #include "fsl_sai.h" #include "fsl_sdma.h" /*! * @addtogroup sai_sdma * @{ */ /******************************************************************************* * Definitions ******************************************************************************/ /*! @name Driver version */ /*@{*/ #define FSL_SAI_SDMA_DRIVER_VERSION (MAKE_VERSION(2, 3, 1)) /*!< Version 2.3.1 */ /*@}*/ typedef struct _sai_sdma_handle sai_sdma_handle_t; /*! @brief SAI SDMA transfer callback function for finish and error */ typedef void (*sai_sdma_callback_t)(I2S_Type *base, sai_sdma_handle_t *handle, status_t status, void *userData); /*! @brief SAI DMA transfer handle, users should not touch the content of the handle. */ struct _sai_sdma_handle { sdma_handle_t *dmaHandle; /*!< DMA handler for SAI send */ uint8_t bytesPerFrame; /*!< Bytes in a frame */ uint8_t channel; /*!< start data channel */ uint8_t channelNums; /*!< total transfer channel numbers, used for multififo */ uint8_t channelMask; /*!< enabled channel mask value, refernece _sai_channel_mask */ uint8_t fifoOffset; /*!< fifo address offset between multifo*/ uint8_t count; /*!< The transfer data count in a DMA request */ uint32_t state; /*!< Internal state for SAI SDMA transfer */ uint32_t eventSource; /*!< SAI event source number */ sai_sdma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */ void *userData; /*!< User callback parameter */ sdma_buffer_descriptor_t bdPool[SAI_XFER_QUEUE_SIZE]; /*!< BD pool for SDMA 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 SDMA Transactional * @{ */ /*! * @brief Initializes the SAI SDMA 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 SDMA 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 SDMA handle pointer, this handle shall be static allocated by users. * @param eventSource SAI event source number. */ void SAI_TransferTxCreateHandleSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_sdma_callback_t callback, void *userData, sdma_handle_t *dmaHandle, uint32_t eventSource); /*! * @brief Initializes the SAI Rx SDMA 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 SDMA 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 SDMA handle pointer, this handle shall be static allocated by users. * @param eventSource SAI event source number. */ void SAI_TransferRxCreateHandleSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_sdma_callback_t callback, void *userData, sdma_handle_t *dmaHandle, uint32_t eventSource); /*! * @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 SDMA parameter according to formatting requirements. * * @param base SAI base pointer. * @param handle SAI SDMA 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_TransferTxSetFormatSDMA(I2S_Type *base, sai_sdma_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 SDMA parameter according to formatting requirements. * * @param base SAI base pointer. * @param handle SAI SDMA 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_TransferRxSetFormatSDMA(I2S_Type *base, sai_sdma_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 SDMA handle pointer. * @param xfer Pointer to the DMA transfer structure. * @retval kStatus_Success Start a SAI SDMA send successfully. * @retval kStatus_InvalidArgument The input argument is invalid. * @retval kStatus_TxBusy SAI is busy sending data. */ status_t SAI_TransferSendSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transfer_t *xfer); /*! * @brief Performs a non-blocking SAI receive using SDMA. * * @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 SDMA handle pointer. * @param xfer Pointer to DMA transfer structure. * @retval kStatus_Success Start a SAI SDMA receive successfully. * @retval kStatus_InvalidArgument The input argument is invalid. * @retval kStatus_RxBusy SAI is busy receiving data. */ status_t SAI_TransferReceiveSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transfer_t *xfer); /*! * @brief Aborts a SAI transfer using SDMA. * * @param base SAI base pointer. * @param handle SAI SDMA handle pointer. */ void SAI_TransferAbortSendSDMA(I2S_Type *base, sai_sdma_handle_t *handle); /*! * @brief Aborts a SAI receive using SDMA. * * @param base SAI base pointer * @param handle SAI SDMA handle pointer. */ void SAI_TransferAbortReceiveSDMA(I2S_Type *base, sai_sdma_handle_t *handle); /*! * brief Configures the SAI RX. * * param base SAI base pointer. * param handle SAI SDMA handle pointer. * param saiConig sai configurations. */ void SAI_TransferRxSetConfigSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transceiver_t *saiConfig); /*! * brief Configures the SAI Tx. * * param base SAI base pointer. * param handle SAI SDMA handle pointer. * param saiConig sai configurations. */ void SAI_TransferTxSetConfigSDMA(I2S_Type *base, sai_sdma_handle_t *handle, sai_transceiver_t *saiConfig); /*! @} */ #if defined(__cplusplus) } #endif /*! * @} */ #endif