xref: /rk3399_rockchip-uboot/include/command.h (revision 8a40fb148efa442d6526eac46a2001e4c64d28ff)
178f6622aSwdenk /*
278f6622aSwdenk  * (C) Copyright 2000
378f6622aSwdenk  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
478f6622aSwdenk  *
578f6622aSwdenk  * See file CREDITS for list of people who contributed to this
678f6622aSwdenk  * project.
778f6622aSwdenk  *
878f6622aSwdenk  * This program is free software; you can redistribute it and/or
978f6622aSwdenk  * modify it under the terms of the GNU General Public License as
1078f6622aSwdenk  * published by the Free Software Foundation; either version 2 of
1178f6622aSwdenk  * the License, or (at your option) any later version.
1278f6622aSwdenk  *
1378f6622aSwdenk  * This program is distributed in the hope that it will be useful,
1478f6622aSwdenk  * but WITHOUT ANY WARRANTY; without even the implied warranty of
1578f6622aSwdenk  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1678f6622aSwdenk  * GNU General Public License for more details.
1778f6622aSwdenk  *
1878f6622aSwdenk  * You should have received a copy of the GNU General Public License
1978f6622aSwdenk  * along with this program; if not, write to the Free Software
2078f6622aSwdenk  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
2178f6622aSwdenk  * MA 02111-1307 USA
2278f6622aSwdenk  */
2378f6622aSwdenk 
2478f6622aSwdenk /*
2578f6622aSwdenk  *  Definitions for Command Processor
2678f6622aSwdenk  */
2778f6622aSwdenk #ifndef __COMMAND_H
2878f6622aSwdenk #define __COMMAND_H
2978f6622aSwdenk 
30f2302d44SStefan Roese #include <config.h>
31f2302d44SStefan Roese 
3278f6622aSwdenk #ifndef NULL
3378f6622aSwdenk #define NULL	0
3478f6622aSwdenk #endif
3578f6622aSwdenk 
3678f6622aSwdenk #ifndef	__ASSEMBLY__
3778f6622aSwdenk /*
3878f6622aSwdenk  * Monitor Command Table
3978f6622aSwdenk  */
4078f6622aSwdenk 
4178f6622aSwdenk struct cmd_tbl_s {
4278f6622aSwdenk 	char		*name;		/* Command Name			*/
4378f6622aSwdenk 	int		maxargs;	/* maximum number of arguments	*/
4478f6622aSwdenk 	int		repeatable;	/* autorepeat allowed?		*/
4578f6622aSwdenk 					/* Implementation function	*/
4678f6622aSwdenk 	int		(*cmd)(struct cmd_tbl_s *, int, int, char *[]);
4778f6622aSwdenk 	char		*usage;		/* Usage message	(short)	*/
4878f6622aSwdenk #ifdef	CFG_LONGHELP
4978f6622aSwdenk 	char		*help;		/* Help  message	(long)	*/
5078f6622aSwdenk #endif
5104a85b3bSwdenk #ifdef CONFIG_AUTO_COMPLETE
5204a85b3bSwdenk 	/* do auto completion on the arguments */
5304a85b3bSwdenk 	int		(*complete)(int argc, char *argv[], char last_char, int maxv, char *cmdv[]);
5404a85b3bSwdenk #endif
5578f6622aSwdenk };
5678f6622aSwdenk 
5778f6622aSwdenk typedef struct cmd_tbl_s	cmd_tbl_t;
5878f6622aSwdenk 
598bde7f77Swdenk extern cmd_tbl_t  __u_boot_cmd_start;
608bde7f77Swdenk extern cmd_tbl_t  __u_boot_cmd_end;
6178f6622aSwdenk 
6278f6622aSwdenk 
6378f6622aSwdenk /* common/command.c */
6478f6622aSwdenk cmd_tbl_t *find_cmd(const char *cmd);
6578f6622aSwdenk 
6604a85b3bSwdenk #ifdef CONFIG_AUTO_COMPLETE
6704a85b3bSwdenk extern void install_auto_complete(void);
6804a85b3bSwdenk extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
6904a85b3bSwdenk #endif
7004a85b3bSwdenk 
7178f6622aSwdenk /*
7278f6622aSwdenk  * Monitor Command
7378f6622aSwdenk  *
7478f6622aSwdenk  * All commands use a common argument format:
7578f6622aSwdenk  *
7678f6622aSwdenk  * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
7778f6622aSwdenk  */
7878f6622aSwdenk 
7978f6622aSwdenk typedef	void	command_t (cmd_tbl_t *, int, int, char *[]);
8078f6622aSwdenk 
81*8a40fb14SJean-Christophe PLAGNIOL-VILLARD #if defined(CONFIG_CMD_MEMORY)		\
82*8a40fb14SJean-Christophe PLAGNIOL-VILLARD     || defined(CONFIG_CMD_I2C)		\
83*8a40fb14SJean-Christophe PLAGNIOL-VILLARD     || defined(CONFIG_CMD_ITEST)	\
84*8a40fb14SJean-Christophe PLAGNIOL-VILLARD     || defined(CONFIG_CMD_PCI)		\
85*8a40fb14SJean-Christophe PLAGNIOL-VILLARD     || defined(CONFIG_CMD_PORTIO)
86*8a40fb14SJean-Christophe PLAGNIOL-VILLARD #define CMD_DATA_SIZE
87*8a40fb14SJean-Christophe PLAGNIOL-VILLARD extern int cmd_get_data_size(char* arg, int default_size);
88*8a40fb14SJean-Christophe PLAGNIOL-VILLARD #endif
89*8a40fb14SJean-Christophe PLAGNIOL-VILLARD 
9078f6622aSwdenk #endif	/* __ASSEMBLY__ */
9178f6622aSwdenk 
9278f6622aSwdenk /*
9378f6622aSwdenk  * Command Flags:
9478f6622aSwdenk  */
9578f6622aSwdenk #define CMD_FLAG_REPEAT		0x0001	/* repeat last command		*/
9678f6622aSwdenk #define CMD_FLAG_BOOTD		0x0002	/* command is from bootd	*/
9778f6622aSwdenk 
988bde7f77Swdenk #define Struct_Section  __attribute__ ((unused,section (".u_boot_cmd")))
998bde7f77Swdenk 
1008bde7f77Swdenk #ifdef  CFG_LONGHELP
1018bde7f77Swdenk 
1020d498393Swdenk #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
1030d498393Swdenk cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help}
1048bde7f77Swdenk 
1058bde7f77Swdenk #else	/* no long help info */
1068bde7f77Swdenk 
1070d498393Swdenk #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
1080d498393Swdenk cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}
1098bde7f77Swdenk 
1108bde7f77Swdenk #endif	/* CFG_LONGHELP */
1118bde7f77Swdenk 
11278f6622aSwdenk #endif	/* __COMMAND_H */
113