[drivers/serial] Introduce hooker for TTY (#8733)

polarvid · Rbb666 · commit a79176b0ae49 · 2024-04-19T15:29:16.000+08:00
In this patch, a hook list has been introduced to address the concerns
regarding coupling issues arising from modifications to the serial code
for integrating TTY logic.

Signed-off-by: Shell &lt;smokewood@qq.com&gt;
diff --git a/components/drivers/include/drivers/serial.h b/components/drivers/include/drivers/serial.h
@@ -102,6 +102,14 @@
     0                                      \
 }
 
+/**
+ * @brief Sets a hook function when RX indicate is called
+ *
+ * @param thread is the target thread that initializing
+ */
+typedef void (*rt_hw_serial_rxind_hookproto_t)(rt_device_t dev, rt_size_t size);
+RT_OBJECT_HOOKLIST_DECLARE(rt_hw_serial_rxind_hookproto_t, rt_hw_serial_rxind);
+
 struct serial_configure
 {
     rt_uint32_t baud_rate;
@@ -186,4 +194,5 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
                                void                    *data);
 
 rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
+
 #endif
diff --git a/components/drivers/include/drivers/serial_dm.h b/components/drivers/include/drivers/serial_dm.h
diff --git a/components/drivers/include/drivers/serial_v2.h b/components/drivers/include/drivers/serial_v2.h
@@ -103,6 +103,14 @@
     0                                                 \
 }
 
+/**
+ * @brief Sets a hook function when RX indicate is called
+ *
+ * @param thread is the target thread that initializing
+ */
+typedef void (*rt_hw_serial_rxind_hookproto_t)(rt_device_t dev, rt_size_t size);
+RT_OBJECT_HOOKLIST_DECLARE(rt_hw_serial_rxind_hookproto_t, rt_hw_serial_rxind);
+
 struct serial_configure
 {
     rt_uint32_t baud_rate;
diff --git a/components/drivers/ofw/ofw.c b/components/drivers/ofw/ofw.c
@@ -12,7 +12,7 @@
 #include <rtdevice.h>
 #include <drivers/platform.h>
 #include <drivers/core/bus.h>
-#include "../serial/serial_dm.h"
+#include <drivers/serial_dm.h>
 
 #define DBG_TAG "rtdm.ofw"
 #define DBG_LVL DBG_INFO
diff --git a/components/drivers/serial/serial.c b/components/drivers/serial/serial.c
@@ -57,10 +57,14 @@
 #undef putc
 #endif
 
+RT_OBJECT_HOOKLIST_DEFINE(rt_hw_serial_rxind);
+
 static rt_err_t serial_fops_rx_ind(rt_device_t dev, rt_size_t size)
 {
     rt_wqueue_wakeup(&(dev->wait_queue), (void*)POLLIN);
 
+    RT_OBJECT_HOOKLIST_CALL(rt_hw_serial_rxind, (dev, size));
+
     return RT_EOK;
 }
 
@@ -1390,14 +1394,6 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
     return ret;
 }
 
-#if defined(RT_USING_SMART) && defined(LWP_DEBUG)
-static volatile int _early_input = 0;
-int lwp_startup_debug_request(void)
-{
-    return _early_input;
-}
-#endif
-
 /* ISR for serial interrupt */
 void rt_hw_serial_isr(struct rt_serial_device *serial, int event)
 {
@@ -1443,7 +1439,7 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event)
             /**
              * Invoke callback.
              * First try notify if any, and if notify is existed, rx_indicate()
-             * is not callback. This seperate the priority and makes the reuse
+             * is not callback. This separate the priority and makes the reuse
              * of same serial device reasonable for RT console.
              */
             if (serial->rx_notify.notify)
@@ -1465,9 +1461,6 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event)
                     serial->parent.rx_indicate(&serial->parent, rx_length);
                 }
             }
-        #if defined(RT_USING_SMART) && defined(LWP_DEBUG)
-            _early_input = 1;
-        #endif
             break;
         }
         case RT_SERIAL_EVENT_TX_DONE:
