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_USENSE/TOOLCHAIN_ARM_STD/fsl_flexio_i2s_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 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_FLEXIO_I2S_EDMA_H_
AnnaBridge 145:64910690c574 31 #define _FSL_FLEXIO_I2S_EDMA_H_
AnnaBridge 145:64910690c574 32
AnnaBridge 145:64910690c574 33 #include "fsl_flexio_i2s.h"
AnnaBridge 145:64910690c574 34 #include "fsl_edma.h"
AnnaBridge 145:64910690c574 35
AnnaBridge 145:64910690c574 36 /*!
AnnaBridge 145:64910690c574 37 * @addtogroup flexio_edma_i2s
AnnaBridge 145:64910690c574 38 * @{
AnnaBridge 145:64910690c574 39 */
AnnaBridge 145:64910690c574 40
AnnaBridge 145:64910690c574 41
AnnaBridge 145:64910690c574 42 /*******************************************************************************
AnnaBridge 145:64910690c574 43 * Definitions
AnnaBridge 145:64910690c574 44 ******************************************************************************/
AnnaBridge 145:64910690c574 45
AnnaBridge 145:64910690c574 46 typedef struct _flexio_i2s_edma_handle flexio_i2s_edma_handle_t;
AnnaBridge 145:64910690c574 47
AnnaBridge 145:64910690c574 48 /*! @brief FlexIO I2S eDMA transfer callback function for finish and error */
AnnaBridge 145:64910690c574 49 typedef void (*flexio_i2s_edma_callback_t)(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 50 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 51 status_t status,
AnnaBridge 145:64910690c574 52 void *userData);
AnnaBridge 145:64910690c574 53
AnnaBridge 145:64910690c574 54 /*! @brief FlexIO I2S DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 145:64910690c574 55 struct _flexio_i2s_edma_handle
AnnaBridge 145:64910690c574 56 {
AnnaBridge 145:64910690c574 57 edma_handle_t *dmaHandle; /*!< DMA handler for FlexIO I2S send */
AnnaBridge 145:64910690c574 58 uint8_t bytesPerFrame; /*!< Bytes in a frame */
AnnaBridge 145:64910690c574 59 uint32_t state; /*!< Internal state for FlexIO I2S eDMA transfer */
AnnaBridge 145:64910690c574 60 flexio_i2s_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurred */
AnnaBridge 145:64910690c574 61 void *userData; /*!< User callback parameter */
AnnaBridge 145:64910690c574 62 edma_tcd_t tcd[FLEXIO_I2S_XFER_QUEUE_SIZE + 1U]; /*!< TCD pool for eDMA transfer. */
AnnaBridge 145:64910690c574 63 flexio_i2s_transfer_t queue[FLEXIO_I2S_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer. */
AnnaBridge 145:64910690c574 64 size_t transferSize[FLEXIO_I2S_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
AnnaBridge 145:64910690c574 65 volatile uint8_t queueUser; /*!< Index for user to queue transfer. */
AnnaBridge 145:64910690c574 66 volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
AnnaBridge 145:64910690c574 67 };
AnnaBridge 145:64910690c574 68
AnnaBridge 145:64910690c574 69 /*******************************************************************************
AnnaBridge 145:64910690c574 70 * APIs
AnnaBridge 145:64910690c574 71 ******************************************************************************/
AnnaBridge 145:64910690c574 72 #if defined(__cplusplus)
AnnaBridge 145:64910690c574 73 extern "C" {
AnnaBridge 145:64910690c574 74 #endif
AnnaBridge 145:64910690c574 75
AnnaBridge 145:64910690c574 76 /*!
AnnaBridge 145:64910690c574 77 * @name eDMA Transactional
AnnaBridge 145:64910690c574 78 * @{
AnnaBridge 145:64910690c574 79 */
AnnaBridge 145:64910690c574 80
AnnaBridge 145:64910690c574 81 /*!
AnnaBridge 145:64910690c574 82 * @brief Initializes the FlexIO I2S eDMA handle.
AnnaBridge 145:64910690c574 83 *
AnnaBridge 145:64910690c574 84 * This function initializes the FlexIO I2S master DMA handle which can be used for other FlexIO I2S master
AnnaBridge 145:64910690c574 85 * transactional APIs.
AnnaBridge 145:64910690c574 86 * Usually, for a specified FlexIO I2S instance, user need only call this API once to get the initialized handle.
AnnaBridge 145:64910690c574 87 *
AnnaBridge 145:64910690c574 88 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 89 * @param handle FlexIO I2S eDMA handle pointer.
AnnaBridge 145:64910690c574 90 * @param callback FlexIO I2S eDMA callback function called while finished a block.
AnnaBridge 145:64910690c574 91 * @param userData User parameter for callback.
AnnaBridge 145:64910690c574 92 * @param dmaHandle eDMA handle for FlexIO I2S. This handle shall be a static value allocated by users.
AnnaBridge 145:64910690c574 93 */
AnnaBridge 145:64910690c574 94 void FLEXIO_I2S_TransferTxCreateHandleEDMA(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 95 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 96 flexio_i2s_edma_callback_t callback,
AnnaBridge 145:64910690c574 97 void *userData,
AnnaBridge 145:64910690c574 98 edma_handle_t *dmaHandle);
AnnaBridge 145:64910690c574 99
AnnaBridge 145:64910690c574 100 /*!
AnnaBridge 145:64910690c574 101 * @brief Initializes the FlexIO I2S Rx eDMA handle.
AnnaBridge 145:64910690c574 102 *
AnnaBridge 145:64910690c574 103 * This function initializes the FlexIO I2S slave DMA handle which can be used for other FlexIO I2S master transactional
AnnaBridge 145:64910690c574 104 * APIs.
AnnaBridge 145:64910690c574 105 * Usually, for a specified FlexIO I2S instance, user need only call this API once to get the initialized handle.
AnnaBridge 145:64910690c574 106 *
AnnaBridge 145:64910690c574 107 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 108 * @param handle FlexIO I2S eDMA handle pointer.
AnnaBridge 145:64910690c574 109 * @param callback FlexIO I2S eDMA callback function called while finished a block.
AnnaBridge 145:64910690c574 110 * @param userData User parameter for callback.
AnnaBridge 145:64910690c574 111 * @param dmaHandle eDMA handle for FlexIO I2S. This handle shall be a static value allocated by users.
AnnaBridge 145:64910690c574 112 */
AnnaBridge 145:64910690c574 113 void FLEXIO_I2S_TransferRxCreateHandleEDMA(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 114 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 115 flexio_i2s_edma_callback_t callback,
AnnaBridge 145:64910690c574 116 void *userData,
AnnaBridge 145:64910690c574 117 edma_handle_t *dmaHandle);
AnnaBridge 145:64910690c574 118
AnnaBridge 145:64910690c574 119 /*!
AnnaBridge 145:64910690c574 120 * @brief Configures the FlexIO I2S Tx audio format.
AnnaBridge 145:64910690c574 121 *
AnnaBridge 145:64910690c574 122 * Audio format can be changed in run-time of FlexIO I2S. This function configures the sample rate and audio data
AnnaBridge 145:64910690c574 123 * format to be transferred. This function also sets eDMA parameter according to format.
AnnaBridge 145:64910690c574 124 *
AnnaBridge 145:64910690c574 125 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 126 * @param handle FlexIO I2S eDMA handle pointer
AnnaBridge 145:64910690c574 127 * @param format Pointer to FlexIO I2S audio data format structure.
AnnaBridge 145:64910690c574 128 * @param srcClock_Hz FlexIO I2S clock source frequency in Hz, it should be 0 while in slave mode.
AnnaBridge 145:64910690c574 129 * @retval kStatus_Success Audio format set successfully.
AnnaBridge 145:64910690c574 130 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 145:64910690c574 131 */
AnnaBridge 145:64910690c574 132 void FLEXIO_I2S_TransferSetFormatEDMA(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 133 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 134 flexio_i2s_format_t *format,
AnnaBridge 145:64910690c574 135 uint32_t srcClock_Hz);
AnnaBridge 145:64910690c574 136
AnnaBridge 145:64910690c574 137 /*!
AnnaBridge 145:64910690c574 138 * @brief Performs a non-blocking FlexIO I2S transfer using DMA.
AnnaBridge 145:64910690c574 139 *
AnnaBridge 145:64910690c574 140 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 145:64910690c574 141 * FLEXIO_I2S_GetTransferStatus to poll the transfer status to check whether FlexIO I2S transfer finished.
AnnaBridge 145:64910690c574 142 *
AnnaBridge 145:64910690c574 143 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 144 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 145 * @param xfer Pointer to DMA transfer structure.
AnnaBridge 145:64910690c574 146 * @retval kStatus_Success Start a FlexIO I2S eDMA send successfully.
AnnaBridge 145:64910690c574 147 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 145:64910690c574 148 * @retval kStatus_TxBusy FlexIO I2S is busy sending data.
AnnaBridge 145:64910690c574 149 */
AnnaBridge 145:64910690c574 150 status_t FLEXIO_I2S_TransferSendEDMA(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 151 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 152 flexio_i2s_transfer_t *xfer);
AnnaBridge 145:64910690c574 153
AnnaBridge 145:64910690c574 154 /*!
AnnaBridge 145:64910690c574 155 * @brief Performs a non-blocking FlexIO I2S receive using eDMA.
AnnaBridge 145:64910690c574 156 *
AnnaBridge 145:64910690c574 157 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 145:64910690c574 158 * FLEXIO_I2S_GetReceiveRemainingBytes to poll the transfer status to check whether FlexIO I2S transfer finished.
AnnaBridge 145:64910690c574 159 *
AnnaBridge 145:64910690c574 160 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 161 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 162 * @param xfer Pointer to DMA transfer structure.
AnnaBridge 145:64910690c574 163 * @retval kStatus_Success Start a FlexIO I2S eDMA receive successfully.
AnnaBridge 145:64910690c574 164 * @retval kStatus_InvalidArgument The input arguments is invalid.
AnnaBridge 145:64910690c574 165 * @retval kStatus_RxBusy FlexIO I2S is busy receiving data.
AnnaBridge 145:64910690c574 166 */
AnnaBridge 145:64910690c574 167 status_t FLEXIO_I2S_TransferReceiveEDMA(FLEXIO_I2S_Type *base,
AnnaBridge 145:64910690c574 168 flexio_i2s_edma_handle_t *handle,
AnnaBridge 145:64910690c574 169 flexio_i2s_transfer_t *xfer);
AnnaBridge 145:64910690c574 170
AnnaBridge 145:64910690c574 171 /*!
AnnaBridge 145:64910690c574 172 * @brief Aborts a FlexIO I2S transfer using eDMA.
AnnaBridge 145:64910690c574 173 *
AnnaBridge 145:64910690c574 174 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 175 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 176 */
AnnaBridge 145:64910690c574 177 void FLEXIO_I2S_TransferAbortSendEDMA(FLEXIO_I2S_Type *base, flexio_i2s_edma_handle_t *handle);
AnnaBridge 145:64910690c574 178
AnnaBridge 145:64910690c574 179 /*!
AnnaBridge 145:64910690c574 180 * @brief Aborts a FlexIO I2S receive using eDMA.
AnnaBridge 145:64910690c574 181 *
AnnaBridge 145:64910690c574 182 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 183 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 184 */
AnnaBridge 145:64910690c574 185 void FLEXIO_I2S_TransferAbortReceiveEDMA(FLEXIO_I2S_Type *base, flexio_i2s_edma_handle_t *handle);
AnnaBridge 145:64910690c574 186
AnnaBridge 145:64910690c574 187 /*!
AnnaBridge 145:64910690c574 188 * @brief Gets the remaining bytes to be sent.
AnnaBridge 145:64910690c574 189 *
AnnaBridge 145:64910690c574 190 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 191 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 192 * @param count Bytes sent.
AnnaBridge 145:64910690c574 193 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 145:64910690c574 194 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 145:64910690c574 195 */
AnnaBridge 145:64910690c574 196 status_t FLEXIO_I2S_TransferGetSendCountEDMA(FLEXIO_I2S_Type *base, flexio_i2s_edma_handle_t *handle, size_t *count);
AnnaBridge 145:64910690c574 197
AnnaBridge 145:64910690c574 198 /*!
AnnaBridge 145:64910690c574 199 * @brief Get the remaining bytes to be received.
AnnaBridge 145:64910690c574 200 *
AnnaBridge 145:64910690c574 201 * @param base FlexIO I2S peripheral base address.
AnnaBridge 145:64910690c574 202 * @param handle FlexIO I2S DMA handle pointer.
AnnaBridge 145:64910690c574 203 * @param count Bytes received.
AnnaBridge 145:64910690c574 204 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 145:64910690c574 205 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 145:64910690c574 206 */
AnnaBridge 145:64910690c574 207 status_t FLEXIO_I2S_TransferGetReceiveCountEDMA(FLEXIO_I2S_Type *base, flexio_i2s_edma_handle_t *handle, size_t *count);
AnnaBridge 145:64910690c574 208
AnnaBridge 145:64910690c574 209 /*! @} */
AnnaBridge 145:64910690c574 210
AnnaBridge 145:64910690c574 211 #if defined(__cplusplus)
AnnaBridge 145:64910690c574 212 }
AnnaBridge 145:64910690c574 213 #endif
AnnaBridge 145:64910690c574 214
AnnaBridge 145:64910690c574 215 /*!
AnnaBridge 145:64910690c574 216 * @}
AnnaBridge 145:64910690c574 217 */
AnnaBridge 145:64910690c574 218 #endif