mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_flexio_i2s_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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