5 基于 Keil MDK 移植RT-Thread Nano 上移植FinSH

原文地址

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

5.1在 Nano 上添加 UART 控制台

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

5.1.1串口初始化

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

5.1.2实现 rt_hw_console_output

实现 finsh 组件输出一个字符，即在该函数中实现 uart 输出字符：

/*输出一个字符，系统函数，函数名不可更改 */
void rt_hw_console_output(const char *str);

示例代码：如下是基于STM32F103 标准库3.5的串口驱动对接的 rt_hw_console_output() 函数，实现控制台字符输出，示例仅做参考。

注意：RT-Thread 系统中已有的打印均以 \n 结尾，而并非 \r\n，所以在字符输出时，需要在输出 \n 之前输出 \r，完成回车与换行，否则系统打印出来的信息将只有换行。

5.1.3结果验证

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

5.2在 Nano 上添加 FinSH 组件

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

本文以串口 UART 作为 FinSH 的输入输出端口与 PC 进行通信，描述如何在 Nano 上实现 FinSH shell 功能。

在 RT-Thread Nano 上添加 FinSH 组件，实现 FinSH 功能的步骤主要如下：

1.添加 FinSH 源码到工程。
2.实现函数对接。

5.2.1 KEIL 添加 FinSH 源码工程

点击 Manage Run-Environment：

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

添加成功后会有三个文件：

5.2.2实现 rt_hw_console_getchar

要实现 FinSH 组件功能：既可以打印也能输入命令进行调试，控制台已经实现了打印功能，现在还需要在 board.c 中对接控制台输入函数，实现字符输入：

/* finsh 获取一个字符，系统函数，函数名不可更改 */
char rt_hw_console_getchar(void)；

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

5.2.2.1查询方式

如下是基于 STM32F103 标准库3.5的串口驱动对接的 rt_hw_console_getchar()，完成对接 FinSH 组件，其中获取字符采用查询方式，示例仅做参考。

/* 移植 FinSH，实现命令行交互, 需要添加 FinSH 源码，然后再对接 rt_hw_console_getchar */
char rt_hw_console_getchar(void)
{int ch = -1;if (USART_GetFlagStatus(USART1, USART_FLAG_RXNE) != RESET){ch = (int)USART_ReceiveData(USART1);}else{if(USART_GetFlagStatus(USART1, USART_FLAG_ORE) != RESET){USART_ClearFlag(USART1,USART_FLAG_TC);}rt_thread_mdelay(10);}return ch;  
}

5.2.2.2中断方式

如下是基于 STM32F103串口驱动，实现控制台输出与 FinSH Shell，其中获取字符采用中断方式。原理是，在 uart 接收到数据时产生中断，在中断中把数据存入 ringbuffer 缓冲区，然后释放信号量，tshell 线程接收信号量，然后读取存在 ringbuffer 中的数据。

