发新帖

在 RT-Thread Nano 上添加控制台与 FinSH

[复制链接]
851 0

本文包含源代码、原理图、PCB、封装库、中英文PDF等资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
本片文档分为两部分:第一部分是实现 UART 控制台,该部分只需要实现两个数即可完成 UART 控制台打印功能。第二部分是实现移植 FinSH 组件,实现在控制台输入命令调试系统,该部分实现基于第一部分,只需要添加 FinSH 组件源码并再对接一个系统函数即可实现。下面将对这两部分进行说明。

在 Nano 上添加 UART 控制台


在 RT-Thread Nano 上添加 UART 控制台打印功能后,就可以在代码中使用 RT-Thread 提供的打印函数 rt_kprintf() 进行信息打印,从而获取自定义的打印信息,方便定位代码 bug 或者获取系统当前运行状态等。实现控制台打印(需要确认 rtconfig.h 中已使能 RT_USING_CONSOLE 宏定义),需要完成基本的硬件初始化,以及对接一个系统输出字符的函数,本小节将详细说明。


实现串口初始化


使用串口对接控制台的打印,首先需要初始化串口,如引脚、波特率等。uart_init() 需要在 board.c 中的 rt_hw_board_init() 函数中调用。

  1. /* 实现 1:初始化串口 */
  2. static int uart_init(void);
复制代码



示例代码:如下是基于 HAL 库的 STM32F103 串口驱动,完成添加控制台的示例代码,仅做参考。


  1. static UART_HandleTypeDef UartHandle;
  2. static int uart_init(void)
  3. {
  4.     /* 初始化串口参数,如波特率、停止位等等 */
  5.     UartHandle.Instance = USART1;
  6.     UartHandle.Init.BaudRate   = 115200;
  7.     UartHandle.Init.HwFlowCtl  = UART_HWCONTROL_NONE;
  8.     UartHandle.Init.Mode       = UART_MODE_TX_RX;
  9.     UartHandle.Init.OverSampling = UART_OVERSAMPLING_16;
  10.     UartHandle.Init.WordLength = UART_WORDLENGTH_8B;
  11.     UartHandle.Init.StopBits   = UART_STOPBITS_1;
  12.     UartHandle.Init.Parity     = UART_PARITY_NONE;
  13.     /* 初始化串口引脚等 */
  14.     if (HAL_UART_Init(&UartHandle) != HAL_OK)
  15.     {
  16.         while(1);
  17.     }
  18.     return 0;
  19. }
  20. INIT_BOARD_EXPORT(uart_init);
复制代码


  1. /* board.c */
  2. void rt_hw_board_init(void)
  3. {
  4.     ....
  5.     uart_init();             // 在 rt_hw_board_init 函数中调用 串口初始化 函数
  6.     ....
  7. }
复制代码





实现 rt_hw_console_output



实现 finsh 组件输出一个字符,即在该函数中实现 uart 输出字符:
  1. /* 实现 2:输出一个字符,系统函数,函数名不可更改 */
  2. void rt_hw_console_output(const char *str);
复制代码



93d221bc3e48e4e501909e50f5f72828.png

示例代码
如下是基于STM32F103 HAL 串口驱动对接的 rt_hw_console_output() 函数,实现控制台字符输出,示例仅做参考。
  1. void rt_hw_console_output(const char *str)
  2. {
  3.     rt_size_t i = 0, size = 0;
  4.     char a = '\r';
  5.     __HAL_UNLOCK(&UartHandle);
  6.     size = rt_strlen(str);
  7.     for (i = 0; i < size; i++)
  8.     {
  9.         if (*(str + i) == '\n')
  10.         {
  11.             HAL_UART_Transmit(&UartHandle, (uint8_t *)&a, 1, 1);
  12.         }
  13.         HAL_UART_Transmit(&UartHandle, (uint8_t *)(str + i), 1, 1);
  14.     }
  15. }
复制代码



结果验证
在应用代码中编写含有 rt_kprintf() 打印的代码,编译下载,打开串口助手进行验证。如下图是一个在 main() 函数中每隔 1 秒进行循环打印 Hello RT-Thread 的示例效果:


5d39d80a0a53c41cd4fff9bca6c673b3.png



