FinSH

最新推荐文章于 2024-05-04 18:28:09 发布
最新推荐文章于 2024-05-04 18:28:09 发布
阅读量1.4k 收藏 3
点赞数
分类专栏： rt-thread笔记 文章标签： risc-v ubuntu
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Exxfire/article/details/127705270
版权

finSH介绍

FinSH 是 RT-Thread 的命令行组件，提供一套供用户在命令行调用的操作接口，主要用于调试或查看系统信息。它可以使用串口 / 以太网 / USB 等与 PC 机进行通信。

命令执行过程

FinSH 命令执行流程图

功能:

  1. 支持鉴权，可在系统配置中选择打开/关闭。(TODO:具体操作过程)
  2. tap键自动补全命令，如果什么都没有输入会列出所有命令。（TODO:原理）
    按键功能描述
    Tab 键当没有输入任何字符时按下 Tab 键将会打印当前系统支持的所有命令。若已经输入部分字符时按下 Tab 键，将会查找匹配的命令，也会按照文件系统的当前目录下的文件名进行补全，并可以继续输入，多次补全
    ↑↓键上下翻阅最近输入的历史命令
    退格键删除符
    ←→键向左或向右移动标
  3. 历史命令查看。（上下键翻阅）
  4. FinSH 完全采用 ANSI C 编写，具备极好的移植性。（前面章节中介绍的函数方式动态地向 FinSH 添加符号，FinSH 将不会动态申请内存？？什么方式？）

传统命令行模式msh VS C-style模式

最初 FinSH 仅支持 C-Style 模式，后来随着 RT-Thread 的不断发展，C-Style 模式在运行脚本或者程序时不太方便，而使用传统的 shell 方式则比较方便。另外，C-Style 模式下，FinSH 占用体积比较大。(TODO:为什么会比较大)出于这些考虑，在 RT-Thread 中增加了 msh 模式，msh 模式体积小，使用方便，推荐使用 msh 模式。

  1. modemshC-style
    examplecommand [arg1] [arg2] […]list_thread()
    switchexit ===>to c-style modemsh() ===> to msh mode
    cmd defineMSH_CMD_EXPORT(name, desc);
    MSH_CMD_EXPORT_ALIAS    		FINSH_FUNCTION_EXPORT(name,desc);
    FINSH_VAR_EXPORT(name, type, desc);
    FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc);(当函数名称超过16个字节的时候，需要导出别名，否则执行会出错，在重命名的命令名字前加 __cmd_ 就可以将命令导出到 msh 模式，否则，命令会被导出到 C-Style 模式)

FinSH功能配置

在rt-thread配置文件rt-config.h 中，在env开发环境下，可以使用menuconfig 命令在图形化界面当中进行配置。

宏定义取值类型描述默认值
#define RT_USING_FINSH无使能 FinSH开启
#define FINSH_THREAD_NAME字符串FinSH 线程的名字“tshell”
#define FINSH_USING_HISTORY无打开历史回溯功能开启
#define FINSH_HISTORY_LINES整数型能回溯的历史命令行数5
#define FINSH_USING_SYMTAB无可以在 FinSH 中使用符号表开启
#define FINSH_USING_DESCRIPTION无给每个 FinSH 的符号添加一段描述开启
#define FINSH_USING_MSH无使能 msh 模式开启
#define FINSH_USING_MSH_ONLY无只使用 msh 模式开启
#define FINSH_ARG_MAX整数型最大输入参数数量10
#define FINSH_USING_AUTH无使能权限验证关闭
#define FINSH_DEFAULT_PASSWORD字符串权限验证密码关闭

FiniSH代码阅读提示：

每次的命令执行都是在 FinSH 线程（即 tshell 线程）的上下文中完成。

初始化：finsh_system_init() 函数。

输出：在 RT-Thread 中依赖 rt_kprintf() 输出。在启动函数 rt_hw_board_init() 中，rt_console_set_device(const char* name) 函数设置了 FinSH 的打印输出设备。

输入：获得了信号量后，调用rt_device_read() 函数从设备 (选用串口设备) 中获得一个字符然后处理。而 rx_sem 信号量的释放通过调用 rx_indicate() 函数以完成对 FinSH 线程的输入通知。通常的过程是，当串口接收中断发生时（即串口有输入），接受中断服务例程调用 rx_indicate() 函数通知 FinSH 线程有输入，而后 FinSH 线程获取串口输入最后做相应的命令处理。