/* 第一部分：ringbuffer 实现部分 */
#include <rtthread.h>
#include <string.h>#define rt_ringbuffer_space_len(rb) ((rb)->buffer_size - rt_ringbuffer_data_len(rb))struct rt_ringbuffer
{rt_uint8_t *buffer_ptr;rt_uint16_t read_mirror : 1;rt_uint16_t read_index : 15;rt_uint16_t write_mirror : 1;rt_uint16_t write_index : 15;rt_int16_t buffer_size;
};enum rt_ringbuffer_state
{RT_RINGBUFFER_EMPTY,RT_RINGBUFFER_FULL,/* half full is neither full nor empty */RT_RINGBUFFER_HALFFULL,
};rt_inline enum rt_ringbuffer_state rt_ringbuffer_status(struct rt_ringbuffer *rb)
{if (rb->read_index == rb->write_index){if (rb->read_mirror == rb->write_mirror)return RT_RINGBUFFER_EMPTY;elsereturn RT_RINGBUFFER_FULL;}return RT_RINGBUFFER_HALFFULL;
}/** * get the size of data in rb */
rt_size_t rt_ringbuffer_data_len(struct rt_ringbuffer *rb)
{switch (rt_ringbuffer_status(rb)){case RT_RINGBUFFER_EMPTY:return 0;case RT_RINGBUFFER_FULL:return rb->buffer_size;case RT_RINGBUFFER_HALFFULL:default:if (rb->write_index > rb->read_index)return rb->write_index - rb->read_index;elsereturn rb->buffer_size - (rb->read_index - rb->write_index);};
}void rt_ringbuffer_init(struct rt_ringbuffer *rb,rt_uint8_t           *pool,rt_int16_t            size)
{RT_ASSERT(rb != RT_NULL);RT_ASSERT(size > 0);/* initialize read and write index */rb->read_mirror = rb->read_index = 0;rb->write_mirror = rb->write_index = 0;/* set buffer pool and size */rb->buffer_ptr = pool;rb->buffer_size = RT_ALIGN_DOWN(size, RT_ALIGN_SIZE);
}/*** put a character into ring buffer*/
rt_size_t rt_ringbuffer_putchar(struct rt_ringbuffer *rb, const rt_uint8_t ch)
{RT_ASSERT(rb != RT_NULL);/* whether has enough space */if (!rt_ringbuffer_space_len(rb))return 0;rb->buffer_ptr[rb->write_index] = ch;/* flip mirror */if (rb->write_index == rb->buffer_size-1){rb->write_mirror = ~rb->write_mirror;rb->write_index = 0;}else{rb->write_index++;}return 1;
}
/*** get a character from a ringbuffer*/
rt_size_t rt_ringbuffer_getchar(struct rt_ringbuffer *rb, rt_uint8_t *ch)
{RT_ASSERT(rb != RT_NULL);/* ringbuffer is empty */if (!rt_ringbuffer_data_len(rb))return 0;/* put character */*ch = rb->buffer_ptr[rb->read_index];if (rb->read_index == rb->buffer_size-1){rb->read_mirror = ~rb->read_mirror;rb->read_index = 0;}else{rb->read_index++;}return 1;
}/* 第二部分：finsh 移植对接部分 */
#define UART_RX_BUF_LEN 16
rt_uint8_t uart_rx_buf[UART_RX_BUF_LEN] = {0};
struct rt_ringbuffer  uart_rxcb;         /* 定义一个 ringbuffer cb */
static struct rt_semaphore shell_rx_sem; /* 定义一个静态信号量 *//*** @brief  USART1 GPIO 配置,工作模式配置。115200 8-N-1* @param  None* @retval None*/
void USART1_Config(void)
{GPIO_InitTypeDef GPIO_InitStructure;USART_InitTypeDef USART_InitStructure;/* 初始化串口接收 ringbuffer  */rt_ringbuffer_init(&uart_rxcb, uart_rx_buf, UART_RX_BUF_LEN);/* 初始化串口接收数据的信号量 */rt_sem_init(&(shell_rx_sem), "shell_rx", 0, 0);/* config USART1 clock */RCC_APB2PeriphClockCmd(RCC_APB2Periph_USART1 | RCC_APB2Periph_GPIOA, ENABLE);/* USART1 GPIO config *//* Configure USART1 Tx (PA.09) as alternate function push-pull */GPIO_InitStructure.GPIO_Pin = GPIO_Pin_9;GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF_PP;GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;GPIO_Init(GPIOA, &GPIO_InitStructure);    /* Configure USART1 Rx (PA.10) as input floating */GPIO_InitStructure.GPIO_Pin = GPIO_Pin_10;GPIO_InitStructure.GPIO_Mode = GPIO_Mode_IN_FLOATING;GPIO_Init(GPIOA, &GPIO_InitStructure);USART_DeInit(USART1);/* USART1 mode config */USART_InitStructure.USART_BaudRate = 115200;USART_InitStructure.USART_WordLength = USART_WordLength_8b;USART_InitStructure.USART_StopBits = USART_StopBits_1;USART_InitStructure.USART_Parity = USART_Parity_No ;USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;USART_InitStructure.USART_Mode = USART_Mode_Rx | USART_Mode_Tx;USART_Init(USART1, &USART_InitStructure);/* 使能串口1接收中断 */USART_ITConfig(USART1, USART_IT_RXNE, ENABLE);USART_Cmd(USART1, ENABLE);
}/*** @brief  配置USART1接收中断* @param  None* @retval None*/
void NVIC_Configuration(void)
{NVIC_InitTypeDef NVIC_InitStructure; /* Configure the NVIC Preemption Priority Bits */  NVIC_PriorityGroupConfig(NVIC_PriorityGroup_0);/* Enable the USARTy Interrupt */NVIC_InitStructure.NVIC_IRQChannel = USART1_IRQn;	 NVIC_InitStructure.NVIC_IRQChannelPreemptionPriority = 0;NVIC_InitStructure.NVIC_IRQChannelSubPriority = 1;NVIC_InitStructure.NVIC_IRQChannelCmd = ENABLE;NVIC_Init(&NVIC_InitStructure);
}/*输出一个字符，系统函数，函数名不可更改 */
void rt_hw_console_output(const char *str)
{rt_size_t  i = 0, size = 0;char a = '\r';/*清楚标志位*/USART_ClearFlag(USART1,USART_FLAG_TC);size = rt_strlen(str);for (i = 0; i < size; i++){if (*(str + i) == '\n'){/* 发送一个字节数据到USART1 */USART_SendData(USART1, (uint8_t) a);/* 等待发送完毕 */while (USART_GetFlagStatus(USART1, USART_FLAG_TC) == RESET);			}/* 发送一个字节数据到USART1 */USART_SendData(USART1, (uint8_t) *(str+i));/* 等待发送完毕 */		while (USART_GetFlagStatus(USART1, USART_FLAG_TC) == RESET);	}
}/* 移植 FinSH，实现命令行交互, 需要添加 FinSH 源码，然后再对接 rt_hw_console_getchar */
/* 中断方式 */
char rt_hw_console_getchar(void)
{char ch = 0;/* 从 ringbuffer 中拿出数据 */while (rt_ringbuffer_getchar(&uart_rxcb, (rt_uint8_t *)&ch) != 1){rt_sem_take(&shell_rx_sem, RT_WAITING_FOREVER);} return ch;   
}/* 第三部分：中断部分*/void USART1_IRQHandler(void)
{int ch = -1;   /* enter interrupt */rt_interrupt_enter();          //在中断中一定要调用这对函数，进入中断if( (USART_GetITStatus(USART1, USART_IT_RXNE) != RESET) && (USART_GetFlagStatus(USART1, USART_FLAG_RXNE) != RESET) ){ 	while (1)      {ch = -1;if(USART_GetITStatus(USART1, USART_IT_RXNE) != RESET){ch = USART_ReceiveData(USART1);}if(ch ==-1){break;}/* 读取到数据，将数据存入 ringbuffer */rt_ringbuffer_putchar(&uart_rxcb, ch);}rt_sem_release(&shell_rx_sem);} /* leave interrupt */rt_interrupt_leave();    //在中断中一定要调用这对函数，离开中断
}

【注】需要确认 rtconfig.h 中已使能 RT_USING_CONSOLE 宏定义

移植完成后，将程序下载到板子中，打开串口助手，在发送去输入字符，点击发送即可进行交互。注意一定要有换行符。

这里推荐使用xshell等工具，用起来就有种Linux终端的感觉。

---

---

代码获取方法

1.长按下面二维码，关注公众号[嵌入式实验楼]
2.在公众号回复关键词[RT-Thread]获取资料

---

欢迎访问我的网站：

BruceOu的哔哩哔哩
BruceOu的主页
BruceOu的博客
BruceOu的CSDN博客
BruceOu的简书