Hardware UART data types. More...

Data Structures

struct  gos_uart_powersave_config_t
 UART powersave configuration. More...
 
struct  gos_uart_config_t
 UART configuration. More...
 

Typedefs

typedef gos_result_t(* gos_uart_callback_t) (void *unused)
 UART callback. More...
 

Enumerations

enum  gos_uart_width_t {
  GOS_UART_WIDTH_4BIT = 0,
  GOS_UART_WIDTH_5BIT = 1,
  GOS_UART_WIDTH_6BIT = 2,
  GOS_UART_WIDTH_7BIT = 3,
  GOS_UART_WIDTH_8BIT = 4,
  GOS_UART_WIDTH_9BIT = 5,
  GOS_UART_WIDTH_10BIT = 6,
  GOS_UART_WIDTH_11BIT = 7,
  GOS_UART_WIDTH_12BIT = 8,
  GOS_UART_WIDTH_13BIT = 9,
  GOS_UART_WIDTH_14BIT = 10,
  GOS_UART_WIDTH_15BIT = 11,
  GOS_UART_WIDTH_16BIT = 12
}
 UART data width. More...
 
enum  gos_uart_stop_bits_t {
  GOS_UART_STOP_BITS_1 = 0,
  GOS_UART_STOP_BITS_2 = 1
}
 UART stop bits. More...
 
enum  gos_uart_flow_control_t {
  GOS_UART_FLOW_CONTROL_DISABLED = 0 ,
  GOS_UART_FLOW_CONTROL_CTSRTS = 3
}
 UART hardware flow control. More...
 
enum  gos_uart_parity_t {
  GOS_UART_NO_PARITY = 0,
  GOS_UART_ODD_PARITY = 1,
  GOS_UART_EVEN_PARITY = 2
}
 UART data parity. More...
 
enum  gos_uart_powersave_mode_t {
  GOS_UART_POWERSAVE_DISABLED = 0,
  GOS_UART_POWERSAVE_WAKE_EXTERNAL
}
 UART powersave mode. More...
 
enum  gos_uart_t {
  GOS_UART_0,
  GOS_UART_MAX
}
 

Detailed Description

Hardware UART data types.

Typedef Documentation

◆ gos_uart_callback_t

typedef gos_result_t(* gos_uart_callback_t) (void *unused)

UART callback.

This callback is used by gos_uart_set_tx_processor() and gos_uart_set_rx_callback()

For gos_uart_set_tx_processor(), return GOS_SUCCESS to continue processing, any other error could will abort the transfer.

Enumeration Type Documentation

◆ gos_uart_flow_control_t

UART hardware flow control.

Enumerator
GOS_UART_FLOW_CONTROL_DISABLED 

No hardware flow control used.

GOS_UART_FLOW_CONTROL_CTSRTS 

CTS & RTS signals used.

◆ gos_uart_parity_t

UART data parity.

Enumerator
GOS_UART_NO_PARITY 

No data parity used.

GOS_UART_ODD_PARITY 

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

GOS_UART_EVEN_PARITY 

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

◆ gos_uart_powersave_mode_t

UART powersave mode.

Enumerator
GOS_UART_POWERSAVE_DISABLED 

No powersave used, device sleep mode limited to 'SLEEP'.

GOS_UART_POWERSAVE_WAKE_EXTERNAL 

UART is stopped, the device is woken by an event set in system.sleep.wakeup. Device sleep mode is not restricted.

◆ gos_uart_stop_bits_t

UART stop bits.

Enumerator
GOS_UART_STOP_BITS_1 

1bit signifies end of character

GOS_UART_STOP_BITS_2 

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

◆ gos_uart_t

enum gos_uart_t

Gecko OS UART ID

Enumerator
GOS_UART_0 

This is just a placeholder, this is platform dependent.

GOS_UART_MAX 

Maximum number of UARTs the platform supports in Gecko OS.

◆ gos_uart_width_t

UART data width.

Enumerator
GOS_UART_WIDTH_4BIT 

GOS_UART_WIDTH_4BIT.

GOS_UART_WIDTH_5BIT 

GOS_UART_WIDTH_5BIT.

GOS_UART_WIDTH_6BIT 

GOS_UART_WIDTH_6BIT.

GOS_UART_WIDTH_7BIT 

GOS_UART_WIDTH_7BIT.

GOS_UART_WIDTH_8BIT 

GOS_UART_WIDTH_8BIT.

GOS_UART_WIDTH_9BIT 

GOS_UART_WIDTH_9BIT.

GOS_UART_WIDTH_10BIT 

GOS_UART_WIDTH_10BIT.

GOS_UART_WIDTH_11BIT 

GOS_UART_WIDTH_11BIT.

GOS_UART_WIDTH_12BIT 

GOS_UART_WIDTH_12BIT.

GOS_UART_WIDTH_13BIT 

GOS_UART_WIDTH_13BIT.

GOS_UART_WIDTH_14BIT 

GOS_UART_WIDTH_14BIT.

GOS_UART_WIDTH_15BIT 

GOS_UART_WIDTH_15BIT.

GOS_UART_WIDTH_16BIT 

GOS_UART_WIDTH_16BIT.