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