diff --git a/components/drivers/serial/serial_dm.c b/components/drivers/serial/serial_dm.c
@@ -9,7 +9,7 @@
  */
 
 #include <rtatomic.h>
-#include "serial_dm.h"
+#include <drivers/serial_dm.h>
 
 int serial_dev_set_name(struct rt_serial_device *sdev)
 {
@@ -82,8 +82,9 @@ void *serial_base_from_args(char *str)
     return (void *)base;
 }
 
-struct serial_configure serial_cfg_from_args(char *str)
+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 */
diff --git a/components/drivers/serial/serial_tty.c b/components/drivers/serial/serial_tty.c
@@ -63,6 +63,37 @@ static char *alloc_device_name(void)
     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;
@@ -325,6 +356,8 @@ static int _tty_workqueue_init(void)
                                     LWP_TTY_WORKQUEUE_PRIORITY);
     RT_ASSERT(_ttyworkq != RT_NULL);
 
+    _setup_debug_rxind_hook();
+
     return RT_EOK;
 }
 INIT_PREV_EXPORT(_tty_workqueue_init);
diff --git a/components/drivers/serial/serial_v2.c b/components/drivers/serial/serial_v2.c
@@ -35,10 +35,14 @@
 #undef putc
 #endif
 
+RT_OBJECT_HOOKLIST_DEFINE(rt_hw_serial_rxind);
+
 static rt_err_t serial_fops_rx_ind(rt_device_t dev, rt_size_t size)
 {
     rt_wqueue_wakeup(&(dev->wait_queue), (void*)POLLIN);
 
+    RT_OBJECT_HOOKLIST_CALL(rt_hw_serial_rxind, (dev, size));
+
     return RT_EOK;
 }
 
diff --git a/components/lwp/Kconfig b/components/lwp/Kconfig
@@ -6,10 +6,17 @@ menuconfig RT_USING_LWP
         The lwP is a light weight process running in user mode.
 
 if RT_USING_LWP
-    config LWP_DEBUG
+    menuconfig LWP_DEBUG
         bool "Enable debugging features of LwP"
         default y
 
+    if LWP_DEBUG
+        config LWP_DEBUG_INIT
+        select RT_USING_HOOKLIST
+        bool "Enable debug mode of init process"
+        default n
+    endif
+
     config RT_LWP_MAX_NR
         int "The max number of light-weight process"
         default 30
diff --git a/components/lwp/lwp.c b/components/lwp/lwp.c
@@ -137,7 +137,7 @@ static int lwp_startup(void)
     char *argv[] = {0, "&"};
     char *envp[] = {LWP_CONSOLE_PATH, 0};
 
-#ifdef LWP_DEBUG
+#ifdef LWP_DEBUG_INIT
     int command;
     int countdown = LATENCY_TIMES;
     while (countdown)
@@ -152,7 +152,7 @@ static int lwp_startup(void)
         rt_thread_mdelay(LATENCY_IN_MSEC);
     }
     rt_kprintf("Starting init ...\n");
-#endif
+#endif /* LWP_DEBUG_INIT */
 
     for (size_t i = 0; i < sizeof(init_search_path)/sizeof(init_search_path[0]); i++)
     {
diff --git a/include/rtdef.h b/include/rtdef.h
@@ -526,23 +526,23 @@ struct rt_object_information
  *     do_other_things();
  * }
  */
