TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Important changes to repositories hosted on mbed.com

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

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

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

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

IO operation functions
Functions

IO operation functions
[SAI Exported Functions]

Data transfers functions. More...

Functions

HAL_StatusTypeDef HAL_SAI_Transmit (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 Transmit an amount of data in blocking mode.
HAL_StatusTypeDef HAL_SAI_Receive (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size, uint32_t Timeout)
 Receive an amount of data in blocking mode.
HAL_StatusTypeDef HAL_SAI_Transmit_IT (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 Transmit an amount of data in non-blocking mode with Interrupt.
HAL_StatusTypeDef HAL_SAI_Receive_IT (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 Receive an amount of data in non-blocking mode with Interrupt.
HAL_StatusTypeDef HAL_SAI_DMAPause (SAI_HandleTypeDef *hsai)
 Pause the audio stream playing from the Media.
HAL_StatusTypeDef HAL_SAI_DMAResume (SAI_HandleTypeDef *hsai)
 Resume the audio stream playing from the Media.
HAL_StatusTypeDef HAL_SAI_DMAStop (SAI_HandleTypeDef *hsai)
 Stop the audio stream playing from the Media.
HAL_StatusTypeDef HAL_SAI_Abort (SAI_HandleTypeDef *hsai)
 Abort the current transfer and disable the SAI.
HAL_StatusTypeDef HAL_SAI_Transmit_DMA (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 Transmit an amount of data in non-blocking mode with DMA.
HAL_StatusTypeDef HAL_SAI_Receive_DMA (SAI_HandleTypeDef *hsai, uint8_t *pData, uint16_t Size)
 Receive an amount of data in non-blocking mode with DMA.
HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode (SAI_HandleTypeDef *hsai, uint16_t val)
 Enable the Tx mute mode.
HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode (SAI_HandleTypeDef *hsai)
 Disable the Tx mute mode.
HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode (SAI_HandleTypeDef *hsai, SAIcallback callback, uint16_t counter)
 Enable the Rx mute detection.
HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode (SAI_HandleTypeDef *hsai)
 Disable the Rx mute detection.
void HAL_SAI_IRQHandler (SAI_HandleTypeDef *hsai)
 Handle SAI interrupt request.
__weak void HAL_SAI_TxCpltCallback (SAI_HandleTypeDef *hsai)
 Tx Transfer completed callback.
__weak void HAL_SAI_TxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Tx Transfer Half completed callback.
__weak void HAL_SAI_RxCpltCallback (SAI_HandleTypeDef *hsai)
 Rx Transfer completed callback.
__weak void HAL_SAI_RxHalfCpltCallback (SAI_HandleTypeDef *hsai)
 Rx Transfer half completed callback.
__weak void HAL_SAI_ErrorCallback (SAI_HandleTypeDef *hsai)
 SAI error callback.

Detailed Description

Data transfers functions. 

  ==============================================================================
                      ##### IO operation functions #####
  ==============================================================================
  [..]
    This subsection provides a set of functions allowing to manage the SAI data
    transfers.

    (+) There are two modes of transfer:
      (++) Blocking mode : The communication is performed in the polling mode.
           The status of all data processing is returned by the same function
           after finishing transfer.
      (++) No-Blocking mode : The communication is performed using Interrupts
           or DMA. These functions return the status of the transfer startup.
           The end of the data processing will be indicated through the
           dedicated SAI IRQ when using Interrupt mode or the DMA IRQ when
           using DMA mode.

    (+) Blocking mode functions are :
      (++) HAL_SAI_Transmit()
      (++) HAL_SAI_Receive()
      (++) HAL_SAI_TransmitReceive()

    (+) Non Blocking mode functions with Interrupt are :
      (++) HAL_SAI_Transmit_IT()
      (++) HAL_SAI_Receive_IT()
      (++) HAL_SAI_TransmitReceive_IT()

    (+) Non Blocking mode functions with DMA are :
      (++) HAL_SAI_Transmit_DMA()
      (++) HAL_SAI_Receive_DMA()
      (++) HAL_SAI_TransmitReceive_DMA()

    (+) A set of Transfer Complete Callbacks are provided in non Blocking mode:
      (++) HAL_SAI_TxCpltCallback()
      (++) HAL_SAI_RxCpltCallback()
      (++) HAL_SAI_ErrorCallback()

Function Documentation

HAL_StatusTypeDef HAL_SAI_Abort ( SAI_HandleTypeDef *  hsai )

Abort the current transfer and disable the SAI.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 1071 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_DisableRxMuteMode ( SAI_HandleTypeDef *  hsai )

Disable the Rx mute detection.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 1324 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_DisableTxMuteMode ( SAI_HandleTypeDef *  hsai )

Disable the Tx mute mode.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 1283 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_DMAPause ( SAI_HandleTypeDef *  hsai )

Pause the audio stream playing from the Media.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 982 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_DMAResume ( SAI_HandleTypeDef *  hsai )

Resume the audio stream playing from the Media.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 1002 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_DMAStop ( SAI_HandleTypeDef *  hsai )

Stop the audio stream playing from the Media.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
HALstatus

Definition at line 1029 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_EnableRxMuteMode ( SAI_HandleTypeDef *  hsai,
SAIcallback  callback,
uint16_t  counter 
)

Enable the Rx mute detection.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
callback,:function called when the mute is detected.
counter,:number a data before mute detection max 63.
Return values:
HALstatus

Definition at line 1301 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_EnableTxMuteMode ( SAI_HandleTypeDef *  hsai,
uint16_t  val 
)

Enable the Tx mute mode.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
val,:value sent during the mute SAI Block Mute Value
Return values:
HALstatus

Definition at line 1264 of file stm32l4xx_hal_sai.c.

void HAL_SAI_ErrorCallback ( SAI_HandleTypeDef *  hsai )

SAI error callback.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1583 of file stm32l4xx_hal_sai.c.

void HAL_SAI_IRQHandler ( SAI_HandleTypeDef *  hsai )

Handle SAI interrupt request.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1343 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Receive ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size,
uint32_t  Timeout 
)

Receive an amount of data in blocking mode.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be received
Timeout,:Timeout duration
Return values:
HALstatus

Definition at line 765 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Receive_DMA ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size 
)

Receive an amount of data in non-blocking mode with DMA.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be received
Return values:
HALstatus

Definition at line 1195 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Receive_IT ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size 
)

Receive an amount of data in non-blocking mode with Interrupt.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be received
Return values:
HALstatus

Definition at line 924 of file stm32l4xx_hal_sai.c.

void HAL_SAI_RxCpltCallback ( SAI_HandleTypeDef *  hsai )

Rx Transfer completed callback.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1551 of file stm32l4xx_hal_sai.c.

void HAL_SAI_RxHalfCpltCallback ( SAI_HandleTypeDef *  hsai )

Rx Transfer half completed callback.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1567 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Transmit ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size,
uint32_t  Timeout 
)

