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_K22F/TOOLCHAIN_GCC_ARM/fsl_sai_edma.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

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