qinyunti 发表于 2024-7-25 00:05

【瑞萨RA8D1开发板,基于M85内核的图形MCU】移植精简的shell

<div class='showpostmsg'><p>前面我们移植了xprintf可以方便的打印输出和输入,为了方便后面调试开发,我们进一步移植一个精简的shell,实现命令行交互。</p>

<p >&nbsp;</p>

<p >参考微信公众号&rdquo;嵌入式Lee&rdquo;的文章</p>

<p ><a href="https://mp.weixin.qq.com/s/XLmbJn0SKoDT1aLdxHDrbg"><u>https://mp.weixin.qq.com/s/XLmbJn0SKoDT1aLdxHDrbg</u></a>&nbsp;一个超级精简高可移植的shell命令行C实现</p>

<p >&nbsp;</p>

<p >Shell.c如下,完全可移植无需修改</p>

<pre>
<code class="language-cpp">
#include &lt;stdint.h&gt;
#include "shell.h"

shell_read_pf s_input_pf = 0;      /* ??????   */
shell_write_pf s_output_pf = 0;    /* ??????   */
shell_cmd_cfg* s_cmd_cfg_pst = 0;/* ??????   */
uint8_t s_enableecho_u8 = 0;       /* ????echo?? */
static uint8_ts_cmd_buf_au8="\r"; /* ????? */
static uint32_t s_cmd_buf_index_u32 = 0;               /* ??????????? */

/**
* ??????
*/
static void shell_putchar(uint8_t val)
{
    uint8_t tmp;
    if(s_output_pf != 0)
    {
      tmp = val;
      s_output_pf(&amp;tmp, 1);
    }
}

/**
* ???????
*/
static void shell_putstring(char* str)
{
    uint32_t len = 0;
    uint8_t*p = (uint8_t*)str;
    while(*str++)
    {
      len++;
    }
    s_output_pf(p, len);
}

/**
* ?????
*/
static int shell_getchar(uint8_t *data)
{
    if(s_input_pf == 0)
    {
      return -1;
    }
if(0 == s_input_pf(data, 1))
    {
    return -1;
}
else
{
      return 0;
}
}

/**
* ??????????
* ??????????
*/
static uint32_t shell_cmd_len(uint8_t *cmd)
{
    uint8_t *p = cmd;
    uint32_t len = 0;
    while((*p != ' ') &amp;&amp; (*p != 0))
    {
      p++;
      len++;
    }
    return len;
}

/**
* ???????????,????0
*/
static int shell_cmd_check(uint8_t *cmd, uint8_t *str)
{
    uint32_t len1 = shell_cmd_len(cmd);
    uint32_t len2 = shell_cmd_len(str);
    if(len1 != len2)
    {
      return -1;
    }
    for(uint32_t i=0; i&lt;len1; i++)
    {
      if(*cmd++ != *str++)
      {
            return -1;
      }
    }
    return 0;
}

/**
* ??????
*/
static uint32_t shell_read_line(void)
{
    uint8_t ch;
    uint32_t count;
    /* ????sh&gt; */
    if(s_cmd_buf_au8=='\r')
    {
      shell_putstring("sh&gt;\r\n");
      s_cmd_buf_au8 = 0;
    }

    /* ????????? */
    if(shell_getchar(&amp;ch) !=0 )
    {
      return 0;
    }

    /* ???????????????,?????????
   * ????????,????????
    */
    if((ch == '\r' || ch == '\n' || ch &lt; ' ' || ch &gt; '~') &amp;&amp; (ch != '\b'))
    {
      if(s_cmd_buf_index_u32==0)
      {
            /* ?????????????????,?????sh&gt; */
            shell_putstring("sh&gt;\r\n");
      }
      else
      {
            /* ????????,???????????????
             * ?????????,?????,??????
             * ???????0
            */
            count = s_cmd_buf_index_u32;
            s_cmd_buf_au8=0;
            s_cmd_buf_index_u32 =0;
            shell_putstring("\r\n");
            return count;
      }
    }
    else
    {
      if(ch == '\b')
      {
            /* ????,???????????????,????? */
            if(s_cmd_buf_index_u32 != 0)
            {
                s_cmd_buf_index_u32--;
                shell_putchar('\b');
                shell_putchar(' ');
                shell_putchar('\b');
                s_cmd_buf_au8= '\0';
            }
      }
      else
      {
            /* ?????,??????
             * ??????????????-1,?????????
             * -1?????????0??
            */
            if(s_enableecho_u8 != 0)
            {
                shell_putchar(ch);
            }
            s_cmd_buf_au8 = ch;
            if(s_cmd_buf_index_u32&gt;=(sizeof(s_cmd_buf_au8)-1))
            {
                count = s_cmd_buf_index_u32;
                s_cmd_buf_au8=0;
                s_cmd_buf_index_u32 =0;
                shell_putstring("\r\n");
                return count;
            }
      }
    }
    return 0;
}

