向vivi中添加自己的命令

时间：2009-05-20 来源：tastesweet

前几天学习了vivi的移植，基本没什么，vivi的移植是很简单，主要还是功能太少了，也只是和与2410的板子，但学习vivi还是很有价值的，如果有vivi的背景，在去学习uboot就会更加容易一些，这里，我们来讨论如何在vivi中添加属于自己的命令，首先我们必须了解vivi的命令是怎么来管理的，在vivi中，所有的命令都是通过一个链表来实现，链表的节点的定义如下：

typedef struct user_command {
    const char *name;
    void (*cmdfunc)(int argc, const char **);
    struct user_command *next_cmd;
    const char *helpstr;
} user_command_t;
typedef struct user_subcommand {
    const char *name;
    void (*cmdfunc)(int argc, const char **);
    const char *helpstr;
} user_subcommand_t;

这里是两个主要的结构体申明，其中最为主要的是struct user_command，这是存储命令的结构体，const char *name存储的就是命令名称，这个结构体在include/command.h文件中申明，void (*cmdfunc)(int argc, const char **)，这是一个指向函数的指针，也就是函数指针， const char *helpstr这里放的帮助信息。这里我们举个例子，如果要添加一条命令:tastesweet,相应的代码为：

// tastesweet命令的实现部分，自己写一个函数就可以了

void tastesweet_cmd(int argc,const char **argv)
{
    printk("just for test ,have fun");
    return ;
}

//构建命令节点
user_command_t tastesweet={
    "tastesweet",//命令名
    tastesweet_cmd, //命令实现函数的指针
    NULL,   //下一个几点的指针，这里赋值为NULL，后边的函数会处理
    "just for test " //帮助信息 vivi下help命令会显示。
};

既然命令是一个链表，下边是命令添加如链表的代码：

int init_builtin_cmds(void)
{
#ifdef CONFIG_DEBUG
    printk("init built-in commands\n");
#endif

#ifdef CONFIG_MD5
    add_command(&md5sum_cmd);
#endif
#ifdef CONFIG_CMD_AMD_FLASH
    add_command(&amd_cmd);
#endif
#ifdef CONFIG_TEST
    add_command(&test_cmd);
#endif
#ifdef CONFIG_CMD_PROMPT
    add_command(&prompt_cmd);
#endif
#ifdef CONFIG_CMD_SLEEP
    add_comamnd(&sleep_cmd);
#endif
#ifdef CONFIG_CMD_BONFS
    add_command(&bon_cmd);
#endif
    add_command(&reset_cmd);
#ifdef CONFIG_CMD_PARAM
    add_command(&param_cmd);
#endif
#ifdef CONFIG_CMD_PART
    add_command(&part_cmd);
#endif
#ifdef CONFIG_CMD_MEM
    add_command(&mem_cmd);
#endif
    add_command(&load_cmd);
    add_command(&go_cmd);
    add_command(&dump_cmd);
    add_command(&call_cmd);
    add_command(&boot_cmd);
    add_command(&help_cmd);
    add_command(&tastesweet); //注意这里，只要调用函数add_command()就可以了。
    return 0;
}

下边是vivi命令链表的操作函数：

void add_command(user_command_t *cmd)//将命令加入链表
{
    if (head_cmd == NULL) {
        head_cmd = tail_cmd = cmd;//很普通的链表操作。
    } else {
        tail_cmd->next_cmd = cmd;
        tail_cmd = cmd;
    }
    /*printk("Registered '%s' command\n", cmd->name);*/
}

/* find command */
user_command_t *find_cmd(const char *cmdname)
{
    user_command_t *curr;

    /* do da string compare for the first offset character of cmdstr
     against each number of the cmdlist */
    curr = head_cmd;//看见strncmp了吗？自己实现的。
    while(curr != NULL) {
        if (strncmp(curr->name, cmdname, strlen(cmdname)) == 0)
            return curr;
        curr = curr->next_cmd;
    }
    return NULL;
}

/* execute a function */
void execcmd(int argc, const char **argv)
{
    user_command_t *cmd = find_cmd(argv[0]);

    if (cmd == NULL) {
        printk("Could not found '%s' command\n", argv[0]);
        printk("If you want to konw available commands, type 'help'\n");
        return;
    }
    /*printk("execcmd: cmd=%s, argc=%d\n", argv[0], argc);*/

    cmd->cmdfunc(argc, argv);
}

/* parse and execute a string */
void exec_string(char *buf)
{
    int argc;
    char *argv[128];
    char *resid;

    while (*buf) {
        memset(argv, 0, sizeof(argv));
        parseargs(buf, &argc, argv, &resid);
        if (argc > 0)
            execcmd(argc, (const char **)argv);
        buf = resid;
    }
}

/*
* For sub-commands
*/
void execsubcmd(user_subcommand_t *cmds, int argc, const char **argv)
{

    while (cmds->name != NULL) {
        if (strncmp(argv[0], cmds->name, strlen(argv[0])) == 0) {
            /*printk("subexeccmd: cmd=%s, argc=%d\n", argv[0], argc);*/
            cmds->cmdfunc(argc, argv);
            return;
        }
        cmds++;
    }
    printk("Could not found '%s' sub-command\n", argv[0]);
}

void print_usage(char *strhead, user_subcommand_t *cmds)
{
    printk("Usage:\n");
    while (cmds->name != NULL) {
        if (strhead)
            printk("%s ", strhead);
        if (*cmds->helpstr)
            printk("%s\n", cmds->helpstr);
        cmds++;
    }
}

void invalid_cmd(const char *cmd_name, user_subcommand_t *cmds)
{
    printk("invalid '%s' command: wrong argumets\n", cmd_name);
    print_usage(" ", cmds);
}

/*
* Define (basic) built-in commands
*/
#if 0

    "help [{cmds}] -- Help about help?"
    "boot [{cmds}] - Booting linux kernel"
    "call <addr> <args> -- Execute binaries"
    "dump <addr> <length> -- Display (hex dump) a range of memory."
    "flash [{cmds}]-- Manage Flash memory"
    "info -- Display vivi information"
    "load [{cmds}] -- Load a file"
    "mem -- Show info about memory"
    "reset -- Reset the System"
    "param [eval|show|save [-n]|reset]"
    "part [ help | add | delete | show | reset ] -- MTD partition"
    "test -- Test items"
#endif

/* help command */
void command_help(int argc, const char **argv)
{
    user_command_t *curr;

    /* help <command>. invoke <command> with 'help' as an argument */
    if (argc == 2) {
        if (strncmp(argv[1], "help", strlen(argv[1])) == 0) {
            printk("Are you kidding?\n");
            return;
        }
        argv[0] = argv[1];
        argv[1] = "help";
        execcmd(argc, argv);
        return;
    }

    printk("Usage:\n");
    curr = head_cmd;
    while(curr != NULL) {
        printk(" %s\n", curr->helpstr);
        curr = curr->next_cmd;
    }
}

这样就可以加入自己的命令了，需要思考的内容是vivi命令链表的管理。

这里要学习vivi的命令实现方式，以后可以创建这样的结构体来管理命令。