在 Nano 上添加 FinSH 组件

RT-Thread FinSH 是 RT-Thread 的命令行组件(shell),提供一套供用户在命令行调用的操作接口,主要用于调试或查看系统信息。它可以使用串口 / 以太网 / USB 等与 PC 机进行通信,使用 FinSH 组件基本命令的效果图如下所示:

9eb7d0c2f1a672abf8193608e79f4037.gif

本文以串口 UART 作为 FinSH 的输入输出端口与 PC 进行通信,描述如何在 Nano 上实现 FinSH shell 功能。在 RT-Thread Nano 上添加 FinSH 组件,实现 FinSH 功能的步骤主要如下:
  • 添加 FinSH 源码到工程
  • 实现函数对接



添加 FinSH 源码到工程


KEIL 添加 FinSH 源码
点击 Manage Run-Environment:
1a4345ed2057a402611c481f9edb8c88.png

勾选 shell,这将自动把 FinSH 组件的源码到工程:


cc948c7f947ff6524baa24cb68799276.png



Cube MX 添加 FinSH 源码
打开一个 cube 工程,点击 Additional Software,在 Pack Vendor 中可勾选 RealThread 快速定位 RT-Thread 软件包,然后在 RT-Thread 软件包中勾选 shell,即可添加 FinSH 组件的源码到工程中。
ba69ff15079171781f7b7a08ada861d3.png


其他 IDE 添加 FinSH 源码

其他 IDE 添加 FinSH 源码,需要手动添加 FinSH 源码以及头文件路径到工程中,以 IAR IDE 为例进行结介绍。


1、复制 FinSH 源码到目标裸机工程:直接复制 Nano 源码中 rtthread-nano/components 文件夹下的 finsh 文件夹到工程中,如图:

ea0730fc5b97bff0e538a438f5bfc8ac.png


2、目标工程添加 FinSH 源码:
  • 打开工程,新建 finsh 分组,添加工程中 finsh 文件夹下的所有. c 文件,如下图;
  • 添加 finsh 文件夹的头文件路径(点击 Project -> Options... 进入弹窗进行添加,如下图);
  • 在 rtconfig.h 中添加 #define RT_USING_FINSH 宏定义,这样 FinSH 将生效,如下图。



d653b8b73bf6ae410c674c533de1e971.png

ffffe2c04e6eaad19a14af68383d39df.png

27dab120796fa9286068c4548b8356bd.png


实现 rt_hw_console_getchar

要实现 FinSH 组件功能:既可以打印也能输入命令进行调试,控制台已经实现了打印功能,现在还需要在 board.c 中对接控制台输入函数,实现字符输入:
  1. /* 实现 3:finsh 获取一个字符,系统函数,函数名不可更改 */
  2. char rt_hw_console_getchar(void);
复制代码




  • rt_hw_console_getchar():控制台获取一个字符,即在该函数中实现 uart 获取字符,可以使用查询方式获取(注意不要死等,在未获取到字符时,需要让出 CPU),也可以使用中断方式获取。


示例代码:如下是基于 STM32F103  HAL 串口驱动对接的 rt_hw_console_getchar(),完成对接 FinSH 组件,其中获取字符采用查询方式,示例仅做参考。
  1. char rt_hw_console_getchar(void)
  2. {
  3.     int ch = -1;
  4.     if (__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_RXNE) != RESET)
  5.     {
  6.         ch = UartHandle.Instance->DR & 0xff;
  7.     }
  8.     else
  9.     {
  10.         if(__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_ORE) != RESET)
  11.         {
  12.             __HAL_UART_CLEAR_OREFLAG(&UartHandle);
  13.         }
  14.         rt_thread_mdelay(10);
  15.     }
  16.     return ch;
  17. }
复制代码



结果验证

编译下载代码,打开串口助手,可以在串口助手中打印输入 help 命令,回车查看系统支持的命令:


e4ac6090a66704610e8e0dbc84a1a1a4.png


如果没有成功运行,请检查对接的函数实现是否正确。

移植示例代码

