rtthread学习笔记系列(3) -- FINSH模块

🕗 发布于 2025-01-15 21:20 linux c语言 单片机 arm

文章目录

3. FINSH模块

3. FINSH模块

https://github.com/wdfk-prog/RT-Thread-Study

3.1MSH

3.1.1初始化

根据链接脚本指明FINSH使用内存空间 _syscall_table_begin _syscall_table_end的地址

3.1.1.1FSymtab段

        . = ALIGN(4);
        __fsymtab_start = .;
        KEEP(*(FSymTab))
        __fsymtab_end = .;

__fsymtab_start和 __fsymtab_end用于指明finsh使用内存
FSymTab用于存放所有注册命令的结构体 struct finsh_syscall,包括命令名称,命令选项,命令描述,命令函数执行地址信息

3.1.1.2 宏

/**
 * @ingroup msh
 *
 * This macro exports a command to module shell.
 *
 * @param command is the name of the command.
 * @param desc is the description of the command, which will show in help list.
 * @param opt This is an option, enter any content to enable option completion
 */
/* MSH_CMD_EXPORT(command, desc) or MSH_CMD_EXPORT(command, desc, opt) */
#define MSH_CMD_EXPORT(...)                                 \
    __MSH_GET_MACRO(__VA_ARGS__, _MSH_FUNCTION_CMD2_OPT,    \
        _MSH_FUNCTION_CMD2)(__VA_ARGS__)

#define __MSH_GET_MACRO(_1, _2, _3, _FUN, ...)  _FUN

#define _MSH_FUNCTION_CMD2(a0, a1)       \
        MSH_FUNCTION_EXPORT_CMD(a0, a0, a1, 0)

