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