STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_ll_usart.h File Reference

Header file of USART LL module. More...

Go to the source code of this file.

Data Structures

struct  LL_USART_InitTypeDef
 LL USART Init Structure definition. More...
 
struct  LL_USART_ClockInitTypeDef
 LL USART Clock Init Structure definition. More...
 

Functions

__STATIC_INLINE void LL_USART_Enable (USART_TypeDef *USARTx)
 USART Enable CR1 UE LL_USART_Enable. More...
 
__STATIC_INLINE void LL_USART_Disable (USART_TypeDef *USARTx)
 USART Disable (all USART prescalers and outputs are disabled) More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabled (USART_TypeDef *USARTx)
 Indicate if USART is enabled CR1 UE LL_USART_IsEnabled. More...
 
__STATIC_INLINE void LL_USART_EnableFIFO (USART_TypeDef *USARTx)
 FIFO Mode Enable. More...
 
__STATIC_INLINE void LL_USART_DisableFIFO (USART_TypeDef *USARTx)
 FIFO Mode Disable. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledFIFO (USART_TypeDef *USARTx)
 Indicate if FIFO Mode is enabled. More...
 
__STATIC_INLINE void LL_USART_SetTXFIFOThreshold (USART_TypeDef *USARTx, uint32_t Threshold)
 Configure TX FIFO Threshold. More...
 
__STATIC_INLINE uint32_t LL_USART_GetTXFIFOThreshold (USART_TypeDef *USARTx)
 Return TX FIFO Threshold Configuration. More...
 
__STATIC_INLINE void LL_USART_SetRXFIFOThreshold (USART_TypeDef *USARTx, uint32_t Threshold)
 Configure RX FIFO Threshold. More...
 
__STATIC_INLINE uint32_t LL_USART_GetRXFIFOThreshold (USART_TypeDef *USARTx)
 Return RX FIFO Threshold Configuration. More...
 
__STATIC_INLINE void LL_USART_ConfigFIFOsThreshold (USART_TypeDef *USARTx, uint32_t TXThreshold, uint32_t RXThreshold)
 Configure TX and RX FIFOs Threshold. More...
 
__STATIC_INLINE void LL_USART_EnableInStopMode (USART_TypeDef *USARTx)
 USART enabled in STOP Mode. More...
 
__STATIC_INLINE void LL_USART_DisableInStopMode (USART_TypeDef *USARTx)
 USART disabled in STOP Mode. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledInStopMode (USART_TypeDef *USARTx)
 Indicate if USART is enabled in STOP Mode (able to wake up MCU from Stop mode or not) More...
 
__STATIC_INLINE void LL_USART_EnableClockInStopMode (USART_TypeDef *USARTx)
 USART Clock enabled in STOP Mode. More...
 
__STATIC_INLINE void LL_USART_DisableClockInStopMode (USART_TypeDef *USARTx)
 USART clock disabled in STOP Mode. More...
 
__STATIC_INLINE uint32_t LL_USART_IsClockEnabledInStopMode (USART_TypeDef *USARTx)
 Indicate if USART clock is enabled in STOP Mode CR3 UCESM LL_USART_IsClockEnabledInStopMode. More...
 
__STATIC_INLINE void LL_USART_EnableDirectionRx (USART_TypeDef *USARTx)
 Receiver Enable (Receiver is enabled and begins searching for a start bit) CR1 RE LL_USART_EnableDirectionRx. More...
 
__STATIC_INLINE void LL_USART_DisableDirectionRx (USART_TypeDef *USARTx)
 Receiver Disable CR1 RE LL_USART_DisableDirectionRx. More...
 
__STATIC_INLINE void LL_USART_EnableDirectionTx (USART_TypeDef *USARTx)
 Transmitter Enable CR1 TE LL_USART_EnableDirectionTx. More...
 
__STATIC_INLINE void LL_USART_DisableDirectionTx (USART_TypeDef *USARTx)
 Transmitter Disable CR1 TE LL_USART_DisableDirectionTx. More...
 
__STATIC_INLINE void LL_USART_SetTransferDirection (USART_TypeDef *USARTx, uint32_t TransferDirection)
 Configure simultaneously enabled/disabled states of Transmitter and Receiver CR1 RE LL_USART_SetTransferDirection
CR1 TE LL_USART_SetTransferDirection. More...
 
__STATIC_INLINE uint32_t LL_USART_GetTransferDirection (USART_TypeDef *USARTx)
 Return enabled/disabled states of Transmitter and Receiver CR1 RE LL_USART_GetTransferDirection
CR1 TE LL_USART_GetTransferDirection. More...
 
__STATIC_INLINE void LL_USART_SetParity (USART_TypeDef *USARTx, uint32_t Parity)
 Configure Parity (enabled/disabled and parity mode if enabled). More...
 
