def0935a737e7a734d22fe89015da8938b8a8ec8
[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, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifndef COMMAND_H
24 #define COMMAND_H
25
26 #include "types.h"
27
28 /* Integrate the JIM TCL interpretor into the command processing. */
29 #if BUILD_ECOSBOARD
30 #include <stdio.h>
31 #include <stdarg.h>
32 /* Jim is provied by eCos */
33 #include <cyg/jimtcl/jim.h>
34 #else
35 #include "jim.h"
36 #endif
37
38 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
39 * used for __attribute__((format( ... ))), with GCC v4.4 or later
40 */
41 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
42 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
43 #else
44 #define PRINTF_ATTRIBUTE_FORMAT printf
45 #endif
46
47 enum command_mode
48 {
49 COMMAND_EXEC,
50 COMMAND_CONFIG,
51 COMMAND_ANY,
52 };
53
54 struct command_context;
55
56 /// The type signature for command context's output handler.
57 typedef int (*command_output_handler_t)(struct command_context *context,
58 const char* line);
59
60 struct command_context
61 {
62 enum command_mode mode;
63 struct command *commands;
64 int current_target;
65 /* Execute a command.
66 *
67 * If the command fails, it *MUST* return a value != ERROR_OK
68 * (many commands break this rule, patches welcome!)
69 *
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.
75 *
76 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
77 * printing out the syntax of the command.
78 */
79 command_output_handler_t output_handler;
80 void *output_handler_priv;
81 };
82
83 /**
84 * When run_command is called, a new instance will be created on the
85 * stack, filled with the proper values, and passed by reference to the
86 * required COMMAND_HANDLER routine.
87 */
88 struct command_invocation {
89 struct command_context *ctx;
90 const char *name;
91 unsigned argc;
92 const char **argv;
93 };
94
95 /**
96 * Command handlers may be defined with more parameters than the base
97 * set provided by command.c. This macro uses C99 magic to allow
98 * defining all such derivative types using this macro.
99 */
100 #define __COMMAND_HANDLER(name, extra...) \
101 int name(struct command_invocation *cmd, ##extra)
102
103 /**
104 * Use this to macro to call a command helper (or a nested handler).
105 * It provides command handler authors protection against reordering or
106 * removal of unused parameters.
107 *
108 * @b Note: This macro uses lexical capture to provide some arguments.
109 * As a result, this macro should be used @b only within functions
110 * defined by the COMMAND_HANDLER or COMMAND_HELPER macros. Those
111 * macros provide the expected lexical context captured by this macro.
112 * Furthermore, it should be used only from the top-level of handler or
113 * helper function, or care must be taken to avoid redefining the same
114 * variables in intervening scope(s) by accident.
115 */
116 #define CALL_COMMAND_HANDLER(name, extra...) \
117 name(cmd, ##extra)
118
119 /**
120 * Always use this macro to define new command handler functions.
121 * It ensures the parameters are ordered, typed, and named properly, so
122 * they be can be used by other macros (e.g. COMMAND_PARSE_NUMBER).
123 * All command handler functions must be defined as static in scope.
124 */
125 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
126
127 /**
128 * Similar to COMMAND_HANDLER, except some parameters are expected.
129 * A helper is globally-scoped because it may be shared between several
130 * source files (e.g. the s3c24xx device command helper).
131 */
132 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
133
134 /**
135 * Use this macro to access the context of the command being handled,
136 * rather than accessing the variable directly. It may be moved.
137 */
138 #define CMD_CTX cmd->ctx
139 /**
140 * Use this macro to access the number of arguments for the command being
141 * handled, rather than accessing the variable directly. It may be moved.
142 */
143 #define CMD_ARGC cmd->argc
144 /**
145 * Use this macro to access the arguments for the command being handled,
146 * rather than accessing the variable directly. It may be moved.
147 */
148 #define CMD_ARGV cmd->argv
149 /**
150 * Use this macro to access the name of the command being handled,
151 * rather than accessing the variable directly. It may be moved.
152 */
153 #define CMD_NAME cmd->name
154
155
156 /// The type signature for commands' handler functions.
157 typedef __COMMAND_HANDLER((*command_handler_t));
158
159 struct command
160 {
161 char *name;
162 struct command *parent;
163 struct command *children;
164 command_handler_t handler;
165 enum command_mode mode;
166 struct command *next;
167 };
168
169 /**
170 * @param c The command to be named.
171 * @param delim The character to place between command names.
172 * @returns A malloc'd string containing the full command name,
173 * which may include one or more ancestor components. Multiple names
174 * are separated by single spaces. The caller must free() the string
175 * when done with it.
176 */
177 char *command_name(struct command *c, char delim);
178
179 struct command* register_command(struct command_context *context,
180 struct command *parent, char *name, command_handler_t handler,
181 enum command_mode mode, char *help);
182
183 int unregister_command(struct command_context *context, char *name);
184 int unregister_all_commands(struct command_context *context);
185
186 void command_set_output_handler(struct command_context* context,
187 command_output_handler_t output_handler, void *priv);
188
189 struct command_context* copy_command_context(struct command_context* context);
190
191 int command_context_mode(struct command_context *context, enum command_mode mode);
192
193 /**
194 * Creates a new command context using the startup TCL provided.
195 */
196 struct command_context* command_init(const char *startup_tcl);
197 int command_done(struct command_context *context);
198
199 void command_print(struct command_context *context, const char *format, ...)
200 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
201 void command_print_sameline(struct command_context *context, const char *format, ...)
202 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
203 int command_run_line(struct command_context *context, char *line);
204 int command_run_linef(struct command_context *context, const char *format, ...)
205 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
206 void command_output_text(struct command_context *context, const char *data);
207
208 void process_jim_events(void);
209
210 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
211 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
212 #define ERROR_COMMAND_NOTFOUND (-602)
213 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
214 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
215 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
216
217 extern Jim_Interp *interp;
218
219 void register_jim(struct command_context *context, const char *name,
220 Jim_CmdProc cmd, const char *help);
221
222 int parse_ulong(const char *str, unsigned long *ul);
223 int parse_ullong(const char *str, unsigned long long *ul);
224
225 int parse_long(const char *str, long *ul);
226 int parse_llong(const char *str, long long *ul);
227
228 #define DECLARE_PARSE_WRAPPER(name, type) \
229 int parse##name(const char *str, type *ul)
230
231 DECLARE_PARSE_WRAPPER(_uint, unsigned);
232 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
233 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
234 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
235
236 DECLARE_PARSE_WRAPPER(_int, int);
237 DECLARE_PARSE_WRAPPER(_s32, int32_t);
238 DECLARE_PARSE_WRAPPER(_s16, int16_t);
239 DECLARE_PARSE_WRAPPER(_s8, int8_t);
240
241 /**
242 * @brief parses the string @a in into @a out as a @a type, or prints
243 * a command error and passes the error code to the caller. If an error
244 * does occur, the calling function will return the error code produced
245 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
246 *
247 * This function may cause the calling function to return immediately,
248 * so it should be used carefully to avoid leaking resources. In most
249 * situations, parsing should be completed in full before proceding
250 * to allocate resources, and this strategy will most prevents leaks.
251 */
252 #define COMMAND_PARSE_NUMBER(type, in, out) \
253 do { \
254 int retval = parse_##type(in, &(out)); \
255 if (ERROR_OK != retval) { \
256 command_print(CMD_CTX, stringify(out) \
257 " option value ('%s') is not valid", in); \
258 return retval; \
259 } \
260 } while (0)
261
262 /**
263 * Parse the string @c as a binary parameter, storing the boolean value
264 * in @c out. The strings @c on and @c off are used to match different
265 * strings for true and false options (e.g. "on" and "off" or
266 * "enable" and "disable").
267 */
268 #define COMMAND_PARSE_BOOL(in, out, on, off) \
269 do { \
270 bool value; \
271 int retval = command_parse_bool_arg(in, &value); \
272 if (ERROR_OK != retval) { \
273 command_print(CMD_CTX, stringify(out) \
274 " option value ('%s') is not valid", in); \
275 command_print(CMD_CTX, " choices are '%s' or '%s'", \
276 on, off); \
277 return retval; \
278 } \
279 out = value; \
280 } while (0)
281
282 int command_parse_bool_arg(const char *in, bool *out);
283 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
284
285 /// parses an on/off command argument
286 #define COMMAND_PARSE_ON_OFF(in, out) \
287 COMMAND_PARSE_BOOL(in, out, "on", "off")
288 /// parses an enable/disable command argument
289 #define COMMAND_PARSE_ENABLE(in, out) \
290 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
291
292 void script_debug(Jim_Interp *interp, const char *cmd,
293 unsigned argc, Jim_Obj *const *argv);
294
295 #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)