u-boot/doc/README.commands

1 Command definition
4 Commands are added to U-Boot by creating a new command structure.
5 This is done by first including command.h, then using the U_BOOT_CMD() or the
8 U_BOOT_CMD(name, maxargs, repeatable, command, "usage", "help")
9 U_BOOT_CMD_COMPLETE(name, maxargs, repeatable, command, "usage, "help", comp)
11 name:		The name of the command. THIS IS NOT a string.
14 		the command itself.
18 command:	Pointer to the command function. This is the function that is
19 		called when the command is issued.
28 		entering the command arguments to complete the entry. Command
31 Sub-command definition
37 * U_BOOT_CMD_MKENT(name, maxargs, repeatable, command, "usage", "help")
38 * U_BOOT_CMD_MKENTCOMPLETE(name, maxargs, repeatable, command, "usage, "help",
41 This table has to be evaluated in the command function of the main command, e.g.
55         /* drop sub-command argument */
67 Command function
70 The command function pointer has to be of type
73 cmdtp:		Table entry describing the command (see above).
76 		CMD_FLAG_REPEAT - The last command is repeated.
77 		CMD_FLAG_BOOTD  - The command is called by the bootd command.
78 		CMD_FLAG_ENV    - The command is called by the run command.
80 argc:		Number of arguments including the command.
86 CMD_SUCCESS	The command was successfully executed.
88 CMD_FAILURE	The command failed.
90 CMD_RET_USAGE	The command was called with invalid parameters. This value
100 argc:		Number of arguments including the command.
104 last_char:	The last character in the command line buffer.
124 command array can be iterated over using the linker lists macros.
130 If a new board is defined do not forget to define the command section