Configuration functions
[LPUART Exported Functions]

Configure Character frame format (Datawidth, Parity control, Stop Bits)

Note:

Call of this function is equivalent to following function call sequence :

• Data Width configuration using LL_LPUART_SetDataWidth() function
• Parity Control and mode configuration using LL_LPUART_SetParity() function
• Stop bits configuration using LL_LPUART_SetStopBitsLength() function CR1 PS LL_LPUART_ConfigCharacter
  CR1 PCE LL_LPUART_ConfigCharacter
  CR1 M LL_LPUART_ConfigCharacter
  CR2 STOP LL_LPUART_ConfigCharacter

Parameters:

LPUARTx	LPUART Instance
DataWidth	This parameter can be one of the following values: LL_LPUART_DATAWIDTH_7B LL_LPUART_DATAWIDTH_8B LL_LPUART_DATAWIDTH_9B
Parity	This parameter can be one of the following values: LL_LPUART_PARITY_NONE LL_LPUART_PARITY_EVEN LL_LPUART_PARITY_ODD
StopBits	This parameter can be one of the following values: LL_LPUART_STOPBITS_1 LL_LPUART_STOPBITS_2

Return values:

None

Definition at line 737 of file stm32l4xx_ll_lpuart.h.

Set Address of the LPUART node.

Note:

This is used in multiprocessor communication during Mute mode or Stop mode, for wake up with address mark detection.

4bits address node is used when 4-bit Address Detection is selected in ADDM7. (b7-b4 should be set to 0) 8bits address node is used when 7-bit Address Detection is selected in ADDM7. (This is used in multiprocessor communication during Mute mode or Stop mode, for wake up with 7-bit address mark detection. The MSB of the character sent by the transmitter should be equal to 1. It may also be used for character detection during normal reception, Mute mode inactive (for example, end of block detection in ModBus protocol). In this case, the whole received character (8-bit) is compared to the ADD[7:0] value and CMF flag is set on match) CR2 ADD LL_LPUART_ConfigNodeAddress
CR2 ADDM7 LL_LPUART_ConfigNodeAddress

Parameters:

LPUARTx	LPUART Instance
AddressLen	This parameter can be one of the following values: LL_LPUART_ADDRESS_DETECT_4B LL_LPUART_ADDRESS_DETECT_7B
NodeAddress	4 or 7 bit Address of the LPUART node.

Return values:

None

Definition at line 909 of file stm32l4xx_ll_lpuart.h.

LPUART Disable.

Note:

When LPUART is disabled, LPUART prescalers and outputs are stopped immediately, and current operations are discarded. The configuration of the LPUART is kept, but all the status flags, in the LPUARTx_ISR are set to their default values.

In order to go into low-power mode without generating errors on the line, the TE bit must be reset before and the software must wait for the TC bit in the LPUART_ISR to be set before resetting the UE bit. The DMA requests are also reset when UE = 0 so the DMA channel must be disabled before resetting the UE bit. CR1 UE LL_LPUART_Disable

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 432 of file stm32l4xx_ll_lpuart.h.

Disable CTS HW Flow Control CR3 CTSE LL_LPUART_DisableCTSHWFlowCtrl.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 982 of file stm32l4xx_ll_lpuart.h.

Receiver Disable CR1 RE LL_LPUART_DisableDirectionRx.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 502 of file stm32l4xx_ll_lpuart.h.

Transmitter Disable CR1 TE LL_LPUART_DisableDirectionTx.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 524 of file stm32l4xx_ll_lpuart.h.

LPUART disabled in STOP Mode.

Note:

When this function is disabled, LPUART is not able to wake up the MCU from Stop mode CR1 UESM LL_LPUART_DisableInStopMode

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 468 of file stm32l4xx_ll_lpuart.h.

Prevent Mute Mode use.

