STM8S/A Standard Peripherals Firmware Library: UART4_Exported_Types

STM8S/A

STM8S/A Standard Peripherals Firmware Library
UART4_Exported_Types

Enumerations

enum  UART4_Flag_TypeDef {
  UART4_FLAG_TXE = (uint16_t)0x0080, UART4_FLAG_TC = (uint16_t)0x0040, UART4_FLAG_RXNE = (uint16_t)0x0020, UART4_FLAG_IDLE = (uint16_t)0x0010,
  UART4_FLAG_OR_LHE = (uint16_t)0x0008, UART4_FLAG_NF = (uint16_t)0x0004, UART4_FLAG_FE = (uint16_t)0x0002, UART4_FLAG_PE = (uint16_t)0x0001,
  UART4_FLAG_SBK = (uint16_t)0x0101, UART4_FLAG_LBDF = (uint16_t)0x0210, UART4_FLAG_LHDF = (uint16_t)0x0302, UART4_FLAG_LSF = (uint16_t)0x0301
}
 UART4 Flag possible values. More...
enum  UART4_IrDAMode_TypeDef { UART4_IRDAMODE_NORMAL = (uint8_t)0x00, UART4_IRDAMODE_LOWPOWER = (uint8_t)0x01 }
 UART4 Irda Modes. More...
enum  UART4_IT_TypeDef {
  UART4_IT_TXE = (uint16_t)0x0277, UART4_IT_TC = (uint16_t)0x0266, UART4_IT_RXNE = (uint16_t)0x0255, UART4_IT_IDLE = (uint16_t)0x0244,
  UART4_IT_OR = (uint16_t)0x0235, UART4_IT_PE = (uint16_t)0x0100, UART4_IT_LBDF = (uint16_t)0x0346, UART4_IT_LHDF = (uint16_t)0x0412,
  UART4_IT_RXNE_OR = (uint16_t)0x0205
}
 UART4 Interrupt definition UART4_IT possible values Elements values convention: 0xZYX X: Position of the corresponding Interrupt. More...
enum  UART4_LinAutosync_TypeDef { UART4_LIN_AUTOSYNC_DISABLE = (uint8_t)0x00, UART4_LIN_AUTOSYNC_ENABLE = (uint8_t)0x01 }
 UART4 automatic resynchronisation possible values. More...
enum  UART4_LINBreakDetectionLength_TypeDef { UART4_LINBREAKDETECTIONLENGTH_10BITS = (uint8_t)0x00, UART4_LINBREAKDETECTIONLENGTH_11BITS = (uint8_t)0x01 }
 UART4 LIN Break detection length possible values. More...
enum  UART4_LinDivUp_TypeDef { UART4_LIN_DIVUP_LBRR1 = (uint8_t)0x00, UART4_LIN_DIVUP_NEXTRXNE = (uint8_t)0x01 }
 UART4 Divider Update Method possible values. More...
enum  UART4_LinMode_TypeDef { UART4_LIN_MODE_MASTER = (uint8_t)0x00, UART4_LIN_MODE_SLAVE = (uint8_t)0x01 }
 UART4 Mode possible values. More...
enum  UART4_Mode_TypeDef {
  UART4_MODE_RX_ENABLE = (uint8_t)0x08, UART4_MODE_TX_ENABLE = (uint8_t)0x04, UART4_MODE_TX_DISABLE = (uint8_t)0x80, UART4_MODE_RX_DISABLE = (uint8_t)0x40,
  UART4_MODE_TXRX_ENABLE = (uint8_t)0x0C
}
 UART4 Mode possible values. More...
enum  UART4_Parity_TypeDef { UART4_PARITY_NO = (uint8_t)0x00, UART4_PARITY_EVEN = (uint8_t)0x04, UART4_PARITY_ODD = (uint8_t)0x06 }
 UART4 parity possible values. More...
enum  UART4_StopBits_TypeDef { UART4_STOPBITS_1 = (uint8_t)0x00, UART4_STOPBITS_0_5 = (uint8_t)0x10, UART4_STOPBITS_2 = (uint8_t)0x20, UART4_STOPBITS_1_5 = (uint8_t)0x30 }
 UART4 stop bits possible values. More...
