2003-07-01 15:06:45 -06:00
|
|
|
|
|
|
|
Commands are added to U-Boot by creating a new command structure.
|
2012-02-07 22:31:52 -07: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 15:06:45 -06:00
|
|
|
|
|
|
|
U_BOOT_CMD(name,maxargs,repeatable,command,"usage","help")
|
|
|
|
|
|
|
|
name: is the name of the commad. THIS IS NOT a string.
|
2012-02-07 22:31:52 -07:00
|
|
|
maxargs: the maximum number of arguments this function takes
|
|
|
|
repeatable: either 0 or 1 to indicate if autorepeat is allowed
|
2003-07-01 15:06:45 -06:00
|
|
|
command: Function pointer (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
|
|
|
|
usage: Short description. This is a string
|
2012-02-07 22:31:52 -07:00
|
|
|
help: Long description. This is a string
|
2003-07-01 15:06:45 -06:00
|
|
|
|
|
|
|
|
2012-02-07 22:31:52 -07:00
|
|
|
**** Behind the scene ******
|
2003-07-01 15:06:45 -06:00
|
|
|
|
2013-02-24 17:59:00 -07:00
|
|
|
The structure created is named with a special prefix and placed by
|
|
|
|
the linker in a special section using the linker lists mechanism
|
|
|
|
(see include/linker_lists.h)
|
2003-07-01 15:06:45 -06:00
|
|
|
|
|
|
|
This makes it possible for the final link to extract all commands
|
|
|
|
compiled into any object code and construct a static array so the
|
2013-02-24 17:59:00 -07:00
|
|
|
command array can be iterated over using the linker lists macros.
|
2003-07-01 15:06:45 -06:00
|
|
|
|
2013-02-24 17:59:00 -07:00
|
|
|
The linker lists feature ensures that the linker does not discard
|
|
|
|
these symbols when linking full U-Boot even though they are not
|
|
|
|
referenced in the source code as such.
|
2012-09-20 00:02:43 -06:00
|
|
|
|
2003-07-01 15:06:45 -06: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:
|
|
|
|
|
2012-10-12 04:27:04 -06:00
|
|
|
.u_boot_list : {
|
2013-02-24 17:59:00 -07:00
|
|
|
KEEP(*(SORT(.u_boot_list*)));
|
2012-10-12 04:27:04 -06:00
|
|
|
}
|