mirror of
				https://github.com/smaeul/u-boot.git
				synced 2025-11-04 05:50:17 +00:00 
			
		
		
		
	Command parsing and processing code is not needed when the command line is disabled. Remove this code in that case. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Tom Rini <trini@konsulko.com>
		
			
				
	
	
		
			226 lines
		
	
	
		
			6.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			226 lines
		
	
	
		
			6.8 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
 * (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 <linker_lists.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
 | 
						|
 | 
						|
#ifndef	__ASSEMBLY__
 | 
						|
/*
 | 
						|
 * Monitor Command Table
 | 
						|
 */
 | 
						|
 | 
						|
struct cmd_tbl_s {
 | 
						|
	char		*name;		/* Command Name			*/
 | 
						|
	int		maxargs;	/* maximum number of arguments	*/
 | 
						|
	int		repeatable;	/* autorepeat allowed?		*/
 | 
						|
					/* Implementation function	*/
 | 
						|
	int		(*cmd)(struct cmd_tbl_s *, int, int, char * const []);
 | 
						|
	char		*usage;		/* Usage message	(short)	*/
 | 
						|
#ifdef	CONFIG_SYS_LONGHELP
 | 
						|
	char		*help;		/* Help  message	(long)	*/
 | 
						|
#endif
 | 
						|
#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
 | 
						|
};
 | 
						|
 | 
						|
typedef struct cmd_tbl_s	cmd_tbl_t;
 | 
						|
 | 
						|
 | 
						|
#if defined(CONFIG_CMD_RUN)
 | 
						|
extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
#endif
 | 
						|
 | 
						|
/* common/command.c */
 | 
						|
int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
 | 
						|
	      flag, int argc, char * const argv[]);
 | 
						|
cmd_tbl_t *find_cmd(const char *cmd);
 | 
						|
cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
 | 
						|
 | 
						|
extern int cmd_usage(const 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 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, int flag, int argc, char * const argv[]);
 | 
						|
 */
 | 
						|
 | 
						|
#if defined(CONFIG_CMD_MEMORY)		\
 | 
						|
	|| defined(CONFIG_CMD_I2C)	\
 | 
						|
	|| defined(CONFIG_CMD_ITEST)	\
 | 
						|
	|| defined(CONFIG_CMD_PCI)	\
 | 
						|
	|| defined(CONFIG_CMD_PORTIO)
 | 
						|
#define CMD_DATA_SIZE
 | 
						|
extern int cmd_get_data_size(char* arg, int default_size);
 | 
						|
#endif
 | 
						|
 | 
						|
#ifdef CONFIG_CMD_BOOTD
 | 
						|
extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
#endif
 | 
						|
#ifdef CONFIG_CMD_BOOTM
 | 
						|
extern int do_bootm(cmd_tbl_t *cmdtp, int 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, const char *cmd)
 | 
						|
{
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
#endif
 | 
						|
 | 
						|
extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
 | 
						|
extern int do_booti(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
 | 
						|
extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
 | 
						|
			   char *const argv[]);
 | 
						|
 | 
						|
extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 | 
						|
 | 
						|
/*
 | 
						|
 * 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.
 | 
						|
 */
 | 
						|
enum command_ret_t {
 | 
						|
	CMD_RET_SUCCESS,	/* 0 = Success */
 | 
						|
	CMD_RET_FAILURE,	/* 1 = Failure */
 | 
						|
	CMD_RET_USAGE = -1,	/* Failure, please report 'usage' error */
 | 
						|
};
 | 
						|
 | 
						|
/**
 | 
						|
 * 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.
 | 
						|
 * @param ticks		If ticks is not null, this function set it to the
 | 
						|
 *			number of ticks the command took to complete.
 | 
						|
 * @return 0 if the command succeeded, 1 if it failed
 | 
						|
 */
 | 
						|
int cmd_process(int flag, int argc, char * const argv[],
 | 
						|
			       int *repeatable, unsigned long *ticks);
 | 
						|
 | 
						|
void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
 | 
						|
 | 
						|
/**
 | 
						|
 * board_run_command() - Fallback function to execute a command
 | 
						|
 *
 | 
						|
 * When no command line features are enabled in U-Boot, this function is
 | 
						|
 * called to execute a command. Typically the function can look at the
 | 
						|
 * command and perform a few very specific tasks, such as booting the
 | 
						|
 * system in a particular way.
 | 
						|
 *
 | 
						|
 * This function is only used when CONFIG_CMDLINE is not enabled.
 | 
						|
 *
 | 
						|
 * In normal situations this function should not return, since U-Boot will
 | 
						|
 * simply hang.
 | 
						|
 *
 | 
						|
 * @cmdline:	Command line string to execute
 | 
						|
 * @return 0 if OK, 1 for error
 | 
						|
 */
 | 
						|
int board_run_command(const char *cmdline);
 | 
						|
#endif	/* __ASSEMBLY__ */
 | 
						|
 | 
						|
/*
 | 
						|
 * Command Flags:
 | 
						|
 */
 | 
						|
#define CMD_FLAG_REPEAT		0x0001	/* repeat last command		*/
 | 
						|
#define CMD_FLAG_BOOTD		0x0002	/* command is from bootd	*/
 | 
						|
#define CMD_FLAG_ENV		0x0004	/* command is from the environment */
 | 
						|
 | 
						|
#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
 | 
						|
 | 
						|
#ifdef CONFIG_CMDLINE
 | 
						|
#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
 | 
						|
				_usage, _help, _comp)			\
 | 
						|
		{ #_name, _maxargs, _rep, _cmd, _usage,			\
 | 
						|
			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 | 
						|
 | 
						|
#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
 | 
						|
	ll_entry_declare(cmd_tbl_t, _name, cmd) =			\
 | 
						|
		U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,	\
 | 
						|
						_usage, _help, _comp);
 | 
						|
 | 
						|
#else
 | 
						|
#define U_BOOT_SUBCMD_START(name)	static cmd_tbl_t name[] = {};
 | 
						|
#define U_BOOT_SUBCMD_END
 | 
						|
 | 
						|
#define _CMD_REMOVE(_name, _cmd)					\
 | 
						|
	int __remove_ ## _name(void)					\
 | 
						|
	{								\
 | 
						|
		if (0)							\
 | 
						|
			_cmd(NULL, 0, 0, NULL);				\
 | 
						|
		return 0;						\
 | 
						|
	}
 | 
						|
#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage,	\
 | 
						|
				  _help, _comp)				\
 | 
						|
		{ #_name, _maxargs, _rep, 0 ? _cmd : NULL, _usage,	\
 | 
						|
			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
 | 
						|
 | 
						|
#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help,	\
 | 
						|
			    _comp)				\
 | 
						|
	_CMD_REMOVE(sub_ ## _name, _cmd)
 | 
						|
 | 
						|
#endif /* CONFIG_CMDLINE */
 | 
						|
 | 
						|
#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)		\
 | 
						|
	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
 | 
						|
 | 
						|
#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help)	\
 | 
						|
	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
 | 
						|
					_usage, _help, NULL)
 | 
						|
 | 
						|
#endif	/* __COMMAND_H */
 |