Senior Design: Sound Monitor / STM32L4xx_HAL_Driver

L4 HAL Drivers

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 967 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 1195 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 1154 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 884 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 904 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 931 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 1172 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 1135 of file stm32l4xx_hal_sai.c.

__weak 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 1349 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 1214 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 680 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 1073 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 825 of file stm32l4xx_hal_sai.c.

__weak 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 1323 of file stm32l4xx_hal_sai.c.

__weak 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 1336 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 596 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 1009 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 762 of file stm32l4xx_hal_sai.c.

__weak 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 1297 of file stm32l4xx_hal_sai.c.

__weak 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 1310 of file stm32l4xx_hal_sai.c.

Generated on Tue Jul 12 2022 10:58:18 by  doxygen 1.7.2