doc/README.commands

   1
   2 Commands are added to U-Boot by creating a new command structure.
   3 This is done by first including command.h, then using the U_BOOT_CMD() macro
   4 to fill in a cmd_tbl_t struct.
   5
   6 U_BOOT_CMD(name,maxargs,repeatable,command,"usage","help")
   7
   8 name:    is the name of the commad. THIS IS NOT a string.
   9 maxargs: the maximum number of arguments this function takes
  10 repeatable: either 0 or 1 to indicate if autorepeat is allowed
  11 command: Function pointer (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
  12 usage:   Short description. This is a string
  13 help:    Long description. This is a string
  14
  15
  16 **** Behind the scene ******
  17
  18 The structure created is named with a special prefix (__u_boot_cmd_)
  19 and placed by the linker in a special section.
  20
  21 This makes it possible for the final link to extract all commands
  22 compiled into any object code and construct a static array so the
  23 command can be found in an array starting at __u_boot_cmd_start.
  24
  25 If a new board is defined do not forget to define the command section
  26 by writing in u-boot.lds ($(TOPDIR)/board/boardname/u-boot.lds) these
  27 3 lines:
  28
  29         __u_boot_cmd_start = .;
  30         .u_boot_cmd : { *(.u_boot_cmd) }
  31         __u_boot_cmd_end = .;