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.

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 172:65be27845400 1 /**
AnnaBridge 172:65be27845400 2 ******************************************************************************
AnnaBridge 172:65be27845400 3 * @file stm32l4xx_hal_sai.h
AnnaBridge 172:65be27845400 4 * @author MCD Application Team
AnnaBridge 172:65be27845400 5 * @brief Header file of SAI HAL module.
AnnaBridge 172:65be27845400 6 ******************************************************************************
AnnaBridge 172:65be27845400 7 * @attention
AnnaBridge 172:65be27845400 8 *
AnnaBridge 172:65be27845400 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 172:65be27845400 10 *
AnnaBridge 172:65be27845400 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 172:65be27845400 12 * are permitted provided that the following conditions are met:
AnnaBridge 172:65be27845400 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 172:65be27845400 14 * this list of conditions and the following disclaimer.
AnnaBridge 172:65be27845400 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 172:65be27845400 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 172:65be27845400 17 * and/or other materials provided with the distribution.
AnnaBridge 172:65be27845400 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 172:65be27845400 19 * may be used to endorse or promote products derived from this software
AnnaBridge 172:65be27845400 20 * without specific prior written permission.
AnnaBridge 172:65be27845400 21 *
AnnaBridge 172:65be27845400 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 172:65be27845400 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 172:65be27845400 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 172:65be27845400 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 172:65be27845400 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 172:65be27845400 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 172:65be27845400 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 172:65be27845400 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 172:65be27845400 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 172:65be27845400 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 172:65be27845400 32 *
AnnaBridge 172:65be27845400 33 ******************************************************************************
AnnaBridge 172:65be27845400 34 */
AnnaBridge 172:65be27845400 35
AnnaBridge 172:65be27845400 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 172:65be27845400 37 #ifndef __STM32L4xx_HAL_SAI_H
AnnaBridge 172:65be27845400 38 #define __STM32L4xx_HAL_SAI_H
AnnaBridge 172:65be27845400 39
AnnaBridge 172:65be27845400 40 #ifdef __cplusplus
AnnaBridge 172:65be27845400 41 extern "C" {
AnnaBridge 172:65be27845400 42 #endif
AnnaBridge 172:65be27845400 43
AnnaBridge 172:65be27845400 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 172:65be27845400 45 #include "stm32l4xx_hal_def.h"
AnnaBridge 172:65be27845400 46
AnnaBridge 172:65be27845400 47 /** @addtogroup STM32L4xx_HAL_Driver
AnnaBridge 172:65be27845400 48 * @{
AnnaBridge 172:65be27845400 49 */
AnnaBridge 172:65be27845400 50
AnnaBridge 172:65be27845400 51 /** @addtogroup SAI
AnnaBridge 172:65be27845400 52 * @{
AnnaBridge 172:65be27845400 53 */
AnnaBridge 172:65be27845400 54
AnnaBridge 172:65be27845400 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 56 /** @defgroup SAI_Exported_Types SAI Exported Types
AnnaBridge 172:65be27845400 57 * @{
AnnaBridge 172:65be27845400 58 */
AnnaBridge 172:65be27845400 59
AnnaBridge 172:65be27845400 60 /**
AnnaBridge 172:65be27845400 61 * @brief HAL State structures definition
AnnaBridge 172:65be27845400 62 */
AnnaBridge 172:65be27845400 63 typedef enum
AnnaBridge 172:65be27845400 64 {
AnnaBridge 172:65be27845400 65 HAL_SAI_STATE_RESET = 0x00U, /*!< SAI not yet initialized or disabled */
AnnaBridge 172:65be27845400 66 HAL_SAI_STATE_READY = 0x01U, /*!< SAI initialized and ready for use */
AnnaBridge 172:65be27845400 67 HAL_SAI_STATE_BUSY = 0x02U, /*!< SAI internal process is ongoing */
AnnaBridge 172:65be27845400 68 HAL_SAI_STATE_BUSY_TX = 0x12U, /*!< Data transmission process is ongoing */
AnnaBridge 172:65be27845400 69 HAL_SAI_STATE_BUSY_RX = 0x22U, /*!< Data reception process is ongoing */
AnnaBridge 172:65be27845400 70 }HAL_SAI_StateTypeDef;
AnnaBridge 172:65be27845400 71
AnnaBridge 172:65be27845400 72 /**
AnnaBridge 172:65be27845400 73 * @brief SAI Callback prototype
AnnaBridge 172:65be27845400 74 */
AnnaBridge 172:65be27845400 75 typedef void (*SAIcallback)(void);
AnnaBridge 172:65be27845400 76
AnnaBridge 172:65be27845400 77 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 78 /**
AnnaBridge 172:65be27845400 79 * @brief SAI PDM Init structure definition
AnnaBridge 172:65be27845400 80 */
AnnaBridge 172:65be27845400 81 typedef struct
AnnaBridge 172:65be27845400 82 {
AnnaBridge 172:65be27845400 83 FunctionalState Activation; /*!< Enable/disable PDM interface */
AnnaBridge 172:65be27845400 84 uint32_t MicPairsNbr; /*!< Specifies the number of microphone pairs used.
AnnaBridge 172:65be27845400 85 This parameter must be a number between Min_Data = 1 and Max_Data = 3. */
AnnaBridge 172:65be27845400 86 uint32_t ClockEnable; /*!< Specifies which clock must be enabled.
AnnaBridge 172:65be27845400 87 This parameter can be a values combination of @ref SAI_PDM_ClockEnable */
AnnaBridge 172:65be27845400 88 }SAI_PdmInitTypeDef;
AnnaBridge 172:65be27845400 89 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 90
AnnaBridge 172:65be27845400 91 /** @defgroup SAI_Init_Structure_definition SAI Init Structure definition
AnnaBridge 172:65be27845400 92 * @brief SAI Init Structure definition
AnnaBridge 172:65be27845400 93 * @{
AnnaBridge 172:65be27845400 94 */
AnnaBridge 172:65be27845400 95 typedef struct
AnnaBridge 172:65be27845400 96 {
AnnaBridge 172:65be27845400 97 uint32_t AudioMode; /*!< Specifies the SAI Block audio Mode.
AnnaBridge 172:65be27845400 98 This parameter can be a value of @ref SAI_Block_Mode */
AnnaBridge 172:65be27845400 99
AnnaBridge 172:65be27845400 100 uint32_t Synchro; /*!< Specifies SAI Block synchronization
AnnaBridge 172:65be27845400 101 This parameter can be a value of @ref SAI_Block_Synchronization */
AnnaBridge 172:65be27845400 102
AnnaBridge 172:65be27845400 103 uint32_t SynchroExt; /*!< Specifies SAI external output synchronization, this setup is common
AnnaBridge 172:65be27845400 104 for BlockA and BlockB
AnnaBridge 172:65be27845400 105 This parameter can be a value of @ref SAI_Block_SyncExt
AnnaBridge 172:65be27845400 106 @note: If both audio blocks of same SAI are used, this parameter has
AnnaBridge 172:65be27845400 107 to be set to the same value for each audio block */
AnnaBridge 172:65be27845400 108
AnnaBridge 172:65be27845400 109 uint32_t OutputDrive; /*!< Specifies when SAI Block outputs are driven.
AnnaBridge 172:65be27845400 110 This parameter can be a value of @ref SAI_Block_Output_Drive
AnnaBridge 172:65be27845400 111 @note this value has to be set before enabling the audio block
AnnaBridge 172:65be27845400 112 but after the audio block configuration. */
AnnaBridge 172:65be27845400 113
AnnaBridge 172:65be27845400 114 uint32_t NoDivider; /*!< Specifies whether master clock will be divided or not.
AnnaBridge 172:65be27845400 115 This parameter can be a value of @ref SAI_Block_NoDivider
AnnaBridge 172:65be27845400 116 @note: For STM32L4Rx/STM32L4Sx devices :
AnnaBridge 172:65be27845400 117 If bit NOMCK in the SAI_xCR1 register is cleared, the frame length
AnnaBridge 172:65be27845400 118 should be aligned to a number equal to a power of 2, from 8 to 256.
AnnaBridge 172:65be27845400 119 If bit NOMCK in the SAI_xCR1 register is set, the frame length can
AnnaBridge 172:65be27845400 120 take any of the values without constraint. There is no MCLK_x clock
AnnaBridge 172:65be27845400 121 which can be output.
AnnaBridge 172:65be27845400 122 For other devices :
AnnaBridge 172:65be27845400 123 If bit NODIV in the SAI_xCR1 register is cleared, the frame length
AnnaBridge 172:65be27845400 124 should be aligned to a number equal to a power of 2, from 8 to 256.
AnnaBridge 172:65be27845400 125 If bit NODIV in the SAI_xCR1 register is set, the frame length can
AnnaBridge 172:65be27845400 126 take any of the values without constraint since the input clock of
AnnaBridge 172:65be27845400 127 the audio block should be equal to the bit clock.
AnnaBridge 172:65be27845400 128 There is no MCLK_x clock which can be output. */
AnnaBridge 172:65be27845400 129
AnnaBridge 172:65be27845400 130 uint32_t FIFOThreshold; /*!< Specifies SAI Block FIFO threshold.
AnnaBridge 172:65be27845400 131 This parameter can be a value of @ref SAI_Block_Fifo_Threshold */
AnnaBridge 172:65be27845400 132
AnnaBridge 172:65be27845400 133 uint32_t AudioFrequency; /*!< Specifies the audio frequency sampling.
AnnaBridge 172:65be27845400 134 This parameter can be a value of @ref SAI_Audio_Frequency */
AnnaBridge 172:65be27845400 135
AnnaBridge 172:65be27845400 136 uint32_t Mckdiv; /*!< Specifies the master clock divider, the parameter will be used if for
AnnaBridge 172:65be27845400 137 AudioFrequency the user choice
AnnaBridge 172:65be27845400 138 This parameter must be a number between Min_Data = 0 and Max_Data = 63 on STM32L4Rx/STM32L4Sx devices.
AnnaBridge 172:65be27845400 139 This parameter must be a number between Min_Data = 0 and Max_Data = 15 on other devices. */
AnnaBridge 172:65be27845400 140
AnnaBridge 172:65be27845400 141 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 142 uint32_t MckOverSampling; /*!< Specifies the master clock oversampling.
AnnaBridge 172:65be27845400 143 This parameter can be a value of @ref SAI_Block_Mck_OverSampling */
AnnaBridge 172:65be27845400 144 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 145
AnnaBridge 172:65be27845400 146 uint32_t MonoStereoMode; /*!< Specifies if the mono or stereo mode is selected.
AnnaBridge 172:65be27845400 147 This parameter can be a value of @ref SAI_Mono_Stereo_Mode */
AnnaBridge 172:65be27845400 148
AnnaBridge 172:65be27845400 149 uint32_t CompandingMode; /*!< Specifies the companding mode type.
AnnaBridge 172:65be27845400 150 This parameter can be a value of @ref SAI_Block_Companding_Mode */
AnnaBridge 172:65be27845400 151
AnnaBridge 172:65be27845400 152 uint32_t TriState; /*!< Specifies the companding mode type.
AnnaBridge 172:65be27845400 153 This parameter can be a value of @ref SAI_TRIState_Management */
AnnaBridge 172:65be27845400 154
AnnaBridge 172:65be27845400 155 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 156 SAI_PdmInitTypeDef PdmInit; /*!< Specifies the PDM configuration. */
AnnaBridge 172:65be27845400 157 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 158
AnnaBridge 172:65be27845400 159 /* This part of the structure is automatically filled if your are using the high level initialisation
AnnaBridge 172:65be27845400 160 function HAL_SAI_InitProtocol */
AnnaBridge 172:65be27845400 161
AnnaBridge 172:65be27845400 162 uint32_t Protocol; /*!< Specifies the SAI Block protocol.
AnnaBridge 172:65be27845400 163 This parameter can be a value of @ref SAI_Block_Protocol */
AnnaBridge 172:65be27845400 164
AnnaBridge 172:65be27845400 165 uint32_t DataSize; /*!< Specifies the SAI Block data size.
AnnaBridge 172:65be27845400 166 This parameter can be a value of @ref SAI_Block_Data_Size */
AnnaBridge 172:65be27845400 167
AnnaBridge 172:65be27845400 168 uint32_t FirstBit; /*!< Specifies whether data transfers start from MSB or LSB bit.
AnnaBridge 172:65be27845400 169 This parameter can be a value of @ref SAI_Block_MSB_LSB_transmission */
AnnaBridge 172:65be27845400 170
AnnaBridge 172:65be27845400 171 uint32_t ClockStrobing; /*!< Specifies the SAI Block clock strobing edge sensitivity.
AnnaBridge 172:65be27845400 172 This parameter can be a value of @ref SAI_Block_Clock_Strobing */
AnnaBridge 172:65be27845400 173 }SAI_InitTypeDef;
AnnaBridge 172:65be27845400 174 /**
AnnaBridge 172:65be27845400 175 * @}
AnnaBridge 172:65be27845400 176 */
AnnaBridge 172:65be27845400 177
AnnaBridge 172:65be27845400 178 /** @defgroup SAI_Frame_Structure_definition SAI Frame Structure definition
AnnaBridge 172:65be27845400 179 * @brief SAI Frame Init structure definition
AnnaBridge 172:65be27845400 180 * @{
AnnaBridge 172:65be27845400 181 */
AnnaBridge 172:65be27845400 182 typedef struct
AnnaBridge 172:65be27845400 183 {
AnnaBridge 172:65be27845400 184
AnnaBridge 172:65be27845400 185 uint32_t FrameLength; /*!< Specifies the Frame length, the number of SCK clocks for each audio frame.
AnnaBridge 172:65be27845400 186 This parameter must be a number between Min_Data = 8 and Max_Data = 256.
AnnaBridge 172:65be27845400 187 @note: If master clock MCLK_x pin is declared as an output, the frame length
AnnaBridge 172:65be27845400 188 should be aligned to a number equal to power of 2 in order to keep
AnnaBridge 172:65be27845400 189 in an audio frame, an integer number of MCLK pulses by bit Clock. */
AnnaBridge 172:65be27845400 190
AnnaBridge 172:65be27845400 191 uint32_t ActiveFrameLength; /*!< Specifies the Frame synchronization active level length.
AnnaBridge 172:65be27845400 192 This Parameter specifies the length in number of bit clock (SCK + 1)
AnnaBridge 172:65be27845400 193 of the active level of FS signal in audio frame.
AnnaBridge 172:65be27845400 194 This parameter must be a number between Min_Data = 1 and Max_Data = 128 */
AnnaBridge 172:65be27845400 195
AnnaBridge 172:65be27845400 196 uint32_t FSDefinition; /*!< Specifies the Frame synchronization definition.
AnnaBridge 172:65be27845400 197 This parameter can be a value of @ref SAI_Block_FS_Definition */
AnnaBridge 172:65be27845400 198
AnnaBridge 172:65be27845400 199 uint32_t FSPolarity; /*!< Specifies the Frame synchronization Polarity.
AnnaBridge 172:65be27845400 200 This parameter can be a value of @ref SAI_Block_FS_Polarity */
AnnaBridge 172:65be27845400 201
AnnaBridge 172:65be27845400 202 uint32_t FSOffset; /*!< Specifies the Frame synchronization Offset.
AnnaBridge 172:65be27845400 203 This parameter can be a value of @ref SAI_Block_FS_Offset */
AnnaBridge 172:65be27845400 204
AnnaBridge 172:65be27845400 205 }SAI_FrameInitTypeDef;
AnnaBridge 172:65be27845400 206 /**
AnnaBridge 172:65be27845400 207 * @}
AnnaBridge 172:65be27845400 208 */
AnnaBridge 172:65be27845400 209
AnnaBridge 172:65be27845400 210 /** @defgroup SAI_Slot_Structure_definition SAI Slot Structure definition
AnnaBridge 172:65be27845400 211 * @brief SAI Block Slot Init Structure definition
AnnaBridge 172:65be27845400 212 * @{
AnnaBridge 172:65be27845400 213 */
AnnaBridge 172:65be27845400 214 typedef struct
AnnaBridge 172:65be27845400 215 {
AnnaBridge 172:65be27845400 216 uint32_t FirstBitOffset; /*!< Specifies the position of first data transfer bit in the slot.
AnnaBridge 172:65be27845400 217 This parameter must be a number between Min_Data = 0 and Max_Data = 24 */
AnnaBridge 172:65be27845400 218
AnnaBridge 172:65be27845400 219 uint32_t SlotSize; /*!< Specifies the Slot Size.
AnnaBridge 172:65be27845400 220 This parameter can be a value of @ref SAI_Block_Slot_Size */
AnnaBridge 172:65be27845400 221
AnnaBridge 172:65be27845400 222 uint32_t SlotNumber; /*!< Specifies the number of slot in the audio frame.
AnnaBridge 172:65be27845400 223 This parameter must be a number between Min_Data = 1 and Max_Data = 16 */
AnnaBridge 172:65be27845400 224
AnnaBridge 172:65be27845400 225 uint32_t SlotActive; /*!< Specifies the slots in audio frame that will be activated.
AnnaBridge 172:65be27845400 226 This parameter can be a value of @ref SAI_Block_Slot_Active */
AnnaBridge 172:65be27845400 227 }SAI_SlotInitTypeDef;
AnnaBridge 172:65be27845400 228 /**
AnnaBridge 172:65be27845400 229 * @}
AnnaBridge 172:65be27845400 230 */
AnnaBridge 172:65be27845400 231
AnnaBridge 172:65be27845400 232 /** @defgroup SAI_Handle_Structure_definition SAI Handle Structure definition
AnnaBridge 172:65be27845400 233 * @brief SAI handle Structure definition
AnnaBridge 172:65be27845400 234 * @{
AnnaBridge 172:65be27845400 235 */
AnnaBridge 172:65be27845400 236 typedef struct __SAI_HandleTypeDef
AnnaBridge 172:65be27845400 237 {
AnnaBridge 172:65be27845400 238 SAI_Block_TypeDef *Instance; /*!< SAI Blockx registers base address */
AnnaBridge 172:65be27845400 239
AnnaBridge 172:65be27845400 240 SAI_InitTypeDef Init; /*!< SAI communication parameters */
AnnaBridge 172:65be27845400 241
AnnaBridge 172:65be27845400 242 SAI_FrameInitTypeDef FrameInit; /*!< SAI Frame configuration parameters */
AnnaBridge 172:65be27845400 243
AnnaBridge 172:65be27845400 244 SAI_SlotInitTypeDef SlotInit; /*!< SAI Slot configuration parameters */
AnnaBridge 172:65be27845400 245
AnnaBridge 172:65be27845400 246 uint8_t *pBuffPtr; /*!< Pointer to SAI transfer Buffer */
AnnaBridge 172:65be27845400 247
AnnaBridge 172:65be27845400 248 uint16_t XferSize; /*!< SAI transfer size */
AnnaBridge 172:65be27845400 249
AnnaBridge 172:65be27845400 250 uint16_t XferCount; /*!< SAI transfer counter */
AnnaBridge 172:65be27845400 251
AnnaBridge 172:65be27845400 252 DMA_HandleTypeDef *hdmatx; /*!< SAI Tx DMA handle parameters */
AnnaBridge 172:65be27845400 253
AnnaBridge 172:65be27845400 254 DMA_HandleTypeDef *hdmarx; /*!< SAI Rx DMA handle parameters */
AnnaBridge 172:65be27845400 255
AnnaBridge 172:65be27845400 256 SAIcallback mutecallback; /*!< SAI mute callback */
AnnaBridge 172:65be27845400 257
AnnaBridge 172:65be27845400 258 void (*InterruptServiceRoutine)(struct __SAI_HandleTypeDef *hsai); /* function pointer for IRQ handler */
AnnaBridge 172:65be27845400 259
AnnaBridge 172:65be27845400 260 HAL_LockTypeDef Lock; /*!< SAI locking object */
AnnaBridge 172:65be27845400 261
AnnaBridge 172:65be27845400 262 __IO HAL_SAI_StateTypeDef State; /*!< SAI communication state */
AnnaBridge 172:65be27845400 263
AnnaBridge 172:65be27845400 264 __IO uint32_t ErrorCode; /*!< SAI Error code */
AnnaBridge 172:65be27845400 265 }SAI_HandleTypeDef;
AnnaBridge 172:65be27845400 266 /**
AnnaBridge 172:65be27845400 267 * @}
AnnaBridge 172:65be27845400 268 */
AnnaBridge 172:65be27845400 269
AnnaBridge 172:65be27845400 270 /**
AnnaBridge 172:65be27845400 271 * @}
AnnaBridge 172:65be27845400 272 */
AnnaBridge 172:65be27845400 273
AnnaBridge 172:65be27845400 274 /* Exported constants --------------------------------------------------------*/
AnnaBridge 172:65be27845400 275
AnnaBridge 172:65be27845400 276 /** @defgroup SAI_Exported_Constants SAI Exported Constants
AnnaBridge 172:65be27845400 277 * @{
AnnaBridge 172:65be27845400 278 */
AnnaBridge 172:65be27845400 279
AnnaBridge 172:65be27845400 280 /** @defgroup SAI_Error_Code SAI Error Code
AnnaBridge 172:65be27845400 281 * @{
AnnaBridge 172:65be27845400 282 */
AnnaBridge 172:65be27845400 283 #define HAL_SAI_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
AnnaBridge 172:65be27845400 284 #define HAL_SAI_ERROR_OVR ((uint32_t)0x00000001U) /*!< Overrun Error */
AnnaBridge 172:65be27845400 285 #define HAL_SAI_ERROR_UDR ((uint32_t)0x00000002U) /*!< Underrun error */
AnnaBridge 172:65be27845400 286 #define HAL_SAI_ERROR_AFSDET ((uint32_t)0x00000004U) /*!< Anticipated Frame synchronisation detection */
AnnaBridge 172:65be27845400 287 #define HAL_SAI_ERROR_LFSDET ((uint32_t)0x00000008U) /*!< Late Frame synchronisation detection */
AnnaBridge 172:65be27845400 288 #define HAL_SAI_ERROR_CNREADY ((uint32_t)0x00000010U) /*!< codec not ready */
AnnaBridge 172:65be27845400 289 #define HAL_SAI_ERROR_WCKCFG ((uint32_t)0x00000020U) /*!< Wrong clock configuration */
AnnaBridge 172:65be27845400 290 #define HAL_SAI_ERROR_TIMEOUT ((uint32_t)0x00000040U) /*!< Timeout error */
AnnaBridge 172:65be27845400 291 #define HAL_SAI_ERROR_DMA ((uint32_t)0x00000080U) /*!< DMA error */
AnnaBridge 172:65be27845400 292 /**
AnnaBridge 172:65be27845400 293 * @}
AnnaBridge 172:65be27845400 294 */
AnnaBridge 172:65be27845400 295
AnnaBridge 172:65be27845400 296 /** @defgroup SAI_Block_SyncExt SAI External synchronisation
AnnaBridge 172:65be27845400 297 * @{
AnnaBridge 172:65be27845400 298 */
AnnaBridge 172:65be27845400 299 #define SAI_SYNCEXT_DISABLE 0
AnnaBridge 172:65be27845400 300 #define SAI_SYNCEXT_OUTBLOCKA_ENABLE 1
AnnaBridge 172:65be27845400 301 #define SAI_SYNCEXT_OUTBLOCKB_ENABLE 2
AnnaBridge 172:65be27845400 302 /**
AnnaBridge 172:65be27845400 303 * @}
AnnaBridge 172:65be27845400 304 */
AnnaBridge 172:65be27845400 305
AnnaBridge 172:65be27845400 306 /** @defgroup SAI_Protocol SAI Supported protocol
AnnaBridge 172:65be27845400 307 * @{
AnnaBridge 172:65be27845400 308 */
AnnaBridge 172:65be27845400 309 #define SAI_I2S_STANDARD 0
AnnaBridge 172:65be27845400 310 #define SAI_I2S_MSBJUSTIFIED 1
AnnaBridge 172:65be27845400 311 #define SAI_I2S_LSBJUSTIFIED 2
AnnaBridge 172:65be27845400 312 #define SAI_PCM_LONG 3
AnnaBridge 172:65be27845400 313 #define SAI_PCM_SHORT 4
AnnaBridge 172:65be27845400 314 /**
AnnaBridge 172:65be27845400 315 * @}
AnnaBridge 172:65be27845400 316 */
AnnaBridge 172:65be27845400 317
AnnaBridge 172:65be27845400 318 /** @defgroup SAI_Protocol_DataSize SAI protocol data size
AnnaBridge 172:65be27845400 319 * @{
AnnaBridge 172:65be27845400 320 */
AnnaBridge 172:65be27845400 321 #define SAI_PROTOCOL_DATASIZE_16BIT 0
AnnaBridge 172:65be27845400 322 #define SAI_PROTOCOL_DATASIZE_16BITEXTENDED 1
AnnaBridge 172:65be27845400 323 #define SAI_PROTOCOL_DATASIZE_24BIT 2
AnnaBridge 172:65be27845400 324 #define SAI_PROTOCOL_DATASIZE_32BIT 3
AnnaBridge 172:65be27845400 325 /**
AnnaBridge 172:65be27845400 326 * @}
AnnaBridge 172:65be27845400 327 */
AnnaBridge 172:65be27845400 328
AnnaBridge 172:65be27845400 329 /** @defgroup SAI_Audio_Frequency SAI Audio Frequency
AnnaBridge 172:65be27845400 330 * @{
AnnaBridge 172:65be27845400 331 */
AnnaBridge 172:65be27845400 332 #define SAI_AUDIO_FREQUENCY_192K ((uint32_t)192000U)
AnnaBridge 172:65be27845400 333 #define SAI_AUDIO_FREQUENCY_96K ((uint32_t)96000U)
AnnaBridge 172:65be27845400 334 #define SAI_AUDIO_FREQUENCY_48K ((uint32_t)48000U)
AnnaBridge 172:65be27845400 335 #define SAI_AUDIO_FREQUENCY_44K ((uint32_t)44100U)
AnnaBridge 172:65be27845400 336 #define SAI_AUDIO_FREQUENCY_32K ((uint32_t)32000U)
AnnaBridge 172:65be27845400 337 #define SAI_AUDIO_FREQUENCY_22K ((uint32_t)22050U)
AnnaBridge 172:65be27845400 338 #define SAI_AUDIO_FREQUENCY_16K ((uint32_t)16000U)
AnnaBridge 172:65be27845400 339 #define SAI_AUDIO_FREQUENCY_11K ((uint32_t)11025U)
AnnaBridge 172:65be27845400 340 #define SAI_AUDIO_FREQUENCY_8K ((uint32_t)8000U)
AnnaBridge 172:65be27845400 341 #define SAI_AUDIO_FREQUENCY_MCKDIV ((uint32_t)0U)
AnnaBridge 172:65be27845400 342 /**
AnnaBridge 172:65be27845400 343 * @}
AnnaBridge 172:65be27845400 344 */
AnnaBridge 172:65be27845400 345
AnnaBridge 172:65be27845400 346 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 347 /** @defgroup SAI_Block_Mck_OverSampling SAI Block Master Clock OverSampling
AnnaBridge 172:65be27845400 348 * @{
AnnaBridge 172:65be27845400 349 */
AnnaBridge 172:65be27845400 350 #define SAI_MCK_OVERSAMPLING_DISABLE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 351 #define SAI_MCK_OVERSAMPLING_ENABLE ((uint32_t)SAI_xCR1_OSR)
AnnaBridge 172:65be27845400 352 /**
AnnaBridge 172:65be27845400 353 * @}
AnnaBridge 172:65be27845400 354 */
AnnaBridge 172:65be27845400 355
AnnaBridge 172:65be27845400 356 /** @defgroup SAI_PDM_ClockEnable SAI PDM Clock Enable
AnnaBridge 172:65be27845400 357 * @{
AnnaBridge 172:65be27845400 358 */
AnnaBridge 172:65be27845400 359 #define SAI_PDM_CLOCK1_ENABLE ((uint32_t)SAI_PDMCR_CKEN1)
AnnaBridge 172:65be27845400 360 #define SAI_PDM_CLOCK2_ENABLE ((uint32_t)SAI_PDMCR_CKEN2)
AnnaBridge 172:65be27845400 361 /**
AnnaBridge 172:65be27845400 362 * @}
AnnaBridge 172:65be27845400 363 */
AnnaBridge 172:65be27845400 364 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 365
AnnaBridge 172:65be27845400 366 /** @defgroup SAI_Block_Mode SAI Block Mode
AnnaBridge 172:65be27845400 367 * @{
AnnaBridge 172:65be27845400 368 */
AnnaBridge 172:65be27845400 369 #define SAI_MODEMASTER_TX ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 370 #define SAI_MODEMASTER_RX ((uint32_t)SAI_xCR1_MODE_0)
AnnaBridge 172:65be27845400 371 #define SAI_MODESLAVE_TX ((uint32_t)SAI_xCR1_MODE_1)
AnnaBridge 172:65be27845400 372 #define SAI_MODESLAVE_RX ((uint32_t)(SAI_xCR1_MODE_1 | SAI_xCR1_MODE_0))
AnnaBridge 172:65be27845400 373
AnnaBridge 172:65be27845400 374 /**
AnnaBridge 172:65be27845400 375 * @}
AnnaBridge 172:65be27845400 376 */
AnnaBridge 172:65be27845400 377
AnnaBridge 172:65be27845400 378 /** @defgroup SAI_Block_Protocol SAI Block Protocol
AnnaBridge 172:65be27845400 379 * @{
AnnaBridge 172:65be27845400 380 */
AnnaBridge 172:65be27845400 381 #define SAI_FREE_PROTOCOL ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 382 #define SAI_SPDIF_PROTOCOL ((uint32_t)SAI_xCR1_PRTCFG_0)
AnnaBridge 172:65be27845400 383 #define SAI_AC97_PROTOCOL ((uint32_t)SAI_xCR1_PRTCFG_1)
AnnaBridge 172:65be27845400 384 /**
AnnaBridge 172:65be27845400 385 * @}
AnnaBridge 172:65be27845400 386 */
AnnaBridge 172:65be27845400 387
AnnaBridge 172:65be27845400 388 /** @defgroup SAI_Block_Data_Size SAI Block Data Size
AnnaBridge 172:65be27845400 389 * @{
AnnaBridge 172:65be27845400 390 */
AnnaBridge 172:65be27845400 391 #define SAI_DATASIZE_8 ((uint32_t)SAI_xCR1_DS_1)
AnnaBridge 172:65be27845400 392 #define SAI_DATASIZE_10 ((uint32_t)(SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
AnnaBridge 172:65be27845400 393 #define SAI_DATASIZE_16 ((uint32_t)SAI_xCR1_DS_2)
AnnaBridge 172:65be27845400 394 #define SAI_DATASIZE_20 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_0))
AnnaBridge 172:65be27845400 395 #define SAI_DATASIZE_24 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1))
AnnaBridge 172:65be27845400 396 #define SAI_DATASIZE_32 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
AnnaBridge 172:65be27845400 397 /**
AnnaBridge 172:65be27845400 398 * @}
AnnaBridge 172:65be27845400 399 */
AnnaBridge 172:65be27845400 400
AnnaBridge 172:65be27845400 401 /** @defgroup SAI_Block_MSB_LSB_transmission SAI Block MSB LSB transmission
AnnaBridge 172:65be27845400 402 * @{
AnnaBridge 172:65be27845400 403 */
AnnaBridge 172:65be27845400 404 #define SAI_FIRSTBIT_MSB ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 405 #define SAI_FIRSTBIT_LSB ((uint32_t)SAI_xCR1_LSBFIRST)
AnnaBridge 172:65be27845400 406 /**
AnnaBridge 172:65be27845400 407 * @}
AnnaBridge 172:65be27845400 408 */
AnnaBridge 172:65be27845400 409
AnnaBridge 172:65be27845400 410 /** @defgroup SAI_Block_Clock_Strobing SAI Block Clock Strobing
AnnaBridge 172:65be27845400 411 * @{
AnnaBridge 172:65be27845400 412 */
AnnaBridge 172:65be27845400 413 #define SAI_CLOCKSTROBING_FALLINGEDGE 0
AnnaBridge 172:65be27845400 414 #define SAI_CLOCKSTROBING_RISINGEDGE 1
AnnaBridge 172:65be27845400 415 /**
AnnaBridge 172:65be27845400 416 * @}
AnnaBridge 172:65be27845400 417 */
AnnaBridge 172:65be27845400 418
AnnaBridge 172:65be27845400 419 /** @defgroup SAI_Block_Synchronization SAI Block Synchronization
AnnaBridge 172:65be27845400 420 * @{
AnnaBridge 172:65be27845400 421 */
AnnaBridge 172:65be27845400 422 #define SAI_ASYNCHRONOUS 0 /*!< Asynchronous */
AnnaBridge 172:65be27845400 423 #define SAI_SYNCHRONOUS 1 /*!< Synchronous with other block of same SAI */
AnnaBridge 172:65be27845400 424 #define SAI_SYNCHRONOUS_EXT_SAI1 2 /*!< Synchronous with other SAI, SAI1 */
AnnaBridge 172:65be27845400 425 #define SAI_SYNCHRONOUS_EXT_SAI2 3 /*!< Synchronous with other SAI, SAI2 */
AnnaBridge 172:65be27845400 426 /**
AnnaBridge 172:65be27845400 427 * @}
AnnaBridge 172:65be27845400 428 */
AnnaBridge 172:65be27845400 429
AnnaBridge 172:65be27845400 430 /** @defgroup SAI_Block_Output_Drive SAI Block Output Drive
AnnaBridge 172:65be27845400 431 * @{
AnnaBridge 172:65be27845400 432 */
AnnaBridge 172:65be27845400 433 #define SAI_OUTPUTDRIVE_DISABLE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 434 #define SAI_OUTPUTDRIVE_ENABLE ((uint32_t)SAI_xCR1_OUTDRIV)
AnnaBridge 172:65be27845400 435 /**
AnnaBridge 172:65be27845400 436 * @}
AnnaBridge 172:65be27845400 437 */
AnnaBridge 172:65be27845400 438
AnnaBridge 172:65be27845400 439 /** @defgroup SAI_Block_NoDivider SAI Block NoDivider
AnnaBridge 172:65be27845400 440 * @{
AnnaBridge 172:65be27845400 441 */
AnnaBridge 172:65be27845400 442 #define SAI_MASTERDIVIDER_ENABLE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 443 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 444 #define SAI_MASTERDIVIDER_DISABLE ((uint32_t)SAI_xCR1_NOMCK)
AnnaBridge 172:65be27845400 445 #else
AnnaBridge 172:65be27845400 446 #define SAI_MASTERDIVIDER_DISABLE ((uint32_t)SAI_xCR1_NODIV)
AnnaBridge 172:65be27845400 447 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 448 /**
AnnaBridge 172:65be27845400 449 * @}
AnnaBridge 172:65be27845400 450 */
AnnaBridge 172:65be27845400 451
AnnaBridge 172:65be27845400 452
AnnaBridge 172:65be27845400 453 /** @defgroup SAI_Block_FS_Definition SAI Block FS Definition
AnnaBridge 172:65be27845400 454 * @{
AnnaBridge 172:65be27845400 455 */
AnnaBridge 172:65be27845400 456 #define SAI_FS_STARTFRAME ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 457 #define SAI_FS_CHANNEL_IDENTIFICATION ((uint32_t)SAI_xFRCR_FSDEF)
AnnaBridge 172:65be27845400 458 /**
AnnaBridge 172:65be27845400 459 * @}
AnnaBridge 172:65be27845400 460 */
AnnaBridge 172:65be27845400 461
AnnaBridge 172:65be27845400 462 /** @defgroup SAI_Block_FS_Polarity SAI Block FS Polarity
AnnaBridge 172:65be27845400 463 * @{
AnnaBridge 172:65be27845400 464 */
AnnaBridge 172:65be27845400 465 #define SAI_FS_ACTIVE_LOW ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 466 #define SAI_FS_ACTIVE_HIGH ((uint32_t)SAI_xFRCR_FSPOL)
AnnaBridge 172:65be27845400 467 /**
AnnaBridge 172:65be27845400 468 * @}
AnnaBridge 172:65be27845400 469 */
AnnaBridge 172:65be27845400 470
AnnaBridge 172:65be27845400 471 /** @defgroup SAI_Block_FS_Offset SAI Block FS Offset
AnnaBridge 172:65be27845400 472 * @{
AnnaBridge 172:65be27845400 473 */
AnnaBridge 172:65be27845400 474 #define SAI_FS_FIRSTBIT ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 475 #define SAI_FS_BEFOREFIRSTBIT ((uint32_t)SAI_xFRCR_FSOFF)
AnnaBridge 172:65be27845400 476 /**
AnnaBridge 172:65be27845400 477 * @}
AnnaBridge 172:65be27845400 478 */
AnnaBridge 172:65be27845400 479
AnnaBridge 172:65be27845400 480
AnnaBridge 172:65be27845400 481 /** @defgroup SAI_Block_Slot_Size SAI Block Slot Size
AnnaBridge 172:65be27845400 482 * @{
AnnaBridge 172:65be27845400 483 */
AnnaBridge 172:65be27845400 484 #define SAI_SLOTSIZE_DATASIZE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 485 #define SAI_SLOTSIZE_16B ((uint32_t)SAI_xSLOTR_SLOTSZ_0)
AnnaBridge 172:65be27845400 486 #define SAI_SLOTSIZE_32B ((uint32_t)SAI_xSLOTR_SLOTSZ_1)
AnnaBridge 172:65be27845400 487 /**
AnnaBridge 172:65be27845400 488 * @}
AnnaBridge 172:65be27845400 489 */
AnnaBridge 172:65be27845400 490
AnnaBridge 172:65be27845400 491 /** @defgroup SAI_Block_Slot_Active SAI Block Slot Active
AnnaBridge 172:65be27845400 492 * @{
AnnaBridge 172:65be27845400 493 */
AnnaBridge 172:65be27845400 494 #define SAI_SLOT_NOTACTIVE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 495 #define SAI_SLOTACTIVE_0 ((uint32_t)0x00000001U)
AnnaBridge 172:65be27845400 496 #define SAI_SLOTACTIVE_1 ((uint32_t)0x00000002U)
AnnaBridge 172:65be27845400 497 #define SAI_SLOTACTIVE_2 ((uint32_t)0x00000004U)
AnnaBridge 172:65be27845400 498 #define SAI_SLOTACTIVE_3 ((uint32_t)0x00000008U)
AnnaBridge 172:65be27845400 499 #define SAI_SLOTACTIVE_4 ((uint32_t)0x00000010U)
AnnaBridge 172:65be27845400 500 #define SAI_SLOTACTIVE_5 ((uint32_t)0x00000020U)
AnnaBridge 172:65be27845400 501 #define SAI_SLOTACTIVE_6 ((uint32_t)0x00000040U)
AnnaBridge 172:65be27845400 502 #define SAI_SLOTACTIVE_7 ((uint32_t)0x00000080U)
AnnaBridge 172:65be27845400 503 #define SAI_SLOTACTIVE_8 ((uint32_t)0x00000100U)
AnnaBridge 172:65be27845400 504 #define SAI_SLOTACTIVE_9 ((uint32_t)0x00000200U)
AnnaBridge 172:65be27845400 505 #define SAI_SLOTACTIVE_10 ((uint32_t)0x00000400U)
AnnaBridge 172:65be27845400 506 #define SAI_SLOTACTIVE_11 ((uint32_t)0x00000800U)
AnnaBridge 172:65be27845400 507 #define SAI_SLOTACTIVE_12 ((uint32_t)0x00001000U)
AnnaBridge 172:65be27845400 508 #define SAI_SLOTACTIVE_13 ((uint32_t)0x00002000U)
AnnaBridge 172:65be27845400 509 #define SAI_SLOTACTIVE_14 ((uint32_t)0x00004000U)
AnnaBridge 172:65be27845400 510 #define SAI_SLOTACTIVE_15 ((uint32_t)0x00008000U)
AnnaBridge 172:65be27845400 511 #define SAI_SLOTACTIVE_ALL ((uint32_t)0x0000FFFFU)
AnnaBridge 172:65be27845400 512 /**
AnnaBridge 172:65be27845400 513 * @}
AnnaBridge 172:65be27845400 514 */
AnnaBridge 172:65be27845400 515
AnnaBridge 172:65be27845400 516 /** @defgroup SAI_Mono_Stereo_Mode SAI Mono Stereo Mode
AnnaBridge 172:65be27845400 517 * @{
AnnaBridge 172:65be27845400 518 */
AnnaBridge 172:65be27845400 519 #define SAI_STEREOMODE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 520 #define SAI_MONOMODE ((uint32_t)SAI_xCR1_MONO)
AnnaBridge 172:65be27845400 521 /**
AnnaBridge 172:65be27845400 522 * @}
AnnaBridge 172:65be27845400 523 */
AnnaBridge 172:65be27845400 524
AnnaBridge 172:65be27845400 525 /** @defgroup SAI_TRIState_Management SAI TRIState Management
AnnaBridge 172:65be27845400 526 * @{
AnnaBridge 172:65be27845400 527 */
AnnaBridge 172:65be27845400 528 #define SAI_OUTPUT_NOTRELEASED ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 529 #define SAI_OUTPUT_RELEASED ((uint32_t)SAI_xCR2_TRIS)
AnnaBridge 172:65be27845400 530 /**
AnnaBridge 172:65be27845400 531 * @}
AnnaBridge 172:65be27845400 532 */
AnnaBridge 172:65be27845400 533
AnnaBridge 172:65be27845400 534 /** @defgroup SAI_Block_Fifo_Threshold SAI Block Fifo Threshold
AnnaBridge 172:65be27845400 535 * @{
AnnaBridge 172:65be27845400 536 */
AnnaBridge 172:65be27845400 537 #define SAI_FIFOTHRESHOLD_EMPTY ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 538 #define SAI_FIFOTHRESHOLD_1QF ((uint32_t)(SAI_xCR2_FTH_0))
AnnaBridge 172:65be27845400 539 #define SAI_FIFOTHRESHOLD_HF ((uint32_t)(SAI_xCR2_FTH_1))
AnnaBridge 172:65be27845400 540 #define SAI_FIFOTHRESHOLD_3QF ((uint32_t)(SAI_xCR2_FTH_1 | SAI_xCR2_FTH_0))
AnnaBridge 172:65be27845400 541 #define SAI_FIFOTHRESHOLD_FULL ((uint32_t)(SAI_xCR2_FTH_2))
AnnaBridge 172:65be27845400 542 /**
AnnaBridge 172:65be27845400 543 * @}
AnnaBridge 172:65be27845400 544 */
AnnaBridge 172:65be27845400 545
AnnaBridge 172:65be27845400 546 /** @defgroup SAI_Block_Companding_Mode SAI Block Companding Mode
AnnaBridge 172:65be27845400 547 * @{
AnnaBridge 172:65be27845400 548 */
AnnaBridge 172:65be27845400 549 #define SAI_NOCOMPANDING ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 550 #define SAI_ULAW_1CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1))
AnnaBridge 172:65be27845400 551 #define SAI_ALAW_1CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0))
AnnaBridge 172:65be27845400 552 #define SAI_ULAW_2CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_CPL))
AnnaBridge 172:65be27845400 553 #define SAI_ALAW_2CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0 | SAI_xCR2_CPL))
AnnaBridge 172:65be27845400 554 /**
AnnaBridge 172:65be27845400 555 * @}
AnnaBridge 172:65be27845400 556 */
AnnaBridge 172:65be27845400 557
AnnaBridge 172:65be27845400 558 /** @defgroup SAI_Block_Mute_Value SAI Block Mute Value
AnnaBridge 172:65be27845400 559 * @{
AnnaBridge 172:65be27845400 560 */
AnnaBridge 172:65be27845400 561 #define SAI_ZERO_VALUE ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 562 #define SAI_LAST_SENT_VALUE ((uint32_t)SAI_xCR2_MUTEVAL)
AnnaBridge 172:65be27845400 563 /**
AnnaBridge 172:65be27845400 564 * @}
AnnaBridge 172:65be27845400 565 */
AnnaBridge 172:65be27845400 566
AnnaBridge 172:65be27845400 567 /** @defgroup SAI_Block_Interrupts_Definition SAI Block Interrupts Definition
AnnaBridge 172:65be27845400 568 * @{
AnnaBridge 172:65be27845400 569 */
AnnaBridge 172:65be27845400 570 #define SAI_IT_OVRUDR ((uint32_t)SAI_xIMR_OVRUDRIE)
AnnaBridge 172:65be27845400 571 #define SAI_IT_MUTEDET ((uint32_t)SAI_xIMR_MUTEDETIE)
AnnaBridge 172:65be27845400 572 #define SAI_IT_WCKCFG ((uint32_t)SAI_xIMR_WCKCFGIE)
AnnaBridge 172:65be27845400 573 #define SAI_IT_FREQ ((uint32_t)SAI_xIMR_FREQIE)
AnnaBridge 172:65be27845400 574 #define SAI_IT_CNRDY ((uint32_t)SAI_xIMR_CNRDYIE)
AnnaBridge 172:65be27845400 575 #define SAI_IT_AFSDET ((uint32_t)SAI_xIMR_AFSDETIE)
AnnaBridge 172:65be27845400 576 #define SAI_IT_LFSDET ((uint32_t)SAI_xIMR_LFSDETIE)
AnnaBridge 172:65be27845400 577 /**
AnnaBridge 172:65be27845400 578 * @}
AnnaBridge 172:65be27845400 579 */
AnnaBridge 172:65be27845400 580
AnnaBridge 172:65be27845400 581 /** @defgroup SAI_Block_Flags_Definition SAI Block Flags Definition
AnnaBridge 172:65be27845400 582 * @{
AnnaBridge 172:65be27845400 583 */
AnnaBridge 172:65be27845400 584 #define SAI_FLAG_OVRUDR ((uint32_t)SAI_xSR_OVRUDR)
AnnaBridge 172:65be27845400 585 #define SAI_FLAG_MUTEDET ((uint32_t)SAI_xSR_MUTEDET)
AnnaBridge 172:65be27845400 586 #define SAI_FLAG_WCKCFG ((uint32_t)SAI_xSR_WCKCFG)
AnnaBridge 172:65be27845400 587 #define SAI_FLAG_FREQ ((uint32_t)SAI_xSR_FREQ)
AnnaBridge 172:65be27845400 588 #define SAI_FLAG_CNRDY ((uint32_t)SAI_xSR_CNRDY)
AnnaBridge 172:65be27845400 589 #define SAI_FLAG_AFSDET ((uint32_t)SAI_xSR_AFSDET)
AnnaBridge 172:65be27845400 590 #define SAI_FLAG_LFSDET ((uint32_t)SAI_xSR_LFSDET)
AnnaBridge 172:65be27845400 591 /**
AnnaBridge 172:65be27845400 592 * @}
AnnaBridge 172:65be27845400 593 */
AnnaBridge 172:65be27845400 594
AnnaBridge 172:65be27845400 595 /** @defgroup SAI_Block_Fifo_Status_Level SAI Block Fifo Status Level
AnnaBridge 172:65be27845400 596 * @{
AnnaBridge 172:65be27845400 597 */
AnnaBridge 172:65be27845400 598 #define SAI_FIFOSTATUS_EMPTY ((uint32_t)0x00000000U)
AnnaBridge 172:65be27845400 599 #define SAI_FIFOSTATUS_LESS1QUARTERFULL ((uint32_t)0x00010000U)
AnnaBridge 172:65be27845400 600 #define SAI_FIFOSTATUS_1QUARTERFULL ((uint32_t)0x00020000U)
AnnaBridge 172:65be27845400 601 #define SAI_FIFOSTATUS_HALFFULL ((uint32_t)0x00030000U)
AnnaBridge 172:65be27845400 602 #define SAI_FIFOSTATUS_3QUARTERFULL ((uint32_t)0x00040000U)
AnnaBridge 172:65be27845400 603 #define SAI_FIFOSTATUS_FULL ((uint32_t)0x00050000U)
AnnaBridge 172:65be27845400 604 /**
AnnaBridge 172:65be27845400 605 * @}
AnnaBridge 172:65be27845400 606 */
AnnaBridge 172:65be27845400 607
AnnaBridge 172:65be27845400 608 /**
AnnaBridge 172:65be27845400 609 * @}
AnnaBridge 172:65be27845400 610 */
AnnaBridge 172:65be27845400 611
AnnaBridge 172:65be27845400 612 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 613
AnnaBridge 172:65be27845400 614 /** @defgroup SAI_Exported_Macros SAI Exported Macros
AnnaBridge 172:65be27845400 615 * @brief macros to handle interrupts and specific configurations
AnnaBridge 172:65be27845400 616 * @{
AnnaBridge 172:65be27845400 617 */
AnnaBridge 172:65be27845400 618
AnnaBridge 172:65be27845400 619 /** @brief Reset SAI handle state.
AnnaBridge 172:65be27845400 620 * @param __HANDLE__ specifies the SAI Handle.
AnnaBridge 172:65be27845400 621 * @retval None
AnnaBridge 172:65be27845400 622 */
AnnaBridge 172:65be27845400 623 #define __HAL_SAI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SAI_STATE_RESET)
AnnaBridge 172:65be27845400 624
AnnaBridge 172:65be27845400 625 /** @brief Enable or disable the specified SAI interrupts.
AnnaBridge 172:65be27845400 626 * @param __HANDLE__ specifies the SAI Handle.
AnnaBridge 172:65be27845400 627 * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
AnnaBridge 172:65be27845400 628 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 629 * @arg SAI_IT_OVRUDR: Overrun underrun interrupt enable
AnnaBridge 172:65be27845400 630 * @arg SAI_IT_MUTEDET: Mute detection interrupt enable
AnnaBridge 172:65be27845400 631 * @arg SAI_IT_WCKCFG: Wrong Clock Configuration interrupt enable
AnnaBridge 172:65be27845400 632 * @arg SAI_IT_FREQ: FIFO request interrupt enable
AnnaBridge 172:65be27845400 633 * @arg SAI_IT_CNRDY: Codec not ready interrupt enable
AnnaBridge 172:65be27845400 634 * @arg SAI_IT_AFSDET: Anticipated frame synchronization detection interrupt enable
AnnaBridge 172:65be27845400 635 * @arg SAI_IT_LFSDET: Late frame synchronization detection interrupt enable
AnnaBridge 172:65be27845400 636 * @retval None
AnnaBridge 172:65be27845400 637 */
AnnaBridge 172:65be27845400 638 #define __HAL_SAI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
AnnaBridge 172:65be27845400 639 #define __HAL_SAI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR &= (~(__INTERRUPT__)))
AnnaBridge 172:65be27845400 640
AnnaBridge 172:65be27845400 641 /** @brief Check whether the specified SAI interrupt source is enabled or not.
AnnaBridge 172:65be27845400 642 * @param __HANDLE__ specifies the SAI Handle.
AnnaBridge 172:65be27845400 643 * @param __INTERRUPT__ specifies the SAI interrupt source to check.
AnnaBridge 172:65be27845400 644 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 645 * @arg SAI_IT_OVRUDR: Overrun underrun interrupt enable
AnnaBridge 172:65be27845400 646 * @arg SAI_IT_MUTEDET: Mute detection interrupt enable
AnnaBridge 172:65be27845400 647 * @arg SAI_IT_WCKCFG: Wrong Clock Configuration interrupt enable
AnnaBridge 172:65be27845400 648 * @arg SAI_IT_FREQ: FIFO request interrupt enable
AnnaBridge 172:65be27845400 649 * @arg SAI_IT_CNRDY: Codec not ready interrupt enable
AnnaBridge 172:65be27845400 650 * @arg SAI_IT_AFSDET: Anticipated frame synchronization detection interrupt enable
AnnaBridge 172:65be27845400 651 * @arg SAI_IT_LFSDET: Late frame synchronization detection interrupt enable
AnnaBridge 172:65be27845400 652 * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
AnnaBridge 172:65be27845400 653 */
AnnaBridge 172:65be27845400 654 #define __HAL_SAI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
AnnaBridge 172:65be27845400 655
AnnaBridge 172:65be27845400 656 /** @brief Check whether the specified SAI flag is set or not.
AnnaBridge 172:65be27845400 657 * @param __HANDLE__ specifies the SAI Handle.
AnnaBridge 172:65be27845400 658 * @param __FLAG__ specifies the flag to check.
AnnaBridge 172:65be27845400 659 * This parameter can be one of the following values:
AnnaBridge 172:65be27845400 660 * @arg SAI_FLAG_OVRUDR: Overrun underrun flag.
AnnaBridge 172:65be27845400 661 * @arg SAI_FLAG_MUTEDET: Mute detection flag.
AnnaBridge 172:65be27845400 662 * @arg SAI_FLAG_WCKCFG: Wrong Clock Configuration flag.
AnnaBridge 172:65be27845400 663 * @arg SAI_FLAG_FREQ: FIFO request flag.
AnnaBridge 172:65be27845400 664 * @arg SAI_FLAG_CNRDY: Codec not ready flag.
AnnaBridge 172:65be27845400 665 * @arg SAI_FLAG_AFSDET: Anticipated frame synchronization detection flag.
AnnaBridge 172:65be27845400 666 * @arg SAI_FLAG_LFSDET: Late frame synchronization detection flag.
AnnaBridge 172:65be27845400 667 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 172:65be27845400 668 */
AnnaBridge 172:65be27845400 669 #define __HAL_SAI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
AnnaBridge 172:65be27845400 670
AnnaBridge 172:65be27845400 671 /** @brief Clear the specified SAI pending flag.
AnnaBridge 172:65be27845400 672 * @param __HANDLE__ specifies the SAI Handle.
AnnaBridge 172:65be27845400 673 * @param __FLAG__ specifies the flag to check.
AnnaBridge 172:65be27845400 674 * This parameter can be any combination of the following values:
AnnaBridge 172:65be27845400 675 * @arg SAI_FLAG_OVRUDR: Clear Overrun underrun
AnnaBridge 172:65be27845400 676 * @arg SAI_FLAG_MUTEDET: Clear Mute detection
AnnaBridge 172:65be27845400 677 * @arg SAI_FLAG_WCKCFG: Clear Wrong Clock Configuration
AnnaBridge 172:65be27845400 678 * @arg SAI_FLAG_FREQ: Clear FIFO request
AnnaBridge 172:65be27845400 679 * @arg SAI_FLAG_CNRDY: Clear Codec not ready
AnnaBridge 172:65be27845400 680 * @arg SAI_FLAG_AFSDET: Clear Anticipated frame synchronization detection
AnnaBridge 172:65be27845400 681 * @arg SAI_FLAG_LFSDET: Clear Late frame synchronization detection
AnnaBridge 172:65be27845400 682 *
AnnaBridge 172:65be27845400 683 * @retval None
AnnaBridge 172:65be27845400 684 */
AnnaBridge 172:65be27845400 685 #define __HAL_SAI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->CLRFR = (__FLAG__))
AnnaBridge 172:65be27845400 686
AnnaBridge 172:65be27845400 687 #define __HAL_SAI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SAI_xCR1_SAIEN)
AnnaBridge 172:65be27845400 688 #define __HAL_SAI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~SAI_xCR1_SAIEN)
AnnaBridge 172:65be27845400 689
AnnaBridge 172:65be27845400 690 /**
AnnaBridge 172:65be27845400 691 * @}
AnnaBridge 172:65be27845400 692 */
AnnaBridge 172:65be27845400 693
AnnaBridge 172:65be27845400 694 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 695 /* Include SAI HAL Extension module */
AnnaBridge 172:65be27845400 696 #include "stm32l4xx_hal_sai_ex.h"
AnnaBridge 172:65be27845400 697 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 698
AnnaBridge 172:65be27845400 699 /* Exported functions --------------------------------------------------------*/
AnnaBridge 172:65be27845400 700
AnnaBridge 172:65be27845400 701 /** @addtogroup SAI_Exported_Functions
AnnaBridge 172:65be27845400 702 * @{
AnnaBridge 172:65be27845400 703 */
AnnaBridge 172:65be27845400 704
AnnaBridge 172:65be27845400 705 /* Initialization/de-initialization functions ********************************/
AnnaBridge 172:65be27845400 706
AnnaBridge 172:65be27845400 707 /** @addtogroup SAI_Exported_Functions_Group1
AnnaBridge 172:65be27845400 708 * @{
AnnaBridge 172:65be27845400 709 */
AnnaBridge 172:65be27845400 710 HAL_StatusTypeDef HAL_SAI_InitProtocol(SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot);
AnnaBridge 172:65be27845400 711 HAL_StatusTypeDef HAL_SAI_Init(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 712 HAL_StatusTypeDef HAL_SAI_DeInit (SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 713 void HAL_SAI_MspInit(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 714 void HAL_SAI_MspDeInit(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 715
AnnaBridge 172:65be27845400 716 /**
AnnaBridge 172:65be27845400 717 * @}
AnnaBridge 172:65be27845400 718 */
AnnaBridge 172:65be27845400 719
AnnaBridge 172:65be27845400 720 /* I/O operation functions ***************************************************/
AnnaBridge 172:65be27845400 721
AnnaBridge 172:65be27845400 722 /** @addtogroup SAI_Exported_Functions_Group2
AnnaBridge 172:65be27845400 723 * @{
AnnaBridge 172:65be27845400 724 */
AnnaBridge 172:65be27845400 725 /* Blocking mode: Polling */
AnnaBridge 172:65be27845400 726 HAL_StatusTypeDef HAL_SAI_Transmit(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 172:65be27845400 727 HAL_StatusTypeDef HAL_SAI_Receive(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 172:65be27845400 728
AnnaBridge 172:65be27845400 729 /* Non-Blocking mode: Interrupt */
AnnaBridge 172:65be27845400 730 HAL_StatusTypeDef HAL_SAI_Transmit_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 731 HAL_StatusTypeDef HAL_SAI_Receive_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 732
AnnaBridge 172:65be27845400 733 /* Non-Blocking mode: DMA */
AnnaBridge 172:65be27845400 734 HAL_StatusTypeDef HAL_SAI_Transmit_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 735 HAL_StatusTypeDef HAL_SAI_Receive_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
AnnaBridge 172:65be27845400 736 HAL_StatusTypeDef HAL_SAI_DMAPause(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 737 HAL_StatusTypeDef HAL_SAI_DMAResume(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 738 HAL_StatusTypeDef HAL_SAI_DMAStop(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 739
AnnaBridge 172:65be27845400 740 /* Abort function */
AnnaBridge 172:65be27845400 741 HAL_StatusTypeDef HAL_SAI_Abort(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 742
AnnaBridge 172:65be27845400 743 /* Mute management */
AnnaBridge 172:65be27845400 744 HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode(SAI_HandleTypeDef *hsai, uint16_t val);
AnnaBridge 172:65be27845400 745 HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 746 HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode(SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter);
AnnaBridge 172:65be27845400 747 HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 748
AnnaBridge 172:65be27845400 749 /* SAI IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
AnnaBridge 172:65be27845400 750 void HAL_SAI_IRQHandler(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 751 void HAL_SAI_TxHalfCpltCallback(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 752 void HAL_SAI_TxCpltCallback(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 753 void HAL_SAI_RxHalfCpltCallback(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 754 void HAL_SAI_RxCpltCallback(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 755 void HAL_SAI_ErrorCallback(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 756 /**
AnnaBridge 172:65be27845400 757 * @}
AnnaBridge 172:65be27845400 758 */
AnnaBridge 172:65be27845400 759
AnnaBridge 172:65be27845400 760 /** @addtogroup SAI_Exported_Functions_Group3
AnnaBridge 172:65be27845400 761 * @{
AnnaBridge 172:65be27845400 762 */
AnnaBridge 172:65be27845400 763 /* Peripheral State functions ************************************************/
AnnaBridge 172:65be27845400 764 HAL_SAI_StateTypeDef HAL_SAI_GetState(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 765 uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai);
AnnaBridge 172:65be27845400 766 /**
AnnaBridge 172:65be27845400 767 * @}
AnnaBridge 172:65be27845400 768 */
AnnaBridge 172:65be27845400 769
AnnaBridge 172:65be27845400 770 /**
AnnaBridge 172:65be27845400 771 * @}
AnnaBridge 172:65be27845400 772 */
AnnaBridge 172:65be27845400 773
AnnaBridge 172:65be27845400 774 /* Private macros ------------------------------------------------------------*/
AnnaBridge 172:65be27845400 775 /** @addtogroup SAI_Private_Macros
AnnaBridge 172:65be27845400 776 * @{
AnnaBridge 172:65be27845400 777 */
AnnaBridge 172:65be27845400 778 #define IS_SAI_BLOCK_SYNCEXT(STATE) (((STATE) == SAI_SYNCEXT_DISABLE) ||\
AnnaBridge 172:65be27845400 779 ((STATE) == SAI_SYNCEXT_OUTBLOCKA_ENABLE) ||\
AnnaBridge 172:65be27845400 780 ((STATE) == SAI_SYNCEXT_OUTBLOCKB_ENABLE))
AnnaBridge 172:65be27845400 781
AnnaBridge 172:65be27845400 782 #define IS_SAI_SUPPORTED_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_I2S_STANDARD) ||\
AnnaBridge 172:65be27845400 783 ((PROTOCOL) == SAI_I2S_MSBJUSTIFIED) ||\
AnnaBridge 172:65be27845400 784 ((PROTOCOL) == SAI_I2S_LSBJUSTIFIED) ||\
AnnaBridge 172:65be27845400 785 ((PROTOCOL) == SAI_PCM_LONG) ||\
AnnaBridge 172:65be27845400 786 ((PROTOCOL) == SAI_PCM_SHORT))
AnnaBridge 172:65be27845400 787
AnnaBridge 172:65be27845400 788 #define IS_SAI_PROTOCOL_DATASIZE(DATASIZE) (((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BIT) ||\
AnnaBridge 172:65be27845400 789 ((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BITEXTENDED) ||\
AnnaBridge 172:65be27845400 790 ((DATASIZE) == SAI_PROTOCOL_DATASIZE_24BIT) ||\
AnnaBridge 172:65be27845400 791 ((DATASIZE) == SAI_PROTOCOL_DATASIZE_32BIT))
AnnaBridge 172:65be27845400 792
AnnaBridge 172:65be27845400 793 #define IS_SAI_AUDIO_FREQUENCY(AUDIO) (((AUDIO) == SAI_AUDIO_FREQUENCY_192K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_96K) || \
AnnaBridge 172:65be27845400 794 ((AUDIO) == SAI_AUDIO_FREQUENCY_48K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_44K) || \
AnnaBridge 172:65be27845400 795 ((AUDIO) == SAI_AUDIO_FREQUENCY_32K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_22K) || \
AnnaBridge 172:65be27845400 796 ((AUDIO) == SAI_AUDIO_FREQUENCY_16K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_11K) || \
AnnaBridge 172:65be27845400 797 ((AUDIO) == SAI_AUDIO_FREQUENCY_8K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_MCKDIV))
AnnaBridge 172:65be27845400 798
AnnaBridge 172:65be27845400 799 #if defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
AnnaBridge 172:65be27845400 800 #define IS_SAI_BLOCK_MCK_OVERSAMPLING(VALUE) (((VALUE) == SAI_MCK_OVERSAMPLING_DISABLE) || \
AnnaBridge 172:65be27845400 801 ((VALUE) == SAI_MCK_OVERSAMPLING_ENABLE))
AnnaBridge 172:65be27845400 802
AnnaBridge 172:65be27845400 803 #define IS_SAI_PDM_MIC_PAIRS_NUMBER(VALUE) ((1U <= (VALUE)) && ((VALUE) <= 3U))
AnnaBridge 172:65be27845400 804
AnnaBridge 172:65be27845400 805 #define IS_SAI_PDM_CLOCK_ENABLE(CLOCK) (((CLOCK) != 0U) && \
AnnaBridge 172:65be27845400 806 (((CLOCK) & ~(SAI_PDM_CLOCK1_ENABLE | SAI_PDM_CLOCK2_ENABLE)) == 0U))
AnnaBridge 172:65be27845400 807 #endif /* STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
AnnaBridge 172:65be27845400 808
AnnaBridge 172:65be27845400 809 #define IS_SAI_BLOCK_MODE(MODE) (((MODE) == SAI_MODEMASTER_TX) || \
AnnaBridge 172:65be27845400 810 ((MODE) == SAI_MODEMASTER_RX) || \
AnnaBridge 172:65be27845400 811 ((MODE) == SAI_MODESLAVE_TX) || \
AnnaBridge 172:65be27845400 812 ((MODE) == SAI_MODESLAVE_RX))
AnnaBridge 172:65be27845400 813
AnnaBridge 172:65be27845400 814 #define IS_SAI_BLOCK_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_FREE_PROTOCOL) || \
AnnaBridge 172:65be27845400 815 ((PROTOCOL) == SAI_AC97_PROTOCOL) || \
AnnaBridge 172:65be27845400 816 ((PROTOCOL) == SAI_SPDIF_PROTOCOL))
AnnaBridge 172:65be27845400 817
AnnaBridge 172:65be27845400 818 #define IS_SAI_BLOCK_DATASIZE(DATASIZE) (((DATASIZE) == SAI_DATASIZE_8) || \
AnnaBridge 172:65be27845400 819 ((DATASIZE) == SAI_DATASIZE_10) || \
AnnaBridge 172:65be27845400 820 ((DATASIZE) == SAI_DATASIZE_16) || \
AnnaBridge 172:65be27845400 821 ((DATASIZE) == SAI_DATASIZE_20) || \
AnnaBridge 172:65be27845400 822 ((DATASIZE) == SAI_DATASIZE_24) || \
AnnaBridge 172:65be27845400 823 ((DATASIZE) == SAI_DATASIZE_32))
AnnaBridge 172:65be27845400 824
AnnaBridge 172:65be27845400 825 #define IS_SAI_BLOCK_FIRST_BIT(BIT) (((BIT) == SAI_FIRSTBIT_MSB) || \
AnnaBridge 172:65be27845400 826 ((BIT) == SAI_FIRSTBIT_LSB))
AnnaBridge 172:65be27845400 827
AnnaBridge 172:65be27845400 828 #define IS_SAI_BLOCK_CLOCK_STROBING(CLOCK) (((CLOCK) == SAI_CLOCKSTROBING_FALLINGEDGE) || \
AnnaBridge 172:65be27845400 829 ((CLOCK) == SAI_CLOCKSTROBING_RISINGEDGE))
AnnaBridge 172:65be27845400 830
AnnaBridge 172:65be27845400 831 #define IS_SAI_BLOCK_SYNCHRO(SYNCHRO) (((SYNCHRO) == SAI_ASYNCHRONOUS) || \
AnnaBridge 172:65be27845400 832 ((SYNCHRO) == SAI_SYNCHRONOUS) || \
AnnaBridge 172:65be27845400 833 ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) || \
AnnaBridge 172:65be27845400 834 ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI2))
AnnaBridge 172:65be27845400 835
AnnaBridge 172:65be27845400 836 #define IS_SAI_BLOCK_OUTPUT_DRIVE(DRIVE) (((DRIVE) == SAI_OUTPUTDRIVE_DISABLE) || \
AnnaBridge 172:65be27845400 837 ((DRIVE) == SAI_OUTPUTDRIVE_ENABLE))
AnnaBridge 172:65be27845400 838
AnnaBridge 172:65be27845400 839 #define IS_SAI_BLOCK_NODIVIDER(NODIVIDER) (((NODIVIDER) == SAI_MASTERDIVIDER_ENABLE) || \
AnnaBridge 172:65be27845400 840 ((NODIVIDER) == SAI_MASTERDIVIDER_DISABLE))
AnnaBridge 172:65be27845400 841
AnnaBridge 172:65be27845400 842 #define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER) ((COUNTER) <= 63)
AnnaBridge 172:65be27845400 843
AnnaBridge 172:65be27845400 844 #define IS_SAI_BLOCK_MUTE_VALUE(VALUE) (((VALUE) == SAI_ZERO_VALUE) || \
AnnaBridge 172:65be27845400 845 ((VALUE) == SAI_LAST_SENT_VALUE))
AnnaBridge 172:65be27845400 846
AnnaBridge 172:65be27845400 847 #define IS_SAI_BLOCK_COMPANDING_MODE(MODE) (((MODE) == SAI_NOCOMPANDING) || \
AnnaBridge 172:65be27845400 848 ((MODE) == SAI_ULAW_1CPL_COMPANDING) || \
AnnaBridge 172:65be27845400 849 ((MODE) == SAI_ALAW_1CPL_COMPANDING) || \
AnnaBridge 172:65be27845400 850 ((MODE) == SAI_ULAW_2CPL_COMPANDING) || \
AnnaBridge 172:65be27845400 851 ((MODE) == SAI_ALAW_2CPL_COMPANDING))
AnnaBridge 172:65be27845400 852
AnnaBridge 172:65be27845400 853 #define IS_SAI_BLOCK_FIFO_THRESHOLD(THRESHOLD) (((THRESHOLD) == SAI_FIFOTHRESHOLD_EMPTY) || \
AnnaBridge 172:65be27845400 854 ((THRESHOLD) == SAI_FIFOTHRESHOLD_1QF) || \
AnnaBridge 172:65be27845400 855 ((THRESHOLD) == SAI_FIFOTHRESHOLD_HF) || \
AnnaBridge 172:65be27845400 856 ((THRESHOLD) == SAI_FIFOTHRESHOLD_3QF) || \
AnnaBridge 172:65be27845400 857 ((THRESHOLD) == SAI_FIFOTHRESHOLD_FULL))
AnnaBridge 172:65be27845400 858
AnnaBridge 172:65be27845400 859 #define IS_SAI_BLOCK_TRISTATE_MANAGEMENT(STATE) (((STATE) == SAI_OUTPUT_NOTRELEASED) ||\
AnnaBridge 172:65be27845400 860 ((STATE) == SAI_OUTPUT_RELEASED))
AnnaBridge 172:65be27845400 861
AnnaBridge 172:65be27845400 862 #define IS_SAI_MONO_STEREO_MODE(MODE) (((MODE) == SAI_MONOMODE) ||\
AnnaBridge 172:65be27845400 863 ((MODE) == SAI_STEREOMODE))
AnnaBridge 172:65be27845400 864
AnnaBridge 172:65be27845400 865 #define IS_SAI_SLOT_ACTIVE(ACTIVE) ((ACTIVE) <= SAI_SLOTACTIVE_ALL)
AnnaBridge 172:65be27845400 866
AnnaBridge 172:65be27845400 867 #define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER) ((1 <= (NUMBER)) && ((NUMBER) <= 16))
AnnaBridge 172:65be27845400 868
AnnaBridge 172:65be27845400 869 #define IS_SAI_BLOCK_SLOT_SIZE(SIZE) (((SIZE) == SAI_SLOTSIZE_DATASIZE) || \
AnnaBridge 172:65be27845400 870 ((SIZE) == SAI_SLOTSIZE_16B) || \
AnnaBridge 172:65be27845400 871 ((SIZE) == SAI_SLOTSIZE_32B))
AnnaBridge 172:65be27845400 872
AnnaBridge 172:65be27845400 873 #define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET) ((OFFSET) <= 24)
AnnaBridge 172:65be27845400 874
AnnaBridge 172:65be27845400 875 #define IS_SAI_BLOCK_FS_OFFSET(OFFSET) (((OFFSET) == SAI_FS_FIRSTBIT) || \
AnnaBridge 172:65be27845400 876 ((OFFSET) == SAI_FS_BEFOREFIRSTBIT))
AnnaBridge 172:65be27845400 877
AnnaBridge 172:65be27845400 878 #define IS_SAI_BLOCK_FS_POLARITY(POLARITY) (((POLARITY) == SAI_FS_ACTIVE_LOW) || \
AnnaBridge 172:65be27845400 879 ((POLARITY) == SAI_FS_ACTIVE_HIGH))
AnnaBridge 172:65be27845400 880
AnnaBridge 172:65be27845400 881 #define IS_SAI_BLOCK_FS_DEFINITION(DEFINITION) (((DEFINITION) == SAI_FS_STARTFRAME) || \
AnnaBridge 172:65be27845400 882 ((DEFINITION) == SAI_FS_CHANNEL_IDENTIFICATION))
AnnaBridge 172:65be27845400 883
AnnaBridge 172:65be27845400 884 #define IS_SAI_BLOCK_MASTER_DIVIDER(DIVIDER) ((DIVIDER) <= 15)
AnnaBridge 172:65be27845400 885
AnnaBridge 172:65be27845400 886 #define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH) ((8 <= (LENGTH)) && ((LENGTH) <= 256))
AnnaBridge 172:65be27845400 887
AnnaBridge 172:65be27845400 888 #define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH) ((1 <= (LENGTH)) && ((LENGTH) <= 128))
AnnaBridge 172:65be27845400 889
AnnaBridge 172:65be27845400 890 /**
AnnaBridge 172:65be27845400 891 * @}
AnnaBridge 172:65be27845400 892 */
AnnaBridge 172:65be27845400 893
AnnaBridge 172:65be27845400 894 /* Private functions ---------------------------------------------------------*/
AnnaBridge 172:65be27845400 895 /** @defgroup SAI_Private_Functions SAI Private Functions
AnnaBridge 172:65be27845400 896 * @{
AnnaBridge 172:65be27845400 897 */
AnnaBridge 172:65be27845400 898
AnnaBridge 172:65be27845400 899 /**
AnnaBridge 172:65be27845400 900 * @}
AnnaBridge 172:65be27845400 901 */
AnnaBridge 172:65be27845400 902
AnnaBridge 172:65be27845400 903 /**
AnnaBridge 172:65be27845400 904 * @}
AnnaBridge 172:65be27845400 905 */
AnnaBridge 172:65be27845400 906
AnnaBridge 172:65be27845400 907 /**
AnnaBridge 172:65be27845400 908 * @}
AnnaBridge 172:65be27845400 909 */
AnnaBridge 172:65be27845400 910
AnnaBridge 172:65be27845400 911 #ifdef __cplusplus
AnnaBridge 172:65be27845400 912 }
AnnaBridge 172:65be27845400 913 #endif
AnnaBridge 172:65be27845400 914
AnnaBridge 172:65be27845400 915 #endif /* __STM32L4xx_HAL_SAI_H */
AnnaBridge 172:65be27845400 916
AnnaBridge 172:65be27845400 917 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/