first

rt-thread/components/drivers/serial/Kconfig

@@ -0,0 +1,24 @@
+menuconfig RT_USING_SERIAL
+    bool "USING Serial device drivers"
+    select RT_USING_DEVICE_IPC
+    select RT_USING_DEVICE
+    default y
+
+    if RT_USING_SERIAL
+        choice
+            prompt "Choice Serial version"
+            default RT_USING_SERIAL_V1
+            config RT_USING_SERIAL_V1
+                bool "RT_USING_SERIAL_V1"
+            config RT_USING_SERIAL_V2
+                bool "RT_USING_SERIAL_V2"
+        endchoice
+        config RT_SERIAL_USING_DMA
+            bool "Enable serial DMA mode"
+            default y
+
+        config RT_SERIAL_RB_BUFSZ
+            int "Set RX buffer size"
+            depends on !RT_USING_SERIAL_V2
+            default 64
+    endif

rt-thread/components/drivers/serial/SConscript

@@ -0,0 +1,24 @@
+from building import *
+
+cwd = GetCurrentDir()
+CPPPATH = [cwd + '/../include']
+group = []
+src = []
+
+if not GetDepend(['RT_USING_SERIAL']):
+    Return('group')
+
+if GetDepend(['RT_USING_SMART']):
+    src += Glob('serial_tty.c')
+
+if GetDepend(['RT_USING_SERIAL_V2']):
+    src += ['serial_v2.c']
+else:
+    src += ['serial.c']
+
+if GetDepend(['RT_USING_DM']):
+    src += ['serial_dm.c']
+
+group = DefineGroup('DeviceDrivers', src, depend = [''], CPPPATH = CPPPATH)
+
+Return('group')

rt-thread/components/drivers/serial/serial_dm.c

@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2006-2022, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2022-11-16     GuEe-GUI     first version
+ */
+
+#include <rtatomic.h>
+#include <drivers/serial_dm.h>
+
+static int uid_min = -1;
+static volatile rt_atomic_t uid = 0;
+
+int serial_dev_set_name(struct rt_serial_device *sdev)
+{
+    int id = -1;
+
+    RT_ASSERT(sdev != RT_NULL);
+
+#ifdef RT_USING_OFW
+    if (sdev->parent.ofw_node)
+    {
+        id = rt_ofw_get_alias_id(sdev->parent.ofw_node, "serial");
+
+        if (id < 0)
+        {
+            id = rt_ofw_get_alias_id(sdev->parent.ofw_node, "uart");
+        }
+    }
+#endif
+
+    if (id < 0)
+    {
+        id = (int)rt_hw_atomic_add(&uid, 1);
+    }
+
+    return rt_dm_dev_set_name(&sdev->parent, "uart%u", id);
+}
+
+static int serial_dm_naming_framework_init(void)
+{
+#ifdef RT_USING_OFW
+    uid_min = rt_ofw_get_alias_last_id("serial");
+
+    if (uid_min < 0)
+    {
+        uid_min = rt_ofw_get_alias_last_id("uart");
+    }
+
+    uid_min = uid_min < 0 ? 0 : (uid_min + 1);
+
+    rt_hw_atomic_store(&uid, uid_min);
+#endif
+
+    return 0;
+}
+INIT_PLATFORM_EXPORT(serial_dm_naming_framework_init);
+
+void *serial_base_from_args(char *str)
+{
+    rt_ubase_t base = 0;
+
+    while (*str && !(*str == 'x' || *str == 'X'))
+    {
+        ++str;
+    }
+    ++str;
+
+    /* The str may get from bootargs that we need check it */
+    while (*str)
+    {
+        if ((*str >= 'a' && *str <= 'f') || (*str >= 'A' && *str <= 'F'))
+        {
+            base = (base << 4) | (((*str | ' ') - 'a') + 10);
+        }
+        else if (*str >= '0' && *str <= '9')
+        {
+            base = (base << 4) | (*str - '0');
+        }
+        else break;
+
+        ++str;
+    }
+
+    return (void *)base;
+}
+
+struct serial_configure serial_cfg_from_args(char *_str)
+{
+    char *str = _str;
+    struct serial_configure cfg = RT_SERIAL_CONFIG_DEFAULT;
+
+    /* Format baudrate/parity/bits/flow (BBBBPNF), Default is 115200n8 */
+    if (str && *str)
+    {
+        rt_uint32_t baudrate = 0;
+
+        /* BBBB is the speed */
+        while (*str && (*str >= '0' && *str <= '9'))
+        {
+            baudrate *= 10;
+            baudrate += *str - '0';
+            ++str;
+        }
+
+        if (baudrate)
+        {
+            cfg.baud_rate = baudrate;
+        }
+
+        /* P is parity (n/o/e) */
+        switch (*str)
+        {
+        case 'n':
+            cfg.parity = PARITY_NONE;
+            break;
+        case 'o':
+            cfg.parity = PARITY_ODD;
+            break;
+        case 'e':
+            cfg.parity = PARITY_EVEN;
+            break;
+        default:
+            --str;
+            break;
+        }
+        ++str;
+
+        /* N is number of bits */
+        if (*str && (*str >= '0' && *str <= '9'))
+        {
+            cfg.data_bits = *str - '0';
+            ++str;
+        }
+
+        /* F is flow ontrol ('r' for RTS) */
+        if (*str)
+        {
+            cfg.flowcontrol = (*str == 'r' ? RT_SERIAL_FLOWCONTROL_CTSRTS : RT_SERIAL_FLOWCONTROL_NONE);
+            ++str;
+        }
+
+    #ifdef RT_USING_OFW
+        if (*str == '\0')
+        {
+            const char earlycon_magic[] = { 'O', 'F', 'W', '\0' };
+
+            if (!rt_strcmp(++str, earlycon_magic))
+            {
+                /* Is OFW earlycon, we should ACK it */
+                rt_memset(str, 0, RT_ARRAY_SIZE(earlycon_magic));
+            }
+        }
+    #endif
+    }
+
+    return cfg;
+}

