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 target *current_target;
58 /* The target set by 'targets xx' command or the latest created */
59 struct target *current_target_override;
60 /* If set overrides current_target
61 * It happens during processing of
62 * 1) a target prefixed command
64 * Pay attention to reentrancy when setting override.
66 command_output_handler_t output_handler;
67 void *output_handler_priv;
68 struct list_head *help_list;
74 * When run_command is called, a new instance will be created on the
75 * stack, filled with the proper values, and passed by reference to the
76 * required COMMAND_HANDLER routine.
78 struct command_invocation {
79 struct command_context *ctx;
80 struct command *current;
88 * Command handlers may be defined with more parameters than the base
89 * set provided by command.c. This macro uses C99 magic to allow
90 * defining all such derivative types using this macro.
92 #define __COMMAND_HANDLER(name, extra ...) \
93 int name(struct command_invocation *cmd, ## extra)
96 * Use this to macro to call a command helper (or a nested handler).
97 * It provides command handler authors protection against reordering or
98 * removal of unused parameters.
100 * @b Note: This macro uses lexical capture to provide some arguments.
101 * As a result, this macro should be used @b only within functions
102 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
103 * macros provide the expected lexical context captured by this macro.
104 * Furthermore, it should be used only from the top-level of handler or
105 * helper function, or care must be taken to avoid redefining the same
106 * variables in intervening scope(s) by accident.
108 #define CALL_COMMAND_HANDLER(name, extra ...) \
112 * Always use this macro to define new command handler functions.
113 * It ensures the parameters are ordered, typed, and named properly, so
114 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
115 * All command handler functions must be defined as static in scope.
117 #define COMMAND_HANDLER(name) \
118 static __COMMAND_HANDLER(name)
121 * Similar to COMMAND_HANDLER, except some parameters are expected.
122 * A helper is globally-scoped because it may be shared between several
123 * source files (e.g. the s3c24xx device command helper).
125 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
128 * Use this macro to access the command being handled,
129 * rather than accessing the variable directly. It may be moved.
133 * Use this macro to access the context of the command being handled,
134 * rather than accessing the variable directly. It may be moved.
136 #define CMD_CTX (cmd->ctx)
138 * Use this macro to access the number of arguments for the command being
139 * handled, rather than accessing the variable directly. It may be moved.
141 #define CMD_ARGC (cmd->argc)
143 * Use this macro to access the arguments for the command being handled,
144 * rather than accessing the variable directly. It may be moved.
146 #define CMD_ARGV (cmd->argv)
148 * Use this macro to access the name of the command being handled,
149 * rather than accessing the variable directly. It may be moved.
151 #define CMD_NAME (cmd->name)
153 * Use this macro to access the current command being handled,
154 * rather than accessing the variable directly. It may be moved.
156 #define CMD_CURRENT (cmd->current)
158 * Use this macro to access the invoked command handler's data pointer,
159 * rather than accessing the variable directly. It may be moved.
161 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
164 * The type signature for command handling functions. They are
165 * usually registered as part of command_registration, providing
166 * a high-level means for executing a command.
168 * If the command fails, it *MUST* return a value != ERROR_OK
169 * (many commands break this rule, patches welcome!)
171 * This is *especially* important for commands such as writing
172 * to flash or verifying memory. The reason is that those commands
173 * can be used by programs to determine if the operation succeeded
174 * or not. If the operation failed, then a program can try
175 * an alternative approach.
177 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
178 * printing out the syntax of the command.
180 typedef __COMMAND_HANDLER((*command_handler_t));
184 command_handler_t handler;
185 Jim_CmdProc *jim_handler;
186 void *jim_handler_data;
187 /* Command handlers can use it for any handler specific data */
188 struct target *jim_override_target;
189 /* Used only for target of target-prefixed cmd */
190 enum command_mode mode;
194 * Return the struct command pointer kept in private data
195 * Used to enforce check on data type
197 static inline struct command *jim_to_command(Jim_Interp *interp)
199 return Jim_CmdPrivData(interp);
203 * Commands should be registered by filling in one or more of these
204 * structures and passing them to [un]register_commands().
206 * A conventional format should be used for help strings, to provide both
207 * usage and basic information:
209 * "@<options@> ... - some explanation text"
212 * @param name The name of the command to register, which must not have
213 * been registered previously in the intended context.
214 * @param handler The callback function that will be called. If NULL,
215 * then the command serves as a placeholder for its children or a script.
216 * @param mode The command mode(s) in which this command may be run.
217 * @param help The help text that will be displayed to the user.
219 struct command_registration {
221 command_handler_t handler;
222 Jim_CmdProc *jim_handler;
223 enum command_mode mode;
225 /** a string listing the options and arguments, required or optional */
229 * If non-NULL, the commands in @c chain will be registered in
230 * the same context and scope of this registration record.
231 * This allows modules to inherit lists commands from other
234 const struct command_registration *chain;
237 /** Use this as the last entry in an array of command_registration records. */
238 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
240 int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
241 const struct command_registration *cmds, void *data,
242 struct target *override_target);
245 * Register one or more commands in the specified context, as children
246 * of @c parent (or top-level commends, if NULL). In a registration's
247 * record contains a non-NULL @c chain member and name is NULL, the
248 * commands on the chain will be registered in the same context.
249 * Otherwise, the chained commands are added as children of the command.
251 * @param cmd_ctx The command_context in which to register the command.
252 * @param cmd_prefix Register this command as a child of this, or NULL to
253 * register a top-level command.
254 * @param cmds Pointer to an array of command_registration records that
255 * contains the desired command parameters. The last record must have
256 * NULL for all fields.
257 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
259 static inline int register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
260 const struct command_registration *cmds)
262 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, NULL);
266 * Register one or more commands, as register_commands(), plus specify
267 * that command should override the current target
269 * @param cmd_ctx The command_context in which to register the command.
270 * @param cmd_prefix Register this command as a child of this, or NULL to
271 * register a top-level command.
272 * @param cmds Pointer to an array of command_registration records that
273 * contains the desired command parameters. The last record must have
274 * NULL for all fields.
275 * @param target The target that has to override current target.
276 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
278 static inline int register_commands_override_target(struct command_context *cmd_ctx,
279 const char *cmd_prefix, const struct command_registration *cmds,
280 struct target *target)
282 return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, target);
286 * Register one or more commands, as register_commands(), plus specify
287 * a pointer to command private data that would be accessible through
288 * the macro CMD_DATA. The private data will not be freed when command
291 * @param cmd_ctx The command_context in which to register the command.
292 * @param cmd_prefix Register this command as a child of this, or NULL to
293 * register a top-level command.
294 * @param cmds Pointer to an array of command_registration records that
295 * contains the desired command parameters. The last record must have
296 * NULL for all fields.
297 * @param data The command private data.
298 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
300 static inline int register_commands_with_data(struct command_context *cmd_ctx,
301 const char *cmd_prefix, const struct command_registration *cmds,
304 return __register_commands(cmd_ctx, cmd_prefix, cmds, data, NULL);
308 * Unregisters all commands from the specified context.
309 * @param cmd_ctx The context that will be cleared of registered commands.
310 * @param cmd_prefix If given, only clear commands from under this one command.
311 * @returns ERROR_OK on success, or an error code.
313 int unregister_all_commands(struct command_context *cmd_ctx,
314 const char *cmd_prefix);
317 * Unregisters the help for all commands. Used at exit to remove the help
318 * added through the commands 'add_help_text' and 'add_usage_text'.
319 * @param cmd_ctx The context that will be cleared of registered helps.
320 * @returns ERROR_OK on success, or an error code.
322 int help_del_all_commands(struct command_context *cmd_ctx);
324 void command_set_output_handler(struct command_context *context,
325 command_output_handler_t output_handler, void *priv);
328 int command_context_mode(struct command_context *context, enum command_mode mode);
330 /* Return the current command context associated with the Jim interpreter or
331 * alternatively the global default command interpreter
333 struct command_context *current_command_context(Jim_Interp *interp);
335 * Creates a new command context using the startup TCL provided and
336 * the existing Jim interpreter, if any. If interp == NULL, then command_init
337 * creates a command interpreter.
339 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
341 * Shutdown a command context.
343 * Free the command context and the associated Jim interpreter.
345 * @param context The command_context that will be destroyed.
347 void command_exit(struct command_context *context);
349 * Creates a copy of an existing command context. This does not create
350 * a deep copy of the command list, so modifications in one context will
351 * affect all shared contexts. The caller must track reference counting
352 * and ensure the commands are freed before destroying the last instance.
353 * @param cmd_ctx The command_context that will be copied.
354 * @returns A new command_context with the same state as the original.
356 struct command_context *copy_command_context(struct command_context *cmd_ctx);
358 * Frees the resources associated with a command context. The commands
359 * are not removed, so unregister_all_commands() must be called first.
360 * @param context The command_context that will be destroyed.
362 void command_done(struct command_context *context);
364 void command_print(struct command_invocation *cmd, const char *format, ...)
365 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
366 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
367 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
368 int command_run_line(struct command_context *context, char *line);
369 int command_run_linef(struct command_context *context, const char *format, ...)
370 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
371 void command_output_text(struct command_context *context, const char *data);
373 void process_jim_events(struct command_context *cmd_ctx);
375 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
376 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
377 #define ERROR_COMMAND_NOTFOUND (-602)
378 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
379 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
380 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
382 int parse_ulong(const char *str, unsigned long *ul);
383 int parse_ullong(const char *str, unsigned long long *ul);
385 int parse_long(const char *str, long *ul);
386 int parse_llong(const char *str, long long *ul);
388 #define DECLARE_PARSE_WRAPPER(name, type) \
389 int parse ## name(const char *str, type * ul)
391 DECLARE_PARSE_WRAPPER(_uint, unsigned);
392 DECLARE_PARSE_WRAPPER(_u64, uint64_t);
393 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
394 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
395 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
397 DECLARE_PARSE_WRAPPER(_int, int);
398 DECLARE_PARSE_WRAPPER(_s64, int64_t);
399 DECLARE_PARSE_WRAPPER(_s32, int32_t);
400 DECLARE_PARSE_WRAPPER(_s16, int16_t);
401 DECLARE_PARSE_WRAPPER(_s8, int8_t);
403 DECLARE_PARSE_WRAPPER(_target_addr, target_addr_t);
406 * @brief parses the string @a in into @a out as a @a type, or prints
407 * a command error and passes the error code to the caller. If an error
408 * does occur, the calling function will return the error code produced
409 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
411 * This function may cause the calling function to return immediately,
412 * so it should be used carefully to avoid leaking resources. In most
413 * situations, parsing should be completed in full before proceeding
414 * to allocate resources, and this strategy will most prevents leaks.
416 #define COMMAND_PARSE_NUMBER(type, in, out) \
418 int retval_macro_tmp = parse_ ## type(in, &(out)); \
419 if (ERROR_OK != retval_macro_tmp) { \
420 command_print(CMD, stringify(out) \
421 " option value ('%s') is not valid", in); \
422 return retval_macro_tmp; \
426 #define COMMAND_PARSE_ADDRESS(in, out) \
427 COMMAND_PARSE_NUMBER(target_addr, in, out)
430 * Parse the string @c as a binary parameter, storing the boolean value
431 * in @c out. The strings @c on and @c off are used to match different
432 * strings for true and false options (e.g. "on" and "off" or
433 * "enable" and "disable").
435 #define COMMAND_PARSE_BOOL(in, out, on, off) \
438 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
439 if (ERROR_OK != retval_macro_tmp) { \
440 command_print(CMD, stringify(out) \
441 " option value ('%s') is not valid", in); \
442 command_print(CMD, " choices are '%s' or '%s'", \
444 return retval_macro_tmp; \
449 int command_parse_bool_arg(const char *in, bool *out);
450 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
452 /** parses an on/off command argument */
453 #define COMMAND_PARSE_ON_OFF(in, out) \
454 COMMAND_PARSE_BOOL(in, out, "on", "off")
455 /** parses an enable/disable command argument */
456 #define COMMAND_PARSE_ENABLE(in, out) \
457 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
459 #endif /* OPENOCD_HELPER_COMMAND_H */