Configuration Reference

Normative

The configuration items a conformant UART driver MUST support (CHI-UART-MUST-23). The configuration toolchain, data structure, and file schema are implementation-defined; vendor extensions are allowed. For a worked example see Configuration. The model follows the common configuration structure in the General part.

General
General options

Property

Type

Description

enable_development_error_reporting

bool

If true, development error checking and reporting is enabled (see Errors).

Configuration set and channels
ConfigSet

Property

Type

Description

config_set_name

str

Name of the configuration set; must be a valid C identifier.

channel

List[Channel]

Per-channel configurations. Size ≥ 1; maximum is implementation-defined.

Channel

Property

Type

Description

channel_id

int

Logical channel id. Starts at 0, unique within a ConfigSet.

hw_channel

impl-defined

Hardware channel assigned to this logical channel.

event_handling_mode

EventHandlingMode

Interrupt or Polling (polled events serviced by Uart_PollFunction).

transmission_callback_type

TransmissionCallbackType

HwCompletion (Uart_Callout_OnTransmission) or Streaming (Uart_Callout_OnStreamingDataRequest).

clock_divider

int

UART hardware clock divider; derives the baudrate. Range ≥ 1 (maximum implementation-defined).

data_bit_width

int

Data bits per frame. Range [5, 8].

stop_bit_width

StopBitLength

1.0 | 1.5 | 2.0.

parity

Parity

None | Odd | Even.

bit_order

BitOrder

LsbFirst | MsbFirst (restrict to what the HW supports; the driver does not convert bit order in software).

hw_flow_control

bool

Enable hardware flow control. Only false is accepted where the HW lacks it (CHI-UART-SHOULD-01).

Note

transmission_callback_type fixes the TX notification style per channel — the driver uses Uart_Callout_OnTransmission or Uart_Callout_OnStreamingDataRequest for a channel, never both.