STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
UART Exported Types
Collaboration diagram for UART Exported Types:

Data Structures

struct  UART_InitTypeDef
 UART Init Structure definition. More...
 
struct  __UART_HandleTypeDef
 UART handle Structure definition. More...
 

Typedefs

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  HAL_UART_StateTypeDef {
  HAL_UART_STATE_RESET = 0x00U , HAL_UART_STATE_READY = 0x20U , HAL_UART_STATE_BUSY = 0x24U , HAL_UART_STATE_BUSY_TX = 0x21U ,
  HAL_UART_STATE_BUSY_RX = 0x22U , HAL_UART_STATE_BUSY_TX_RX = 0x23U , HAL_UART_STATE_TIMEOUT = 0xA0U , HAL_UART_STATE_ERROR = 0xE0U
}
 HAL UART State structures definition. More...
 

Detailed Description

Typedef Documentation

◆ HAL_UART_RxTypeTypeDef

typedef uint32_t HAL_UART_RxTypeTypeDef

#include <stm32f4xx_hal_uart.h>

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,

Definition at line 144 of file stm32f4xx_hal_uart.h.

◆ HAL_UART_RxEventTypeTypeDef

typedef uint32_t HAL_UART_RxEventTypeTypeDef

#include <stm32f4xx_hal_uart.h>

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,

Definition at line 155 of file stm32f4xx_hal_uart.h.

◆ UART_HandleTypeDef

#include <stm32f4xx_hal_uart.h>

UART handle Structure definition.

Enumeration Type Documentation

◆ HAL_UART_StateTypeDef

#include <stm32f4xx_hal_uart.h>

HAL UART State structures definition.

Note
HAL UART State value is a combination of 2 different substates: gState and RxState.
  • 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.
Enumerator
HAL_UART_STATE_RESET 

Peripheral is not yet Initialized Value is allowed for gState and RxState

HAL_UART_STATE_READY 

Peripheral Initialized and ready for use Value is allowed for gState and RxState

HAL_UART_STATE_BUSY 

an internal process is ongoing Value is allowed for gState only

HAL_UART_STATE_BUSY_TX 

Data Transmission process is ongoing Value is allowed for gState only

HAL_UART_STATE_BUSY_RX 

Data Reception process is ongoing Value is allowed for RxState only

HAL_UART_STATE_BUSY_TX_RX 

Data Transmission and Reception process is ongoing Not to be used for neither gState nor RxState. Value is result of combination (Or) between gState and RxState values

HAL_UART_STATE_TIMEOUT 

Timeout state Value is allowed for gState only

HAL_UART_STATE_ERROR 

Error Value is allowed for gState only

Definition at line 116 of file stm32f4xx_hal_uart.h.