Set Receiver in active mode permanently. CR1 MME LL_LPUART_DisableMuteMode

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 670 of file stm32l4xx_ll_lpuart.h.

Disable Overrun detection CR3 OVRDIS LL_LPUART_DisableOverrunDetect.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 1037 of file stm32l4xx_ll_lpuart.h.

Disable RTS HW Flow Control CR3 RTSE LL_LPUART_DisableRTSHWFlowCtrl.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 960 of file stm32l4xx_ll_lpuart.h.

LPUART Enable CR1 UE LL_LPUART_Enable.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 413 of file stm32l4xx_ll_lpuart.h.

Enable CTS HW Flow Control CR3 CTSE LL_LPUART_EnableCTSHWFlowCtrl.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 971 of file stm32l4xx_ll_lpuart.h.

Receiver Enable (Receiver is enabled and begins searching for a start bit) CR1 RE LL_LPUART_EnableDirectionRx.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 491 of file stm32l4xx_ll_lpuart.h.

Transmitter Enable CR1 TE LL_LPUART_EnableDirectionTx.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 513 of file stm32l4xx_ll_lpuart.h.

LPUART enabled in STOP Mode.

Note:

When this function is enabled, LPUART is able to wake up the MCU from Stop mode, provided that LPUART clock selection is HSI or LSE in RCC. CR1 UESM LL_LPUART_EnableInStopMode

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 456 of file stm32l4xx_ll_lpuart.h.

Allow switch between Mute Mode and Active mode CR1 MME LL_LPUART_EnableMuteMode.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 659 of file stm32l4xx_ll_lpuart.h.

Enable Overrun detection CR3 OVRDIS LL_LPUART_EnableOverrunDetect.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 1026 of file stm32l4xx_ll_lpuart.h.

Enable RTS HW Flow Control CR3 RTSE LL_LPUART_EnableRTSHWFlowCtrl.

Parameters:

LPUARTx

LPUART Instance

Return values:

None

Definition at line 949 of file stm32l4xx_ll_lpuart.h.

Return current Baud Rate value, according to LPUARTDIV present in BRR register (full BRR content), and to used Peripheral Clock values.

Note:

In case of non-initialized or invalid value stored in BRR register, value 0 will be returned. BRR BRR LL_LPUART_GetBaudRate

Parameters:

LPUARTx	LPUART Instance
PeriphClk	Peripheral Clock

Return values:

Baud

Rate

Definition at line 1112 of file stm32l4xx_ll_lpuart.h.

Retrieve Binary data configuration CR2 DATAINV LL_LPUART_GetBinaryDataLogic.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_BINARY_LOGIC_POSITIVE LL_LPUART_BINARY_LOGIC_NEGATIVE

Definition at line 850 of file stm32l4xx_ll_lpuart.h.

Return Word length (i.e.

nb of data bits, excluding start and stop bits) CR1 M LL_LPUART_GetDataWidth

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_DATAWIDTH_7B LL_LPUART_DATAWIDTH_8B LL_LPUART_DATAWIDTH_9B

Definition at line 648 of file stm32l4xx_ll_lpuart.h.

Return HW Flow Control configuration (both CTS and RTS) CR3 RTSE LL_LPUART_GetHWFlowCtrl
CR3 CTSE LL_LPUART_GetHWFlowCtrl.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_HWCONTROL_NONE LL_LPUART_HWCONTROL_RTS LL_LPUART_HWCONTROL_CTS LL_LPUART_HWCONTROL_RTS_CTS

Definition at line 1015 of file stm32l4xx_ll_lpuart.h.

Return 8 bit Address of the LPUART node as set in ADD field of CR2.

Note:

If 4-bit Address Detection is selected in ADDM7, only 4bits (b3-b0) of returned value are relevant (b31-b4 are not relevant) If 7-bit Address Detection is selected in ADDM7, only 8bits (b7-b0) of returned value are relevant (b31-b8 are not relevant) CR2 ADD LL_LPUART_GetNodeAddress

