13#ifndef ZEPHYR_INCLUDE_DRIVERS_UART_H_
14#define ZEPHYR_INCLUDE_DRIVERS_UART_H_
334__subsystem
struct uart_driver_api {
336#ifdef CONFIG_UART_ASYNC_API
338 int (*callback_set)(
const struct device *dev,
342 int (*tx)(
const struct device *dev,
const uint8_t *buf,
size_t len,
344 int (*tx_abort)(
const struct device *dev);
346 int (*rx_enable)(
const struct device *dev,
uint8_t *buf,
size_t len,
348 int (*rx_buf_rsp)(
const struct device *dev,
uint8_t *buf,
size_t len);
349 int (*rx_disable)(
const struct device *dev);
351#ifdef CONFIG_UART_WIDE_DATA
363 int (*poll_in)(
const struct device *dev,
unsigned char *p_char);
364 void (*poll_out)(
const struct device *dev,
unsigned char out_char);
366#ifdef CONFIG_UART_WIDE_DATA
372 int (*err_check)(
const struct device *dev);
374#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
376 int (*configure)(
const struct device *dev,
381#ifdef CONFIG_UART_INTERRUPT_DRIVEN
384 int (*fifo_fill)(
const struct device *dev,
const uint8_t *tx_data,
387#ifdef CONFIG_UART_WIDE_DATA
388 int (*fifo_fill_u16)(
const struct device *dev,
const uint16_t *tx_data,
396#ifdef CONFIG_UART_WIDE_DATA
402 void (*irq_tx_enable)(
const struct device *dev);
405 void (*irq_tx_disable)(
const struct device *dev);
408 int (*irq_tx_ready)(
const struct device *dev);
411 void (*irq_rx_enable)(
const struct device *dev);
414 void (*irq_rx_disable)(
const struct device *dev);
417 int (*irq_tx_complete)(
const struct device *dev);
420 int (*irq_rx_ready)(
const struct device *dev);
423 void (*irq_err_enable)(
const struct device *dev);
426 void (*irq_err_disable)(
const struct device *dev);
429 int (*irq_is_pending)(
const struct device *dev);
432 int (*irq_update)(
const struct device *dev);
435 void (*irq_callback_set)(
const struct device *dev,
441#ifdef CONFIG_UART_LINE_CTRL
448#ifdef CONFIG_UART_DRV_CMD
467static inline int z_impl_uart_err_check(
const struct device *dev)
469 const struct uart_driver_api *api =
470 (
const struct uart_driver_api *)dev->
api;
472 if (api->err_check == NULL) {
476 return api->err_check(dev);
504static inline int z_impl_uart_poll_in(
const struct device *dev,
505 unsigned char *p_char)
507 const struct uart_driver_api *api =
508 (
const struct uart_driver_api *)dev->
api;
510 if (api->poll_in == NULL) {
514 return api->poll_in(dev, p_char);
538static inline int z_impl_uart_poll_in_u16(
const struct device *dev,
541#ifdef CONFIG_UART_WIDE_DATA
542 const struct uart_driver_api *api =
543 (
const struct uart_driver_api *)dev->
api;
545 if (api->poll_in_u16 == NULL) {
549 return api->poll_in_u16(dev, p_u16);
572 unsigned char out_char);
574static inline void z_impl_uart_poll_out(
const struct device *dev,
575 unsigned char out_char)
577 const struct uart_driver_api *api =
578 (
const struct uart_driver_api *)dev->
api;
580 api->poll_out(dev, out_char);
599static inline void z_impl_uart_poll_out_u16(
const struct device *dev,
602#ifdef CONFIG_UART_WIDE_DATA
603 const struct uart_driver_api *api =
604 (
const struct uart_driver_api *)dev->
api;
606 api->poll_out_u16(dev, out_u16);
634static inline int z_impl_uart_configure(
const struct device *dev,
637#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
638 const struct uart_driver_api *api =
639 (
const struct uart_driver_api *)dev->
api;
641 if (api->configure == NULL) {
644 return api->configure(dev, cfg);
669static inline int z_impl_uart_config_get(
const struct device *dev,
672#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
673 const struct uart_driver_api *api =
674 (
const struct uart_driver_api *)dev->
api;
676 if (api->config_get == NULL) {
680 return api->config_get(dev, cfg);
717#ifdef CONFIG_UART_INTERRUPT_DRIVEN
718 const struct uart_driver_api *api =
719 (
const struct uart_driver_api *)dev->
api;
721 if (api->fifo_fill == NULL) {
725 return api->fifo_fill(dev, tx_data, size);
758#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
759 const struct uart_driver_api *api =
760 (
const struct uart_driver_api *)dev->
api;
762 if (api->fifo_fill_u16 == NULL) {
766 return api->fifo_fill_u16(dev, tx_data, size);
799#ifdef CONFIG_UART_INTERRUPT_DRIVEN
800 const struct uart_driver_api *api =
801 (
const struct uart_driver_api *)dev->
api;
803 if (api->fifo_read == NULL) {
807 return api->fifo_read(dev, rx_data, size);
841#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
842 const struct uart_driver_api *api =
843 (
const struct uart_driver_api *)dev->
api;
845 if (api->fifo_read_u16 == NULL) {
849 return api->fifo_read_u16(dev, rx_data, size);
865static inline void z_impl_uart_irq_tx_enable(
const struct device *dev)
867#ifdef CONFIG_UART_INTERRUPT_DRIVEN
868 const struct uart_driver_api *api =
869 (
const struct uart_driver_api *)dev->
api;
871 if (api->irq_tx_enable != NULL) {
872 api->irq_tx_enable(dev);
886static inline void z_impl_uart_irq_tx_disable(
const struct device *dev)
888#ifdef CONFIG_UART_INTERRUPT_DRIVEN
889 const struct uart_driver_api *api =
890 (
const struct uart_driver_api *)dev->
api;
892 if (api->irq_tx_disable != NULL) {
893 api->irq_tx_disable(dev);
920#ifdef CONFIG_UART_INTERRUPT_DRIVEN
921 const struct uart_driver_api *api =
922 (
const struct uart_driver_api *)dev->
api;
924 if (api->irq_tx_ready == NULL) {
928 return api->irq_tx_ready(dev);
942static inline void z_impl_uart_irq_rx_enable(
const struct device *dev)
944#ifdef CONFIG_UART_INTERRUPT_DRIVEN
945 const struct uart_driver_api *api =
946 (
const struct uart_driver_api *)dev->
api;
948 if (api->irq_rx_enable != NULL) {
949 api->irq_rx_enable(dev);
963static inline void z_impl_uart_irq_rx_disable(
const struct device *dev)
965#ifdef CONFIG_UART_INTERRUPT_DRIVEN
966 const struct uart_driver_api *api =
967 (
const struct uart_driver_api *)dev->
api;
969 if (api->irq_rx_disable != NULL) {
970 api->irq_rx_disable(dev);
998#ifdef CONFIG_UART_INTERRUPT_DRIVEN
999 const struct uart_driver_api *api =
1000 (
const struct uart_driver_api *)dev->
api;
1002 if (api->irq_tx_complete == NULL) {
1005 return api->irq_tx_complete(dev);
1034#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1035 const struct uart_driver_api *api =
1036 (
const struct uart_driver_api *)dev->
api;
1038 if (api->irq_rx_ready == NULL) {
1041 return api->irq_rx_ready(dev);
1054static inline void z_impl_uart_irq_err_enable(
const struct device *dev)
1056#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1057 const struct uart_driver_api *api =
1058 (
const struct uart_driver_api *)dev->
api;
1060 if (api->irq_err_enable) {
1061 api->irq_err_enable(dev);
1075static inline void z_impl_uart_irq_err_disable(
const struct device *dev)
1077#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1078 const struct uart_driver_api *api =
1079 (
const struct uart_driver_api *)dev->
api;
1081 if (api->irq_err_disable) {
1082 api->irq_err_disable(dev);
1101static inline int z_impl_uart_irq_is_pending(
const struct device *dev)
1103#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1104 const struct uart_driver_api *api =
1105 (
const struct uart_driver_api *)dev->
api;
1107 if (api->irq_is_pending == NULL) {
1110 return api->irq_is_pending(dev);
1144static inline int z_impl_uart_irq_update(
const struct device *dev)
1146#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1147 const struct uart_driver_api *api =
1148 (
const struct uart_driver_api *)dev->
api;
1150 if (api->irq_update == NULL) {
1153 return api->irq_update(dev);
1179#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1180 const struct uart_driver_api *api =
1181 (
const struct uart_driver_api *)dev->
api;
1183 if ((api != NULL) && (api->irq_callback_set != NULL)) {
1184 api->irq_callback_set(dev, cb, user_data);
1192 ARG_UNUSED(user_data);
1244#ifdef CONFIG_UART_ASYNC_API
1245 const struct uart_driver_api *api =
1246 (
const struct uart_driver_api *)dev->
api;
1248 if (api->callback_set == NULL) {
1252 return api->callback_set(dev, callback, user_data);
1255 ARG_UNUSED(callback);
1256 ARG_UNUSED(user_data);
1282static inline int z_impl_uart_tx(
const struct device *dev,
const uint8_t *buf,
1286#ifdef CONFIG_UART_ASYNC_API
1287 const struct uart_driver_api *api =
1288 (
const struct uart_driver_api *)dev->
api;
1290 return api->tx(dev, buf, len, timeout);
1295 ARG_UNUSED(timeout);
1320static inline int z_impl_uart_tx_u16(
const struct device *dev,
1325#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1326 const struct uart_driver_api *api =
1327 (
const struct uart_driver_api *)dev->
api;
1329 return api->tx_u16(dev, buf, len, timeout);
1334 ARG_UNUSED(timeout);
1353static inline int z_impl_uart_tx_abort(
const struct device *dev)
1355#ifdef CONFIG_UART_ASYNC_API
1356 const struct uart_driver_api *api =
1357 (
const struct uart_driver_api *)dev->
api;
1359 return api->tx_abort(dev);
1391static inline int z_impl_uart_rx_enable(
const struct device *dev,
1395#ifdef CONFIG_UART_ASYNC_API
1396 const struct uart_driver_api *api =
1397 (
const struct uart_driver_api *)dev->
api;
1399 return api->rx_enable(dev, buf, len, timeout);
1404 ARG_UNUSED(timeout);
1433static inline int z_impl_uart_rx_enable_u16(
const struct device *dev,
1437#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1438 const struct uart_driver_api *api =
1439 (
const struct uart_driver_api *)dev->
api;
1441 return api->rx_enable_u16(dev, buf, len, timeout);
1446 ARG_UNUSED(timeout);
1474#ifdef CONFIG_UART_ASYNC_API
1475 const struct uart_driver_api *api =
1476 (
const struct uart_driver_api *)dev->
api;
1478 return api->rx_buf_rsp(dev, buf, len);
1511#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1512 const struct uart_driver_api *api =
1513 (
const struct uart_driver_api *)dev->
api;
1515 return api->rx_buf_rsp_u16(dev, buf, len);
1541static inline int z_impl_uart_rx_disable(
const struct device *dev)
1543#ifdef CONFIG_UART_ASYNC_API
1544 const struct uart_driver_api *api =
1545 (
const struct uart_driver_api *)dev->
api;
1547 return api->rx_disable(dev);
1573static inline int z_impl_uart_line_ctrl_set(
const struct device *dev,
1576#ifdef CONFIG_UART_LINE_CTRL
1577 const struct uart_driver_api *api =
1578 (
const struct uart_driver_api *)dev->
api;
1580 if (api->line_ctrl_set == NULL) {
1583 return api->line_ctrl_set(dev, ctrl, val);
1607static inline int z_impl_uart_line_ctrl_get(
const struct device *dev,
1610#ifdef CONFIG_UART_LINE_CTRL
1611 const struct uart_driver_api *api =
1612 (
const struct uart_driver_api *)dev->
api;
1614 if (api->line_ctrl_get == NULL) {
1617 return api->line_ctrl_get(dev, ctrl, val);
1646#ifdef CONFIG_UART_DRV_CMD
1647 const struct uart_driver_api *api =
1648 (
const struct uart_driver_api *)dev->
api;
1650 if (api->drv_cmd == NULL) {
1653 return api->drv_cmd(dev,
cmd, p);
1670#include <syscalls/uart.h>
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
Function not implemented.
Definition: errno.h:83
#define ENOTSUP
Unsupported value.
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:1471
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:1508
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:320
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:1240
uart_event_type
Types of events passed to callback in UART_ASYNC_API.
Definition: uart.h:203
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:254
@ UART_TX_ABORTED
Transmitting aborted due to timeout or uart_tx_abort call.
Definition: uart.h:213
@ UART_RX_BUF_REQUEST
Driver requests next buffer for continuous reception.
Definition: uart.h:236
@ UART_TX_DONE
Whole TX buffer was transmitted.
Definition: uart.h:205
@ UART_RX_RDY
Received data is ready for processing.
Definition: uart.h:224
@ UART_RX_DISABLED
RX has been disabled and can be reenabled.
Definition: uart.h:248
@ UART_RX_BUF_RELEASED
Buffer is no longer used by UART driver.
Definition: uart.h:240
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
Data Terminal Ready (DTR)
Definition: uart.h:36
@ UART_LINE_CTRL_RTS
Request To Send (RTS)
Definition: uart.h:35
@ UART_LINE_CTRL_BAUD_RATE
Baud rate.
Definition: uart.h:34
@ UART_LINE_CTRL_DCD
Data Carrier Detect (DCD)
Definition: uart.h:37
@ UART_LINE_CTRL_DSR
Data Set Ready (DSR)
Definition: uart.h:38
@ UART_CFG_FLOW_CTRL_DTR_DSR
DTR/DSR flow control.
Definition: uart.h:112
@ UART_CFG_FLOW_CTRL_NONE
No flow control.
Definition: uart.h:110
@ UART_CFG_FLOW_CTRL_RS485
RS485 flow control.
Definition: uart.h:113
@ UART_CFG_FLOW_CTRL_RTS_CTS
RTS/CTS flow control.
Definition: uart.h:111
@ UART_CFG_PARITY_MARK
Mark parity.
Definition: uart.h:81
@ UART_CFG_PARITY_NONE
No parity.
Definition: uart.h:78
@ UART_CFG_PARITY_ODD
Odd parity.
Definition: uart.h:79
@ UART_CFG_PARITY_SPACE
Space parity.
Definition: uart.h:82
@ UART_CFG_PARITY_EVEN
Even parity.
Definition: uart.h:80
@ UART_CFG_DATA_BITS_5
5 data bits
Definition: uart.h:95
@ UART_CFG_DATA_BITS_8
8 data bits
Definition: uart.h:98
@ UART_CFG_DATA_BITS_7
7 data bits
Definition: uart.h:97
@ UART_CFG_DATA_BITS_6
6 data bits
Definition: uart.h:96
@ UART_CFG_DATA_BITS_9
9 data bits
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
1.5 stop bits
Definition: uart.h:89
@ UART_CFG_STOP_BITS_0_5
0.5 stop bit
Definition: uart.h:87
@ UART_CFG_STOP_BITS_1
1 stop bit
Definition: uart.h:88
@ UART_CFG_STOP_BITS_2
2 stop bits
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:837
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:918
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:1210
void(* uart_irq_config_func_t)(const struct device *dev)
For configuring IRQ on each individual UART device.
Definition: uart.h:147
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:996
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:754
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:796
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:1032
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:139
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:1175
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:713
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.
__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:387
const void * api
Address of the API structure exposed by the device instance.
Definition: device.h:393
UART controller configuration structure.
Definition: uart.h:119
uint8_t stop_bits
Stop bits, use uart_config_stop_bits.
Definition: uart.h:122
uint8_t parity
Parity bit, use uart_config_parity.
Definition: uart.h:121
uint8_t data_bits
Data bits, use uart_config_data_bits.
Definition: uart.h:123
uint32_t baudrate
Baudrate setting in bps.
Definition: uart.h:120
uint8_t flow_ctrl
Flow control setting, use uart_config_flow_control.
Definition: uart.h:124
UART RX buffer released event data.
Definition: uart.h:281
uint8_t * buf
Pointer to buffer that is no longer in use.
Definition: uart.h:283
UART RX stopped data.
Definition: uart.h:287
struct uart_event_rx data
Last received data.
Definition: uart.h:291
enum uart_rx_stop_reason reason
Reason why receiving stopped.
Definition: uart.h:289
UART RX event data.
Definition: uart.h:271
uint8_t * buf
Pointer to current buffer.
Definition: uart.h:273
size_t len
Number of new bytes received.
Definition: uart.h:277
size_t offset
Currently received data offset in bytes.
Definition: uart.h:275
UART TX event data.
Definition: uart.h:258
const uint8_t * buf
Pointer to current buffer.
Definition: uart.h:260
size_t len
Number of bytes sent.
Definition: uart.h:262
Structure containing information about current event.
Definition: uart.h:295
union uart_event::uart_event_data data
enum uart_event_type type
Type of event.
Definition: uart.h:297
Event data.
Definition: uart.h:299
struct uart_event_tx tx
UART_TX_DONE and UART_TX_ABORTED events data.
Definition: uart.h:301
struct uart_event_rx_stop rx_stop
UART_RX_STOPPED event data.
Definition: uart.h:307
struct uart_event_rx_buf rx_buf
UART_RX_BUF_RELEASED event data.
Definition: uart.h:305
struct uart_event_rx rx
UART_RX_RDY event data.
Definition: uart.h:303