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

Peripheral Control functions
Functions

Peripheral Control functions
[UARTEx Exported Functions]

Extended Peripheral Control functions. More...

Functions

HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set (UART_HandleTypeDef *huart, uint32_t AddressLength)
 By default in multiprocessor mode, when the wake up method is set to address mark, the UART handles only 4-bit long addresses detection; this API allows to enable longer addresses detection (6-, 7- or 8-bit long).
HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig (UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection)
 Set Wakeup from Stop mode interrupt flag selection.
HAL_StatusTypeDef HAL_UARTEx_EnableStopMode (UART_HandleTypeDef *huart)
 Enable UART Stop Mode.
HAL_StatusTypeDef HAL_UARTEx_DisableStopMode (UART_HandleTypeDef *huart)
 Disable UART Stop Mode.
__weak void HAL_UARTEx_WakeupCallback (UART_HandleTypeDef *huart)
 UART wakeup from Stop mode callback.

Detailed Description

Extended Peripheral Control functions. 

 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================
    [..] This section provides the following functions:
     (+) HAL_UARTEx_EnableClockStopMode() API enables the UART clock (HSI or LSE only) during stop mode
     (+) HAL_UARTEx_DisableClockStopMode() API disables the above functionality
     (+) HAL_MultiProcessorEx_AddressLength_Set() API optionally sets the UART node address
         detection length to more than 4 bits for multiprocessor address mark wake up.
     (+) HAL_UARTEx_StopModeWakeUpSourceConfig() API defines the wake-up from stop mode
         trigger: address match, Start Bit detection or RXNE bit status.
     (+) HAL_UARTEx_EnableStopMode() API enables the UART to wake up the MCU from stop mode
     (+) HAL_UARTEx_DisableStopMode() API disables the above functionality
     (+) HAL_UARTEx_WakeupCallback() called upon UART wakeup interrupt

Function Documentation

HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set ( UART_HandleTypeDef *  huart,
uint32_t  AddressLength 
)

By default in multiprocessor mode, when the wake up method is set to address mark, the UART handles only 4-bit long addresses detection; this API allows to enable longer addresses detection (6-, 7- or 8-bit long).

Note:
Addresses detection lengths are: 6-bit address detection in 7-bit data mode, 7-bit address detection in 8-bit data mode, 8-bit address detection in 9-bit data mode.
Parameters:
huart,:UART handle.
AddressLength,:this parameter can be one of the following values:

  • UART_ADDRESS_DETECT_4B 4-bit long address
  • UART_ADDRESS_DETECT_7B 6-, 7- or 8-bit long address
Return values:
HALstatus

Definition at line 274 of file stm32l4xx_hal_uart_ex.c.

HAL_StatusTypeDef HAL_UARTEx_DisableStopMode ( UART_HandleTypeDef *  huart )

Disable UART Stop Mode.

Parameters:
huart,:UART handle.
Return values:
HALstatus

Definition at line 390 of file stm32l4xx_hal_uart_ex.c.

HAL_StatusTypeDef HAL_UARTEx_EnableStopMode ( UART_HandleTypeDef *  huart )

Enable UART Stop Mode.

Note:
The UART is able to wake up the MCU from Stop 1 mode as long as UART clock is HSI or LSE.
Parameters:
huart,:UART handle.
Return values:
HALstatus

Definition at line 367 of file stm32l4xx_hal_uart_ex.c.

HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig ( UART_HandleTypeDef *  huart,
UART_WakeUpTypeDef  WakeUpSelection 
)

Set Wakeup from Stop mode interrupt flag selection.

Parameters:
huart,:UART handle.
WakeUpSelection,:address match, Start Bit detection or RXNE bit status. This parameter can be one of the following values:

  • UART_WAKEUP_ON_ADDRESS
  • UART_WAKEUP_ON_STARTBIT
  • UART_WAKEUP_ON_READDATA_NONEMPTY
Return values:
HALstatus

Definition at line 311 of file stm32l4xx_hal_uart_ex.c.

__weak void HAL_UARTEx_WakeupCallback ( UART_HandleTypeDef *  huart )

UART wakeup from Stop mode callback.

Parameters:
huart,:UART handle.
Return values:
None

Definition at line 413 of file stm32l4xx_hal_uart_ex.c.

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