mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_K66F/TOOLCHAIN_GCC_ARM/fsl_sai_edma.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 143:86740a56073b 3 * Copyright 2016-2017 NXP
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 143:86740a56073b 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 143:86740a56073b 13 * other materials provided with the distribution.
AnnaBridge 143:86740a56073b 14 *
AnnaBridge 143:86740a56073b 15 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 143:86740a56073b 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 143:86740a56073b 17 * software without specific prior written permission.
AnnaBridge 143:86740a56073b 18 *
AnnaBridge 143:86740a56073b 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 29 */
AnnaBridge 143:86740a56073b 30 #ifndef _FSL_SAI_EDMA_H_
AnnaBridge 143:86740a56073b 31 #define _FSL_SAI_EDMA_H_
AnnaBridge 143:86740a56073b 32
AnnaBridge 143:86740a56073b 33 #include "fsl_sai.h"
AnnaBridge 143:86740a56073b 34 #include "fsl_edma.h"
AnnaBridge 143:86740a56073b 35
AnnaBridge 143:86740a56073b 36 /*!
AnnaBridge 143:86740a56073b 37 * @addtogroup sai_edma
AnnaBridge 143:86740a56073b 38 * @{
AnnaBridge 143:86740a56073b 39 */
AnnaBridge 143:86740a56073b 40
AnnaBridge 143:86740a56073b 41 /*******************************************************************************
AnnaBridge 143:86740a56073b 42 * Definitions
AnnaBridge 143:86740a56073b 43 ******************************************************************************/
AnnaBridge 143:86740a56073b 44
AnnaBridge 143:86740a56073b 45 typedef struct _sai_edma_handle sai_edma_handle_t;
AnnaBridge 143:86740a56073b 46
AnnaBridge 143:86740a56073b 47 /*! @brief SAI eDMA transfer callback function for finish and error */
AnnaBridge 143:86740a56073b 48 typedef void (*sai_edma_callback_t)(I2S_Type *base, sai_edma_handle_t *handle, status_t status, void *userData);
AnnaBridge 143:86740a56073b 49
AnnaBridge 143:86740a56073b 50 /*! @brief SAI DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 143:86740a56073b 51 struct _sai_edma_handle
AnnaBridge 143:86740a56073b 52 {
AnnaBridge 143:86740a56073b 53 edma_handle_t *dmaHandle; /*!< DMA handler for SAI send */
AnnaBridge 143:86740a56073b 54 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 143:86740a56073b 55 uint8_t bytesPerFrame; /*!< Bytes in a frame */
AnnaBridge 143:86740a56073b 56 uint8_t channel; /*!< Which data channel */
AnnaBridge 143:86740a56073b 57 uint8_t count; /*!< The transfer data count in a DMA request */
AnnaBridge 143:86740a56073b 58 uint32_t state; /*!< Internal state for SAI eDMA transfer */
AnnaBridge 143:86740a56073b 59 sai_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurs */
AnnaBridge 143:86740a56073b 60 void *userData; /*!< User callback parameter */
AnnaBridge 143:86740a56073b 61 edma_tcd_t tcd[SAI_XFER_QUEUE_SIZE + 1U]; /*!< TCD pool for eDMA transfer. */
AnnaBridge 143:86740a56073b 62 sai_transfer_t saiQueue[SAI_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
AnnaBridge 143:86740a56073b 63 size_t transferSize[SAI_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
AnnaBridge 143:86740a56073b 64 volatile uint8_t queueUser; /*!< Index for user to queue transfer. */
AnnaBridge 143:86740a56073b 65 volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
AnnaBridge 143:86740a56073b 66 };
AnnaBridge 143:86740a56073b 67
AnnaBridge 143:86740a56073b 68 /*******************************************************************************
AnnaBridge 143:86740a56073b 69 * APIs
AnnaBridge 143:86740a56073b 70 ******************************************************************************/
AnnaBridge 143:86740a56073b 71 #if defined(__cplusplus)
AnnaBridge 143:86740a56073b 72 extern "C" {
AnnaBridge 143:86740a56073b 73 #endif
AnnaBridge 143:86740a56073b 74
AnnaBridge 143:86740a56073b 75 /*!
AnnaBridge 143:86740a56073b 76 * @name eDMA Transactional
AnnaBridge 143:86740a56073b 77 * @{
AnnaBridge 143:86740a56073b 78 */
AnnaBridge 143:86740a56073b 79
AnnaBridge 143:86740a56073b 80 /*!
AnnaBridge 143:86740a56073b 81 * @brief Initializes the SAI eDMA handle.
AnnaBridge 143:86740a56073b 82 *
AnnaBridge 143:86740a56073b 83 * This function initializes the SAI master DMA handle, which can be used for other SAI master transactional APIs.
AnnaBridge 143:86740a56073b 84 * Usually, for a specified SAI instance, call this API once to get the initialized handle.
AnnaBridge 143:86740a56073b 85 *
AnnaBridge 143:86740a56073b 86 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 87 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 88 * @param base SAI peripheral base address.
AnnaBridge 143:86740a56073b 89 * @param callback Pointer to user callback function.
AnnaBridge 143:86740a56073b 90 * @param userData User parameter passed to the callback function.
AnnaBridge 143:86740a56073b 91 * @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
AnnaBridge 143:86740a56073b 92 */
AnnaBridge 143:86740a56073b 93 void SAI_TransferTxCreateHandleEDMA(
AnnaBridge 143:86740a56073b 94 I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
AnnaBridge 143:86740a56073b 95
AnnaBridge 143:86740a56073b 96 /*!
AnnaBridge 143:86740a56073b 97 * @brief Initializes the SAI Rx eDMA handle.
AnnaBridge 143:86740a56073b 98 *
AnnaBridge 143:86740a56073b 99 * This function initializes the SAI slave DMA handle, which can be used for other SAI master transactional APIs.
AnnaBridge 143:86740a56073b 100 * Usually, for a specified SAI instance, call this API once to get the initialized handle.
AnnaBridge 143:86740a56073b 101 *
AnnaBridge 143:86740a56073b 102 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 103 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 104 * @param base SAI peripheral base address.
AnnaBridge 143:86740a56073b 105 * @param callback Pointer to user callback function.
AnnaBridge 143:86740a56073b 106 * @param userData User parameter passed to the callback function.
AnnaBridge 143:86740a56073b 107 * @param dmaHandle eDMA handle pointer, this handle shall be static allocated by users.
AnnaBridge 143:86740a56073b 108 */
AnnaBridge 143:86740a56073b 109 void SAI_TransferRxCreateHandleEDMA(
AnnaBridge 143:86740a56073b 110 I2S_Type *base, sai_edma_handle_t *handle, sai_edma_callback_t callback, void *userData, edma_handle_t *dmaHandle);
AnnaBridge 143:86740a56073b 111
AnnaBridge 143:86740a56073b 112 /*!
AnnaBridge 143:86740a56073b 113 * @brief Configures the SAI Tx audio format.
AnnaBridge 143:86740a56073b 114 *
AnnaBridge 143:86740a56073b 115 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 143:86740a56073b 116 * format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
AnnaBridge 143:86740a56073b 117 *
AnnaBridge 143:86740a56073b 118 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 119 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 120 * @param format Pointer to SAI audio data format structure.
AnnaBridge 143:86740a56073b 121 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 143:86740a56073b 122 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If bit clock source is master
AnnaBridge 143:86740a56073b 123 * clock, this value should equals to masterClockHz in format.
AnnaBridge 143:86740a56073b 124 * @retval kStatus_Success Audio format set successfully.
AnnaBridge 143:86740a56073b 125 * @retval kStatus_InvalidArgument The input argument is invalid.
AnnaBridge 143:86740a56073b 126 */
AnnaBridge 143:86740a56073b 127 void SAI_TransferTxSetFormatEDMA(I2S_Type *base,
AnnaBridge 143:86740a56073b 128 sai_edma_handle_t *handle,
AnnaBridge 143:86740a56073b 129 sai_transfer_format_t *format,
AnnaBridge 143:86740a56073b 130 uint32_t mclkSourceClockHz,
AnnaBridge 143:86740a56073b 131 uint32_t bclkSourceClockHz);
AnnaBridge 143:86740a56073b 132
AnnaBridge 143:86740a56073b 133 /*!
AnnaBridge 143:86740a56073b 134 * @brief Configures the SAI Rx audio format.
AnnaBridge 143:86740a56073b 135 *
AnnaBridge 143:86740a56073b 136 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 143:86740a56073b 137 * format to be transferred. This function also sets the eDMA parameter according to formatting requirements.
AnnaBridge 143:86740a56073b 138 *
AnnaBridge 143:86740a56073b 139 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 140 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 141 * @param format Pointer to SAI audio data format structure.
AnnaBridge 143:86740a56073b 142 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 143:86740a56073b 143 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is the master
AnnaBridge 143:86740a56073b 144 * clock, this value should equal to masterClockHz in format.
AnnaBridge 143:86740a56073b 145 * @retval kStatus_Success Audio format set successfully.
AnnaBridge 143:86740a56073b 146 * @retval kStatus_InvalidArgument The input argument is invalid.
AnnaBridge 143:86740a56073b 147 */
AnnaBridge 143:86740a56073b 148 void SAI_TransferRxSetFormatEDMA(I2S_Type *base,
AnnaBridge 143:86740a56073b 149 sai_edma_handle_t *handle,
AnnaBridge 143:86740a56073b 150 sai_transfer_format_t *format,
AnnaBridge 143:86740a56073b 151 uint32_t mclkSourceClockHz,
AnnaBridge 143:86740a56073b 152 uint32_t bclkSourceClockHz);
AnnaBridge 143:86740a56073b 153
AnnaBridge 143:86740a56073b 154 /*!
AnnaBridge 143:86740a56073b 155 * @brief Performs a non-blocking SAI transfer using DMA.
AnnaBridge 143:86740a56073b 156 *
AnnaBridge 143:86740a56073b 157 * @note This interface returns immediately after the transfer initiates. Call
AnnaBridge 143:86740a56073b 158 * SAI_GetTransferStatus to poll the transfer status and check whether the SAI transfer is finished.
AnnaBridge 143:86740a56073b 159 *
AnnaBridge 143:86740a56073b 160 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 161 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 162 * @param xfer Pointer to the DMA transfer structure.
AnnaBridge 143:86740a56073b 163 * @retval kStatus_Success Start a SAI eDMA send successfully.
AnnaBridge 143:86740a56073b 164 * @retval kStatus_InvalidArgument The input argument is invalid.
AnnaBridge 143:86740a56073b 165 * @retval kStatus_TxBusy SAI is busy sending data.
AnnaBridge 143:86740a56073b 166 */
AnnaBridge 143:86740a56073b 167 status_t SAI_TransferSendEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
AnnaBridge 143:86740a56073b 168
AnnaBridge 143:86740a56073b 169 /*!
AnnaBridge 143:86740a56073b 170 * @brief Performs a non-blocking SAI receive using eDMA.
AnnaBridge 143:86740a56073b 171 *
AnnaBridge 143:86740a56073b 172 * @note This interface returns immediately after the transfer initiates. Call
AnnaBridge 143:86740a56073b 173 * the SAI_GetReceiveRemainingBytes to poll the transfer status and check whether the SAI transfer is finished.
AnnaBridge 143:86740a56073b 174 *
AnnaBridge 143:86740a56073b 175 * @param base SAI base pointer
AnnaBridge 143:86740a56073b 176 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 177 * @param xfer Pointer to DMA transfer structure.
AnnaBridge 143:86740a56073b 178 * @retval kStatus_Success Start a SAI eDMA receive successfully.
AnnaBridge 143:86740a56073b 179 * @retval kStatus_InvalidArgument The input argument is invalid.
AnnaBridge 143:86740a56073b 180 * @retval kStatus_RxBusy SAI is busy receiving data.
AnnaBridge 143:86740a56073b 181 */
AnnaBridge 143:86740a56073b 182 status_t SAI_TransferReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle, sai_transfer_t *xfer);
AnnaBridge 143:86740a56073b 183
AnnaBridge 143:86740a56073b 184 /*!
AnnaBridge 143:86740a56073b 185 * @brief Aborts a SAI transfer using eDMA.
AnnaBridge 143:86740a56073b 186 *
AnnaBridge 143:86740a56073b 187 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 188 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 189 */
AnnaBridge 143:86740a56073b 190 void SAI_TransferAbortSendEDMA(I2S_Type *base, sai_edma_handle_t *handle);
AnnaBridge 143:86740a56073b 191
AnnaBridge 143:86740a56073b 192 /*!
AnnaBridge 143:86740a56073b 193 * @brief Aborts a SAI receive using eDMA.
AnnaBridge 143:86740a56073b 194 *
AnnaBridge 143:86740a56073b 195 * @param base SAI base pointer
AnnaBridge 143:86740a56073b 196 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 197 */
AnnaBridge 143:86740a56073b 198 void SAI_TransferAbortReceiveEDMA(I2S_Type *base, sai_edma_handle_t *handle);
AnnaBridge 143:86740a56073b 199
AnnaBridge 143:86740a56073b 200 /*!
AnnaBridge 143:86740a56073b 201 * @brief Gets byte count sent by SAI.
AnnaBridge 143:86740a56073b 202 *
AnnaBridge 143:86740a56073b 203 * @param base SAI base pointer.
AnnaBridge 143:86740a56073b 204 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 205 * @param count Bytes count sent by SAI.
AnnaBridge 143:86740a56073b 206 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 143:86740a56073b 207 * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
AnnaBridge 143:86740a56073b 208 */
AnnaBridge 143:86740a56073b 209 status_t SAI_TransferGetSendCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
AnnaBridge 143:86740a56073b 210
AnnaBridge 143:86740a56073b 211 /*!
AnnaBridge 143:86740a56073b 212 * @brief Gets byte count received by SAI.
AnnaBridge 143:86740a56073b 213 *
AnnaBridge 143:86740a56073b 214 * @param base SAI base pointer
AnnaBridge 143:86740a56073b 215 * @param handle SAI eDMA handle pointer.
AnnaBridge 143:86740a56073b 216 * @param count Bytes count received by SAI.
AnnaBridge 143:86740a56073b 217 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 143:86740a56073b 218 * @retval kStatus_NoTransferInProgress There is no non-blocking transaction in progress.
AnnaBridge 143:86740a56073b 219 */
AnnaBridge 143:86740a56073b 220 status_t SAI_TransferGetReceiveCountEDMA(I2S_Type *base, sai_edma_handle_t *handle, size_t *count);
AnnaBridge 143:86740a56073b 221
AnnaBridge 143:86740a56073b 222 /*! @} */
AnnaBridge 143:86740a56073b 223
AnnaBridge 143:86740a56073b 224 #if defined(__cplusplus)
AnnaBridge 143:86740a56073b 225 }
AnnaBridge 143:86740a56073b 226 #endif
AnnaBridge 143:86740a56073b 227
AnnaBridge 143:86740a56073b 228 /*!
AnnaBridge 143:86740a56073b 229 * @}
AnnaBridge 143:86740a56073b 230 */
AnnaBridge 143:86740a56073b 231 #endif