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