下面是FinSH組件的簡介

RT-Thread FinSH 是 RT-Thread 的命令行組件（shell），提供一套供用戶在命令行調用的操作接口，主要用于調試或查看系統信息。它可以使用串口 / 以太網 / USB 等與 PC 機進行通信，使用 FinSH 組件基本命令的效果圖如下所示：

老規矩，先給文件
文件信息如下

移植步驟如下：

1、在keil中添加FinSH源碼

打開未移植FinSH的keil工程，按圖中將shell勾選上，這會把FinSH組件的源碼添加到工程中

然后在rtconfig.h中將#include “finsh_config.h”的注釋釋放掉，如下圖所示

2、ringbuffer實現部分

這一部分我也不是很明白，不過也不需要太明白，官方有示例，直接復制過來即可，這個不會因為芯片不同而產生區別，只把它當作一個緩沖區就可以了

移植代碼直接粘貼到finsh_port.c文件中即可

代碼如下：

/* 第一部分：ringbuffer 實現部分 */
#include
#include
#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;
else
return 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;
else
return 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;
}

3、finsh 移植對接部分

在這一部分我們開始對接finSH組件，對接finSH組件的一個大致流程如下：

當有數據通過串口輸入時，進入串口中斷，在中斷服務函數中將數據存入ringbuffer緩沖區，等數據傳輸完畢，會觸發另一個串口中斷并進入中斷服務函數，告訴finSH組件數據接收完畢，然后finSH組件開始讀取ringbuffer緩沖區中的數據

下面是該部分的移植

3.1 初始化串口中斷

在前兩篇中，我們已經做好了串口初始化，所以我們在這里直接剪切過來即可，將寫圖中代碼剪切

粘貼到下圖中的位置

在finsh_port.c文件中引入串口的頭文件，如圖所示

#include "bsp_usart.h"

然后我們定義幾個需要用到的變量

UART_RX_BUF_LEN是串口接收數據長度宏定義
uart_rx_buf是串口接收緩沖區
uart_rxcb是ringbuffer cb（這個不是很懂，個人理解是用來管理串口接收緩沖區的）
shell_rx_sem是信號量，當串口接收完成后中斷函數會釋放信號量，而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; / 定義一個靜態信號量 */

將他們放到下圖中的位置

在串口初始化函數中初始化ringbuffer cb變量uart_rxcb和信號量shell_rx_sem

/* 初始化串口接收 ringbuffer  */
rt_ringbuffer_init(&uart_rxcb, uart_rx_buf, UART_RX_BUF_LEN);
/* 初始化串口接收數據的信號量 */
rt_sem_init(&(shell_rx_sem), "shell_rx", 0, 0);

將他們放到下圖中的位置

編寫串口中斷服務函數

/* uart 中斷 /
void USART0_IRQHandler(void)
{
int ch;
/ enter interrupt /
rt_interrupt_enter(); //在中斷中一定要調用這對函數，進入中斷
if (usart_interrupt_flag_get(BSP_USART,USART_INT_FLAG_RBNE) == SET) // 接收緩沖區不為空
{
ch = usart_data_receive(BSP_USART);
}
if (usart_interrupt_flag_get(BSP_USART,USART_INT_FLAG_IDLE) == SET) // 檢測到幀中斷
{
usart_data_receive(BSP_USART); // 必須要讀，讀出來的值不能要
ch = '?'; // 數據接收完畢，數組結束標志
rt_sem_release(&shell_rx_sem);
}
/ 讀取到數據，將數據存入 ringbuffer /
rt_ringbuffer_putchar(&uart_rxcb, ch);
/ leave interrupt */
rt_interrupt_leave(); //在中斷中一定要調用這對函數，離開中斷
}

將他們放到下圖中的位置

并將bsp_usart文件中的串口中斷函數注釋掉，如下面圖片所示

3.2 rt_hw_console_getchar函數實現

經過以上的步驟，已成功將官方示例的基礎移植完成，這里只需要將官方示例中的rt_hw_console_getchar函數直接復制過來即可

/* 移植 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;
}

將上面代碼放置到下圖中的位置

以上就實現了在梁山派的Nano上添加FinSH組件（實現命令輸入）

這里直接燒錄通過串口查看即可（記得注釋掉main函數中的rt_kprintf打印函數，實驗現象會明顯一些）

實驗現象如下圖：