stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h
Go to the documentation of this file.
1 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32H7xx_HAL_SAI_H
22 #define STM32H7xx_HAL_SAI_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32h7xx_hal_def.h"
30 
39 /* Exported types ------------------------------------------------------------*/
47 typedef enum
48 {
49  HAL_SAI_STATE_RESET = 0x00U,
50  HAL_SAI_STATE_READY = 0x01U,
51  HAL_SAI_STATE_BUSY = 0x02U,
52  HAL_SAI_STATE_BUSY_TX = 0x12U,
53  HAL_SAI_STATE_BUSY_RX = 0x22U,
54 } HAL_SAI_StateTypeDef;
55 
59 typedef void (*SAIcallback)(void);
60 
65 typedef struct
66 {
67  FunctionalState Activation;
68  uint32_t MicPairsNbr;
70  uint32_t ClockEnable;
72 } SAI_PdmInitTypeDef;
81 typedef struct
82 {
83  uint32_t AudioMode;
86  uint32_t Synchro;
89  uint32_t SynchroExt;
95  uint32_t MckOutput;
99  uint32_t OutputDrive;
104  uint32_t NoDivider;
112  uint32_t FIFOThreshold;
115  uint32_t AudioFrequency;
118  uint32_t Mckdiv;
123  uint32_t MckOverSampling;
126  uint32_t MonoStereoMode;
129  uint32_t CompandingMode;
132  uint32_t TriState;
135  SAI_PdmInitTypeDef PdmInit;
137  /* This part of the structure is automatically filled if your are using the high level initialisation
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;
161 typedef struct
162 {
163 
164  uint32_t FrameLength;
170  uint32_t ActiveFrameLength;
175  uint32_t FSDefinition;
178  uint32_t FSPolarity;
181  uint32_t FSOffset;
184 } SAI_FrameInitTypeDef;
195 typedef struct
196 {
197  uint32_t FirstBitOffset;
200  uint32_t SlotSize;
203  uint32_t SlotNumber;
206  uint32_t SlotActive;
208 } SAI_SlotInitTypeDef;
217 typedef struct __SAI_HandleTypeDef
218 {
219  SAI_Block_TypeDef *Instance;
221  SAI_InitTypeDef Init;
223  SAI_FrameInitTypeDef FrameInit;
225  SAI_SlotInitTypeDef SlotInit;
227  uint8_t *pBuffPtr;
229  uint16_t XferSize;
231  uint16_t XferCount;
233  DMA_HandleTypeDef *hdmatx;
235  DMA_HandleTypeDef *hdmarx;
237  SAIcallback mutecallback;
239  void (*InterruptServiceRoutine)(struct __SAI_HandleTypeDef *hsai); /* function pointer for IRQ handler */
240 
241  HAL_LockTypeDef Lock;
243  __IO HAL_SAI_StateTypeDef State;
245  __IO uint32_t ErrorCode;
247 #if (USE_HAL_SAI_REGISTER_CALLBACKS == 1)
248  void (*RxCpltCallback)(struct __SAI_HandleTypeDef *hsai);
249  void (*RxHalfCpltCallback)(struct __SAI_HandleTypeDef *hsai);
250  void (*TxCpltCallback)(struct __SAI_HandleTypeDef *hsai);
251  void (*TxHalfCpltCallback)(struct __SAI_HandleTypeDef *hsai);
252  void (*ErrorCallback)(struct __SAI_HandleTypeDef *hsai);
253  void (*MspInitCallback)(struct __SAI_HandleTypeDef *hsai);
254  void (*MspDeInitCallback)(struct __SAI_HandleTypeDef *hsai);
255 #endif
256 } SAI_HandleTypeDef;
261 #if (USE_HAL_SAI_REGISTER_CALLBACKS == 1)
262 
265 typedef enum
266 {
267  HAL_SAI_RX_COMPLETE_CB_ID = 0x00U,
268  HAL_SAI_RX_HALFCOMPLETE_CB_ID = 0x01U,
269  HAL_SAI_TX_COMPLETE_CB_ID = 0x02U,
270  HAL_SAI_TX_HALFCOMPLETE_CB_ID = 0x03U,
271  HAL_SAI_ERROR_CB_ID = 0x04U,
272  HAL_SAI_MSPINIT_CB_ID = 0x05U,
273  HAL_SAI_MSPDEINIT_CB_ID = 0x06U
274 } HAL_SAI_CallbackIDTypeDef;
275 
279 typedef void (*pSAI_CallbackTypeDef)(SAI_HandleTypeDef *hsai);
280 #endif
281 
286 /* Exported constants --------------------------------------------------------*/
294 #define HAL_SAI_ERROR_NONE 0x00000000U
295 #define HAL_SAI_ERROR_OVR 0x00000001U
296 #define HAL_SAI_ERROR_UDR 0x00000002U
297 #define HAL_SAI_ERROR_AFSDET 0x00000004U
298 #define HAL_SAI_ERROR_LFSDET 0x00000008U
299 #define HAL_SAI_ERROR_CNREADY 0x00000010U
300 #define HAL_SAI_ERROR_WCKCFG 0x00000020U
301 #define HAL_SAI_ERROR_TIMEOUT 0x00000040U
302 #define HAL_SAI_ERROR_DMA 0x00000080U
303 #if (USE_HAL_SAI_REGISTER_CALLBACKS == 1)
304 #define HAL_SAI_ERROR_INVALID_CALLBACK 0x00000100U
305 #endif
306 
313 #define SAI_SYNCEXT_DISABLE 0U
314 #define SAI_SYNCEXT_OUTBLOCKA_ENABLE 1U
315 #define SAI_SYNCEXT_OUTBLOCKB_ENABLE 2U
316 
323 #define SAI_MCK_OUTPUT_DISABLE 0x00000000U
324 #define SAI_MCK_OUTPUT_ENABLE SAI_xCR1_MCKEN
325 
332 #define SAI_I2S_STANDARD 0U
333 #define SAI_I2S_MSBJUSTIFIED 1U
334 #define SAI_I2S_LSBJUSTIFIED 2U
335 #define SAI_PCM_LONG 3U
336 #define SAI_PCM_SHORT 4U
337 
344 #define SAI_PROTOCOL_DATASIZE_16BIT 0U
345 #define SAI_PROTOCOL_DATASIZE_16BITEXTENDED 1U
346 #define SAI_PROTOCOL_DATASIZE_24BIT 2U
347 #define SAI_PROTOCOL_DATASIZE_32BIT 3U
348 
355 #define SAI_AUDIO_FREQUENCY_192K 192000U
356 #define SAI_AUDIO_FREQUENCY_96K 96000U
357 #define SAI_AUDIO_FREQUENCY_48K 48000U
358 #define SAI_AUDIO_FREQUENCY_44K 44100U
359 #define SAI_AUDIO_FREQUENCY_32K 32000U
360 #define SAI_AUDIO_FREQUENCY_22K 22050U
361 #define SAI_AUDIO_FREQUENCY_16K 16000U
362 #define SAI_AUDIO_FREQUENCY_11K 11025U
363 #define SAI_AUDIO_FREQUENCY_8K 8000U
364 #define SAI_AUDIO_FREQUENCY_MCKDIV 0U
365 
372 #define SAI_MCK_OVERSAMPLING_DISABLE 0x00000000U
373 #define SAI_MCK_OVERSAMPLING_ENABLE SAI_xCR1_OSR
374 
381 #define SAI_PDM_CLOCK1_ENABLE SAI_PDMCR_CKEN1
382 #define SAI_PDM_CLOCK2_ENABLE SAI_PDMCR_CKEN2
383 
390 #define SAI_MODEMASTER_TX 0x00000000U
391 #define SAI_MODEMASTER_RX SAI_xCR1_MODE_0
392 #define SAI_MODESLAVE_TX SAI_xCR1_MODE_1
393 #define SAI_MODESLAVE_RX (SAI_xCR1_MODE_1 | SAI_xCR1_MODE_0)
394 
402 #define SAI_FREE_PROTOCOL 0x00000000U
403 #define SAI_SPDIF_PROTOCOL SAI_xCR1_PRTCFG_0
404 #define SAI_AC97_PROTOCOL SAI_xCR1_PRTCFG_1
405 
412 #define SAI_DATASIZE_8 SAI_xCR1_DS_1
413 #define SAI_DATASIZE_10 (SAI_xCR1_DS_1 | SAI_xCR1_DS_0)
414 #define SAI_DATASIZE_16 SAI_xCR1_DS_2
415 #define SAI_DATASIZE_20 (SAI_xCR1_DS_2 | SAI_xCR1_DS_0)
416 #define SAI_DATASIZE_24 (SAI_xCR1_DS_2 | SAI_xCR1_DS_1)
417 #define SAI_DATASIZE_32 (SAI_xCR1_DS_2 | SAI_xCR1_DS_1 | SAI_xCR1_DS_0)
418 
425 #define SAI_FIRSTBIT_MSB 0x00000000U
426 #define SAI_FIRSTBIT_LSB SAI_xCR1_LSBFIRST
427 
434 #define SAI_CLOCKSTROBING_FALLINGEDGE 0U
435 #define SAI_CLOCKSTROBING_RISINGEDGE 1U
436 
443 #define SAI_ASYNCHRONOUS 0U
444 #define SAI_SYNCHRONOUS 1U
445 #define SAI_SYNCHRONOUS_EXT_SAI1 2U
446 #if defined(SAI2)
447 #define SAI_SYNCHRONOUS_EXT_SAI2 3U
448 #endif /* SAI2 */
449 #if defined(SAI3)
450 #define SAI_SYNCHRONOUS_EXT_SAI3 4U
451 #endif /* SAI3 */
452 #if defined(SAI4)
453 #define SAI_SYNCHRONOUS_EXT_SAI4 5U
454 #endif /* SAI4 */
455 
462 #define SAI_OUTPUTDRIVE_DISABLE 0x00000000U
463 #define SAI_OUTPUTDRIVE_ENABLE SAI_xCR1_OUTDRIV
464 
471 #define SAI_MASTERDIVIDER_ENABLE 0x00000000U
472 #define SAI_MASTERDIVIDER_DISABLE SAI_xCR1_NODIV
473 
480 #define SAI_FS_STARTFRAME 0x00000000U
481 #define SAI_FS_CHANNEL_IDENTIFICATION SAI_xFRCR_FSDEF
482 
489 #define SAI_FS_ACTIVE_LOW 0x00000000U
490 #define SAI_FS_ACTIVE_HIGH SAI_xFRCR_FSPOL
491 
498 #define SAI_FS_FIRSTBIT 0x00000000U
499 #define SAI_FS_BEFOREFIRSTBIT SAI_xFRCR_FSOFF
500 
507 #define SAI_SLOTSIZE_DATASIZE 0x00000000U
508 #define SAI_SLOTSIZE_16B SAI_xSLOTR_SLOTSZ_0
509 #define SAI_SLOTSIZE_32B SAI_xSLOTR_SLOTSZ_1
510 
517 #define SAI_SLOT_NOTACTIVE 0x00000000U
518 #define SAI_SLOTACTIVE_0 0x00000001U
519 #define SAI_SLOTACTIVE_1 0x00000002U
520 #define SAI_SLOTACTIVE_2 0x00000004U
521 #define SAI_SLOTACTIVE_3 0x00000008U
522 #define SAI_SLOTACTIVE_4 0x00000010U
523 #define SAI_SLOTACTIVE_5 0x00000020U
524 #define SAI_SLOTACTIVE_6 0x00000040U
525 #define SAI_SLOTACTIVE_7 0x00000080U
526 #define SAI_SLOTACTIVE_8 0x00000100U
527 #define SAI_SLOTACTIVE_9 0x00000200U
528 #define SAI_SLOTACTIVE_10 0x00000400U
529 #define SAI_SLOTACTIVE_11 0x00000800U
530 #define SAI_SLOTACTIVE_12 0x00001000U
531 #define SAI_SLOTACTIVE_13 0x00002000U
532 #define SAI_SLOTACTIVE_14 0x00004000U
533 #define SAI_SLOTACTIVE_15 0x00008000U
534 #define SAI_SLOTACTIVE_ALL 0x0000FFFFU
535 
542 #define SAI_STEREOMODE 0x00000000U
543 #define SAI_MONOMODE SAI_xCR1_MONO
544 
551 #define SAI_OUTPUT_NOTRELEASED 0x00000000U
552 #define SAI_OUTPUT_RELEASED SAI_xCR2_TRIS
553 
560 #define SAI_FIFOTHRESHOLD_EMPTY 0x00000000U
561 #define SAI_FIFOTHRESHOLD_1QF SAI_xCR2_FTH_0
562 #define SAI_FIFOTHRESHOLD_HF SAI_xCR2_FTH_1
563 #define SAI_FIFOTHRESHOLD_3QF (SAI_xCR2_FTH_1 | SAI_xCR2_FTH_0)
564 #define SAI_FIFOTHRESHOLD_FULL SAI_xCR2_FTH_2
565 
572 #define SAI_NOCOMPANDING 0x00000000U
573 #define SAI_ULAW_1CPL_COMPANDING SAI_xCR2_COMP_1
574 #define SAI_ALAW_1CPL_COMPANDING (SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0)
575 #define SAI_ULAW_2CPL_COMPANDING (SAI_xCR2_COMP_1 | SAI_xCR2_CPL)
576 #define SAI_ALAW_2CPL_COMPANDING (SAI_xCR2_COMP_1 | SAI_xCR2_COMP_0 | SAI_xCR2_CPL)
577 
584 #define SAI_ZERO_VALUE 0x00000000U
585 #define SAI_LAST_SENT_VALUE SAI_xCR2_MUTEVAL
586 
593 #define SAI_IT_OVRUDR SAI_xIMR_OVRUDRIE
594 #define SAI_IT_MUTEDET SAI_xIMR_MUTEDETIE
595 #define SAI_IT_WCKCFG SAI_xIMR_WCKCFGIE
596 #define SAI_IT_FREQ SAI_xIMR_FREQIE
597 #define SAI_IT_CNRDY SAI_xIMR_CNRDYIE
598 #define SAI_IT_AFSDET SAI_xIMR_AFSDETIE
599 #define SAI_IT_LFSDET SAI_xIMR_LFSDETIE
600 
607 #define SAI_FLAG_OVRUDR SAI_xSR_OVRUDR
608 #define SAI_FLAG_MUTEDET SAI_xSR_MUTEDET
609 #define SAI_FLAG_WCKCFG SAI_xSR_WCKCFG
610 #define SAI_FLAG_FREQ SAI_xSR_FREQ
611 #define SAI_FLAG_CNRDY SAI_xSR_CNRDY
612 #define SAI_FLAG_AFSDET SAI_xSR_AFSDET
613 #define SAI_FLAG_LFSDET SAI_xSR_LFSDET
614 
621 #define SAI_FIFOSTATUS_EMPTY 0x00000000U
622 #define SAI_FIFOSTATUS_LESS1QUARTERFULL 0x00010000U
623 #define SAI_FIFOSTATUS_1QUARTERFULL 0x00020000U
624 #define SAI_FIFOSTATUS_HALFFULL 0x00030000U
625 #define SAI_FIFOSTATUS_3QUARTERFULL 0x00040000U
626 #define SAI_FIFOSTATUS_FULL 0x00050000U
627 
635 /* Exported macro ------------------------------------------------------------*/
645 #if (USE_HAL_SAI_REGISTER_CALLBACKS == 1)
646 #define __HAL_SAI_RESET_HANDLE_STATE(__HANDLE__) do{ \
647  (__HANDLE__)->State = HAL_SAI_STATE_RESET; \
648  (__HANDLE__)->MspInitCallback = NULL; \
649  (__HANDLE__)->MspDeInitCallback = NULL; \
650  } while(0U)
651 #else
652 #define __HAL_SAI_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SAI_STATE_RESET)
653 #endif
654 
668 #define __HAL_SAI_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR |= (__INTERRUPT__))
669 
683 #define __HAL_SAI_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IMR &= (~(__INTERRUPT__)))
684 
698 #define __HAL_SAI_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IMR & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
699 
713 #define __HAL_SAI_GET_FLAG(__HANDLE__, __FLAG__) ((((__HANDLE__)->Instance->SR) & (__FLAG__)) == (__FLAG__))
714 
729 #define __HAL_SAI_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->CLRFR = (__FLAG__))
730 
735 #define __HAL_SAI_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= SAI_xCR1_SAIEN)
736 
741 #define __HAL_SAI_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~SAI_xCR1_SAIEN)
742 
747 /* Include SAI HAL Extension module */
748 #include "stm32h7xx_hal_sai_ex.h"
749 
750 /* Exported functions --------------------------------------------------------*/
755 /* Initialization/de-initialization functions ********************************/
759 HAL_StatusTypeDef HAL_SAI_InitProtocol(SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot);
760 HAL_StatusTypeDef HAL_SAI_Init(SAI_HandleTypeDef *hsai);
761 HAL_StatusTypeDef HAL_SAI_DeInit(SAI_HandleTypeDef *hsai);
762 void HAL_SAI_MspInit(SAI_HandleTypeDef *hsai);
763 void HAL_SAI_MspDeInit(SAI_HandleTypeDef *hsai);
764 
765 #if (USE_HAL_SAI_REGISTER_CALLBACKS == 1)
766 /* SAI callbacks register/unregister functions ********************************/
767 HAL_StatusTypeDef HAL_SAI_RegisterCallback(SAI_HandleTypeDef *hsai,
768  HAL_SAI_CallbackIDTypeDef CallbackID,
769  pSAI_CallbackTypeDef pCallback);
770 HAL_StatusTypeDef HAL_SAI_UnRegisterCallback(SAI_HandleTypeDef *hsai,
771  HAL_SAI_CallbackIDTypeDef CallbackID);
772 #endif
773 
777 /* I/O operation functions ***************************************************/
781 /* Blocking mode: Polling */
782 HAL_StatusTypeDef HAL_SAI_Transmit(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
783 HAL_StatusTypeDef HAL_SAI_Receive(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout);
784 
785 /* Non-Blocking mode: Interrupt */
786 HAL_StatusTypeDef HAL_SAI_Transmit_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
787 HAL_StatusTypeDef HAL_SAI_Receive_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
788 
789 /* Non-Blocking mode: DMA */
790 HAL_StatusTypeDef HAL_SAI_Transmit_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
791 HAL_StatusTypeDef HAL_SAI_Receive_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size);
792 HAL_StatusTypeDef HAL_SAI_DMAPause(SAI_HandleTypeDef *hsai);
793 HAL_StatusTypeDef HAL_SAI_DMAResume(SAI_HandleTypeDef *hsai);
794 HAL_StatusTypeDef HAL_SAI_DMAStop(SAI_HandleTypeDef *hsai);
795 
796 /* Abort function */
797 HAL_StatusTypeDef HAL_SAI_Abort(SAI_HandleTypeDef *hsai);
798 
799 /* Mute management */
800 HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode(SAI_HandleTypeDef *hsai, uint16_t val);
801 HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode(SAI_HandleTypeDef *hsai);
802 HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode(SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter);
803 HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode(SAI_HandleTypeDef *hsai);
804 
805 /* SAI IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
806 void HAL_SAI_IRQHandler(SAI_HandleTypeDef *hsai);
807 void HAL_SAI_TxHalfCpltCallback(SAI_HandleTypeDef *hsai);
808 void HAL_SAI_TxCpltCallback(SAI_HandleTypeDef *hsai);
809 void HAL_SAI_RxHalfCpltCallback(SAI_HandleTypeDef *hsai);
810 void HAL_SAI_RxCpltCallback(SAI_HandleTypeDef *hsai);
811 void HAL_SAI_ErrorCallback(SAI_HandleTypeDef *hsai);
819 /* Peripheral State functions ************************************************/
820 HAL_SAI_StateTypeDef HAL_SAI_GetState(SAI_HandleTypeDef *hsai);
821 uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai);
830 /* Private macros ------------------------------------------------------------*/
834 #define IS_SAI_BLOCK_SYNCEXT(STATE) (((STATE) == SAI_SYNCEXT_DISABLE) ||\
835  ((STATE) == SAI_SYNCEXT_OUTBLOCKA_ENABLE) ||\
836  ((STATE) == SAI_SYNCEXT_OUTBLOCKB_ENABLE))
837 
838 #define IS_SAI_SUPPORTED_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_I2S_STANDARD) ||\
839  ((PROTOCOL) == SAI_I2S_MSBJUSTIFIED) ||\
840  ((PROTOCOL) == SAI_I2S_LSBJUSTIFIED) ||\
841  ((PROTOCOL) == SAI_PCM_LONG) ||\
842  ((PROTOCOL) == SAI_PCM_SHORT))
843 
844 #define IS_SAI_PROTOCOL_DATASIZE(DATASIZE) (((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BIT) ||\
845  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_16BITEXTENDED) ||\
846  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_24BIT) ||\
847  ((DATASIZE) == SAI_PROTOCOL_DATASIZE_32BIT))
848 
849 #define IS_SAI_AUDIO_FREQUENCY(AUDIO) (((AUDIO) == SAI_AUDIO_FREQUENCY_192K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_96K) || \
850  ((AUDIO) == SAI_AUDIO_FREQUENCY_48K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_44K) || \
851  ((AUDIO) == SAI_AUDIO_FREQUENCY_32K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_22K) || \
852  ((AUDIO) == SAI_AUDIO_FREQUENCY_16K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_11K) || \
853  ((AUDIO) == SAI_AUDIO_FREQUENCY_8K) || ((AUDIO) == SAI_AUDIO_FREQUENCY_MCKDIV))
854 
855 #define IS_SAI_BLOCK_MCK_OVERSAMPLING(VALUE) (((VALUE) == SAI_MCK_OVERSAMPLING_DISABLE) || \
856  ((VALUE) == SAI_MCK_OVERSAMPLING_ENABLE))
857 
858 #define IS_SAI_PDM_MIC_PAIRS_NUMBER(VALUE) ((1U <= (VALUE)) && ((VALUE) <= 3U))
859 
860 #define IS_SAI_PDM_CLOCK_ENABLE(CLOCK) (((CLOCK) != 0U) && \
861  (((CLOCK) & ~(SAI_PDM_CLOCK1_ENABLE | SAI_PDM_CLOCK2_ENABLE)) == 0U))
862 
863 #define IS_SAI_BLOCK_MODE(MODE) (((MODE) == SAI_MODEMASTER_TX) || \
864  ((MODE) == SAI_MODEMASTER_RX) || \
865  ((MODE) == SAI_MODESLAVE_TX) || \
866  ((MODE) == SAI_MODESLAVE_RX))
867 
868 #define IS_SAI_BLOCK_PROTOCOL(PROTOCOL) (((PROTOCOL) == SAI_FREE_PROTOCOL) || \
869  ((PROTOCOL) == SAI_AC97_PROTOCOL) || \
870  ((PROTOCOL) == SAI_SPDIF_PROTOCOL))
871 
872 #define IS_SAI_BLOCK_DATASIZE(DATASIZE) (((DATASIZE) == SAI_DATASIZE_8) || \
873  ((DATASIZE) == SAI_DATASIZE_10) || \
874  ((DATASIZE) == SAI_DATASIZE_16) || \
875  ((DATASIZE) == SAI_DATASIZE_20) || \
876  ((DATASIZE) == SAI_DATASIZE_24) || \
877  ((DATASIZE) == SAI_DATASIZE_32))
878 
879 #define IS_SAI_BLOCK_FIRST_BIT(BIT) (((BIT) == SAI_FIRSTBIT_MSB) || \
880  ((BIT) == SAI_FIRSTBIT_LSB))
881 
882 #define IS_SAI_BLOCK_CLOCK_STROBING(CLOCK) (((CLOCK) == SAI_CLOCKSTROBING_FALLINGEDGE) || \
883  ((CLOCK) == SAI_CLOCKSTROBING_RISINGEDGE))
884 #if defined(SAI2) && defined(SAI3) && defined(SAI4)
885 #define IS_SAI_BLOCK_SYNCHRO(SYNCHRO) (((SYNCHRO) == SAI_ASYNCHRONOUS) || \
886  ((SYNCHRO) == SAI_SYNCHRONOUS) || \
887  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) || \
888  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI2) || \
889  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI3) || \
890  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI4))
891 #elif defined(SAI2)
892 #define IS_SAI_BLOCK_SYNCHRO(SYNCHRO) (((SYNCHRO) == SAI_ASYNCHRONOUS) || \
893  ((SYNCHRO) == SAI_SYNCHRONOUS) || \
894  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) || \
895  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI2))
896 #else
897 #define IS_SAI_BLOCK_SYNCHRO(SYNCHRO) (((SYNCHRO) == SAI_ASYNCHRONOUS) || \
898  ((SYNCHRO) == SAI_SYNCHRONOUS) || \
899  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI1) || \
900  ((SYNCHRO) == SAI_SYNCHRONOUS_EXT_SAI4))
901 #endif
902 
903 #define IS_SAI_BLOCK_MCK_OUTPUT(VALUE) (((VALUE) == SAI_MCK_OUTPUT_ENABLE) || \
904  ((VALUE) == SAI_MCK_OUTPUT_DISABLE))
905 
906 #define IS_SAI_BLOCK_OUTPUT_DRIVE(DRIVE) (((DRIVE) == SAI_OUTPUTDRIVE_DISABLE) || \
907  ((DRIVE) == SAI_OUTPUTDRIVE_ENABLE))
908 
909 #define IS_SAI_BLOCK_NODIVIDER(NODIVIDER) (((NODIVIDER) == SAI_MASTERDIVIDER_ENABLE) || \
910  ((NODIVIDER) == SAI_MASTERDIVIDER_DISABLE))
911 
912 #define IS_SAI_BLOCK_MUTE_COUNTER(COUNTER) ((COUNTER) <= 63U)
913 
914 #define IS_SAI_BLOCK_MUTE_VALUE(VALUE) (((VALUE) == SAI_ZERO_VALUE) || \
915  ((VALUE) == SAI_LAST_SENT_VALUE))
916 
917 #define IS_SAI_BLOCK_COMPANDING_MODE(MODE) (((MODE) == SAI_NOCOMPANDING) || \
918  ((MODE) == SAI_ULAW_1CPL_COMPANDING) || \
919  ((MODE) == SAI_ALAW_1CPL_COMPANDING) || \
920  ((MODE) == SAI_ULAW_2CPL_COMPANDING) || \
921  ((MODE) == SAI_ALAW_2CPL_COMPANDING))
922 
923 #define IS_SAI_BLOCK_FIFO_THRESHOLD(THRESHOLD) (((THRESHOLD) == SAI_FIFOTHRESHOLD_EMPTY) || \
924  ((THRESHOLD) == SAI_FIFOTHRESHOLD_1QF) || \
925  ((THRESHOLD) == SAI_FIFOTHRESHOLD_HF) || \
926  ((THRESHOLD) == SAI_FIFOTHRESHOLD_3QF) || \
927  ((THRESHOLD) == SAI_FIFOTHRESHOLD_FULL))
928 
929 #define IS_SAI_BLOCK_TRISTATE_MANAGEMENT(STATE) (((STATE) == SAI_OUTPUT_NOTRELEASED) ||\
930  ((STATE) == SAI_OUTPUT_RELEASED))
931 
932 #define IS_SAI_MONO_STEREO_MODE(MODE) (((MODE) == SAI_MONOMODE) ||\
933  ((MODE) == SAI_STEREOMODE))
934 
935 #define IS_SAI_SLOT_ACTIVE(ACTIVE) ((ACTIVE) <= SAI_SLOTACTIVE_ALL)
936 
937 #define IS_SAI_BLOCK_SLOT_NUMBER(NUMBER) ((1U <= (NUMBER)) && ((NUMBER) <= 16U))
938 
939 #define IS_SAI_BLOCK_SLOT_SIZE(SIZE) (((SIZE) == SAI_SLOTSIZE_DATASIZE) || \
940  ((SIZE) == SAI_SLOTSIZE_16B) || \
941  ((SIZE) == SAI_SLOTSIZE_32B))
942 
943 #define IS_SAI_BLOCK_FIRSTBIT_OFFSET(OFFSET) ((OFFSET) <= 24U)
944 
945 #define IS_SAI_BLOCK_FS_OFFSET(OFFSET) (((OFFSET) == SAI_FS_FIRSTBIT) || \
946  ((OFFSET) == SAI_FS_BEFOREFIRSTBIT))
947 
948 #define IS_SAI_BLOCK_FS_POLARITY(POLARITY) (((POLARITY) == SAI_FS_ACTIVE_LOW) || \
949  ((POLARITY) == SAI_FS_ACTIVE_HIGH))
950 
951 #define IS_SAI_BLOCK_FS_DEFINITION(DEFINITION) (((DEFINITION) == SAI_FS_STARTFRAME) || \
952  ((DEFINITION) == SAI_FS_CHANNEL_IDENTIFICATION))
953 
954 #define IS_SAI_BLOCK_MASTER_DIVIDER(DIVIDER) ((DIVIDER) <= 63U)
955 
956 #define IS_SAI_BLOCK_FRAME_LENGTH(LENGTH) ((8U <= (LENGTH)) && ((LENGTH) <= 256U))
957 
958 #define IS_SAI_BLOCK_ACTIVE_FRAME(LENGTH) ((1U <= (LENGTH)) && ((LENGTH) <= 128U))
959 
964 /* Private functions ---------------------------------------------------------*/
981 #ifdef __cplusplus
982 }
983 #endif
984 
985 #endif /* STM32H7xx_HAL_SAI_H */
986 
987 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
__SAI_HandleTypeDef::mutecallback
SAIcallback mutecallback
Definition: stm32f7xx_hal_sai.h:211
HAL_SAI_DisableRxMuteMode
HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode(SAI_HandleTypeDef *hsai)
HAL_SAI_DisableTxMuteMode
HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode(SAI_HandleTypeDef *hsai)
__IO
#define __IO
Definition: imxrt1050/imxrt1050-evkb/CMSIS/core_cm7.h:237
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:40
HAL_SAI_MspInit
void HAL_SAI_MspInit(SAI_HandleTypeDef *hsai)
Definition: stm32h7xx_hal_msp.c:398
HAL_SAI_DMAStop
HAL_StatusTypeDef HAL_SAI_DMAStop(SAI_HandleTypeDef *hsai)
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma.h:139
__SAI_HandleTypeDef::hdmatx
DMA_HandleTypeDef * hdmatx
Definition: stm32f7xx_hal_sai.h:207
HAL_SAI_DMAPause
HAL_StatusTypeDef HAL_SAI_DMAPause(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::ErrorCode
__IO uint32_t ErrorCode
Definition: stm32f7xx_hal_sai.h:219
SAI_HandleTypeDef
struct __SAI_HandleTypeDef SAI_HandleTypeDef
HAL_SAI_DeInit
HAL_StatusTypeDef HAL_SAI_DeInit(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::pBuffPtr
uint8_t * pBuffPtr
Definition: stm32f7xx_hal_sai.h:201
HAL_SAI_GetState
HAL_SAI_StateTypeDef HAL_SAI_GetState(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::State
__IO HAL_SAI_StateTypeDef State
Definition: stm32f7xx_hal_sai.h:217
HAL_SAI_STATE_READY
@ HAL_SAI_STATE_READY
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:50
HAL_SAI_Receive
HAL_StatusTypeDef HAL_SAI_Receive(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:51
HAL_SAI_IRQHandler
void HAL_SAI_IRQHandler(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::hdmarx
DMA_HandleTypeDef * hdmarx
Definition: stm32f7xx_hal_sai.h:209
__SAI_HandleTypeDef::Instance
SAI_Block_TypeDef * Instance
Definition: stm32f7xx_hal_sai.h:193
__SAI_HandleTypeDef::XferSize
uint16_t XferSize
Definition: stm32f7xx_hal_sai.h:203
HAL_SAI_STATE_BUSY_RX
@ HAL_SAI_STATE_BUSY_RX
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:53
SAI_FrameInitTypeDef
Definition: stm32f7xx_hal_sai.h:137
HAL_SAI_InitProtocol
HAL_StatusTypeDef HAL_SAI_InitProtocol(SAI_HandleTypeDef *hsai, uint32_t protocol, uint32_t datasize, uint32_t nbslot)
__SAI_HandleTypeDef::Init
SAI_InitTypeDef Init
Definition: stm32f7xx_hal_sai.h:195
__SAI_HandleTypeDef
Definition: stm32f7xx_hal_sai.h:191
__SAI_HandleTypeDef::Lock
HAL_LockTypeDef Lock
Definition: stm32f7xx_hal_sai.h:215
HAL_SAI_RxHalfCpltCallback
void HAL_SAI_RxHalfCpltCallback(SAI_HandleTypeDef *hsai)
Half reception complete callback.
Definition: stm32f769i_discovery_audio.c:1593
HAL_SAI_GetError
uint32_t HAL_SAI_GetError(SAI_HandleTypeDef *hsai)
HAL_SAI_DMAResume
HAL_StatusTypeDef HAL_SAI_DMAResume(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::XferCount
uint16_t XferCount
Definition: stm32f7xx_hal_sai.h:205
HAL_SAI_RxCpltCallback
void HAL_SAI_RxCpltCallback(SAI_HandleTypeDef *hsai)
Reception complete callback.
Definition: stm32f769i_discovery_audio.c:1605
SAI_Block_TypeDef
Definition: stm32f469xx.h:848
HAL_SAI_Transmit_IT
HAL_StatusTypeDef HAL_SAI_Transmit_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
SAI_InitTypeDef
Definition: stm32f7xx_hal_sai.h:66
stm32h7xx_hal_sai_ex.h
Header file of SAI HAL extended module.
HAL_SAI_ErrorCallback
void HAL_SAI_ErrorCallback(SAI_HandleTypeDef *hsai)
SAI error callbacks.
Definition: stm32469i_discovery_audio.c:628
HAL_SAI_TxHalfCpltCallback
void HAL_SAI_TxHalfCpltCallback(SAI_HandleTypeDef *hsai)
Tx Half Transfer completed callbacks.
Definition: stm32469i_discovery_audio.c:617
HAL_SAI_EnableTxMuteMode
HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode(SAI_HandleTypeDef *hsai, uint16_t val)
SAI_SlotInitTypeDef
Definition: stm32f7xx_hal_sai.h:169
__SAI_HandleTypeDef::InterruptServiceRoutine
void(* InterruptServiceRoutine)(struct __SAI_HandleTypeDef *hsai)
Definition: stm32f7xx_hal_sai.h:213
HAL_SAI_Transmit
HAL_StatusTypeDef HAL_SAI_Transmit(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_SAI_TxCpltCallback
void HAL_SAI_TxCpltCallback(SAI_HandleTypeDef *hsai)
Tx Transfer completed callbacks.
Definition: stm32469i_discovery_audio.c:606
HAL_SAI_Receive_DMA
HAL_StatusTypeDef HAL_SAI_Receive_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
SAI_PdmInitTypeDef
Definition: stm32h735/stm32h735g-dk/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:65
stm32h7xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_SAI_STATE_BUSY_TX
@ HAL_SAI_STATE_BUSY_TX
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:52
HAL_SAI_StateTypeDef
HAL_SAI_StateTypeDef
HAL State structures definition.
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:47
HAL_SAI_Init
HAL_StatusTypeDef HAL_SAI_Init(SAI_HandleTypeDef *hsai)
HAL_SAI_STATE_BUSY
@ HAL_SAI_STATE_BUSY
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:51
HAL_SAI_Receive_IT
HAL_StatusTypeDef HAL_SAI_Receive_IT(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
HAL_SAI_STATE_RESET
@ HAL_SAI_STATE_RESET
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:49
SAIcallback
void(* SAIcallback)(void)
SAI Callback prototype.
Definition: stm32h747/stm32h747i-disco/CM7/Drivers/STM32H7xx_HAL_Driver/Inc/stm32h7xx_hal_sai.h:59
HAL_SAI_MspDeInit
void HAL_SAI_MspDeInit(SAI_HandleTypeDef *hsai)
Definition: stm32h7xx_hal_msp.c:456
HAL_SAI_Abort
HAL_StatusTypeDef HAL_SAI_Abort(SAI_HandleTypeDef *hsai)
__SAI_HandleTypeDef::SlotInit
SAI_SlotInitTypeDef SlotInit
Definition: stm32f7xx_hal_sai.h:199
__SAI_HandleTypeDef::FrameInit
SAI_FrameInitTypeDef FrameInit
Definition: stm32f7xx_hal_sai.h:197
HAL_SAI_Transmit_DMA
HAL_StatusTypeDef HAL_SAI_Transmit_DMA(SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
FunctionalState
FunctionalState
Definition: stm32f407/stm32f407g-disc1/Drivers/CMSIS/Device/ST/STM32F4xx/Include/stm32f4xx.h:191
HAL_SAI_EnableRxMuteMode
HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode(SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter)

picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:14:55