enum  UART4_SyncMode_TypeDef {
  UART4_SYNCMODE_CLOCK_DISABLE = (uint8_t)0x80, UART4_SYNCMODE_CLOCK_ENABLE = (uint8_t)0x08, UART4_SYNCMODE_CPOL_LOW = (uint8_t)0x40, UART4_SYNCMODE_CPOL_HIGH = (uint8_t)0x04,
  UART4_SYNCMODE_CPHA_MIDDLE = (uint8_t)0x20, UART4_SYNCMODE_CPHA_BEGINING = (uint8_t)0x02, UART4_SYNCMODE_LASTBIT_DISABLE = (uint8_t)0x10, UART4_SYNCMODE_LASTBIT_ENABLE = (uint8_t)0x01
}
 UART4 Synchrone modes. More...
enum  UART4_WakeUp_TypeDef { UART4_WAKEUP_IDLELINE = (uint8_t)0x00, UART4_WAKEUP_ADDRESSMARK = (uint8_t)0x08 }
 UART4 WakeUP Modes. More...
enum  UART4_WordLength_TypeDef { UART4_WORDLENGTH_8D = (uint8_t)0x00, UART4_WORDLENGTH_9D = (uint8_t)0x10 }
 UART4 Word length possible values. More...

Enumeration Type Documentation

UART4 Flag possible values.

Enumerator:
UART4_FLAG_TXE 

Transmit Data Register Empty flag

UART4_FLAG_TC 

Transmission Complete flag

UART4_FLAG_RXNE 

Read Data Register Not Empty flag

UART4_FLAG_IDLE 

Idle line detected flag

UART4_FLAG_OR_LHE 

OverRun error flag

UART4_FLAG_NF 

Noise error flag

UART4_FLAG_FE 

Framing Error flag

UART4_FLAG_PE 

Parity Error flag

UART4_FLAG_SBK 

Send Break Complete interrupt flag.

UART4_FLAG_LBDF 

LIN Break Detection Flag.

UART4_FLAG_LHDF 

LIN Header Detection Flag.

UART4_FLAG_LSF 

LIN Sync Field Flag.

Definition at line 139 of file stm8s_uart4.h.

UART4 Irda Modes.

Enumerator:
UART4_IRDAMODE_NORMAL 

0x00 Irda Normal Mode

UART4_IRDAMODE_LOWPOWER 

0x01 Irda Low Power Mode

Definition at line 49 of file stm8s_uart4.h.

UART4 Interrupt definition UART4_IT possible values Elements values convention: 0xZYX X: Position of the corresponding Interrupt.

  • For the following values, X means the interrupt position in the CR2 register. UART4_IT_TXE UART4_IT_TC UART4_IT_RXNE UART4_IT_IDLE UART4_IT_OR
  • For the UART4_IT_PE value, X means the flag position in the CR1 register.
  • For the UART4_IT_LBDF value, X means the flag position in the CR4 register.
  • For the UART4_IT_LHDF value, X means the flag position in the CR6 register. Y: Flag position

For the following values, Y means the flag (pending bit) position in the SR register. UART4_IT_TXE UART4_IT_TC UART4_IT_RXNE UART4_IT_IDLE UART4_IT_OR UART4_IT_PE

  • For the UART4_IT_LBDF value, Y means the flag position in the CR4 register.
  • For the UART4_IT_LHDF value, Y means the flag position in the CR6 register. Z: Register index: indicate in which register the dedicated interrupt source is:
  • 1==> CR1 register
  • 2==> CR2 register
  • 3==> CR4 register
  • 4==> CR6 register
Enumerator:
UART4_IT_TXE 

Transmit interrupt.

UART4_IT_TC 

Transmission Complete interrupt.

UART4_IT_RXNE 

Data Register Not Empty interrupt.

UART4_IT_IDLE 

Idle line detected interrupt.

UART4_IT_OR 

OverRun error interrupt.

UART4_IT_PE 

Parity Error interrupt.

UART4_IT_LBDF 

LIN Break Detection interrupt.

UART4_IT_LHDF 

LIN Header Detection interrupt.

UART4_IT_RXNE_OR 

Receive/Overrun interrupt

Definition at line 185 of file stm8s_uart4.h.

