uart.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2019 Nordic Semiconductor ASA
 * Copyright (c) 2015 Wind River Systems, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_UART_H_
#define ZEPHYR_INCLUDE_DRIVERS_UART_H_
 
#include <errno.h>
#include <stddef.h>
 
#include <device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum uart_line_ctrl {
        UART_LINE_CTRL_BAUD_RATE = BIT(0),
        UART_LINE_CTRL_RTS = BIT(1),
        UART_LINE_CTRL_DTR = BIT(2),
        UART_LINE_CTRL_DCD = BIT(3),
        UART_LINE_CTRL_DSR = BIT(4),
};
 
enum uart_rx_stop_reason {
        UART_ERROR_OVERRUN = (1 << 0),
        UART_ERROR_PARITY  = (1 << 1),
        UART_ERROR_FRAMING = (1 << 2),
        UART_BREAK = (1 << 3),
        UART_ERROR_COLLISION = (1 << 4),
};
 
enum uart_config_parity {
        UART_CFG_PARITY_NONE,
        UART_CFG_PARITY_ODD,
        UART_CFG_PARITY_EVEN,
        UART_CFG_PARITY_MARK,
        UART_CFG_PARITY_SPACE,
};
 
enum uart_config_stop_bits {
        UART_CFG_STOP_BITS_0_5,
        UART_CFG_STOP_BITS_1,
        UART_CFG_STOP_BITS_1_5,
        UART_CFG_STOP_BITS_2,
};
 
enum uart_config_data_bits {
        UART_CFG_DATA_BITS_5,
        UART_CFG_DATA_BITS_6,
        UART_CFG_DATA_BITS_7,
        UART_CFG_DATA_BITS_8,
        UART_CFG_DATA_BITS_9,
};
 
enum uart_config_flow_control {
        UART_CFG_FLOW_CTRL_NONE,
        UART_CFG_FLOW_CTRL_RTS_CTS,
        UART_CFG_FLOW_CTRL_DTR_DSR,
};
 
struct uart_config {
        uint32_t baudrate;
        uint8_t parity;
        uint8_t stop_bits;
        uint8_t data_bits;
        uint8_t flow_ctrl;
};
 
typedef void (*uart_irq_callback_user_data_t)(const struct device *dev,
                                              void *user_data);
 
typedef void (*uart_irq_config_func_t)(const struct device *dev);
 
enum uart_event_type {
        UART_TX_DONE,
        UART_TX_ABORTED,
        UART_RX_RDY,
        UART_RX_BUF_REQUEST,
        UART_RX_BUF_RELEASED,
        UART_RX_DISABLED,
        UART_RX_STOPPED,
};
 
struct uart_event_tx {
        const uint8_t *buf;
        size_t len;
};
 
struct uart_event_rx {
        uint8_t *buf;
        size_t offset;
        size_t len;
};
 
struct uart_event_rx_buf {
        /* @brief Pointer to buffer that is no longer in use. */
        uint8_t *buf;
};
 
struct uart_event_rx_stop {
        enum uart_rx_stop_reason reason;
        struct uart_event_rx data;
};
 
struct uart_event {
        enum uart_event_type type;
        union uart_event_data {
                struct uart_event_tx tx;
                struct uart_event_rx rx;
                struct uart_event_rx_buf rx_buf;
                struct uart_event_rx_stop rx_stop;
        } data;
};
 
typedef void (*uart_callback_t)(const struct device *dev,
                                struct uart_event *evt, void *user_data);
 
struct uart_device_config {
        union {
                uint32_t port;
                uint8_t *base;
                uint32_t regs;
        };
 
        uint32_t sys_clk_freq;
 
#if defined(CONFIG_UART_INTERRUPT_DRIVEN) || defined(CONFIG_UART_ASYNC_API)
        uart_irq_config_func_t  irq_config_func;
#endif
};
 
