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_KL43Z/TOOLCHAIN_IAR/fsl_flexio_i2s_dma.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 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_FLEXIO_I2S_DMA_H_
AnnaBridge 171:3a7713b1edbc 31 #define _FSL_FLEXIO_I2S_DMA_H_
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 #include "fsl_flexio_i2s.h"
AnnaBridge 171:3a7713b1edbc 34 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 35
AnnaBridge 171:3a7713b1edbc 36 /*!
AnnaBridge 171:3a7713b1edbc 37 * @addtogroup flexio_dma_i2s
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 _flexio_i2s_dma_handle flexio_i2s_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49 /*! @brief FlexIO I2S DMA transfer callback function for finish and error */
AnnaBridge 171:3a7713b1edbc 50 typedef void (*flexio_i2s_dma_callback_t)(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 51 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 52 status_t status,
AnnaBridge 171:3a7713b1edbc 53 void *userData);
AnnaBridge 171:3a7713b1edbc 54
AnnaBridge 171:3a7713b1edbc 55 /*! @brief FlexIO I2S DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 171:3a7713b1edbc 56 struct _flexio_i2s_dma_handle
AnnaBridge 171:3a7713b1edbc 57 {
AnnaBridge 171:3a7713b1edbc 58 dma_handle_t *dmaHandle; /*!< DMA handler for FlexIO I2S send */
AnnaBridge 171:3a7713b1edbc 59 uint8_t bytesPerFrame; /*!< Bytes in a frame */
AnnaBridge 171:3a7713b1edbc 60 uint32_t state; /*!< Internal state for FlexIO I2S DMA transfer */
AnnaBridge 171:3a7713b1edbc 61 flexio_i2s_dma_callback_t callback; /*!< Callback for users while transfer finish or error occurred */
AnnaBridge 171:3a7713b1edbc 62 void *userData; /*!< User callback parameter */
AnnaBridge 171:3a7713b1edbc 63 flexio_i2s_transfer_t queue[FLEXIO_I2S_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
AnnaBridge 171:3a7713b1edbc 64 size_t transferSize[FLEXIO_I2S_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 DMA Transactional
AnnaBridge 171:3a7713b1edbc 78 * @{
AnnaBridge 171:3a7713b1edbc 79 */
AnnaBridge 171:3a7713b1edbc 80
AnnaBridge 171:3a7713b1edbc 81 /*!
AnnaBridge 171:3a7713b1edbc 82 * @brief Initializes the FlexIO I2S DMA handle.
AnnaBridge 171:3a7713b1edbc 83 *
AnnaBridge 171:3a7713b1edbc 84 * This function initializes the FlexIO I2S master DMA handle which can be used for other FlexIO I2S master
AnnaBridge 171:3a7713b1edbc 85 * transactional APIs.
AnnaBridge 171:3a7713b1edbc 86 * Usually, for a specified FlexIO I2S instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 87 *
AnnaBridge 171:3a7713b1edbc 88 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 89 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 90 * @param callback FlexIO I2S DMA callback function called while finished a block.
AnnaBridge 171:3a7713b1edbc 91 * @param userData User parameter for callback.
AnnaBridge 171:3a7713b1edbc 92 * @param dmaHandle DMA handle for FlexIO I2S. This handle shall be a static value allocated by users.
AnnaBridge 171:3a7713b1edbc 93 */
AnnaBridge 171:3a7713b1edbc 94 void FLEXIO_I2S_TransferTxCreateHandleDMA(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 95 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 96 flexio_i2s_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 97 void *userData,
AnnaBridge 171:3a7713b1edbc 98 dma_handle_t *dmaHandle);
AnnaBridge 171:3a7713b1edbc 99
AnnaBridge 171:3a7713b1edbc 100 /*!
AnnaBridge 171:3a7713b1edbc 101 * @brief Initializes the FlexIO I2S Rx DMA handle.
AnnaBridge 171:3a7713b1edbc 102 *
AnnaBridge 171:3a7713b1edbc 103 * This function initializes the FlexIO I2S slave DMA handle which can be used for other FlexIO I2S master transactional
AnnaBridge 171:3a7713b1edbc 104 * APIs.
AnnaBridge 171:3a7713b1edbc 105 * Usually, for a specified FlexIO I2S instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 106 *
AnnaBridge 171:3a7713b1edbc 107 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 108 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 109 * @param callback FlexIO I2S DMA callback function called while finished a block.
AnnaBridge 171:3a7713b1edbc 110 * @param userData User parameter for callback.
AnnaBridge 171:3a7713b1edbc 111 * @param dmaHandle DMA handle for FlexIO I2S. This handle shall be a static value allocated by users.
AnnaBridge 171:3a7713b1edbc 112 */
AnnaBridge 171:3a7713b1edbc 113 void FLEXIO_I2S_TransferRxCreateHandleDMA(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 114 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 115 flexio_i2s_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 116 void *userData,
AnnaBridge 171:3a7713b1edbc 117 dma_handle_t *dmaHandle);
AnnaBridge 171:3a7713b1edbc 118
AnnaBridge 171:3a7713b1edbc 119 /*!
AnnaBridge 171:3a7713b1edbc 120 * @brief Configures the FlexIO I2S Tx audio format.
AnnaBridge 171:3a7713b1edbc 121 *
AnnaBridge 171:3a7713b1edbc 122 * Audio format can be changed in run-time of FlexIO I2S. This function configures the sample rate and audio data
AnnaBridge 171:3a7713b1edbc 123 * format to be transferred. This function also sets DMA parameter according to format.
AnnaBridge 171:3a7713b1edbc 124 *
AnnaBridge 171:3a7713b1edbc 125 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 126 * @param handle FlexIO I2S DMA handle pointer
AnnaBridge 171:3a7713b1edbc 127 * @param format Pointer to FlexIO I2S audio data format structure.
AnnaBridge 171:3a7713b1edbc 128 * @param srcClock_Hz FlexIO I2S clock source frequency in Hz. It should be 0 while in slave mode.
AnnaBridge 171:3a7713b1edbc 129 * @retval kStatus_Success Audio format set successfully.
AnnaBridge 171:3a7713b1edbc 130 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 171:3a7713b1edbc 131 */
AnnaBridge 171:3a7713b1edbc 132 void FLEXIO_I2S_TransferSetFormatDMA(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 133 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 134 flexio_i2s_format_t *format,
AnnaBridge 171:3a7713b1edbc 135 uint32_t srcClock_Hz);
AnnaBridge 171:3a7713b1edbc 136
AnnaBridge 171:3a7713b1edbc 137 /*!
AnnaBridge 171:3a7713b1edbc 138 * @brief Performs a non-blocking FlexIO I2S transfer using DMA.
AnnaBridge 171:3a7713b1edbc 139 *
AnnaBridge 171:3a7713b1edbc 140 * @note This interface returns immediately after transfer initiates. Call
AnnaBridge 171:3a7713b1edbc 141 * FLEXIO_I2S_GetTransferStatus to poll the transfer status and check whether FLEXIO I2S transfer finished.
AnnaBridge 171:3a7713b1edbc 142 *
AnnaBridge 171:3a7713b1edbc 143 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 144 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 145 * @param xfer Pointer to DMA transfer structure.
AnnaBridge 171:3a7713b1edbc 146 * @retval kStatus_Success Start a FlexIO I2S DMA send successfully.
AnnaBridge 171:3a7713b1edbc 147 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 171:3a7713b1edbc 148 * @retval kStatus_TxBusy FlexIO I2S is busy sending data.
AnnaBridge 171:3a7713b1edbc 149 */
AnnaBridge 171:3a7713b1edbc 150 status_t FLEXIO_I2S_TransferSendDMA(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 151 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 152 flexio_i2s_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 153
AnnaBridge 171:3a7713b1edbc 154 /*!
AnnaBridge 171:3a7713b1edbc 155 * @brief Performs a non-blocking FlexIO I2S receive using DMA.
AnnaBridge 171:3a7713b1edbc 156 *
AnnaBridge 171:3a7713b1edbc 157 * @note This interface returns immediately after transfer initiates. Call
AnnaBridge 171:3a7713b1edbc 158 * FLEXIO_I2S_GetReceiveRemainingBytes to poll the transfer status to check whether the FlexIO I2S transfer is finished.
AnnaBridge 171:3a7713b1edbc 159 *
AnnaBridge 171:3a7713b1edbc 160 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 161 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 162 * @param xfer Pointer to DMA transfer structure.
AnnaBridge 171:3a7713b1edbc 163 * @retval kStatus_Success Start a FlexIO I2S DMA receive successfully.
AnnaBridge 171:3a7713b1edbc 164 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 171:3a7713b1edbc 165 * @retval kStatus_RxBusy FlexIO I2S is busy receiving data.
AnnaBridge 171:3a7713b1edbc 166 */
AnnaBridge 171:3a7713b1edbc 167 status_t FLEXIO_I2S_TransferReceiveDMA(FLEXIO_I2S_Type *base,
AnnaBridge 171:3a7713b1edbc 168 flexio_i2s_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 169 flexio_i2s_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 170
AnnaBridge 171:3a7713b1edbc 171 /*!
AnnaBridge 171:3a7713b1edbc 172 * @brief Aborts a FlexIO I2S transfer using DMA.
AnnaBridge 171:3a7713b1edbc 173 *
AnnaBridge 171:3a7713b1edbc 174 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 175 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 176 */
AnnaBridge 171:3a7713b1edbc 177 void FLEXIO_I2S_TransferAbortSendDMA(FLEXIO_I2S_Type *base, flexio_i2s_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 178
AnnaBridge 171:3a7713b1edbc 179 /*!
AnnaBridge 171:3a7713b1edbc 180 * @brief Aborts a FlexIO I2S receive using DMA.
AnnaBridge 171:3a7713b1edbc 181 *
AnnaBridge 171:3a7713b1edbc 182 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 183 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 184 */
AnnaBridge 171:3a7713b1edbc 185 void FLEXIO_I2S_TransferAbortReceiveDMA(FLEXIO_I2S_Type *base, flexio_i2s_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 186
AnnaBridge 171:3a7713b1edbc 187 /*!
AnnaBridge 171:3a7713b1edbc 188 * @brief Gets the remaining bytes to be sent.
AnnaBridge 171:3a7713b1edbc 189 *
AnnaBridge 171:3a7713b1edbc 190 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 191 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 192 * @param count Bytes sent.
AnnaBridge 171:3a7713b1edbc 193 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 194 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 195 */
AnnaBridge 171:3a7713b1edbc 196 status_t FLEXIO_I2S_TransferGetSendCountDMA(FLEXIO_I2S_Type *base, flexio_i2s_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 197
AnnaBridge 171:3a7713b1edbc 198 /*!
AnnaBridge 171:3a7713b1edbc 199 * @brief Gets the remaining bytes to be received.
AnnaBridge 171:3a7713b1edbc 200 *
AnnaBridge 171:3a7713b1edbc 201 * @param base FlexIO I2S peripheral base address.
AnnaBridge 171:3a7713b1edbc 202 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 203 * @param count Bytes received.
AnnaBridge 171:3a7713b1edbc 204 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 205 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 206 */
AnnaBridge 171:3a7713b1edbc 207 status_t FLEXIO_I2S_TransferGetReceiveCountDMA(FLEXIO_I2S_Type *base, flexio_i2s_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 208
AnnaBridge 171:3a7713b1edbc 209 /*! @} */
AnnaBridge 171:3a7713b1edbc 210
AnnaBridge 171:3a7713b1edbc 211 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 212 }
AnnaBridge 171:3a7713b1edbc 213 #endif
AnnaBridge 171:3a7713b1edbc 214
AnnaBridge 171:3a7713b1edbc 215 /*!
AnnaBridge 171:3a7713b1edbc 216 * @}
AnnaBridge 171:3a7713b1edbc 217 */
AnnaBridge 171:3a7713b1edbc 218 #endif