UART4 automatic resynchronisation possible values.

Enumerator:
UART4_LIN_AUTOSYNC_DISABLE 

LIN Autosynchronization Disable.

UART4_LIN_AUTOSYNC_ENABLE 

LIN Autosynchronization Enable.

Definition at line 97 of file stm8s_uart4.h.

UART4 LIN Break detection length possible values.

Enumerator:
UART4_LINBREAKDETECTIONLENGTH_10BITS 

0x01 10 bits Lin Break detection

UART4_LINBREAKDETECTIONLENGTH_11BITS 

0x02 11 bits Lin Break detection

Definition at line 66 of file stm8s_uart4.h.

UART4 Divider Update Method possible values.

Enumerator:
UART4_LIN_DIVUP_LBRR1 

LIN LDIV is updated as soon as LBRR1 is written.

UART4_LIN_DIVUP_NEXTRXNE 

LIN LDIV is updated at the next received character.

Definition at line 103 of file stm8s_uart4.h.

UART4 Mode possible values.

Enumerator:
UART4_LIN_MODE_MASTER 

LIN Master Mode.

UART4_LIN_MODE_SLAVE 

LIN Slave Mode.

Definition at line 91 of file stm8s_uart4.h.

UART4 Mode possible values.

Enumerator:
UART4_MODE_RX_ENABLE 

0x08 Receive Enable

UART4_MODE_TX_ENABLE 

0x04 Transmit Enable

UART4_MODE_TX_DISABLE 

0x80 Transmit Disable

UART4_MODE_RX_DISABLE 

0x40 Single-wire Half-duplex mode

UART4_MODE_TXRX_ENABLE 

0x0C Transmit Enable and Receive Enable

Definition at line 130 of file stm8s_uart4.h.

UART4 parity possible values.

Enumerator:
UART4_PARITY_NO 

No Parity.

UART4_PARITY_EVEN 

Even Parity.

UART4_PARITY_ODD 

Odd Parity.

Definition at line 84 of file stm8s_uart4.h.

UART4 stop bits possible values.

Enumerator:
UART4_STOPBITS_1 

One stop bit is transmitted at the end of frame.

UART4_STOPBITS_0_5 

Half stop bits is transmitted at the end of frame.

UART4_STOPBITS_2 

Two stop bits are transmitted at the end of frame.

UART4_STOPBITS_1_5 

One and half stop bits.

Definition at line 74 of file stm8s_uart4.h.

UART4 Synchrone modes.

Enumerator:
UART4_SYNCMODE_CLOCK_DISABLE 

0x80 Sync mode Disable, SLK pin Disable

UART4_SYNCMODE_CLOCK_ENABLE 

0x08 Sync mode Enable, SLK pin Enable

UART4_SYNCMODE_CPOL_LOW 

0x40 Steady low value on SCLK pin outside transmission window

UART4_SYNCMODE_CPOL_HIGH 

0x04 Steady high value on SCLK pin outside transmission window

UART4_SYNCMODE_CPHA_MIDDLE 

0x20 SCLK clock line activated in middle of data bit

UART4_SYNCMODE_CPHA_BEGINING 

0x02 SCLK clock line activated at beginning of data bit

UART4_SYNCMODE_LASTBIT_DISABLE 

0x10 The clock pulse of the last data bit is not output to the SCLK pin

UART4_SYNCMODE_LASTBIT_ENABLE 

0x01 The clock pulse of the last data bit is output to the SCLK pin

Definition at line 110 of file stm8s_uart4.h.

UART4 WakeUP Modes.

Enumerator:
UART4_WAKEUP_IDLELINE 

0x01 Idle Line wake up

UART4_WAKEUP_ADDRESSMARK 

0x02 Address Mark wake up

Definition at line 58 of file stm8s_uart4.h.

UART4 Word length possible values.

Enumerator:
UART4_WORDLENGTH_8D 

0x00 8 bits Data

UART4_WORDLENGTH_9D 

0x10 9 bits Data

Definition at line 123 of file stm8s_uart4.h.

STM8 Standard Peripherals Library: Footer

 

 

 

      For complete documentation on STM8 8-bit Microcontrollers platform visit www.st.com