rt-thread/components/drivers/serial/serial_tty.c

@@ -0,0 +1,479 @@
+/*
+ * Copyright (c) 2006-2023, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2023-11-21     Shell        init ver.
+ */
+
+#define DBG_TAG "drivers.serial"
+#define DBG_LVL DBG_INFO
+#include <rtdbg.h>
+
+#include <rthw.h>
+#include <rtthread.h>
+#include <rtdevice.h>
+#include <terminal/terminal.h>
+
+#define TTY_NAME_PREFIX "S" /* (S)erial */
+#define LWP_TTY_WORKQUEUE_PRIORITY 3
+
+struct serial_tty_context
+{
+    struct rt_serial_device *parent;
+    struct rt_device_notify backup_notify;
+    struct rt_work work;
+};
+
+static struct rt_workqueue *_ttyworkq; /* system work queue */
+
+#ifndef RT_USING_DM
+static rt_atomic_t _device_id_counter = 0;
+
+static long get_dec_digits(rt_ubase_t val)
+{
+    long result = 1;
+    while (1)
+    {
+        if (val < 10)
+            return result;
+        if (val < 100)
+            return result + 1;
+        if (val < 1000)
+            return result + 2;
+        if (val < 10000)
+            return result + 3;
+        val /= 10000U;
+        result += 4;
+    }
+    return result;
+}
+#endif
+
+static char *alloc_device_name(struct rt_serial_device *serial)
+{
+    char *tty_dev_name;
+#ifdef RT_USING_DM
+    char *serial_name = serial->parent.parent.name;
+    /*
+     * if RT_USING_DM is defined, the name of the serial device
+     * must be obtained using the serial_dev_set_name function,
+     * and it should begin with "uart".
+     */
+    RT_ASSERT((strlen(serial_name) > strlen("uart")) && (strncmp(serial_name, "uart", 4) == 0));
+    long digits_len = (sizeof(TTY_NAME_PREFIX) - 1) /* raw prefix */
+                      + strlen(serial_name + sizeof("uart") - 1) /* suffix of serial device name*/
+                      + 1;  /* tailing \0 */
+
+    tty_dev_name = rt_malloc(digits_len);
+    if (tty_dev_name)
+        rt_sprintf(tty_dev_name, "%s%s", TTY_NAME_PREFIX, serial_name + sizeof("uart") - 1);
+#else
+    RT_UNUSED(serial);
+    unsigned int devid = rt_atomic_add(&_device_id_counter, 1);
+    long digits_len = (sizeof(TTY_NAME_PREFIX) - 1) /* raw prefix */
+                      + get_dec_digits(devid) + 1;  /* tailing \0 */
+
+    tty_dev_name = rt_malloc(digits_len);
+    if (tty_dev_name)
+        rt_sprintf(tty_dev_name, "%s%u", TTY_NAME_PREFIX, devid);
+#endif
+    return tty_dev_name;
+}
+
+#ifdef LWP_DEBUG_INIT
+static volatile int _early_input = 0;
+
+static void _set_debug(rt_device_t dev, rt_size_t size);
+RT_OBJECT_HOOKLIST_DEFINE_NODE(rt_hw_serial_rxind, _set_debug_node, _set_debug);
+
+static void _set_debug(rt_device_t dev, rt_size_t size)
+{
+    rt_list_remove(&_set_debug_node.list_node);
+    _early_input = 1;
+}
+
+static void _setup_debug_rxind_hook(void)
+{
+    rt_hw_serial_rxind_sethook(&_set_debug_node);
+}
+
+int lwp_startup_debug_request(void)
+{
+    return _early_input;
+}
+
+#else /* !LWP_DEBUG_INIT */
+
+static void _setup_debug_rxind_hook(void)
+{
+    return ;
+}
+
+#endif /* LWP_DEBUG_INIT */
+
+static void _tty_rx_notify(struct rt_device *device)
+{
+    lwp_tty_t tp;
+    struct serial_tty_context *softc;
+
+    tp = rt_container_of(device, struct lwp_tty, parent);
+    RT_ASSERT(tp);
+
+    softc = tty_softc(tp);
+
+    if (_ttyworkq)
+        rt_workqueue_submit_work(_ttyworkq, &softc->work, 0);
+}
+
+static void _tty_rx_worker(struct rt_work *work, void *data)
+{
+    char input;
+    rt_ssize_t readbytes;
+    lwp_tty_t tp = data;
+    struct serial_tty_context *softc;
+    struct rt_serial_device *serial;
+
+    tty_lock(tp);
+
+    while (1)
+    {
+        softc = tty_softc(tp);
+        serial = softc->parent;
+        readbytes = rt_device_read(&serial->parent, -1, &input, 1);
+        if (readbytes != 1)
+        {
+            break;
+        }
+
+        ttydisc_rint(tp, input, 0);
+    }
+
+    ttydisc_rint_done(tp);
+    tty_unlock(tp);
+}
+
+rt_inline void _setup_serial(struct rt_serial_device *serial, lwp_tty_t tp,
+                             struct serial_tty_context *softc)
+{
+    struct rt_device_notify notify;
+
+    softc->backup_notify = serial->rx_notify;
+    notify.dev = &tp->parent;
+    notify.notify = _tty_rx_notify;
+
+    rt_device_init(&serial->parent);
+
+    rt_device_control(&serial->parent, RT_DEVICE_CTRL_NOTIFY_SET, &notify);
+}
+
+rt_inline void _restore_serial(struct rt_serial_device *serial, lwp_tty_t tp,
+                               struct serial_tty_context *softc)
+{
+    rt_device_control(&serial->parent, RT_DEVICE_CTRL_NOTIFY_SET, &softc->backup_notify);
+}
+
+static void _serial_tty_set_speed(struct lwp_tty *tp)
+{
+    struct serial_tty_context *softc = (struct serial_tty_context *)(tp->t_devswsoftc);
+    struct rt_serial_device *serial;
+    struct termios serial_hw_config;
+
+    RT_ASSERT(softc);
+    serial = softc->parent;
+
+    rt_device_control(&(serial->parent), TCGETS, &serial_hw_config);
+    tp->t_termios_init_in.c_cflag |= serial_hw_config.c_cflag;
+
+    tp->t_termios_init_in.__c_ispeed = tp->t_termios_init_in.__c_ospeed = cfgetospeed(&tp->t_termios_init_in);
+}
+
+static int _serial_isbusy(struct rt_serial_device *serial)
+{
+    rt_thread_t user_thread = rt_console_current_user();
+    rt_thread_t self_thread = rt_thread_self();
+
+    return rt_console_get_device() == &serial->parent &&
+           (user_thread != RT_NULL && user_thread != self_thread);
+}
+
+static void serial_tty_outwakeup(struct lwp_tty *tp)
+{
+    char out_char;
+    int len;
+    struct serial_tty_context *context = tty_softc(tp);
+    struct rt_serial_device *device;
+
+    if (!context || !context->parent)
+    {
+        LOG_E("%s: Data corruption", __func__);
+        return;
+    }
+
+    device = context->parent;
+
+    if (_serial_isbusy(device))
+    {
+        return ;
+    }
+
+    while ((len = ttydisc_getc(tp, &out_char, sizeof(out_char))) != 0)
+    {
+        device->ops->putc(device, out_char);
+
+        /* discard remaining if emergency output is happened */
+        if (_serial_isbusy(device))
+        {
+            break;
+        }
+    }
+}
+
+static int serial_tty_open(struct lwp_tty *tp)
+{
+    struct serial_tty_context *softc;
+    struct rt_serial_device *serial;
+    rt_err_t error;
+    int oflags;
+
+    softc = tty_softc(tp);
+    serial = softc->parent;
+
+    LOG_D("%s", __func__);
+
+    rt_device_control(&serial->parent, RT_DEVICE_CTRL_CONSOLE_OFLAG, &oflags);
+
+    error = rt_device_open(&serial->parent, oflags);
+
+    if (!error)
+    {
+        /**
+         * to avoid driver accesssing null data,
+         * these are setup only after tty is registered
+         */
+        _setup_serial(serial, tp, softc);
+    }
+    return error;
+}
+
+static void serial_tty_close(struct lwp_tty *tp)
+{
+    struct serial_tty_context *softc;
+    struct rt_serial_device *serial;
+    softc = tty_softc(tp);
+    serial = softc->parent;
+
+    LOG_D("%s", __func__);
+
+    _restore_serial(serial, tp, softc);
+    rt_device_close(&serial->parent);
+}
+
+static int serial_tty_ioctl(struct lwp_tty *tp, rt_ubase_t cmd, rt_caddr_t data,
+                            struct rt_thread *td)
+{
+    int error;
+    switch (cmd)
+    {
+        default:
+            /**
+             * Note: for the most case, we don't let serial layer handle ioctl,
+             * for that they can't act properly regarding to the process
+             * management system, since it is unawared of that. So a ENOSYS is
+             * returned and caused the TTY layer to handle ioctl itself.
+             */
+            error = -ENOSYS;
+            break;
+    }
+    return error;
+}
+
+static int serial_tty_param(struct lwp_tty *tp, struct termios *t)
+{
+    struct serial_tty_context *softc = (struct serial_tty_context *)(tp->t_devswsoftc);
+    struct rt_serial_device *serial;
+
+    RT_ASSERT(softc);
+    serial = softc->parent;
+
+    if (!tty_opened(tp))
+    {
+        /**
+         * skip configure on open since all configs are copied from the current
+         * configuration on device. So we don't bother to set it back to device
+         * again.
+         */
+        return RT_EOK;
+    }
+
+    cfsetispeed(t, t->__c_ispeed);
+    return rt_device_control(&(serial->parent), TCSETS, t);
+}
+
+static struct lwp_ttydevsw serial_ttydevsw = {
+    .tsw_open = serial_tty_open,
+    .tsw_close = serial_tty_close,
+    .tsw_ioctl = serial_tty_ioctl,
+    .tsw_param = serial_tty_param,
+    .tsw_outwakeup = serial_tty_outwakeup,
+};
+
+rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial)
+{
+    rt_err_t rc;
+    lwp_tty_t tty;
+    char *dev_name;
+    struct serial_tty_context *softc;
+
+    if (serial->rx_notify.dev)
+    {
+        return -RT_EBUSY;
+    }
+
+    softc = rt_malloc(sizeof(struct serial_tty_context));
+    if (softc)
+    {
+        dev_name = alloc_device_name(serial);
+
+        if (dev_name)
+        {
+            softc->parent = serial;
+            tty = lwp_tty_create(&serial_ttydevsw, softc);
+            if (tty)
+            {
+                _serial_tty_set_speed(tty);
+                rc = lwp_tty_register(tty, dev_name);
+                rt_work_init(&softc->work, _tty_rx_worker, tty);
+
+                if (rc != RT_EOK)
+                {
+                    rt_free(tty);
+                    rt_free(softc);
+                }
+            }
+            else
+            {
+                rt_free(softc);
+                rc = -RT_ENOMEM;
+            }
+
+            rt_free(dev_name);
+        }
+        else
+        {
+            rt_free(softc);
+            rc = -RT_ENOMEM;
+        }
+    }
+    else
+    {
+        rc = -RT_ENOMEM;
+    }
+
+    return rc;
+}
+
+rt_err_t rt_hw_serial_unregister_tty(struct rt_serial_device *serial)
+{
+    rt_device_t tty_dev;
+    lwp_tty_t tp;
+    struct serial_tty_context *softc;
+
+    tty_dev = serial->rx_notify.dev;
+    tp = rt_container_of(tty_dev, struct lwp_tty, parent);
+
+    /* restore serial setting */
+    softc = tty_softc(tp);
+    serial->rx_notify = softc->backup_notify;
+
+    tty_lock(tp);
+
+    tty_rel_gone(tp);
+
+    /* device unregister? */
+    rt_device_destroy(&tp->parent);
+    /* resource free? */
+    lwp_tty_delete(tp);
+
+    return RT_EOK;
+}
+
+static int _tty_workqueue_init(void)
+{
+    if (_ttyworkq != RT_NULL)
+        return RT_EOK;
+
+    _ttyworkq = rt_workqueue_create("ttyworkq", RT_SYSTEM_WORKQUEUE_STACKSIZE,
+                                    LWP_TTY_WORKQUEUE_PRIORITY);
+    RT_ASSERT(_ttyworkq != RT_NULL);
+
+    _setup_debug_rxind_hook();
+
+    return RT_EOK;
+}
+INIT_PREV_EXPORT(_tty_workqueue_init);
+
+static rt_err_t _match_tty_iter(struct rt_object *obj, void *data)
+{
+    rt_device_t target = *(rt_device_t *)data;
+    rt_device_t device = rt_container_of(obj, struct rt_device, parent);
+    if (device->type == RT_Device_Class_Char)
+    {
+        lwp_tty_t tp;
+        if (rt_strncmp(obj->name, "tty"TTY_NAME_PREFIX,
+            sizeof("tty"TTY_NAME_PREFIX) - 1) == 0)
+        {
+            struct serial_tty_context *softc;
+
+            tp = rt_container_of(device, struct lwp_tty, parent);
+            softc = tty_softc(tp);
+
+            if (&softc->parent->parent == target)
+            {
+                /* matched, early return */
+                *(rt_device_t *)data = device;
+                return 1;
+            }
+        }
+    }
+
+    return RT_EOK;
+}
+
+/**
+ * @brief The default console is only a backup device with lowest priority.
+ *        It's always recommended to scratch the console from the boot arguments.
+ *        And dont forget to register the device with a higher priority.
+ */
+static int _default_console_setup(void)
+{
+    rt_err_t rc;
+    rt_device_t bakdev;
+    rt_device_t ttydev;
+
+    bakdev = rt_console_get_device();
+    if (!bakdev)
+    {
+        return -RT_ENOENT;
+    }
+
+    ttydev = bakdev;
+    rt_object_for_each(RT_Object_Class_Device, _match_tty_iter, &ttydev);
+
+    if (ttydev != bakdev)
+    {
+        LOG_I("Using /dev/%.*s as default console", RT_NAME_MAX, ttydev->parent.name);
+        lwp_console_register_backend(ttydev, LWP_CONSOLE_LOWEST_PRIOR);
+        rc = RT_EOK;
+    }
+    else
+    {
+        rc = -RT_EINVAL;
+    }
+
+    return rc;
+}
+
+INIT_COMPONENT_EXPORT(_default_console_setup);