[example] 格式化整理

2025-10-20 22:42:40 +08:00 · 2021-03-07 08:34:04 +08:00
parent ce86058201
commit 08af426f01
30 changed files with 1063 additions and 1063 deletions
--- a/examples/kernel/timer_timeout.c
+++ b/examples/kernel/timer_timeout.c
@@ -1,21 +1,21 @@
 /*
- * <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>嵥<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
+ * 程序清单：消息队列例程
 *
- * <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ᴴ<EFBFBD><EFBFBD>3<EFBFBD><EFBFBD><EFBFBD><EFBFBD>̬<EFBFBD>̣߳<EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD>̻߳<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD>̻߳ᶨʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
- * Ϣ<EFBFBD><EFBFBD><EFBFBD>з<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD>̻߳ᶨʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD>з<EFBFBD><EFBFBD>ͽ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD>
+ * 这个程序会创建3个动态线程，一个线程会从消息队列中收取消息；一个线程会定时给消
+ * 息队列发送消息；一个线程会定时给消息队列发送紧急消息。
 */
 #include <rtthread.h>
 #include "tc_comm.h"

-/* ָ<EFBFBD><EFBFBD><EFBFBD>߳̿<EFBFBD><EFBFBD>ƿ<EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD> */
+/* 指向线程控制块的指针 */
 static rt_thread_t tid = RT_NULL;

-/* <EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD>п<EFBFBD><EFBFBD>ƿ<EFBFBD> */
+/* 消息队列控制块 */
 static struct rt_messagequeue mq;
-/* <EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>õ<EFBFBD><EFBFBD>ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD><EFBFBD><EFBFBD> */
+/* 消息队列中用到的放置消息的内存池 */
 static char msg_pool[2048];

-/* <EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD>Ŀ<EFBFBD><EFBFBD>ƿ<EFBFBD> */
+/* 定时器的控制块 */
 static struct rt_timer timer;
 static rt_uint16_t no = 0;
 static void timer_timeout(void* parameter)
@@ -27,24 +27,24 @@ static void timer_timeout(void* parameter)
    rt_mq_send(&mq, &buf[0], length);
 }

-/* <EFBFBD>߳<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ں<EFBFBD><EFBFBD><EFBFBD> */
+/* 线程入口函数 */
 static void thread_entry(void* parameter)
 {
    char buf[64];
    rt_err_t result;

-    /* <EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD> */
-    rt_timer_init(&timer, "timer",  /* <EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> timer1 */
-        timer_timeout, /* <EFBFBD><EFBFBD>ʱʱ<EFBFBD>ص<EFBFBD><EFBFBD>Ĵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
-        RT_NULL, /* <EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><EFBFBD><EFBFBD> */
-        1, /* <EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD>ȣ<EFBFBD><EFBFBD><EFBFBD>OS TickΪ<6B><CEAA>λ<EFBFBD><CEBB><EFBFBD><EFBFBD>1<EFBFBD><31>OS Tick */
-        RT_TIMER_FLAG_PERIODIC); /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Զ<EFBFBD>ʱ<EFBFBD><EFBFBD> */
+    /* 初始化定时器 */
+    rt_timer_init(&timer, "timer",  /* 定时器名字是 timer1 */
+        timer_timeout, /* 超时时回调的处理函数 */
+        RT_NULL, /* 超时函数的入口参数 */
+        1, /* 定时长度，以OS Tick为单位，即1个OS Tick */
+        RT_TIMER_FLAG_PERIODIC); /* 周期性定时器 */

    while (1)
    {
        rt_memset(&buf[0], 0, sizeof(buf));

-        /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>н<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ */
+        /* 从消息队列中接收消息 */
        result = rt_mq_recv(&mq, &buf[0], sizeof(buf), 1);
        if (result == RT_EOK)
        {
@@ -59,16 +59,16 @@ static void thread_entry(void* parameter)

 int timer_timeout_init()
 {
-    /* <EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
-    rt_mq_init(&mq, "mqt", 
-        &msg_pool[0], /* <EFBFBD>ڴ<EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>msg_pool */ 
-        128 - sizeof(void*), /* ÿ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD>Ĵ<EFBFBD>С<EFBFBD><EFBFBD> 128 - void* */
-        sizeof(msg_pool), /* <EFBFBD>ڴ<EFBFBD><EFBFBD>صĴ<EFBFBD>С<EFBFBD><EFBFBD>msg_pool<EFBFBD>Ĵ<EFBFBD>С */
-        RT_IPC_FLAG_FIFO); /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD><EFBFBD>̵߳ȴ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȵõ<EFBFBD><EFBFBD>ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ */
+    /* 初始化消息队列 */
+    rt_mq_init(&mq, "mqt",
+        &msg_pool[0], /* 内存池指向msg_pool */
+        128 - sizeof(void*), /* 每个消息的大小是 128 - void* */
+        sizeof(msg_pool), /* 内存池的大小是msg_pool的大小 */
+        RT_IPC_FLAG_FIFO); /* 如果有多个线程等待，按照先来先得到的方法分配消息 */

-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>߳<EFBFBD> */
+    /* 创建线程 */
    tid = rt_thread_create("t",
-        thread_entry, RT_NULL, /* <EFBFBD>߳<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>thread_entry, <EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>RT_NULL */
+        thread_entry, RT_NULL, /* 线程入口是thread_entry, 入口参数是RT_NULL */
        THREAD_STACK_SIZE, THREAD_PRIORITY, THREAD_TIMESLICE);
    if (tid != RT_NULL)
        rt_thread_startup(tid);
@@ -81,38 +81,38 @@ int timer_timeout_init()
 #ifdef RT_USING_TC
 static void _tc_cleanup()
 {
-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>󣬽<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>̣߳<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ӧ<EFBFBD>ж<EFBFBD> */
+    /* 调度器上锁，上锁后，将不再切换到其他线程，仅响应中断 */
    rt_enter_critical();

-    /* ɾ<EFBFBD><EFBFBD><EFBFBD>߳<EFBFBD> */
+    /* 删除线程 */
    if (tid != RT_NULL && tid->stat != RT_THREAD_CLOSE)
        rt_thread_delete(tid);

-    /* ִ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ<EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
+    /* 执行消息队列对象脱离 */
    rt_mq_detach(&mq);
-    /* ִ<EFBFBD>ж<EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
+    /* 执行定时器脱离 */
    rt_timer_detach(&timer);

-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
+    /* 调度器解锁 */
    rt_exit_critical();

-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD>TestCase״̬ */
+    /* 设置TestCase状态 */
    tc_done(TC_STAT_PASSED);
 }

 int _tc_timer_timeout()
 {
-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD>TestCase<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
+    /* 设置TestCase清理回调函数 */
    tc_cleanup(_tc_cleanup);
    timer_timeout_init();

-    /* <EFBFBD><EFBFBD><EFBFBD><EFBFBD>TestCase<EFBFBD><EFBFBD><EFBFBD>е<EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD> */
+    /* 返回TestCase运行的最长时间 */
    return 100;
 }
-/* <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>finsh shell<EFBFBD><EFBFBD> */
+/* 输出函数命令到finsh shell中 */
 FINSH_FUNCTION_EXPORT(_tc_timer_timeout, a thread timer testcase);
 #else
-/* <EFBFBD>û<EFBFBD>Ӧ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> */
+/* 用户应用入口 */
 int rt_application_init()
 {
    timer_timeout_init();