RT Thread RTOS应用之二——使用finsh组件.doc

RT Thread RTOS应用之二——使用finsh shell系统
实验描述：开启RTT 的finsh组件；向finsh中添加用户函数；利用finsh观察RTT个线程的运行状态；通过finsh调用用户函数。

实验讲解开始：“每个线程栈应该设定多大最合适？”，“当前到底启动了哪几个线程？”“我的程序没有正常运行，到底是哪个线程出现了问题？”，“我想要随时获得任意变量的数值应该怎么办？”，“我想要在程序运行中，人为插入一些操作应该如何实现？”。这些问题都是使用RTOS的人经常会碰到的，这些问题在传统的OS中并不好解决，需要用户自行设计解决方法。而在RT Thread中却非常容易解决。原因就在于他的finsh shell系统。
RT-Thread的shell系统——finsh，提供了一套供用户在命令行操作的接口，主要用于调试、查看系统信息。finsh被设计成一个不同于传统命令行的C语言表达式解释器：由于很多嵌入式系统都是采用C语言来编写，finsh正是采用了这种系统软件开发人员都会的语法形式，把C语言表达式变成了命令行的风格。它能够解析执行大部分C语言的表达式，也能够使用类似于C语言的函数调用方式访问系统中的函数及全局变量，此外它也能够通过命令行方式创建变量——引自《RT-Thread实时操作系统编程指南》。
移植finsh系统
移植finsh系统非常简单，只需要将rtt文件夹中的components文件夹下的finsh文件夹中的文件添加进入MDK。结果如图：

之后，在MDK中包含finsh的文件路径，以保证可以检测到全部finsh相关的头文件，如下图所示：

开启finsh系统
在RTT中启用finsh系统非常容易，只需要在rtconfig.h头文件中，定义
/* SECTION: finsh, a C-Express shell */
#define RT_USING_FINSH
/* Using symbol table */
#define FINSH_USING_SYMTAB
#define FINSH_USING_DESCRIPTION
这三个宏。其中第一个宏会开启finsh系统。后面两个宏可以使finsh系统支持列表输出和输出函数描述。
修改finsh对应usart端口
默认情况下finsh使用usart1端口，如果你需要更改finsh对应的usart端口，可以按照下面三个步骤来进行：
1. 修改STM32_CONSOLE_USART宏的数值。该宏定义在board.h头文件下。
// <o> Console on USART: <0=> no console <1=>USART 1 <2=>USART 2 <3=> USART 3
// <i>Default: 1
#define STM32_CONSOLE_USART 1
默认是1，表示usart1端口，你可以根据自己的需要修改端口号
2. 修改RT_USING_UART1的数值

/* SECTION: Device System */
/* Using Device System */
#define RT_USING_DEVICE
#define RT_USING_UART1
如果你需要使用usart2的话，需要将这个宏定义成RT_USING_UART2
3. 修改startup.c文件
#ifdef RT_USING_FINSH
/* init finsh */
finsh_system_init();
finsh_set_device("uart1");
#endif
将其中标红的uart1修改成你需要的端口号码，如uart2等。
4. 修改MDK设置
为了保证用户自行添加的函数不会被编译器优化掉，需要修改MDK的设置，如下：

在Misc controls标签下，键入”--keep __fsym_* --keep __vsym_*”这个命令，该命令会保留未被函数主体调用的函数。
至此，finsh的修改和配置就完成了。
连接finsh
Finsh系统通过usart端口与PC端的232串口相连接。调试推荐使用windows自带的超级终端。具体的通讯参数如下：
串口设置：
每秒位数 115200
数据位 8
奇偶校验 无
停止位 1数据流控制 无

下面介绍一下finsh中经常使用的函数
为了照顾C语言编写者的习惯（也就是照顾咱们的习惯），finsh中每个命令后面都需要一个()表示结束，同时如果函数带有参数，参数按照顺序写入（）中。这点和平时C语言书写函数一样。
常用的finsh命令：
1.list_thread()
这个命令可以将当前系统的线程状态返回到超级终端中，通过这个函数我们可以获得当前系统中运行的线程名称，数量，以及其线程栈的使用情况。并且RTT会记录每个线程最大的线程栈使用情况，这样为我们优化程序，降低程序资源占用提供了很大的方便。

2. 宏方式输出函数、变量
当使能了FINSH USING SYMTAB宏时，也能够使用宏输出的方式向finsh shell增加命令。当需要输出函数或变量到finsh shell时，可以通过引用宏：FINSH FUNCTION EXPORT和FINSH VAR EXPORT的方式
例如本例中，为了通过finsh控制LED2的状态，编写了LED2控制函数LED2_control(char state),并且将该函数添加进入finsh系统：
#ifdef RT_USING_FINSH
#include <finsh.h>
void LED2_control(char state)
{
if (state==0)
{
LED2(OFF);//0表示LED2关闭
}
else
{
LED2(ON);//非0表示LED2开启
}
}
FINSH_FUNCTION_EXPORT(LED2_control, control LED2's state);//将该函数添加进入finsh，方便以后调用
#endif
其他的相关finsh命令请参考《RT-Thread实时操作系统编程指南》

程序实现：
本例为建立在第一个例子之上，添加了finsh系统，可以通过超级终端控制野火开发板上的LED2的状态，并且可以通过finsh来获取系统线程状态。具体运行状态为，LED1和LED3不断闪烁，而LED2的状态收到finsh的控制，当输入LED2_control的参数为非0参数时，LED2点亮，否则LED2熄灭。并且输入的参数为char型，请大家注意不要越界。