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_LPC54114/TOOLCHAIN_ARM_STD/fsl_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
Kojto 148:fd96258d940d 1 /*
Kojto 148:fd96258d940d 2 * Copyright (c) 2016, Freescale Semiconductor, Inc.
Kojto 148:fd96258d940d 3 *
Kojto 148:fd96258d940d 4 * Redistribution and use in source and binary forms, with or without modification,
Kojto 148:fd96258d940d 5 * are permitted provided that the following conditions are met:
Kojto 148:fd96258d940d 6 *
Kojto 148:fd96258d940d 7 * o Redistributions of source code must retain the above copyright notice, this list
Kojto 148:fd96258d940d 8 * of conditions and the following disclaimer.
Kojto 148:fd96258d940d 9 *
Kojto 148:fd96258d940d 10 * o Redistributions in binary form must reproduce the above copyright notice, this
Kojto 148:fd96258d940d 11 * list of conditions and the following disclaimer in the documentation and/or
Kojto 148:fd96258d940d 12 * other materials provided with the distribution.
Kojto 148:fd96258d940d 13 *
Kojto 148:fd96258d940d 14 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
Kojto 148:fd96258d940d 15 * contributors may be used to endorse or promote products derived from this
Kojto 148:fd96258d940d 16 * software without specific prior written permission.
Kojto 148:fd96258d940d 17 *
Kojto 148:fd96258d940d 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Kojto 148:fd96258d940d 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Kojto 148:fd96258d940d 20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 148:fd96258d940d 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Kojto 148:fd96258d940d 22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Kojto 148:fd96258d940d 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Kojto 148:fd96258d940d 24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Kojto 148:fd96258d940d 25 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Kojto 148:fd96258d940d 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Kojto 148:fd96258d940d 27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 148:fd96258d940d 28 */
Kojto 148:fd96258d940d 29 #ifndef _FSL_I2S_DMA_H_
Kojto 148:fd96258d940d 30 #define _FSL_I2S_DMA_H_
Kojto 148:fd96258d940d 31
Kojto 148:fd96258d940d 32 #include "fsl_device_registers.h"
Kojto 148:fd96258d940d 33 #include "fsl_common.h"
Kojto 148:fd96258d940d 34 #include "fsl_flexcomm.h"
Kojto 148:fd96258d940d 35
Kojto 148:fd96258d940d 36 #include "fsl_dma.h"
Kojto 148:fd96258d940d 37 #include "fsl_i2s.h"
Kojto 148:fd96258d940d 38
Kojto 148:fd96258d940d 39 /*******************************************************************************
Kojto 148:fd96258d940d 40 * Definitions
Kojto 148:fd96258d940d 41 ******************************************************************************/
Kojto 148:fd96258d940d 42
Kojto 148:fd96258d940d 43 /*!
Kojto 148:fd96258d940d 44 * @addtogroup i2s_dma_driver
Kojto 148:fd96258d940d 45 * @{
Kojto 148:fd96258d940d 46 */
Kojto 148:fd96258d940d 47
Kojto 148:fd96258d940d 48 /*! @file */
Kojto 148:fd96258d940d 49
Kojto 148:fd96258d940d 50 /*! @name Driver version */
Kojto 148:fd96258d940d 51 /*@{*/
Kojto 148:fd96258d940d 52 /*! @brief I2S DMA driver version 2.0.0.
Kojto 148:fd96258d940d 53 *
Kojto 148:fd96258d940d 54 * Current version: 2.0.0
Kojto 148:fd96258d940d 55 *
Kojto 148:fd96258d940d 56 * Change log:
Kojto 148:fd96258d940d 57 * - Version 2.0.0
Kojto 148:fd96258d940d 58 * - initial version
Kojto 148:fd96258d940d 59 */
Kojto 148:fd96258d940d 60 #define FSL_I2S_DMA_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
Kojto 148:fd96258d940d 61 /*@}*/
Kojto 148:fd96258d940d 62
Kojto 148:fd96258d940d 63 /*! @brief Members not to be accessed / modified outside of the driver. */
Kojto 148:fd96258d940d 64 typedef struct _i2s_dma_handle i2s_dma_handle_t;
Kojto 148:fd96258d940d 65
Kojto 148:fd96258d940d 66 /*!
Kojto 148:fd96258d940d 67 * @brief Callback function invoked from DMA API on completion.
Kojto 148:fd96258d940d 68 *
Kojto 148:fd96258d940d 69 * @param base I2S base pointer.
Kojto 148:fd96258d940d 70 * @param handle pointer to I2S transaction.
Kojto 148:fd96258d940d 71 * @param completionStatus status of the transaction.
Kojto 148:fd96258d940d 72 * @param userData optional pointer to user arguments data.
Kojto 148:fd96258d940d 73 */
Kojto 148:fd96258d940d 74 typedef void (*i2s_dma_transfer_callback_t)(I2S_Type *base,
Kojto 148:fd96258d940d 75 i2s_dma_handle_t *handle,
Kojto 148:fd96258d940d 76 status_t completionStatus,
Kojto 148:fd96258d940d 77 void *userData);
Kojto 148:fd96258d940d 78
Kojto 148:fd96258d940d 79 struct _i2s_dma_handle
Kojto 148:fd96258d940d 80 {
Kojto 148:fd96258d940d 81 uint32_t state; /*!< Internal state of I2S DMA transfer */
Kojto 148:fd96258d940d 82 i2s_dma_transfer_callback_t completionCallback; /*!< Callback function pointer */
Kojto 148:fd96258d940d 83 void *userData; /*!< Application data passed to callback */
Kojto 148:fd96258d940d 84 dma_handle_t *dmaHandle; /*!< DMA handle */
Kojto 148:fd96258d940d 85 volatile i2s_transfer_t i2sQueue[I2S_NUM_BUFFERS]; /*!< Transfer queue storing transfer buffers */
Kojto 148:fd96258d940d 86 volatile uint8_t queueUser; /*!< Queue index where user's next transfer will be stored */
Kojto 148:fd96258d940d 87 volatile uint8_t queueDriver; /*!< Queue index of buffer actually used by the driver */
Kojto 148:fd96258d940d 88 };
Kojto 148:fd96258d940d 89
Kojto 148:fd96258d940d 90 /*******************************************************************************
Kojto 148:fd96258d940d 91 * API
Kojto 148:fd96258d940d 92 ******************************************************************************/
Kojto 148:fd96258d940d 93
Kojto 148:fd96258d940d 94 #if defined(__cplusplus)
Kojto 148:fd96258d940d 95 extern "C" {
Kojto 148:fd96258d940d 96 #endif
Kojto 148:fd96258d940d 97
Kojto 148:fd96258d940d 98 /*!
Kojto 148:fd96258d940d 99 * @name Initialization and deinitialization
Kojto 148:fd96258d940d 100 * @{
Kojto 148:fd96258d940d 101 */
Kojto 148:fd96258d940d 102
Kojto 148:fd96258d940d 103 /*! @} */
Kojto 148:fd96258d940d 104
Kojto 148:fd96258d940d 105 /*!
Kojto 148:fd96258d940d 106 * @name DMA API
Kojto 148:fd96258d940d 107 * @{
Kojto 148:fd96258d940d 108 */
Kojto 148:fd96258d940d 109
Kojto 148:fd96258d940d 110 /*!
Kojto 148:fd96258d940d 111 * @brief Initializes handle for transfer of audio data.
Kojto 148:fd96258d940d 112 *
Kojto 148:fd96258d940d 113 * @param base I2S base pointer.
Kojto 148:fd96258d940d 114 * @param handle pointer to handle structure.
Kojto 148:fd96258d940d 115 * @param dmaHandle pointer to dma handle structure.
Kojto 148:fd96258d940d 116 * @param callback function to be called back when transfer is done or fails.
Kojto 148:fd96258d940d 117 * @param userData pointer to data passed to callback.
Kojto 148:fd96258d940d 118 */
Kojto 148:fd96258d940d 119 void I2S_TxTransferCreateHandleDMA(I2S_Type *base,
Kojto 148:fd96258d940d 120 i2s_dma_handle_t *handle,
Kojto 148:fd96258d940d 121 dma_handle_t *dmaHandle,
Kojto 148:fd96258d940d 122 i2s_dma_transfer_callback_t callback,
Kojto 148:fd96258d940d 123 void *userData);
Kojto 148:fd96258d940d 124
Kojto 148:fd96258d940d 125 /*!
Kojto 148:fd96258d940d 126 * @brief Begins or queue sending of the given data.
Kojto 148:fd96258d940d 127 *
Kojto 148:fd96258d940d 128 * @param base I2S base pointer.
Kojto 148:fd96258d940d 129 * @param handle pointer to handle structure.
Kojto 148:fd96258d940d 130 * @param transfer data buffer.
Kojto 148:fd96258d940d 131 *
Kojto 148:fd96258d940d 132 * @retval kStatus_Success
Kojto 148:fd96258d940d 133 * @retval kStatus_I2S_Busy if all queue slots are occupied with unsent buffers.
Kojto 148:fd96258d940d 134 */
Kojto 148:fd96258d940d 135 status_t I2S_TxTransferSendDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t transfer);
Kojto 148:fd96258d940d 136
Kojto 148:fd96258d940d 137 /*!
Kojto 148:fd96258d940d 138 * @brief Aborts transfer of data.
Kojto 148:fd96258d940d 139 *
Kojto 148:fd96258d940d 140 * @param base I2S base pointer.
Kojto 148:fd96258d940d 141 * @param handle pointer to handle structure.
Kojto 148:fd96258d940d 142 */
Kojto 148:fd96258d940d 143 void I2S_TransferAbortDMA(I2S_Type *base, i2s_dma_handle_t *handle);
Kojto 148:fd96258d940d 144
Kojto 148:fd96258d940d 145 /*!
Kojto 148:fd96258d940d 146 * @brief Initializes handle for reception of audio data.
Kojto 148:fd96258d940d 147 *
Kojto 148:fd96258d940d 148 * @param base I2S base pointer.
Kojto 148:fd96258d940d 149 * @param handle pointer to handle structure.
Kojto 148:fd96258d940d 150 * @param dmaHandle pointer to dma handle structure.
Kojto 148:fd96258d940d 151 * @param callback function to be called back when transfer is done or fails.
Kojto 148:fd96258d940d 152 * @param userData pointer to data passed to callback.
Kojto 148:fd96258d940d 153 */
Kojto 148:fd96258d940d 154 void I2S_RxTransferCreateHandleDMA(I2S_Type *base,
Kojto 148:fd96258d940d 155 i2s_dma_handle_t *handle,
Kojto 148:fd96258d940d 156 dma_handle_t *dmaHandle,
Kojto 148:fd96258d940d 157 i2s_dma_transfer_callback_t callback,
Kojto 148:fd96258d940d 158 void *userData);
Kojto 148:fd96258d940d 159
Kojto 148:fd96258d940d 160 /*!
Kojto 148:fd96258d940d 161 * @brief Begins or queue reception of data into given buffer.
Kojto 148:fd96258d940d 162 *
Kojto 148:fd96258d940d 163 * @param base I2S base pointer.
Kojto 148:fd96258d940d 164 * @param handle pointer to handle structure.
Kojto 148:fd96258d940d 165 * @param transfer data buffer.
Kojto 148:fd96258d940d 166 *
Kojto 148:fd96258d940d 167 * @retval kStatus_Success
Kojto 148:fd96258d940d 168 * @retval kStatus_I2S_Busy if all queue slots are occupied with buffers
Kojto 148:fd96258d940d 169 * which are not full.
Kojto 148:fd96258d940d 170 */
Kojto 148:fd96258d940d 171 status_t I2S_RxTransferReceiveDMA(I2S_Type *base, i2s_dma_handle_t *handle, i2s_transfer_t transfer);
Kojto 148:fd96258d940d 172
Kojto 148:fd96258d940d 173 /*!
Kojto 148:fd96258d940d 174 * @brief Invoked from DMA interrupt handler.
Kojto 148:fd96258d940d 175 *
Kojto 148:fd96258d940d 176 * @param handle pointer to DMA handle structure.
Kojto 148:fd96258d940d 177 * @param userData argument for user callback.
Kojto 148:fd96258d940d 178 * @param transferDone if transfer was done.
Kojto 148:fd96258d940d 179 * @param tcds
Kojto 148:fd96258d940d 180 */
Kojto 148:fd96258d940d 181 void I2S_DMACallback(dma_handle_t *handle, void *userData, bool transferDone, uint32_t tcds);
Kojto 148:fd96258d940d 182
Kojto 148:fd96258d940d 183 /*! @} */
Kojto 148:fd96258d940d 184
Kojto 148:fd96258d940d 185 /*! @} */
Kojto 148:fd96258d940d 186
Kojto 148:fd96258d940d 187 #if defined(__cplusplus)
Kojto 148:fd96258d940d 188 }
Kojto 148:fd96258d940d 189 #endif
Kojto 148:fd96258d940d 190
Kojto 148:fd96258d940d 191 #endif /* _FSL_I2S_DMA_H_ */