__STATIC_INLINE uint32_t LL_USART_GetParity (USART_TypeDef *USARTx)
 Return Parity configuration (enabled/disabled and parity mode if enabled) CR1 PS LL_USART_GetParity
CR1 PCE LL_USART_GetParity. More...
 
__STATIC_INLINE void LL_USART_SetWakeUpMethod (USART_TypeDef *USARTx, uint32_t Method)
 Set Receiver Wake Up method from Mute mode. CR1 WAKE LL_USART_SetWakeUpMethod. More...
 
__STATIC_INLINE uint32_t LL_USART_GetWakeUpMethod (USART_TypeDef *USARTx)
 Return Receiver Wake Up method from Mute mode CR1 WAKE LL_USART_GetWakeUpMethod. More...
 
__STATIC_INLINE void LL_USART_SetDataWidth (USART_TypeDef *USARTx, uint32_t DataWidth)
 Set Word length (i.e. nb of data bits, excluding start and stop bits) CR1 M0 LL_USART_SetDataWidth
CR1 M1 LL_USART_SetDataWidth. More...
 
__STATIC_INLINE uint32_t LL_USART_GetDataWidth (USART_TypeDef *USARTx)
 Return Word length (i.e. nb of data bits, excluding start and stop bits) CR1 M0 LL_USART_GetDataWidth
CR1 M1 LL_USART_GetDataWidth. More...
 
__STATIC_INLINE void LL_USART_EnableMuteMode (USART_TypeDef *USARTx)
 Allow switch between Mute Mode and Active mode CR1 MME LL_USART_EnableMuteMode. More...
 
__STATIC_INLINE void LL_USART_DisableMuteMode (USART_TypeDef *USARTx)
 Prevent Mute Mode use. Set Receiver in active mode permanently. CR1 MME LL_USART_DisableMuteMode. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledMuteMode (USART_TypeDef *USARTx)
 Indicate if switch between Mute Mode and Active mode is allowed CR1 MME LL_USART_IsEnabledMuteMode. More...
 
__STATIC_INLINE void LL_USART_SetOverSampling (USART_TypeDef *USARTx, uint32_t OverSampling)
 Set Oversampling to 8-bit or 16-bit mode CR1 OVER8 LL_USART_SetOverSampling. More...
 
__STATIC_INLINE uint32_t LL_USART_GetOverSampling (USART_TypeDef *USARTx)
 Return Oversampling mode CR1 OVER8 LL_USART_GetOverSampling. More...
 
__STATIC_INLINE void LL_USART_SetLastClkPulseOutput (USART_TypeDef *USARTx, uint32_t LastBitClockPulse)
 Configure if Clock pulse of the last data bit is output to the SCLK pin or not. More...
 
__STATIC_INLINE uint32_t LL_USART_GetLastClkPulseOutput (USART_TypeDef *USARTx)
 Retrieve Clock pulse of the last data bit output configuration (Last bit Clock pulse output to the SCLK pin or not) More...
 
__STATIC_INLINE void LL_USART_SetClockPhase (USART_TypeDef *USARTx, uint32_t ClockPhase)
 Select the phase of the clock output on the SCLK pin in synchronous mode. More...
 
__STATIC_INLINE uint32_t LL_USART_GetClockPhase (USART_TypeDef *USARTx)
 Return phase of the clock output on the SCLK pin in synchronous mode. More...
 
__STATIC_INLINE void LL_USART_SetClockPolarity (USART_TypeDef *USARTx, uint32_t ClockPolarity)
 Select the polarity of the clock output on the SCLK pin in synchronous mode. More...
 
__STATIC_INLINE uint32_t LL_USART_GetClockPolarity (USART_TypeDef *USARTx)
 Return polarity of the clock output on the SCLK pin in synchronous mode. More...
 
__STATIC_INLINE void LL_USART_ConfigClock (USART_TypeDef *USARTx, uint32_t Phase, uint32_t Polarity, uint32_t LBCPOutput)
 Configure Clock signal format (Phase Polarity and choice about output of last bit clock pulse) More...
 
__STATIC_INLINE void LL_USART_SetPrescaler (USART_TypeDef *USARTx, uint32_t PrescalerValue)
 Configure Clock source prescaler for baudrate generator and oversampling. More...
 
__STATIC_INLINE uint32_t LL_USART_GetPrescaler (USART_TypeDef *USARTx)
 Retrieve the Clock source prescaler for baudrate generator and oversampling. More...
 
__STATIC_INLINE void LL_USART_EnableSCLKOutput (USART_TypeDef *USARTx)
 Enable Clock output on SCLK pin. More...
 
__STATIC_INLINE void LL_USART_DisableSCLKOutput (USART_TypeDef *USARTx)
 Disable Clock output on SCLK pin. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledSCLKOutput (USART_TypeDef *USARTx)
 Indicate if Clock output on SCLK pin is enabled. More...
 
