command.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. /*
  2. * (C) Copyright 2000-2009
  3. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  4. *
  5. * See file CREDITS for list of people who contributed to this
  6. * project.
  7. *
  8. * This program is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU General Public License as
  10. * published by the Free Software Foundation; either version 2 of
  11. * the License, or (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21. * MA 02111-1307 USA
  22. */
  23. /*
  24. * Definitions for Command Processor
  25. */
  26. #ifndef __COMMAND_H
  27. #define __COMMAND_H
  28. #include <config.h>
  29. #ifndef NULL
  30. #define NULL 0
  31. #endif
  32. /* Default to a width of 8 characters for help message command width */
  33. #ifndef CONFIG_SYS_HELP_CMD_WIDTH
  34. #define CONFIG_SYS_HELP_CMD_WIDTH 8
  35. #endif
  36. #ifndef __ASSEMBLY__
  37. /*
  38. * Monitor Command Table
  39. */
  40. struct cmd_tbl_s {
  41. char *name; /* Command Name */
  42. int maxargs; /* maximum number of arguments */
  43. int repeatable; /* autorepeat allowed? */
  44. /* Implementation function */
  45. int (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
  46. char *usage; /* Usage message (short) */
  47. #ifdef CONFIG_SYS_LONGHELP
  48. char *help; /* Help message (long) */
  49. #endif
  50. #ifdef CONFIG_AUTO_COMPLETE
  51. /* do auto completion on the arguments */
  52. int (*complete)(int argc, char *argv[], char last_char, int maxv, char *cmdv[]);
  53. #endif
  54. };
  55. typedef struct cmd_tbl_s cmd_tbl_t;
  56. extern cmd_tbl_t __u_boot_cmd_start;
  57. extern cmd_tbl_t __u_boot_cmd_end;
  58. /* common/command.c */
  59. int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
  60. flag, int argc, char *argv[]);
  61. cmd_tbl_t *find_cmd(const char *cmd);
  62. cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
  63. extern int cmd_usage(cmd_tbl_t *cmdtp);
  64. #ifdef CONFIG_AUTO_COMPLETE
  65. extern void install_auto_complete(void);
  66. extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
  67. #endif
  68. /*
  69. * Monitor Command
  70. *
  71. * All commands use a common argument format:
  72. *
  73. * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
  74. */
  75. typedef void command_t (cmd_tbl_t *, int, int, char *[]);
  76. #if defined(CONFIG_CMD_MEMORY) \
  77. || defined(CONFIG_CMD_I2C) \
  78. || defined(CONFIG_CMD_ITEST) \
  79. || defined(CONFIG_CMD_PCI) \
  80. || defined(CONFIG_CMD_PORTIO)
  81. #define CMD_DATA_SIZE
  82. extern int cmd_get_data_size(char* arg, int default_size);
  83. #endif
  84. #endif /* __ASSEMBLY__ */
  85. /*
  86. * Command Flags:
  87. */
  88. #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
  89. #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
  90. #define Struct_Section __attribute__ ((unused,section (".u_boot_cmd")))
  91. #ifdef CONFIG_SYS_LONGHELP
  92. #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
  93. cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help}
  94. #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
  95. {#name, maxargs, rep, cmd, usage, help}
  96. #else /* no long help info */
  97. #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
  98. cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}
  99. #define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
  100. {#name, maxargs, rep, cmd, usage}
  101. #endif /* CONFIG_SYS_LONGHELP */
  102. #endif /* __COMMAND_H */