1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
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. *
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. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
22 #ifndef OPENOCD_HELPER_COMMAND_H
23 #define OPENOCD_HELPER_COMMAND_H
28 #include <helper/jim-nvp.h>
29 #include <helper/list.h>
30 #include <helper/types.h>
32 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
33 * used for __attribute__((format( ... ))), with GCC v4.4 or later
35 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
36 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
38 #define PRINTF_ATTRIBUTE_FORMAT printf
42 * OpenOCD command mode is COMMAND_CONFIG at start, then switches to COMMAND_EXEC
43 * during the execution of command 'init'.
44 * The field 'mode' in struct command_registration specifies in which command mode
45 * the command can be executed:
46 * - during COMMAND_CONFIG only,
47 * - during COMMAND_EXEC only,
48 * - in both modes (COMMAND_ANY).
54 COMMAND_UNKNOWN = -1, /* error condition */
57 struct command_context;
59 /** The type signature for command context's output handler. */
60 typedef int (*command_output_handler_t)(struct command_context *context,
63 struct command_context {
65 enum command_mode mode;
66 struct target *current_target;
67 /* The target set by 'targets xx' command or the latest created */
68 struct target *current_target_override;
69 /* If set overrides current_target
70 * It happens during processing of
71 * 1) a target prefixed command
73 * Pay attention to reentrancy when setting override.
75 command_output_handler_t output_handler;
76 void *output_handler_priv;
77 struct list_head *help_list;
83 * When run_command is called, a new instance will be created on the
84 * stack, filled with the proper values, and passed by reference to the
85 * required COMMAND_HANDLER routine.
87 struct command_invocation {
88 struct command_context *ctx;
89 struct command *current;
97 * Return true if the command @c cmd is registered by OpenOCD.
99 bool jimcmd_is_oocd_command(Jim_Cmd *cmd);
102 * Return the pointer to the command's private data specified during the
103 * registration of command @a cmd .
105 void *jimcmd_privdata(Jim_Cmd *cmd);
108 * Command handlers may be defined with more parameters than the base
109 * set provided by command.c. This macro uses C99 magic to allow
110 * defining all such derivative types using this macro.
112 #define __COMMAND_HANDLER(name, extra ...) \
113 int name(struct command_invocation *cmd, ## extra)
116 * Use this to macro to call a command helper (or a nested handler).
117 * It provides command handler authors protection against reordering or
118 * removal of unused parameters.
120 * @b Note: This macro uses lexical capture to provide some arguments.
121 * As a result, this macro should be used @b only within functions
122 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
123 * macros provide the expected lexical context captured by this macro.
124 * Furthermore, it should be used only from the top-level of handler or
125 * helper function, or care must be taken to avoid redefining the same
126 * variables in intervening scope(s) by accident.
128 #define CALL_COMMAND_HANDLER(name, extra ...) \
132 * Always use this macro to define new command handler functions.
133 * It ensures the parameters are ordered, typed, and named properly, so
134 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
135 * All command handler functions must be defined as static in scope.
137 #define COMMAND_HANDLER(name) \
138 static __COMMAND_HANDLER(name)
141 * Similar to COMMAND_HANDLER, except some parameters are expected.
142 * A helper is globally-scoped because it may be shared between several
143 * source files (e.g. the s3c24xx device command helper).
145 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
148 * Use this macro to access the command being handled,
149 * rather than accessing the variable directly. It may be moved.
153 * Use this macro to access the context of the command being handled,
154 * rather than accessing the variable directly. It may be moved.
156 #define CMD_CTX (cmd->ctx)
158 * Use this macro to access the number of arguments for the command being
159 * handled, rather than accessing the variable directly. It may be moved.
161 #define CMD_ARGC (cmd->argc)
163 * Use this macro to access the arguments for the command being handled,
164 * rather than accessing the variable directly. It may be moved.
166 #define CMD_ARGV (cmd->argv)
168 * Use this macro to access the name of the command being handled,
169 * rather than accessing the variable directly. It may be moved.
171 #define CMD_NAME (cmd->name)
173 * Use this macro to access the current command being handled,
174 * rather than accessing the variable directly. It may be moved.
176 #define CMD_CURRENT (cmd->current)
178 * Use this macro to access the invoked command handler's data pointer,
179 * rather than accessing the variable directly. It may be moved.
181 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
184 * The type signature for command handling functions. They are
185 * usually registered as part of command_registration, providing
186 * a high-level means for executing a command.
188 * If the command fails, it *MUST* return a value != ERROR_OK
189 * (many commands break this rule, patches welcome!)
191 * This is *especially* important for commands such as writing
192 * to flash or verifying memory. The reason is that those commands
193 * can be used by programs to determine if the operation succeeded
194 * or not. If the operation failed, then a program can try
195 * an alternative approach.
197 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
198 * printing out the syntax of the command.
200 typedef __COMMAND_HANDLER((*command_handler_t));
204 command_handler_t handler;
205 Jim_CmdProc *jim_handler;
206 void *jim_handler_data;
207 /* Command handlers can use it for any handler specific data */
208 struct target *jim_override_target;
209 /* Used only for target of target-prefixed cmd */
210 enum command_mode mode;
214 * Return the struct command pointer kept in private data
215 * Used to enforce check on data type
217 static inline struct command *jim_to_command(Jim_Interp *interp)
219 return Jim_CmdPrivData(interp);
223 * Commands should be registered by filling in one or more of these
224 * structures and passing them to [un]register_commands().
226 * A conventional format should be used for help strings, to provide both
227 * usage and basic information:
229 * "@<options@> ... - some explanation text"
232 * @param name The name of the command to register, which must not have
233 * been registered previously in the intended context.
234 * @param handler The callback function that will be called. If NULL,
235 * then the command serves as a placeholder for its children or a script.
236 * @param mode The command mode(s) in which this command may be run.
237 * @param help The help text that will be displayed to the user.
239 struct command_registration {
241 command_handler_t handler;
242 Jim_CmdProc *jim_handler;
243 enum command_mode mode;
245 /** a string listing the options and arguments, required or optional */
249 * If non-NULL, the commands in @c chain will be registered in
250 * the same context and scope of this registration record.
251 * This allows modules to inherit lists commands from other
254 const struct command_registration *chain;
257 /** Use this as the last entry in an array of command_registration records. */
258 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
260 int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
261 const struct command_registration *cmds, void *data,
262 struct target *override_target);
265 * Register one or more commands in the specified context, as children
266 * of @c parent (or top-level commends, if NULL). In a registration's
267 * record contains a non-NULL @c chain member and name is NULL, the
268 * commands on the chain will be registered in the same context.
269 * Otherwise, the chained commands are added as children of the command.
271 * @param cmd_ctx The command_context in which to register the command.
272 * @param cmd_prefix Register this command as a child of this, or NULL to
273 * register a top-level command.
274 * @param cmds Pointer to an array of command_registration records that
275 * contains the desired command parameters. The last record must have
276 * NULL for all fields.
277 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
279 static inline int register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
280 const struct command_registration *cmds)
282 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, NULL);
286 * Register one or more commands, as register_commands(), plus specify
287 * that command should override the current target
289 * @param cmd_ctx The command_context in which to register the command.
290 * @param cmd_prefix Register this command as a child of this, or NULL to
291 * register a top-level command.
292 * @param cmds Pointer to an array of command_registration records that
293 * contains the desired command parameters. The last record must have
294 * NULL for all fields.
295 * @param target The target that has to override current target.
296 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
298 static inline int register_commands_override_target(struct command_context *cmd_ctx,
299 const char *cmd_prefix, const struct command_registration *cmds,
300 struct target *target)
302 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, target);
306 * Register one or more commands, as register_commands(), plus specify
307 * a pointer to command private data that would be accessible through
308 * the macro CMD_DATA. The private data will not be freed when command
311 * @param cmd_ctx The command_context in which to register the command.
312 * @param cmd_prefix Register this command as a child of this, or NULL to
313 * register a top-level command.
314 * @param cmds Pointer to an array of command_registration records that
315 * contains the desired command parameters. The last record must have
316 * NULL for all fields.
317 * @param data The command private data.
318 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
320 static inline int register_commands_with_data(struct command_context *cmd_ctx,
321 const char *cmd_prefix, const struct command_registration *cmds,
324 return __register_commands(cmd_ctx, cmd_prefix, cmds, data, NULL);
328 * Unregisters all commands from the specified context.
329 * @param cmd_ctx The context that will be cleared of registered commands.
330 * @param cmd_prefix If given, only clear commands from under this one command.
331 * @returns ERROR_OK on success, or an error code.
333 int unregister_all_commands(struct command_context *cmd_ctx,
334 const char *cmd_prefix);
337 * Unregisters the help for all commands. Used at exit to remove the help
338 * added through the commands 'add_help_text' and 'add_usage_text'.
339 * @param cmd_ctx The context that will be cleared of registered helps.
340 * @returns ERROR_OK on success, or an error code.
342 int help_del_all_commands(struct command_context *cmd_ctx);
344 void command_set_output_handler(struct command_context *context,
345 command_output_handler_t output_handler, void *priv);
348 int command_context_mode(struct command_context *context, enum command_mode mode);
350 /* Return the current command context associated with the Jim interpreter or
351 * alternatively the global default command interpreter
353 struct command_context *current_command_context(Jim_Interp *interp);
355 * Creates a new command context using the startup TCL provided and
356 * the existing Jim interpreter, if any. If interp == NULL, then command_init
357 * creates a command interpreter.
359 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
361 * Shutdown a command context.
363 * Free the command context and the associated Jim interpreter.
365 * @param context The command_context that will be destroyed.
367 void command_exit(struct command_context *context);
369 * Creates a copy of an existing command context. This does not create
370 * a deep copy of the command list, so modifications in one context will
371 * affect all shared contexts. The caller must track reference counting
372 * and ensure the commands are freed before destroying the last instance.
373 * @param cmd_ctx The command_context that will be copied.
374 * @returns A new command_context with the same state as the original.
376 struct command_context *copy_command_context(struct command_context *cmd_ctx);
378 * Frees the resources associated with a command context. The commands
379 * are not removed, so unregister_all_commands() must be called first.
380 * @param context The command_context that will be destroyed.
382 void command_done(struct command_context *context);
384 void command_print(struct command_invocation *cmd, const char *format, ...)
385 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
386 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
387 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
388 int command_run_line(struct command_context *context, char *line);
389 int command_run_linef(struct command_context *context, const char *format, ...)
390 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
391 void command_output_text(struct command_context *context, const char *data);
393 void process_jim_events(struct command_context *cmd_ctx);
395 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
396 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
397 #define ERROR_COMMAND_NOTFOUND (-602)
398 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
399 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
400 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
402 int parse_ulong(const char *str, unsigned long *ul);
403 int parse_ullong(const char *str, unsigned long long *ul);
405 int parse_long(const char *str, long *ul);
406 int parse_llong(const char *str, long long *ul);
408 #define DECLARE_PARSE_WRAPPER(name, type) \
409 int parse ## name(const char *str, type * ul)
411 DECLARE_PARSE_WRAPPER(_uint, unsigned);
412 DECLARE_PARSE_WRAPPER(_u64, uint64_t);
413 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
414 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
415 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
417 DECLARE_PARSE_WRAPPER(_int, int);
418 DECLARE_PARSE_WRAPPER(_s64, int64_t);
419 DECLARE_PARSE_WRAPPER(_s32, int32_t);
420 DECLARE_PARSE_WRAPPER(_s16, int16_t);
421 DECLARE_PARSE_WRAPPER(_s8, int8_t);
423 DECLARE_PARSE_WRAPPER(_target_addr, target_addr_t);
426 * @brief parses the string @a in into @a out as a @a type, or prints
427 * a command error and passes the error code to the caller. If an error
428 * does occur, the calling function will return the error code produced
429 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
431 * This function may cause the calling function to return immediately,
432 * so it should be used carefully to avoid leaking resources. In most
433 * situations, parsing should be completed in full before proceeding
434 * to allocate resources, and this strategy will most prevents leaks.
436 #define COMMAND_PARSE_NUMBER(type, in, out) \
438 int retval_macro_tmp = parse_ ## type(in, &(out)); \
439 if (retval_macro_tmp != ERROR_OK) { \
440 command_print(CMD, stringify(out) \
441 " option value ('%s') is not valid", in); \
442 return retval_macro_tmp; \
446 #define COMMAND_PARSE_ADDRESS(in, out) \
447 COMMAND_PARSE_NUMBER(target_addr, in, out)
450 * @brief parses the command argument at position @a argn into @a out
451 * as a @a type, or prints a command error referring to @a name_str
452 * and passes the error code to the caller. @a argn will be incremented
453 * if no error occurred. Otherwise the calling function will return
454 * the error code produced by the parsing function.
456 * This function may cause the calling function to return immediately,
457 * so it should be used carefully to avoid leaking resources. In most
458 * situations, parsing should be completed in full before proceeding
459 * to allocate resources, and this strategy will most prevents leaks.
461 #define COMMAND_PARSE_ADDITIONAL_NUMBER(type, argn, out, name_str) \
463 if (argn+1 >= CMD_ARGC || CMD_ARGV[argn+1][0] == '-') { \
464 command_print(CMD, "no " name_str " given"); \
468 COMMAND_PARSE_NUMBER(type, CMD_ARGV[argn], out); \
472 * @brief parses the command argument at position @a argn into @a out
473 * as a @a type if the argument @a argn does not start with '-'.
474 * and passes the error code to the caller. @a argn will be incremented
475 * if no error occurred. Otherwise the calling function will return
476 * the error code produced by the parsing function.
478 * This function may cause the calling function to return immediately,
479 * so it should be used carefully to avoid leaking resources. In most
480 * situations, parsing should be completed in full before proceeding
481 * to allocate resources, and this strategy will most prevents leaks.
483 #define COMMAND_PARSE_OPTIONAL_NUMBER(type, argn, out) \
485 if (argn+1 < CMD_ARGC && CMD_ARGV[argn+1][0] != '-') { \
487 COMMAND_PARSE_NUMBER(type, CMD_ARGV[argn], out); \
492 * Parse the string @c as a binary parameter, storing the boolean value
493 * in @c out. The strings @c on and @c off are used to match different
494 * strings for true and false options (e.g. "on" and "off" or
495 * "enable" and "disable").
497 #define COMMAND_PARSE_BOOL(in, out, on, off) \
500 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
501 if (retval_macro_tmp != ERROR_OK) { \
502 command_print(CMD, stringify(out) \
503 " option value ('%s') is not valid", in); \
504 command_print(CMD, " choices are '%s' or '%s'", \
506 return retval_macro_tmp; \
511 int command_parse_bool_arg(const char *in, bool *out);
512 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
514 /** parses an on/off command argument */
515 #define COMMAND_PARSE_ON_OFF(in, out) \
516 COMMAND_PARSE_BOOL(in, out, "on", "off")
517 /** parses an enable/disable command argument */
518 #define COMMAND_PARSE_ENABLE(in, out) \
519 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
521 #endif /* OPENOCD_HELPER_COMMAND_H */