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
27 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
28 * used for __attribute__((format( ... ))), with GCC v4.4 or later
30 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
31 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
33 #define PRINTF_ATTRIBUTE_FORMAT printf
42 struct command_context
;
44 /** The type signature for command context's output handler. */
45 typedef int (*command_output_handler_t
)(struct command_context
*context
,
48 struct command_context
{
50 enum command_mode mode
;
51 struct command
*commands
;
53 command_output_handler_t output_handler
;
54 void *output_handler_priv
;
60 * When run_command is called, a new instance will be created on the
61 * stack, filled with the proper values, and passed by reference to the
62 * required COMMAND_HANDLER routine.
64 struct command_invocation
{
65 struct command_context
*ctx
;
66 struct command
*current
;
73 * Command handlers may be defined with more parameters than the base
74 * set provided by command.c. This macro uses C99 magic to allow
75 * defining all such derivative types using this macro.
77 #define __COMMAND_HANDLER(name, extra ...) \
78 int name(struct command_invocation *cmd, ## extra)
81 * Use this to macro to call a command helper (or a nested handler).
82 * It provides command handler authors protection against reordering or
83 * removal of unused parameters.
85 * @b Note: This macro uses lexical capture to provide some arguments.
86 * As a result, this macro should be used @b only within functions
87 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
88 * macros provide the expected lexical context captured by this macro.
89 * Furthermore, it should be used only from the top-level of handler or
90 * helper function, or care must be taken to avoid redefining the same
91 * variables in intervening scope(s) by accident.
93 #define CALL_COMMAND_HANDLER(name, extra ...) \
97 * Always use this macro to define new command handler functions.
98 * It ensures the parameters are ordered, typed, and named properly, so
99 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
100 * All command handler functions must be defined as static in scope.
102 #define COMMAND_HANDLER(name) \
103 static __COMMAND_HANDLER(name)
106 * Similar to COMMAND_HANDLER, except some parameters are expected.
107 * A helper is globally-scoped because it may be shared between several
108 * source files (e.g. the s3c24xx device command helper).
110 #define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
113 * Use this macro to access the context of the command being handled,
114 * rather than accessing the variable directly. It may be moved.
116 #define CMD_CTX (cmd->ctx)
118 * Use this macro to access the number of arguments for the command being
119 * handled, rather than accessing the variable directly. It may be moved.
121 #define CMD_ARGC (cmd->argc)
123 * Use this macro to access the arguments for the command being handled,
124 * rather than accessing the variable directly. It may be moved.
126 #define CMD_ARGV (cmd->argv)
128 * Use this macro to access the name of the command being handled,
129 * rather than accessing the variable directly. It may be moved.
131 #define CMD_NAME (cmd->name)
133 * Use this macro to access the current command being handled,
134 * rather than accessing the variable directly. It may be moved.
136 #define CMD_CURRENT (cmd->current)
138 * Use this macro to access the invoked command handler's data pointer,
139 * rather than accessing the variable directly. It may be moved.
141 #define CMD_DATA (CMD_CURRENT->jim_handler_data)
144 * The type signature for command handling functions. They are
145 * usually registered as part of command_registration, providing
146 * a high-level means for executing a command.
148 * If the command fails, it *MUST* return a value != ERROR_OK
149 * (many commands break this rule, patches welcome!)
151 * This is *especially* important for commands such as writing
152 * to flash or verifying memory. The reason is that those commands
153 * can be used by programs to determine if the operation succeded
154 * or not. If the operation failed, then a program can try
155 * an alternative approach.
157 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
158 * printing out the syntax of the command.
160 typedef __COMMAND_HANDLER((*command_handler_t
));
166 struct command
*parent
;
167 struct command
*children
;
168 command_handler_t handler
;
169 Jim_CmdProc
*jim_handler
;
170 void *jim_handler_data
;
171 enum command_mode mode
;
172 struct command
*next
;
176 * @param c The command to be named.
177 * @param delim The character to place between command names.
178 * @returns A malloc'd string containing the full command name,
179 * which may include one or more ancestor components. Multiple names
180 * are separated by single spaces. The caller must free() the string
183 char *command_name(struct command
*c
, char delim
);
186 * Commands should be registered by filling in one or more of these
187 * structures and passing them to register_command().
189 * A conventioal format should be used for help strings, to provide both
190 * usage and basic information:
192 * "@<options@> ... - some explanation text"
195 * @param name The name of the command to register, which must not have
196 * been registered previously in the intended context.
197 * @param handler The callback function that will be called. If NULL,
198 * then the command serves as a placeholder for its children or a script.
199 * @param mode The command mode(s) in which this command may be run.
200 * @param help The help text that will be displayed to the user.
202 struct command_registration
{
204 command_handler_t handler
;
205 Jim_CmdProc
*jim_handler
;
206 void *jim_handler_data
;
207 enum command_mode mode
;
209 /** a string listing the options and arguments, required or optional */
213 * If non-NULL, the commands in @c chain will be registered in
214 * the same context and scope of this registration record.
215 * This allows modules to inherit lists commands from other
218 const struct command_registration
*chain
;
221 /** Use this as the last entry in an array of command_registration records. */
222 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
225 * Register a command @c handler that can be called from scripts during
226 * the execution @c mode specified.
228 * If @c parent is non-NULL, the new command will be registered as a
229 * sub-command under it; otherwise, it will be available as a top-level
232 * @param cmd_ctx The command_context in which to register the command.
233 * @param parent Register this command as a child of this, or NULL to
234 * register a top-level command.
235 * @param rec A command_registration record that contains the desired
236 * command parameters.
237 * @returns The new command, if successful; otherwise, NULL.
239 struct command
*register_command(struct command_context
*cmd_ctx
,
240 struct command
*parent
, const struct command_registration
*rec
);
243 * Register one or more commands in the specified context, as children
244 * of @c parent (or top-level commends, if NULL). In a registration's
245 * record contains a non-NULL @c chain member and name is NULL, the
246 * commands on the chain will be registered in the same context.
247 * Otherwise, the chained commands are added as children of the command.
249 * @param cmd_ctx The command_context in which to register the command.
250 * @param parent Register this command as a child of this, or NULL to
251 * register a top-level command.
252 * @param cmds Pointer to an array of command_registration records that
253 * contains the desired command parameters. The last record must have
254 * NULL for all fields.
255 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
257 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
258 const struct command_registration
*cmds
);
262 * Unregisters command @c name from the given context, @c cmd_ctx.
263 * @param cmd_ctx The context of the registered command.
264 * @param parent The parent of the given command, or NULL.
265 * @param name The name of the command to unregister.
266 * @returns ERROR_OK on success, or an error code.
268 int unregister_command(struct command_context
*cmd_ctx
,
269 struct command
*parent
, const char *name
);
271 * Unregisters all commands from the specfied context.
272 * @param cmd_ctx The context that will be cleared of registered commands.
273 * @param parent If given, only clear commands from under this one command.
274 * @returns ERROR_OK on success, or an error code.
276 int unregister_all_commands(struct command_context
*cmd_ctx
,
277 struct command
*parent
);
279 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
281 struct command
*command_find_in_parent(struct command
*parent
,
285 * Update the private command data field for a command and all descendents.
286 * This is used when creating a new heirarchy of commands that depends
287 * on obtaining a dynamically created context. The value will be available
288 * in command handlers by using the CMD_DATA macro.
289 * @param c The command (group) whose data pointer(s) will be updated.
290 * @param p The new data pointer to use for the command or its descendents.
292 void command_set_handler_data(struct command
*c
, void *p
);
294 void command_set_output_handler(struct command_context
*context
,
295 command_output_handler_t output_handler
, void *priv
);
298 int command_context_mode(struct command_context
*context
, enum command_mode mode
);
300 /* Return the current command context associated with the Jim interpreter or
301 * alternatively the global default command interpreter
303 struct command_context
*current_command_context(Jim_Interp
*interp
);
305 * Creates a new command context using the startup TCL provided and
306 * the existing Jim interpreter, if any. If interp == NULL, then command_init
307 * creates a command interpreter.
309 struct command_context
*command_init(const char *startup_tcl
, Jim_Interp
*interp
);
311 * Creates a copy of an existing command context. This does not create
312 * a deep copy of the command list, so modifications in one context will
313 * affect all shared contexts. The caller must track reference counting
314 * and ensure the commands are freed before destroying the last instance.
315 * @param cmd_ctx The command_context that will be copied.
316 * @returns A new command_context with the same state as the original.
318 struct command_context
*copy_command_context(struct command_context
*cmd_ctx
);
320 * Frees the resources associated with a command context. The commands
321 * are not removed, so unregister_all_commands() must be called first.
322 * @param context The command_context that will be destroyed.
324 void command_done(struct command_context
*context
);
326 void command_print(struct command_context
*context
, const char *format
, ...)
327 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
328 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
329 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
330 int command_run_line(struct command_context
*context
, char *line
);
331 int command_run_linef(struct command_context
*context
, const char *format
, ...)
332 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
333 void command_output_text(struct command_context
*context
, const char *data
);
335 void process_jim_events(struct command_context
*cmd_ctx
);
337 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
338 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
339 #define ERROR_COMMAND_NOTFOUND (-602)
340 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
341 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
342 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
344 int parse_ulong(const char *str
, unsigned long *ul
);
345 int parse_ullong(const char *str
, unsigned long long *ul
);
347 int parse_long(const char *str
, long *ul
);
348 int parse_llong(const char *str
, long long *ul
);
350 #define DECLARE_PARSE_WRAPPER(name, type) \
351 int parse ## name(const char *str, type * ul)
353 DECLARE_PARSE_WRAPPER(_uint
, unsigned);
354 DECLARE_PARSE_WRAPPER(_u64
, uint64_t);
355 DECLARE_PARSE_WRAPPER(_u32
, uint32_t);
356 DECLARE_PARSE_WRAPPER(_u16
, uint16_t);
357 DECLARE_PARSE_WRAPPER(_u8
, uint8_t);
359 DECLARE_PARSE_WRAPPER(_int
, int);
360 DECLARE_PARSE_WRAPPER(_s32
, int32_t);
361 DECLARE_PARSE_WRAPPER(_s16
, int16_t);
362 DECLARE_PARSE_WRAPPER(_s8
, int8_t);
365 * @brief parses the string @a in into @a out as a @a type, or prints
366 * a command error and passes the error code to the caller. If an error
367 * does occur, the calling function will return the error code produced
368 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
370 * This function may cause the calling function to return immediately,
371 * so it should be used carefully to avoid leaking resources. In most
372 * situations, parsing should be completed in full before proceding
373 * to allocate resources, and this strategy will most prevents leaks.
375 #define COMMAND_PARSE_NUMBER(type, in, out) \
377 int retval_macro_tmp = parse_ ## type(in, &(out)); \
378 if (ERROR_OK != retval_macro_tmp) { \
379 command_print(CMD_CTX, stringify(out) \
380 " option value ('%s') is not valid", in); \
381 return retval_macro_tmp; \
386 * Parse the string @c as a binary parameter, storing the boolean value
387 * in @c out. The strings @c on and @c off are used to match different
388 * strings for true and false options (e.g. "on" and "off" or
389 * "enable" and "disable").
391 #define COMMAND_PARSE_BOOL(in, out, on, off) \
394 int retval_macro_tmp = command_parse_bool_arg(in, &value); \
395 if (ERROR_OK != retval_macro_tmp) { \
396 command_print(CMD_CTX, stringify(out) \
397 " option value ('%s') is not valid", in); \
398 command_print(CMD_CTX, " choices are '%s' or '%s'", \
400 return retval_macro_tmp; \
405 int command_parse_bool_arg(const char *in
, bool *out
);
406 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
);
408 /** parses an on/off command argument */
409 #define COMMAND_PARSE_ON_OFF(in, out) \
410 COMMAND_PARSE_BOOL(in, out, "on", "off")
411 /** parses an enable/disable command argument */
412 #define COMMAND_PARSE_ENABLE(in, out) \
413 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
415 void script_debug(Jim_Interp
*interp
, const char *cmd
,
416 unsigned argc
, Jim_Obj
* const *argv
);
418 #endif /* OPENOCD_HELPER_COMMAND_H */
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)