13#ifndef ZEPHYR_INCLUDE_DRIVERS_UART_H_
14#define ZEPHYR_INCLUDE_DRIVERS_UART_H_
347__subsystem
struct uart_driver_api {
349#ifdef CONFIG_UART_ASYNC_API
351 int (*callback_set)(
const struct device *dev,
355 int (*tx)(
const struct device *dev,
const uint8_t *buf,
size_t len,
357 int (*tx_abort)(
const struct device *dev);
359 int (*rx_enable)(
const struct device *dev,
uint8_t *buf,
size_t len,
361 int (*rx_buf_rsp)(
const struct device *dev,
uint8_t *buf,
size_t len);
362 int (*rx_disable)(
const struct device *dev);
364#ifdef CONFIG_UART_WIDE_DATA
376 int (*poll_in)(
const struct device *dev,
unsigned char *p_char);
377 void (*poll_out)(
const struct device *dev,
unsigned char out_char);
379#ifdef CONFIG_UART_WIDE_DATA
385 int (*err_check)(
const struct device *dev);
388 int (*configure)(
const struct device *dev,
392#ifdef CONFIG_UART_INTERRUPT_DRIVEN
395 int (*fifo_fill)(
const struct device *dev,
const uint8_t *tx_data,
398#ifdef CONFIG_UART_WIDE_DATA
399 int (*fifo_fill_u16)(
const struct device *dev,
const uint16_t *tx_data,
407#ifdef CONFIG_UART_WIDE_DATA
413 void (*irq_tx_enable)(
const struct device *dev);
416 void (*irq_tx_disable)(
const struct device *dev);
419 int (*irq_tx_ready)(
const struct device *dev);
422 void (*irq_rx_enable)(
const struct device *dev);
425 void (*irq_rx_disable)(
const struct device *dev);
428 int (*irq_tx_complete)(
const struct device *dev);
431 int (*irq_rx_ready)(
const struct device *dev);
434 void (*irq_err_enable)(
const struct device *dev);
437 void (*irq_err_disable)(
const struct device *dev);
440 int (*irq_is_pending)(
const struct device *dev);
443 int (*irq_update)(
const struct device *dev);
446 void (*irq_callback_set)(
const struct device *dev,
452#ifdef CONFIG_UART_LINE_CTRL
459#ifdef CONFIG_UART_DRV_CMD
478static inline int z_impl_uart_err_check(
const struct device *dev)
480 const struct uart_driver_api *api =
481 (
const struct uart_driver_api *)dev->
api;
483 if (api->err_check == NULL) {
487 return api->err_check(dev);
515static inline int z_impl_uart_poll_in(
const struct device *dev,
516 unsigned char *p_char)
518 const struct uart_driver_api *api =
519 (
const struct uart_driver_api *)dev->
api;
521 if (api->poll_in == NULL) {
525 return api->poll_in(dev, p_char);
549static inline int z_impl_uart_poll_in_u16(
const struct device *dev,
552#ifdef CONFIG_UART_WIDE_DATA
553 const struct uart_driver_api *api =
554 (
const struct uart_driver_api *)dev->
api;
556 if (api->poll_in_u16 == NULL) {
560 return api->poll_in_u16(dev, p_u16);
583 unsigned char out_char);
585static inline void z_impl_uart_poll_out(
const struct device *dev,
586 unsigned char out_char)
588 const struct uart_driver_api *api =
589 (
const struct uart_driver_api *)dev->
api;
591 api->poll_out(dev, out_char);
610static inline void z_impl_uart_poll_out_u16(
const struct device *dev,
613#ifdef CONFIG_UART_WIDE_DATA
614 const struct uart_driver_api *api =
615 (
const struct uart_driver_api *)dev->
api;
617 api->poll_out_u16(dev, out_u16);
644static inline int z_impl_uart_configure(
const struct device *dev,
647 const struct uart_driver_api *api =
648 (
const struct uart_driver_api *)dev->
api;
650 if (api->configure == NULL) {
653 return api->configure(dev, cfg);
672static inline int z_impl_uart_config_get(
const struct device *dev,
675 const struct uart_driver_api *api =
676 (
const struct uart_driver_api *)dev->
api;
678 if (api->config_get == NULL) {
682 return api->config_get(dev, cfg);
714#ifdef CONFIG_UART_INTERRUPT_DRIVEN
715 const struct uart_driver_api *api =
716 (
const struct uart_driver_api *)dev->
api;
718 if (api->fifo_fill == NULL) {
722 return api->fifo_fill(dev, tx_data, size);
755#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
756 const struct uart_driver_api *api =
757 (
const struct uart_driver_api *)dev->
api;
759 if (api->fifo_fill_u16 == NULL) {
763 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);
844#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
845 const struct uart_driver_api *api =
846 (
const struct uart_driver_api *)dev->
api;
848 if (api->fifo_read_u16 == NULL) {
852 return api->fifo_read_u16(dev, rx_data, size);
868static inline void z_impl_uart_irq_tx_enable(
const struct device *dev)
870#ifdef CONFIG_UART_INTERRUPT_DRIVEN
871 const struct uart_driver_api *api =
872 (
const struct uart_driver_api *)dev->
api;
874 if (api->irq_tx_enable != NULL) {
875 api->irq_tx_enable(dev);
889static inline void z_impl_uart_irq_tx_disable(
const struct device *dev)
891#ifdef CONFIG_UART_INTERRUPT_DRIVEN
892 const struct uart_driver_api *api =
893 (
const struct uart_driver_api *)dev->
api;
895 if (api->irq_tx_disable != NULL) {
896 api->irq_tx_disable(dev);
923#ifdef CONFIG_UART_INTERRUPT_DRIVEN
924 const struct uart_driver_api *api =
925 (
const struct uart_driver_api *)dev->
api;
927 if (api->irq_tx_ready == NULL) {
931 return api->irq_tx_ready(dev);
945static inline void z_impl_uart_irq_rx_enable(
const struct device *dev)
947#ifdef CONFIG_UART_INTERRUPT_DRIVEN
948 const struct uart_driver_api *api =
949 (
const struct uart_driver_api *)dev->
api;
951 if (api->irq_rx_enable != NULL) {
952 api->irq_rx_enable(dev);
966static inline void z_impl_uart_irq_rx_disable(
const struct device *dev)
968#ifdef CONFIG_UART_INTERRUPT_DRIVEN
969 const struct uart_driver_api *api =
970 (
const struct uart_driver_api *)dev->
api;
972 if (api->irq_rx_disable != NULL) {
973 api->irq_rx_disable(dev);
1001#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1002 const struct uart_driver_api *api =
1003 (
const struct uart_driver_api *)dev->
api;
1005 if (api->irq_tx_complete == NULL) {
1008 return api->irq_tx_complete(dev);
1037#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1038 const struct uart_driver_api *api =
1039 (
const struct uart_driver_api *)dev->
api;
1041 if (api->irq_rx_ready == NULL) {
1044 return api->irq_rx_ready(dev);
1057static inline void z_impl_uart_irq_err_enable(
const struct device *dev)
1059#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1060 const struct uart_driver_api *api =
1061 (
const struct uart_driver_api *)dev->
api;
1063 if (api->irq_err_enable) {
1064 api->irq_err_enable(dev);
1078static inline void z_impl_uart_irq_err_disable(
const struct device *dev)
1080#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1081 const struct uart_driver_api *api =
1082 (
const struct uart_driver_api *)dev->
api;
1084 if (api->irq_err_disable) {
1085 api->irq_err_disable(dev);
1104static inline int z_impl_uart_irq_is_pending(
const struct device *dev)
1106#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1107 const struct uart_driver_api *api =
1108 (
const struct uart_driver_api *)dev->
api;
1110 if (api->irq_is_pending == NULL) {
1113 return api->irq_is_pending(dev);
1147static inline int z_impl_uart_irq_update(
const struct device *dev)
1149#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1150 const struct uart_driver_api *api =
1151 (
const struct uart_driver_api *)dev->
api;
1153 if (api->irq_update == NULL) {
1156 return api->irq_update(dev);
1178#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1179 const struct uart_driver_api *api =
1180 (
const struct uart_driver_api *)dev->
api;
1182 if ((api != NULL) && (api->irq_callback_set != NULL)) {
1183 api->irq_callback_set(dev, cb,
user_data);
1235#ifdef CONFIG_UART_ASYNC_API
1236 const struct uart_driver_api *api =
1237 (
const struct uart_driver_api *)dev->
api;
1239 if (api->callback_set == NULL) {
1243 return api->callback_set(dev, callback,
user_data);
1246 ARG_UNUSED(callback);
1273static inline int z_impl_uart_tx(
const struct device *dev,
const uint8_t *buf,
1277#ifdef CONFIG_UART_ASYNC_API
1278 const struct uart_driver_api *api =
1279 (
const struct uart_driver_api *)dev->
api;
1281 return api->tx(dev, buf, len,
timeout);
1311static inline int z_impl_uart_tx_u16(
const struct device *dev,
1316#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1317 const struct uart_driver_api *api =
1318 (
const struct uart_driver_api *)dev->
api;
1320 return api->tx_u16(dev, buf, len,
timeout);
1345static inline int z_impl_uart_tx_abort(
const struct device *dev)
1347#ifdef CONFIG_UART_ASYNC_API
1348 const struct uart_driver_api *api =
1349 (
const struct uart_driver_api *)dev->
api;
1351 return api->tx_abort(dev);
1384static inline int z_impl_uart_rx_enable(
const struct device *dev,
1388#ifdef CONFIG_UART_ASYNC_API
1389 const struct uart_driver_api *api =
1390 (
const struct uart_driver_api *)dev->
api;
1392 return api->rx_enable(dev, buf, len,
timeout);
1427static inline int z_impl_uart_rx_enable_u16(
const struct device *dev,
1431#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1432 const struct uart_driver_api *api =
1433 (
const struct uart_driver_api *)dev->
api;
1435 return api->rx_enable_u16(dev, buf, len,
timeout);
1469#ifdef CONFIG_UART_ASYNC_API
1470 const struct uart_driver_api *api =
1471 (
const struct uart_driver_api *)dev->
api;
1473 return api->rx_buf_rsp(dev, buf, len);
1506#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1507 const struct uart_driver_api *api =
1508 (
const struct uart_driver_api *)dev->
api;
1510 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_event_type::UART_RX_BUF_REQUEST event.
Definition: uart.h:1466
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_event_type::UART_RX_BUF_REQUEST event.
Definition: uart.h:1503
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:333
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:1231
uart_event_type
Types of events passed to callback in UART_ASYNC_API.
Definition: uart.h:211
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:263
@ UART_TX_ABORTED
Transmitting aborted due to timeout or uart_tx_abort call.
Definition: uart.h:221
@ UART_RX_BUF_REQUEST
Driver requests next buffer for continuous reception.
Definition: uart.h:245
@ UART_TX_DONE
Whole TX buffer was transmitted.
Definition: uart.h:213
@ UART_RX_RDY
Received data is ready for processing.
Definition: uart.h:233
@ UART_RX_DISABLED
RX has been disabled and can be reenabled.
Definition: uart.h:257
@ UART_RX_BUF_RELEASED
Buffer is no longer used by UART driver.
Definition: uart.h:249
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:107
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:75
uart_config_data_bits
Number of data bits.
Definition: uart.h:92
uart_rx_stop_reason
Reception stop reasons.
Definition: uart.h:47
uart_config_stop_bits
Number of stop bits.
Definition: uart.h:84
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:110
@ UART_CFG_FLOW_CTRL_NONE
Definition: uart.h:108
@ UART_CFG_FLOW_CTRL_RTS_CTS
Definition: uart.h:109
@ UART_CFG_PARITY_MARK
Definition: uart.h:79
@ UART_CFG_PARITY_NONE
Definition: uart.h:76
@ UART_CFG_PARITY_ODD
Definition: uart.h:77
@ UART_CFG_PARITY_SPACE
Definition: uart.h:80
@ UART_CFG_PARITY_EVEN
Definition: uart.h:78
@ UART_CFG_DATA_BITS_5
Definition: uart.h:93
@ UART_CFG_DATA_BITS_8
Definition: uart.h:96
@ UART_CFG_DATA_BITS_7
Definition: uart.h:95
@ UART_CFG_DATA_BITS_6
Definition: uart.h:94
@ UART_CFG_DATA_BITS_9
Definition: uart.h:97
@ 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:87
@ UART_CFG_STOP_BITS_0_5
Definition: uart.h:85
@ UART_CFG_STOP_BITS_1
Definition: uart.h:86
@ UART_CFG_STOP_BITS_2
Definition: uart.h:88
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:840
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:921
void(* uart_irq_config_func_t)(const struct device *dev)
For configuring IRQ on each individual UART device.
Definition: uart.h:150
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:999
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:751
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 void 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:1201
static int uart_irq_rx_ready(const struct device *dev)
Check if UART RX buffer has a received char.
Definition: uart.h:1035
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:142
static void 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:1174
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:710
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:435
const void * api
Definition: device.h:441
UART controller configuration structure.
Definition: uart.h:122
uint8_t stop_bits
Definition: uart.h:125
uint8_t parity
Definition: uart.h:124
uint8_t data_bits
Definition: uart.h:126
uint32_t baudrate
Definition: uart.h:123
uint8_t flow_ctrl
Definition: uart.h:127
UART RX buffer released event data.
Definition: uart.h:290
uint8_t * buf
Definition: uart.h:292
UART RX stopped data.
Definition: uart.h:296
struct uart_event_rx data
Last received data.
Definition: uart.h:300
enum uart_rx_stop_reason reason
Reason why receiving stopped.
Definition: uart.h:298
UART RX event data.
Definition: uart.h:280
uint8_t * buf
Pointer to current buffer.
Definition: uart.h:282
size_t len
Number of new bytes received.
Definition: uart.h:286
size_t offset
Currently received data offset in bytes.
Definition: uart.h:284
UART TX event data.
Definition: uart.h:267
const uint8_t * buf
Pointer to current buffer.
Definition: uart.h:269
size_t len
Number of bytes sent.
Definition: uart.h:271
Structure containing information about current event.
Definition: uart.h:304
union uart_event::uart_event_data data
enum uart_event_type type
Type of event.
Definition: uart.h:306
static const intptr_t user_data[5]
Definition: main.c:588
Event data.
Definition: uart.h:308
struct uart_event_tx tx
uart_event_type::UART_TX_DONE and uart_event_type::UART_TX_ABORTED events data.
Definition: uart.h:312
struct uart_event_rx_stop rx_stop
uart_event_type::UART_RX_STOPPED event data.
Definition: uart.h:320
struct uart_event_rx_buf rx_buf
uart_event_type::UART_RX_BUF_RELEASED event data.
Definition: uart.h:318
struct uart_event_rx rx
uart_event_type::UART_RX_RDY event data.
Definition: uart.h:314