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
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
45 COMMAND_UNKNOWN = -1, /* error condition */
48 struct command_context;
50 /** The type signature for command context's output handler. */
51 typedef int (*command_output_handler_t)(struct command_context *context,
54 struct command_context {
56 enum command_mode mode;
57 struct command *commands;
58 struct target *current_target;
59 /* The target set by 'targets xx' command or the latest created */
60 struct target *current_target_override;
61 /* If set overrides current_target
62 * It happens during processing of
63 * 1) a target prefixed command
65 * Pay attention to reentrancy when setting override.
67 command_output_handler_t output_handler;
68 void *output_handler_priv;
69 struct list_head *help_list;
75 * When run_command is called, a new instance will be created on the
76 * stack, filled with the proper values, and passed by reference to the
77 * required COMMAND_HANDLER routine.
79 struct command_invocation {
80 struct command_context *ctx;
81 struct command *current;
89 * Command handlers may be defined with more parameters than the base
90 * set provided by command.c. This macro uses C99 magic to allow
91 * defining all such derivative types using this macro.
93 #define __COMMAND_HANDLER(name, extra ...) \
94 int name(struct command_invocation *cmd, ## extra)
97 * Use this to macro to call a command helper (or a nested handler).
98 * It provides command handler authors protection against reordering or
99 * removal of unused parameters.
101 * @b Note: This macro uses lexical capture to provide some arguments.
102 * As a result, this macro should be used @b only within functions
103 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
104 * macros provide the expected lexical context captured by this macro.
105 * Furthermore, it should be used only from the top-level of handler or
106 * helper function, or care must be taken to avoid redefining the same
107 * variables in intervening scope(s) by accident.
109 #define CALL_COMMAND_HANDLER(name, extra ...) \
113 * Always use this macro to define new command handler functions.
114 * It ensures the parameters are ordered, typed, and named properly, so
115 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
116 * All command handler functions must be defined as static in scope.
118 #define COMMAND_HANDLER(name) \
119 static __COMMAND_HANDLER(name)
122 * Similar to COMMAND_HANDLER, except some parameters are expected.
123 * A helper is globally-scoped because it may be shared between several
124 * source files (e.g. the s3c24xx device command helper).
126 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
129 * Use this macro to access the command being handled,
130 * rather than accessing the variable directly. It may be moved.
134 * Use this macro to access the context of the command being handled,
135 * rather than accessing the variable directly. It may be moved.
137 #define CMD_CTX (cmd->ctx)
139 * Use this macro to access the number of arguments for the command being
140 * handled, rather than accessing the variable directly. It may be moved.
142 #define CMD_ARGC (cmd->argc)
144 * Use this macro to access the arguments for the command being handled,
145 * rather than accessing the variable directly. It may be moved.
147 #define CMD_ARGV (cmd->argv)
149 * Use this macro to access the name of the command being handled,
150 * rather than accessing the variable directly. It may be moved.
152 #define CMD_NAME (cmd->name)
154 * Use this macro to access the current command being handled,
155 * rather than accessing the variable directly. It may be moved.
157 #define CMD_CURRENT (cmd->current)
159 * Use this macro to access the invoked command handler's data pointer,
160 * rather than accessing the variable directly. It may be moved.
162 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
165 * The type signature for command handling functions. They are
166 * usually registered as part of command_registration, providing
167 * a high-level means for executing a command.
169 * If the command fails, it *MUST* return a value != ERROR_OK
170 * (many commands break this rule, patches welcome!)
172 * This is *especially* important for commands such as writing
173 * to flash or verifying memory. The reason is that those commands
174 * can be used by programs to determine if the operation succeeded
175 * or not. If the operation failed, then a program can try
176 * an alternative approach.
178 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
179 * printing out the syntax of the command.
181 typedef __COMMAND_HANDLER((*command_handler_t));
185 struct command *parent;
186 struct command *children;
187 command_handler_t handler;
188 Jim_CmdProc *jim_handler;
189 void *jim_handler_data;
190 /* Command handlers can use it for any handler specific data */
191 struct target *jim_override_target;
192 /* Used only for target of target-prefixed cmd */
193 enum command_mode mode;
194 struct command *next;
198 * Return the struct command pointer kept in private data
199 * Used to enforce check on data type
201 static inline struct command *jim_to_command(Jim_Interp *interp)
203 return Jim_CmdPrivData(interp);
207 * Commands should be registered by filling in one or more of these
208 * structures and passing them to [un]register_commands().
210 * A conventional format should be used for help strings, to provide both
211 * usage and basic information:
213 * "@<options@> ... - some explanation text"
216 * @param name The name of the command to register, which must not have
217 * been registered previously in the intended context.
218 * @param handler The callback function that will be called. If NULL,
219 * then the command serves as a placeholder for its children or a script.
220 * @param mode The command mode(s) in which this command may be run.
221 * @param help The help text that will be displayed to the user.
223 struct command_registration {
225 command_handler_t handler;
226 Jim_CmdProc *jim_handler;
227 enum command_mode mode;
229 /** a string listing the options and arguments, required or optional */
233 * If non-NULL, the commands in @c chain will be registered in
234 * the same context and scope of this registration record.
235 * This allows modules to inherit lists commands from other
238 const struct command_registration *chain;
241 /** Use this as the last entry in an array of command_registration records. */
242 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
244 int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
245 const struct command_registration *cmds, void *data,
246 struct target *override_target);
249 * Register one or more commands in the specified context, as children
250 * of @c parent (or top-level commends, if NULL). In a registration's
251 * record contains a non-NULL @c chain member and name is NULL, the
252 * commands on the chain will be registered in the same context.
253 * Otherwise, the chained commands are added as children of the command.
255 * @param cmd_ctx The command_context in which to register the command.
256 * @param cmd_prefix Register this command as a child of this, or NULL to
257 * register a top-level command.
258 * @param cmds Pointer to an array of command_registration records that
259 * contains the desired command parameters. The last record must have
260 * NULL for all fields.
261 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
263 static inline int register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
264 const struct command_registration *cmds)
266 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, NULL);
270 * Register one or more commands, as register_commands(), plus specify
271 * that command should override the current target
273 * @param cmd_ctx The command_context in which to register the command.
274 * @param cmd_prefix Register this command as a child of this, or NULL to
275 * register a top-level command.
276 * @param cmds Pointer to an array of command_registration records that
277 * contains the desired command parameters. The last record must have
278 * NULL for all fields.
279 * @param target The target that has to override current target.
280 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
282 static inline int register_commands_override_target(struct command_context *cmd_ctx,
283 const char *cmd_prefix, const struct command_registration *cmds,
284 struct target *target)
286 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, target);
290 * Register one or more commands, as register_commands(), plus specify
291 * a pointer to command private data that would be accessible through
292 * the macro CMD_DATA. The private data will not be freed when command
295 * @param cmd_ctx The command_context in which to register the command.
296 * @param cmd_prefix Register this command as a child of this, or NULL to
297 * register a top-level command.
298 * @param cmds Pointer to an array of command_registration records that
299 * contains the desired command parameters. The last record must have
300 * NULL for all fields.
301 * @param data The command private data.
302 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
304 static inline int register_commands_with_data(struct command_context *cmd_ctx,
305 const char *cmd_prefix, const struct command_registration *cmds,
308 return __register_commands(cmd_ctx, cmd_prefix, cmds, data, NULL);
312 * Unregisters all commands from the specified context.
313 * @param cmd_ctx The context that will be cleared of registered commands.
314 * @param parent If given, only clear commands from under this one command.
315 * @returns ERROR_OK on success, or an error code.
317 int unregister_all_commands(struct command_context *cmd_ctx,
318 struct command *parent);
321 * Unregisters the help for all commands. Used at exit to remove the help
322 * added through the commands 'add_help_text' and 'add_usage_text'.
323 * @param cmd_ctx The context that will be cleared of registered helps.
324 * @returns ERROR_OK on success, or an error code.
326 int help_del_all_commands(struct command_context *cmd_ctx);
328 void command_set_output_handler(struct command_context *context,
329 command_output_handler_t output_handler, void *priv);
332 int command_context_mode(struct command_context *context, enum command_mode mode);
334 /* Return the current command context associated with the Jim interpreter or
335 * alternatively the global default command interpreter
337 struct command_context *current_command_context(Jim_Interp *interp);
339 * Creates a new command context using the startup TCL provided and
340 * the existing Jim interpreter, if any. If interp == NULL, then command_init
341 * creates a command interpreter.
343 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
345 * Shutdown a command context.
347 * Free the command context and the associated Jim interpreter.
349 * @param context The command_context that will be destroyed.
351 void command_exit(struct command_context *context);
353 * Creates a copy of an existing command context. This does not create
354 * a deep copy of the command list, so modifications in one context will
355 * affect all shared contexts. The caller must track reference counting
356 * and ensure the commands are freed before destroying the last instance.
357 * @param cmd_ctx The command_context that will be copied.
358 * @returns A new command_context with the same state as the original.
360 struct command_context *copy_command_context(struct command_context *cmd_ctx);
362 * Frees the resources associated with a command context. The commands
363 * are not removed, so unregister_all_commands() must be called first.
364 * @param context The command_context that will be destroyed.
366 void command_done(struct command_context *context);
368 void command_print(struct command_invocation *cmd, const char *format, ...)
369 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
370 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
371 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
372 int command_run_line(struct command_context *context, char *line);
373 int command_run_linef(struct command_context *context, const char *format, ...)
374 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
375 void command_output_text(struct command_context *context, const char *data);
377 void process_jim_events(struct command_context *cmd_ctx);
379 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
380 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
381 #define ERROR_COMMAND_NOTFOUND (-602)
382 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
383 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
384 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
386 int parse_ulong(const char *str, unsigned long *ul);
387 int parse_ullong(const char *str, unsigned long long *ul);
389 int parse_long(const char *str, long *ul);
390 int parse_llong(const char *str, long long *ul);
392 #define DECLARE_PARSE_WRAPPER(name, type) \
393 int parse ## name(const char *str, type * ul)
395 DECLARE_PARSE_WRAPPER(_uint, unsigned);
396 DECLARE_PARSE_WRAPPER(_u64, uint64_t);
397 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
398 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
399 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
401 DECLARE_PARSE_WRAPPER(_int, int);
402 DECLARE_PARSE_WRAPPER(_s64, int64_t);
403 DECLARE_PARSE_WRAPPER(_s32, int32_t);
404 DECLARE_PARSE_WRAPPER(_s16, int16_t);
405 DECLARE_PARSE_WRAPPER(_s8, int8_t);
407 DECLARE_PARSE_WRAPPER(_target_addr, target_addr_t);
410 * @brief parses the string @a in into @a out as a @a type, or prints
411 * a command error and passes the error code to the caller. If an error
412 * does occur, the calling function will return the error code produced
413 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
415 * This function may cause the calling function to return immediately,
416 * so it should be used carefully to avoid leaking resources. In most
417 * situations, parsing should be completed in full before proceeding
418 * to allocate resources, and this strategy will most prevents leaks.
420 #define COMMAND_PARSE_NUMBER(type, in, out) \
422 int retval_macro_tmp = parse_ ## type(in, &(out)); \
423 if (ERROR_OK != retval_macro_tmp) { \
424 command_print(CMD, stringify(out) \
425 " option value ('%s') is not valid", in); \
426 return retval_macro_tmp; \
430 #define COMMAND_PARSE_ADDRESS(in, out) \
431 COMMAND_PARSE_NUMBER(target_addr, in, out)
434 * Parse the string @c as a binary parameter, storing the boolean value
435 * in @c out. The strings @c on and @c off are used to match different
436 * strings for true and false options (e.g. "on" and "off" or
437 * "enable" and "disable").
439 #define COMMAND_PARSE_BOOL(in, out, on, off) \
442 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
443 if (ERROR_OK != retval_macro_tmp) { \
444 command_print(CMD, stringify(out) \
445 " option value ('%s') is not valid", in); \
446 command_print(CMD, " choices are '%s' or '%s'", \
448 return retval_macro_tmp; \
453 int command_parse_bool_arg(const char *in, bool *out);
454 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
456 /** parses an on/off command argument */
457 #define COMMAND_PARSE_ON_OFF(in, out) \
458 COMMAND_PARSE_BOOL(in, out, "on", "off")
459 /** parses an enable/disable command argument */
460 #define COMMAND_PARSE_ENABLE(in, out) \
461 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
463 void script_debug(Jim_Interp *interp, unsigned int argc, Jim_Obj * const *argv);
465 #endif /* OPENOCD_HELPER_COMMAND_H */