__subsystem struct uart_driver_api {
 
#ifdef CONFIG_UART_ASYNC_API
 
        int (*callback_set)(const struct device *dev,
                            uart_callback_t callback,
                            void *user_data);
 
        int (*tx)(const struct device *dev, const uint8_t *buf, size_t len,
                  int32_t timeout);
        int (*tx_abort)(const struct device *dev);
 
        int (*rx_enable)(const struct device *dev, uint8_t *buf, size_t len,
                         int32_t timeout);
        int (*rx_buf_rsp)(const struct device *dev, uint8_t *buf, size_t len);
        int (*rx_disable)(const struct device *dev);
 
#ifdef CONFIG_UART_WIDE_DATA
        int (*tx_u16)(const struct device *dev, const uint16_t *buf,
                      size_t len, int32_t timeout);
        int (*rx_enable_u16)(const struct device *dev, uint16_t *buf,
                             size_t len, int32_t timeout);
        int (*rx_buf_rsp_u16)(const struct device *dev, uint16_t *buf,
                              size_t len);
#endif
 
#endif
 
        int (*poll_in)(const struct device *dev, unsigned char *p_char);
        void (*poll_out)(const struct device *dev, unsigned char out_char);
 
#ifdef CONFIG_UART_WIDE_DATA
        int (*poll_in_u16)(const struct device *dev, uint16_t *p_u16);
        void (*poll_out_u16)(const struct device *dev, uint16_t out_u16);
#endif
 
        int (*err_check)(const struct device *dev);
 
        int (*configure)(const struct device *dev,
                         const struct uart_config *cfg);
        int (*config_get)(const struct device *dev, struct uart_config *cfg);
 
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
 
        int (*fifo_fill)(const struct device *dev, const uint8_t *tx_data,
                         int len);
 
#ifdef CONFIG_UART_WIDE_DATA
        int (*fifo_fill_u16)(const struct device *dev, const uint16_t *tx_data,
                             int len);
#endif
 
        int (*fifo_read)(const struct device *dev, uint8_t *rx_data,
                         const int size);
 
#ifdef CONFIG_UART_WIDE_DATA
        int (*fifo_read_u16)(const struct device *dev, uint16_t *rx_data,
                             const int size);
#endif
 
        void (*irq_tx_enable)(const struct device *dev);
 
        void (*irq_tx_disable)(const struct device *dev);
 
        int (*irq_tx_ready)(const struct device *dev);
 
        void (*irq_rx_enable)(const struct device *dev);
 
        void (*irq_rx_disable)(const struct device *dev);
 
        int (*irq_tx_complete)(const struct device *dev);
 
        int (*irq_rx_ready)(const struct device *dev);
 
        void (*irq_err_enable)(const struct device *dev);
 
        void (*irq_err_disable)(const struct device *dev);
 
        int (*irq_is_pending)(const struct device *dev);
 
        int (*irq_update)(const struct device *dev);
 
        void (*irq_callback_set)(const struct device *dev,
                                 uart_irq_callback_user_data_t cb,
                                 void *user_data);
 
#endif
 
#ifdef CONFIG_UART_LINE_CTRL
        int (*line_ctrl_set)(const struct device *dev, uint32_t ctrl,
                             uint32_t val);
        int (*line_ctrl_get)(const struct device *dev, uint32_t ctrl,
                             uint32_t *val);
#endif
 
#ifdef CONFIG_UART_DRV_CMD
        int (*drv_cmd)(const struct device *dev, uint32_t cmd, uint32_t p);
#endif
 
};
 
__syscall int uart_err_check(const struct device *dev);
 
static inline int z_impl_uart_err_check(const struct device *dev)
{
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->err_check == NULL) {
                return -ENOSYS;
        }
 
        return api->err_check(dev);
}
 
__syscall int uart_poll_in(const struct device *dev, unsigned char *p_char);
 
static inline int z_impl_uart_poll_in(const struct device *dev,
                                      unsigned char *p_char)
{
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->poll_in == NULL) {
                return -ENOSYS;
        }
 
        return api->poll_in(dev, p_char);
}
 
__syscall int uart_poll_in_u16(const struct device *dev, uint16_t *p_u16);
 
static inline int z_impl_uart_poll_in_u16(const struct device *dev,
                                          uint16_t *p_u16)
{
#ifdef CONFIG_UART_WIDE_DATA
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->poll_in_u16 == NULL) {
                return -ENOSYS;
        }
 
        return api->poll_in_u16(dev, p_u16);
#else
        return -ENOTSUP;
#endif
}
 
__syscall void uart_poll_out(const struct device *dev,
                             unsigned char out_char);
 
static inline void z_impl_uart_poll_out(const struct device *dev,
                                        unsigned char out_char)
{
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        api->poll_out(dev, out_char);
}
 
__syscall void uart_poll_out_u16(const struct device *dev, uint16_t out_u16);
 
static inline void z_impl_uart_poll_out_u16(const struct device *dev,
                                            uint16_t out_u16)
{
#ifdef CONFIG_UART_WIDE_DATA
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        api->poll_out_u16(dev, out_u16);
#endif
}
 
__syscall int uart_configure(const struct device *dev,
                             const struct uart_config *cfg);
 
static inline int z_impl_uart_configure(const struct device *dev,
                                        const struct uart_config *cfg)
{
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        if (api->configure == NULL) {
                return -ENOSYS;
        }
        return api->configure(dev, cfg);
}
 