TODO:获得一个字符就处理吗？还是整个命令获得了再处理？

FinSH代码阅读

文件结构
route:rt-thread/components/finish
├─ finsh

│  ├─ cmd.c                // place rt-thread  cmd

│  ├─ finsh.h            // cmd export相关的宏和函数的声明，涉及到的函数的声明（TODO:函数实现在哪？）

│  ├─ msh.c                // msh cmd search & excution funcitons

│  ├─ msh.h                // msh cmd search & excution funcitons API

│  ├─ msh_file.c        // some os cmd define(cd/pwd/mkfs/mount/...)

│  ├─ msh_parse.c        // msh cmd parse

│  ├─ msh_parse.h        // msh cmd parse API

│  ├─ shell.c            // shell context and cmd read

│  ├─ shell.h            // struct define and API set

│  ├─ Kconfig            // project config file for menuconfig

│  └─ SConscript        // scons project file
初始化

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1M5zlpzZ-1667636697535)(a1992662197db6b981a36dd150b62ae0.png)]

finSH的初始化放在rt_components_init()的applilication init functions部分。

调用关系:

rtthread_startup() -->

rt_system_scheduler_start() -->

main_thread_entry(void *parameter) -->

rt_components_init(void) -->

finsh_system_init(void) -->

分出另一个线程 -->

finsh_thread_entry(void *parameter).


finsh_system_init() 下finsh_system_function_init() 的作用是什么呢？

答：初始化两个指针，一个指向所有命令的最开始，一个指向命令的最结尾。

CMD define逻辑

macro call :FINSH_FUNCTION_EXPORT(name, desc) --> MSH_FUNCTION_EXPORT_CMD(name, cmd, desc)

MSH_FUNCTION_EXPORT_CMD逻辑
#define MSH_FUNCTION_EXPORT_CMD(name, cmd, desc)        \     

​        const char __fsym_##cmd##_name[] = #cmd;       \    /* cmd name to str */

​        const char __fsym_##cmd##_desc[] = #desc;      \    /* cmd description to str */

​        __declspec(allocate("FSymTab$f"))              \    /* put next struct to this section */

​        const struct finsh_syscall __fsym_##cmd =      \

​        {                                              \

​          __fsym_##cmd##_name,                           \

​          __fsym_##cmd##_desc,                           \

​          (syscall_func)&name                           \

​        };
FinSH CMD 处理逻辑

finsh_thread_entry函数用于处理来自用户的输入，大概有以下几个功能：

  • 鉴权
  • 循环读取一个字符串并处理：
    • 特殊字符的处理： 上下左右、制表符、回退、回车。对应历史命令读取、光标移动、命令和路径补全、删除当前命令、执行命令功能。
    • 普通字符，放入字符串存储等待处理。
流程图

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PsFWhmpP-1667636697536)(6fc6a5a21447eeb3ce2ceeedebc41719.png)]

FinSH shell 状态机

初步阅读代码，我的理解是这个是为了处理上下左右四个键的输入方式而设计的。

WAIT_NORMAL // shell 处于等待接收正常字符的状态

WAIT_SPEC_KEY // shell 处于等待接收方向键的特殊字符的状态

WAIT_FUNC_KEY // shell 处于等待接收功能键的状态

相关的特殊按键的获取方式：

ps:在Win的env工具下仿真模拟msh读取不到上下左右的按键，猜测和windows 和 linux 下的按键的输入值不同有关。

KeyLinuxKeyWindows
Up0x1B 0x5B 0x41Up0xE0 0x48
Down0x1B 0x5B 0x42Down0xE0 0x50
Left0x1B 0x5B 0x44Left0xE0 0x4B
Right0x1B 0x5B 0x43Right0xE0 0x4D
FinSH context
struct finsh_shell
{
    struct rt_semaphore rx_sem;

​    enum input_stat stat;

​    rt_uint8_t echo_mode: 1;
​    rt_uint8_t prompt_mode: 1;

#ifdef FINSH_USING_HISTORY
    rt_uint16_t current_history;
    rt_uint16_t history_count;

​    char cmd_history[FINSH_HISTORY_LINES][FINSH_CMD_SIZE];
#endif

​    char line[FINSH_CMD_SIZE + 1];
​    rt_uint16_t line_position;
​    rt_uint16_t line_curpos;

#if !defined(RT_USING_POSIX_STDIO) && defined(RT_USING_DEVICE)
    rt_device_t device;
#endif

#ifdef FINSH_USING_AUTH
    char password[FINSH_PASSWORD_MAX];
#endif
};
FinSH input信息读取