Transmit an amount of data in blocking mode.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be sent
Timeout,:Timeout duration
Return values:
HALstatus

Definition at line 665 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Transmit_DMA ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size 
)

Transmit an amount of data in non-blocking mode with DMA.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be sent
Return values:
HALstatus

Definition at line 1126 of file stm32l4xx_hal_sai.c.

HAL_StatusTypeDef HAL_SAI_Transmit_IT ( SAI_HandleTypeDef *  hsai,
uint8_t *  pData,
uint16_t  Size 
)

Transmit an amount of data in non-blocking mode with Interrupt.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
pData,:Pointer to data buffer
Size,:Amount of data to be sent
Return values:
HALstatus

Definition at line 862 of file stm32l4xx_hal_sai.c.

void HAL_SAI_TxCpltCallback ( SAI_HandleTypeDef *  hsai )

Tx Transfer completed callback.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1519 of file stm32l4xx_hal_sai.c.

void HAL_SAI_TxHalfCpltCallback ( SAI_HandleTypeDef *  hsai )

Tx Transfer Half completed callback.

Parameters:
hsai,:pointer to a SAI_HandleTypeDef structure that contains the configuration information for SAI module.
Return values:
None

Definition at line 1535 of file stm32l4xx_hal_sai.c.

Generated on Tue Jul 12 2022 17:38:54 by  doxygen 1.7.2