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_s
;
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t
)(struct command_context_s
*context
,
60 typedef struct command_context_s
62 enum command_mode mode
;
63 struct command_s
*commands
;
67 * If the command fails, it *MUST* return a value != ERROR_OK
68 * (many commands break this rule, patches welcome!)
70 * This is *especially* important for commands such as writing
71 * to flash or verifying memory. The reason is that those commands
72 * can be used by programs to determine if the operation succeded
73 * or not. If the operation failed, then a program can try
74 * an alternative approach.
76 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
77 * printing out the syntax of the command.
79 command_output_handler_t output_handler
;
80 void *output_handler_priv
;
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_context_s *cmd_ctx, \
91 char *cmd, char **args, int argc, ##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...) \
107 name(cmd_ctx, cmd, args, argc, ##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) static __COMMAND_HANDLER(name)
118 * Similar to COMMAND_HANDLER, except some parameters are expected.
119 * A helper is globally-scoped because it may be shared between several
120 * source files (e.g. the s3c24xx device command helper).
122 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
125 typedef struct command_s
128 struct command_s
*parent
;
129 struct command_s
*children
;
130 int (*handler
)(struct command_context_s
*context
, char* name
, char** args
, int argc
);
131 enum command_mode mode
;
132 struct command_s
*next
;
136 * @param c The command to be named.
137 * @param delim The character to place between command names.
138 * @returns A malloc'd string containing the full command name,
139 * which may include one or more ancestor components. Multiple names
140 * are separated by single spaces. The caller must free() the string
143 char *command_name(struct command_s
*c
, char delim
);
145 command_t
* register_command(command_context_t
*context
,
146 command_t
*parent
, char *name
,
147 int (*handler
)(struct command_context_s
*context
,
148 char* name
, char** args
, int argc
),
149 enum command_mode mode
, char *help
);
151 int unregister_command(command_context_t
*context
, char *name
);
152 int unregister_all_commands(command_context_t
*context
);
154 void command_set_output_handler(command_context_t
* context
,
155 command_output_handler_t output_handler
, void *priv
);
157 command_context_t
* copy_command_context(command_context_t
* context
);
159 int command_context_mode(command_context_t
*context
, enum command_mode mode
);
161 command_context_t
* command_init(void);
162 int command_done(command_context_t
*context
);
164 void command_print(command_context_t
*context
, const char *format
, ...)
165 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
166 void command_print_sameline(command_context_t
*context
, const char *format
, ...)
167 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
168 int command_run_line(command_context_t
*context
, char *line
);
169 int command_run_linef(command_context_t
*context
, const char *format
, ...)
170 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
171 void command_output_text(command_context_t
*context
, const char *data
);
173 void process_jim_events(void);
175 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
176 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
177 #define ERROR_COMMAND_NOTFOUND (-602)
178 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
179 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
180 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
182 extern int fast_and_dangerous
;
184 extern Jim_Interp
*interp
;
186 void register_jim(command_context_t
*context
, const char *name
, int (*cmd
)(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
), const char *help
);
188 long jim_global_long(const char *variable
);
190 int parse_ulong(const char *str
, unsigned long *ul
);
191 int parse_ullong(const char *str
, unsigned long long *ul
);
193 int parse_long(const char *str
, long *ul
);
194 int parse_llong(const char *str
, long long *ul
);
196 #define DECLARE_PARSE_WRAPPER(name, type) \
197 int parse##name(const char *str, type *ul)
199 DECLARE_PARSE_WRAPPER(_uint
, unsigned);
200 DECLARE_PARSE_WRAPPER(_u32
, uint32_t);
201 DECLARE_PARSE_WRAPPER(_u16
, uint16_t);
202 DECLARE_PARSE_WRAPPER(_u8
, uint8_t);
204 DECLARE_PARSE_WRAPPER(_int
, int);
205 DECLARE_PARSE_WRAPPER(_s32
, int32_t);
206 DECLARE_PARSE_WRAPPER(_s16
, int16_t);
207 DECLARE_PARSE_WRAPPER(_s8
, int8_t);
210 * @brief parses the string @a in into @a out as a @a type, or prints
211 * a command error and passes the error code to the caller. If an error
212 * does occur, the calling function will return the error code produced
213 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
215 * This function may cause the calling function to return immediately,
216 * so it should be used carefully to avoid leaking resources. In most
217 * situations, parsing should be completed in full before proceding
218 * to allocate resources, and this strategy will most prevents leaks.
220 #define COMMAND_PARSE_NUMBER(type, in, out) \
222 int retval = parse_##type(in, &(out)); \
223 if (ERROR_OK != retval) { \
224 command_print(cmd_ctx, stringify(out) \
225 " option value ('%s') is not valid", in); \
230 void script_debug(Jim_Interp
*interp
, const char *cmd
,
231 unsigned argc
, Jim_Obj
*const *argv
);
233 #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)