STM CMSIS
stm32f4xx_hal_sai.h
Go to the documentation of this file.
1 
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_SAI_H
40 #define __STM32F4xx_HAL_SAI_H
41 
42 #ifdef __cplusplus
43  extern "C" {
44 #endif
45 
46 /* Includes ------------------------------------------------------------------*/
47 #include "stm32f4xx_hal_def.h"
48 
52 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
53  defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
54 
59 /* Exported types ------------------------------------------------------------*/
67 typedef enum
68 {
69  HAL_SAI_STATE_RESET = 0x00U,
70  HAL_SAI_STATE_READY = 0x01U,
71  HAL_SAI_STATE_BUSY = 0x02U,
72  HAL_SAI_STATE_BUSY_TX = 0x12U,
73  HAL_SAI_STATE_BUSY_RX = 0x22U,
74  HAL_SAI_STATE_TIMEOUT = 0x03U,
75  HAL_SAI_STATE_ERROR = 0x04U
76 }HAL_SAI_StateTypeDef;
77 
81 typedef void (*SAIcallback)(void);
82 
87 typedef struct
88 {
89  uint32_t AudioMode;
92  uint32_t Synchro;
95  uint32_t SynchroExt;
101  uint32_t OutputDrive;
106  uint32_t NoDivider;
115  uint32_t FIFOThreshold;
118  uint32_t ClockSource;
121  uint32_t AudioFrequency;
124  uint32_t Mckdiv;
128  uint32_t MonoStereoMode;
131  uint32_t CompandingMode;
134  uint32_t TriState;
137  /* This part of the structure is automatically filled if your are using the high level intialisation
138  function HAL_SAI_InitProtocol */
139 
140  uint32_t Protocol;
143  uint32_t DataSize;
146  uint32_t FirstBit;
149  uint32_t ClockStrobing;
151 }SAI_InitTypeDef;
160 typedef struct
161 {
162  uint32_t FrameLength;
168  uint32_t ActiveFrameLength;
173  uint32_t FSDefinition;
176  uint32_t FSPolarity;
179  uint32_t FSOffset;
181 }SAI_FrameInitTypeDef;
190 typedef struct
191 {
192  uint32_t FirstBitOffset;
195  uint32_t SlotSize;
198  uint32_t SlotNumber;
201  uint32_t SlotActive;
203 }SAI_SlotInitTypeDef;
204 
213 typedef struct __SAI_HandleTypeDef
214 {
215  SAI_Block_TypeDef *Instance;
217  SAI_InitTypeDef Init;
219  SAI_FrameInitTypeDef FrameInit;
221  SAI_SlotInitTypeDef SlotInit;
223  uint8_t *pBuffPtr;
225  uint16_t XferSize;
227  uint16_t XferCount;
229  DMA_HandleTypeDef *hdmatx;
231  DMA_HandleTypeDef *hdmarx;
233  SAIcallback mutecallback;
235  void (*InterruptServiceRoutine)(struct __SAI_HandleTypeDef *hsai); /* function pointer for IRQ handler */
236 
237  HAL_LockTypeDef Lock;
239  __IO HAL_SAI_StateTypeDef State;
241  __IO uint32_t ErrorCode;
242 }SAI_HandleTypeDef;
247 /* Exported constants --------------------------------------------------------*/
248 
256 #define HAL_SAI_ERROR_NONE ((uint32_t)0x00000000U)
257 #define HAL_SAI_ERROR_OVR ((uint32_t)0x00000001U)
258 #define HAL_SAI_ERROR_UDR ((uint32_t)0x00000002U)
259 #define HAL_SAI_ERROR_AFSDET ((uint32_t)0x00000004U)
260 #define HAL_SAI_ERROR_LFSDET ((uint32_t)0x00000008U)
261 #define HAL_SAI_ERROR_CNREADY ((uint32_t)0x00000010U)
262 #define HAL_SAI_ERROR_WCKCFG ((uint32_t)0x00000020U)
263 #define HAL_SAI_ERROR_TIMEOUT ((uint32_t)0x00000040U)
264 #define HAL_SAI_ERROR_DMA ((uint32_t)0x00000080U)
272 #define SAI_SYNCEXT_DISABLE 0U
273 #define SAI_SYNCEXT_OUTBLOCKA_ENABLE 1U
274 #define SAI_SYNCEXT_OUTBLOCKB_ENABLE 2U
275 
282 #define SAI_I2S_STANDARD 0U
283 #define SAI_I2S_MSBJUSTIFIED 1U
284 #define SAI_I2S_LSBJUSTIFIED 2U
285 #define SAI_PCM_LONG 3U
286 #define SAI_PCM_SHORT 4U
287 
294 #define SAI_PROTOCOL_DATASIZE_16BIT 0U
295 #define SAI_PROTOCOL_DATASIZE_16BITEXTENDED 1U
296 #define SAI_PROTOCOL_DATASIZE_24BIT 2U
297 #define SAI_PROTOCOL_DATASIZE_32BIT 3U
298 
305 #define SAI_CLKSOURCE_PLLSAI ((uint32_t)0x00000000U)
306 #define SAI_CLKSOURCE_PLLI2S ((uint32_t)0x00100000U)
307 #define SAI_CLKSOURCE_EXT ((uint32_t)0x00200000U)
308 #define SAI_CLKSOURCE_NA ((uint32_t)0x00400000U)
316 #define SAI_AUDIO_FREQUENCY_192K ((uint32_t)192000U)
317 #define SAI_AUDIO_FREQUENCY_96K ((uint32_t)96000U)
318 #define SAI_AUDIO_FREQUENCY_48K ((uint32_t)48000U)
319 #define SAI_AUDIO_FREQUENCY_44K ((uint32_t)44100U)
320 #define SAI_AUDIO_FREQUENCY_32K ((uint32_t)32000U)
321 #define SAI_AUDIO_FREQUENCY_22K ((uint32_t)22050U)
322 #define SAI_AUDIO_FREQUENCY_16K ((uint32_t)16000U)
323 #define SAI_AUDIO_FREQUENCY_11K ((uint32_t)11025U)
324 #define SAI_AUDIO_FREQUENCY_8K ((uint32_t)8000U)
325 #define SAI_AUDIO_FREQUENCY_MCKDIV ((uint32_t)0U)
326 
333 #define SAI_MODEMASTER_TX ((uint32_t)0x00000000U)
334 #define SAI_MODEMASTER_RX ((uint32_t)SAI_xCR1_MODE_0)
335 #define SAI_MODESLAVE_TX ((uint32_t)SAI_xCR1_MODE_1)
336 #define SAI_MODESLAVE_RX ((uint32_t)(SAI_xCR1_MODE_1 | SAI_xCR1_MODE_0))
337 
344 #define SAI_FREE_PROTOCOL ((uint32_t)0x00000000U)
345 #define SAI_SPDIF_PROTOCOL ((uint32_t)SAI_xCR1_PRTCFG_0)
346 #define SAI_AC97_PROTOCOL ((uint32_t)SAI_xCR1_PRTCFG_1)
347 
354 #define SAI_DATASIZE_8 ((uint32_t)SAI_xCR1_DS_1)
355 #define SAI_DATASIZE_10 ((uint32_t)(SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
356 #define SAI_DATASIZE_16 ((uint32_t)SAI_xCR1_DS_2)
357 #define SAI_DATASIZE_20 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_0))
358 #define SAI_DATASIZE_24 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1))
359 #define SAI_DATASIZE_32 ((uint32_t)(SAI_xCR1_DS_2 | SAI_xCR1_DS_1 | SAI_xCR1_DS_0))
360 
367 #define SAI_FIRSTBIT_MSB ((uint32_t)0x00000000U)
368 #define SAI_FIRSTBIT_LSB ((uint32_t)SAI_xCR1_LSBFIRST)
369 
376 #define SAI_CLOCKSTROBING_FALLINGEDGE 0U
377 #define SAI_CLOCKSTROBING_RISINGEDGE 1U
378 
385 #define SAI_ASYNCHRONOUS 0U
386 #define SAI_SYNCHRONOUS 1U
387 #define SAI_SYNCHRONOUS_EXT_SAI1 2U
388 #define SAI_SYNCHRONOUS_EXT_SAI2 3U
396 #define SAI_OUTPUTDRIVE_DISABLE ((uint32_t)0x00000000U)
397 #define SAI_OUTPUTDRIVE_ENABLE ((uint32_t)SAI_xCR1_OUTDRIV)
398 
405 #define SAI_MASTERDIVIDER_ENABLE ((uint32_t)0x00000000U)
406 #define SAI_MASTERDIVIDER_DISABLE ((uint32_t)SAI_xCR1_NODIV)
407 
414 #define SAI_FS_STARTFRAME ((uint32_t)0x00000000U)
415 #define SAI_FS_CHANNEL_IDENTIFICATION ((uint32_t)SAI_xFRCR_FSDEF)
416 
423 #define SAI_FS_ACTIVE_LOW ((uint32_t)0x00000000U)
424 #define SAI_FS_ACTIVE_HIGH ((uint32_t)SAI_xFRCR_FSPOL)
425 
432 #define SAI_FS_FIRSTBIT ((uint32_t)0x00000000U)
433 #define SAI_FS_BEFOREFIRSTBIT ((uint32_t)SAI_xFRCR_FSOFF)
434 
441 #define SAI_SLOTSIZE_DATASIZE ((uint32_t)0x00000000U)
442 #define SAI_SLOTSIZE_16B ((uint32_t)SAI_xSLOTR_SLOTSZ_0)
443 #define SAI_SLOTSIZE_32B ((uint32_t)SAI_xSLOTR_SLOTSZ_1)
444 
451 #define SAI_SLOT_NOTACTIVE ((uint32_t)0x00000000U)
452 #define SAI_SLOTACTIVE_0 ((uint32_t)0x00000001U)
453 #define SAI_SLOTACTIVE_1 ((uint32_t)0x00000002U)
454 #define SAI_SLOTACTIVE_2 ((uint32_t)0x00000004U)
455 #define SAI_SLOTACTIVE_3 ((uint32_t)0x00000008U)
456 #define SAI_SLOTACTIVE_4 ((uint32_t)0x00000010U)
457 #define SAI_SLOTACTIVE_5 ((uint32_t)0x00000020U)
458 #define SAI_SLOTACTIVE_6 ((uint32_t)0x00000040U)
459 #define SAI_SLOTACTIVE_7 ((uint32_t)0x00000080U)
460 #define SAI_SLOTACTIVE_8 ((uint32_t)0x00000100U)
461 #define SAI_SLOTACTIVE_9 ((uint32_t)0x00000200U)
462 #define SAI_SLOTACTIVE_10 ((uint32_t)0x00000400U)
463 #define SAI_SLOTACTIVE_11 ((uint32_t)0x00000800U)
464 #define SAI_SLOTACTIVE_12 ((uint32_t)0x00001000U)
465 #define SAI_SLOTACTIVE_13 ((uint32_t)0x00002000U)
466 #define SAI_SLOTACTIVE_14 ((uint32_t)0x00004000U)
467 #define SAI_SLOTACTIVE_15 ((uint32_t)0x00008000U)
468 #define SAI_SLOTACTIVE_ALL ((uint32_t)0x0000FFFFU)
469 
476 #define SAI_STEREOMODE ((uint32_t)0x00000000U)
477 #define SAI_MONOMODE ((uint32_t)SAI_xCR1_MONO)
478 
485 #define SAI_OUTPUT_NOTRELEASED ((uint32_t)0x00000000U)
486 #define SAI_OUTPUT_RELEASED ((uint32_t)SAI_xCR2_TRIS)
487 
494 #define SAI_FIFOTHRESHOLD_EMPTY ((uint32_t)0x00000000U)
495 #define SAI_FIFOTHRESHOLD_1QF ((uint32_t)(SAI_xCR2_FTH_0))
496 #define SAI_FIFOTHRESHOLD_HF ((uint32_t)(SAI_xCR2_FTH_1))
497 #define SAI_FIFOTHRESHOLD_3QF ((uint32_t)(SAI_xCR2_FTH_1 | SAI_xCR2_FTH_0))
498 #define SAI_FIFOTHRESHOLD_FULL ((uint32_t)(SAI_xCR2_FTH_2))
499 
506 #define SAI_NOCOMPANDING ((uint32_t)0x00000000U)
507 #define SAI_ULAW_1CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1))
508 #define SAI_ALAW_1CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0))
509 #define SAI_ULAW_2CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_CPL))
510 #define SAI_ALAW_2CPL_COMPANDING ((uint32_t)(SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0 | SAI_xCR2_CPL))
511 
518 #define SAI_ZERO_VALUE ((uint32_t)0x00000000U)
519 #define SAI_LAST_SENT_VALUE ((uint32_t)SAI_xCR2_MUTEVAL)
520 
527 #define SAI_IT_OVRUDR ((uint32_t)SAI_xIMR_OVRUDRIE)
528 #define SAI_IT_MUTEDET ((uint32_t)SAI_xIMR_MUTEDETIE)
529 #define SAI_IT_WCKCFG ((uint32_t)SAI_xIMR_WCKCFGIE)
530 #define SAI_IT_FREQ ((uint32_t)SAI_xIMR_FREQIE)
531 #define SAI_IT_CNRDY ((uint32_t)SAI_xIMR_CNRDYIE)
532 #define SAI_IT_AFSDET ((uint32_t)SAI_xIMR_AFSDETIE)
533 #define SAI_IT_LFSDET ((uint32_t)SAI_xIMR_LFSDETIE)
534 
541 #define SAI_FLAG_OVRUDR ((uint32_t)SAI_xSR_OVRUDR)
542 #define SAI_FLAG_MUTEDET ((uint32_t)SAI_xSR_MUTEDET)
543 #define SAI_FLAG_WCKCFG ((uint32_t)SAI_xSR_WCKCFG)
544 #define SAI_FLAG_FREQ ((uint32_t)SAI_xSR_FREQ)
545 #define SAI_FLAG_CNRDY ((uint32_t)SAI_xSR_CNRDY)
546 #define SAI_FLAG_AFSDET ((uint32_t)SAI_xSR_AFSDET)
547 #define SAI_FLAG_LFSDET ((uint32_t)SAI_xSR_LFSDET)
548 
555 #define SAI_FIFOSTATUS_EMPTY ((uint32_t)0x00000000U)
556 #define SAI_FIFOSTATUS_LESS1QUARTERFULL ((uint32_t)0x00010000U)
557 #define SAI_FIFOSTATUS_1QUARTERFULL ((uint32_t)0x00020000U)
558 #define SAI_FIFOSTATUS_HALFFULL ((uint32_t)0x00030000U)
559 #define SAI_FIFOSTATUS_3QUARTERFULL ((uint32_t)0x00040000U)
560 #define SAI_FIFOSTATUS_FULL ((uint32_t)0x00050000U)
561 
569 /* Exported macro ------------------------------------------------------------*/
570 
580 #define __HAL_SAI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SAI_STATE_RESET)
581 
595 #define __HAL_SAI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
596 #define __HAL_SAI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR &= (~(__INTERRUPT__)))
597 
612 #define __HAL_SAI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
613 
627 #define __HAL_SAI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
628 
642 #define __HAL_SAI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->CLRFR = (__FLAG__))
643 
648 #define __HAL_SAI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SAI_xCR1_SAIEN)
649 
654 #define __HAL_SAI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~SAI_xCR1_SAIEN)
655 
660 /* Include RCC SAI Extension module */
661 #include "stm32f4xx_hal_sai_ex.h"
662 
663 /* Exported functions --------------------------------------------------------*/
664 
669 /* Initialization/de-initialization functions **********************************/
673 HAL_StatusTypeDef HAL_SAI_InitProtocol(SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot);
674 HAL_StatusTypeDef HAL_SAI_Init(SAI_HandleTypeDef *hsai);
675 HAL_StatusTypeDef HAL_SAI_DeInit (SAI_HandleTypeDef *hsai);
676 void HAL_SAI_MspInit(SAI_HandleTypeDef *hsai);
677 void HAL_SAI_MspDeInit(SAI_HandleTypeDef *hsai);
678 
683 /* I/O operation functions *****************************************************/
687 /* Blocking mode: Polling */
688 HAL_StatusTypeDef HAL_SAI_Transmit(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
689 HAL_StatusTypeDef HAL_SAI_Receive(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
690 
691 /* Non-Blocking mode: Interrupt */
692 HAL_StatusTypeDef HAL_SAI_Transmit_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
693 HAL_StatusTypeDef HAL_SAI_Receive_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
694 
695 /* Non-Blocking mode: DMA */
696 HAL_StatusTypeDef HAL_SAI_Transmit_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
697 HAL_StatusTypeDef HAL_SAI_Receive_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
698 HAL_StatusTypeDef HAL_SAI_DMAPause(SAI_HandleTypeDef *hsai);
699 HAL_StatusTypeDef HAL_SAI_DMAResume(SAI_HandleTypeDef *hsai);
700 HAL_StatusTypeDef HAL_SAI_DMAStop(SAI_HandleTypeDef *hsai);
701 
702 /* Abort function */
703 HAL_StatusTypeDef HAL_SAI_Abort(SAI_HandleTypeDef *hsai);
704 
705 /* Mute management */
706 HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode(SAI_HandleTypeDef *hsai, uint16_t val);
707 HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode(SAI_HandleTypeDef *hsai);
708 HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode(SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter);
709 HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode(SAI_HandleTypeDef *hsai);
710 
711 /* SAI IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
712 void HAL_SAI_IRQHandler(SAI_HandleTypeDef *hsai);
713 void HAL_SAI_TxHalfCpltCallback(SAI_HandleTypeDef *hsai);
714 void HAL_SAI_TxCpltCallback(SAI_HandleTypeDef *hsai);
715 void HAL_SAI_RxHalfCpltCallback(SAI_HandleTypeDef *hsai);
716 void HAL_SAI_RxCpltCallback(SAI_HandleTypeDef *hsai);
717 void HAL_SAI_ErrorCallback(SAI_HandleTypeDef *hsai);
725 /* Peripheral State functions ************************************************/
726 HAL_SAI_StateTypeDef HAL_SAI_GetState(SAI_HandleTypeDef *hsai);
727 uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai);
736 /* Private macros ------------------------------------------------------------*/
740 #define IS_SAI_BLOCK_SYNCEXT(STATE) (((STATE) == SAI_SYNCEXT_DISABLE) ||\
741  ((STATE) == SAI_SYNCEXT_OUTBLOCKA_ENABLE) ||\
742  ((STATE) == SAI_SYNCEXT_OUTBLOCKB_ENABLE))
743 
744 #define IS_SAI_SUPPORTED_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_I2S_STANDARD) ||\
745  ((PROTOCOL) == SAI_I2S_MSBJUSTIFIED) ||\
746  ((PROTOCOL) == SAI_I2S_LSBJUSTIFIED) ||\
747  ((PROTOCOL) == SAI_PCM_LONG) ||\
748  ((PROTOCOL) == SAI_PCM_SHORT))
749 
750 #define IS_SAI_PROTOCOL_DATASIZE(DATASIZE) (((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BIT) ||\
751  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BITEXTENDED) ||\
752  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_24BIT) ||\
753  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_32BIT))
754 
755 #define IS_SAI_CLK_SOURCE(SOURCE) (((SOURCE) == SAI_CLKSOURCE_PLLSAI) ||\
756  ((SOURCE) == SAI_CLKSOURCE_PLLI2S) ||\
757  ((SOURCE) == SAI_CLKSOURCE_EXT))
758 
759 #define IS_SAI_AUDIO_FREQUENCY(AUDIO) (((AUDIO) == SAI_AUDIO_FREQUENCY_192K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_96K) || \
760  ((AUDIO) == SAI_AUDIO_FREQUENCY_48K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_44K) || \
761  ((AUDIO) == SAI_AUDIO_FREQUENCY_32K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_22K) || \
762  ((AUDIO) == SAI_AUDIO_FREQUENCY_16K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_11K) || \
763  ((AUDIO) == SAI_AUDIO_FREQUENCY_8K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_MCKDIV))
764 
765 #define IS_SAI_BLOCK_MODE(MODE) (((MODE) == SAI_MODEMASTER_TX) || \
766  ((MODE) == SAI_MODEMASTER_RX) || \
767  ((MODE) == SAI_MODESLAVE_TX) || \
768  ((MODE) == SAI_MODESLAVE_RX))
769 
770 #define IS_SAI_BLOCK_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_FREE_PROTOCOL) || \
771  ((PROTOCOL) == SAI_AC97_PROTOCOL) || \
772  ((PROTOCOL) == SAI_SPDIF_PROTOCOL))
773 
774 #define IS_SAI_BLOCK_DATASIZE(DATASIZE) (((DATASIZE) == SAI_DATASIZE_8) || \
775  ((DATASIZE) == SAI_DATASIZE_10) || \
776  ((DATASIZE) == SAI_DATASIZE_16) || \
777  ((DATASIZE) == SAI_DATASIZE_20) || \
778  ((DATASIZE) == SAI_DATASIZE_24) || \
779  ((DATASIZE) == SAI_DATASIZE_32))
780 
781 #define IS_SAI_BLOCK_FIRST_BIT(BIT) (((BIT) == SAI_FIRSTBIT_MSB) || \
782  ((BIT) == SAI_FIRSTBIT_LSB))
783 
784 #define IS_SAI_BLOCK_CLOCK_STROBING(CLOCK) (((CLOCK) == SAI_CLOCKSTROBING_FALLINGEDGE) || \
785  ((CLOCK) == SAI_CLOCKSTROBING_RISINGEDGE))
786 
787 #define IS_SAI_BLOCK_SYNCHRO(SYNCHRO) (((SYNCHRO) == SAI_ASYNCHRONOUS) || \
788  ((SYNCHRO) == SAI_SYNCHRONOUS) || \
789  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) ||\
790  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI2))
791 
792 #define IS_SAI_BLOCK_OUTPUT_DRIVE(DRIVE) (((DRIVE) == SAI_OUTPUTDRIVE_DISABLE) || \
793  ((DRIVE) == SAI_OUTPUTDRIVE_ENABLE))
794 
795 #define IS_SAI_BLOCK_NODIVIDER(NODIVIDER) (((NODIVIDER) == SAI_MASTERDIVIDER_ENABLE) || \
796  ((NODIVIDER) == SAI_MASTERDIVIDER_DISABLE))
797 
798 #define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER) ((COUNTER) <= 63U)
799 
800 #define IS_SAI_BLOCK_MUTE_VALUE(VALUE) (((VALUE) == SAI_ZERO_VALUE) || \
801  ((VALUE) == SAI_LAST_SENT_VALUE))
802 
803 #define IS_SAI_BLOCK_COMPANDING_MODE(MODE) (((MODE) == SAI_NOCOMPANDING) || \
804  ((MODE) == SAI_ULAW_1CPL_COMPANDING) || \
805  ((MODE) == SAI_ALAW_1CPL_COMPANDING) || \
806  ((MODE) == SAI_ULAW_2CPL_COMPANDING) || \
807  ((MODE) == SAI_ALAW_2CPL_COMPANDING))
808 
809 #define IS_SAI_BLOCK_FIFO_THRESHOLD(THRESHOLD) (((THRESHOLD) == SAI_FIFOTHRESHOLD_EMPTY) || \
810  ((THRESHOLD) == SAI_FIFOTHRESHOLD_1QF) || \
811  ((THRESHOLD) == SAI_FIFOTHRESHOLD_HF) || \
812  ((THRESHOLD) == SAI_FIFOTHRESHOLD_3QF) || \
813  ((THRESHOLD) == SAI_FIFOTHRESHOLD_FULL))
814 
815 #define IS_SAI_BLOCK_TRISTATE_MANAGEMENT(STATE) (((STATE) == SAI_OUTPUT_NOTRELEASED) ||\
816  ((STATE) == SAI_OUTPUT_RELEASED))
817 
818 #define IS_SAI_MONO_STEREO_MODE(MODE) (((MODE) == SAI_MONOMODE) ||\
819  ((MODE) == SAI_STEREOMODE))
820 
821 #define IS_SAI_SLOT_ACTIVE(ACTIVE) ((ACTIVE) <= SAI_SLOTACTIVE_ALL)
822 
823 #define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER) ((1U <= (NUMBER)) && ((NUMBER) <= 16U))
824 
825 #define IS_SAI_BLOCK_SLOT_SIZE(SIZE) (((SIZE) == SAI_SLOTSIZE_DATASIZE) || \
826  ((SIZE) == SAI_SLOTSIZE_16B) || \
827  ((SIZE) == SAI_SLOTSIZE_32B))
828 
829 #define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET) ((OFFSET) <= 24U)
830 
831 #define IS_SAI_BLOCK_FS_OFFSET(OFFSET) (((OFFSET) == SAI_FS_FIRSTBIT) || \
832  ((OFFSET) == SAI_FS_BEFOREFIRSTBIT))
833 
834 #define IS_SAI_BLOCK_FS_POLARITY(POLARITY) (((POLARITY) == SAI_FS_ACTIVE_LOW) || \
835  ((POLARITY) == SAI_FS_ACTIVE_HIGH))
836 
837 #define IS_SAI_BLOCK_FS_DEFINITION(DEFINITION) (((DEFINITION) == SAI_FS_STARTFRAME) || \
838  ((DEFINITION) == SAI_FS_CHANNEL_IDENTIFICATION))
839 
840 #define IS_SAI_BLOCK_MASTER_DIVIDER(DIVIDER) ((DIVIDER) <= 15U)
841 
842 #define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH) ((8U <= (LENGTH)) && ((LENGTH) <= 256U))
843 
844 #define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH) ((1U <= (LENGTH)) && ((LENGTH) <= 128U))
845 
846 
851 /* Private functions ---------------------------------------------------------*/
860 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
861 
869 #ifdef __cplusplus
870 }
871 #endif
872 
873 #endif /* __STM32F4xx_HAL_SAI_H */
874 
875 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition.
Definition: stm32f4xx_hal_def.h:57
__IO
#define __IO
Definition: core_cm0.h:213
stm32f4xx_hal_sai_ex.h
Header file of SAI Extension HAL module.
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition.
Definition: stm32f4xx_hal_def.h:68
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f4xx_hal_dma.h:157
SAI_Block_TypeDef
Definition: stm32f427xx.h:755