uart_async_to_irq.h File Reference

#include <zephyr/drivers/uart.h>
#include <zephyr/logging/log.h>
#include <zephyr/spinlock.h>
#include <zephyr/sys/util.h>
#include <zephyr/drivers/serial/uart_async_rx.h>

Go to the source code of this file.

#define	UART_ASYNC_TO_IRQ_API_INIT()
	Interrupt driven API initializer.
#define	UART_ASYNC_TO_IRQ_API_CONFIG_INITIALIZER(_api, _trampoline, _baudrate, _tx_buf, _tx_len, _rx_buf, _rx_len, _rx_cnt, _log)
	Configuration structure initializer.
typedef void(*	uart_async_to_irq_trampoline) (const struct device *dev)
void	uart_async_to_irq_trampoline_cb (const struct device *dev)
	Callback to be called from trampoline context.
int	uart_async_to_irq_init (struct uart_async_to_irq_data *data, const struct uart_async_to_irq_config *config)
	Initialize the adaptation layer.
int	uart_async_to_irq_rx_enable (const struct device *dev)
int	uart_async_to_irq_rx_disable (const struct device *dev)

Macro Definition Documentation

UART_ASYNC_TO_IRQ_API_CONFIG_INITIALIZER

#define UART_ASYNC_TO_IRQ_API_CONFIG_INITIALIZER	(		_api,
			_trampoline,
			_baudrate,
			_tx_buf,
			_tx_len,
			_rx_buf,
			_rx_len,
			_rx_cnt,
			_log
	)

Value:

        {                                                                                       \
                .tx_buf = _tx_buf,                                                              \
                .tx_len = _tx_len,                                                              \
                .async_rx = {                                                                   \
                        .buffer = _rx_buf,                                                      \
                        .length = _rx_len,                                                      \
                        .buf_cnt = _rx_cnt                                                      \
                },                                                                              \
                .api = _api,                                                                    \
                .trampoline = _trampoline,                                                      \
                .baudrate = _baudrate,                                                          \
                LOG_OBJECT_PTR_INIT(log,                                                        \
                                COND_CODE_1(IS_EMPTY(_log),                                     \
                                            (LOG_OBJECT_PTR(UART_ASYNC_TO_IRQ_LOG_NAME)),       \
                                            (_log)                                              \
                                           )                                                    \
                                   )                                                            \
        }

Configuration structure initializer.

Parameters

_api	Structure with UART asynchronous API.
_trampoline	Function that trampolines to the interrupt context.
_baudrate	UART baudrate.
_tx_buf	TX buffer.
_tx_len	TX buffer length.
_rx_buf	RX buffer.
_rx_len	RX buffer length.
_rx_cnt	Number of chunks into which RX buffer is divided.
_log	Logging instance, if not provided (empty) then default is used.

UART_ASYNC_TO_IRQ_API_INIT

#define UART_ASYNC_TO_IRQ_API_INIT

(

)

Value:

        .fifo_fill        = z_uart_async_to_irq_fifo_fill,      \
        .fifo_read        = z_uart_async_to_irq_fifo_read,      \
        .irq_tx_enable    = z_uart_async_to_irq_irq_tx_enable,  \
        .irq_tx_disable   = z_uart_async_to_irq_irq_tx_disable, \
        .irq_tx_ready     = z_uart_async_to_irq_irq_tx_ready,   \
        .irq_rx_enable    = z_uart_async_to_irq_irq_rx_enable,  \
        .irq_rx_disable   = z_uart_async_to_irq_irq_rx_disable, \
        .irq_tx_complete  = z_uart_async_to_irq_irq_tx_complete,\
        .irq_rx_ready     = z_uart_async_to_irq_irq_rx_ready,   \
        .irq_err_enable   = z_uart_async_to_irq_irq_err_enable, \
        .irq_err_disable  = z_uart_async_to_irq_irq_err_disable,\
        .irq_is_pending   = z_uart_async_to_irq_irq_is_pending, \
        .irq_update       = z_uart_async_to_irq_irq_update,     \
        .irq_callback_set = z_uart_async_to_irq_irq_callback_set

Interrupt driven API initializer.

It should be used in the initialization of the UART API structure in the driver to provide interrupt driven API functions.

Typedef Documentation

uart_async_to_irq_trampoline

typedef void(* uart_async_to_irq_trampoline) (const struct device *dev)

Function Documentation

uart_async_to_irq_init()

int uart_async_to_irq_init	(	struct uart_async_to_irq_data *	data,
		const struct uart_async_to_irq_config *	config
	)

Initialize the adaptation layer.

Parameters

data	Data associated with the given adaptation layer instance.
config	Configuration structure. Must be persistent.

Return values

0	On successful initialization.

uart_async_to_irq_rx_disable()

int uart_async_to_irq_rx_disable

(

const struct device *

dev

)

uart_async_to_irq_rx_enable()

int uart_async_to_irq_rx_enable

(

const struct device *

dev

)

uart_async_to_irq_trampoline_cb()

void uart_async_to_irq_trampoline_cb

(

const struct device *

dev

)

Callback to be called from trampoline context.

Parameters

dev	UART device.