打印
[APM32F4]

nr_micro_shell在APM32 + FreeRTOS平台的移植和使用

[复制链接]
75|0
手机看帖
扫描二维码
随时随地手机跟帖
跳转到指定楼层
楼主
luobeihai|  楼主 | 2024-12-10 22:15 | 只看该作者 |只看大图 回帖奖励 |倒序浏览 |阅读模式
本帖最后由 luobeihai 于 2024-12-10 22:18 编辑

#申请原创# @21小跑堂

1. nr_micro_shell基本介绍

在进行调试和维护时,常常需要与单片机进行交互,获取、设置某些参数或执行某些操作,nr_micro_shell正是为满足这一需求,针对资源较少的MCU编写的基本命令行工具。虽然RT_Thread组件中已经提供了强大的finsh命令行交互工具,但对于ROM、RAM资源较少的单片机,finsh还是略显的庞大,在这些平台上,若仍想保留基本的命令行交互功能,nr_micro_shell是一个不错的选择。

nr_micro_shell具有以下优点:
  • 占用资源少,使用简单,灵活方便。使用过程只涉及两个shell_init()和shell()两个函数,无论是使用RTOS还是裸机都可以方便的应用该工具,不需要额外的编码工作。
  • 交互体验好。完全类似于linux shell命令行,当串口终端支持ANSI(如Hypertrm终端)时,其不仅支持基本的命令行交互,还提供Tab键命令补全,查询历史命令,方向键移动光标修改功能。
  • 扩展性好。nr_micro_shell为用户提供自定义命令的标准函数原型,只需要按照命令编写命令函数,并注册命令函数,即可使用命令。

nr_micro_shell和相同配置下的 finsh (finsh不使用msh)占用资源对比:


两者配置都为:
  • 最多3条历史命令。
  • 支持Tab补全 。
  • 命令行最大长度为100。
  • 最多10个命令参数。
  • 命令行线程堆栈为512字节。

移植完之后的启动效果如下:


作者的代码仓库地址:
https://gitee.com/nrush/nr_micro_shell
2. 在APM32+FreeRTOS上移植使用

我所使用的硬件平台是 APM32F407ZGT6,移植前我们需要准备好可以正常运行 FreeRTOS 和可以正常通过 printf 打印输出到串口终端的工程源码。如果使用裸机的话,那么就不用把 FreeRTOS 添加进来了,而且使用裸机移植会更简单。

要有正常运行 FreeRTOS 和串口工程源码,对于 APM32 来说也很方便,官方的SDK都会提供FreeRTOS的工程源码,我们直接在官方的FreeRTOS的Demo上进行移植 nr_micro_shell 就行。

2.1 添加 nr_micro_shell 源码到工程目录

把下载好的 nr_micro_shell  源码拷贝到APM32 SDK目录下以供待用。


添加 nr_micro_shell /src 目录的所有C文件,和  nr_micro_shell /examples 目录下的 nr_micro_shell_commands.c 文件。


添加头文件路径包含:


2.2 修改 nr_micro_shell_config.h 配置文件

1、把下面第44、45行包含了 RT-Thread 的头文件给注释掉,或者自己定义 NR_MICRO_SHELL_SIMULATOR 这个宏进行头文件包含屏蔽也可以。


2、对于 shell 输出的末尾行模式,我们选择修改为 1 ,即选择 \r 结尾。原来的代码默认是 0,即  \n 结尾,如果选择默认的行结尾模式的话,会导致 shell 终端运行不正常(我踩了这个坑,输入回车之后,命令不会执行。)


其实选择默认的 \n 结尾模式也可以,但是 shell 接收到 \r 结尾符的时候,要多输出一个 \n 。如下代码:

void task_shell(void const * argument)
{
        char ch;
   
        for(;;)
        {
                ch = uart1_get_char();
                shell(ch);
                if (ch == '\r')                        // 遇到 \r 的时候,shell要多接收一个 \n 字符
                        shell('\n');
        }
}

2.3 实现串口输出一个字符函数

在 nr_micro_shell_config.h 文件中的 144、145 行使用到了库函数 printf 和 putchar 函数,我们需要重新实现 fputc  函数才能正常打印输出,不然会导致程序死掉。

fputc 函数代码如下:

int fputc(int ch, FILE* f)
{
    if (ch == '\n')
    {
        /* send a byte of data to the serial port */
        USART_TxData(USART1, '\r');
        /* wait for the data to be send */
        while (USART_ReadStatusFlag(USART1, USART_FLAG_TXBE) == RESET);
    }
    /* send a byte of data to the serial port */
    USART_TxData(USART1, (uint8_t)ch);
    /* wait for the data to be send */
    while (USART_ReadStatusFlag(USART1, USART_FLAG_TXBE) == RESET);

    return (ch);
}

另外,还需要勾选上配置窗口使用 Use MicroLib  。

2.4 实现 shell 接收一个字符函数

shell 接收一个字符的函数,是必须由用户实现的,因为 nr_micro_shell 是无法确定你从什么设备上接收一个字符的。我这里需要实现一个从串口接收一个字符的函数。

因为我使用的是 APM32 + FreeRTOS 来运行 nr_micro_shell ,运行 FreeRTOS 要考虑到阻塞机制,不能让 shell 任务一直不断的运行,所以实现起来稍微麻烦一点点。