__STATIC_INLINE void LL_USART_SetStopBitsLength (USART_TypeDef *USARTx, uint32_t StopBits)
 Set the length of the stop bits CR2 STOP LL_USART_SetStopBitsLength. More...
 
__STATIC_INLINE uint32_t LL_USART_GetStopBitsLength (USART_TypeDef *USARTx)
 Retrieve the length of the stop bits CR2 STOP LL_USART_GetStopBitsLength. More...
 
__STATIC_INLINE void LL_USART_ConfigCharacter (USART_TypeDef *USARTx, uint32_t DataWidth, uint32_t Parity, uint32_t StopBits)
 Configure Character frame format (Datawidth, Parity control, Stop Bits) More...
 
__STATIC_INLINE void LL_USART_SetTXRXSwap (USART_TypeDef *USARTx, uint32_t SwapConfig)
 Configure TX/RX pins swapping setting. CR2 SWAP LL_USART_SetTXRXSwap. More...
 
__STATIC_INLINE uint32_t LL_USART_GetTXRXSwap (USART_TypeDef *USARTx)
 Retrieve TX/RX pins swapping configuration. CR2 SWAP LL_USART_GetTXRXSwap. More...
 
__STATIC_INLINE void LL_USART_SetRXPinLevel (USART_TypeDef *USARTx, uint32_t PinInvMethod)
 Configure RX pin active level logic CR2 RXINV LL_USART_SetRXPinLevel. More...
 
__STATIC_INLINE uint32_t LL_USART_GetRXPinLevel (USART_TypeDef *USARTx)
 Retrieve RX pin active level logic configuration CR2 RXINV LL_USART_GetRXPinLevel. More...
 
__STATIC_INLINE void LL_USART_SetTXPinLevel (USART_TypeDef *USARTx, uint32_t PinInvMethod)
 Configure TX pin active level logic CR2 TXINV LL_USART_SetTXPinLevel. More...
 
__STATIC_INLINE uint32_t LL_USART_GetTXPinLevel (USART_TypeDef *USARTx)
 Retrieve TX pin active level logic configuration CR2 TXINV LL_USART_GetTXPinLevel. More...
 
__STATIC_INLINE void LL_USART_SetBinaryDataLogic (USART_TypeDef *USARTx, uint32_t DataLogic)
 Configure Binary data logic. More...
 
__STATIC_INLINE uint32_t LL_USART_GetBinaryDataLogic (USART_TypeDef *USARTx)
 Retrieve Binary data configuration CR2 DATAINV LL_USART_GetBinaryDataLogic. More...
 
__STATIC_INLINE void LL_USART_SetTransferBitOrder (USART_TypeDef *USARTx, uint32_t BitOrder)
 Configure transfer bit order (either Less or Most Significant Bit First) More...
 
__STATIC_INLINE uint32_t LL_USART_GetTransferBitOrder (USART_TypeDef *USARTx)
 Return transfer bit order (either Less or Most Significant Bit First) More...
 
__STATIC_INLINE void LL_USART_EnableAutoBaudRate (USART_TypeDef *USARTx)
 Enable Auto Baud-Rate Detection. More...
 
__STATIC_INLINE void LL_USART_DisableAutoBaudRate (USART_TypeDef *USARTx)
 Disable Auto Baud-Rate Detection. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledAutoBaud (USART_TypeDef *USARTx)
 Indicate if Auto Baud-Rate Detection mechanism is enabled. More...
 
__STATIC_INLINE void LL_USART_SetAutoBaudRateMode (USART_TypeDef *USARTx, uint32_t AutoBaudRateMode)
 Set Auto Baud-Rate mode bits. More...
 
__STATIC_INLINE uint32_t LL_USART_GetAutoBaudRateMode (USART_TypeDef *USARTx)
 Return Auto Baud-Rate mode. More...
 
__STATIC_INLINE void LL_USART_EnableRxTimeout (USART_TypeDef *USARTx)
 Enable Receiver Timeout CR2 RTOEN LL_USART_EnableRxTimeout. More...
 
__STATIC_INLINE void LL_USART_DisableRxTimeout (USART_TypeDef *USARTx)
 Disable Receiver Timeout CR2 RTOEN LL_USART_DisableRxTimeout. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledRxTimeout (USART_TypeDef *USARTx)
 Indicate if Receiver Timeout feature is enabled CR2 RTOEN LL_USART_IsEnabledRxTimeout. More...
 
__STATIC_INLINE void LL_USART_ConfigNodeAddress (USART_TypeDef *USARTx, uint32_t AddressLen, uint32_t NodeAddress)
 Set Address of the USART node. More...
 
__STATIC_INLINE uint32_t LL_USART_GetNodeAddress (USART_TypeDef *USARTx)
 Return 8 bit Address of the USART node as set in ADD field of CR2. More...
 
