2002-08-27 10:27:51 +00:00
|
|
|
/*
|
|
|
|
* (C) Copyright 2000
|
|
|
|
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
|
|
|
|
*
|
|
|
|
* See file CREDITS for list of people who contributed to this
|
|
|
|
* project.
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License as
|
|
|
|
* published by the Free Software Foundation; either version 2 of
|
|
|
|
* the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Definitions for Command Processor
|
|
|
|
*/
|
|
|
|
#ifndef __COMMAND_H
|
|
|
|
#define __COMMAND_H
|
|
|
|
|
2009-11-02 13:31:18 +00:00
|
|
|
#include <linux/list.h>
|
2010-09-27 10:52:17 +00:00
|
|
|
#include <linux/stringify.h>
|
2007-10-11 19:58:51 +00:00
|
|
|
|
2002-08-27 10:27:51 +00:00
|
|
|
#ifndef NULL
|
|
|
|
#define NULL 0
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef __ASSEMBLY__
|
2007-10-11 19:58:51 +00:00
|
|
|
|
|
|
|
extern struct list_head command_list;
|
|
|
|
|
|
|
|
#define for_each_command(cmd) list_for_each_entry(cmd, &command_list, list)
|
|
|
|
|
2011-06-06 15:14:38 +00:00
|
|
|
struct string_list;
|
|
|
|
|
2002-08-27 10:27:51 +00:00
|
|
|
/*
|
|
|
|
* Monitor Command Table
|
|
|
|
*/
|
2010-01-04 09:21:11 +00:00
|
|
|
struct command {
|
2008-04-04 09:46:55 +00:00
|
|
|
const char *name; /* Command Name */
|
|
|
|
const char **aliases;
|
2002-08-27 10:27:51 +00:00
|
|
|
/* Implementation function */
|
2011-12-21 13:18:57 +00:00
|
|
|
int (*cmd)(int, char *[]);
|
2011-06-06 15:14:38 +00:00
|
|
|
int (*complete)(struct string_list *sl, char *instr);
|
commands: harmonize in-barebox documentation
This patch does probably too much, but it's hard (and very
cumbersome/time consuming) to break it out. What is does is this:
* each command has one short description, e.g. "list MUX configuration"
* made sure the short descriptions start lowercase
* each command has one usage. That string contains just the
options, e.g. "[-npn]". It's not part of the long help text.
* that is, it doesn't say "[OPTIONS]" anymore, every usable option
is listed by character in this (short) option string (the long
description is in the long help text, as before)
* help texts have been reworked, to make them
- sometimes smaller
- sometimes describe the options better
- more often present themselves in a nicer format
* all long help texts are now created with BUSYBOX_CMD_HELP_
macros, no more 'static const __maybe_unused char cmd_foobar_help[]'
* made sure the long help texts starts uppercase
* because cmdtp->name and cmdtp->opts together provide the new usage,
all "Usage: foobar" texts have been removed from the long help texts
* BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this
is nicer in the source code
* BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself
* made sure no line gets longer than 77 characters
* delibertely renamed cmdtp->usage, so that we can get compile-time
errors (e.g. in out-of-tree modules that use register_command()
* the 'help' command can now always emit the usage, even without
compiled long help texts
* 'help -v' gives a list of commands with their short description, this
is similar like the old "help" command before my patchset
* 'help -a' gives out help of all commands
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 08:28:42 +00:00
|
|
|
const char *desc; /* Short command description, start with lowercase */
|
|
|
|
const char *opts; /* command options */
|
2007-10-11 19:58:51 +00:00
|
|
|
|
|
|
|
struct list_head list; /* List of commands */
|
commands: group 'help' output
The old output of "help" was just producing a long list, that usually
scrolled of the screen (even on a X11 terminal). This list is more
compact, and also sorted by groups.
The old output format (plus grouping) is now available with 'help -v'.
Example:
Information commands:
?, devinfo, help, iomem, meminfo, version
Boot commands:
boot, bootm, go, loadb, loads, loadx, loady, saves, uimage
...
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 14:14:05 +00:00
|
|
|
uint32_t group;
|
2007-07-05 16:01:33 +00:00
|
|
|
#ifdef CONFIG_LONGHELP
|
2008-04-04 09:46:55 +00:00
|
|
|
const char *help; /* Help message (long) */
|
2002-08-27 10:27:51 +00:00
|
|
|
#endif
|
2007-07-05 16:01:57 +00:00
|
|
|
}
|
|
|
|
#ifdef __x86_64__
|
|
|
|
/* This is required because the linker will put symbols on a 64 bit alignment */
|
|
|
|
__attribute__((aligned(64)))
|
|
|
|
#endif
|
|
|
|
;
|
|
|
|
|
2010-01-04 09:21:11 +00:00
|
|
|
extern struct command __barebox_cmd_start;
|
|
|
|
extern struct command __barebox_cmd_end;
|
2002-08-27 10:27:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
/* common/command.c */
|
2010-01-04 09:21:11 +00:00
|
|
|
struct command *find_cmd(const char *cmd);
|
2009-10-17 10:01:14 +00:00
|
|
|
int execute_command(int argc, char **argv);
|
2010-01-04 09:21:11 +00:00
|
|
|
void barebox_cmd_usage(struct command *cmdtp);
|
2002-08-27 10:27:51 +00:00
|
|
|
|
2009-10-17 10:23:03 +00:00
|
|
|
#define COMMAND_SUCCESS 0
|
|
|
|
#define COMMAND_ERROR 1
|
|
|
|
#define COMMAND_ERROR_USAGE 2
|
|
|
|
|
commands: harmonize in-barebox documentation
This patch does probably too much, but it's hard (and very
cumbersome/time consuming) to break it out. What is does is this:
* each command has one short description, e.g. "list MUX configuration"
* made sure the short descriptions start lowercase
* each command has one usage. That string contains just the
options, e.g. "[-npn]". It's not part of the long help text.
* that is, it doesn't say "[OPTIONS]" anymore, every usable option
is listed by character in this (short) option string (the long
description is in the long help text, as before)
* help texts have been reworked, to make them
- sometimes smaller
- sometimes describe the options better
- more often present themselves in a nicer format
* all long help texts are now created with BUSYBOX_CMD_HELP_
macros, no more 'static const __maybe_unused char cmd_foobar_help[]'
* made sure the long help texts starts uppercase
* because cmdtp->name and cmdtp->opts together provide the new usage,
all "Usage: foobar" texts have been removed from the long help texts
* BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this
is nicer in the source code
* BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself
* made sure no line gets longer than 77 characters
* delibertely renamed cmdtp->usage, so that we can get compile-time
errors (e.g. in out-of-tree modules that use register_command()
* the 'help' command can now always emit the usage, even without
compiled long help texts
* 'help -v' gives a list of commands with their short description, this
is similar like the old "help" command before my patchset
* 'help -a' gives out help of all commands
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 08:28:42 +00:00
|
|
|
/* Note: keep this list in sync with commands/help.c */
|
commands: group 'help' output
The old output of "help" was just producing a long list, that usually
scrolled of the screen (even on a X11 terminal). This list is more
compact, and also sorted by groups.
The old output format (plus grouping) is now available with 'help -v'.
Example:
Information commands:
?, devinfo, help, iomem, meminfo, version
Boot commands:
boot, bootm, go, loadb, loads, loadx, loady, saves, uimage
...
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 14:14:05 +00:00
|
|
|
#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
|
|
|
|
|
2002-08-27 10:27:51 +00:00
|
|
|
#endif /* __ASSEMBLY__ */
|
|
|
|
|
2009-12-15 08:11:09 +00:00
|
|
|
#define Struct_Section __attribute__ ((unused,section (".barebox_cmd")))
|
2003-06-27 21:31:46 +00:00
|
|
|
|
2010-10-15 06:23:34 +00:00
|
|
|
#define BAREBOX_CMD_START(_name) \
|
|
|
|
extern const struct command __barebox_cmd_##_name; \
|
|
|
|
const struct command __barebox_cmd_##_name \
|
|
|
|
__attribute__ ((unused,section (".barebox_cmd_" __stringify(_name)))) = { \
|
2007-07-05 16:01:52 +00:00
|
|
|
.name = #_name,
|
2003-06-27 21:31:46 +00:00
|
|
|
|
2009-12-15 08:11:09 +00:00
|
|
|
#define BAREBOX_CMD_END \
|
2007-07-05 16:01:52 +00:00
|
|
|
};
|
2011-06-06 15:14:38 +00:00
|
|
|
#ifdef CONFIG_AUTO_COMPLETE
|
|
|
|
#define BAREBOX_CMD_COMPLETE(_cpt) .complete = _cpt,
|
|
|
|
#else
|
|
|
|
#define BAREBOX_CMD_COMPLETE(_cpt)
|
|
|
|
#endif
|
2003-06-27 21:31:46 +00:00
|
|
|
|
2010-07-12 16:03:05 +00:00
|
|
|
#define BAREBOX_CMD_HELP_START(_name) \
|
|
|
|
static const __maybe_unused char cmd_##_name##_help[] =
|
|
|
|
|
commands: harmonize in-barebox documentation
This patch does probably too much, but it's hard (and very
cumbersome/time consuming) to break it out. What is does is this:
* each command has one short description, e.g. "list MUX configuration"
* made sure the short descriptions start lowercase
* each command has one usage. That string contains just the
options, e.g. "[-npn]". It's not part of the long help text.
* that is, it doesn't say "[OPTIONS]" anymore, every usable option
is listed by character in this (short) option string (the long
description is in the long help text, as before)
* help texts have been reworked, to make them
- sometimes smaller
- sometimes describe the options better
- more often present themselves in a nicer format
* all long help texts are now created with BUSYBOX_CMD_HELP_
macros, no more 'static const __maybe_unused char cmd_foobar_help[]'
* made sure the long help texts starts uppercase
* because cmdtp->name and cmdtp->opts together provide the new usage,
all "Usage: foobar" texts have been removed from the long help texts
* BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this
is nicer in the source code
* BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself
* made sure no line gets longer than 77 characters
* delibertely renamed cmdtp->usage, so that we can get compile-time
errors (e.g. in out-of-tree modules that use register_command()
* the 'help' command can now always emit the usage, even without
compiled long help texts
* 'help -v' gives a list of commands with their short description, this
is similar like the old "help" command before my patchset
* 'help -a' gives out help of all commands
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 08:28:42 +00:00
|
|
|
#define BAREBOX_CMD_HELP_OPT(_opt, _desc) "\t" _opt "\t" _desc "\n"
|
|
|
|
#define BAREBOX_CMD_HELP_TEXT(_text) _text "\n"
|
2010-07-12 16:03:05 +00:00
|
|
|
#define BAREBOX_CMD_HELP_END ;
|
|
|
|
|
2007-07-05 16:01:52 +00:00
|
|
|
#ifdef CONFIG_LONGHELP
|
2009-12-15 08:11:09 +00:00
|
|
|
#define BAREBOX_CMD_HELP(text) .help = text,
|
2007-07-05 16:01:52 +00:00
|
|
|
#else
|
2009-12-15 08:11:09 +00:00
|
|
|
#define BAREBOX_CMD_HELP(text)
|
2007-07-05 16:01:52 +00:00
|
|
|
#endif
|
2003-06-27 21:31:46 +00:00
|
|
|
|
commands: group 'help' output
The old output of "help" was just producing a long list, that usually
scrolled of the screen (even on a X11 terminal). This list is more
compact, and also sorted by groups.
The old output format (plus grouping) is now available with 'help -v'.
Example:
Information commands:
?, devinfo, help, iomem, meminfo, version
Boot commands:
boot, bootm, go, loadb, loads, loadx, loady, saves, uimage
...
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 14:14:05 +00:00
|
|
|
#define BAREBOX_CMD_GROUP(grp) .group = grp,
|
|
|
|
|
commands: harmonize in-barebox documentation
This patch does probably too much, but it's hard (and very
cumbersome/time consuming) to break it out. What is does is this:
* each command has one short description, e.g. "list MUX configuration"
* made sure the short descriptions start lowercase
* each command has one usage. That string contains just the
options, e.g. "[-npn]". It's not part of the long help text.
* that is, it doesn't say "[OPTIONS]" anymore, every usable option
is listed by character in this (short) option string (the long
description is in the long help text, as before)
* help texts have been reworked, to make them
- sometimes smaller
- sometimes describe the options better
- more often present themselves in a nicer format
* all long help texts are now created with BUSYBOX_CMD_HELP_
macros, no more 'static const __maybe_unused char cmd_foobar_help[]'
* made sure the long help texts starts uppercase
* because cmdtp->name and cmdtp->opts together provide the new usage,
all "Usage: foobar" texts have been removed from the long help texts
* BUSYBOX_CMD_HELP_TEXT() provides the trailing newline by itself, this
is nicer in the source code
* BUSYBOX_CMD_HELP_OPT() provides the trailing newline by itself
* made sure no line gets longer than 77 characters
* delibertely renamed cmdtp->usage, so that we can get compile-time
errors (e.g. in out-of-tree modules that use register_command()
* the 'help' command can now always emit the usage, even without
compiled long help texts
* 'help -v' gives a list of commands with their short description, this
is similar like the old "help" command before my patchset
* 'help -a' gives out help of all commands
Signed-off-by: Holger Schurig <holgerschurig@gmail.com>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
2014-05-13 08:28:42 +00:00
|
|
|
#define BAREBOX_CMD_DESC(text) .desc = text,
|
|
|
|
|
|
|
|
#define BAREBOX_CMD_OPTS(text) .opts = text,
|
|
|
|
|
2010-01-04 09:21:11 +00:00
|
|
|
int register_command(struct command *);
|
2007-10-01 08:15:38 +00:00
|
|
|
|
2002-08-27 10:27:51 +00:00
|
|
|
#endif /* __COMMAND_H */
|