-#define _RT_OBJECT_HOOKLIST_CALL(nodetype, nested, list, lock, argv) \
-    do                                                               \
-    {                                                                \
-        nodetype iter;                                               \
-        rt_ubase_t level = rt_spin_lock_irqsave(&lock);              \
-        nested += 1;                                                 \
-        rt_spin_unlock_irqrestore(&lock, level);                     \
-        if (!rt_list_isempty(&list))                                 \
-        {                                                            \
-            rt_list_for_each_entry(iter, &list, list_node)           \
-            {                                                        \
-                iter->handler argv;                                  \
-            }                                                        \
-        }                                                            \
-        level = rt_spin_lock_irqsave(&lock);                         \
-        nested -= 1;                                                 \
-        rt_spin_unlock_irqrestore(&lock, level);                     \
+#define _RT_OBJECT_HOOKLIST_CALL(nodetype, nested, list, lock, argv)  \
+    do                                                                \
+    {                                                                 \
+        nodetype iter, next;                                          \
+        rt_ubase_t level = rt_spin_lock_irqsave(&lock);               \
+        nested += 1;                                                  \
+        rt_spin_unlock_irqrestore(&lock, level);                      \
+        if (!rt_list_isempty(&list))                                  \
+        {                                                             \
+            rt_list_for_each_entry_safe(iter, next, &list, list_node) \
+            {                                                         \
+                iter->handler argv;                                   \
+            }                                                         \
+        }                                                             \
+        level = rt_spin_lock_irqsave(&lock);                          \
+        nested -= 1;                                                  \
+        rt_spin_unlock_irqrestore(&lock, level);                      \
     } while (0)
 #define RT_OBJECT_HOOKLIST_CALL(name, argv)                        \
     _RT_OBJECT_HOOKLIST_CALL(name##_hooklistnode_t, name##_nested, \

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,14 @@`
`103`	`103`	`0 \`
`104`	`104`	`}`
`105`	`105`
	`106`	`+/**`
	`107`	`+ * @brief Sets a hook function when RX indicate is called`
	`108`	`+ *`
	`109`	`+ * @param thread is the target thread that initializing`
	`110`	`+ */`
	`111`	`+typedef void (*rt_hw_serial_rxind_hookproto_t)(rt_device_t dev, rt_size_t size);`
	`112`	`+RT_OBJECT_HOOKLIST_DECLARE(rt_hw_serial_rxind_hookproto_t, rt_hw_serial_rxind);`
	`113`	`+`
`106`	`114`	`struct serial_configure`
`107`	`115`	`{`
`108`	`116`	`rt_uint32_t baud_rate;`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`*/`
`10`	`10`
`11`	`11`	`#include <rtatomic.h>`
`12`		`-#include "serial_dm.h"`
	`12`	`+#include <drivers/serial_dm.h>`
`13`	`13`
`14`	`14`	`int serial_dev_set_name(struct rt_serial_device *sdev)`
`15`	`15`	`{`
`@@ -82,8 +82,9 @@ void serial_base_from_args(char str)`
`82`	`82`	`return (void *)base;`
`83`	`83`	`}`
`84`	`84`
`85`		`-struct serial_configure serial_cfg_from_args(char *str)`
	`85`	`+struct serial_configure serial_cfg_from_args(char *_str)`
`86`	`86`	`{`
	`87`	`+ char *str = _str;`
`87`	`88`	`struct serial_configure cfg = RT_SERIAL_CONFIG_DEFAULT;`
`88`	`89`
`89`	`90`	`/* Format baudrate/parity/bits/flow (BBBBPNF), Default is 115200n8 */`
Original file line number	Diff line number	Diff line change
`@@ -35,10 +35,14 @@`
`35`	`35`	`#undef putc`
`36`	`36`	`#endif`
`37`	`37`
	`38`	`+RT_OBJECT_HOOKLIST_DEFINE(rt_hw_serial_rxind);`
	`39`	`+`
`38`	`40`	`static rt_err_t serial_fops_rx_ind(rt_device_t dev, rt_size_t size)`
`39`	`41`	`{`
`40`	`42`	`rt_wqueue_wakeup(&(dev->wait_queue), (void*)POLLIN);`
`41`	`43`
	`44`	`+ RT_OBJECT_HOOKLIST_CALL(rt_hw_serial_rxind, (dev, size));`
	`45`	`+`
`42`	`46`	`return RT_EOK;`
`43`	`47`	`}`
`44`	`48`