Type definitions#

Modules#

sid_pal_serial_bus_client

sid_pal_serial_bus_iface

sid_pal_serial_bus_factory

Enumerations#

enum
SID_PAL_SERIAL_BUS_BIT_ORDER_MSB_FIRST
SID_PAL_SERIAL_BUS_BIT_ORDER_LSB_FIRST
}

Describes the bit order of messages exchanged on serial bus interface.

enum
SID_PAL_SERIAL_BUS_CLIENT_DESELECT
SID_PAL_SERIAL_BUS_CLIENT_SELECT
}

Describes the client selection or deselection.

Typedefs#

typedef void(*
sid_pal_serial_bus_rx_cb_t)(const uint8_t *data, size_t len, void *context)

Callback delivered by the backend as bytes arrive on the bus.

Enumeration Documentation#

sid_pal_serial_bus_bit_order#

sid_pal_serial_bus_bit_order

Describes the bit order of messages exchanged on serial bus interface.

Enumerator
SID_PAL_SERIAL_BUS_BIT_ORDER_MSB_FIRST

Most significant bit first.

SID_PAL_SERIAL_BUS_BIT_ORDER_LSB_FIRST

Least significant bit first.


sid_pal_serial_bus_client_select#

sid_pal_serial_bus_client_select

Describes the client selection or deselection.

Enumerator
SID_PAL_SERIAL_BUS_CLIENT_DESELECT

Deselect the serial bus client

SID_PAL_SERIAL_BUS_CLIENT_SELECT

Select the serial bus client


Typedef Documentation#

sid_pal_serial_bus_rx_cb_t#

typedef void(* sid_pal_serial_bus_rx_cb_t) (const uint8_t *data, size_t len, void *context) )(const uint8_t *data, size_t len, void *context)

Callback delivered by the backend as bytes arrive on the bus.

Parameters
TypeDirectionArgument NameDescription
[in]data

received bytes (never NULL when len > 0)

[in]len

number of valid bytes in data

[in]context

the context registered with set_rx_callback

Invoked from the backend's receive context (typically an ISR on UART backends). The callback MUST return quickly and MUST NOT call back into the bus interface – copy the bytes into caller-owned storage and defer any real work. data is only valid for the duration of the call.