轮询示例
如下是基于 STM32F103  HAL 串口驱动,实现控制台输出与 FinSH Shell,其中获取字符采用查询方式,示例仅做参考。
  1. /* 初始化串口 */
  2. static UART_HandleTypeDef UartHandle;
  3. static int uart_init(void)
  4. {
  5.     /* 初始化串口参数,如波特率、停止位等等 */
  6.     UartHandle.Instance = USART1;
  7.     UartHandle.Init.BaudRate   = 115200;
  8.     UartHandle.Init.HwFlowCtl  = UART_HWCONTROL_NONE;
  9.     UartHandle.Init.Mode       = UART_MODE_TX_RX;
  10.     UartHandle.Init.OverSampling = UART_OVERSAMPLING_16;
  11.     UartHandle.Init.WordLength = UART_WORDLENGTH_8B;
  12.     UartHandle.Init.StopBits   = UART_STOPBITS_1;
  13.     UartHandle.Init.Parity     = UART_PARITY_NONE;
  14.     /* 初始化串口引脚等 */
  15.     if (HAL_UART_Init(&UartHandle) != HAL_OK)
  16.     {
  17.         while(1);
  18.     }
  19.     return 0;
  20. }
  21. INIT_BOARD_EXPORT(uart_init);
  22. /* 移植控制台,实现控制台输出, 对接 rt_hw_console_output */
  23. void rt_hw_console_output(const char *str)
  24. {
  25.     rt_size_t i = 0, size = 0;
  26.     char a = '\r';
  27.     __HAL_UNLOCK(&UartHandle);
  28.     size = rt_strlen(str);
  29.     for (i = 0; i < size; i++)
  30.     {
  31.         if (*(str + i) == '\n')
  32.         {
  33.             HAL_UART_Transmit(&UartHandle, (uint8_t *)&a, 1, 1);
  34.         }
  35.         HAL_UART_Transmit(&UartHandle, (uint8_t *)(str + i), 1, 1);
  36.     }
  37. }
  38. /* 移植 FinSH,实现命令行交互, 需要添加 FinSH 源码,然后再对接 rt_hw_console_getchar */
  39. /* 查询方式 */
  40. char rt_hw_console_getchar(void)
  41. {
  42.     int ch = -1;
  43.     if (__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_RXNE) != RESET)
  44.     {
  45.         ch = UartHandle.Instance->DR & 0xff;
  46.     }
  47.     else
  48.     {
  49.         if(__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_ORE) != RESET)
  50.         {
  51.             __HAL_UART_CLEAR_OREFLAG(&UartHandle);
  52.         }
  53.         rt_thread_mdelay(10);
  54.     }
  55.     return ch;
  56. }
复制代码