Parameters:

LPUARTx

LPUART Instance

Return values:

Address

of the LPUART node (Value between Min_Data=0 and Max_Data=255)

Definition at line 925 of file stm32l4xx_ll_lpuart.h.

Return Length of Node Address used in Address Detection mode (7-bit or 4-bit) CR2 ADDM7 LL_LPUART_GetNodeAddressLen.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_ADDRESS_DETECT_4B LL_LPUART_ADDRESS_DETECT_7B

Definition at line 938 of file stm32l4xx_ll_lpuart.h.

Return Parity configuration (enabled/disabled and parity mode if enabled) CR1 PS LL_LPUART_GetParity
CR1 PCE LL_LPUART_GetParity.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_PARITY_NONE LL_LPUART_PARITY_EVEN LL_LPUART_PARITY_ODD

Definition at line 592 of file stm32l4xx_ll_lpuart.h.

Retrieve RX pin active level logic configuration CR2 RXINV LL_LPUART_GetRXPinLevel.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_RXPIN_LEVEL_STANDARD LL_LPUART_RXPIN_LEVEL_INVERTED

Definition at line 793 of file stm32l4xx_ll_lpuart.h.

Retrieve the length of the stop bits CR2 STOP LL_LPUART_GetStopBitsLength.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_STOPBITS_1 LL_LPUART_STOPBITS_2

Definition at line 708 of file stm32l4xx_ll_lpuart.h.

Return transfer bit order (either Less or Most Significant Bit First)

Note:

MSB First means data is transmitted/received with the MSB first, following the start bit. LSB First means data is transmitted/received with data bit 0 first, following the start bit. CR2 MSBFIRST LL_LPUART_GetTransferBitOrder

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_BITORDER_LSBFIRST LL_LPUART_BITORDER_MSBFIRST

Definition at line 881 of file stm32l4xx_ll_lpuart.h.

Return enabled/disabled states of Transmitter and Receiver CR1 RE LL_LPUART_GetTransferDirection
CR1 TE LL_LPUART_GetTransferDirection.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_DIRECTION_NONE LL_LPUART_DIRECTION_RX LL_LPUART_DIRECTION_TX LL_LPUART_DIRECTION_TX_RX

Definition at line 558 of file stm32l4xx_ll_lpuart.h.

Retrieve TX pin active level logic configuration CR2 TXINV LL_LPUART_GetTXPinLevel.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_TXPIN_LEVEL_STANDARD LL_LPUART_TXPIN_LEVEL_INVERTED

Definition at line 820 of file stm32l4xx_ll_lpuart.h.

Retrieve TX/RX pins swapping configuration.

CR2 SWAP LL_LPUART_GetTXRXSwap

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_TXRX_STANDARD LL_LPUART_TXRX_SWAPPED

Definition at line 766 of file stm32l4xx_ll_lpuart.h.

Return Receiver Wake Up method from Mute mode CR1 WAKE LL_LPUART_GetWakeUpMethod.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_WAKEUP_IDLELINE LL_LPUART_WAKEUP_ADDRESSMARK

Definition at line 619 of file stm32l4xx_ll_lpuart.h.

Return event type for Wake UP Interrupt Flag (WUS[1:0] bits) CR3 WUS LL_LPUART_GetWKUPType.

Parameters:

LPUARTx

LPUART Instance

Return values:

Returned

value can be one of the following values: LL_LPUART_WAKEUP_ON_ADDRESS LL_LPUART_WAKEUP_ON_STARTBIT LL_LPUART_WAKEUP_ON_RXNE

Definition at line 1077 of file stm32l4xx_ll_lpuart.h.

Indicate if LPUART is enabled CR1 UE LL_LPUART_IsEnabled.

Parameters:

LPUARTx

LPUART Instance

Return values:

State

of bit (1 or 0).

