Call subcommands from main command processor

[z180-stamp.git] / include / command.h

/*
 * (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 *cmd_start, cmd_tbl_t * cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
cmd_tbl_t *find_cmd (const char *cmd, cmd_tbl_t *table);

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[]);

extern command_ret_t do_reset(cmd_tbl_t *cmdtp, uint_fast8_t flag, 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	*/

#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)

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 */