__syscall int uart_config_get(const struct device *dev,
                              struct uart_config *cfg);
 
static inline int z_impl_uart_config_get(const struct device *dev,
                                         struct uart_config *cfg)
{
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        if (api->config_get == NULL) {
                return -ENOSYS;
        }
 
        return api->config_get(dev, cfg);
}
 
static inline int uart_fifo_fill(const struct device *dev,
                                 const uint8_t *tx_data,
                                 int size)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->fifo_fill == NULL) {
                return -ENOSYS;
        }
 
        return api->fifo_fill(dev, tx_data, size);
#endif
 
        return -ENOTSUP;
}
 
static inline int uart_fifo_fill_u16(const struct device *dev,
                                     const uint16_t *tx_data,
                                     int size)
{
#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->fifo_fill_u16 == NULL) {
                return -ENOSYS;
        }
 
        return api->fifo_fill_u16(dev, tx_data, size);
#else
        return -ENOTSUP;
#endif
}
 
static inline int uart_fifo_read(const struct device *dev, uint8_t *rx_data,
                                 const int size)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->fifo_read == NULL) {
                return -ENOSYS;
        }
 
        return api->fifo_read(dev, rx_data, size);
#endif
 
        return -ENOTSUP;
}
 
static inline int uart_fifo_read_u16(const struct device *dev,
                                     uint16_t *rx_data,
                                     const int size)
{
#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->fifo_read_u16 == NULL) {
                return -ENOSYS;
        }
 
        return api->fifo_read_u16(dev, rx_data, size);
#endif
 
        return -ENOTSUP;
}
 
__syscall void uart_irq_tx_enable(const struct device *dev);
 
static inline void z_impl_uart_irq_tx_enable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_tx_enable != NULL) {
                api->irq_tx_enable(dev);
        }
#endif
}
 
__syscall void uart_irq_tx_disable(const struct device *dev);
 
static inline void z_impl_uart_irq_tx_disable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_tx_disable != NULL) {
                api->irq_tx_disable(dev);
        }
#endif
}
 
static inline int uart_irq_tx_ready(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_tx_ready == NULL) {
                return -ENOSYS;
        }
 
        return api->irq_tx_ready(dev);
#endif
 
        return -ENOTSUP;
}
 
__syscall void uart_irq_rx_enable(const struct device *dev);
 
static inline void z_impl_uart_irq_rx_enable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_rx_enable != NULL) {
                api->irq_rx_enable(dev);
        }
#endif
}
 
__syscall void uart_irq_rx_disable(const struct device *dev);
 
static inline void z_impl_uart_irq_rx_disable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_rx_disable != NULL) {
                api->irq_rx_disable(dev);
        }
#endif
}
 
static inline int uart_irq_tx_complete(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_tx_complete == NULL) {
                return -ENOSYS;
        }
        return api->irq_tx_complete(dev);
#endif
        return -ENOTSUP;
 
}
 
static inline int uart_irq_rx_ready(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_rx_ready == NULL) {
                return -ENOSYS;
        }
        return api->irq_rx_ready(dev);
#endif
 
        return -ENOTSUP;
}
__syscall void uart_irq_err_enable(const struct device *dev);
 
static inline void z_impl_uart_irq_err_enable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_err_enable) {
                api->irq_err_enable(dev);
        }
#endif
}
 
__syscall void uart_irq_err_disable(const struct device *dev);
 
static inline void z_impl_uart_irq_err_disable(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_err_disable) {
                api->irq_err_disable(dev);
        }
#endif
}
 
__syscall int uart_irq_is_pending(const struct device *dev);
 
static inline int z_impl_uart_irq_is_pending(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_is_pending == NULL) {
                return -ENOSYS;
        }
        return api->irq_is_pending(dev);
#endif
        return -ENOTSUP;
}
 
__syscall int uart_irq_update(const struct device *dev);
 
static inline int z_impl_uart_irq_update(const struct device *dev)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->irq_update == NULL) {
                return -ENOSYS;
        }
        return api->irq_update(dev);
#endif
        return -ENOTSUP;
}
 
static inline void uart_irq_callback_user_data_set(const struct device *dev,
                                                   uart_irq_callback_user_data_t cb,
                                                   void *user_data)
{
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if ((api != NULL) && (api->irq_callback_set != NULL)) {
                api->irq_callback_set(dev, cb, user_data);
        }
#endif
}
 
static inline void uart_irq_callback_set(const struct device *dev,
                                         uart_irq_callback_user_data_t cb)
{
        uart_irq_callback_user_data_set(dev, cb, NULL);
}
 