/**
* ??????????
*/
static int shell_exec_cmdlist(uint8_t* cmd)
{
    int i;
    if(s_cmd_cfg_pst == 0)
    {
      return -1;
    }
    for (i=0; s_cmd_cfg_pst.name != 0; i++)
    {
      if (shell_cmd_check(cmd, s_cmd_cfg_pst.name) == 0)
      {
            s_cmd_cfg_pst.func(cmd);
            return 0;
      }            
    }
    if(s_cmd_cfg_pst.name == 0)
    {
      shell_putstring("unkown command\r\n");
      return -1;
    }
    return 0;
}

/**
* ????,????
*/
void shell_exec(void)
{
    if(shell_read_line() &gt; 0)
    {
      shell_exec_cmdlist(s_cmd_buf_au8);
    }
}

/**
* ????,???????
*/
void shell_set_itf(shell_read_pf input, shell_write_pf output, shell_cmd_cfg* cmd_list, uint8_t enableecho)
{
    s_input_pf = input;
    s_output_pf = output;
    s_cmd_cfg_pst = cmd_list;
    s_enableecho_u8 = enableecho;
}

</code></pre>

<p >Shell.h如下,完全可移植无需修改</p>

<pre>
<code class="language-cpp">#ifndef SHELL_H
#define SHELL_H

#ifdef __cplusplus
extern "C" {
#endif

#include &lt;stdint.h&gt;

#define SHELL_CMD_LEN 512                                          /**&lt; ??????? */

typedef void (*shell_command_pf)(uint8_t *);                      /**&lt; ??????   */
typedef uint32_t (*shell_read_pf)(uint8_t *buff, uint32_t len);   /**&lt; ?????   */
typedef void (*shell_write_pf)(uint8_t *buff, uint32_t len);      /**&lt; ?????   */

/**
* \struct shell_cmd_cfg
* ????
*/
typedef struct
{
    uint8_t * name;          /**&lt; ?????   */
    shell_command_pf func;   /**&lt; ?????? */
    uint8_t * helpstr;       /**&lt; ?????? */   
}shell_cmd_cfg;

/**
* \fn shell_exec
* ???????,??????,????????????
* ???
*/
void shell_exec(void);

/**
* \fn shell_set_itf
* ??????????,??????
* ??shell_exec_shellcmd??,???????????
* \param input \ref shell_read_pf ????
* \param output \ref shell_write_pf ????
* \param cmd_list \ref shell_cmd_cfg ????
* \param enableecho 0:?????, ???:????
*/
void shell_set_itf(shell_read_pf input, shell_write_pf output, shell_cmd_cfg* cmd_list, uint8_t enableecho);

#ifdef __cplusplus
}
#endif

#endif</code></pre>

<p >shell_func.c如下,可以添加自己的命令,默认实现了help命令,打印所有命令信息</p>

<pre>
<code class="language-cpp">
#include &lt;stdio.h&gt;
#include &lt;stdint.h&gt;
#include &lt;string.h&gt;
#include &lt;stdlib.h&gt;
#include "shell.h"
#include "shell_func.h"
#include "xprintf.h"

static void helpfunc(uint8_t* param);


