-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathcommand.h
122 lines (98 loc) · 3.12 KB
/
command.h
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
/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
* (C) Copyright 2000
* Wolfgang Denk, DENX Software Engineering, [email protected].
*/
/*
* Definitions for Command Processor
*/
#ifndef __COMMAND_H
#define __COMMAND_H
#include <linux/list.h>
#include <linux/stringify.h>
#include <linux/compiler_types.h>
#include <linux/stddef.h>
#include <string.h>
#include <errno.h>
#ifndef __ASSEMBLY__
extern struct list_head command_list;
#define for_each_command(cmd) list_for_each_entry(cmd, &command_list, list)
struct string_list;
/*
* Monitor Command Table
*/
struct command {
const char *name; /* Command Name */
const char * const *aliases;
/* Implementation function */
int (*cmd)(int, char *[]);
int (*complete)(struct string_list *sl, char *instr);
const char *desc; /* Short command description, start with lowercase */
const char *opts; /* command options */
struct list_head list; /* List of commands */
uint32_t group;
#ifdef CONFIG_LONGHELP
const char *help; /* Help message (long) */
void (*usage)(void);
#endif
};
extern struct command * const __barebox_cmd_start[];
extern struct command * const __barebox_cmd_end[];
/* common/command.c */
#ifdef CONFIG_COMMAND_SUPPORT
struct command *find_cmd(const char *cmd);
int execute_command(int argc, char **argv);
void barebox_cmd_usage(struct command *cmdtp);
int run_command(const char *cmd);
#else
static inline struct command *find_cmd(const char *cmd) { return NULL; }
static inline int execute_command(int argc, char **argv) { return -ENOSYS; }
static inline void barebox_cmd_usage(struct command *cmdtp) {}
static inline int run_command(const char *cmd) { return -ENOSYS; }
#endif
#define COMMAND_SUCCESS 0
#define COMMAND_ERROR 1
#define COMMAND_ERROR_USAGE 2
/* Note: keep this list in sync with commands/help.c */
#define CMD_GRP_INFO 1
#define CMD_GRP_BOOT 2
#define CMD_GRP_ENV 3
#define CMD_GRP_FILE 4
#define CMD_GRP_PART 5
#define CMD_GRP_SCRIPT 6
#define CMD_GRP_NET 7
#define CMD_GRP_CONSOLE 8
#define CMD_GRP_MEM 9
#define CMD_GRP_HWMANIP 10
#define CMD_GRP_MISC 11
#endif /* __ASSEMBLY__ */
#define BAREBOX_CMD_START(_name) \
static struct command __barebox_cmd_##_name; \
const struct command *barebox_cmd_##_name \
__ll_elem(.barebox_cmd_##_name) = &__barebox_cmd_##_name; \
static struct command __barebox_cmd_##_name = { \
.name = #_name,
#define BAREBOX_CMD_END \
};
#ifdef CONFIG_AUTO_COMPLETE
#define BAREBOX_CMD_COMPLETE(_cpt) .complete = _cpt,
#else
#define BAREBOX_CMD_COMPLETE(_cpt)
#endif
#define BAREBOX_CMD_HELP_START(_name) \
static const __maybe_unused char cmd_##_name##_help[] =
#define BAREBOX_CMD_HELP_OPT(_opt, _desc) "\t" _opt "\t" _desc "\n"
#define BAREBOX_CMD_HELP_TEXT(_text) _text "\n"
#define BAREBOX_CMD_HELP_END ;
#ifdef CONFIG_LONGHELP
#define BAREBOX_CMD_HELP(text) .help = text,
#define BAREBOX_CMD_USAGE(fn) .usage = fn,
#else
#define BAREBOX_CMD_HELP(text)
#define BAREBOX_CMD_USAGE(fn)
#endif
#define BAREBOX_CMD_GROUP(grp) .group = grp,
#define BAREBOX_CMD_DESC(text) .desc = text,
#define BAREBOX_CMD_OPTS(text) .opts = text,
int register_command(struct command *);
#endif /* __COMMAND_H */