__STATIC_INLINE uint32_t LL_USART_GetNodeAddressLen (USART_TypeDef *USARTx)
 Return Length of Node Address used in Address Detection mode (7-bit or 4-bit) CR2 ADDM7 LL_USART_GetNodeAddressLen. More...
 
__STATIC_INLINE void LL_USART_EnableRTSHWFlowCtrl (USART_TypeDef *USARTx)
 Enable RTS HW Flow Control. More...
 
__STATIC_INLINE void LL_USART_DisableRTSHWFlowCtrl (USART_TypeDef *USARTx)
 Disable RTS HW Flow Control. More...
 
__STATIC_INLINE void LL_USART_EnableCTSHWFlowCtrl (USART_TypeDef *USARTx)
 Enable CTS HW Flow Control. More...
 
__STATIC_INLINE void LL_USART_DisableCTSHWFlowCtrl (USART_TypeDef *USARTx)
 Disable CTS HW Flow Control. More...
 
__STATIC_INLINE void LL_USART_SetHWFlowCtrl (USART_TypeDef *USARTx, uint32_t HardwareFlowControl)
 Configure HW Flow Control mode (both CTS and RTS) More...
 
__STATIC_INLINE uint32_t LL_USART_GetHWFlowCtrl (USART_TypeDef *USARTx)
 Return HW Flow Control configuration (both CTS and RTS) More...
 
__STATIC_INLINE void LL_USART_EnableOneBitSamp (USART_TypeDef *USARTx)
 Enable One bit sampling method CR3 ONEBIT LL_USART_EnableOneBitSamp. More...
 
__STATIC_INLINE void LL_USART_DisableOneBitSamp (USART_TypeDef *USARTx)
 Disable One bit sampling method CR3 ONEBIT LL_USART_DisableOneBitSamp. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledOneBitSamp (USART_TypeDef *USARTx)
 Indicate if One bit sampling method is enabled CR3 ONEBIT LL_USART_IsEnabledOneBitSamp. More...
 
__STATIC_INLINE void LL_USART_EnableOverrunDetect (USART_TypeDef *USARTx)
 Enable Overrun detection CR3 OVRDIS LL_USART_EnableOverrunDetect. More...
 
__STATIC_INLINE void LL_USART_DisableOverrunDetect (USART_TypeDef *USARTx)
 Disable Overrun detection CR3 OVRDIS LL_USART_DisableOverrunDetect. More...
 
__STATIC_INLINE uint32_t LL_USART_IsEnabledOverrunDetect (USART_TypeDef *USARTx)
 Indicate if Overrun detection is enabled CR3 OVRDIS LL_USART_IsEnabledOverrunDetect. More...
 
__STATIC_INLINE void LL_USART_SetWKUPType (USART_TypeDef *USARTx, uint32_t Type)
 Select event type for Wake UP Interrupt Flag (WUS[1:0] bits) More...
 
__STATIC_INLINE uint32_t LL_USART_GetWKUPType (USART_TypeDef *USARTx)
 Return event type for Wake UP Interrupt Flag (WUS[1:0] bits) More...
 
__STATIC_INLINE void LL_USART_SetBaudRate (USART_TypeDef *USARTx, uint32_t PeriphClk, uint32_t PrescalerValue, uint32_t OverSampling, uint32_t BaudRate) __STATIC_INLINE void LL_USART_SetBaudRate(USART_TypeDef *USARTx
 Configure USART BRR register for achieving expected Baud Rate value. More...
 
 if (PrescalerValue > LL_USART_PRESCALER_DIV256)
 
else if (OverSampling==LL_USART_OVERSAMPLING_8) if(OverSampling
 
ErrorStatus LL_USART_Init (USART_TypeDef *USARTx, LL_USART_InitTypeDef *USART_InitStruct)
 Initialize USART registers according to the specified parameters in USART_InitStruct. More...
 
void LL_USART_StructInit (LL_USART_InitTypeDef *USART_InitStruct)
 Set each LL_USART_InitTypeDef field to default value. More...
 
ErrorStatus LL_USART_ClockInit (USART_TypeDef *USARTx, LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
 Initialize USART Clock related settings according to the specified parameters in the USART_ClockInitStruct. More...
 
void LL_USART_ClockStructInit (LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
 Set each field of a LL_USART_ClockInitTypeDef type structure to default value. More...
 

Variables

static const uint32_t USART_PRESCALER_TAB []
 
__STATIC_INLINE void uint32_t PeriphClk
 
__STATIC_INLINE void uint32_t uint32_t OverSampling
 
__STATIC_INLINE void uint32_t uint32_t uint32_t BaudRate
 
register uint32_t brrtemp
 

Detailed Description

Header file of USART LL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_ll_usart.h.