Definition at line 443 of file stm32l4xx_ll_lpuart.h.

Indicate if LPUART is enabled in STOP Mode (able to wake up MCU from Stop mode or not) CR1 UESM LL_LPUART_IsEnabledInStopMode.

Parameters:

LPUARTx

LPUART Instance

Return values:

State

of bit (1 or 0).

Definition at line 480 of file stm32l4xx_ll_lpuart.h.

Indicate if switch between Mute Mode and Active mode is allowed CR1 MME LL_LPUART_IsEnabledMuteMode.

Parameters:

LPUARTx

LPUART Instance

Return values:

State

of bit (1 or 0).

Definition at line 681 of file stm32l4xx_ll_lpuart.h.

Indicate if Overrun detection is enabled CR3 OVRDIS LL_LPUART_IsEnabledOverrunDetect.

Parameters:

LPUARTx

LPUART Instance

Return values:

State

of bit (1 or 0).

Definition at line 1048 of file stm32l4xx_ll_lpuart.h.

Configure LPUART BRR register for achieving expected Baud Rate value.

Note:

Compute and set LPUARTDIV value in BRR Register (full BRR content) according to used Peripheral Clock and expected Baud Rate values

Peripheral clock and Baud Rate values provided as function parameters should be valid (Baud rate value != 0).

Provided that LPUARTx_BRR must be > = 0x300 and LPUART_BRR is 20-bit, a care should be taken when generating high baud rates using high PeriphClk values. PeriphClk must be in the range [3 x BaudRate, 4096 x BaudRate]. BRR BRR LL_LPUART_SetBaudRate

Parameters:

LPUARTx	LPUART Instance
PeriphClk	Peripheral Clock
BaudRate	Baud Rate

Return values:

None

Definition at line 1098 of file stm32l4xx_ll_lpuart.h.

Configure Binary data logic.

Note:

Allow to define how Logical data from the data register are send/received : either in positive/direct logic (1=H, 0=L) or in negative/inverse logic (1=L, 0=H) CR2 DATAINV LL_LPUART_SetBinaryDataLogic

Parameters:

LPUARTx	LPUART Instance
DataLogic	This parameter can be one of the following values: LL_LPUART_BINARY_LOGIC_POSITIVE LL_LPUART_BINARY_LOGIC_NEGATIVE

Return values:

None

Definition at line 837 of file stm32l4xx_ll_lpuart.h.

Set Word length (nb of data bits, excluding start and stop bits) CR1 M LL_LPUART_SetDataWidth.

Parameters:

LPUARTx	LPUART Instance
DataWidth	This parameter can be one of the following values: LL_LPUART_DATAWIDTH_7B LL_LPUART_DATAWIDTH_8B LL_LPUART_DATAWIDTH_9B

Return values:

None

Definition at line 634 of file stm32l4xx_ll_lpuart.h.

Configure HW Flow Control mode (both CTS and RTS) CR3 RTSE LL_LPUART_SetHWFlowCtrl
CR3 CTSE LL_LPUART_SetHWFlowCtrl.

Parameters:

LPUARTx	LPUART Instance
HardwareFlowControl	This parameter can be one of the following values: LL_LPUART_HWCONTROL_NONE LL_LPUART_HWCONTROL_RTS LL_LPUART_HWCONTROL_CTS LL_LPUART_HWCONTROL_RTS_CTS

Return values:

None

Definition at line 999 of file stm32l4xx_ll_lpuart.h.

Configure Parity (enabled/disabled and parity mode if enabled)

Note:

This function selects if hardware parity control (generation and detection) is enabled or disabled. When the parity control is enabled (Odd or Even), computed parity bit is inserted at the MSB position (depending on data width) and parity is checked on the received data. CR1 PS LL_LPUART_SetParity
CR1 PCE LL_LPUART_SetParity

Parameters:

