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_LPC546XX/TOOLCHAIN_IAR/fsl_i2s.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?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 171:3a7713b1edbc | 1 | /* |
AnnaBridge | 171:3a7713b1edbc | 2 | * The Clear BSD License |
AnnaBridge | 171:3a7713b1edbc | 3 | * Copyright (c) 2016, Freescale Semiconductor, Inc. |
AnnaBridge | 171:3a7713b1edbc | 4 | * Copyright 2016-2017 NXP |
AnnaBridge | 171:3a7713b1edbc | 5 | * All rights reserved. |
AnnaBridge | 171:3a7713b1edbc | 6 | * |
AnnaBridge | 171:3a7713b1edbc | 7 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 171:3a7713b1edbc | 8 | * are permitted (subject to the limitations in the disclaimer below) provided |
AnnaBridge | 171:3a7713b1edbc | 9 | * that the following conditions are met: |
AnnaBridge | 171:3a7713b1edbc | 10 | * |
AnnaBridge | 171:3a7713b1edbc | 11 | * o Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 171:3a7713b1edbc | 12 | * of conditions and the following disclaimer. |
AnnaBridge | 171:3a7713b1edbc | 13 | * |
AnnaBridge | 171:3a7713b1edbc | 14 | * o Redistributions in binary form must reproduce the above copyright notice, this |
AnnaBridge | 171:3a7713b1edbc | 15 | * list of conditions and the following disclaimer in the documentation and/or |
AnnaBridge | 171:3a7713b1edbc | 16 | * other materials provided with the distribution. |
AnnaBridge | 171:3a7713b1edbc | 17 | * |
AnnaBridge | 171:3a7713b1edbc | 18 | * o Neither the name of the copyright holder nor the names of its |
AnnaBridge | 171:3a7713b1edbc | 19 | * contributors may be used to endorse or promote products derived from this |
AnnaBridge | 171:3a7713b1edbc | 20 | * software without specific prior written permission. |
AnnaBridge | 171:3a7713b1edbc | 21 | * |
AnnaBridge | 171:3a7713b1edbc | 22 | * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. |
AnnaBridge | 171:3a7713b1edbc | 23 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 171:3a7713b1edbc | 24 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 171:3a7713b1edbc | 25 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 171:3a7713b1edbc | 26 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 171:3a7713b1edbc | 27 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 171:3a7713b1edbc | 28 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 171:3a7713b1edbc | 29 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 171:3a7713b1edbc | 30 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 171:3a7713b1edbc | 31 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 171:3a7713b1edbc | 32 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 171:3a7713b1edbc | 33 | */ |
AnnaBridge | 171:3a7713b1edbc | 34 | #ifndef _FSL_I2S_H_ |
AnnaBridge | 171:3a7713b1edbc | 35 | #define _FSL_I2S_H_ |
AnnaBridge | 171:3a7713b1edbc | 36 | |
AnnaBridge | 171:3a7713b1edbc | 37 | #include "fsl_device_registers.h" |
AnnaBridge | 171:3a7713b1edbc | 38 | #include "fsl_common.h" |
AnnaBridge | 171:3a7713b1edbc | 39 | #include "fsl_flexcomm.h" |
AnnaBridge | 171:3a7713b1edbc | 40 | |
AnnaBridge | 171:3a7713b1edbc | 41 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 42 | * Definitions |
AnnaBridge | 171:3a7713b1edbc | 43 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 44 | |
AnnaBridge | 171:3a7713b1edbc | 45 | /*! |
AnnaBridge | 171:3a7713b1edbc | 46 | * @addtogroup i2s_driver |
AnnaBridge | 171:3a7713b1edbc | 47 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 48 | */ |
AnnaBridge | 171:3a7713b1edbc | 49 | |
AnnaBridge | 171:3a7713b1edbc | 50 | /*! @file */ |
AnnaBridge | 171:3a7713b1edbc | 51 | |
AnnaBridge | 171:3a7713b1edbc | 52 | /*! @name Driver version */ |
AnnaBridge | 171:3a7713b1edbc | 53 | /*@{*/ |
AnnaBridge | 171:3a7713b1edbc | 54 | /*! @brief I2S driver version 2.0.0. |
AnnaBridge | 171:3a7713b1edbc | 55 | * |
AnnaBridge | 171:3a7713b1edbc | 56 | * Current version: 2.0.0 |
AnnaBridge | 171:3a7713b1edbc | 57 | * |
AnnaBridge | 171:3a7713b1edbc | 58 | * Change log: |
AnnaBridge | 171:3a7713b1edbc | 59 | * - Version 2.0.0 |
AnnaBridge | 171:3a7713b1edbc | 60 | * - initial version |
AnnaBridge | 171:3a7713b1edbc | 61 | */ |
AnnaBridge | 171:3a7713b1edbc | 62 | #define FSL_I2S_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) |
AnnaBridge | 171:3a7713b1edbc | 63 | /*@}*/ |
AnnaBridge | 171:3a7713b1edbc | 64 | |
AnnaBridge | 171:3a7713b1edbc | 65 | #ifndef I2S_NUM_BUFFERS |
AnnaBridge | 171:3a7713b1edbc | 66 | |
AnnaBridge | 171:3a7713b1edbc | 67 | /*! @brief Number of buffers . */ |
AnnaBridge | 171:3a7713b1edbc | 68 | #define I2S_NUM_BUFFERS (4) |
AnnaBridge | 171:3a7713b1edbc | 69 | |
AnnaBridge | 171:3a7713b1edbc | 70 | #endif |
AnnaBridge | 171:3a7713b1edbc | 71 | |
AnnaBridge | 171:3a7713b1edbc | 72 | /*! @brief I2S status codes. */ |
AnnaBridge | 171:3a7713b1edbc | 73 | enum _i2s_status |
AnnaBridge | 171:3a7713b1edbc | 74 | { |
AnnaBridge | 171:3a7713b1edbc | 75 | kStatus_I2S_BufferComplete = |
AnnaBridge | 171:3a7713b1edbc | 76 | MAKE_STATUS(kStatusGroup_I2S, 0), /*!< Transfer from/into a single buffer has completed */ |
AnnaBridge | 171:3a7713b1edbc | 77 | kStatus_I2S_Done = MAKE_STATUS(kStatusGroup_I2S, 1), /*!< All buffers transfers have completed */ |
AnnaBridge | 171:3a7713b1edbc | 78 | kStatus_I2S_Busy = |
AnnaBridge | 171:3a7713b1edbc | 79 | MAKE_STATUS(kStatusGroup_I2S, 2), /*!< Already performing a transfer and cannot queue another buffer */ |
AnnaBridge | 171:3a7713b1edbc | 80 | }; |
AnnaBridge | 171:3a7713b1edbc | 81 | |
AnnaBridge | 171:3a7713b1edbc | 82 | /*! |
AnnaBridge | 171:3a7713b1edbc | 83 | * @brief I2S flags. |
AnnaBridge | 171:3a7713b1edbc | 84 | * |
AnnaBridge | 171:3a7713b1edbc | 85 | * @note These enums are meant to be OR'd together to form a bit mask. |
AnnaBridge | 171:3a7713b1edbc | 86 | */ |
AnnaBridge | 171:3a7713b1edbc | 87 | typedef enum _i2s_flags |
AnnaBridge | 171:3a7713b1edbc | 88 | { |
AnnaBridge | 171:3a7713b1edbc | 89 | kI2S_TxErrorFlag = I2S_FIFOINTENSET_TXERR_MASK, /*!< TX error interrupt */ |
AnnaBridge | 171:3a7713b1edbc | 90 | kI2S_TxLevelFlag = I2S_FIFOINTENSET_TXLVL_MASK, /*!< TX level interrupt */ |
AnnaBridge | 171:3a7713b1edbc | 91 | kI2S_RxErrorFlag = I2S_FIFOINTENSET_RXERR_MASK, /*!< RX error interrupt */ |
AnnaBridge | 171:3a7713b1edbc | 92 | kI2S_RxLevelFlag = I2S_FIFOINTENSET_RXLVL_MASK /*!< RX level interrupt */ |
AnnaBridge | 171:3a7713b1edbc | 93 | } i2s_flags_t; |
AnnaBridge | 171:3a7713b1edbc | 94 | |
AnnaBridge | 171:3a7713b1edbc | 95 | /*! @brief Master / slave mode. */ |
AnnaBridge | 171:3a7713b1edbc | 96 | typedef enum _i2s_master_slave |
AnnaBridge | 171:3a7713b1edbc | 97 | { |
AnnaBridge | 171:3a7713b1edbc | 98 | kI2S_MasterSlaveNormalSlave = 0x0, /*!< Normal slave */ |
AnnaBridge | 171:3a7713b1edbc | 99 | kI2S_MasterSlaveWsSyncMaster = 0x1, /*!< WS synchronized master */ |
AnnaBridge | 171:3a7713b1edbc | 100 | kI2S_MasterSlaveExtSckMaster = 0x2, /*!< Master using existing SCK */ |
AnnaBridge | 171:3a7713b1edbc | 101 | kI2S_MasterSlaveNormalMaster = 0x3 /*!< Normal master */ |
AnnaBridge | 171:3a7713b1edbc | 102 | } i2s_master_slave_t; |
AnnaBridge | 171:3a7713b1edbc | 103 | |
AnnaBridge | 171:3a7713b1edbc | 104 | /*! @brief I2S mode. */ |
AnnaBridge | 171:3a7713b1edbc | 105 | typedef enum _i2s_mode |
AnnaBridge | 171:3a7713b1edbc | 106 | { |
AnnaBridge | 171:3a7713b1edbc | 107 | kI2S_ModeI2sClassic = 0x0, /*!< I2S classic mode */ |
AnnaBridge | 171:3a7713b1edbc | 108 | kI2S_ModeDspWs50 = 0x1, /*!< DSP mode, WS having 50% duty cycle */ |
AnnaBridge | 171:3a7713b1edbc | 109 | kI2S_ModeDspWsShort = 0x2, /*!< DSP mode, WS having one clock long pulse */ |
AnnaBridge | 171:3a7713b1edbc | 110 | kI2S_ModeDspWsLong = 0x3 /*!< DSP mode, WS having one data slot long pulse */ |
AnnaBridge | 171:3a7713b1edbc | 111 | } i2s_mode_t; |
AnnaBridge | 171:3a7713b1edbc | 112 | |
AnnaBridge | 171:3a7713b1edbc | 113 | /*! @brief I2S configuration structure. */ |
AnnaBridge | 171:3a7713b1edbc | 114 | typedef struct _i2s_config |
AnnaBridge | 171:3a7713b1edbc | 115 | { |
AnnaBridge | 171:3a7713b1edbc | 116 | i2s_master_slave_t masterSlave; /*!< Master / slave configuration */ |
AnnaBridge | 171:3a7713b1edbc | 117 | i2s_mode_t mode; /*!< I2S mode */ |
AnnaBridge | 171:3a7713b1edbc | 118 | bool rightLow; /*!< Right channel data in low portion of FIFO */ |
AnnaBridge | 171:3a7713b1edbc | 119 | bool leftJust; /*!< Left justify data in FIFO */ |
AnnaBridge | 171:3a7713b1edbc | 120 | bool pdmData; /*!< Data source is the D-Mic subsystem */ |
AnnaBridge | 171:3a7713b1edbc | 121 | bool sckPol; /*!< SCK polarity */ |
AnnaBridge | 171:3a7713b1edbc | 122 | bool wsPol; /*!< WS polarity */ |
AnnaBridge | 171:3a7713b1edbc | 123 | uint16_t divider; /*!< Flexcomm function clock divider (1 - 4096) */ |
AnnaBridge | 171:3a7713b1edbc | 124 | bool oneChannel; /*!< true mono, false stereo */ |
AnnaBridge | 171:3a7713b1edbc | 125 | uint8_t dataLength; /*!< Data length (4 - 32) */ |
AnnaBridge | 171:3a7713b1edbc | 126 | uint16_t frameLength; /*!< Frame width (4 - 512) */ |
AnnaBridge | 171:3a7713b1edbc | 127 | uint16_t position; /*!< Data position in the frame */ |
AnnaBridge | 171:3a7713b1edbc | 128 | uint8_t watermark; /*!< FIFO trigger level */ |
AnnaBridge | 171:3a7713b1edbc | 129 | bool txEmptyZero; /*!< Transmit zero when buffer becomes empty or last item */ |
AnnaBridge | 171:3a7713b1edbc | 130 | bool pack48; /*!< Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit |
AnnaBridge | 171:3a7713b1edbc | 131 | values) */ |
AnnaBridge | 171:3a7713b1edbc | 132 | } i2s_config_t; |
AnnaBridge | 171:3a7713b1edbc | 133 | |
AnnaBridge | 171:3a7713b1edbc | 134 | /*! @brief Buffer to transfer from or receive audio data into. */ |
AnnaBridge | 171:3a7713b1edbc | 135 | typedef struct _i2s_transfer |
AnnaBridge | 171:3a7713b1edbc | 136 | { |
AnnaBridge | 171:3a7713b1edbc | 137 | volatile uint8_t *data; /*!< Pointer to data buffer. */ |
AnnaBridge | 171:3a7713b1edbc | 138 | volatile size_t dataSize; /*!< Buffer size in bytes. */ |
AnnaBridge | 171:3a7713b1edbc | 139 | } i2s_transfer_t; |
AnnaBridge | 171:3a7713b1edbc | 140 | |
AnnaBridge | 171:3a7713b1edbc | 141 | /*! @brief Transactional state of the intialized transfer or receive I2S operation. */ |
AnnaBridge | 171:3a7713b1edbc | 142 | typedef struct _i2s_handle i2s_handle_t; |
AnnaBridge | 171:3a7713b1edbc | 143 | |
AnnaBridge | 171:3a7713b1edbc | 144 | /*! |
AnnaBridge | 171:3a7713b1edbc | 145 | * @brief Callback function invoked from transactional API |
AnnaBridge | 171:3a7713b1edbc | 146 | * on completion of a single buffer transfer. |
AnnaBridge | 171:3a7713b1edbc | 147 | * |
AnnaBridge | 171:3a7713b1edbc | 148 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 149 | * @param handle pointer to I2S transaction. |
AnnaBridge | 171:3a7713b1edbc | 150 | * @param completionStatus status of the transaction. |
AnnaBridge | 171:3a7713b1edbc | 151 | * @param userData optional pointer to user arguments data. |
AnnaBridge | 171:3a7713b1edbc | 152 | */ |
AnnaBridge | 171:3a7713b1edbc | 153 | typedef void (*i2s_transfer_callback_t)(I2S_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 154 | i2s_handle_t *handle, |
AnnaBridge | 171:3a7713b1edbc | 155 | status_t completionStatus, |
AnnaBridge | 171:3a7713b1edbc | 156 | void *userData); |
AnnaBridge | 171:3a7713b1edbc | 157 | |
AnnaBridge | 171:3a7713b1edbc | 158 | /*! @brief Members not to be accessed / modified outside of the driver. */ |
AnnaBridge | 171:3a7713b1edbc | 159 | struct _i2s_handle |
AnnaBridge | 171:3a7713b1edbc | 160 | { |
AnnaBridge | 171:3a7713b1edbc | 161 | uint32_t state; /*!< State of transfer */ |
AnnaBridge | 171:3a7713b1edbc | 162 | i2s_transfer_callback_t completionCallback; /*!< Callback function pointer */ |
AnnaBridge | 171:3a7713b1edbc | 163 | void *userData; /*!< Application data passed to callback */ |
AnnaBridge | 171:3a7713b1edbc | 164 | bool oneChannel; /*!< true mono, false stereo */ |
AnnaBridge | 171:3a7713b1edbc | 165 | uint8_t dataLength; /*!< Data length (4 - 32) */ |
AnnaBridge | 171:3a7713b1edbc | 166 | bool pack48; /*!< Packing format for 48-bit data (false - 24 bit values, true - alternating 32-bit and 16-bit |
AnnaBridge | 171:3a7713b1edbc | 167 | values) */ |
AnnaBridge | 171:3a7713b1edbc | 168 | bool useFifo48H; /*!< When dataLength 17-24: true use FIFOWR48H, false use FIFOWR */ |
AnnaBridge | 171:3a7713b1edbc | 169 | volatile i2s_transfer_t i2sQueue[I2S_NUM_BUFFERS]; /*!< Transfer queue storing transfer buffers */ |
AnnaBridge | 171:3a7713b1edbc | 170 | volatile uint8_t queueUser; /*!< Queue index where user's next transfer will be stored */ |
AnnaBridge | 171:3a7713b1edbc | 171 | volatile uint8_t queueDriver; /*!< Queue index of buffer actually used by the driver */ |
AnnaBridge | 171:3a7713b1edbc | 172 | volatile uint32_t errorCount; /*!< Number of buffer underruns/overruns */ |
AnnaBridge | 171:3a7713b1edbc | 173 | volatile uint32_t transferCount; /*!< Number of bytes transferred */ |
AnnaBridge | 171:3a7713b1edbc | 174 | volatile uint8_t watermark; /*!< FIFO trigger level */ |
AnnaBridge | 171:3a7713b1edbc | 175 | }; |
AnnaBridge | 171:3a7713b1edbc | 176 | |
AnnaBridge | 171:3a7713b1edbc | 177 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 178 | * API |
AnnaBridge | 171:3a7713b1edbc | 179 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 180 | |
AnnaBridge | 171:3a7713b1edbc | 181 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 182 | extern "C" { |
AnnaBridge | 171:3a7713b1edbc | 183 | #endif |
AnnaBridge | 171:3a7713b1edbc | 184 | |
AnnaBridge | 171:3a7713b1edbc | 185 | /*! |
AnnaBridge | 171:3a7713b1edbc | 186 | * @name Initialization and deinitialization |
AnnaBridge | 171:3a7713b1edbc | 187 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 188 | */ |
AnnaBridge | 171:3a7713b1edbc | 189 | |
AnnaBridge | 171:3a7713b1edbc | 190 | /*! |
AnnaBridge | 171:3a7713b1edbc | 191 | * @brief Initializes the FLEXCOMM peripheral for I2S transmit functionality. |
AnnaBridge | 171:3a7713b1edbc | 192 | * |
AnnaBridge | 171:3a7713b1edbc | 193 | * Ungates the FLEXCOMM clock and configures the module |
AnnaBridge | 171:3a7713b1edbc | 194 | * for I2S transmission using a configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 195 | * The configuration structure can be custom filled or set with default values by |
AnnaBridge | 171:3a7713b1edbc | 196 | * I2S_TxGetDefaultConfig(). |
AnnaBridge | 171:3a7713b1edbc | 197 | * |
AnnaBridge | 171:3a7713b1edbc | 198 | * @note This API should be called at the beginning of the application to use |
AnnaBridge | 171:3a7713b1edbc | 199 | * the I2S driver. |
AnnaBridge | 171:3a7713b1edbc | 200 | * |
AnnaBridge | 171:3a7713b1edbc | 201 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 202 | * @param config pointer to I2S configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 203 | */ |
AnnaBridge | 171:3a7713b1edbc | 204 | void I2S_TxInit(I2S_Type *base, const i2s_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 205 | |
AnnaBridge | 171:3a7713b1edbc | 206 | /*! |
AnnaBridge | 171:3a7713b1edbc | 207 | * @brief Initializes the FLEXCOMM peripheral for I2S receive functionality. |
AnnaBridge | 171:3a7713b1edbc | 208 | * |
AnnaBridge | 171:3a7713b1edbc | 209 | * Ungates the FLEXCOMM clock and configures the module |
AnnaBridge | 171:3a7713b1edbc | 210 | * for I2S receive using a configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 211 | * The configuration structure can be custom filled or set with default values by |
AnnaBridge | 171:3a7713b1edbc | 212 | * I2S_RxGetDefaultConfig(). |
AnnaBridge | 171:3a7713b1edbc | 213 | * |
AnnaBridge | 171:3a7713b1edbc | 214 | * @note This API should be called at the beginning of the application to use |
AnnaBridge | 171:3a7713b1edbc | 215 | * the I2S driver. |
AnnaBridge | 171:3a7713b1edbc | 216 | * |
AnnaBridge | 171:3a7713b1edbc | 217 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 218 | * @param config pointer to I2S configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 219 | */ |
AnnaBridge | 171:3a7713b1edbc | 220 | void I2S_RxInit(I2S_Type *base, const i2s_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 221 | |
AnnaBridge | 171:3a7713b1edbc | 222 | /*! |
AnnaBridge | 171:3a7713b1edbc | 223 | * @brief Sets the I2S Tx configuration structure to default values. |
AnnaBridge | 171:3a7713b1edbc | 224 | * |
AnnaBridge | 171:3a7713b1edbc | 225 | * This API initializes the configuration structure for use in I2S_TxInit(). |
AnnaBridge | 171:3a7713b1edbc | 226 | * The initialized structure can remain unchanged in I2S_TxInit(), or it can be modified |
AnnaBridge | 171:3a7713b1edbc | 227 | * before calling I2S_TxInit(). |
AnnaBridge | 171:3a7713b1edbc | 228 | * Example: |
AnnaBridge | 171:3a7713b1edbc | 229 | @code |
AnnaBridge | 171:3a7713b1edbc | 230 | i2s_config_t config; |
AnnaBridge | 171:3a7713b1edbc | 231 | I2S_TxGetDefaultConfig(&config); |
AnnaBridge | 171:3a7713b1edbc | 232 | @endcode |
AnnaBridge | 171:3a7713b1edbc | 233 | * |
AnnaBridge | 171:3a7713b1edbc | 234 | * Default values: |
AnnaBridge | 171:3a7713b1edbc | 235 | * @code |
AnnaBridge | 171:3a7713b1edbc | 236 | * config->masterSlave = kI2S_MasterSlaveNormalMaster; |
AnnaBridge | 171:3a7713b1edbc | 237 | * config->mode = kI2S_ModeI2sClassic; |
AnnaBridge | 171:3a7713b1edbc | 238 | * config->rightLow = false; |
AnnaBridge | 171:3a7713b1edbc | 239 | * config->leftJust = false; |
AnnaBridge | 171:3a7713b1edbc | 240 | * config->pdmData = false; |
AnnaBridge | 171:3a7713b1edbc | 241 | * config->sckPol = false; |
AnnaBridge | 171:3a7713b1edbc | 242 | * config->wsPol = false; |
AnnaBridge | 171:3a7713b1edbc | 243 | * config->divider = 1; |
AnnaBridge | 171:3a7713b1edbc | 244 | * config->oneChannel = false; |
AnnaBridge | 171:3a7713b1edbc | 245 | * config->dataLength = 16; |
AnnaBridge | 171:3a7713b1edbc | 246 | * config->frameLength = 32; |
AnnaBridge | 171:3a7713b1edbc | 247 | * config->position = 0; |
AnnaBridge | 171:3a7713b1edbc | 248 | * config->watermark = 4; |
AnnaBridge | 171:3a7713b1edbc | 249 | * config->txEmptyZero = true; |
AnnaBridge | 171:3a7713b1edbc | 250 | * config->pack48 = false; |
AnnaBridge | 171:3a7713b1edbc | 251 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 252 | * |
AnnaBridge | 171:3a7713b1edbc | 253 | * @param config pointer to I2S configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 254 | */ |
AnnaBridge | 171:3a7713b1edbc | 255 | void I2S_TxGetDefaultConfig(i2s_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 256 | |
AnnaBridge | 171:3a7713b1edbc | 257 | /*! |
AnnaBridge | 171:3a7713b1edbc | 258 | * @brief Sets the I2S Rx configuration structure to default values. |
AnnaBridge | 171:3a7713b1edbc | 259 | * |
AnnaBridge | 171:3a7713b1edbc | 260 | * This API initializes the configuration structure for use in I2S_RxInit(). |
AnnaBridge | 171:3a7713b1edbc | 261 | * The initialized structure can remain unchanged in I2S_RxInit(), or it can be modified |
AnnaBridge | 171:3a7713b1edbc | 262 | * before calling I2S_RxInit(). |
AnnaBridge | 171:3a7713b1edbc | 263 | * Example: |
AnnaBridge | 171:3a7713b1edbc | 264 | @code |
AnnaBridge | 171:3a7713b1edbc | 265 | i2s_config_t config; |
AnnaBridge | 171:3a7713b1edbc | 266 | I2S_RxGetDefaultConfig(&config); |
AnnaBridge | 171:3a7713b1edbc | 267 | @endcode |
AnnaBridge | 171:3a7713b1edbc | 268 | * |
AnnaBridge | 171:3a7713b1edbc | 269 | * Default values: |
AnnaBridge | 171:3a7713b1edbc | 270 | * @code |
AnnaBridge | 171:3a7713b1edbc | 271 | * config->masterSlave = kI2S_MasterSlaveNormalSlave; |
AnnaBridge | 171:3a7713b1edbc | 272 | * config->mode = kI2S_ModeI2sClassic; |
AnnaBridge | 171:3a7713b1edbc | 273 | * config->rightLow = false; |
AnnaBridge | 171:3a7713b1edbc | 274 | * config->leftJust = false; |
AnnaBridge | 171:3a7713b1edbc | 275 | * config->pdmData = false; |
AnnaBridge | 171:3a7713b1edbc | 276 | * config->sckPol = false; |
AnnaBridge | 171:3a7713b1edbc | 277 | * config->wsPol = false; |
AnnaBridge | 171:3a7713b1edbc | 278 | * config->divider = 1; |
AnnaBridge | 171:3a7713b1edbc | 279 | * config->oneChannel = false; |
AnnaBridge | 171:3a7713b1edbc | 280 | * config->dataLength = 16; |
AnnaBridge | 171:3a7713b1edbc | 281 | * config->frameLength = 32; |
AnnaBridge | 171:3a7713b1edbc | 282 | * config->position = 0; |
AnnaBridge | 171:3a7713b1edbc | 283 | * config->watermark = 4; |
AnnaBridge | 171:3a7713b1edbc | 284 | * config->txEmptyZero = false; |
AnnaBridge | 171:3a7713b1edbc | 285 | * config->pack48 = false; |
AnnaBridge | 171:3a7713b1edbc | 286 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 287 | * |
AnnaBridge | 171:3a7713b1edbc | 288 | * @param config pointer to I2S configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 289 | */ |
AnnaBridge | 171:3a7713b1edbc | 290 | void I2S_RxGetDefaultConfig(i2s_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 291 | |
AnnaBridge | 171:3a7713b1edbc | 292 | /*! |
AnnaBridge | 171:3a7713b1edbc | 293 | * @brief De-initializes the I2S peripheral. |
AnnaBridge | 171:3a7713b1edbc | 294 | * |
AnnaBridge | 171:3a7713b1edbc | 295 | * This API gates the FLEXCOMM clock. The I2S module can't operate unless I2S_TxInit |
AnnaBridge | 171:3a7713b1edbc | 296 | * or I2S_RxInit is called to enable the clock. |
AnnaBridge | 171:3a7713b1edbc | 297 | * |
AnnaBridge | 171:3a7713b1edbc | 298 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 299 | */ |
AnnaBridge | 171:3a7713b1edbc | 300 | void I2S_Deinit(I2S_Type *base); |
AnnaBridge | 171:3a7713b1edbc | 301 | |
AnnaBridge | 171:3a7713b1edbc | 302 | /*! @} */ |
AnnaBridge | 171:3a7713b1edbc | 303 | |
AnnaBridge | 171:3a7713b1edbc | 304 | /*! |
AnnaBridge | 171:3a7713b1edbc | 305 | * @name Non-blocking API |
AnnaBridge | 171:3a7713b1edbc | 306 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 307 | */ |
AnnaBridge | 171:3a7713b1edbc | 308 | |
AnnaBridge | 171:3a7713b1edbc | 309 | /*! |
AnnaBridge | 171:3a7713b1edbc | 310 | * @brief Initializes handle for transfer of audio data. |
AnnaBridge | 171:3a7713b1edbc | 311 | * |
AnnaBridge | 171:3a7713b1edbc | 312 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 313 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 314 | * @param callback function to be called back when transfer is done or fails. |
AnnaBridge | 171:3a7713b1edbc | 315 | * @param userData pointer to data passed to callback. |
AnnaBridge | 171:3a7713b1edbc | 316 | */ |
AnnaBridge | 171:3a7713b1edbc | 317 | void I2S_TxTransferCreateHandle(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_callback_t callback, void *userData); |
AnnaBridge | 171:3a7713b1edbc | 318 | |
AnnaBridge | 171:3a7713b1edbc | 319 | /*! |
AnnaBridge | 171:3a7713b1edbc | 320 | * @brief Begins or queue sending of the given data. |
AnnaBridge | 171:3a7713b1edbc | 321 | * |
AnnaBridge | 171:3a7713b1edbc | 322 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 323 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 324 | * @param transfer data buffer. |
AnnaBridge | 171:3a7713b1edbc | 325 | * |
AnnaBridge | 171:3a7713b1edbc | 326 | * @retval kStatus_Success |
AnnaBridge | 171:3a7713b1edbc | 327 | * @retval kStatus_I2S_Busy if all queue slots are occupied with unsent buffers. |
AnnaBridge | 171:3a7713b1edbc | 328 | */ |
AnnaBridge | 171:3a7713b1edbc | 329 | status_t I2S_TxTransferNonBlocking(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_t transfer); |
AnnaBridge | 171:3a7713b1edbc | 330 | |
AnnaBridge | 171:3a7713b1edbc | 331 | /*! |
AnnaBridge | 171:3a7713b1edbc | 332 | * @brief Aborts sending of data. |
AnnaBridge | 171:3a7713b1edbc | 333 | * |
AnnaBridge | 171:3a7713b1edbc | 334 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 335 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 336 | */ |
AnnaBridge | 171:3a7713b1edbc | 337 | void I2S_TxTransferAbort(I2S_Type *base, i2s_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 338 | |
AnnaBridge | 171:3a7713b1edbc | 339 | /*! |
AnnaBridge | 171:3a7713b1edbc | 340 | * @brief Initializes handle for reception of audio data. |
AnnaBridge | 171:3a7713b1edbc | 341 | * |
AnnaBridge | 171:3a7713b1edbc | 342 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 343 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 344 | * @param callback function to be called back when transfer is done or fails. |
AnnaBridge | 171:3a7713b1edbc | 345 | * @param userData pointer to data passed to callback. |
AnnaBridge | 171:3a7713b1edbc | 346 | */ |
AnnaBridge | 171:3a7713b1edbc | 347 | void I2S_RxTransferCreateHandle(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_callback_t callback, void *userData); |
AnnaBridge | 171:3a7713b1edbc | 348 | |
AnnaBridge | 171:3a7713b1edbc | 349 | /*! |
AnnaBridge | 171:3a7713b1edbc | 350 | * @brief Begins or queue reception of data into given buffer. |
AnnaBridge | 171:3a7713b1edbc | 351 | * |
AnnaBridge | 171:3a7713b1edbc | 352 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 353 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 354 | * @param transfer data buffer. |
AnnaBridge | 171:3a7713b1edbc | 355 | * |
AnnaBridge | 171:3a7713b1edbc | 356 | * @retval kStatus_Success |
AnnaBridge | 171:3a7713b1edbc | 357 | * @retval kStatus_I2S_Busy if all queue slots are occupied with buffers which are not full. |
AnnaBridge | 171:3a7713b1edbc | 358 | */ |
AnnaBridge | 171:3a7713b1edbc | 359 | status_t I2S_RxTransferNonBlocking(I2S_Type *base, i2s_handle_t *handle, i2s_transfer_t transfer); |
AnnaBridge | 171:3a7713b1edbc | 360 | |
AnnaBridge | 171:3a7713b1edbc | 361 | /*! |
AnnaBridge | 171:3a7713b1edbc | 362 | * @brief Aborts receiving of data. |
AnnaBridge | 171:3a7713b1edbc | 363 | * |
AnnaBridge | 171:3a7713b1edbc | 364 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 365 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 366 | */ |
AnnaBridge | 171:3a7713b1edbc | 367 | void I2S_RxTransferAbort(I2S_Type *base, i2s_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 368 | |
AnnaBridge | 171:3a7713b1edbc | 369 | /*! |
AnnaBridge | 171:3a7713b1edbc | 370 | * @brief Returns number of bytes transferred so far. |
AnnaBridge | 171:3a7713b1edbc | 371 | * |
AnnaBridge | 171:3a7713b1edbc | 372 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 373 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 374 | * @param[out] count number of bytes transferred so far by the non-blocking transaction. |
AnnaBridge | 171:3a7713b1edbc | 375 | * |
AnnaBridge | 171:3a7713b1edbc | 376 | * @retval kStatus_Success |
AnnaBridge | 171:3a7713b1edbc | 377 | * @retval kStatus_NoTransferInProgress there is no non-blocking transaction currently in progress. |
AnnaBridge | 171:3a7713b1edbc | 378 | */ |
AnnaBridge | 171:3a7713b1edbc | 379 | status_t I2S_TransferGetCount(I2S_Type *base, i2s_handle_t *handle, size_t *count); |
AnnaBridge | 171:3a7713b1edbc | 380 | |
AnnaBridge | 171:3a7713b1edbc | 381 | /*! |
AnnaBridge | 171:3a7713b1edbc | 382 | * @brief Returns number of buffer underruns or overruns. |
AnnaBridge | 171:3a7713b1edbc | 383 | * |
AnnaBridge | 171:3a7713b1edbc | 384 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 385 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 386 | * @param[out] count number of transmit errors encountered so far by the non-blocking transaction. |
AnnaBridge | 171:3a7713b1edbc | 387 | * |
AnnaBridge | 171:3a7713b1edbc | 388 | * @retval kStatus_Success |
AnnaBridge | 171:3a7713b1edbc | 389 | * @retval kStatus_NoTransferInProgress there is no non-blocking transaction currently in progress. |
AnnaBridge | 171:3a7713b1edbc | 390 | */ |
AnnaBridge | 171:3a7713b1edbc | 391 | status_t I2S_TransferGetErrorCount(I2S_Type *base, i2s_handle_t *handle, size_t *count); |
AnnaBridge | 171:3a7713b1edbc | 392 | |
AnnaBridge | 171:3a7713b1edbc | 393 | /*! @} */ |
AnnaBridge | 171:3a7713b1edbc | 394 | |
AnnaBridge | 171:3a7713b1edbc | 395 | /*! |
AnnaBridge | 171:3a7713b1edbc | 396 | * @name Enable / disable |
AnnaBridge | 171:3a7713b1edbc | 397 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 398 | */ |
AnnaBridge | 171:3a7713b1edbc | 399 | |
AnnaBridge | 171:3a7713b1edbc | 400 | /*! |
AnnaBridge | 171:3a7713b1edbc | 401 | * @brief Enables I2S operation. |
AnnaBridge | 171:3a7713b1edbc | 402 | * |
AnnaBridge | 171:3a7713b1edbc | 403 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 404 | */ |
AnnaBridge | 171:3a7713b1edbc | 405 | static inline void I2S_Enable(I2S_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 406 | { |
AnnaBridge | 171:3a7713b1edbc | 407 | base->CFG1 |= I2S_CFG1_MAINENABLE(1U); |
AnnaBridge | 171:3a7713b1edbc | 408 | } |
AnnaBridge | 171:3a7713b1edbc | 409 | |
AnnaBridge | 171:3a7713b1edbc | 410 | /*! |
AnnaBridge | 171:3a7713b1edbc | 411 | * @brief Disables I2S operation. |
AnnaBridge | 171:3a7713b1edbc | 412 | * |
AnnaBridge | 171:3a7713b1edbc | 413 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 414 | */ |
AnnaBridge | 171:3a7713b1edbc | 415 | static inline void I2S_Disable(I2S_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 416 | { |
AnnaBridge | 171:3a7713b1edbc | 417 | base->CFG1 &= (~I2S_CFG1_MAINENABLE(1U)); |
AnnaBridge | 171:3a7713b1edbc | 418 | } |
AnnaBridge | 171:3a7713b1edbc | 419 | |
AnnaBridge | 171:3a7713b1edbc | 420 | /*! @} */ |
AnnaBridge | 171:3a7713b1edbc | 421 | |
AnnaBridge | 171:3a7713b1edbc | 422 | /*! |
AnnaBridge | 171:3a7713b1edbc | 423 | * @name Interrupts |
AnnaBridge | 171:3a7713b1edbc | 424 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 425 | */ |
AnnaBridge | 171:3a7713b1edbc | 426 | |
AnnaBridge | 171:3a7713b1edbc | 427 | /*! |
AnnaBridge | 171:3a7713b1edbc | 428 | * @brief Enables I2S FIFO interrupts. |
AnnaBridge | 171:3a7713b1edbc | 429 | * |
AnnaBridge | 171:3a7713b1edbc | 430 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 431 | * @param interruptMask bit mask of interrupts to enable. See #i2s_flags_t for the set |
AnnaBridge | 171:3a7713b1edbc | 432 | * of constants that should be OR'd together to form the bit mask. |
AnnaBridge | 171:3a7713b1edbc | 433 | */ |
AnnaBridge | 171:3a7713b1edbc | 434 | static inline void I2S_EnableInterrupts(I2S_Type *base, uint32_t interruptMask) |
AnnaBridge | 171:3a7713b1edbc | 435 | { |
AnnaBridge | 171:3a7713b1edbc | 436 | base->FIFOINTENSET = interruptMask; |
AnnaBridge | 171:3a7713b1edbc | 437 | } |
AnnaBridge | 171:3a7713b1edbc | 438 | |
AnnaBridge | 171:3a7713b1edbc | 439 | /*! |
AnnaBridge | 171:3a7713b1edbc | 440 | * @brief Disables I2S FIFO interrupts. |
AnnaBridge | 171:3a7713b1edbc | 441 | * |
AnnaBridge | 171:3a7713b1edbc | 442 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 443 | * @param interruptMask bit mask of interrupts to enable. See #i2s_flags_t for the set |
AnnaBridge | 171:3a7713b1edbc | 444 | * of constants that should be OR'd together to form the bit mask. |
AnnaBridge | 171:3a7713b1edbc | 445 | */ |
AnnaBridge | 171:3a7713b1edbc | 446 | static inline void I2S_DisableInterrupts(I2S_Type *base, uint32_t interruptMask) |
AnnaBridge | 171:3a7713b1edbc | 447 | { |
AnnaBridge | 171:3a7713b1edbc | 448 | base->FIFOINTENCLR = interruptMask; |
AnnaBridge | 171:3a7713b1edbc | 449 | } |
AnnaBridge | 171:3a7713b1edbc | 450 | |
AnnaBridge | 171:3a7713b1edbc | 451 | /*! |
AnnaBridge | 171:3a7713b1edbc | 452 | * @brief Returns the set of currently enabled I2S FIFO interrupts. |
AnnaBridge | 171:3a7713b1edbc | 453 | * |
AnnaBridge | 171:3a7713b1edbc | 454 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 455 | * |
AnnaBridge | 171:3a7713b1edbc | 456 | * @return A bitmask composed of #i2s_flags_t enumerators OR'd together |
AnnaBridge | 171:3a7713b1edbc | 457 | * to indicate the set of enabled interrupts. |
AnnaBridge | 171:3a7713b1edbc | 458 | */ |
AnnaBridge | 171:3a7713b1edbc | 459 | static inline uint32_t I2S_GetEnabledInterrupts(I2S_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 460 | { |
AnnaBridge | 171:3a7713b1edbc | 461 | return base->FIFOINTENSET; |
AnnaBridge | 171:3a7713b1edbc | 462 | } |
AnnaBridge | 171:3a7713b1edbc | 463 | |
AnnaBridge | 171:3a7713b1edbc | 464 | /*! |
AnnaBridge | 171:3a7713b1edbc | 465 | * @brief Invoked from interrupt handler when transmit FIFO level decreases. |
AnnaBridge | 171:3a7713b1edbc | 466 | * |
AnnaBridge | 171:3a7713b1edbc | 467 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 468 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 469 | */ |
AnnaBridge | 171:3a7713b1edbc | 470 | void I2S_TxHandleIRQ(I2S_Type *base, i2s_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 471 | |
AnnaBridge | 171:3a7713b1edbc | 472 | /*! |
AnnaBridge | 171:3a7713b1edbc | 473 | * @brief Invoked from interrupt handler when receive FIFO level decreases. |
AnnaBridge | 171:3a7713b1edbc | 474 | * |
AnnaBridge | 171:3a7713b1edbc | 475 | * @param base I2S base pointer. |
AnnaBridge | 171:3a7713b1edbc | 476 | * @param handle pointer to handle structure. |
AnnaBridge | 171:3a7713b1edbc | 477 | */ |
AnnaBridge | 171:3a7713b1edbc | 478 | void I2S_RxHandleIRQ(I2S_Type *base, i2s_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 479 | |
AnnaBridge | 171:3a7713b1edbc | 480 | /*! @} */ |
AnnaBridge | 171:3a7713b1edbc | 481 | |
AnnaBridge | 171:3a7713b1edbc | 482 | /*! @} */ |
AnnaBridge | 171:3a7713b1edbc | 483 | |
AnnaBridge | 171:3a7713b1edbc | 484 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 485 | } |
AnnaBridge | 171:3a7713b1edbc | 486 | #endif |
AnnaBridge | 171:3a7713b1edbc | 487 | |
AnnaBridge | 171:3a7713b1edbc | 488 | #endif /* _FSL_I2S_H_ */ |