sl_iostream_uart_context_t Struct Reference

I/O Stream UART context.

#include <sl_iostream_uart.h>

Public Member Functions

__ALIGNED (4) uint8_t read_lock_cb[osMutexCbSize]
read_lock control block. Available only when kernel present.
__ALIGNED (4) uint8_t read_signal_cb[osSemaphoreCbSize]
read_signal control block. Available only when kernel present.
__ALIGNED (4) uint8_t write_lock_cb[osMutexCbSize]
write_lock control block. Available only when kernel present.

Data Fields

sl_status_t(* tx )(void *context, char c)
Tx function pointer.
void(* tx_completed )(void *context, bool enable)
Pointer to a function handling the Tx Completed event.
void(* enable_rx )(void *context)
Pointer to a function determining whether rx is enabled.
sl_status_t(* deinit )(void *context)
DeInit function pointer.
uint32_t rx_read_index
Index in buffer to be read.
uint32_t rx_write_index
Index in buffer to be written to.
uint32_t rx_count
Keeps track of how much data which are stored in the buffer.
uint8_t * rx_buffer
buffer to store data
size_t rx_buffer_length
rx_buffer_length
bool lf_to_crlf
lf_to_crlf
bool sw_flow_control
software flow control
bool xon
Transmitter enabled.
bool remote_xon
Remote Transmitter enabled.
IRQn_Type rx_irq_number
Receive IRQ Number.
IRQn_Type tx_irq_number
Transmit IRQ Number.
volatile bool tx_idle
tx_idle. Available only when Power Manager present.
bool em_req_added
em_req_added. Available only when Power Manager present.
sl_power_manager_em_t rx_em
rx_em. Available only when Power Manager present.
sl_power_manager_em_t tx_em
tx_em. Available only when Power Manager present.
bool block
block. Available only when kernel present.
osMutexId_t read_lock
read_lock. Available only when kernel present.
osSemaphoreId_t read_signal
read_signal. Available only when kernel present.
osMutexId_t write_lock
write_lock. Available only when kernel present.

I/O Stream UART context.

Member Function Documentation

__ALIGNED() [1/3]

sl_iostream_uart_context_t::__ALIGNED ( 4 )

read_lock control block. Available only when kernel present.

__ALIGNED() [2/3]

sl_iostream_uart_context_t::__ALIGNED ( 4 )

read_signal control block. Available only when kernel present.

__ALIGNED() [3/3]

sl_iostream_uart_context_t::__ALIGNED ( 4 )

write_lock control block. Available only when kernel present.

Field Documentation

tx

sl_status_t(* sl_iostream_uart_context_t::tx) (void *context, char c)

Tx function pointer.

tx_completed

void(* sl_iostream_uart_context_t::tx_completed) (void *context, bool enable)

Pointer to a function handling the Tx Completed event.

enable_rx

void(* sl_iostream_uart_context_t::enable_rx) (void *context)

Pointer to a function determining whether rx is enabled.

deinit

sl_status_t(* sl_iostream_uart_context_t::deinit) (void *context)

DeInit function pointer.

rx_read_index

uint32_t sl_iostream_uart_context_t::rx_read_index

Index in buffer to be read.

rx_write_index

uint32_t sl_iostream_uart_context_t::rx_write_index

Index in buffer to be written to.

rx_count

uint32_t sl_iostream_uart_context_t::rx_count

Keeps track of how much data which are stored in the buffer.

rx_buffer

uint8_t* sl_iostream_uart_context_t::rx_buffer

buffer to store data

rx_buffer_length

size_t sl_iostream_uart_context_t::rx_buffer_length

rx_buffer_length

lf_to_crlf

bool sl_iostream_uart_context_t::lf_to_crlf

lf_to_crlf

sw_flow_control

bool sl_iostream_uart_context_t::sw_flow_control

software flow control

xon

bool sl_iostream_uart_context_t::xon

Transmitter enabled.

remote_xon

bool sl_iostream_uart_context_t::remote_xon

Remote Transmitter enabled.

rx_irq_number

IRQn_Type sl_iostream_uart_context_t::rx_irq_number

Receive IRQ Number.

tx_irq_number

IRQn_Type sl_iostream_uart_context_t::tx_irq_number

Transmit IRQ Number.

tx_idle

volatile bool sl_iostream_uart_context_t::tx_idle

tx_idle. Available only when Power Manager present.

em_req_added

bool sl_iostream_uart_context_t::em_req_added

em_req_added. Available only when Power Manager present.

rx_em

sl_power_manager_em_t sl_iostream_uart_context_t::rx_em

rx_em. Available only when Power Manager present.

tx_em

sl_power_manager_em_t sl_iostream_uart_context_t::tx_em

tx_em. Available only when Power Manager present.

block

bool sl_iostream_uart_context_t::block

block. Available only when kernel present.

read_lock

osMutexId_t sl_iostream_uart_context_t::read_lock

read_lock. Available only when kernel present.

read_signal

osSemaphoreId_t sl_iostream_uart_context_t::read_signal

read_signal. Available only when kernel present.

write_lock

osMutexId_t sl_iostream_uart_context_t::write_lock

write_lock. Available only when kernel present.