思路就是,在串口中断中接收一个字符放进环形缓冲区中,然后串口中断释放信号量唤醒 shell 任务。shell 线程则获取信号量,并且读取环形缓冲区的数据,没数据可读则进入阻塞状态。

1、环形缓冲区实现

#define BUFFER_SIZE 64        /* 环形缓冲区的大小 */
typedef struct
{
        volatile unsigned int pR;           /* 读地址 */
        volatile unsigned int pW;           /* 写地址 */   
    unsigned char buffer[BUFFER_SIZE];  /* 缓冲区空间 */   
} ring_buffer;

/*
*  函数名:void ring_buffer_init(ring_buffer *dst_buf)
*  输入参数:dst_buf --> 指向目标缓冲区
*  输出参数:无
*  返回值:无
*  函数作用:初始化缓冲区
*/
void ring_buffer_init(ring_buffer *dst_buf)
{
    dst_buf->pW = 0;
    dst_buf->pR = 0;
}

/*
*  函数名:void ring_buffer_write(unsigned char c, ring_buffer *dst_buf)
*  输入参数:c --> 要写入的数据
*            dst_buf --> 指向目标缓冲区
*  输出参数:无
*  返回值:无
*  函数作用:向目标缓冲区写入一个字节的数据,如果缓冲区满了就丢掉此数据
*/
void ring_buffer_write(unsigned char c, ring_buffer *dst_buf)
{
    int i = (dst_buf->pW + 1) % BUFFER_SIZE;
    if(i != dst_buf->pR)    // 环形缓冲区没有写满
    {
        dst_buf->buffer[dst_buf->pW] = c;
        dst_buf->pW = i;
    }
}

/*
*  函数名:int ring_buffer_read(unsigned char *c, ring_buffer *dst_buf)
*  输入参数:c --> 指向将读到的数据保存到内存中的地址
*            dst_buf --> 指向目标缓冲区
*  输出参数:无
*  返回值:读到数据返回0,否则返回-1
*  函数作用:从目标缓冲区读取一个字节的数据,如果缓冲区空了返回-1表明读取失败
*/
int ring_buffer_read(unsigned char *c, ring_buffer *dst_buf)
{
    if(dst_buf->pR == dst_buf->pW)
    {
        return -1;
    }
    else
    {
        *c = dst_buf->buffer[dst_buf->pR];
        dst_buf->pR = (dst_buf->pR + 1) % BUFFER_SIZE;
        return 0;
    }
}

2、串口中断代码

static SemaphoreHandle_t uart1_rx_sem;
static ring_buffer uart1_rx_buf = {0, 0, {0}};

void USART1_IRQHandler(void)
{
    int ch = -1;
        static BaseType_t xHigherPriorityTaskWoken = pdFALSE;

    if ((USART_ReadStatusFlag(USART1, USART_FLAG_RXBNE) != RESET) &&
        (USART_ReadIntFlag(USART1, USART_INT_RXBNE) != RESET))
    {
        while (1)
        {
            ch = -1;
            if (USART_ReadStatusFlag(USART1, USART_FLAG_RXBNE) != RESET)
            {
                ch =  USART1->DATA_B.DATA & 0xff;
            }
            if (ch == -1)
            {
                break;
            }
            /* 读取到数据,将数据存入 ringbuffer */
            ring_buffer_write(ch, &uart1_rx_buf);
        }
        /* 释放信号量 */
        xSemaphoreGiveFromISR(uart1_rx_sem, &xHigherPriorityTaskWoken);
    }
}

3、获取一个字符函数实现

char uart1_get_char(void)
{
        unsigned char ch;
        while (ring_buffer_read(&ch, &uart1_rx_buf) != 0)
        xSemaphoreTake(uart1_rx_sem, portMAX_DELAY);
               
        return ch;
}

3. 使用结果演示

编写完上面要用到的代码之后,我们在 main 函数中创建一个 shell 任务。

/* 任务函数 */
void task_shell(void const * argument)
{
        /* USER CODE BEGIN StartDefaultTask */
        char ch;
        /* Infinite loop */
        for(;;)
        {
        /* 获取串口输入,然后解析执行命令 */
                ch = uart1_get_char();
                shell(ch);
        }
        /* USER CODE END StartDefaultTask */
}

xTaskCreate((TaskFunction_t )task_shell,                    //任务函数
            (const char*    )"task_shell",           //任务名称
            (uint16_t       )512,                                 //任务堆栈大小
            (void*          )NULL,                              //传递给任务函数的参数
            (UBaseType_t    )10,                                        //任务优先级
            (TaskHandle_t*  )NULL);                              //任务句柄

编译下载后,打开 MobaXterm 终端软件,可以看到 shell 运行起来了,而且也可以运行命令。如下图:


目前只实现了两条命令,如果用户需要执行更多的命令,可以自己添加,然后导出到到命令列表就行。

发现一些问题:nr_micro_shell 还不支持一些特殊的按键,如果按下了这些特殊按键会导致程序崩溃。而且在使用方向键获取历史命令的时候,会把前导符 ”:“ 给覆盖掉,所以还是有些需要完善的地方的。

下面的附件是整个工程的源码,上传以供大家参考。

APM32F4xx_SDK_V1.4_nr_micro_shell.zip (6.49 MB)




使用特权

评论回复
发新帖 我要提问
您需要登录后才可以回帖 登录 | 注册

本版积分规则

17

主题

67

帖子

2

粉丝