中断示例
如下是基于 STM32F103  HAL 串口驱动,实现控制台输出与 FinSH Shell,其中获取字符采用中断方式。原理是,在 uart 接收到数据时产生中断,在中断中释放信号量,tshell 线程接收信号量,然后读取 uart 接收到的数据。示例仅做参考。实际使用时可以自定义一个接收缓冲区,将数据存入缓冲区,防止一次性读入数据过多,造成数据覆盖的现象。
  1. /* 定义一个静态信号量 */
  2. static struct rt_semaphore shell_rx_sem;
  3. /* 初始化串口,中断方式 */
  4. static UART_HandleTypeDef UartHandle;
  5. static int uart_init(void)
  6. {
  7.     /* 初始化串口接收数据的信号量 */
  8.     rt_sem_init(&(shell_rx_sem), "shell_rx", 0, 0);
  9.     /* 初始化串口参数,如波特率、停止位等等 */
  10.     UartHandle.Instance = USART2;
  11.     UartHandle.Init.BaudRate   = 115200;
  12.     UartHandle.Init.HwFlowCtl  = UART_HWCONTROL_NONE;
  13.     UartHandle.Init.Mode       = UART_MODE_TX_RX;
  14.     UartHandle.Init.OverSampling = UART_OVERSAMPLING_16;
  15.     UartHandle.Init.WordLength = UART_WORDLENGTH_8B;
  16.     UartHandle.Init.StopBits   = UART_STOPBITS_1;
  17.     UartHandle.Init.Parity     = UART_PARITY_NONE;
  18.     /* 初始化串口引脚等 */
  19.     if (HAL_UART_Init(&UartHandle) != HAL_OK)
  20.     {
  21.         while(1);
  22.     }
  23.     /* 中断配置 */
  24.     __HAL_UART_ENABLE_IT(&UartHandle, UART_IT_RXNE);
  25.     HAL_NVIC_EnableIRQ(USART2_IRQn);                 
  26.     HAL_NVIC_SetPriority(USART2_IRQn, 3, 3);         
  27.     return 0;
  28. }
  29. INIT_BOARD_EXPORT(uart_init);
  30. /* 移植控制台,实现控制台输出, 对接 rt_hw_console_output */
  31. void rt_hw_console_output(const char *str)
  32. {
  33.     rt_size_t i = 0, size = 0;
  34.     char a = '\r';
  35.     __HAL_UNLOCK(&UartHandle);
  36.     size = rt_strlen(str);
  37.     for (i = 0; i < size; i++)
  38.     {
  39.         if (*(str + i) == '\n')
  40.         {
  41.             HAL_UART_Transmit(&UartHandle, (uint8_t *)&a, 1, 1);
  42.         }
  43.         HAL_UART_Transmit(&UartHandle, (uint8_t *)(str + i), 1, 1);
  44.     }
  45. }
  46. /* 移植 FinSH,实现命令行交互, 需要添加 FinSH 源码,然后再对接 rt_hw_console_getchar */
  47. /* 中断方式 */
  48. char rt_hw_console_getchar(void)
  49. {
  50.     int ch = -1;
  51.     rt_sem_take(&shell_rx_sem, RT_WAITING_FOREVER);  //接收信号量
  52.     ch = UartHandle.Instance->DR & 0xff;             //读取数据
  53.     return ch;
  54. }
  55. /* 在中断服务例程中释放信号量 */
  56. void USART2_IRQHandler(void)
  57. {   
  58.     if((__HAL_UART_GET_FLAG(&UartHandle, UART_FLAG_RXNE) != RESET) &&
  59.             (__HAL_UART_GET_IT_SOURCE(&(UartHandle), UART_IT_RXNE) != RESET)) //接收中断
  60.     {      
  61.         __HAL_UART_CLEAR_FLAG(&(UartHandle), UART_FLAG_RXNE);  //清除中断
  62.         rt_sem_release(&shell_rx_sem);                         //释放信号量
  63.     }
  64. }
复制代码



常见问题

Q: rt_kprintf() 不能打印浮点数吗?
A: 不可以。但是可以通过其他方法实现打印浮点数的目的,比如成倍扩大数值后,分别打印整数与小数部分。
Q: 在实现 FinSH 完整功能时,却不能输入。

5d39d80a0a53c41cd4fff9bca6c673b3.png


A:可能的原因有:UART 驱动未实现字符输入函数、未打开 FinSH 组件等;如果手动开启了 HEAP,需要确定 HEAP 是否过小,导致 tshell 线程创建失败 。
Q: 出现 hard fault。
A: ps 后关注各个线程栈的最大利用率,若某线程出现 100% 的情况,则表示该线程栈过小,需要将值调大。
Q: 使用 AC6 编译的问题。
A: FinSH 移植完成后,使用 AC5 编译并下载是没有问题的,但是使用 AC6 编译会有问题,出现控制台不能输入的情况。这是由于 __CLANG_ARM 这个宏未被定义,造成 FinSH 组件在 rtconfig.h 中没有被打开,可以直接在 rtconfig.h 中定义该宏,如下:
  1. // 方法一,定义 __CLANG_ARM 宏
  2. #if defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
  3. #define __CLANG_ARM
  4. #endif
  5. #if defined(__CC_ARM) || defined(__CLANG_ARM)
  6. #include "RTE_Components.h"
  7. #if defined(RTE_USING_FINSH)
  8. #define RT_USING_FINSH
  9. #endif //RTE_USING_FINSH
  10. #endif //(__CC_ARM) || (__CLANG_ARM)
复制代码

  1. // 方法二,直接定义 RT_USING_FINSH 宏
  2. #define RT_USING_FINSH
复制代码






*滑块验证:
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

更多

客服中心

微信扫描二维码 服务时间:周一至周日 8:30-22:00
快速回复 返回顶部 返回列表