在rt_hw_board_init(）中调用rt_device_t rt_console_set_device(const char *name)注册了console device。

请添加图片描述

Exxfire
关注
专栏目录
MSH FINSH 对比
假不假，生来只为写代码
09-16 1046
内在的区别我也没看明白，我就把我看到的区别总结下： 最明显的，msh命令都带一个__cmd_， 而finsh命令不带，__cmd_这个前缀是宏定义时加的，使用FINSH_FUNCTION_EXPORT_ALIA 、MSH_CMD_EXPORT这2个宏义就会把命令定义成MSH命令，官方手册也提到了， MSH执行效果 FINSH执行效果 finSH需要在命令后面加上（），美其名曰 “C-Style” 模式， MSH -> exit -> FINSH FINSH-&...
在rt-thread实时系统上自定义Finsh命令
12-14
在rt-thread实时系统上自定义Finsh命令，在控制台上通过指定的命令控制LED灯的闪烁。
[嵌入式系统-65]：RT-Thread-组件：FinSH控制台, 用户与RT Thread OS实时命令行交互工具
最新发布
文火冰糖（王文兵）的博客
05-04 1362
这是因为虽然显示了完整的函数名，但是实际上 FinSH 中却保存了前 16 字节作为命令，过多的输入会导致无法正确找到命令，这时就可以使用 FINSH_FUNCTION_EXPORT_ALIAS 来对导出的命令进行重命名。有了 shell，开发者除了能更快的定位到问题之外，也能利用 shell 调用测试函数，改变测试函数的参数，减少代码的烧录次数，缩短项目的开发时间。FinSH 支持权限验证功能，系统在启动后会进行权限验证，只有权限验证通过，才会开启 FinSH 功能，提升系统输入的安全性。
RT-Thread系列09——Finsh自定义命令
32Haozi
08-09 798
rtthread中finsh自定义命令
RT-Thread中自定义 FinSH 命令
HXYDJ的博客
12-14 4257
在使用RT-Thread中的FinSH 命令时，除了系统默认的FinSH命令以外，我们还可以自定义FinSH命令。下面就来演示一下如何自定义FinSH命令。关于FinSH命令的详细用法请参考官方资料https://www.rt-thread.org/document/site/programming-manual/finsh/finsh/。 要使用FinSH 命令首先要添加FinSH组件，添加组件的详细过程见手把手教你移植RT-Thread系统,FinSH组件添加成后，打开建立...
RT-thread ---- FinSH 控制台
热门推荐
Eureka1024的博客
05-27 1万+
一、介绍 FinSH 是 RT-Thread 的命令行组件（shell），有了 shell，就像在开发者和计算机之间架起了一座沟通的桥梁，开发者能很方便的获取系统的运行情况，并通过命令控制系统的运行。特别是在调试阶段，有了 shell，开发者除了能更快的定位到问题之外，也能利用 shell 调用测试函数，改变测试函数的参数，减少代码的烧录次数，缩短项目的开发时间。 FinSH 支持两种输入模式...
8FinSH波形切换_FinSH控制台_
10-03
FinSH控制台是嵌入式系统中常用的一个命令行接口，它为开发者提供了一个轻量级的Shell环境，便于在设备上进行调试和测试。在本主题“8FinSH波形切换”中，我们将深入探讨如何利用FinSH控制台来控制波形输出，特别是...
stm32f103标准库+rt-thread 3.1.3+finsh
11-02
3. FinSH的集成：学习如何在RT-Thread中添加和配置FinSH，以及如何定义和使用自定义命令。 4. 中断服务程序的编写：理解中断处理机制，编写中断服务函数，确保在中断发生时正确执行。 5. 工程构建与调试：熟悉IDE...
STM32F429_3.1.3_FinSH控制台.zip
06-16
此资源"STM32F429_3.1.3_FinSH控制台.zip"是将RT-Thread RTOS的3.1.3版本移植到STM32F429芯片上，并添加了FinSH控制台功能的示例代码。 RT-Thread是一款实时操作系统，它提供了一个微内核架构，包括任务调度、内存...
RTT（finsh调试）.7z
10-14
STM32-RT Thread finsh调试是嵌入式系统开发中的一个重要环节，它涉及到实时操作系统（RTOS）RT Thread的使用，以及finsh组件的集成与调试。finsh是一个轻量级的命令行接口，用于在RTOS环境下进行快速的程序调试和...
linux平台运行的finsh代码
11-25
实现rthread中的finsh部分在linux上运行，即将rthread中的finsh组件从rthread中抽离出来，并在linux系统上运行。在64bit系统上，当出现FSymTab和VSymTab表存放的FINSH和MSH函数或者变量地址大于32bit时，会出现段...
STM32F429_FinSH控制台.zip
06-09
在本项目中，我们将探讨如何在STM32F429上移植并使用RT-Thread实时操作系统，并添加FinSH控制台功能。 RT-Thread是一个开源、轻量级、实时性优秀的嵌入式操作系统，适用于各种微处理器和微控制器。它提供了丰富的...
rtnano-finsh.rar
04-12
3. **初始化finsh**: 在RTOSNANO的初始化代码中，调用finsh的初始化函数，将finsh与RTOSNANO的任务系统连接起来。 4. **实现命令解析**: finsh使用一种基于C的简单命令解析机制。开发者需要定义自己的命令处理函数...
Qt 实现串口控制台，适配RT-Thread的FinSH控制台功能
04-08
在本文中，我们将深入探讨如何使用Qt来实现一个串口控制台，以便它能与RT-Thread操作系统中的FinSH控制台功能相兼容。这个过程涉及到串口通信、Qt的图形界面设计以及FinSH命令行接口的适配。让我们一步一步地了解这...
RT-Thread-Nano-Finsh
01-12
3. **Finsh shell**：Finsh是RT-Thread提供的一个命令行接口，用于调试和测试。在这个项目中，只有一个主线程与Finsh交互，这意味着用户可以通过串口发送命令，实现对系统的运行状态进行监控和控制。 移植RT-Thread...
FinSH控制台
封狼居胥
04-28 3693
RT-Thread FinSH使用一、FinSH内置命令二、自定义FinSH命令2.1 自定义msh命令2.2 自定义C-style命令三、FinSH功能配置   shell是用户与操作系统间接口的程序，它允许用户向操作系统输入需要执行的命令，并将操作系统的运行结果返回给用户。   FinSH就是RT-Thread的shell（命令行组件），在读取输入命令后，解析并自动扫描内部函数表，寻找对应函数...
RT-thread finsh组件工作流程
weixin_34151004的博客
07-14 589
finsh是RT-Thread的命令行外壳（shell），提供一套供用户在命令行的操作接口，主要用于调试、查看系统信息。在大部分嵌入式系统中，一般开发调试都使用硬件调试器和printf日志打印，在有些情况下，这两种方式并不是那么好用。比如对于RT-Thread这个多线程系统，我们想知道某个时刻系统中的线程运行状态、手动控制系统状态。如果有一个shell，就可以输入命令，直接相应的函数执行获得需要的...
RT-Thread进阶笔记之FinSH组件
sinat_31039061的博客
02-03 1万+
1
FINSH_FUNCTION_EXPORT
11-11
`FINSH_FUNCTION_EXPORT`是一个宏定义，用于将一个函数导出为FinSH命令。FinSH是一个嵌入式系统的命令行调试工具，可以通过串口或网络连接到嵌入式设备，方便地进行调试和测试。使用`FINSH_FUNCTION_EXPORT`宏定义可以将一个函数导出为FinSH命令，从而可以在FinSH命令行中直接调用该函数。下面是一个使用`FINSH_FUNCTION_EXPORT`宏定义导出函数的例子： ```c #include <finsh.h> int add(int a, int b) { return a + b; } FINSH_FUNCTION_EXPORT(add, add two numbers); ``` 上面的代码定义了一个名为`add`的函数，使用`FINSH_FUNCTION_EXPORT`宏定义将其导出为FinSH命令。第一个参数是函数名，第二个参数是命令的描述信息。在FinSH命令行中输入`add 1 2`即可调用该函数并输出结果`3`。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值