My Project
Loading...
Searching...
No Matches
UART Exported Types

Classes

struct  UART_InitTypeDef
 UART Init Structure definition. More...
 
struct  UART_AdvFeatureInitTypeDef
 UART Advanced Features initialization structure definition. More...
 
struct  __UART_HandleTypeDef
 UART handle Structure definition. More...
 

Typedefs

typedef uint32_t HAL_UART_StateTypeDef
 HAL UART State definition.
 
typedef uint32_t HAL_UART_RxTypeTypeDef
 HAL UART Reception type definition.
 
typedef uint32_t HAL_UART_RxEventTypeTypeDef
 HAL UART Rx Event type definition.
 
typedef struct __UART_HandleTypeDef UART_HandleTypeDef
 UART handle Structure definition.
 

Enumerations

enum  UART_ClockSourceTypeDef {
  UART_CLOCKSOURCE_PCLK1 = 0x00U , UART_CLOCKSOURCE_PCLK2 = 0x01U , UART_CLOCKSOURCE_HSI = 0x02U , UART_CLOCKSOURCE_SYSCLK = 0x04U ,
  UART_CLOCKSOURCE_LSE = 0x08U , UART_CLOCKSOURCE_UNDEFINED = 0x10U
}
 UART clock sources definition. More...
 

Detailed Description

Typedef Documentation

◆ HAL_UART_RxEventTypeTypeDef

typedef uint32_t HAL_UART_RxEventTypeTypeDef

HAL UART Rx Event type definition.

Note
HAL UART Rx Event type value aims to identify which type of Event has occurred leading to call of the RxEvent callback. This parameter can be a value of UART RxEvent type values : HAL_UART_RXEVENT_TC = 0x00U, HAL_UART_RXEVENT_HT = 0x01U, HAL_UART_RXEVENT_IDLE = 0x02U,

◆ HAL_UART_RxTypeTypeDef

typedef uint32_t HAL_UART_RxTypeTypeDef

HAL UART Reception type definition.

Note
HAL UART Reception type value aims to identify which type of Reception is ongoing. This parameter can be a value of UART Reception type values : HAL_UART_RECEPTION_STANDARD = 0x00U, HAL_UART_RECEPTION_TOIDLE = 0x01U, HAL_UART_RECEPTION_TORTO = 0x02U, HAL_UART_RECEPTION_TOCHARMATCH = 0x03U,

◆ HAL_UART_StateTypeDef

typedef uint32_t HAL_UART_StateTypeDef

HAL UART State definition.

Note
HAL UART State value is a combination of 2 different substates: gState and RxState (see UART State Code Definition).
  • gState contains UART state information related to global Handle management and also information related to Tx operations. gState value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : (Not Used) 10 : Timeout 11 : Error b5 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral initialized. HAL UART Init function already called) b4-b3 (not used) xx : Should be set to 00 b2 Intrinsic process state 0 : Ready 1 : Busy (Peripheral busy with some configuration or internal operations) b1 (not used) x : Should be set to 0 b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
  • RxState contains information related to Rx operations. RxState value coding follow below described bitmap : b7-b6 (not used) xx : Should be set to 00 b5 Peripheral initialization status 0 : Reset (Peripheral not initialized) 1 : Init done (Peripheral initialized) b4-b2 (not used) xxx : Should be set to 000 b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 (not used) x : Should be set to 0.

◆ UART_HandleTypeDef

UART handle Structure definition.

Enumeration Type Documentation

◆ UART_ClockSourceTypeDef

UART clock sources definition.

Enumerator
UART_CLOCKSOURCE_PCLK1 

PCLK1 clock source

UART_CLOCKSOURCE_PCLK2 

PCLK2 clock source

UART_CLOCKSOURCE_HSI 

HSI clock source

UART_CLOCKSOURCE_SYSCLK 

SYSCLK clock source

UART_CLOCKSOURCE_LSE 

LSE clock source

UART_CLOCKSOURCE_UNDEFINED 

Undefined clock source