README.commands 1.5 KB

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