mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_MIMXRT1050_EVK/TARGET_NXP/TARGET_MCUXpresso_MCUS/TARGET_MIMXRT1050/drivers/fsl_sai.h@161:aa5281ff4a02, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:16:41 2018 +0000
Revision:
161:aa5281ff4a02
Child:
170:e95d10626187
mbed library. Release version 159.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 161:aa5281ff4a02 1 /*
AnnaBridge 161:aa5281ff4a02 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 161:aa5281ff4a02 3 * Copyright 2016-2017 NXP
AnnaBridge 161:aa5281ff4a02 4 *
AnnaBridge 161:aa5281ff4a02 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 161:aa5281ff4a02 6 * are permitted provided that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 7 *
AnnaBridge 161:aa5281ff4a02 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 161:aa5281ff4a02 9 * of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 161:aa5281ff4a02 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 161:aa5281ff4a02 13 * other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 14 *
AnnaBridge 161:aa5281ff4a02 15 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 161:aa5281ff4a02 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 161:aa5281ff4a02 17 * software without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 18 *
AnnaBridge 161:aa5281ff4a02 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 161:aa5281ff4a02 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 161:aa5281ff4a02 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 161:aa5281ff4a02 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 161:aa5281ff4a02 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 161:aa5281ff4a02 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 161:aa5281ff4a02 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 161:aa5281ff4a02 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 161:aa5281ff4a02 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 29 */
AnnaBridge 161:aa5281ff4a02 30
AnnaBridge 161:aa5281ff4a02 31 #ifndef _FSL_SAI_H_
AnnaBridge 161:aa5281ff4a02 32 #define _FSL_SAI_H_
AnnaBridge 161:aa5281ff4a02 33
AnnaBridge 161:aa5281ff4a02 34 #include "fsl_common.h"
AnnaBridge 161:aa5281ff4a02 35
AnnaBridge 161:aa5281ff4a02 36 /*!
AnnaBridge 161:aa5281ff4a02 37 * @addtogroup sai
AnnaBridge 161:aa5281ff4a02 38 * @{
AnnaBridge 161:aa5281ff4a02 39 */
AnnaBridge 161:aa5281ff4a02 40
AnnaBridge 161:aa5281ff4a02 41 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 42 * Definitions
AnnaBridge 161:aa5281ff4a02 43 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /*! @name Driver version */
AnnaBridge 161:aa5281ff4a02 46 /*@{*/
AnnaBridge 161:aa5281ff4a02 47 #define FSL_SAI_DRIVER_VERSION (MAKE_VERSION(2, 1, 3)) /*!< Version 2.1.3 */
AnnaBridge 161:aa5281ff4a02 48 /*@}*/
AnnaBridge 161:aa5281ff4a02 49
AnnaBridge 161:aa5281ff4a02 50 /*! @brief SAI return status*/
AnnaBridge 161:aa5281ff4a02 51 enum _sai_status_t
AnnaBridge 161:aa5281ff4a02 52 {
AnnaBridge 161:aa5281ff4a02 53 kStatus_SAI_TxBusy = MAKE_STATUS(kStatusGroup_SAI, 0), /*!< SAI Tx is busy. */
AnnaBridge 161:aa5281ff4a02 54 kStatus_SAI_RxBusy = MAKE_STATUS(kStatusGroup_SAI, 1), /*!< SAI Rx is busy. */
AnnaBridge 161:aa5281ff4a02 55 kStatus_SAI_TxError = MAKE_STATUS(kStatusGroup_SAI, 2), /*!< SAI Tx FIFO error. */
AnnaBridge 161:aa5281ff4a02 56 kStatus_SAI_RxError = MAKE_STATUS(kStatusGroup_SAI, 3), /*!< SAI Rx FIFO error. */
AnnaBridge 161:aa5281ff4a02 57 kStatus_SAI_QueueFull = MAKE_STATUS(kStatusGroup_SAI, 4), /*!< SAI transfer queue is full. */
AnnaBridge 161:aa5281ff4a02 58 kStatus_SAI_TxIdle = MAKE_STATUS(kStatusGroup_SAI, 5), /*!< SAI Tx is idle */
AnnaBridge 161:aa5281ff4a02 59 kStatus_SAI_RxIdle = MAKE_STATUS(kStatusGroup_SAI, 6) /*!< SAI Rx is idle */
AnnaBridge 161:aa5281ff4a02 60 };
AnnaBridge 161:aa5281ff4a02 61
AnnaBridge 161:aa5281ff4a02 62 /*! @brief Define the SAI bus type */
AnnaBridge 161:aa5281ff4a02 63 typedef enum _sai_protocol
AnnaBridge 161:aa5281ff4a02 64 {
AnnaBridge 161:aa5281ff4a02 65 kSAI_BusLeftJustified = 0x0U, /*!< Uses left justified format.*/
AnnaBridge 161:aa5281ff4a02 66 kSAI_BusRightJustified, /*!< Uses right justified format. */
AnnaBridge 161:aa5281ff4a02 67 kSAI_BusI2S, /*!< Uses I2S format. */
AnnaBridge 161:aa5281ff4a02 68 kSAI_BusPCMA, /*!< Uses I2S PCM A format.*/
AnnaBridge 161:aa5281ff4a02 69 kSAI_BusPCMB /*!< Uses I2S PCM B format. */
AnnaBridge 161:aa5281ff4a02 70 } sai_protocol_t;
AnnaBridge 161:aa5281ff4a02 71
AnnaBridge 161:aa5281ff4a02 72 /*! @brief Master or slave mode */
AnnaBridge 161:aa5281ff4a02 73 typedef enum _sai_master_slave
AnnaBridge 161:aa5281ff4a02 74 {
AnnaBridge 161:aa5281ff4a02 75 kSAI_Master = 0x0U, /*!< Master mode */
AnnaBridge 161:aa5281ff4a02 76 kSAI_Slave = 0x1U /*!< Slave mode */
AnnaBridge 161:aa5281ff4a02 77 } sai_master_slave_t;
AnnaBridge 161:aa5281ff4a02 78
AnnaBridge 161:aa5281ff4a02 79 /*! @brief Mono or stereo audio format */
AnnaBridge 161:aa5281ff4a02 80 typedef enum _sai_mono_stereo
AnnaBridge 161:aa5281ff4a02 81 {
AnnaBridge 161:aa5281ff4a02 82 kSAI_Stereo = 0x0U, /*!< Stereo sound. */
AnnaBridge 161:aa5281ff4a02 83 kSAI_MonoRight, /*!< Only Right channel have sound. */
AnnaBridge 161:aa5281ff4a02 84 kSAI_MonoLeft /*!< Only left channel have sound. */
AnnaBridge 161:aa5281ff4a02 85 } sai_mono_stereo_t;
AnnaBridge 161:aa5281ff4a02 86
AnnaBridge 161:aa5281ff4a02 87 /*! @brief Synchronous or asynchronous mode */
AnnaBridge 161:aa5281ff4a02 88 typedef enum _sai_sync_mode
AnnaBridge 161:aa5281ff4a02 89 {
AnnaBridge 161:aa5281ff4a02 90 kSAI_ModeAsync = 0x0U, /*!< Asynchronous mode */
AnnaBridge 161:aa5281ff4a02 91 kSAI_ModeSync, /*!< Synchronous mode (with receiver or transmit) */
AnnaBridge 161:aa5281ff4a02 92 kSAI_ModeSyncWithOtherTx, /*!< Synchronous with another SAI transmit */
AnnaBridge 161:aa5281ff4a02 93 kSAI_ModeSyncWithOtherRx /*!< Synchronous with another SAI receiver */
AnnaBridge 161:aa5281ff4a02 94 } sai_sync_mode_t;
AnnaBridge 161:aa5281ff4a02 95
AnnaBridge 161:aa5281ff4a02 96 /*! @brief Mater clock source */
AnnaBridge 161:aa5281ff4a02 97 typedef enum _sai_mclk_source
AnnaBridge 161:aa5281ff4a02 98 {
AnnaBridge 161:aa5281ff4a02 99 kSAI_MclkSourceSysclk = 0x0U, /*!< Master clock from the system clock */
AnnaBridge 161:aa5281ff4a02 100 kSAI_MclkSourceSelect1, /*!< Master clock from source 1 */
AnnaBridge 161:aa5281ff4a02 101 kSAI_MclkSourceSelect2, /*!< Master clock from source 2 */
AnnaBridge 161:aa5281ff4a02 102 kSAI_MclkSourceSelect3 /*!< Master clock from source 3 */
AnnaBridge 161:aa5281ff4a02 103 } sai_mclk_source_t;
AnnaBridge 161:aa5281ff4a02 104
AnnaBridge 161:aa5281ff4a02 105 /*! @brief Bit clock source */
AnnaBridge 161:aa5281ff4a02 106 typedef enum _sai_bclk_source
AnnaBridge 161:aa5281ff4a02 107 {
AnnaBridge 161:aa5281ff4a02 108 kSAI_BclkSourceBusclk = 0x0U, /*!< Bit clock using bus clock */
AnnaBridge 161:aa5281ff4a02 109 kSAI_BclkSourceMclkDiv, /*!< Bit clock using master clock divider */
AnnaBridge 161:aa5281ff4a02 110 kSAI_BclkSourceOtherSai0, /*!< Bit clock from other SAI device */
AnnaBridge 161:aa5281ff4a02 111 kSAI_BclkSourceOtherSai1 /*!< Bit clock from other SAI device */
AnnaBridge 161:aa5281ff4a02 112 } sai_bclk_source_t;
AnnaBridge 161:aa5281ff4a02 113
AnnaBridge 161:aa5281ff4a02 114 /*! @brief The SAI interrupt enable flag */
AnnaBridge 161:aa5281ff4a02 115 enum _sai_interrupt_enable_t
AnnaBridge 161:aa5281ff4a02 116 {
AnnaBridge 161:aa5281ff4a02 117 kSAI_WordStartInterruptEnable =
AnnaBridge 161:aa5281ff4a02 118 I2S_TCSR_WSIE_MASK, /*!< Word start flag, means the first word in a frame detected */
AnnaBridge 161:aa5281ff4a02 119 kSAI_SyncErrorInterruptEnable = I2S_TCSR_SEIE_MASK, /*!< Sync error flag, means the sync error is detected */
AnnaBridge 161:aa5281ff4a02 120 kSAI_FIFOWarningInterruptEnable = I2S_TCSR_FWIE_MASK, /*!< FIFO warning flag, means the FIFO is empty */
AnnaBridge 161:aa5281ff4a02 121 kSAI_FIFOErrorInterruptEnable = I2S_TCSR_FEIE_MASK, /*!< FIFO error flag */
AnnaBridge 161:aa5281ff4a02 122 #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1)
AnnaBridge 161:aa5281ff4a02 123 kSAI_FIFORequestInterruptEnable = I2S_TCSR_FRIE_MASK, /*!< FIFO request, means reached watermark */
AnnaBridge 161:aa5281ff4a02 124 #endif /* FSL_FEATURE_SAI_FIFO_COUNT */
AnnaBridge 161:aa5281ff4a02 125 };
AnnaBridge 161:aa5281ff4a02 126
AnnaBridge 161:aa5281ff4a02 127 /*! @brief The DMA request sources */
AnnaBridge 161:aa5281ff4a02 128 enum _sai_dma_enable_t
AnnaBridge 161:aa5281ff4a02 129 {
AnnaBridge 161:aa5281ff4a02 130 kSAI_FIFOWarningDMAEnable = I2S_TCSR_FWDE_MASK, /*!< FIFO warning caused by the DMA request */
AnnaBridge 161:aa5281ff4a02 131 #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1)
AnnaBridge 161:aa5281ff4a02 132 kSAI_FIFORequestDMAEnable = I2S_TCSR_FRDE_MASK, /*!< FIFO request caused by the DMA request */
AnnaBridge 161:aa5281ff4a02 133 #endif /* FSL_FEATURE_SAI_FIFO_COUNT */
AnnaBridge 161:aa5281ff4a02 134 };
AnnaBridge 161:aa5281ff4a02 135
AnnaBridge 161:aa5281ff4a02 136 /*! @brief The SAI status flag */
AnnaBridge 161:aa5281ff4a02 137 enum _sai_flags
AnnaBridge 161:aa5281ff4a02 138 {
AnnaBridge 161:aa5281ff4a02 139 kSAI_WordStartFlag = I2S_TCSR_WSF_MASK, /*!< Word start flag, means the first word in a frame detected */
AnnaBridge 161:aa5281ff4a02 140 kSAI_SyncErrorFlag = I2S_TCSR_SEF_MASK, /*!< Sync error flag, means the sync error is detected */
AnnaBridge 161:aa5281ff4a02 141 kSAI_FIFOErrorFlag = I2S_TCSR_FEF_MASK, /*!< FIFO error flag */
AnnaBridge 161:aa5281ff4a02 142 #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1)
AnnaBridge 161:aa5281ff4a02 143 kSAI_FIFORequestFlag = I2S_TCSR_FRF_MASK, /*!< FIFO request flag. */
AnnaBridge 161:aa5281ff4a02 144 #endif /* FSL_FEATURE_SAI_FIFO_COUNT */
AnnaBridge 161:aa5281ff4a02 145 kSAI_FIFOWarningFlag = I2S_TCSR_FWF_MASK, /*!< FIFO warning flag */
AnnaBridge 161:aa5281ff4a02 146 };
AnnaBridge 161:aa5281ff4a02 147
AnnaBridge 161:aa5281ff4a02 148 /*! @brief The reset type */
AnnaBridge 161:aa5281ff4a02 149 typedef enum _sai_reset_type
AnnaBridge 161:aa5281ff4a02 150 {
AnnaBridge 161:aa5281ff4a02 151 kSAI_ResetTypeSoftware = I2S_TCSR_SR_MASK, /*!< Software reset, reset the logic state */
AnnaBridge 161:aa5281ff4a02 152 kSAI_ResetTypeFIFO = I2S_TCSR_FR_MASK, /*!< FIFO reset, reset the FIFO read and write pointer */
AnnaBridge 161:aa5281ff4a02 153 kSAI_ResetAll = I2S_TCSR_SR_MASK | I2S_TCSR_FR_MASK /*!< All reset. */
AnnaBridge 161:aa5281ff4a02 154 } sai_reset_type_t;
AnnaBridge 161:aa5281ff4a02 155
AnnaBridge 161:aa5281ff4a02 156 #if defined(FSL_FEATURE_SAI_HAS_FIFO_PACKING) && FSL_FEATURE_SAI_HAS_FIFO_PACKING
AnnaBridge 161:aa5281ff4a02 157 /*!
AnnaBridge 161:aa5281ff4a02 158 * @brief The SAI packing mode
AnnaBridge 161:aa5281ff4a02 159 * The mode includes 8 bit and 16 bit packing.
AnnaBridge 161:aa5281ff4a02 160 */
AnnaBridge 161:aa5281ff4a02 161 typedef enum _sai_fifo_packing
AnnaBridge 161:aa5281ff4a02 162 {
AnnaBridge 161:aa5281ff4a02 163 kSAI_FifoPackingDisabled = 0x0U, /*!< Packing disabled */
AnnaBridge 161:aa5281ff4a02 164 kSAI_FifoPacking8bit = 0x2U, /*!< 8 bit packing enabled */
AnnaBridge 161:aa5281ff4a02 165 kSAI_FifoPacking16bit = 0x3U /*!< 16bit packing enabled */
AnnaBridge 161:aa5281ff4a02 166 } sai_fifo_packing_t;
AnnaBridge 161:aa5281ff4a02 167 #endif /* FSL_FEATURE_SAI_HAS_FIFO_PACKING */
AnnaBridge 161:aa5281ff4a02 168
AnnaBridge 161:aa5281ff4a02 169 /*! @brief SAI user configuration structure */
AnnaBridge 161:aa5281ff4a02 170 typedef struct _sai_config
AnnaBridge 161:aa5281ff4a02 171 {
AnnaBridge 161:aa5281ff4a02 172 sai_protocol_t protocol; /*!< Audio bus protocol in SAI */
AnnaBridge 161:aa5281ff4a02 173 sai_sync_mode_t syncMode; /*!< SAI sync mode, control Tx/Rx clock sync */
AnnaBridge 161:aa5281ff4a02 174 #if defined(FSL_FEATURE_SAI_HAS_MCR) && (FSL_FEATURE_SAI_HAS_MCR)
AnnaBridge 161:aa5281ff4a02 175 bool mclkOutputEnable; /*!< Master clock output enable, true means master clock divider enabled */
AnnaBridge 161:aa5281ff4a02 176 #endif /* FSL_FEATURE_SAI_HAS_MCR */
AnnaBridge 161:aa5281ff4a02 177 sai_mclk_source_t mclkSource; /*!< Master Clock source */
AnnaBridge 161:aa5281ff4a02 178 sai_bclk_source_t bclkSource; /*!< Bit Clock source */
AnnaBridge 161:aa5281ff4a02 179 sai_master_slave_t masterSlave; /*!< Master or slave */
AnnaBridge 161:aa5281ff4a02 180 } sai_config_t;
AnnaBridge 161:aa5281ff4a02 181
AnnaBridge 161:aa5281ff4a02 182 /*!@brief SAI transfer queue size, user can refine it according to use case. */
AnnaBridge 161:aa5281ff4a02 183 #define SAI_XFER_QUEUE_SIZE (4)
AnnaBridge 161:aa5281ff4a02 184
AnnaBridge 161:aa5281ff4a02 185 /*! @brief Audio sample rate */
AnnaBridge 161:aa5281ff4a02 186 typedef enum _sai_sample_rate
AnnaBridge 161:aa5281ff4a02 187 {
AnnaBridge 161:aa5281ff4a02 188 kSAI_SampleRate8KHz = 8000U, /*!< Sample rate 8000 Hz */
AnnaBridge 161:aa5281ff4a02 189 kSAI_SampleRate11025Hz = 11025U, /*!< Sample rate 11025 Hz */
AnnaBridge 161:aa5281ff4a02 190 kSAI_SampleRate12KHz = 12000U, /*!< Sample rate 12000 Hz */
AnnaBridge 161:aa5281ff4a02 191 kSAI_SampleRate16KHz = 16000U, /*!< Sample rate 16000 Hz */
AnnaBridge 161:aa5281ff4a02 192 kSAI_SampleRate22050Hz = 22050U, /*!< Sample rate 22050 Hz */
AnnaBridge 161:aa5281ff4a02 193 kSAI_SampleRate24KHz = 24000U, /*!< Sample rate 24000 Hz */
AnnaBridge 161:aa5281ff4a02 194 kSAI_SampleRate32KHz = 32000U, /*!< Sample rate 32000 Hz */
AnnaBridge 161:aa5281ff4a02 195 kSAI_SampleRate44100Hz = 44100U, /*!< Sample rate 44100 Hz */
AnnaBridge 161:aa5281ff4a02 196 kSAI_SampleRate48KHz = 48000U, /*!< Sample rate 48000 Hz */
AnnaBridge 161:aa5281ff4a02 197 kSAI_SampleRate96KHz = 96000U /*!< Sample rate 96000 Hz */
AnnaBridge 161:aa5281ff4a02 198 } sai_sample_rate_t;
AnnaBridge 161:aa5281ff4a02 199
AnnaBridge 161:aa5281ff4a02 200 /*! @brief Audio word width */
AnnaBridge 161:aa5281ff4a02 201 typedef enum _sai_word_width
AnnaBridge 161:aa5281ff4a02 202 {
AnnaBridge 161:aa5281ff4a02 203 kSAI_WordWidth8bits = 8U, /*!< Audio data width 8 bits */
AnnaBridge 161:aa5281ff4a02 204 kSAI_WordWidth16bits = 16U, /*!< Audio data width 16 bits */
AnnaBridge 161:aa5281ff4a02 205 kSAI_WordWidth24bits = 24U, /*!< Audio data width 24 bits */
AnnaBridge 161:aa5281ff4a02 206 kSAI_WordWidth32bits = 32U /*!< Audio data width 32 bits */
AnnaBridge 161:aa5281ff4a02 207 } sai_word_width_t;
AnnaBridge 161:aa5281ff4a02 208
AnnaBridge 161:aa5281ff4a02 209 /*! @brief sai transfer format */
AnnaBridge 161:aa5281ff4a02 210 typedef struct _sai_transfer_format
AnnaBridge 161:aa5281ff4a02 211 {
AnnaBridge 161:aa5281ff4a02 212 uint32_t sampleRate_Hz; /*!< Sample rate of audio data */
AnnaBridge 161:aa5281ff4a02 213 uint32_t bitWidth; /*!< Data length of audio data, usually 8/16/24/32 bits */
AnnaBridge 161:aa5281ff4a02 214 sai_mono_stereo_t stereo; /*!< Mono or stereo */
AnnaBridge 161:aa5281ff4a02 215 uint32_t masterClockHz; /*!< Master clock frequency in Hz */
AnnaBridge 161:aa5281ff4a02 216 #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1)
AnnaBridge 161:aa5281ff4a02 217 uint8_t watermark; /*!< Watermark value */
AnnaBridge 161:aa5281ff4a02 218 #endif /* FSL_FEATURE_SAI_FIFO_COUNT */
AnnaBridge 161:aa5281ff4a02 219 uint8_t channel; /*!< Data channel used in transfer.*/
AnnaBridge 161:aa5281ff4a02 220 sai_protocol_t protocol; /*!< Which audio protocol used */
AnnaBridge 161:aa5281ff4a02 221 bool isFrameSyncCompact; /*!< True means Frame sync length is configurable according to bitWidth, false means frame
AnnaBridge 161:aa5281ff4a02 222 sync length is 64 times of bit clock. */
AnnaBridge 161:aa5281ff4a02 223 } sai_transfer_format_t;
AnnaBridge 161:aa5281ff4a02 224
AnnaBridge 161:aa5281ff4a02 225 /*! @brief SAI transfer structure */
AnnaBridge 161:aa5281ff4a02 226 typedef struct _sai_transfer
AnnaBridge 161:aa5281ff4a02 227 {
AnnaBridge 161:aa5281ff4a02 228 uint8_t *data; /*!< Data start address to transfer. */
AnnaBridge 161:aa5281ff4a02 229 size_t dataSize; /*!< Transfer size. */
AnnaBridge 161:aa5281ff4a02 230 } sai_transfer_t;
AnnaBridge 161:aa5281ff4a02 231
AnnaBridge 161:aa5281ff4a02 232 typedef struct _sai_handle sai_handle_t;
AnnaBridge 161:aa5281ff4a02 233
AnnaBridge 161:aa5281ff4a02 234 /*! @brief SAI transfer callback prototype */
AnnaBridge 161:aa5281ff4a02 235 typedef void (*sai_transfer_callback_t)(I2S_Type *base, sai_handle_t *handle, status_t status, void *userData);
AnnaBridge 161:aa5281ff4a02 236
AnnaBridge 161:aa5281ff4a02 237 /*! @brief SAI handle structure */
AnnaBridge 161:aa5281ff4a02 238 struct _sai_handle
AnnaBridge 161:aa5281ff4a02 239 {
AnnaBridge 161:aa5281ff4a02 240 uint32_t state; /*!< Transfer status */
AnnaBridge 161:aa5281ff4a02 241 sai_transfer_callback_t callback; /*!< Callback function called at transfer event*/
AnnaBridge 161:aa5281ff4a02 242 void *userData; /*!< Callback parameter passed to callback function*/
AnnaBridge 161:aa5281ff4a02 243 uint8_t bitWidth; /*!< Bit width for transfer, 8/16/24/32 bits */
AnnaBridge 161:aa5281ff4a02 244 uint8_t channel; /*!< Transfer channel */
AnnaBridge 161:aa5281ff4a02 245 sai_transfer_t saiQueue[SAI_XFER_QUEUE_SIZE]; /*!< Transfer queue storing queued transfer */
AnnaBridge 161:aa5281ff4a02 246 size_t transferSize[SAI_XFER_QUEUE_SIZE]; /*!< Data bytes need to transfer */
AnnaBridge 161:aa5281ff4a02 247 volatile uint8_t queueUser; /*!< Index for user to queue transfer */
AnnaBridge 161:aa5281ff4a02 248 volatile uint8_t queueDriver; /*!< Index for driver to get the transfer data and size */
AnnaBridge 161:aa5281ff4a02 249 #if defined(FSL_FEATURE_SAI_FIFO_COUNT) && (FSL_FEATURE_SAI_FIFO_COUNT > 1)
AnnaBridge 161:aa5281ff4a02 250 uint8_t watermark; /*!< Watermark value */
AnnaBridge 161:aa5281ff4a02 251 #endif
AnnaBridge 161:aa5281ff4a02 252 };
AnnaBridge 161:aa5281ff4a02 253
AnnaBridge 161:aa5281ff4a02 254 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 255 * API
AnnaBridge 161:aa5281ff4a02 256 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 257
AnnaBridge 161:aa5281ff4a02 258 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 259 extern "C" {
AnnaBridge 161:aa5281ff4a02 260 #endif /*_cplusplus*/
AnnaBridge 161:aa5281ff4a02 261
AnnaBridge 161:aa5281ff4a02 262 /*!
AnnaBridge 161:aa5281ff4a02 263 * @name Initialization and deinitialization
AnnaBridge 161:aa5281ff4a02 264 * @{
AnnaBridge 161:aa5281ff4a02 265 */
AnnaBridge 161:aa5281ff4a02 266
AnnaBridge 161:aa5281ff4a02 267 /*!
AnnaBridge 161:aa5281ff4a02 268 * @brief Initializes the SAI Tx peripheral.
AnnaBridge 161:aa5281ff4a02 269 *
AnnaBridge 161:aa5281ff4a02 270 * Ungates the SAI clock, resets the module, and configures SAI Tx with a configuration structure.
AnnaBridge 161:aa5281ff4a02 271 * The configuration structure can be custom filled or set with default values by
AnnaBridge 161:aa5281ff4a02 272 * SAI_TxGetDefaultConfig().
AnnaBridge 161:aa5281ff4a02 273 *
AnnaBridge 161:aa5281ff4a02 274 * @note This API should be called at the beginning of the application to use
AnnaBridge 161:aa5281ff4a02 275 * the SAI driver. Otherwise, accessing the SAIM module can cause a hard fault
AnnaBridge 161:aa5281ff4a02 276 * because the clock is not enabled.
AnnaBridge 161:aa5281ff4a02 277 *
AnnaBridge 161:aa5281ff4a02 278 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 279 * @param config SAI configuration structure.
AnnaBridge 161:aa5281ff4a02 280 */
AnnaBridge 161:aa5281ff4a02 281 void SAI_TxInit(I2S_Type *base, const sai_config_t *config);
AnnaBridge 161:aa5281ff4a02 282
AnnaBridge 161:aa5281ff4a02 283 /*!
AnnaBridge 161:aa5281ff4a02 284 * @brief Initializes the the SAI Rx peripheral.
AnnaBridge 161:aa5281ff4a02 285 *
AnnaBridge 161:aa5281ff4a02 286 * Ungates the SAI clock, resets the module, and configures the SAI Rx with a configuration structure.
AnnaBridge 161:aa5281ff4a02 287 * The configuration structure can be custom filled or set with default values by
AnnaBridge 161:aa5281ff4a02 288 * SAI_RxGetDefaultConfig().
AnnaBridge 161:aa5281ff4a02 289 *
AnnaBridge 161:aa5281ff4a02 290 * @note This API should be called at the beginning of the application to use
AnnaBridge 161:aa5281ff4a02 291 * the SAI driver. Otherwise, accessing the SAI module can cause a hard fault
AnnaBridge 161:aa5281ff4a02 292 * because the clock is not enabled.
AnnaBridge 161:aa5281ff4a02 293 *
AnnaBridge 161:aa5281ff4a02 294 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 295 * @param config SAI configuration structure.
AnnaBridge 161:aa5281ff4a02 296 */
AnnaBridge 161:aa5281ff4a02 297 void SAI_RxInit(I2S_Type *base, const sai_config_t *config);
AnnaBridge 161:aa5281ff4a02 298
AnnaBridge 161:aa5281ff4a02 299 /*!
AnnaBridge 161:aa5281ff4a02 300 * @brief Sets the SAI Tx configuration structure to default values.
AnnaBridge 161:aa5281ff4a02 301 *
AnnaBridge 161:aa5281ff4a02 302 * This API initializes the configuration structure for use in SAI_TxConfig().
AnnaBridge 161:aa5281ff4a02 303 * The initialized structure can remain unchanged in SAI_TxConfig(), or it can be modified
AnnaBridge 161:aa5281ff4a02 304 * before calling SAI_TxConfig().
AnnaBridge 161:aa5281ff4a02 305 * This is an example.
AnnaBridge 161:aa5281ff4a02 306 @code
AnnaBridge 161:aa5281ff4a02 307 sai_config_t config;
AnnaBridge 161:aa5281ff4a02 308 SAI_TxGetDefaultConfig(&config);
AnnaBridge 161:aa5281ff4a02 309 @endcode
AnnaBridge 161:aa5281ff4a02 310 *
AnnaBridge 161:aa5281ff4a02 311 * @param config pointer to master configuration structure
AnnaBridge 161:aa5281ff4a02 312 */
AnnaBridge 161:aa5281ff4a02 313 void SAI_TxGetDefaultConfig(sai_config_t *config);
AnnaBridge 161:aa5281ff4a02 314
AnnaBridge 161:aa5281ff4a02 315 /*!
AnnaBridge 161:aa5281ff4a02 316 * @brief Sets the SAI Rx configuration structure to default values.
AnnaBridge 161:aa5281ff4a02 317 *
AnnaBridge 161:aa5281ff4a02 318 * This API initializes the configuration structure for use in SAI_RxConfig().
AnnaBridge 161:aa5281ff4a02 319 * The initialized structure can remain unchanged in SAI_RxConfig() or it can be modified
AnnaBridge 161:aa5281ff4a02 320 * before calling SAI_RxConfig().
AnnaBridge 161:aa5281ff4a02 321 * This is an example.
AnnaBridge 161:aa5281ff4a02 322 @code
AnnaBridge 161:aa5281ff4a02 323 sai_config_t config;
AnnaBridge 161:aa5281ff4a02 324 SAI_RxGetDefaultConfig(&config);
AnnaBridge 161:aa5281ff4a02 325 @endcode
AnnaBridge 161:aa5281ff4a02 326 *
AnnaBridge 161:aa5281ff4a02 327 * @param config pointer to master configuration structure
AnnaBridge 161:aa5281ff4a02 328 */
AnnaBridge 161:aa5281ff4a02 329 void SAI_RxGetDefaultConfig(sai_config_t *config);
AnnaBridge 161:aa5281ff4a02 330
AnnaBridge 161:aa5281ff4a02 331 /*!
AnnaBridge 161:aa5281ff4a02 332 * @brief De-initializes the SAI peripheral.
AnnaBridge 161:aa5281ff4a02 333 *
AnnaBridge 161:aa5281ff4a02 334 * This API gates the SAI clock. The SAI module can't operate unless SAI_TxInit
AnnaBridge 161:aa5281ff4a02 335 * or SAI_RxInit is called to enable the clock.
AnnaBridge 161:aa5281ff4a02 336 *
AnnaBridge 161:aa5281ff4a02 337 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 338 */
AnnaBridge 161:aa5281ff4a02 339 void SAI_Deinit(I2S_Type *base);
AnnaBridge 161:aa5281ff4a02 340
AnnaBridge 161:aa5281ff4a02 341 /*!
AnnaBridge 161:aa5281ff4a02 342 * @brief Resets the SAI Tx.
AnnaBridge 161:aa5281ff4a02 343 *
AnnaBridge 161:aa5281ff4a02 344 * This function enables the software reset and FIFO reset of SAI Tx. After reset, clear the reset bit.
AnnaBridge 161:aa5281ff4a02 345 *
AnnaBridge 161:aa5281ff4a02 346 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 347 */
AnnaBridge 161:aa5281ff4a02 348 void SAI_TxReset(I2S_Type *base);
AnnaBridge 161:aa5281ff4a02 349
AnnaBridge 161:aa5281ff4a02 350 /*!
AnnaBridge 161:aa5281ff4a02 351 * @brief Resets the SAI Rx.
AnnaBridge 161:aa5281ff4a02 352 *
AnnaBridge 161:aa5281ff4a02 353 * This function enables the software reset and FIFO reset of SAI Rx. After reset, clear the reset bit.
AnnaBridge 161:aa5281ff4a02 354 *
AnnaBridge 161:aa5281ff4a02 355 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 356 */
AnnaBridge 161:aa5281ff4a02 357 void SAI_RxReset(I2S_Type *base);
AnnaBridge 161:aa5281ff4a02 358
AnnaBridge 161:aa5281ff4a02 359 /*!
AnnaBridge 161:aa5281ff4a02 360 * @brief Enables/disables the SAI Tx.
AnnaBridge 161:aa5281ff4a02 361 *
AnnaBridge 161:aa5281ff4a02 362 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 363 * @param enable True means enable SAI Tx, false means disable.
AnnaBridge 161:aa5281ff4a02 364 */
AnnaBridge 161:aa5281ff4a02 365 void SAI_TxEnable(I2S_Type *base, bool enable);
AnnaBridge 161:aa5281ff4a02 366
AnnaBridge 161:aa5281ff4a02 367 /*!
AnnaBridge 161:aa5281ff4a02 368 * @brief Enables/disables the SAI Rx.
AnnaBridge 161:aa5281ff4a02 369 *
AnnaBridge 161:aa5281ff4a02 370 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 371 * @param enable True means enable SAI Rx, false means disable.
AnnaBridge 161:aa5281ff4a02 372 */
AnnaBridge 161:aa5281ff4a02 373 void SAI_RxEnable(I2S_Type *base, bool enable);
AnnaBridge 161:aa5281ff4a02 374
AnnaBridge 161:aa5281ff4a02 375 /*! @} */
AnnaBridge 161:aa5281ff4a02 376
AnnaBridge 161:aa5281ff4a02 377 /*!
AnnaBridge 161:aa5281ff4a02 378 * @name Status
AnnaBridge 161:aa5281ff4a02 379 * @{
AnnaBridge 161:aa5281ff4a02 380 */
AnnaBridge 161:aa5281ff4a02 381
AnnaBridge 161:aa5281ff4a02 382 /*!
AnnaBridge 161:aa5281ff4a02 383 * @brief Gets the SAI Tx status flag state.
AnnaBridge 161:aa5281ff4a02 384 *
AnnaBridge 161:aa5281ff4a02 385 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 386 * @return SAI Tx status flag value. Use the Status Mask to get the status value needed.
AnnaBridge 161:aa5281ff4a02 387 */
AnnaBridge 161:aa5281ff4a02 388 static inline uint32_t SAI_TxGetStatusFlag(I2S_Type *base)
AnnaBridge 161:aa5281ff4a02 389 {
AnnaBridge 161:aa5281ff4a02 390 return base->TCSR;
AnnaBridge 161:aa5281ff4a02 391 }
AnnaBridge 161:aa5281ff4a02 392
AnnaBridge 161:aa5281ff4a02 393 /*!
AnnaBridge 161:aa5281ff4a02 394 * @brief Clears the SAI Tx status flag state.
AnnaBridge 161:aa5281ff4a02 395 *
AnnaBridge 161:aa5281ff4a02 396 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 397 * @param mask State mask. It can be a combination of the following source if defined:
AnnaBridge 161:aa5281ff4a02 398 * @arg kSAI_WordStartFlag
AnnaBridge 161:aa5281ff4a02 399 * @arg kSAI_SyncErrorFlag
AnnaBridge 161:aa5281ff4a02 400 * @arg kSAI_FIFOErrorFlag
AnnaBridge 161:aa5281ff4a02 401 */
AnnaBridge 161:aa5281ff4a02 402 static inline void SAI_TxClearStatusFlags(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 403 {
AnnaBridge 161:aa5281ff4a02 404 base->TCSR = ((base->TCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 405 }
AnnaBridge 161:aa5281ff4a02 406
AnnaBridge 161:aa5281ff4a02 407 /*!
AnnaBridge 161:aa5281ff4a02 408 * @brief Gets the SAI Tx status flag state.
AnnaBridge 161:aa5281ff4a02 409 *
AnnaBridge 161:aa5281ff4a02 410 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 411 * @return SAI Rx status flag value. Use the Status Mask to get the status value needed.
AnnaBridge 161:aa5281ff4a02 412 */
AnnaBridge 161:aa5281ff4a02 413 static inline uint32_t SAI_RxGetStatusFlag(I2S_Type *base)
AnnaBridge 161:aa5281ff4a02 414 {
AnnaBridge 161:aa5281ff4a02 415 return base->RCSR;
AnnaBridge 161:aa5281ff4a02 416 }
AnnaBridge 161:aa5281ff4a02 417
AnnaBridge 161:aa5281ff4a02 418 /*!
AnnaBridge 161:aa5281ff4a02 419 * @brief Clears the SAI Rx status flag state.
AnnaBridge 161:aa5281ff4a02 420 *
AnnaBridge 161:aa5281ff4a02 421 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 422 * @param mask State mask. It can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 423 * @arg kSAI_WordStartFlag
AnnaBridge 161:aa5281ff4a02 424 * @arg kSAI_SyncErrorFlag
AnnaBridge 161:aa5281ff4a02 425 * @arg kSAI_FIFOErrorFlag
AnnaBridge 161:aa5281ff4a02 426 */
AnnaBridge 161:aa5281ff4a02 427 static inline void SAI_RxClearStatusFlags(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 428 {
AnnaBridge 161:aa5281ff4a02 429 base->RCSR = ((base->RCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 430 }
AnnaBridge 161:aa5281ff4a02 431
AnnaBridge 161:aa5281ff4a02 432 /*!
AnnaBridge 161:aa5281ff4a02 433 * @brief Do software reset or FIFO reset .
AnnaBridge 161:aa5281ff4a02 434 *
AnnaBridge 161:aa5281ff4a02 435 * FIFO reset means clear all the data in the FIFO, and make the FIFO pointer both to 0.
AnnaBridge 161:aa5281ff4a02 436 * Software reset means claer the Tx internal logic, including the bit clock, frame count etc. But software
AnnaBridge 161:aa5281ff4a02 437 * reset will not clear any configuration registers like TCR1~TCR5.
AnnaBridge 161:aa5281ff4a02 438 * This function will also clear all the error flags such as FIFO error, sync error etc.
AnnaBridge 161:aa5281ff4a02 439 *
AnnaBridge 161:aa5281ff4a02 440 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 441 * @param type Reset type, FIFO reset or software reset
AnnaBridge 161:aa5281ff4a02 442 */
AnnaBridge 161:aa5281ff4a02 443 void SAI_TxSoftwareReset(I2S_Type *base, sai_reset_type_t type);
AnnaBridge 161:aa5281ff4a02 444
AnnaBridge 161:aa5281ff4a02 445 /*!
AnnaBridge 161:aa5281ff4a02 446 * @brief Do software reset or FIFO reset .
AnnaBridge 161:aa5281ff4a02 447 *
AnnaBridge 161:aa5281ff4a02 448 * FIFO reset means clear all the data in the FIFO, and make the FIFO pointer both to 0.
AnnaBridge 161:aa5281ff4a02 449 * Software reset means claer the Rx internal logic, including the bit clock, frame count etc. But software
AnnaBridge 161:aa5281ff4a02 450 * reset will not clear any configuration registers like RCR1~RCR5.
AnnaBridge 161:aa5281ff4a02 451 * This function will also clear all the error flags such as FIFO error, sync error etc.
AnnaBridge 161:aa5281ff4a02 452 *
AnnaBridge 161:aa5281ff4a02 453 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 454 * @param type Reset type, FIFO reset or software reset
AnnaBridge 161:aa5281ff4a02 455 */
AnnaBridge 161:aa5281ff4a02 456 void SAI_RxSoftwareReset(I2S_Type *base, sai_reset_type_t type);
AnnaBridge 161:aa5281ff4a02 457
AnnaBridge 161:aa5281ff4a02 458 /*!
AnnaBridge 161:aa5281ff4a02 459 * @brief Set the Tx channel FIFO enable mask.
AnnaBridge 161:aa5281ff4a02 460 *
AnnaBridge 161:aa5281ff4a02 461 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 462 * @param mask Channel enable mask, 0 means all channel FIFO disabled, 1 means channel 0 enabled,
AnnaBridge 161:aa5281ff4a02 463 * 3 means both channel 0 and channel 1 enabled.
AnnaBridge 161:aa5281ff4a02 464 */
AnnaBridge 161:aa5281ff4a02 465 void SAI_TxSetChannelFIFOMask(I2S_Type *base, uint8_t mask);
AnnaBridge 161:aa5281ff4a02 466
AnnaBridge 161:aa5281ff4a02 467 /*!
AnnaBridge 161:aa5281ff4a02 468 * @brief Set the Rx channel FIFO enable mask.
AnnaBridge 161:aa5281ff4a02 469 *
AnnaBridge 161:aa5281ff4a02 470 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 471 * @param mask Channel enable mask, 0 means all channel FIFO disabled, 1 means channel 0 enabled,
AnnaBridge 161:aa5281ff4a02 472 * 3 means both channel 0 and channel 1 enabled.
AnnaBridge 161:aa5281ff4a02 473 */
AnnaBridge 161:aa5281ff4a02 474 void SAI_RxSetChannelFIFOMask(I2S_Type *base, uint8_t mask);
AnnaBridge 161:aa5281ff4a02 475
AnnaBridge 161:aa5281ff4a02 476 /*! @} */
AnnaBridge 161:aa5281ff4a02 477
AnnaBridge 161:aa5281ff4a02 478 /*!
AnnaBridge 161:aa5281ff4a02 479 * @name Interrupts
AnnaBridge 161:aa5281ff4a02 480 * @{
AnnaBridge 161:aa5281ff4a02 481 */
AnnaBridge 161:aa5281ff4a02 482
AnnaBridge 161:aa5281ff4a02 483 /*!
AnnaBridge 161:aa5281ff4a02 484 * @brief Enables the SAI Tx interrupt requests.
AnnaBridge 161:aa5281ff4a02 485 *
AnnaBridge 161:aa5281ff4a02 486 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 487 * @param mask interrupt source
AnnaBridge 161:aa5281ff4a02 488 * The parameter can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 489 * @arg kSAI_WordStartInterruptEnable
AnnaBridge 161:aa5281ff4a02 490 * @arg kSAI_SyncErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 491 * @arg kSAI_FIFOWarningInterruptEnable
AnnaBridge 161:aa5281ff4a02 492 * @arg kSAI_FIFORequestInterruptEnable
AnnaBridge 161:aa5281ff4a02 493 * @arg kSAI_FIFOErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 494 */
AnnaBridge 161:aa5281ff4a02 495 static inline void SAI_TxEnableInterrupts(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 496 {
AnnaBridge 161:aa5281ff4a02 497 base->TCSR = ((base->TCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 498 }
AnnaBridge 161:aa5281ff4a02 499
AnnaBridge 161:aa5281ff4a02 500 /*!
AnnaBridge 161:aa5281ff4a02 501 * @brief Enables the SAI Rx interrupt requests.
AnnaBridge 161:aa5281ff4a02 502 *
AnnaBridge 161:aa5281ff4a02 503 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 504 * @param mask interrupt source
AnnaBridge 161:aa5281ff4a02 505 * The parameter can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 506 * @arg kSAI_WordStartInterruptEnable
AnnaBridge 161:aa5281ff4a02 507 * @arg kSAI_SyncErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 508 * @arg kSAI_FIFOWarningInterruptEnable
AnnaBridge 161:aa5281ff4a02 509 * @arg kSAI_FIFORequestInterruptEnable
AnnaBridge 161:aa5281ff4a02 510 * @arg kSAI_FIFOErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 511 */
AnnaBridge 161:aa5281ff4a02 512 static inline void SAI_RxEnableInterrupts(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 513 {
AnnaBridge 161:aa5281ff4a02 514 base->RCSR = ((base->RCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 515 }
AnnaBridge 161:aa5281ff4a02 516
AnnaBridge 161:aa5281ff4a02 517 /*!
AnnaBridge 161:aa5281ff4a02 518 * @brief Disables the SAI Tx interrupt requests.
AnnaBridge 161:aa5281ff4a02 519 *
AnnaBridge 161:aa5281ff4a02 520 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 521 * @param mask interrupt source
AnnaBridge 161:aa5281ff4a02 522 * The parameter can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 523 * @arg kSAI_WordStartInterruptEnable
AnnaBridge 161:aa5281ff4a02 524 * @arg kSAI_SyncErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 525 * @arg kSAI_FIFOWarningInterruptEnable
AnnaBridge 161:aa5281ff4a02 526 * @arg kSAI_FIFORequestInterruptEnable
AnnaBridge 161:aa5281ff4a02 527 * @arg kSAI_FIFOErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 528 */
AnnaBridge 161:aa5281ff4a02 529 static inline void SAI_TxDisableInterrupts(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 530 {
AnnaBridge 161:aa5281ff4a02 531 base->TCSR = ((base->TCSR & 0xFFE3FFFFU) & (~mask));
AnnaBridge 161:aa5281ff4a02 532 }
AnnaBridge 161:aa5281ff4a02 533
AnnaBridge 161:aa5281ff4a02 534 /*!
AnnaBridge 161:aa5281ff4a02 535 * @brief Disables the SAI Rx interrupt requests.
AnnaBridge 161:aa5281ff4a02 536 *
AnnaBridge 161:aa5281ff4a02 537 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 538 * @param mask interrupt source
AnnaBridge 161:aa5281ff4a02 539 * The parameter can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 540 * @arg kSAI_WordStartInterruptEnable
AnnaBridge 161:aa5281ff4a02 541 * @arg kSAI_SyncErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 542 * @arg kSAI_FIFOWarningInterruptEnable
AnnaBridge 161:aa5281ff4a02 543 * @arg kSAI_FIFORequestInterruptEnable
AnnaBridge 161:aa5281ff4a02 544 * @arg kSAI_FIFOErrorInterruptEnable
AnnaBridge 161:aa5281ff4a02 545 */
AnnaBridge 161:aa5281ff4a02 546 static inline void SAI_RxDisableInterrupts(I2S_Type *base, uint32_t mask)
AnnaBridge 161:aa5281ff4a02 547 {
AnnaBridge 161:aa5281ff4a02 548 base->RCSR = ((base->RCSR & 0xFFE3FFFFU) & (~mask));
AnnaBridge 161:aa5281ff4a02 549 }
AnnaBridge 161:aa5281ff4a02 550
AnnaBridge 161:aa5281ff4a02 551 /*! @} */
AnnaBridge 161:aa5281ff4a02 552
AnnaBridge 161:aa5281ff4a02 553 /*!
AnnaBridge 161:aa5281ff4a02 554 * @name DMA Control
AnnaBridge 161:aa5281ff4a02 555 * @{
AnnaBridge 161:aa5281ff4a02 556 */
AnnaBridge 161:aa5281ff4a02 557
AnnaBridge 161:aa5281ff4a02 558 /*!
AnnaBridge 161:aa5281ff4a02 559 * @brief Enables/disables the SAI Tx DMA requests.
AnnaBridge 161:aa5281ff4a02 560 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 561 * @param mask DMA source
AnnaBridge 161:aa5281ff4a02 562 * The parameter can be combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 563 * @arg kSAI_FIFOWarningDMAEnable
AnnaBridge 161:aa5281ff4a02 564 * @arg kSAI_FIFORequestDMAEnable
AnnaBridge 161:aa5281ff4a02 565 * @param enable True means enable DMA, false means disable DMA.
AnnaBridge 161:aa5281ff4a02 566 */
AnnaBridge 161:aa5281ff4a02 567 static inline void SAI_TxEnableDMA(I2S_Type *base, uint32_t mask, bool enable)
AnnaBridge 161:aa5281ff4a02 568 {
AnnaBridge 161:aa5281ff4a02 569 if (enable)
AnnaBridge 161:aa5281ff4a02 570 {
AnnaBridge 161:aa5281ff4a02 571 base->TCSR = ((base->TCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 572 }
AnnaBridge 161:aa5281ff4a02 573 else
AnnaBridge 161:aa5281ff4a02 574 {
AnnaBridge 161:aa5281ff4a02 575 base->TCSR = ((base->TCSR & 0xFFE3FFFFU) & (~mask));
AnnaBridge 161:aa5281ff4a02 576 }
AnnaBridge 161:aa5281ff4a02 577 }
AnnaBridge 161:aa5281ff4a02 578
AnnaBridge 161:aa5281ff4a02 579 /*!
AnnaBridge 161:aa5281ff4a02 580 * @brief Enables/disables the SAI Rx DMA requests.
AnnaBridge 161:aa5281ff4a02 581 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 582 * @param mask DMA source
AnnaBridge 161:aa5281ff4a02 583 * The parameter can be a combination of the following sources if defined.
AnnaBridge 161:aa5281ff4a02 584 * @arg kSAI_FIFOWarningDMAEnable
AnnaBridge 161:aa5281ff4a02 585 * @arg kSAI_FIFORequestDMAEnable
AnnaBridge 161:aa5281ff4a02 586 * @param enable True means enable DMA, false means disable DMA.
AnnaBridge 161:aa5281ff4a02 587 */
AnnaBridge 161:aa5281ff4a02 588 static inline void SAI_RxEnableDMA(I2S_Type *base, uint32_t mask, bool enable)
AnnaBridge 161:aa5281ff4a02 589 {
AnnaBridge 161:aa5281ff4a02 590 if (enable)
AnnaBridge 161:aa5281ff4a02 591 {
AnnaBridge 161:aa5281ff4a02 592 base->RCSR = ((base->RCSR & 0xFFE3FFFFU) | mask);
AnnaBridge 161:aa5281ff4a02 593 }
AnnaBridge 161:aa5281ff4a02 594 else
AnnaBridge 161:aa5281ff4a02 595 {
AnnaBridge 161:aa5281ff4a02 596 base->RCSR = ((base->RCSR & 0xFFE3FFFFU) & (~mask));
AnnaBridge 161:aa5281ff4a02 597 }
AnnaBridge 161:aa5281ff4a02 598 }
AnnaBridge 161:aa5281ff4a02 599
AnnaBridge 161:aa5281ff4a02 600 /*!
AnnaBridge 161:aa5281ff4a02 601 * @brief Gets the SAI Tx data register address.
AnnaBridge 161:aa5281ff4a02 602 *
AnnaBridge 161:aa5281ff4a02 603 * This API is used to provide a transfer address for the SAI DMA transfer configuration.
AnnaBridge 161:aa5281ff4a02 604 *
AnnaBridge 161:aa5281ff4a02 605 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 606 * @param channel Which data channel used.
AnnaBridge 161:aa5281ff4a02 607 * @return data register address.
AnnaBridge 161:aa5281ff4a02 608 */
AnnaBridge 161:aa5281ff4a02 609 static inline uint32_t SAI_TxGetDataRegisterAddress(I2S_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 610 {
AnnaBridge 161:aa5281ff4a02 611 return (uint32_t)(&(base->TDR)[channel]);
AnnaBridge 161:aa5281ff4a02 612 }
AnnaBridge 161:aa5281ff4a02 613
AnnaBridge 161:aa5281ff4a02 614 /*!
AnnaBridge 161:aa5281ff4a02 615 * @brief Gets the SAI Rx data register address.
AnnaBridge 161:aa5281ff4a02 616 *
AnnaBridge 161:aa5281ff4a02 617 * This API is used to provide a transfer address for the SAI DMA transfer configuration.
AnnaBridge 161:aa5281ff4a02 618 *
AnnaBridge 161:aa5281ff4a02 619 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 620 * @param channel Which data channel used.
AnnaBridge 161:aa5281ff4a02 621 * @return data register address.
AnnaBridge 161:aa5281ff4a02 622 */
AnnaBridge 161:aa5281ff4a02 623 static inline uint32_t SAI_RxGetDataRegisterAddress(I2S_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 624 {
AnnaBridge 161:aa5281ff4a02 625 return (uint32_t)(&(base->RDR)[channel]);
AnnaBridge 161:aa5281ff4a02 626 }
AnnaBridge 161:aa5281ff4a02 627
AnnaBridge 161:aa5281ff4a02 628 /*! @} */
AnnaBridge 161:aa5281ff4a02 629
AnnaBridge 161:aa5281ff4a02 630 /*!
AnnaBridge 161:aa5281ff4a02 631 * @name Bus Operations
AnnaBridge 161:aa5281ff4a02 632 * @{
AnnaBridge 161:aa5281ff4a02 633 */
AnnaBridge 161:aa5281ff4a02 634
AnnaBridge 161:aa5281ff4a02 635 /*!
AnnaBridge 161:aa5281ff4a02 636 * @brief Configures the SAI Tx audio format.
AnnaBridge 161:aa5281ff4a02 637 *
AnnaBridge 161:aa5281ff4a02 638 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 161:aa5281ff4a02 639 * format to be transferred.
AnnaBridge 161:aa5281ff4a02 640 *
AnnaBridge 161:aa5281ff4a02 641 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 642 * @param format Pointer to the SAI audio data format structure.
AnnaBridge 161:aa5281ff4a02 643 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 161:aa5281ff4a02 644 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If the bit clock source is a master
AnnaBridge 161:aa5281ff4a02 645 * clock, this value should equal the masterClockHz.
AnnaBridge 161:aa5281ff4a02 646 */
AnnaBridge 161:aa5281ff4a02 647 void SAI_TxSetFormat(I2S_Type *base,
AnnaBridge 161:aa5281ff4a02 648 sai_transfer_format_t *format,
AnnaBridge 161:aa5281ff4a02 649 uint32_t mclkSourceClockHz,
AnnaBridge 161:aa5281ff4a02 650 uint32_t bclkSourceClockHz);
AnnaBridge 161:aa5281ff4a02 651
AnnaBridge 161:aa5281ff4a02 652 /*!
AnnaBridge 161:aa5281ff4a02 653 * @brief Configures the SAI Rx audio format.
AnnaBridge 161:aa5281ff4a02 654 *
AnnaBridge 161:aa5281ff4a02 655 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 161:aa5281ff4a02 656 * format to be transferred.
AnnaBridge 161:aa5281ff4a02 657 *
AnnaBridge 161:aa5281ff4a02 658 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 659 * @param format Pointer to the SAI audio data format structure.
AnnaBridge 161:aa5281ff4a02 660 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 161:aa5281ff4a02 661 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If the bit clock source is a master
AnnaBridge 161:aa5281ff4a02 662 * clock, this value should equal the masterClockHz.
AnnaBridge 161:aa5281ff4a02 663 */
AnnaBridge 161:aa5281ff4a02 664 void SAI_RxSetFormat(I2S_Type *base,
AnnaBridge 161:aa5281ff4a02 665 sai_transfer_format_t *format,
AnnaBridge 161:aa5281ff4a02 666 uint32_t mclkSourceClockHz,
AnnaBridge 161:aa5281ff4a02 667 uint32_t bclkSourceClockHz);
AnnaBridge 161:aa5281ff4a02 668
AnnaBridge 161:aa5281ff4a02 669 /*!
AnnaBridge 161:aa5281ff4a02 670 * @brief Sends data using a blocking method.
AnnaBridge 161:aa5281ff4a02 671 *
AnnaBridge 161:aa5281ff4a02 672 * @note This function blocks by polling until data is ready to be sent.
AnnaBridge 161:aa5281ff4a02 673 *
AnnaBridge 161:aa5281ff4a02 674 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 675 * @param channel Data channel used.
AnnaBridge 161:aa5281ff4a02 676 * @param bitWidth How many bits in an audio word; usually 8/16/24/32 bits.
AnnaBridge 161:aa5281ff4a02 677 * @param buffer Pointer to the data to be written.
AnnaBridge 161:aa5281ff4a02 678 * @param size Bytes to be written.
AnnaBridge 161:aa5281ff4a02 679 */
AnnaBridge 161:aa5281ff4a02 680 void SAI_WriteBlocking(I2S_Type *base, uint32_t channel, uint32_t bitWidth, uint8_t *buffer, uint32_t size);
AnnaBridge 161:aa5281ff4a02 681
AnnaBridge 161:aa5281ff4a02 682 /*!
AnnaBridge 161:aa5281ff4a02 683 * @brief Writes data into SAI FIFO.
AnnaBridge 161:aa5281ff4a02 684 *
AnnaBridge 161:aa5281ff4a02 685 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 686 * @param channel Data channel used.
AnnaBridge 161:aa5281ff4a02 687 * @param data Data needs to be written.
AnnaBridge 161:aa5281ff4a02 688 */
AnnaBridge 161:aa5281ff4a02 689 static inline void SAI_WriteData(I2S_Type *base, uint32_t channel, uint32_t data)
AnnaBridge 161:aa5281ff4a02 690 {
AnnaBridge 161:aa5281ff4a02 691 base->TDR[channel] = data;
AnnaBridge 161:aa5281ff4a02 692 }
AnnaBridge 161:aa5281ff4a02 693
AnnaBridge 161:aa5281ff4a02 694 /*!
AnnaBridge 161:aa5281ff4a02 695 * @brief Receives data using a blocking method.
AnnaBridge 161:aa5281ff4a02 696 *
AnnaBridge 161:aa5281ff4a02 697 * @note This function blocks by polling until data is ready to be sent.
AnnaBridge 161:aa5281ff4a02 698 *
AnnaBridge 161:aa5281ff4a02 699 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 700 * @param channel Data channel used.
AnnaBridge 161:aa5281ff4a02 701 * @param bitWidth How many bits in an audio word; usually 8/16/24/32 bits.
AnnaBridge 161:aa5281ff4a02 702 * @param buffer Pointer to the data to be read.
AnnaBridge 161:aa5281ff4a02 703 * @param size Bytes to be read.
AnnaBridge 161:aa5281ff4a02 704 */
AnnaBridge 161:aa5281ff4a02 705 void SAI_ReadBlocking(I2S_Type *base, uint32_t channel, uint32_t bitWidth, uint8_t *buffer, uint32_t size);
AnnaBridge 161:aa5281ff4a02 706
AnnaBridge 161:aa5281ff4a02 707 /*!
AnnaBridge 161:aa5281ff4a02 708 * @brief Reads data from the SAI FIFO.
AnnaBridge 161:aa5281ff4a02 709 *
AnnaBridge 161:aa5281ff4a02 710 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 711 * @param channel Data channel used.
AnnaBridge 161:aa5281ff4a02 712 * @return Data in SAI FIFO.
AnnaBridge 161:aa5281ff4a02 713 */
AnnaBridge 161:aa5281ff4a02 714 static inline uint32_t SAI_ReadData(I2S_Type *base, uint32_t channel)
AnnaBridge 161:aa5281ff4a02 715 {
AnnaBridge 161:aa5281ff4a02 716 return base->RDR[channel];
AnnaBridge 161:aa5281ff4a02 717 }
AnnaBridge 161:aa5281ff4a02 718
AnnaBridge 161:aa5281ff4a02 719 /*! @} */
AnnaBridge 161:aa5281ff4a02 720
AnnaBridge 161:aa5281ff4a02 721 /*!
AnnaBridge 161:aa5281ff4a02 722 * @name Transactional
AnnaBridge 161:aa5281ff4a02 723 * @{
AnnaBridge 161:aa5281ff4a02 724 */
AnnaBridge 161:aa5281ff4a02 725
AnnaBridge 161:aa5281ff4a02 726 /*!
AnnaBridge 161:aa5281ff4a02 727 * @brief Initializes the SAI Tx handle.
AnnaBridge 161:aa5281ff4a02 728 *
AnnaBridge 161:aa5281ff4a02 729 * This function initializes the Tx handle for the SAI Tx transactional APIs. Call
AnnaBridge 161:aa5281ff4a02 730 * this function once to get the handle initialized.
AnnaBridge 161:aa5281ff4a02 731 *
AnnaBridge 161:aa5281ff4a02 732 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 733 * @param handle SAI handle pointer.
AnnaBridge 161:aa5281ff4a02 734 * @param callback Pointer to the user callback function.
AnnaBridge 161:aa5281ff4a02 735 * @param userData User parameter passed to the callback function
AnnaBridge 161:aa5281ff4a02 736 */
AnnaBridge 161:aa5281ff4a02 737 void SAI_TransferTxCreateHandle(I2S_Type *base, sai_handle_t *handle, sai_transfer_callback_t callback, void *userData);
AnnaBridge 161:aa5281ff4a02 738
AnnaBridge 161:aa5281ff4a02 739 /*!
AnnaBridge 161:aa5281ff4a02 740 * @brief Initializes the SAI Rx handle.
AnnaBridge 161:aa5281ff4a02 741 *
AnnaBridge 161:aa5281ff4a02 742 * This function initializes the Rx handle for the SAI Rx transactional APIs. Call
AnnaBridge 161:aa5281ff4a02 743 * this function once to get the handle initialized.
AnnaBridge 161:aa5281ff4a02 744 *
AnnaBridge 161:aa5281ff4a02 745 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 746 * @param handle SAI handle pointer.
AnnaBridge 161:aa5281ff4a02 747 * @param callback Pointer to the user callback function.
AnnaBridge 161:aa5281ff4a02 748 * @param userData User parameter passed to the callback function.
AnnaBridge 161:aa5281ff4a02 749 */
AnnaBridge 161:aa5281ff4a02 750 void SAI_TransferRxCreateHandle(I2S_Type *base, sai_handle_t *handle, sai_transfer_callback_t callback, void *userData);
AnnaBridge 161:aa5281ff4a02 751
AnnaBridge 161:aa5281ff4a02 752 /*!
AnnaBridge 161:aa5281ff4a02 753 * @brief Configures the SAI Tx audio format.
AnnaBridge 161:aa5281ff4a02 754 *
AnnaBridge 161:aa5281ff4a02 755 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 161:aa5281ff4a02 756 * format to be transferred.
AnnaBridge 161:aa5281ff4a02 757 *
AnnaBridge 161:aa5281ff4a02 758 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 759 * @param handle SAI handle pointer.
AnnaBridge 161:aa5281ff4a02 760 * @param format Pointer to the SAI audio data format structure.
AnnaBridge 161:aa5281ff4a02 761 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 161:aa5281ff4a02 762 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is a master
AnnaBridge 161:aa5281ff4a02 763 * clock, this value should equal the masterClockHz in format.
AnnaBridge 161:aa5281ff4a02 764 * @return Status of this function. Return value is the status_t.
AnnaBridge 161:aa5281ff4a02 765 */
AnnaBridge 161:aa5281ff4a02 766 status_t SAI_TransferTxSetFormat(I2S_Type *base,
AnnaBridge 161:aa5281ff4a02 767 sai_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 768 sai_transfer_format_t *format,
AnnaBridge 161:aa5281ff4a02 769 uint32_t mclkSourceClockHz,
AnnaBridge 161:aa5281ff4a02 770 uint32_t bclkSourceClockHz);
AnnaBridge 161:aa5281ff4a02 771
AnnaBridge 161:aa5281ff4a02 772 /*!
AnnaBridge 161:aa5281ff4a02 773 * @brief Configures the SAI Rx audio format.
AnnaBridge 161:aa5281ff4a02 774 *
AnnaBridge 161:aa5281ff4a02 775 * The audio format can be changed at run-time. This function configures the sample rate and audio data
AnnaBridge 161:aa5281ff4a02 776 * format to be transferred.
AnnaBridge 161:aa5281ff4a02 777 *
AnnaBridge 161:aa5281ff4a02 778 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 779 * @param handle SAI handle pointer.
AnnaBridge 161:aa5281ff4a02 780 * @param format Pointer to the SAI audio data format structure.
AnnaBridge 161:aa5281ff4a02 781 * @param mclkSourceClockHz SAI master clock source frequency in Hz.
AnnaBridge 161:aa5281ff4a02 782 * @param bclkSourceClockHz SAI bit clock source frequency in Hz. If a bit clock source is a master
AnnaBridge 161:aa5281ff4a02 783 * clock, this value should equal the masterClockHz in format.
AnnaBridge 161:aa5281ff4a02 784 * @return Status of this function. Return value is one of status_t.
AnnaBridge 161:aa5281ff4a02 785 */
AnnaBridge 161:aa5281ff4a02 786 status_t SAI_TransferRxSetFormat(I2S_Type *base,
AnnaBridge 161:aa5281ff4a02 787 sai_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 788 sai_transfer_format_t *format,
AnnaBridge 161:aa5281ff4a02 789 uint32_t mclkSourceClockHz,
AnnaBridge 161:aa5281ff4a02 790 uint32_t bclkSourceClockHz);
AnnaBridge 161:aa5281ff4a02 791
AnnaBridge 161:aa5281ff4a02 792 /*!
AnnaBridge 161:aa5281ff4a02 793 * @brief Performs an interrupt non-blocking send transfer on SAI.
AnnaBridge 161:aa5281ff4a02 794 *
AnnaBridge 161:aa5281ff4a02 795 * @note This API returns immediately after the transfer initiates.
AnnaBridge 161:aa5281ff4a02 796 * Call the SAI_TxGetTransferStatusIRQ to poll the transfer status and check whether
AnnaBridge 161:aa5281ff4a02 797 * the transfer is finished. If the return status is not kStatus_SAI_Busy, the transfer
AnnaBridge 161:aa5281ff4a02 798 * is finished.
AnnaBridge 161:aa5281ff4a02 799 *
AnnaBridge 161:aa5281ff4a02 800 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 801 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 802 * @param xfer Pointer to the sai_transfer_t structure.
AnnaBridge 161:aa5281ff4a02 803 * @retval kStatus_Success Successfully started the data receive.
AnnaBridge 161:aa5281ff4a02 804 * @retval kStatus_SAI_TxBusy Previous receive still not finished.
AnnaBridge 161:aa5281ff4a02 805 * @retval kStatus_InvalidArgument The input parameter is invalid.
AnnaBridge 161:aa5281ff4a02 806 */
AnnaBridge 161:aa5281ff4a02 807 status_t SAI_TransferSendNonBlocking(I2S_Type *base, sai_handle_t *handle, sai_transfer_t *xfer);
AnnaBridge 161:aa5281ff4a02 808
AnnaBridge 161:aa5281ff4a02 809 /*!
AnnaBridge 161:aa5281ff4a02 810 * @brief Performs an interrupt non-blocking receive transfer on SAI.
AnnaBridge 161:aa5281ff4a02 811 *
AnnaBridge 161:aa5281ff4a02 812 * @note This API returns immediately after the transfer initiates.
AnnaBridge 161:aa5281ff4a02 813 * Call the SAI_RxGetTransferStatusIRQ to poll the transfer status and check whether
AnnaBridge 161:aa5281ff4a02 814 * the transfer is finished. If the return status is not kStatus_SAI_Busy, the transfer
AnnaBridge 161:aa5281ff4a02 815 * is finished.
AnnaBridge 161:aa5281ff4a02 816 *
AnnaBridge 161:aa5281ff4a02 817 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 818 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 819 * @param xfer Pointer to the sai_transfer_t structure.
AnnaBridge 161:aa5281ff4a02 820 * @retval kStatus_Success Successfully started the data receive.
AnnaBridge 161:aa5281ff4a02 821 * @retval kStatus_SAI_RxBusy Previous receive still not finished.
AnnaBridge 161:aa5281ff4a02 822 * @retval kStatus_InvalidArgument The input parameter is invalid.
AnnaBridge 161:aa5281ff4a02 823 */
AnnaBridge 161:aa5281ff4a02 824 status_t SAI_TransferReceiveNonBlocking(I2S_Type *base, sai_handle_t *handle, sai_transfer_t *xfer);
AnnaBridge 161:aa5281ff4a02 825
AnnaBridge 161:aa5281ff4a02 826 /*!
AnnaBridge 161:aa5281ff4a02 827 * @brief Gets a set byte count.
AnnaBridge 161:aa5281ff4a02 828 *
AnnaBridge 161:aa5281ff4a02 829 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 830 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 831 * @param count Bytes count sent.
AnnaBridge 161:aa5281ff4a02 832 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 161:aa5281ff4a02 833 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 161:aa5281ff4a02 834 */
AnnaBridge 161:aa5281ff4a02 835 status_t SAI_TransferGetSendCount(I2S_Type *base, sai_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 836
AnnaBridge 161:aa5281ff4a02 837 /*!
AnnaBridge 161:aa5281ff4a02 838 * @brief Gets a received byte count.
AnnaBridge 161:aa5281ff4a02 839 *
AnnaBridge 161:aa5281ff4a02 840 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 841 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 842 * @param count Bytes count received.
AnnaBridge 161:aa5281ff4a02 843 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 161:aa5281ff4a02 844 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 161:aa5281ff4a02 845 */
AnnaBridge 161:aa5281ff4a02 846 status_t SAI_TransferGetReceiveCount(I2S_Type *base, sai_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 847
AnnaBridge 161:aa5281ff4a02 848 /*!
AnnaBridge 161:aa5281ff4a02 849 * @brief Aborts the current send.
AnnaBridge 161:aa5281ff4a02 850 *
AnnaBridge 161:aa5281ff4a02 851 * @note This API can be called any time when an interrupt non-blocking transfer initiates
AnnaBridge 161:aa5281ff4a02 852 * to abort the transfer early.
AnnaBridge 161:aa5281ff4a02 853 *
AnnaBridge 161:aa5281ff4a02 854 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 855 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 856 */
AnnaBridge 161:aa5281ff4a02 857 void SAI_TransferAbortSend(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 858
AnnaBridge 161:aa5281ff4a02 859 /*!
AnnaBridge 161:aa5281ff4a02 860 * @brief Aborts the the current IRQ receive.
AnnaBridge 161:aa5281ff4a02 861 *
AnnaBridge 161:aa5281ff4a02 862 * @note This API can be called when an interrupt non-blocking transfer initiates
AnnaBridge 161:aa5281ff4a02 863 * to abort the transfer early.
AnnaBridge 161:aa5281ff4a02 864 *
AnnaBridge 161:aa5281ff4a02 865 * @param base SAI base pointer
AnnaBridge 161:aa5281ff4a02 866 * @param handle Pointer to the sai_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 867 */
AnnaBridge 161:aa5281ff4a02 868 void SAI_TransferAbortReceive(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 869
AnnaBridge 161:aa5281ff4a02 870 /*!
AnnaBridge 161:aa5281ff4a02 871 * @brief Terminate all SAI send.
AnnaBridge 161:aa5281ff4a02 872 *
AnnaBridge 161:aa5281ff4a02 873 * This function will clear all transfer slots buffered in the sai queue. If users only want to abort the
AnnaBridge 161:aa5281ff4a02 874 * current transfer slot, please call SAI_TransferAbortSend.
AnnaBridge 161:aa5281ff4a02 875 *
AnnaBridge 161:aa5281ff4a02 876 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 877 * @param handle SAI eDMA handle pointer.
AnnaBridge 161:aa5281ff4a02 878 */
AnnaBridge 161:aa5281ff4a02 879 void SAI_TransferTerminateSend(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 880
AnnaBridge 161:aa5281ff4a02 881 /*!
AnnaBridge 161:aa5281ff4a02 882 * @brief Terminate all SAI receive.
AnnaBridge 161:aa5281ff4a02 883 *
AnnaBridge 161:aa5281ff4a02 884 * This function will clear all transfer slots buffered in the sai queue. If users only want to abort the
AnnaBridge 161:aa5281ff4a02 885 * current transfer slot, please call SAI_TransferAbortReceive.
AnnaBridge 161:aa5281ff4a02 886 *
AnnaBridge 161:aa5281ff4a02 887 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 888 * @param handle SAI eDMA handle pointer.
AnnaBridge 161:aa5281ff4a02 889 */
AnnaBridge 161:aa5281ff4a02 890 void SAI_TransferTerminateReceive(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 891
AnnaBridge 161:aa5281ff4a02 892 /*!
AnnaBridge 161:aa5281ff4a02 893 * @brief Tx interrupt handler.
AnnaBridge 161:aa5281ff4a02 894 *
AnnaBridge 161:aa5281ff4a02 895 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 896 * @param handle Pointer to the sai_handle_t structure.
AnnaBridge 161:aa5281ff4a02 897 */
AnnaBridge 161:aa5281ff4a02 898 void SAI_TransferTxHandleIRQ(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 899
AnnaBridge 161:aa5281ff4a02 900 /*!
AnnaBridge 161:aa5281ff4a02 901 * @brief Tx interrupt handler.
AnnaBridge 161:aa5281ff4a02 902 *
AnnaBridge 161:aa5281ff4a02 903 * @param base SAI base pointer.
AnnaBridge 161:aa5281ff4a02 904 * @param handle Pointer to the sai_handle_t structure.
AnnaBridge 161:aa5281ff4a02 905 */
AnnaBridge 161:aa5281ff4a02 906 void SAI_TransferRxHandleIRQ(I2S_Type *base, sai_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 907
AnnaBridge 161:aa5281ff4a02 908 /*! @} */
AnnaBridge 161:aa5281ff4a02 909
AnnaBridge 161:aa5281ff4a02 910 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 911 }
AnnaBridge 161:aa5281ff4a02 912 #endif /*_cplusplus*/
AnnaBridge 161:aa5281ff4a02 913
AnnaBridge 161:aa5281ff4a02 914 /*! @} */
AnnaBridge 161:aa5281ff4a02 915
AnnaBridge 161:aa5281ff4a02 916 #endif /* _FSL_SAI_H_ */