1bf2cb48cb1b06ba4365fc9c44ca879bc510dd85
[openocd.git] / src / helper / command.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (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 *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifndef COMMAND_H
24 #define COMMAND_H
25
26 #include <helper/types.h>
27
28 /* Integrate the JIM TCL interpretor into the command processing. */
29 #if BUILD_ECOSBOARD
30 #include <stdio.h>
31 #include <stdarg.h>
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
34 #else
35 #include <helper/jim.h>
36 #endif
37
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
40 */
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
43 #else
44 #define PRINTF_ATTRIBUTE_FORMAT printf
45 #endif
46
47 enum command_mode
48 {
49 COMMAND_EXEC,
50 COMMAND_CONFIG,
51 COMMAND_ANY,
52 };
53
54 struct command_context;
55
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t)(struct command_context *context,
58 const char* line);
59
60 struct command_context
61 {
62 Jim_Interp *interp;
63 enum command_mode mode;
64 struct command *commands;
65 int current_target;
66 command_output_handler_t output_handler;
67 void *output_handler_priv;
68 };
69
70 struct command;
71
72 /**
73 * When run_command is called, a new instance will be created on the
74 * stack, filled with the proper values, and passed by reference to the
75 * required COMMAND_HANDLER routine.
76 */
77 struct command_invocation {
78 struct command_context *ctx;
79 struct command *current;
80 const char *name;
81 unsigned argc;
82 const char **argv;
83 };
84
85 /**
86 * Command handlers may be defined with more parameters than the base
87 * set provided by command.c. This macro uses C99 magic to allow
88 * defining all such derivative types using this macro.
89 */
90 #define __COMMAND_HANDLER(name, extra...) \
91 int name(struct command_invocation *cmd, ##extra)
92
93 /**
94 * Use this to macro to call a command helper (or a nested handler).
95 * It provides command handler authors protection against reordering or
96 * removal of unused parameters.
97 *
98 * @b Note: This macro uses lexical capture to provide some arguments.
99 * As a result, this macro should be used @b only within functions
100 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
101 * macros provide the expected lexical context captured by this macro.
102 * Furthermore, it should be used only from the top-level of handler or
103 * helper function, or care must be taken to avoid redefining the same
104 * variables in intervening scope(s) by accident.
105 */
106 #define CALL_COMMAND_HANDLER(name, extra...) \
107 name(cmd, ##extra)
108
109 /**
110 * Always use this macro to define new command handler functions.
111 * It ensures the parameters are ordered, typed, and named properly, so
112 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
113 * All command handler functions must be defined as static in scope.
114 */
115 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
116
117 /**
118 * Similar to COMMAND_HANDLER, except some parameters are expected.
119 * A helper is globally-scoped because it may be shared between several
120 * source files (e.g. the s3c24xx device command helper).
121 */
122 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
123
124 /**
125 * Use this macro to access the context of the command being handled,
126 * rather than accessing the variable directly. It may be moved.
127 */
128 #define CMD_CTX cmd->ctx
129 /**
130 * Use this macro to access the number of arguments for the command being
131 * handled, rather than accessing the variable directly. It may be moved.
132 */
133 #define CMD_ARGC cmd->argc
134 /**
135 * Use this macro to access the arguments for the command being handled,
136 * rather than accessing the variable directly. It may be moved.
137 */
138 #define CMD_ARGV cmd->argv
139 /**
140 * Use this macro to access the name of the command being handled,
141 * rather than accessing the variable directly. It may be moved.
142 */
143 #define CMD_NAME cmd->name
144 /**
145 * Use this macro to access the current command being handled,
146 * rather than accessing the variable directly. It may be moved.
147 */
148 #define CMD_CURRENT cmd->current
149 /**
150 * Use this macro to access the invoked command handler's data pointer,
151 * rather than accessing the variable directly. It may be moved.
152 */
153 #define CMD_DATA CMD_CURRENT->jim_handler_data
154
155
156 /**
157 * The type signature for command handling functions. They are
158 * usually registered as part of command_registration, providing
159 * a high-level means for executing a command.
160 *
161 * If the command fails, it *MUST* return a value != ERROR_OK
162 * (many commands break this rule, patches welcome!)
163 *
164 * This is *especially* important for commands such as writing
165 * to flash or verifying memory. The reason is that those commands
166 * can be used by programs to determine if the operation succeded
167 * or not. If the operation failed, then a program can try
168 * an alternative approach.
169 *
170 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
171 * printing out the syntax of the command.
172 */
173 typedef __COMMAND_HANDLER((*command_handler_t));
174
175 struct command
176 {
177 char *name;
178 const char *help;
179 const char *usage;
180 struct command *parent;
181 struct command *children;
182 command_handler_t handler;
183 Jim_CmdProc jim_handler;
184 void *jim_handler_data;
185 enum command_mode mode;
186 struct command *next;
187 };
188
189 /**
190 * @param c The command to be named.
191 * @param delim The character to place between command names.
192 * @returns A malloc'd string containing the full command name,
193 * which may include one or more ancestor components. Multiple names
194 * are separated by single spaces. The caller must free() the string
195 * when done with it.
196 */
197 char *command_name(struct command *c, char delim);
198
199 /*
200 * Commands should be registered by filling in one or more of these
201 * structures and passing them to register_command().
202 *
203 * A conventioal format should be used for help strings, to provide both
204 * usage and basic information:
205 * @code
206 * "@<options@> ... - some explanation text"
207 * @endcode
208 *
209 * @param name The name of the command to register, which must not have
210 * been registered previously in the intended context.
211 * @param handler The callback function that will be called. If NULL,
212 * then the command serves as a placeholder for its children or a script.
213 * @param mode The command mode(s) in which this command may be run.
214 * @param help The help text that will be displayed to the user.
215 */
216 struct command_registration {
217 const char *name;
218 command_handler_t handler;
219 Jim_CmdProc jim_handler;
220 void *jim_handler_data;
221 enum command_mode mode;
222 const char *help;
223 /// a string listing the options and arguments, required or optional
224 const char *usage;
225
226 /**
227 * If non-NULL, the commands in @c chain will be registered in
228 * the same context and scope of this registration record.
229 * This allows modules to inherit lists commands from other
230 * modules.
231 */
232 const struct command_registration *chain;
233 };
234
235 /// Use this as the last entry in an array of command_registration records.
236 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
237
238 /**
239 * Register a command @c handler that can be called from scripts during
240 * the execution @c mode specified.
241 *
242 * If @c parent is non-NULL, the new command will be registered as a
243 * sub-command under it; otherwise, it will be available as a top-level
244 * command.
245 *
246 * @param cmd_ctx The command_context in which to register the command.
247 * @param parent Register this command as a child of this, or NULL to
248 * register a top-level command.
249 * @param rec A command_registration record that contains the desired
250 * command parameters.
251 * @returns The new command, if successful; otherwise, NULL.
252 */
253 struct command* register_command(struct command_context *cmd_ctx,
254 struct command *parent, const struct command_registration *rec);
255
256 /**
257 * Register one or more commands in the specified context, as children
258 * of @c parent (or top-level commends, if NULL). In a registration's
259 * record contains a non-NULL @c chain member and name is NULL, the
260 * commands on the chain will be registered in the same context.
261 * Otherwise, the chained commands are added as children of the command.
262 *
263 * @param cmd_ctx The command_context in which to register the command.
264 * @param parent Register this command as a child of this, or NULL to
265 * register a top-level command.
266 * @param cmds Pointer to an array of command_registration records that
267 * contains the desired command parameters. The last record must have
268 * NULL for all fields.
269 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
270 */
271 int register_commands(struct command_context *cmd_ctx, struct command *parent,
272 const struct command_registration *cmds);
273
274
275 /**
276 * Unregisters command @c name from the given context, @c cmd_ctx.
277 * @param cmd_ctx The context of the registered command.
278 * @param parent The parent of the given command, or NULL.
279 * @param name The name of the command to unregister.
280 * @returns ERROR_OK on success, or an error code.
281 */
282 int unregister_command(struct command_context *cmd_ctx,
283 struct command *parent, const char *name);
284 /**
285 * Unregisters all commands from the specfied context.
286 * @param cmd_ctx The context that will be cleared of registered commands.
287 * @param parent If given, only clear commands from under this one command.
288 * @returns ERROR_OK on success, or an error code.
289 */
290 int unregister_all_commands(struct command_context *cmd_ctx,
291 struct command *parent);
292
293 struct command *command_find_in_context(struct command_context *cmd_ctx,
294 const char *name);
295 struct command *command_find_in_parent(struct command *parent,
296 const char *name);
297
298 /**
299 * Update the private command data field for a command and all descendents.
300 * This is used when creating a new heirarchy of commands that depends
301 * on obtaining a dynamically created context. The value will be available
302 * in command handlers by using the CMD_DATA macro.
303 * @param c The command (group) whose data pointer(s) will be updated.
304 * @param p The new data pointer to use for the command or its descendents.
305 */
306 void command_set_handler_data(struct command *c, void *p);
307
308 void command_set_output_handler(struct command_context* context,
309 command_output_handler_t output_handler, void *priv);
310
311
312 int command_context_mode(struct command_context *context, enum command_mode mode);
313
314 /* Return the current command context associated with the Jim interpreter or
315 * alternatively the global default command interpreter
316 */
317 struct command_context *current_command_context(Jim_Interp *interp);
318 /**
319 * Creates a new command context using the startup TCL provided and
320 * the existing Jim interpreter, if any. If interp == NULL, then command_init
321 * creates a command interpreter.
322 */
323 struct command_context* command_init(const char *startup_tcl, Jim_Interp *interp);
324 /**
325 * Creates a copy of an existing command context. This does not create
326 * a deep copy of the command list, so modifications in one context will
327 * affect all shared contexts. The caller must track reference counting
328 * and ensure the commands are freed before destroying the last instance.
329 * @param cmd_ctx The command_context that will be copied.
330 * @returns A new command_context with the same state as the original.
331 */
332 struct command_context* copy_command_context(struct command_context* cmd_ctx);
333 /**
334 * Frees the resources associated with a command context. The commands
335 * are not removed, so unregister_all_commands() must be called first.
336 * @param context The command_context that will be destroyed.
337 */
338 void command_done(struct command_context *context);
339
340 void command_print(struct command_context *context, const char *format, ...)
341 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
342 void command_print_sameline(struct command_context *context, const char *format, ...)
343 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
344 int command_run_line(struct command_context *context, char *line);
345 int command_run_linef(struct command_context *context, const char *format, ...)
346 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
347 void command_output_text(struct command_context *context, const char *data);
348
349 void process_jim_events(struct command_context *cmd_ctx);
350
351 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
352 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
353 #define ERROR_COMMAND_NOTFOUND (-602)
354 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
355 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
356 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
357
358 int parse_ulong(const char *str, unsigned long *ul);
359 int parse_ullong(const char *str, unsigned long long *ul);
360
361 int parse_long(const char *str, long *ul);
362 int parse_llong(const char *str, long long *ul);
363
364 #define DECLARE_PARSE_WRAPPER(name, type) \
365 int parse##name(const char *str, type *ul)
366
367 DECLARE_PARSE_WRAPPER(_uint, unsigned);
368 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
369 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
370 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
371
372 DECLARE_PARSE_WRAPPER(_int, int);
373 DECLARE_PARSE_WRAPPER(_s32, int32_t);
374 DECLARE_PARSE_WRAPPER(_s16, int16_t);
375 DECLARE_PARSE_WRAPPER(_s8, int8_t);
376
377 /**
378 * @brief parses the string @a in into @a out as a @a type, or prints
379 * a command error and passes the error code to the caller. If an error
380 * does occur, the calling function will return the error code produced
381 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
382 *
383 * This function may cause the calling function to return immediately,
384 * so it should be used carefully to avoid leaking resources. In most
385 * situations, parsing should be completed in full before proceding
386 * to allocate resources, and this strategy will most prevents leaks.
387 */
388 #define COMMAND_PARSE_NUMBER(type, in, out) \
389 do { \
390 int retval_macro_tmp = parse_##type(in, &(out)); \
391 if (ERROR_OK != retval_macro_tmp) { \
392 command_print(CMD_CTX, stringify(out) \
393 " option value ('%s') is not valid", in); \
394 return retval_macro_tmp; \
395 } \
396 } while (0)
397
398 /**
399 * Parse the string @c as a binary parameter, storing the boolean value
400 * in @c out. The strings @c on and @c off are used to match different
401 * strings for true and false options (e.g. "on" and "off" or
402 * "enable" and "disable").
403 */
404 #define COMMAND_PARSE_BOOL(in, out, on, off) \
405 do { \
406 bool value; \
407 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
408 if (ERROR_OK != retval_macro_tmp) { \
409 command_print(CMD_CTX, stringify(out) \
410 " option value ('%s') is not valid", in); \
411 command_print(CMD_CTX, " choices are '%s' or '%s'", \
412 on, off); \
413 return retval_macro_tmp; \
414 } \
415 out = value; \
416 } while (0)
417
418 int command_parse_bool_arg(const char *in, bool *out);
419 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
420
421 /// parses an on/off command argument
422 #define COMMAND_PARSE_ON_OFF(in, out) \
423 COMMAND_PARSE_BOOL(in, out, "on", "off")
424 /// parses an enable/disable command argument
425 #define COMMAND_PARSE_ENABLE(in, out) \
426 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
427
428 void script_debug(Jim_Interp *interp, const char *cmd,
429 unsigned argc, Jim_Obj *const *argv);
430
431 #endif /* COMMAND_H */