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.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
|
|
* MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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)
|
|
|
|
|
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 *[]);
|
2008-04-04 09:46:55 +00:00
|
|
|
const char *usage; /* Usage message (short) */
|
2007-10-11 19:58:51 +00:00
|
|
|
|
|
|
|
struct list_head list; /* List of commands */
|
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
|
|
|
|
|
2002-08-27 10:27:51 +00:00
|
|
|
#endif /* __ASSEMBLY__ */
|
|
|
|
|
2010-10-22 16:45:07 +00:00
|
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
|
|
|
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
|
|
|
};
|
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[] =
|
|
|
|
|
|
|
|
#define BAREBOX_CMD_HELP_USAGE(_name) "Usage: " _name
|
|
|
|
#define BAREBOX_CMD_HELP_SHORT(_text) _text
|
|
|
|
#define BAREBOX_CMD_HELP_OPT(_opt, _desc) _opt "\t" _desc
|
2011-12-17 15:57:40 +00:00
|
|
|
#define BAREBOX_CMD_HELP_TEXT(_text) _text
|
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
|
|
|
|
2010-10-22 16:45:07 +00:00
|
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
|
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 */
|