static inline int uart_callback_set(const struct device *dev,
                                    uart_callback_t callback,
                                    void *user_data)
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                        (const struct uart_driver_api *)dev->api;
 
        if (api->callback_set == NULL) {
                return -ENOSYS;
        }
 
        return api->callback_set(dev, callback, user_data);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_tx(const struct device *dev, const uint8_t *buf,
                      size_t len,
                      int32_t timeout);
 
static inline int z_impl_uart_tx(const struct device *dev, const uint8_t *buf,
                                 size_t len, int32_t timeout)
 
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                        (const struct uart_driver_api *)dev->api;
 
        return api->tx(dev, buf, len, timeout);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_tx_u16(const struct device *dev, const uint16_t *buf,
                          size_t len, int32_t timeout);
 
static inline int z_impl_uart_tx_u16(const struct device *dev,
                                     const uint16_t *buf,
                                     size_t len, int32_t timeout)
 
{
#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
        const struct uart_driver_api *api =
                        (const struct uart_driver_api *)dev->api;
 
        return api->tx_u16(dev, buf, len, timeout);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_tx_abort(const struct device *dev);
 
static inline int z_impl_uart_tx_abort(const struct device *dev)
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                        (const struct uart_driver_api *)dev->api;
 
        return api->tx_abort(dev);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_rx_enable(const struct device *dev, uint8_t *buf,
                             size_t len,
                             int32_t timeout);
 
static inline int z_impl_uart_rx_enable(const struct device *dev,
                                        uint8_t *buf,
                                        size_t len, int32_t timeout)
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        return api->rx_enable(dev, buf, len, timeout);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_rx_enable_u16(const struct device *dev, uint16_t *buf,
                                 size_t len, int32_t timeout);
 
static inline int z_impl_uart_rx_enable_u16(const struct device *dev,
                                            uint16_t *buf, size_t len,
                                            int32_t timeout)
{
#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        return api->rx_enable_u16(dev, buf, len, timeout);
#else
        return -ENOTSUP;
#endif
}
 
static inline int uart_rx_buf_rsp(const struct device *dev, uint8_t *buf,
                                  size_t len)
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        return api->rx_buf_rsp(dev, buf, len);
#else
        return -ENOTSUP;
#endif
}
 
static inline int uart_rx_buf_rsp_u16(const struct device *dev, uint16_t *buf,
                                      size_t len)
{
#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
        const struct uart_driver_api *api =
                                (const struct uart_driver_api *)dev->api;
 
        return api->rx_buf_rsp_u16(dev, buf, len);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_rx_disable(const struct device *dev);
 
static inline int z_impl_uart_rx_disable(const struct device *dev)
{
#ifdef CONFIG_UART_ASYNC_API
        const struct uart_driver_api *api =
                        (const struct uart_driver_api *)dev->api;
 
        return api->rx_disable(dev);
#else
        return -ENOTSUP;
#endif
}
 
__syscall int uart_line_ctrl_set(const struct device *dev,
                                 uint32_t ctrl, uint32_t val);
 
static inline int z_impl_uart_line_ctrl_set(const struct device *dev,
                                            uint32_t ctrl, uint32_t val)
{
#ifdef CONFIG_UART_LINE_CTRL
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->line_ctrl_set == NULL) {
                return -ENOSYS;
        }
        return api->line_ctrl_set(dev, ctrl, val);
#endif
 
        return -ENOTSUP;
}
 
__syscall int uart_line_ctrl_get(const struct device *dev, uint32_t ctrl,
                                 uint32_t *val);
 
static inline int z_impl_uart_line_ctrl_get(const struct device *dev,
                                            uint32_t ctrl, uint32_t *val)
{
#ifdef CONFIG_UART_LINE_CTRL
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->line_ctrl_get == NULL) {
                return -ENOSYS;
        }
        return api->line_ctrl_get(dev, ctrl, val);
#endif
 
        return -ENOTSUP;
}
 
__syscall int uart_drv_cmd(const struct device *dev, uint32_t cmd, uint32_t p);
 
static inline int z_impl_uart_drv_cmd(const struct device *dev, uint32_t cmd,
                                      uint32_t p)
{
#ifdef CONFIG_UART_DRV_CMD
        const struct uart_driver_api *api =
                (const struct uart_driver_api *)dev->api;
 
        if (api->drv_cmd == NULL) {
                return -ENOSYS;
        }
        return api->drv_cmd(dev, cmd, p);
#endif
 
        return -ENOTSUP;
}
 
#ifdef __cplusplus
}
#endif
 
#include <syscalls/uart.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_UART_H_ */