mctp_uart.h File Reference

#include <stdint.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <libmctp.h>

Go to the source code of this file.

Data Structures
struct	mctp_binding_uart
	An MCTP binding for Zephyr's asynchronous UART interface. More...

Macros
#define	MCTP_UART_DT_DEFINE(_name, _dev)
	Statically define a MCTP bus binding for a UART.

Functions
void	mctp_uart_start_rx (struct mctp_binding_uart *uart)
	Start the receive of mctp messages.
int	mctp_uart_stop_rx (struct mctp_binding_uart *uart)
	Stop the receive of mctp messages.

Macro Definition Documentation

MCTP_UART_DT_DEFINE

#define MCTP_UART_DT_DEFINE	(		_name,
			_dev )

Value:

struct mctp_binding_uart _name = {                                                         \
        .binding =                                                                         \
                {                                                                          \
                        .name = STRINGIFY(_name), .version = 1,                            \
                                          .pkt_size = MCTP_PACKET_SIZE(MCTP_BTU),          \
                                          .pkt_header = 0, .pkt_trailer = 0,               \
                                          .tx_storage = _name.tx_storage,          \
                                          .start = mctp_uart_start, .tx = mctp_uart_tx,    \
                        },                                                                 \
                        .dev = _dev,                                                       \
                        .rx_state = STATE_WAIT_SYNC_START,                                 \
                        .rx_pkt = NULL,                                                    \
                        .rx_res = 0,                                                       \
                        .tx_res = 0,                                                       \
};

Statically define a MCTP bus binding for a UART.

Parameters

_name	Symbolic name of the bus binding variable
_dev	UART device

Function Documentation

mctp_uart_start_rx()

void mctp_uart_start_rx

(

struct mctp_binding_uart *

uart

)

Start the receive of mctp messages.

Will read mctp messages from the uart.

Parameters

uart	MCTP UART binding

mctp_uart_stop_rx()

int mctp_uart_stop_rx

(

struct mctp_binding_uart *

uart

)

Stop the receive of mctp messages.

Will stop reading mctp messages from the uart.

Parameters

uart	MCTP UART binding

Return values

0	on success
-errno	result from uart_rx_disable on failure

See also

uart_rx_disable