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, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
28 /* Integrate the JIM TCL interpretor into the command processing. */
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
44 #define PRINTF_ATTRIBUTE_FORMAT printf
54 struct command_context
;
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t
)(struct command_context
*context
,
60 struct command_context
62 enum command_mode mode
;
63 struct command
*commands
;
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
;
85 * Command handlers may be defined with more parameters than the base
86 * set provided by command.c. This macro uses C99 magic to allow
87 * defining all such derivative types using this macro.
89 #define __COMMAND_HANDLER(name, extra...) \
90 int name(struct command_invocation *cmd, ##extra)
93 * Use this to macro to call a command helper (or a nested handler).
94 * It provides command handler authors protection against reordering or
95 * removal of unused parameters.
97 * @b Note: This macro uses lexical capture to provide some arguments.
98 * As a result, this macro should be used @b only within functions
99 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
100 * macros provide the expected lexical context captured by this macro.
101 * Furthermore, it should be used only from the top-level of handler or
102 * helper function, or care must be taken to avoid redefining the same
103 * variables in intervening scope(s) by accident.
105 #define CALL_COMMAND_HANDLER(name, extra...) \
109 * Always use this macro to define new command handler functions.
110 * It ensures the parameters are ordered, typed, and named properly, so
111 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
112 * All command handler functions must be defined as static in scope.
114 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
117 * Similar to COMMAND_HANDLER, except some parameters are expected.
118 * A helper is globally-scoped because it may be shared between several
119 * source files (e.g. the s3c24xx device command helper).
121 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
124 * Use this macro to access the context of the command being handled,
125 * rather than accessing the variable directly. It may be moved.
127 #define CMD_CTX cmd->ctx
129 * Use this macro to access the number of arguments for the command being
130 * handled, rather than accessing the variable directly. It may be moved.
132 #define CMD_ARGC cmd->argc
134 * Use this macro to access the arguments for the command being handled,
135 * rather than accessing the variable directly. It may be moved.
137 #define CMD_ARGV cmd->argv
139 * Use this macro to access the name of the command being handled,
140 * rather than accessing the variable directly. It may be moved.
142 #define CMD_NAME cmd->name
144 * Use this macro to access the current command being handled,
145 * rather than accessing the variable directly. It may be moved.
147 #define CMD_CURRENT cmd->current
149 * Use this macro to access the invoked command handler's data pointer,
150 * rather than accessing the variable directly. It may be moved.
152 #define CMD_DATA CMD_CURRENT->jim_handler_data
156 * The type signature for command handling functions. They are
157 * usually registered as part of command_registration, providing
158 * a high-level means for executing a command.
160 * If the command fails, it *MUST* return a value != ERROR_OK
161 * (many commands break this rule, patches welcome!)
163 * This is *especially* important for commands such as writing
164 * to flash or verifying memory. The reason is that those commands
165 * can be used by programs to determine if the operation succeded
166 * or not. If the operation failed, then a program can try
167 * an alternative approach.
169 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
170 * printing out the syntax of the command.
172 typedef __COMMAND_HANDLER((*command_handler_t
));
179 struct command
*parent
;
180 struct command
*children
;
181 command_handler_t handler
;
182 Jim_CmdProc jim_handler
;
183 void *jim_handler_data
;
184 enum command_mode mode
;
185 struct command
*next
;
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
196 char *command_name(struct command
*c
, char delim
);
199 * Commands should be registered by filling in one or more of these
200 * structures and passing them to register_command().
202 * A conventioal format should be used for help strings, to provide both
203 * usage and basic information:
205 * "@<options@> ... - some explanation text"
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.
215 struct command_registration
{
217 command_handler_t handler
;
218 Jim_CmdProc jim_handler
;
219 void *jim_handler_data
;
220 enum command_mode mode
;
222 /// a string listing the options and arguments, required or optional
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
231 const struct command_registration
*chain
;
234 /// Use this as the last entry in an array of command_registration records.
235 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
238 * Register a command @c handler that can be called from scripts during
239 * the execution @c mode specified.
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
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.
252 struct command
* register_command(struct command_context
*cmd_ctx
,
253 struct command
*parent
, const struct command_registration
*rec
);
255 #define COMMAND_REGISTER(_cmd_ctx, _parent, _name, _handler, _mode, _help) \
257 struct command_registration cr = { \
259 .handler = _handler, \
263 register_command(_cmd_ctx, _parent, &cr); \
267 * Register one or more commands in the specified context, as children
268 * of @c parent (or top-level commends, if NULL). In a registration's
269 * record contains a non-NULL @c chain member and name is NULL, the
270 * commands on the chain will be registered in the same context.
271 * Otherwise, the chained commands are added as children of the command.
273 * @param cmd_ctx The command_context in which to register the command.
274 * @param parent Register this command as a child of this, or NULL to
275 * register a top-level command.
276 * @param cmds Pointer to an array of command_registration records that
277 * contains the desired command parameters. The last record must have
278 * NULL for all fields.
279 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
281 int register_commands(struct command_context
*cmd_ctx
, struct command
*parent
,
282 const struct command_registration
*cmds
);
286 * Unregisters command @c name from the given context, @c cmd_ctx.
287 * @param cmd_ctx The context of the registered command.
288 * @param parent The parent of the given command, or NULL.
289 * @param name The name of the command to unregister.
290 * @returns ERROR_OK on success, or an error code.
292 int unregister_command(struct command_context
*cmd_ctx
,
293 struct command
*parent
, const char *name
);
295 * Unregisters all commands from the specfied context.
296 * @param cmd_ctx The context that will be cleared of registered commands.
297 * @param parent If given, only clear commands from under this one command.
298 * @returns ERROR_OK on success, or an error code.
300 int unregister_all_commands(struct command_context
*cmd_ctx
,
301 struct command
*parent
);
303 struct command
*command_find_in_context(struct command_context
*cmd_ctx
,
305 struct command
*command_find_in_parent(struct command
*parent
,
309 * Update the private command data field for a command and all descendents.
310 * This is used when creating a new heirarchy of commands that depends
311 * on obtaining a dynamically created context. The value will be available
312 * in command handlers by using the CMD_DATA macro.
313 * @param c The command (group) whose data pointer(s) will be updated.
314 * @param p The new data pointer to use for the command or its descendents.
316 void command_set_handler_data(struct command
*c
, void *p
);
318 void command_set_output_handler(struct command_context
* context
,
319 command_output_handler_t output_handler
, void *priv
);
322 int command_context_mode(struct command_context
*context
, enum command_mode mode
);
325 * Creates a new command context using the startup TCL provided.
327 struct command_context
* command_init(const char *startup_tcl
);
329 * Creates a copy of an existing command context. This does not create
330 * a deep copy of the command list, so modifications in one context will
331 * affect all shared contexts. The caller must track reference counting
332 * and ensure the commands are freed before destroying the last instance.
333 * @param cmd_ctx The command_context that will be copied.
334 * @returns A new command_context with the same state as the original.
336 struct command_context
* copy_command_context(struct command_context
* cmd_ctx
);
338 * Frees the resources associated with a command context. The commands
339 * are not removed, so unregister_all_commands() must be called first.
340 * @param cmd_ctx The command_context that will be destroyed.
342 void command_done(struct command_context
*context
);
344 void command_print(struct command_context
*context
, const char *format
, ...)
345 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
346 void command_print_sameline(struct command_context
*context
, const char *format
, ...)
347 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
348 int command_run_line(struct command_context
*context
, char *line
);
349 int command_run_linef(struct command_context
*context
, const char *format
, ...)
350 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
351 void command_output_text(struct command_context
*context
, const char *data
);
353 void process_jim_events(void);
355 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
356 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
357 #define ERROR_COMMAND_NOTFOUND (-602)
358 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
359 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
360 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
362 extern Jim_Interp
*interp
;
364 int parse_ulong(const char *str
, unsigned long *ul
);
365 int parse_ullong(const char *str
, unsigned long long *ul
);
367 int parse_long(const char *str
, long *ul
);
368 int parse_llong(const char *str
, long long *ul
);
370 #define DECLARE_PARSE_WRAPPER(name, type) \
371 int parse##name(const char *str, type *ul)
373 DECLARE_PARSE_WRAPPER(_uint
, unsigned);
374 DECLARE_PARSE_WRAPPER(_u32
, uint32_t);
375 DECLARE_PARSE_WRAPPER(_u16
, uint16_t);
376 DECLARE_PARSE_WRAPPER(_u8
, uint8_t);
378 DECLARE_PARSE_WRAPPER(_int
, int);
379 DECLARE_PARSE_WRAPPER(_s32
, int32_t);
380 DECLARE_PARSE_WRAPPER(_s16
, int16_t);
381 DECLARE_PARSE_WRAPPER(_s8
, int8_t);
384 * @brief parses the string @a in into @a out as a @a type, or prints
385 * a command error and passes the error code to the caller. If an error
386 * does occur, the calling function will return the error code produced
387 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
389 * This function may cause the calling function to return immediately,
390 * so it should be used carefully to avoid leaking resources. In most
391 * situations, parsing should be completed in full before proceding
392 * to allocate resources, and this strategy will most prevents leaks.
394 #define COMMAND_PARSE_NUMBER(type, in, out) \
396 int retval = parse_##type(in, &(out)); \
397 if (ERROR_OK != retval) { \
398 command_print(CMD_CTX, stringify(out) \
399 " option value ('%s') is not valid", in); \
405 * Parse the string @c as a binary parameter, storing the boolean value
406 * in @c out. The strings @c on and @c off are used to match different
407 * strings for true and false options (e.g. "on" and "off" or
408 * "enable" and "disable").
410 #define COMMAND_PARSE_BOOL(in, out, on, off) \
413 int retval = command_parse_bool_arg(in, &value); \
414 if (ERROR_OK != retval) { \
415 command_print(CMD_CTX, stringify(out) \
416 " option value ('%s') is not valid", in); \
417 command_print(CMD_CTX, " choices are '%s' or '%s'", \
424 int command_parse_bool_arg(const char *in
, bool *out
);
425 COMMAND_HELPER(handle_command_parse_bool
, bool *out
, const char *label
);
427 /// parses an on/off command argument
428 #define COMMAND_PARSE_ON_OFF(in, out) \
429 COMMAND_PARSE_BOOL(in, out, "on", "off")
430 /// parses an enable/disable command argument
431 #define COMMAND_PARSE_ENABLE(in, out) \
432 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
434 void script_debug(Jim_Interp
*interp
, const char *cmd
,
435 unsigned argc
, Jim_Obj
*const *argv
);
437 #endif /* 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)