2003-07-01 21:06:45 +00:00
|
|
|
|
|
|
|
Commands are added to U-Boot by creating a new command structure.
|
2012-02-08 05:31:52 +00:00
|
|
|
This is done by first including command.h, then using the U_BOOT_CMD() macro
|
|
|
|
to fill in a cmd_tbl_t struct.
|
2003-07-01 21:06:45 +00:00
|
|
|
|
|
|
|
U_BOOT_CMD(name,maxargs,repeatable,command,"usage","help")
|
|
|
|
|
|
|
|
name: is the name of the commad. THIS IS NOT a string.
|
2012-02-08 05:31:52 +00:00
|
|
|
maxargs: the maximum number of arguments this function takes
|
|
|
|
repeatable: either 0 or 1 to indicate if autorepeat is allowed
|
2003-07-01 21:06:45 +00:00
|
|
|
command: Function pointer (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
|
|
|
|
usage: Short description. This is a string
|
2012-02-08 05:31:52 +00:00
|
|
|
help: Long description. This is a string
|
2003-07-01 21:06:45 +00:00
|
|
|
|
|
|
|
|
2012-02-08 05:31:52 +00:00
|
|
|
**** Behind the scene ******
|
2003-07-01 21:06:45 +00:00
|
|
|
|
|
|
|
The structure created is named with a special prefix (__u_boot_cmd_)
|
|
|
|
and placed by the linker in a special section.
|
|
|
|
|
|
|
|
This makes it possible for the final link to extract all commands
|
|
|
|
compiled into any object code and construct a static array so the
|
|
|
|
command can be found in an array starting at __u_boot_cmd_start.
|
|
|
|
|
2012-09-20 06:02:43 +00:00
|
|
|
To ensure that the linker does not discard these symbols when linking
|
|
|
|
full U-Boot we generate a list of all the commands we have built (based
|
|
|
|
on the sections mentioned above) and use that to force the linker to
|
|
|
|
first enter the symbol as undefined in the output object so that there
|
|
|
|
is then a need for the symbol to be kept (this is the UNDEF_SYM logic in
|
|
|
|
the Makefile).
|
|
|
|
|
2003-07-01 21:06:45 +00:00
|
|
|
If a new board is defined do not forget to define the command section
|
|
|
|
by writing in u-boot.lds ($(TOPDIR)/board/boardname/u-boot.lds) these
|
|
|
|
3 lines:
|
|
|
|
|
|
|
|
__u_boot_cmd_start = .;
|
|
|
|
.u_boot_cmd : { *(.u_boot_cmd) }
|
|
|
|
__u_boot_cmd_end = .;
|