Types
Peripherals > UART

Hardware UART data types. More...

Data Structures

struct  zos_uart_config_t
 UART configuration. More...
 
struct  zos_uart_mode_config_t
 UART data reception mode configuration. More...
 
struct  zos_uart_buffer_t
 UART buffer info. More...
 

Typedefs

typedef uint8_t zos_uart_data_width_t
 UART data width.
 
typedef uint8_t zos_uart_stop_bits_t
 UART stop bits.
 
typedef uint8_t zos_uart_flow_control_t
 UART hardware flow control.
 
typedef uint8_t zos_uart_parity_t
 UART data parity.
 
typedef uint8_t zos_uart_mode_t
 UART data reception mode.
 
typedef void(* zos_uart_callback_t) (uint32_t c)
 UART callback. More...
 

Enumerations

enum  {
  UART_WIDTH_5BIT = 0,
  UART_WIDTH_6BIT = 1,
  UART_WIDTH_7BIT = 2,
  UART_WIDTH_8BIT = 3,
  UART_WIDTH_9BIT = 4
}
 
enum  {
  UART_STOP_BITS_1 = 0,
  UART_STOP_BITS_2 = 1
}
 
enum  {
  UART_FLOW_DISABLED = 0,
  UART_FLOW_CTS_RTS = 3
}
 
enum  {
  UART_NO_PARITY = 0,
  UART_ODD_PARITY = 1,
  UART_EVEN_PARITY = 2
}
 
enum  {
  UART_MODE_IRQ = 0,
  UART_MODE_RING_BUFFER = 1,
  UART_MODE_ZERO_COPY = 2
}
 

Detailed Description

Hardware UART data types.

Typedef Documentation

typedef void(* zos_uart_callback_t) (uint32_t c)

UART callback.

This callback is used by zn_uart_set_tx_processor() and zn_uart_register_rx_callback()

Enumeration Type Documentation

anonymous enum
Enumerator
UART_WIDTH_5BIT 

5bits per character transmission

UART_WIDTH_6BIT 

6bits per character transmission

UART_WIDTH_7BIT 

7bits per character transmission

UART_WIDTH_8BIT 

8bits per character transmission

UART_WIDTH_9BIT 

9bits per character transmission

anonymous enum
Enumerator
UART_STOP_BITS_1 

1bit signifies end of character

UART_STOP_BITS_2 

2bits signify end of character (use this for high data rates)

anonymous enum
Enumerator
UART_FLOW_DISABLED 

No hardware flow control used.

UART_FLOW_CTS_RTS 

CTS & RTS signals used.

anonymous enum
Enumerator
UART_NO_PARITY 

No data parity used.

UART_ODD_PARITY 

Odd parity (i.e. number of bits in character is always odd)

UART_EVEN_PARITY 

Even parity (i.e. number of bits in character is always even)

anonymous enum
Enumerator
UART_MODE_IRQ 

Each character generates an interrupt and data stored in ring buffer.

UART_MODE_RING_BUFFER 

Use DMA to receive characters into ring buffer.

UART_MODE_ZERO_COPY 

Use DMA to receive characters directly into given buffer.