STM32 添加shell(命令解释器)及shell指令
STM32 添加shell(命令解释器)及shell指令
本文将介绍如何在STM32微控制器上添加一个功能丰富的Shell命令解释器。这个Shell环境支持tab键补全、历史记录等功能，并且可以与多个交互接口（如串口、Telnet等）协同工作。文章将详细讲解在STM32F4系列单片机上实现这一功能的具体步骤，包括UART配置、FreeRTOS集成、代码移植、初始化设置以及用户命令注册等关键环节。
Shell说明
源码地址：https://gitee.com/somebug/atomlib
shell 层与硬件无关，有无操作系统都可以使用，适用于stm32等32位小端的单片机，支持历史纪录功能，tab 键补全命令，提供命令行参数解释函数，可以响应tab、backspace、上下左右编辑等功能，并提供一个简易版的vi 文本编辑功能。支持多交互接口，各个接口间数据流互不影响。
其中此文件夹中的文件都与硬件平台无关，但可能与编译平台有关。此库编译版本要在C99以上，或用GCC编译。根据不同的硬件平台分别写了不同的控制台demo， F1 文件夹的是STM32F1 相关的控制台， F4 则是 F4xx 系列的控制台。
文件说明：
- avltree.c :平衡二叉树相关实现代码，在注册命令较多的时候可以启用平衡二叉树进行索引匹配；
- getopt.c :有些编译环境，如 KEIL5 中，没有函数getopt() ,这是其源码，是我在网上找的。要是用 gcc 相关的编译平台可以 #include <unistd.h> 找到 getopt() 函数支持；
- heaplib.c : 内存管理，其实这个是我原封不动从freertos 的 heap_4.c 拷过来的，在heaplib.h 提供了部分宏支持，可以脱离操作系统使用；
- shell.c:命令行相关，支持 table 键补全，支持上下左右箭头响应，提供参数解析，历史纪录。支持多个交互，如串口，telnet，或者usb，可各自建立交互；
- tasklib.c:协程控制器。有需要的话使用协程可以简化代码的编写。我把它模拟成一个操作系统；
- ustdio.c:提供 printk 函数，重定义 printf 函数；
- vim.c:这是我仿照 linux 的 vi 写的一个建议的文本编辑器，依赖 shell ，可以实现简易的文本编辑；
- F1/F4/L1:不同硬件平台的相关串口控制台实现，提供串口在线升级功能；
- LittleFS: LittleFS 是一个用于 spi flash 的文件系统，先放这；
STM32 F4系列添加shell
1. UART配置
模式为异步模式，硬件流控为Disable，因为我直接了TX RX，波特率一般为115200, 8 Bits，根据需要可自定义设置；使能UART中断，然后生成代码。
2. 添加FreeRTOS* (非必要)
我是用了RTOS系统，添加了一个SHELL_TASK，默认在SHELL_TASK中进行接收完一包数据的处理。
这里都设置为Enabled，不然一直会有警告。
3. 拷贝必要文件到工程目录
从拉下来的atomlib-master库里拷贝containerof.h、getopt.c、getopt.h、shell.c、shell.h、ustdio.c、ustdio.h这几个文件添加到工程目录，我这里新建了一个Common文件夹；
将Common目录添加进Include Path里；
4. 添加shell初始化及UART收发代码
4.1 在usart.c中添加uart发送函数
/* USER CODE BEGIN 1 */
void usart4_puts(char* data, uint16_t len)
{
HAL_UART_Transmit(&huart4, (uint8_t *)data, len, HAL_MAX_DELAY);
}
/* USER CODE END 1 */
4.2 在stm32f4xx_it.c中重写串口回调的callback函数
/* Private variables ---------------------------------------------------------*/
/* USER CODE BEGIN PV */
char uart4_rx_buf[512] = {0};
uint16_t uart4_tail = 0;
// To receive a packet of data
volatile uint16_t uart4_pkt_complete = 0;
/* USER CODE END PV */
/* 修改usart4的中断函数，添加空闲中断处理代码 */
void UART4_IRQHandler(void)
{
/* USER CODE BEGIN UART4_IRQn 0 */
/* USER CODE END UART4_IRQn 0 */
HAL_UART_IRQHandler(&huart4);
/* USER CODE BEGIN UART4_IRQn 1 */
if (RESET != __HAL_UART_GET_FLAG(&huart4, UART_FLAG_IDLE)) {
uart4_pkt_complete = 1;
__HAL_UART_CLEAR_IDLEFLAG(&huart4);
}
/* USER CODE END UART4_IRQn 1 */
}
/* USER CODE BEGIN 1 */
void HAL_UART_RxCpltCallback(UART_HandleTypeDef* huart)
{
if (huart == &huart4) {
HAL_UART_Receive_IT(&huart4, (uint8_t *)&uart4_rx_buf[++uart4_tail], 1);
}
}
/* USER CODE END 1 */
4.3 初始化shell代码
在main.c中include “shell.h”，新建一个交互usart4_shell；
#include "shell.h"
/* ... */
/* Private variables ---------------------------------------------------------*/
/* USER CODE BEGIN PV */
struct shell_input usart4_shell;
extern char uart4_rx_buf[512];
extern uint16_t uart4_tail;
extern volatile uint16_t uart4_pkt_complete;
/* USER CODE END PV */
int main(void)
{
MX_GPIO_Init();
MX_DMA_Init();
MX_UART4_Init();
/* ... */
/* Shell Init */
shell_init("BBOrange:/ $ ", (fmt_puts_t) usart4_puts); //初始化默认标志，初始化默认输出
shell_input_init(&usart4_shell, (fmt_puts_t) usart4_puts); //初始化usart4的交互
HAL_UART_Receive_IT(&huart4, (uint8_t *)&uart4_rx_buf[0], 1); //打开串口中断的接收
__HAL_UART_ENABLE_IT(&huart4, UART_IT_IDLE); //使能空闲中断
while (1)
{
/* USER CODE END WHILE */
/* USER CODE BEGIN 3 */
}
}
在freertos.c中添加对接收完一包数据的处理以及循环接收，注意include必要的头文件；
/* Private variables ---------------------------------------------------------*/
/* USER CODE BEGIN Variables */
extern UART_HandleTypeDef huart4;
extern struct shell_input usart4_shell;
extern char uart4_rx_buf[512];
extern uint16_t uart4_tail;
extern volatile uint16_t uart4_pkt_complete;
/* USER CODE END Header_start_shell_task */
void start_shell_task(void const * argument)
{
/* USER CODE BEGIN start_shell_task */
/* Infinite loop */
for(;;)
{
/* 接收一整包数据 */
if (uart4_pkt_complete) {
shell_input(&usart4_shell, uart4_rx_buf, uart4_tail);
uart4_tail = 0;
uart4_pkt_complete = 0;
HAL_UART_AbortReceive(&huart4);
HAL_UART_Receive_IT(&huart4, (uint8_t*)&uart4_rx_buf[0], 1);
}
osDelay(1);
}
/* USER CODE END start_shell_task */
}
运行效果如下，支持tab补全、以及上下左右按键的功能：
5. 用户命令注册
使用shell_register_command(name, func)来注册自定义shell命令，定义在shell.h中，原型如下：
/* name为名称，必须为常量字符串指针 */
/* func为命令执行函数 */
#define shell_register_command(name,func)\
do{\
static struct shellcommand newcmd = {0};\
_shell_register(&newcmd,name,func); \
}while(0)
在shell_init中调用shell_register_command注册：
void shell_init(char * defaultsign ,fmt_puts_t puts)
{
if (defaultsign)
strncpy(DEFAULT_INPUTSIGN,defaultsign,COMMANDLINE_MAX_LEN);
//strcpy(DEFAULT_INPUTSIGN,defaultsign);
current_puts = puts ;
default_puts = puts ;
/* 注册一些基本命令 */
shell_register_command("cmd-list" ,shell_list_cmd);
shell_register_command("shell-version",shell_version);
shell_register_command("clear" ,shell_clean_screen);
shell_register_command("debug-info" ,shell_debug_stream);
/* New added */
shell_register_command("icm42688-get-temperature", shell_icm42688_temperature);
shell_register_command("icm42688-get-data", shell_icm42688_data);
}
实现shell_icm42688_data函数，若自定义命令带参数，可将getopt导入到工程：
cmdline_strtok()是对命令行的输入字符串进行分割，把输入分割为一串指针数组输出到argv[]中。需要注意的是这个函数会改变命令行的输入内存内容(把空格替换了字符串结束符);
static void shell_icm42688_data(void * arg)
{
int opt, argc;
char* argv[8];
int data_count = 0;
uint32_t para_mask = 0;
argc = cmdline_strtok((char*)arg, argv, 8);
optind = 1;
while ((opt = getopt(argc, argv, "c:t")) != -1) {
switch (opt) {
case 'c':
data_count = atoi(optarg);
para_mask |= (uint32_t) data_count;
break;
case 't':
para_mask |= (uint32_t) 1 << 17;
break;
default:
printk("No parameters!\r\n");
break;
}
}
if (xTaskNotify(SENSOR_TASKHandle, (uint32_t)para_mask, eSetValueWithOverwrite) != pdPASS) {
printk("Send notification to sensor task failed!\r\n");
}
}
optind是索引，例如我们的指令为icm42688-get-data -c 100，那cmdline_strtok()拆出来的argv如下：
getopt()会依次检查你的参数是否有‘c’以及c后携带的参数