13#ifndef ZEPHYR_INCLUDE_DRIVERS_UART_H_
14#define ZEPHYR_INCLUDE_DRIVERS_UART_H_
340__subsystem
struct uart_driver_api {
342#ifdef CONFIG_UART_ASYNC_API
344 int (*callback_set)(
const struct device *dev,
348 int (*tx)(
const struct device *dev,
const uint8_t *buf,
size_t len,
350 int (*tx_abort)(
const struct device *dev);
352 int (*rx_enable)(
const struct device *dev,
uint8_t *buf,
size_t len,
354 int (*rx_buf_rsp)(
const struct device *dev,
uint8_t *buf,
size_t len);
355 int (*rx_disable)(
const struct device *dev);
357#ifdef CONFIG_UART_WIDE_DATA
369 int (*poll_in)(
const struct device *dev,
unsigned char *p_char);
370 void (*poll_out)(
const struct device *dev,
unsigned char out_char);
372#ifdef CONFIG_UART_WIDE_DATA
378 int (*err_check)(
const struct device *dev);
381 int (*configure)(
const struct device *dev,
385#ifdef CONFIG_UART_INTERRUPT_DRIVEN
388 int (*fifo_fill)(
const struct device *dev,
const uint8_t *tx_data,
391#ifdef CONFIG_UART_WIDE_DATA
392 int (*fifo_fill_u16)(
const struct device *dev,
const uint16_t *tx_data,
400#ifdef CONFIG_UART_WIDE_DATA
406 void (*irq_tx_enable)(
const struct device *dev);
409 void (*irq_tx_disable)(
const struct device *dev);
412 int (*irq_tx_ready)(
const struct device *dev);
415 void (*irq_rx_enable)(
const struct device *dev);
418 void (*irq_rx_disable)(
const struct device *dev);
421 int (*irq_tx_complete)(
const struct device *dev);
424 int (*irq_rx_ready)(
const struct device *dev);
427 void (*irq_err_enable)(
const struct device *dev);
430 void (*irq_err_disable)(
const struct device *dev);
433 int (*irq_is_pending)(
const struct device *dev);
436 int (*irq_update)(
const struct device *dev);
439 void (*irq_callback_set)(
const struct device *dev,
445#ifdef CONFIG_UART_LINE_CTRL
452#ifdef CONFIG_UART_DRV_CMD
471static inline int z_impl_uart_err_check(
const struct device *dev)
473 const struct uart_driver_api *api =
474 (
const struct uart_driver_api *)dev->
api;
476 if (api->err_check == NULL) {
480 return api->err_check(dev);
508static inline int z_impl_uart_poll_in(
const struct device *dev,
509 unsigned char *p_char)
511 const struct uart_driver_api *api =
512 (
const struct uart_driver_api *)dev->
api;
514 if (api->poll_in == NULL) {
518 return api->poll_in(dev, p_char);
542static inline int z_impl_uart_poll_in_u16(
const struct device *dev,
545#ifdef CONFIG_UART_WIDE_DATA
546 const struct uart_driver_api *api =
547 (
const struct uart_driver_api *)dev->
api;
549 if (api->poll_in_u16 == NULL) {
553 return api->poll_in_u16(dev, p_u16);
576 unsigned char out_char);
578static inline void z_impl_uart_poll_out(
const struct device *dev,
579 unsigned char out_char)
581 const struct uart_driver_api *api =
582 (
const struct uart_driver_api *)dev->
api;
584 api->poll_out(dev, out_char);
603static inline void z_impl_uart_poll_out_u16(
const struct device *dev,
606#ifdef CONFIG_UART_WIDE_DATA
607 const struct uart_driver_api *api =
608 (
const struct uart_driver_api *)dev->
api;
610 api->poll_out_u16(dev, out_u16);
637static inline int z_impl_uart_configure(
const struct device *dev,
640 const struct uart_driver_api *api =
641 (
const struct uart_driver_api *)dev->
api;
643 if (api->configure == NULL) {
646 return api->configure(dev, cfg);
665static inline int z_impl_uart_config_get(
const struct device *dev,
668 const struct uart_driver_api *api =
669 (
const struct uart_driver_api *)dev->
api;
671 if (api->config_get == NULL) {
675 return api->config_get(dev, cfg);
707#ifdef CONFIG_UART_INTERRUPT_DRIVEN
708 const struct uart_driver_api *api =
709 (
const struct uart_driver_api *)dev->
api;
711 if (api->fifo_fill == NULL) {
715 return api->fifo_fill(dev, tx_data, size);
748#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
749 const struct uart_driver_api *api =
750 (
const struct uart_driver_api *)dev->
api;
752 if (api->fifo_fill_u16 == NULL) {
756 return api->fifo_fill_u16(dev, tx_data, size);
792#ifdef CONFIG_UART_INTERRUPT_DRIVEN
793 const struct uart_driver_api *api =
794 (
const struct uart_driver_api *)dev->
api;
796 if (api->fifo_read == NULL) {
800 return api->fifo_read(dev, rx_data, size);
837#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
838 const struct uart_driver_api *api =
839 (
const struct uart_driver_api *)dev->
api;
841 if (api->fifo_read_u16 == NULL) {
845 return api->fifo_read_u16(dev, rx_data, size);
861static inline void z_impl_uart_irq_tx_enable(
const struct device *dev)
863#ifdef CONFIG_UART_INTERRUPT_DRIVEN
864 const struct uart_driver_api *api =
865 (
const struct uart_driver_api *)dev->
api;
867 if (api->irq_tx_enable != NULL) {
868 api->irq_tx_enable(dev);
882static inline void z_impl_uart_irq_tx_disable(
const struct device *dev)
884#ifdef CONFIG_UART_INTERRUPT_DRIVEN
885 const struct uart_driver_api *api =
886 (
const struct uart_driver_api *)dev->
api;
888 if (api->irq_tx_disable != NULL) {
889 api->irq_tx_disable(dev);
916#ifdef CONFIG_UART_INTERRUPT_DRIVEN
917 const struct uart_driver_api *api =
918 (
const struct uart_driver_api *)dev->
api;
920 if (api->irq_tx_ready == NULL) {
924 return api->irq_tx_ready(dev);
938static inline void z_impl_uart_irq_rx_enable(
const struct device *dev)
940#ifdef CONFIG_UART_INTERRUPT_DRIVEN
941 const struct uart_driver_api *api =
942 (
const struct uart_driver_api *)dev->
api;
944 if (api->irq_rx_enable != NULL) {
945 api->irq_rx_enable(dev);
959static inline void z_impl_uart_irq_rx_disable(
const struct device *dev)
961#ifdef CONFIG_UART_INTERRUPT_DRIVEN
962 const struct uart_driver_api *api =
963 (
const struct uart_driver_api *)dev->
api;
965 if (api->irq_rx_disable != NULL) {
966 api->irq_rx_disable(dev);
994#ifdef CONFIG_UART_INTERRUPT_DRIVEN
995 const struct uart_driver_api *api =
996 (
const struct uart_driver_api *)dev->
api;
998 if (api->irq_tx_complete == NULL) {
1001 return api->irq_tx_complete(dev);
1030#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1031 const struct uart_driver_api *api =
1032 (
const struct uart_driver_api *)dev->
api;
1034 if (api->irq_rx_ready == NULL) {
1037 return api->irq_rx_ready(dev);
1050static inline void z_impl_uart_irq_err_enable(
const struct device *dev)
1052#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1053 const struct uart_driver_api *api =
1054 (
const struct uart_driver_api *)dev->
api;
1056 if (api->irq_err_enable) {
1057 api->irq_err_enable(dev);
1071static inline void z_impl_uart_irq_err_disable(
const struct device *dev)
1073#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1074 const struct uart_driver_api *api =
1075 (
const struct uart_driver_api *)dev->
api;
1077 if (api->irq_err_disable) {
1078 api->irq_err_disable(dev);
1097static inline int z_impl_uart_irq_is_pending(
const struct device *dev)
1099#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1100 const struct uart_driver_api *api =
1101 (
const struct uart_driver_api *)dev->
api;
1103 if (api->irq_is_pending == NULL) {
1106 return api->irq_is_pending(dev);
1140static inline int z_impl_uart_irq_update(
const struct device *dev)
1142#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1143 const struct uart_driver_api *api =
1144 (
const struct uart_driver_api *)dev->
api;
1146 if (api->irq_update == NULL) {
1149 return api->irq_update(dev);
1175#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1176 const struct uart_driver_api *api =
1177 (
const struct uart_driver_api *)dev->
api;
1179 if ((api != NULL) && (api->irq_callback_set != NULL)) {
1180 api->irq_callback_set(dev, cb,
user_data);
1240#ifdef CONFIG_UART_ASYNC_API
1241 const struct uart_driver_api *api =
1242 (
const struct uart_driver_api *)dev->
api;
1244 if (api->callback_set == NULL) {
1248 return api->callback_set(dev, callback,
user_data);
1251 ARG_UNUSED(callback);
1278static inline int z_impl_uart_tx(
const struct device *dev,
const uint8_t *buf,
1282#ifdef CONFIG_UART_ASYNC_API
1283 const struct uart_driver_api *api =
1284 (
const struct uart_driver_api *)dev->
api;
1286 return api->tx(dev, buf, len,
timeout);
1316static inline int z_impl_uart_tx_u16(
const struct device *dev,
1321#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1322 const struct uart_driver_api *api =
1323 (
const struct uart_driver_api *)dev->
api;
1325 return api->tx_u16(dev, buf, len,
timeout);
1349static inline int z_impl_uart_tx_abort(
const struct device *dev)
1351#ifdef CONFIG_UART_ASYNC_API
1352 const struct uart_driver_api *api =
1353 (
const struct uart_driver_api *)dev->
api;
1355 return api->tx_abort(dev);
1387static inline int z_impl_uart_rx_enable(
const struct device *dev,
1391#ifdef CONFIG_UART_ASYNC_API
1392 const struct uart_driver_api *api =
1393 (
const struct uart_driver_api *)dev->
api;
1395 return api->rx_enable(dev, buf, len,
timeout);
1429static inline int z_impl_uart_rx_enable_u16(
const struct device *dev,
1433#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1434 const struct uart_driver_api *api =
1435 (
const struct uart_driver_api *)dev->
api;
1437 return api->rx_enable_u16(dev, buf, len,
timeout);
1470#ifdef CONFIG_UART_ASYNC_API
1471 const struct uart_driver_api *api =
1472 (
const struct uart_driver_api *)dev->
api;
1474 return api->rx_buf_rsp(dev, buf, len);
1507#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1508 const struct uart_driver_api *api =
1509 (
const struct uart_driver_api *)dev->
api;
1511 return api->rx_buf_rsp_u16(dev, buf, len);
1537static inline int z_impl_uart_rx_disable(
const struct device *dev)
1539#ifdef CONFIG_UART_ASYNC_API
1540 const struct uart_driver_api *api =
1541 (
const struct uart_driver_api *)dev->
api;
1543 return api->rx_disable(dev);
1569static inline int z_impl_uart_line_ctrl_set(
const struct device *dev,
1572#ifdef CONFIG_UART_LINE_CTRL
1573 const struct uart_driver_api *api =
1574 (
const struct uart_driver_api *)dev->
api;
1576 if (api->line_ctrl_set == NULL) {
1579 return api->line_ctrl_set(dev, ctrl, val);
1603static inline int z_impl_uart_line_ctrl_get(
const struct device *dev,
1606#ifdef CONFIG_UART_LINE_CTRL
1607 const struct uart_driver_api *api =
1608 (
const struct uart_driver_api *)dev->
api;
1610 if (api->line_ctrl_get == NULL) {
1613 return api->line_ctrl_get(dev, ctrl, val);
1642#ifdef CONFIG_UART_DRV_CMD
1643 const struct uart_driver_api *api =
1644 (
const struct uart_driver_api *)dev->
api;
1646 if (api->drv_cmd == NULL) {
1649 return api->drv_cmd(dev,
cmd,
p);
1666#include <syscalls/uart.h>
ZTEST_BMEM int timeout
Definition: main.c:31
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition: ft8xx_reference_api.h:153
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition: util_macro.h:44
#define ENOSYS
Definition: errno.h:83
#define ENOTSUP
Definition: errno.h:115
int uart_rx_enable_u16(const struct device *dev, uint16_t *buf, size_t len, int32_t timeout)
Start receiving wide data through UART.
static int uart_rx_buf_rsp(const struct device *dev, uint8_t *buf, size_t len)
Provide receive buffer in response to UART_RX_BUF_REQUEST event.
Definition: uart.h:1467
static int uart_rx_buf_rsp_u16(const struct device *dev, uint16_t *buf, size_t len)
Provide wide data receive buffer in response to UART_RX_BUF_REQUEST event.
Definition: uart.h:1504
void(* uart_callback_t)(const struct device *dev, struct uart_event *evt, void *user_data)
Define the application callback function signature for uart_callback_set() function.
Definition: uart.h:326
int uart_rx_enable(const struct device *dev, uint8_t *buf, size_t len, int32_t timeout)
Start receiving data through UART.
int uart_tx_abort(const struct device *dev)
Abort current TX transmission.
int uart_tx_u16(const struct device *dev, const uint16_t *buf, size_t len, int32_t timeout)
Send given number of datum from buffer through UART.
static int uart_callback_set(const struct device *dev, uart_callback_t callback, void *user_data)
Set event handler function.
Definition: uart.h:1236
uart_event_type
Types of events passed to callback in UART_ASYNC_API.
Definition: uart.h:209
int uart_tx(const struct device *dev, const uint8_t *buf, size_t len, int32_t timeout)
Send given number of bytes from buffer through UART.
int uart_rx_disable(const struct device *dev)
Disable RX.
@ UART_RX_STOPPED
RX has stopped due to external event.
Definition: uart.h:260
@ UART_TX_ABORTED
Transmitting aborted due to timeout or uart_tx_abort call.
Definition: uart.h:219
@ UART_RX_BUF_REQUEST
Driver requests next buffer for continuous reception.
Definition: uart.h:242
@ UART_TX_DONE
Whole TX buffer was transmitted.
Definition: uart.h:211
@ UART_RX_RDY
Received data is ready for processing.
Definition: uart.h:230
@ UART_RX_DISABLED
RX has been disabled and can be reenabled.
Definition: uart.h:254
@ UART_RX_BUF_RELEASED
Buffer is no longer used by UART driver.
Definition: uart.h:246
uart_line_ctrl
Line control signals.
Definition: uart.h:33
int uart_err_check(const struct device *dev)
Check whether an error was detected.
int uart_config_get(const struct device *dev, struct uart_config *cfg)
Get UART configuration.
uart_config_flow_control
Hardware flow control options.
Definition: uart.h:109
int uart_configure(const struct device *dev, const struct uart_config *cfg)
Set UART configuration.
int uart_drv_cmd(const struct device *dev, uint32_t cmd, uint32_t p)
Send extra command to driver.
int uart_line_ctrl_set(const struct device *dev, uint32_t ctrl, uint32_t val)
Manipulate line control for UART.
uart_config_parity
Parity modes.
Definition: uart.h:77
uart_config_data_bits
Number of data bits.
Definition: uart.h:94
uart_rx_stop_reason
Reception stop reasons.
Definition: uart.h:47
uart_config_stop_bits
Number of stop bits.
Definition: uart.h:86
int uart_line_ctrl_get(const struct device *dev, uint32_t ctrl, uint32_t *val)
Retrieve line control for UART.
@ UART_LINE_CTRL_DTR
Definition: uart.h:36
@ UART_LINE_CTRL_RTS
Definition: uart.h:35
@ UART_LINE_CTRL_BAUD_RATE
Definition: uart.h:34
@ UART_LINE_CTRL_DCD
Definition: uart.h:37
@ UART_LINE_CTRL_DSR
Definition: uart.h:38
@ UART_CFG_FLOW_CTRL_DTR_DSR
Definition: uart.h:112
@ UART_CFG_FLOW_CTRL_NONE
Definition: uart.h:110
@ UART_CFG_FLOW_CTRL_RS485
Definition: uart.h:113
@ UART_CFG_FLOW_CTRL_RTS_CTS
Definition: uart.h:111
@ UART_CFG_PARITY_MARK
Definition: uart.h:81
@ UART_CFG_PARITY_NONE
Definition: uart.h:78
@ UART_CFG_PARITY_ODD
Definition: uart.h:79
@ UART_CFG_PARITY_SPACE
Definition: uart.h:82
@ UART_CFG_PARITY_EVEN
Definition: uart.h:80
@ UART_CFG_DATA_BITS_5
Definition: uart.h:95
@ UART_CFG_DATA_BITS_8
Definition: uart.h:98
@ UART_CFG_DATA_BITS_7
Definition: uart.h:97
@ UART_CFG_DATA_BITS_6
Definition: uart.h:96
@ UART_CFG_DATA_BITS_9
Definition: uart.h:99
@ UART_ERROR_NOISE
Noise error.
Definition: uart.h:73
@ UART_ERROR_OVERRUN
Overrun error.
Definition: uart.h:49
@ UART_BREAK
Break interrupt.
Definition: uart.h:61
@ UART_ERROR_PARITY
Parity error.
Definition: uart.h:51
@ UART_ERROR_COLLISION
Collision error.
Definition: uart.h:71
@ UART_ERROR_FRAMING
Framing error.
Definition: uart.h:53
@ UART_CFG_STOP_BITS_1_5
Definition: uart.h:89
@ UART_CFG_STOP_BITS_0_5
Definition: uart.h:87
@ UART_CFG_STOP_BITS_1
Definition: uart.h:88
@ UART_CFG_STOP_BITS_2
Definition: uart.h:90
int uart_irq_is_pending(const struct device *dev)
Check if any IRQs is pending.
static int uart_fifo_read_u16(const struct device *dev, uint16_t *rx_data, const int size)
Read wide data from FIFO.
Definition: uart.h:833
void uart_irq_rx_enable(const struct device *dev)
Enable RX interrupt.
static int uart_irq_tx_ready(const struct device *dev)
Check if UART TX buffer can accept a new char.
Definition: uart.h:914
static int uart_irq_callback_set(const struct device *dev, uart_irq_callback_user_data_t cb)
Set the IRQ callback function pointer (legacy).
Definition: uart.h:1206
void(* uart_irq_config_func_t)(const struct device *dev)
For configuring IRQ on each individual UART device.
Definition: uart.h:153
void uart_irq_err_enable(const struct device *dev)
Enable error interrupt.
static int uart_irq_tx_complete(const struct device *dev)
Check if UART TX block finished transmission.
Definition: uart.h:992
void uart_irq_tx_enable(const struct device *dev)
Enable TX interrupt in IER.
void uart_irq_rx_disable(const struct device *dev)
Disable RX interrupt.
static int uart_fifo_fill_u16(const struct device *dev, const uint16_t *tx_data, int size)
Fill FIFO with wide data.
Definition: uart.h:744
void uart_irq_err_disable(const struct device *dev)
Disable error interrupt.
static int uart_fifo_read(const struct device *dev, uint8_t *rx_data, const int size)
Read data from FIFO.
Definition: uart.h:789
int uart_irq_update(const struct device *dev)
Start processing interrupts in ISR.
static int uart_irq_rx_ready(const struct device *dev)
Check if UART RX buffer has a received char.
Definition: uart.h:1028
void(* uart_irq_callback_user_data_t)(const struct device *dev, void *user_data)
Define the application callback function signature for uart_irq_callback_user_data_set() function.
Definition: uart.h:145
static int uart_irq_callback_user_data_set(const struct device *dev, uart_irq_callback_user_data_t cb, void *user_data)
Set the IRQ callback function pointer.
Definition: uart.h:1171
void uart_irq_tx_disable(const struct device *dev)
Disable TX interrupt in IER.
static int uart_fifo_fill(const struct device *dev, const uint8_t *tx_data, int size)
Fill FIFO with data.
Definition: uart.h:703
void uart_poll_out(const struct device *dev, unsigned char out_char)
Write a character to the device for output.
void uart_poll_out_u16(const struct device *dev, uint16_t out_u16)
Write a 16-bit datum to the device for output.
int uart_poll_in_u16(const struct device *dev, uint16_t *p_u16)
Read a 16-bit datum from the device for input.
int uart_poll_in(const struct device *dev, unsigned char *p_char)
Read a character from the device for input.
struct k_pipe p
Definition: kobject.c:1322
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__INT32_TYPE__ int32_t
Definition: stdint.h:74
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition: device.h:380
const void * api
Definition: device.h:386
UART controller configuration structure.
Definition: uart.h:125
uint8_t stop_bits
Definition: uart.h:128
uint8_t parity
Definition: uart.h:127
uint8_t data_bits
Definition: uart.h:129
uint32_t baudrate
Definition: uart.h:126
uint8_t flow_ctrl
Definition: uart.h:130
UART RX buffer released event data.
Definition: uart.h:287
uint8_t * buf
Definition: uart.h:289
UART RX stopped data.
Definition: uart.h:293
struct uart_event_rx data
Last received data.
Definition: uart.h:297
enum uart_rx_stop_reason reason
Reason why receiving stopped.
Definition: uart.h:295
UART RX event data.
Definition: uart.h:277
uint8_t * buf
Pointer to current buffer.
Definition: uart.h:279
size_t len
Number of new bytes received.
Definition: uart.h:283
size_t offset
Currently received data offset in bytes.
Definition: uart.h:281
UART TX event data.
Definition: uart.h:264
const uint8_t * buf
Pointer to current buffer.
Definition: uart.h:266
size_t len
Number of bytes sent.
Definition: uart.h:268
Structure containing information about current event.
Definition: uart.h:301
union uart_event::uart_event_data data
enum uart_event_type type
Type of event.
Definition: uart.h:303
static const intptr_t user_data[5]
Definition: main.c:588
Event data.
Definition: uart.h:305
struct uart_event_tx tx
UART_TX_DONE and UART_TX_ABORTED events data.
Definition: uart.h:307
struct uart_event_rx_stop rx_stop
UART_RX_STOPPED event data.
Definition: uart.h:313
struct uart_event_rx_buf rx_buf
UART_RX_BUF_RELEASED event data.
Definition: uart.h:311
struct uart_event_rx rx
UART_RX_RDY event data.
Definition: uart.h:309