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/types.h>
31 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
32 * used for __attribute__((format( ... ))), with GCC v4.4 or later
34 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
35 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
37 #define PRINTF_ATTRIBUTE_FORMAT printf
46 struct command_context;
48 /** The type signature for command context's output handler. */
49 typedef int (*command_output_handler_t)(struct command_context *context,
52 struct command_context {
54 enum command_mode mode;
55 struct command *commands;
56 struct target *current_target;
57 /* The target set by 'targets xx' command or the latest created */
58 struct target *current_target_override;
59 /* If set overrides current_target
60 * It happens during processing of
61 * 1) a target prefixed command
63 * Pay attention to reentrancy when setting override.
65 command_output_handler_t output_handler;
66 void *output_handler_priv;
72 * When run_command is called, a new instance will be created on the
73 * stack, filled with the proper values, and passed by reference to the
74 * required COMMAND_HANDLER routine.
76 struct command_invocation {
77 struct command_context *ctx;
78 struct command *current;
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.
90 #define __COMMAND_HANDLER(name, extra ...) \
91 int name(struct command_invocation *cmd, ## extra)
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.
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.
106 #define CALL_COMMAND_HANDLER(name, extra ...) \
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.
115 #define COMMAND_HANDLER(name) \
116 static __COMMAND_HANDLER(name)
119 * Similar to COMMAND_HANDLER, except some parameters are expected.
120 * A helper is globally-scoped because it may be shared between several
121 * source files (e.g. the s3c24xx device command helper).
123 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
126 * Use this macro to access the command being handled,
127 * rather than accessing the variable directly. It may be moved.
131 * Use this macro to access the context of the command being handled,
132 * rather than accessing the variable directly. It may be moved.
134 #define CMD_CTX (cmd->ctx)
136 * Use this macro to access the number of arguments for the command being
137 * handled, rather than accessing the variable directly. It may be moved.
139 #define CMD_ARGC (cmd->argc)
141 * Use this macro to access the arguments for the command being handled,
142 * rather than accessing the variable directly. It may be moved.
144 #define CMD_ARGV (cmd->argv)
146 * Use this macro to access the name of the command being handled,
147 * rather than accessing the variable directly. It may be moved.
149 #define CMD_NAME (cmd->name)
151 * Use this macro to access the current command being handled,
152 * rather than accessing the variable directly. It may be moved.
154 #define CMD_CURRENT (cmd->current)
156 * Use this macro to access the invoked command handler's data pointer,
157 * rather than accessing the variable directly. It may be moved.
159 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
162 * The type signature for command handling functions. They are
163 * usually registered as part of command_registration, providing
164 * a high-level means for executing a command.
166 * If the command fails, it *MUST* return a value != ERROR_OK
167 * (many commands break this rule, patches welcome!)
169 * This is *especially* important for commands such as writing
170 * to flash or verifying memory. The reason is that those commands
171 * can be used by programs to determine if the operation succeded
172 * or not. If the operation failed, then a program can try
173 * an alternative approach.
175 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
176 * printing out the syntax of the command.
178 typedef __COMMAND_HANDLER((*command_handler_t));
184 struct command *parent;
185 struct command *children;
186 command_handler_t handler;
187 Jim_CmdProc *jim_handler;
188 void *jim_handler_data;
189 /* Currently used only for target of target-prefixed cmd.
190 * Native OpenOCD commands use jim_handler_data exclusively
191 * as a target override.
192 * Jim handlers outside of target cmd tree can use
193 * jim_handler_data for any handler specific data */
194 enum command_mode mode;
195 struct command *next;
199 * @param c The command to be named.
200 * @param delim The character to place between command names.
201 * @returns A malloc'd string containing the full command name,
202 * which may include one or more ancestor components. Multiple names
203 * are separated by single spaces. The caller must free() the string
206 char *command_name(struct command *c, char delim);
209 * Commands should be registered by filling in one or more of these
210 * structures and passing them to register_command().
212 * A conventioal format should be used for help strings, to provide both
213 * usage and basic information:
215 * "@<options@> ... - some explanation text"
218 * @param name The name of the command to register, which must not have
219 * been registered previously in the intended context.
220 * @param handler The callback function that will be called. If NULL,
221 * then the command serves as a placeholder for its children or a script.
222 * @param mode The command mode(s) in which this command may be run.
223 * @param help The help text that will be displayed to the user.
225 struct command_registration {
227 command_handler_t handler;
228 Jim_CmdProc *jim_handler;
229 enum command_mode mode;
231 /** a string listing the options and arguments, required or optional */
235 * If non-NULL, the commands in @c chain will be registered in
236 * the same context and scope of this registration record.
237 * This allows modules to inherit lists commands from other
240 const struct command_registration *chain;
243 /** Use this as the last entry in an array of command_registration records. */
244 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
247 * Register a command @c handler that can be called from scripts during
248 * the execution @c mode specified.
250 * If @c parent is non-NULL, the new command will be registered as a
251 * sub-command under it; otherwise, it will be available as a top-level
254 * @param cmd_ctx The command_context in which to register the command.
255 * @param parent Register this command as a child of this, or NULL to
256 * register a top-level command.
257 * @param rec A command_registration record that contains the desired
258 * command parameters.
259 * @returns The new command, if successful; otherwise, NULL.
261 struct command *register_command(struct command_context *cmd_ctx,
262 struct command *parent, const struct command_registration *rec);
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 parent 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 int register_commands(struct command_context *cmd_ctx, struct command *parent,
280 const struct command_registration *cmds);
284 * Unregisters command @c name from the given context, @c cmd_ctx.
285 * @param cmd_ctx The context of the registered command.
286 * @param parent The parent of the given command, or NULL.
287 * @param name The name of the command to unregister.
288 * @returns ERROR_OK on success, or an error code.
290 int unregister_command(struct command_context *cmd_ctx,
291 struct command *parent, const char *name);
293 * Unregisters all commands from the specfied context.
294 * @param cmd_ctx The context that will be cleared of registered commands.
295 * @param parent If given, only clear commands from under this one command.
296 * @returns ERROR_OK on success, or an error code.
298 int unregister_all_commands(struct command_context *cmd_ctx,
299 struct command *parent);
301 struct command *command_find_in_context(struct command_context *cmd_ctx,
303 struct command *command_find_in_parent(struct command *parent,
307 * Update the private command data field for a command and all descendents.
308 * This is used when creating a new heirarchy of commands that depends
309 * on obtaining a dynamically created context. The value will be available
310 * in command handlers by using the CMD_DATA macro.
311 * @param c The command (group) whose data pointer(s) will be updated.
312 * @param p The new data pointer to use for the command or its descendents.
314 void command_set_handler_data(struct command *c, void *p);
316 void command_set_output_handler(struct command_context *context,
317 command_output_handler_t output_handler, void *priv);
320 int command_context_mode(struct command_context *context, enum command_mode mode);
322 /* Return the current command context associated with the Jim interpreter or
323 * alternatively the global default command interpreter
325 struct command_context *current_command_context(Jim_Interp *interp);
327 * Creates a new command context using the startup TCL provided and
328 * the existing Jim interpreter, if any. If interp == NULL, then command_init
329 * creates a command interpreter.
331 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
333 * Shutdown a command context.
335 * Free the command context and the associated Jim interpreter.
337 * @param context The command_context that will be destroyed.
339 void command_exit(struct command_context *context);
341 * Creates a copy of an existing command context. This does not create
342 * a deep copy of the command list, so modifications in one context will
343 * affect all shared contexts. The caller must track reference counting
344 * and ensure the commands are freed before destroying the last instance.
345 * @param cmd_ctx The command_context that will be copied.
346 * @returns A new command_context with the same state as the original.
348 struct command_context *copy_command_context(struct command_context *cmd_ctx);
350 * Frees the resources associated with a command context. The commands
351 * are not removed, so unregister_all_commands() must be called first.
352 * @param context The command_context that will be destroyed.
354 void command_done(struct command_context *context);
356 void command_print(struct command_invocation *cmd, const char *format, ...)
357 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
358 void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
359 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
360 int command_run_line(struct command_context *context, char *line);
361 int command_run_linef(struct command_context *context, const char *format, ...)
362 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
363 void command_output_text(struct command_context *context, const char *data);
365 void process_jim_events(struct command_context *cmd_ctx);
367 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
368 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
369 #define ERROR_COMMAND_NOTFOUND (-602)
370 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
371 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
372 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
374 int parse_ulong(const char *str, unsigned long *ul);
375 int parse_ullong(const char *str, unsigned long long *ul);
377 int parse_long(const char *str, long *ul);
378 int parse_llong(const char *str, long long *ul);
380 #define DECLARE_PARSE_WRAPPER(name, type) \
381 int parse ## name(const char *str, type * ul)
383 DECLARE_PARSE_WRAPPER(_uint, unsigned);
384 DECLARE_PARSE_WRAPPER(_u64, uint64_t);
385 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
386 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
387 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
389 DECLARE_PARSE_WRAPPER(_int, int);
390 DECLARE_PARSE_WRAPPER(_s64, int64_t);
391 DECLARE_PARSE_WRAPPER(_s32, int32_t);
392 DECLARE_PARSE_WRAPPER(_s16, int16_t);
393 DECLARE_PARSE_WRAPPER(_s8, int8_t);
395 DECLARE_PARSE_WRAPPER(_target_addr, target_addr_t);
398 * @brief parses the string @a in into @a out as a @a type, or prints
399 * a command error and passes the error code to the caller. If an error
400 * does occur, the calling function will return the error code produced
401 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
403 * This function may cause the calling function to return immediately,
404 * so it should be used carefully to avoid leaking resources. In most
405 * situations, parsing should be completed in full before proceding
406 * to allocate resources, and this strategy will most prevents leaks.
408 #define COMMAND_PARSE_NUMBER(type, in, out) \
410 int retval_macro_tmp = parse_ ## type(in, &(out)); \
411 if (ERROR_OK != retval_macro_tmp) { \
412 command_print(CMD, stringify(out) \
413 " option value ('%s') is not valid", in); \
414 return retval_macro_tmp; \
418 #define COMMAND_PARSE_ADDRESS(in, out) \
419 COMMAND_PARSE_NUMBER(target_addr, in, out)
422 * Parse the string @c as a binary parameter, storing the boolean value
423 * in @c out. The strings @c on and @c off are used to match different
424 * strings for true and false options (e.g. "on" and "off" or
425 * "enable" and "disable").
427 #define COMMAND_PARSE_BOOL(in, out, on, off) \
430 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
431 if (ERROR_OK != retval_macro_tmp) { \
432 command_print(CMD, stringify(out) \
433 " option value ('%s') is not valid", in); \
434 command_print(CMD, " choices are '%s' or '%s'", \
436 return retval_macro_tmp; \
441 int command_parse_bool_arg(const char *in, bool *out);
442 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
444 /** parses an on/off command argument */
445 #define COMMAND_PARSE_ON_OFF(in, out) \
446 COMMAND_PARSE_BOOL(in, out, "on", "off")
447 /** parses an enable/disable command argument */
448 #define COMMAND_PARSE_ENABLE(in, out) \
449 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
451 void script_debug(Jim_Interp *interp, const char *cmd,
452 unsigned argc, Jim_Obj * const *argv);
454 #endif /* OPENOCD_HELPER_COMMAND_H */