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