LPUARTx	LPUART Instance
Parity	This parameter can be one of the following values: LL_LPUART_PARITY_NONE LL_LPUART_PARITY_EVEN LL_LPUART_PARITY_ODD

Return values:

None

Definition at line 577 of file stm32l4xx_ll_lpuart.h.

Configure RX pin active level logic CR2 RXINV LL_LPUART_SetRXPinLevel.

Parameters:

LPUARTx	LPUART Instance
PinInvMethod	This parameter can be one of the following values: LL_LPUART_RXPIN_LEVEL_STANDARD LL_LPUART_RXPIN_LEVEL_INVERTED

Return values:

None

Definition at line 780 of file stm32l4xx_ll_lpuart.h.

Set the length of the stop bits CR2 STOP LL_LPUART_SetStopBitsLength.

Parameters:

LPUARTx	LPUART Instance
StopBits	This parameter can be one of the following values: LL_LPUART_STOPBITS_1 LL_LPUART_STOPBITS_2

Return values:

None

Definition at line 695 of file stm32l4xx_ll_lpuart.h.

Configure transfer bit order (either Less or Most Significant Bit First)

Note:

MSB First means data is transmitted/received with the MSB first, following the start bit. LSB First means data is transmitted/received with data bit 0 first, following the start bit. CR2 MSBFIRST LL_LPUART_SetTransferBitOrder

Parameters:

LPUARTx	LPUART Instance
BitOrder	This parameter can be one of the following values: LL_LPUART_BITORDER_LSBFIRST LL_LPUART_BITORDER_MSBFIRST

Return values:

None

Definition at line 866 of file stm32l4xx_ll_lpuart.h.

Configure simultaneously enabled/disabled states of Transmitter and Receiver CR1 RE LL_LPUART_SetTransferDirection
CR1 TE LL_LPUART_SetTransferDirection.

Parameters:

LPUARTx	LPUART Instance
TransferDirection	This parameter can be one of the following values: LL_LPUART_DIRECTION_NONE LL_LPUART_DIRECTION_RX LL_LPUART_DIRECTION_TX LL_LPUART_DIRECTION_TX_RX

Return values:

None

Definition at line 542 of file stm32l4xx_ll_lpuart.h.

Configure TX pin active level logic CR2 TXINV LL_LPUART_SetTXPinLevel.

Parameters:

LPUARTx	LPUART Instance
PinInvMethod	This parameter can be one of the following values: LL_LPUART_TXPIN_LEVEL_STANDARD LL_LPUART_TXPIN_LEVEL_INVERTED

Return values:

None

Definition at line 807 of file stm32l4xx_ll_lpuart.h.

Configure TX/RX pins swapping setting.

CR2 SWAP LL_LPUART_SetTXRXSwap

Parameters:

LPUARTx	LPUART Instance
SwapConfig	This parameter can be one of the following values: LL_LPUART_TXRX_STANDARD LL_LPUART_TXRX_SWAPPED

Return values:

None

Definition at line 753 of file stm32l4xx_ll_lpuart.h.

Set Receiver Wake Up method from Mute mode.

CR1 WAKE LL_LPUART_SetWakeUpMethod

Parameters:

LPUARTx	LPUART Instance
Method	This parameter can be one of the following values: LL_LPUART_WAKEUP_IDLELINE LL_LPUART_WAKEUP_ADDRESSMARK

Return values:

None

Definition at line 606 of file stm32l4xx_ll_lpuart.h.

Select event type for Wake UP Interrupt Flag (WUS[1:0] bits) CR3 WUS LL_LPUART_SetWKUPType.

Parameters:

LPUARTx	LPUART Instance
Type	This parameter can be one of the following values: LL_LPUART_WAKEUP_ON_ADDRESS LL_LPUART_WAKEUP_ON_STARTBIT LL_LPUART_WAKEUP_ON_RXNE

Return values:

None

Definition at line 1063 of file stm32l4xx_ll_lpuart.h.