#define _MSH_FUNCTION_CMD2_OPT(a0, a1, a2)       \
        MSH_FUNCTION_EXPORT_CMD(a0, a0, a1, a0##_msh_options)

#define MSH_FUNCTION_EXPORT_CMD(name, cmd, desc)                      \
                const char __fsym_##cmd##_name[] rt_section(".rodata.name") = #cmd;    \
                const char __fsym_##cmd##_desc[] rt_section(".rodata.name") = #desc;   \
                rt_used const struct finsh_syscall __fsym_##cmd rt_section("FSymTab")= \
                {                           \
                    __fsym_##cmd##_name,    \
                    __fsym_##cmd##_desc,    \
                    (syscall_func)&name     \
                };

宏过载语法,选择2个参数使用 MSH_FUNCTION_CMD2,_MSH_FUNCTION_CMD2的desc为0;3个参数使用 MSH_FUNCTION_CMD2_OPT
定义字符串成员,地址定义为.rodata.name;内容为#cmd;

const char __fsym_##cmd##_name[] rt_section(".rodata.name") = #cmd;    \
const char __fsym_##cmd##_desc[] rt_section(".rodata.name") = #desc;   \

__fsym_##cmd存储名称,细节,挂钩的函数指针地址

3.1.2遍历FINSH命令

    for (index = _syscall_table_begin;
            index < _syscall_table_end;
            FINSH_NEXT_SYSCALL(index))
    {
  
    }

3.1.3TAB补全实现

判断输入为 /t
将光标移动到行首;使用 /b退格,一个个退回删除之前的显示字符
将命令首地址传入 shell_auto_complete
计算偏移地址

shell_auto_complete

3.1.3.1 `msh_auto_complete`

首地址为 /0,即无输入任何字符串,直接TAB /t,则调用 msh_cmd输出所有支持的命令
匹配命令名字,并输出命令

        for (index = _syscall_table_begin; index < _syscall_table_end; FINSH_NEXT_SYSCALL(index))
        {
            /* skip finsh shell function */
            cmd_name = (const char *) index->name;
            if (strncmp(prefix, cmd_name, strlen(prefix)) == 0)
            {
                if (min_length == 0)
                {
                    /* set name_ptr */
                    name_ptr = cmd_name;
                    /* set initial length */
                    min_length = strlen(name_ptr);
                }

                length = str_common(name_ptr, cmd_name);
                if (length < min_length)
                    min_length = length;

                rt_kprintf("%s\n", cmd_name);
            }
        }

输出提示字符 msh />与命令输入的字符串

 rt_kprintf("%s%s", FINSH_PROMPT, prefix);

finsh_get_prompt输出提示

#define FINSH_PROMPT        finsh_get_prompt()

finsh_prompt_custom 用于自定义替换默认提示
finsh_set_prompt("artpi@root");

3.1.3.2 `msh_opt_auto_complete`

   argc = msh_get_argc(prefix, &opt_str);
    if (argc)
    {
        opt = msh_get_cmd_opt(prefix);
    }
    else if (!msh_get_cmd(prefix, strlen(prefix)) && (' ' == prefix[strlen(prefix) - 1]))
    {
        opt = msh_get_cmd_opt(prefix);
    }

msh_get_argc 获取命令空格之后参数
没获取到参数时,判断 prefix不是一个已知的命令，并且命令行字符串的最后一个字符是空格
msh_get_cmd_opt获取 syscall_table中是否有匹配的命令
argc为0,输出 msh_opt_help所有的命令?
msh_opt_complete与 msh_auto_complete作用相同

3.1.4 TAB 子选项自动补全

msh_opt_auto_complete
使用完成命令注册

#define CMD_OPTIONS_STATEMENT(command) static struct msh_cmd_opt command##_msh_options[];
#define CMD_OPTIONS_NODE_START(command) static struct msh_cmd_opt command##_msh_options[] = {
#define CMD_OPTIONS_NODE(_id, _name, _des) {.id = _id, .name = #_name, .des = #_des},
#define CMD_OPTIONS_NODE_END    {0},};


CMD_OPTIONS_NODE_START(vref_temp_get)
CMD_OPTIONS_NODE(1, write, tx data)
CMD_OPTIONS_NODE(2, irq, irq list)
CMD_OPTIONS_NODE(3, speed-test, eth physical speed test)
CMD_OPTIONS_NODE_END

3.2 SHELL

3.2.1 `finsh_system_init`分配finsh结构体使用内存

创建 finsh_thread_entry线程
创建信号量,用于阻塞接字符串;信号量由控制台设备对象解除
设置提示模式
INIT_APP_EXPORT中调用

3.2.2 `finsh_thread_entry`

获取控制台设备对象
获取控制台密码用于密码确认
- finsh_wait_auth
  - 阻塞等待获取密码;密码输入显示 *
  - 敲入回车认为密码输入完成
  - 进入密码验证判断;失败线程阻塞等待2S再次获取输入字符
进入控制台线程
1. finsh_getchar
- rt_sem_take(&shell->rx_sem, RT_WAITING_FOREVER);等待信号量释放
  - finsh_rx_ind函数中释放信号量
1. handle control key判断
```
     /*
         * handle control key
         * up key  : 0x1b 0x5b 0x41
         * down key: 0x1b 0x5b 0x42
         * right key:0x1b 0x5b 0x43
         * left key: 0x1b 0x5b 0x44
         */
```
- 上下键:历史命令显示
- 左右键:移动当前光标
- tab键补全命令
- 删除键:删除
- 回车键:执行msh命令
设置控制台设备模式

/**
 * @ingroup finsh
 *
 * This function sets the input device of finsh shell.
 *
 * @param device_name the name of new input device.
 */
void finsh_set_device(const char *device_name)
{
    rt_device_t dev = RT_NULL;

    RT_ASSERT(shell != RT_NULL);
    dev = rt_device_find(device_name);
    if (dev == RT_NULL)
    {
        rt_kprintf("finsh: can not find device: %s\n", device_name);
        return;
    }

    /* check whether it's a same device */
    if (dev == shell->device) return;
    /* open this device and set the new device in finsh shell */
    if (rt_device_open(dev, RT_DEVICE_OFLAG_RDWR | RT_DEVICE_FLAG_INT_RX | \
                       RT_DEVICE_FLAG_STREAM) == RT_EOK)
    {
        if (shell->device != RT_NULL)
        {
            /* close old finsh device */
            rt_device_close(shell->device);
            rt_device_set_rx_indicate(shell->device, RT_NULL);
        }

        /* clear line buffer before switch to new device */
        rt_memset(shell->line, 0, sizeof(shell->line));
        shell->line_curpos = shell->line_position = 0;

        shell->device = dev;
        rt_device_set_rx_indicate(dev, finsh_rx_ind);
    }
}

3.2.3 历史命令显示

回车存入历史命令 shell_push_history
上下键显示历史命令 shell_handle_history

3.2.4 MSH命令执行

3.3 cmd&msh_parse&&msh_file

一些系统命令的输出
一些共用的解析
文件系统的命令支持

原文地址：https://blog.csdn.net/qq_39665253/article/details/145147710

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Android笔记：SVG 导入时不支持text 问题解决
下一篇：如何让 LLM 使用外部函数 or 工具？Llama-3-Groq-8B-Tool-Use 模型使用详解

20250117在Ubuntu20.04.6下使用灵思FPGA的刷机工具efinity刷机
周五一月 17 25 18:21:46 - Using FTDI URL (SPI = ftdi://0x0403:0x6010:FT8P1ZWI/1, JTAG = ftdi://0x0403:0
阅读更多2025-01-18
JavaScript系列（31）--装饰器详解
JavaScript之旅第三十一站
阅读更多2025-01-18
Linux测试处理fps为30、1920*1080、一分钟的视频性能
项目CMakeLists.txt。
阅读更多2025-01-18
【HarmonyOS之旅】基于ArkTS开发(二) -＞ UI开发三
除绘制基础几何图形，开发者还可以使用Path组件来绘制自定义的路线，下面进行绘制应用的Logo图案。1. 在pages文件夹下创建新的页面Logo.ets。2. Logo.ets中删掉模板代码，创建L
阅读更多2025-01-18
git 常用命令 git archive
git archive 是 Git 中用于创建一个包含指定提交或分支中所有文件的归档文件（如 .tar 或 .zip）的命令。这个命令非常适合用于分发项目快照、备份代码库或导出特定版本的文件。
阅读更多2025-01-18
JavaScript语言的正则表达式
正则表达式是一种用于描述字符串模式的工具，它由普通字符（如字母和数字）和特殊字符（称为元字符）组成。正则表达式可以用来验证字符串是否符合某种特定的模式，提取字符串中的信息，或对字符串进行替换和修改等操
阅读更多2025-01-18
【爬虫】使用 Scrapy 框架爬取豆瓣电影 Top 250 数据的完整教程
在大数据和网络爬虫领域，Scrapy是一个功能强大且广泛使用的开源爬虫框架。它能够帮助我们快速地构建爬虫项目，并高效地从各种网站中提取数据。在本篇文章中，我将带大家从零开始使用Scrapy框架，构建一
阅读更多2025-01-18
com组件技术学习第一章
组件化的技术。
阅读更多2025-01-18
ScratchLLMStepByStep：训练自己的Tokenizer
这一点非常重要，因为每个utf-8字符都是由一到多个字节组成的，将这个长度为256的编码表中的字节进行组合，理论上就能对世界上所有语言中的字符进行编码，并且还不会出现。
阅读更多2025-01-18
强推未发表！3D图！Transformer-LSTM+NSGAII工艺参数优化、工程设计优化！
强推未发表！3D图！Transformer-LSTM+NSGAII工艺参数优化、工程设计优化！
阅读更多2025-01-18

rtthread学习笔记系列(3) -- FINSH模块

文章目录

3. FINSH模块

3.1MSH

3.1.1初始化

3.1.1.1FSymtab段

3.1.1.2 宏

3.1.2遍历FINSH命令

3.1.3TAB补全实现

3.1.3.1 msh_auto_complete

3.1.3.2 msh_opt_auto_complete

3.1.4 TAB 子选项自动补全

3.2 SHELL

3.2.1 finsh_system_init分配finsh结构体使用内存

3.2.2 finsh_thread_entry

3.2.3 历史命令显示

3.2.4 MSH命令执行

3.3 cmd&msh_parse&&msh_file

相关文章

3.1.3.1 `msh_auto_complete`

3.1.3.2 `msh_opt_auto_complete`

3.2.1 `finsh_system_init`分配finsh结构体使用内存

3.2.2 `finsh_thread_entry`