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