1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
*
* (C) Copyright 2000-2009
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*
* SPDX-License-Identifier: GPL-2.0
*/
/*
* Definitions for Command Processor
*/
#ifndef __COMMAND_H
#define __COMMAND_H
#include "common.h"
#include "config.h"
#include <setjmp.h>
#ifndef NULL
#define NULL 0
#endif
/* Default to a width of 8 characters for help message command width */
#ifndef CONFIG_SYS_HELP_CMD_WIDTH
#define CONFIG_SYS_HELP_CMD_WIDTH 8
#endif
/*
* Error codes that commands return to cmd_process(). We use the standard 0
* and 1 for success and failure, but add one more case - failure with a
* request to call cmd_usage(). But the cmd_process() function handles
* CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
* This is just a convenience for commands to avoid them having to call
* cmd_usage() all over the place.
*/
typedef enum {
CMD_RET_SUCCESS = 0, /* Success */
CMD_RET_FAILURE = 1, /* Failure */
CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
} command_ret_t;
/*
* Monitor Command Table
*/
typedef const FLASH struct cmd_tbl_s cmd_tbl_t;
struct cmd_tbl_s {
const FLASH char *name; /* Command Name */
uint8_t maxargs; /* maximum number of arguments */
uint8_t flags; /* autorepeat allowed? */
/* Implementation function */
command_ret_t (*cmd)(const FLASH struct cmd_tbl_s *, uint_fast8_t, int, char * const []);
const FLASH char *usage; /* Usage message (short) */
#ifdef CONFIG_SYS_LONGHELP
const FLASH char *help; /* Help message (long) */
#endif
cmd_tbl_t *subcmd;
// const FLASH struct cmd_tbl_s *subcommands;
#ifdef CONFIG_AUTO_COMPLETE
/* do auto completion on the arguments */
int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
#endif
};
/**
* Process a command with arguments. We look up the command and execute it
* if valid. Otherwise we print a usage message.
*
* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
* @param argc Number of arguments (arg 0 must be the command text)
* @param argv Arguments
* @param repeatable This function sets this to 0 if the command is not
* repeatable. If the command is repeatable, the value
* is left unchanged.
* @return 0 if the command succeeded, 1 if it failed
*/
command_ret_t
cmd_process(uint_fast8_t flag, int argc, char * const argv[], uint_fast8_t *repeatable);
/* command.c */
command_ret_t do_help(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
int cmd_tbl_item_count(cmd_tbl_t *p);
command_ret_t cmd_usage(cmd_tbl_t *cmdtp);
#ifdef CONFIG_AUTO_COMPLETE
extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
extern int cmd_auto_complete(const FLASH char *const prompt, char *buf, int *np, int *colp);
#endif
/**
* cmd_process_error() - report and process a possible error
*
* @cmdtp: Command which caused the error
* @err: Error code (0 if none, -ve for error, like -EIO)
* @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
*/
int cmd_process_error(cmd_tbl_t *cmdtp, int err);
/*
* Monitor Command
*
* All commands use a common argument format:
*
* void function (cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
*/
#ifdef CONFIG_CMD_BOOTD
extern command_ret_t do_bootd(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
#endif
#ifdef CONFIG_CMD_BOOTM
extern command_ret_t do_bootm(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
#else
static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp UNUSED, const char *cmd UNUSED)
{
return 0;
}
#endif
extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
char *const argv[]);
/*
* Command Flags:
*/
#define CMD_FLAG_REPEAT 0x01 /* repeat last command */
#define CMD_FLAG_BOOTD 0x02 /* command is from bootd */
/*
* Flags for command table:
*/
#define CTBL_REPEAT 0x01 /* command is repeatable */
#define CTBL_SUBCMD 0x02 /* command has subcommands */
#define CTBL_SUBCMDAUTO 0x04 /* execute subcommands whithout prefix*/
#ifdef CONFIG_AUTO_COMPLETE
# define _CMD_COMPLETE(x) x,
#else
# define _CMD_COMPLETE(x)
#endif
#ifdef CONFIG_SYS_LONGHELP
# define _CMD_HELP(x) x,
#else
# define _CMD_HELP(x)
#endif
#define CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
_usage, _help, _subtbl, _comp) \
{ FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \
_CMD_HELP(FSTR(_help)) _subtbl, _CMD_COMPLETE(_comp) }
#define CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \
_usage, _help, _comp) \
{ FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \
_CMD_HELP(FSTR(_help)) NULL, _CMD_COMPLETE(_comp) }
#define CMD_TBL_ITEM(_name, _maxargs, _rep, _cmd, _usage, _help) \
CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
_usage, _help, NULL, NULL)
#define CMD_TBL_ITEM_TOP(_name, _maxargs, _rep, _cmd, _usage, _help, _subtbl) \
CMD_TBL_ITEM_FULL(_name, _maxargs, _rep, _cmd, \
_usage, _help, _subtbl, NULL)
#define CMD_TBL_END(_table_start) { .subcmd = _table_start }
typedef command_ret_t (*do_cmd_t)(cmd_tbl_t *, uint_fast8_t, int, char * const []);
extern cmd_tbl_t cmd_tbl[];
extern jmp_buf cmd_jbuf;
#endif /* __COMMAND_H */
|
