command.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /*
  2. * (C) Copyright 2000
  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. #ifndef NULL
  29. #define NULL 0
  30. #endif
  31. #ifndef __ASSEMBLY__
  32. /*
  33. * Monitor Command Table
  34. */
  35. struct cmd_tbl_s {
  36. char *name; /* Command Name */
  37. int maxargs; /* maximum number of arguments */
  38. int repeatable; /* autorepeat allowed? */
  39. /* Implementation function */
  40. int (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
  41. char *usage; /* Usage message (short) */
  42. #ifdef CFG_LONGHELP
  43. char *help; /* Help message (long) */
  44. #endif
  45. };
  46. typedef struct cmd_tbl_s cmd_tbl_t;
  47. extern cmd_tbl_t __u_boot_cmd_start;
  48. extern cmd_tbl_t __u_boot_cmd_end;
  49. /* common/command.c */
  50. cmd_tbl_t *find_cmd(const char *cmd);
  51. /*
  52. * Monitor Command
  53. *
  54. * All commands use a common argument format:
  55. *
  56. * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
  57. */
  58. typedef void command_t (cmd_tbl_t *, int, int, char *[]);
  59. #endif /* __ASSEMBLY__ */
  60. /*
  61. * Command Flags:
  62. */
  63. #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
  64. #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
  65. /*
  66. * Configurable monitor commands definitions have been moved
  67. * to include/cmd_confdefs.h
  68. */
  69. #define Struct_Section __attribute__ ((unused,section (".u_boot_cmd")))
  70. #ifdef CFG_LONGHELP
  71. #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
  72. cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help}
  73. #else /* no long help info */
  74. #define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
  75. cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}
  76. #endif /* CFG_LONGHELP */
  77. #endif /* __COMMAND_H */