/**
* ???????0,??????
*/
const shell_cmd_cfg g_shell_cmd_list_ast[ ] =
{
{ (uint8_t*)"help",         helpfunc,         (uint8_t*)"help"},
{ (uint8_t*)0,            0 ,               0},
};

void helpfunc(uint8_t* param)
{
    (void)param;
    unsigned int i;
    xprintf("\r\n");
    xprintf("**************\r\n");
    xprintf("*   SHELL    *\r\n");
    xprintf("*   V1.0   *\r\n");
    xprintf("**************\r\n");
    xprintf("\r\n");
    for (i=0; g_shell_cmd_list_ast.name != 0; i++)
    {
      xprintf("%02d.",i);
      xprintf("%-16s",g_shell_cmd_list_ast.name);
      xprintf("%s\r\n",g_shell_cmd_list_ast.helpstr);
    }
}
</code></pre>

<p >Shell_func.h如下</p>

<pre>
<code class="language-cpp">
#ifndef SHELL_FUNC_H
#define SHELL_FUNC_H

#include &lt;stdint.h&gt;

#ifdef __cplusplus
extern "C" {
#endif

extern const shell_cmd_cfg g_shell_cmd_list_ast[ ];
   
#ifdef __cplusplus
}
#endif

#endif</code></pre>

<p >实现接口</p>

<pre>
<code class="language-cpp">static uint32_t shell_read_port(uint8_t *buff, uint32_t len)
{
return uart_read(buff,len);
}

static void shell_write_port(uint8_t *buff, uint32_t len)
{
uart_send(buff,len);
}</code></pre>

<p >设置接口</p>

<p ><b>#include</b>&nbsp;&quot;shell.h&quot;</p>

<p ><b>#include</b>&nbsp;&quot;shell_func.h&quot;</p>

<p >&nbsp;</p>

<p >&nbsp;&nbsp;&nbsp;&nbsp;shell_set_itf(shell_read_port, shell_write_port, (shell_cmd_cfg*)g_shell_cmd_list_ast, 1);</p>

<p >&nbsp;</p>

<p >测试</p>

<pre>
<code class="language-cpp">void blinky_thread_entry (void * pvParameters)
{
uart_init();
xdev_out(xprintf_out_port);
xdev_in(xprintf_in_port);
shell_set_itf(shell_read_port, shell_write_port, (shell_cmd_cfg*)g_shell_cmd_list_ast, 1);

while(1)
{
shell_exec();
vTaskDelay(1);
}</code></pre>

<p >&nbsp;</p>

<p >效果如下,上输入help回车,打印所有支持的命令</p>

<p > &nbsp;</p>

<p >&nbsp;</p>

<p >后面就可以方便添加更多自己的命令,方便调试开发。</p>
</div><script>                                        var loginstr = '<div class="locked">查看本帖全部内容,请<a href="javascript:;"   style="color:#e60000" class="loginf">登录</a>或者<a href="https://bbs.eeworld.com.cn/member.php?mod=register_eeworld.php&action=wechat" style="color:#e60000" target="_blank">注册</a></div>';
                                       
                                        if(parseInt(discuz_uid)==0){
                                                                                                (function($){
                                                        var postHeight = getTextHeight(400);
                                                        $(".showpostmsg").html($(".showpostmsg").html());
                                                        $(".showpostmsg").after(loginstr);
                                                        $(".showpostmsg").css({height:postHeight,overflow:"hidden"});
                                                })(jQuery);
                                        }                </script><script type="text/javascript">(function(d,c){var a=d.createElement("script"),m=d.getElementsByTagName("script"),eewurl="//counter.eeworld.com.cn/pv/count/";a.src=eewurl+c;m.parentNode.insertBefore(a,m)})(document,523)</script>

lugl4313820 发表于 2024-7-25 08:27

<p>&nbsp;</p>

<p>后面就可以方便添加更多自己的命令,方便调试开发。</p>

<p>确实是一个非常好的工具!</p>
页: [1]
查看完整版本: 【瑞萨RA8D1开发板,基于M85内核的图形MCU】移植精简的shell