xref: /openbmc/u-boot/common/command.c (revision 518e2e1a)
1 /*
2  * (C) Copyright 2000-2003
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 /*
25  *  Command Processor Table
26  */
27 
28 #include <common.h>
29 #include <command.h>
30 
31 int
32 do_version (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
33 {
34 	extern char version_string[];
35 	printf ("\n%s\n", version_string);
36 	return 0;
37 }
38 
39 U_BOOT_CMD(
40 	version,	1,		1,	do_version,
41  	"version - print monitor version\n",
42 	NULL
43 );
44 
45 int
46 do_echo (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
47 {
48 	int i, putnl = 1;
49 
50 	for (i = 1; i < argc; i++) {
51 		char *p = argv[i], c;
52 
53 		if (i > 1)
54 			putc(' ');
55 		while ((c = *p++) != '\0') {
56 			if (c == '\\' && *p == 'c') {
57 				putnl = 0;
58 				p++;
59 			} else {
60 				putc(c);
61 			}
62 		}
63 	}
64 
65 	if (putnl)
66 		putc('\n');
67 	return 0;
68 }
69 
70 U_BOOT_CMD(
71 	echo,	CFG_MAXARGS,	1,	do_echo,
72  	"echo    - echo args to console\n",
73  	"[args..]\n"
74 	"    - echo args to console; \\c suppresses newline\n"
75 );
76 
77 /*
78  * Use puts() instead of printf() to avoid printf buffer overflow
79  * for long help messages
80  */
81 int do_help (cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
82 {
83 	int i;
84 	int rcode = 0;
85 
86 	if (argc == 1) {	/*show list of commands */
87 
88 		int cmd_items = &__u_boot_cmd_end -
89 				&__u_boot_cmd_start;	/* pointer arith! */
90 		cmd_tbl_t *cmd_array[cmd_items];
91 		int i, j, swaps;
92 
93 		/* Make array of commands from .uboot_cmd section */
94 		cmdtp = &__u_boot_cmd_start;
95 		for (i = 0; i < cmd_items; i++) {
96 			cmd_array[i] = cmdtp++;
97 		}
98 
99 		/* Sort command list (trivial bubble sort) */
100 		for (i = cmd_items - 1; i > 0; --i) {
101 			swaps = 0;
102 			for (j = 0; j < i; ++j) {
103 				if (strcmp (cmd_array[j]->name,
104 					    cmd_array[j + 1]->name) > 0) {
105 					cmd_tbl_t *tmp;
106 					tmp = cmd_array[j];
107 					cmd_array[j] = cmd_array[j + 1];
108 					cmd_array[j + 1] = tmp;
109 					++swaps;
110 				}
111 			}
112 			if (!swaps)
113 				break;
114 		}
115 
116 		/* print short help (usage) */
117 		for (i = 0; i < cmd_items; i++) {
118 			const char *usage = cmd_array[i]->usage;
119 
120 			/* allow user abort */
121 			if (ctrlc ())
122 				return 1;
123 			if (usage == NULL)
124 				continue;
125 			puts (usage);
126 		}
127 		return 0;
128 	}
129 	/*
130 	 * command help (long version)
131 	 */
132 	for (i = 1; i < argc; ++i) {
133 		if ((cmdtp = find_cmd (argv[i])) != NULL) {
134 #ifdef	CFG_LONGHELP
135 			/* found - print (long) help info */
136 			puts (cmdtp->name);
137 			putc (' ');
138 			if (cmdtp->help) {
139 				puts (cmdtp->help);
140 			} else {
141 				puts ("- No help available.\n");
142 				rcode = 1;
143 			}
144 			putc ('\n');
145 #else	/* no long help available */
146 			if (cmdtp->usage)
147 				puts (cmdtp->usage);
148 #endif	/* CFG_LONGHELP */
149 		} else {
150 			printf ("Unknown command '%s' - try 'help'"
151 				" without arguments for list of all"
152 				" known commands\n\n", argv[i]
153 					);
154 			rcode = 1;
155 		}
156 	}
157 	return rcode;
158 }
159 
160 
161 U_BOOT_CMD(
162 	help,	CFG_MAXARGS,	1,	do_help,
163  	"help    - print online help\n",
164  	"[command ...]\n"
165  	"    - show help information (for 'command')\n"
166  	"'help' prints online help for the monitor commands.\n\n"
167  	"Without arguments, it prints a short usage message for all commands.\n\n"
168  	"To get detailed help information for specific commands you can type\n"
169   "'help' with one or more command names as arguments.\n"
170 );
171 
172 /* This do not ust the U_BOOT_CMD macro as ? can't be used in symbol names */
173 #ifdef  CFG_LONGHELP
174 cmd_tbl_t __u_boot_cmd_question_mark Struct_Section = {
175 	"?",	CFG_MAXARGS,	1,	do_help,
176  	"?       - alias for 'help'\n",
177 	NULL
178 };
179 #else
180 cmd_tbl_t __u_boot_cmd_question_mark Struct_Section = {
181 	"?",	CFG_MAXARGS,	1,	do_help,
182  	"?       - alias for 'help'\n"
183 };
184 #endif /* CFG_LONGHELP */
185 
186 /***************************************************************************
187  * find command table entry for a command
188  */
189 cmd_tbl_t *find_cmd (const char *cmd)
190 {
191 	cmd_tbl_t *cmdtp;
192 	cmd_tbl_t *cmdtp_temp = &__u_boot_cmd_start;	/*Init value */
193 	const char *p;
194 	int len;
195 	int n_found = 0;
196 
197 	/*
198 	 * Some commands allow length modifiers (like "cp.b");
199 	 * compare command name only until first dot.
200 	 */
201 	len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
202 
203 	for (cmdtp = &__u_boot_cmd_start;
204 	     cmdtp != &__u_boot_cmd_end;
205 	     cmdtp++) {
206 		if (strncmp (cmd, cmdtp->name, len) == 0) {
207 			if (len == strlen (cmdtp->name))
208 				return cmdtp;	/* full match */
209 
210 			cmdtp_temp = cmdtp;	/* abbreviated command ? */
211 			n_found++;
212 		}
213 	}
214 	if (n_found == 1) {			/* exactly one match */
215 		return cmdtp_temp;
216 	}
217 
218 	return NULL;	/* not found or ambiguous command */
219 }
220