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;
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;
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.
88 struct command_invocation {
89 struct command_context *ctx;
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.
100 #define __COMMAND_HANDLER(name, extra...) \
101 int name(struct command_invocation *cmd, ##extra)
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.
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.
116 #define CALL_COMMAND_HANDLER(name, extra...) \
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.
125 #define COMMAND_HANDLER(name) static __COMMAND_HANDLER(name)
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).
132 #define COMMAND_HELPER(name, extra...) __COMMAND_HANDLER(name, extra)
135 * Use this macro to access the context of the command being handled,
136 * rather than accessing the variable directly. It may be moved.
138 #define CMD_CTX cmd->ctx
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.
143 #define CMD_ARGC cmd->argc
145 * Use this macro to access the arguments for the command being handled,
146 * rather than accessing the variable directly. It may be moved.
148 #define CMD_ARGV cmd->argv
150 * Use this macro to access the name of the command being handled,
151 * rather than accessing the variable directly. It may be moved.
153 #define CMD_NAME cmd->name
156 /// The type signature for commands' handler functions.
157 typedef __COMMAND_HANDLER((*command_handler_t));
164 struct command *parent;
165 struct command *children;
166 command_handler_t handler;
167 enum command_mode mode;
168 struct command *next;
172 * @param c The command to be named.
173 * @param delim The character to place between command names.
174 * @returns A malloc'd string containing the full command name,
175 * which may include one or more ancestor components. Multiple names
176 * are separated by single spaces. The caller must free() the string
179 char *command_name(struct command *c, char delim);
182 * Commands should be registered by filling in one or more of these
183 * structures and passing them to register_command().
185 * A conventioal format should be used for help strings, to provide both
186 * usage and basic information:
188 * "@<options@> ... - some explanation text"
191 * @param name The name of the command to register, which must not have
192 * been registered previously in the intended context.
193 * @param handler The callback function that will be called. If NULL,
194 * then the command serves as a placeholder for its children or a script.
195 * @param mode The command mode(s) in which this command may be run.
196 * @param help The help text that will be displayed to the user.
198 struct command_registration {
200 command_handler_t handler;
201 enum command_mode mode;
203 /// a string listing the options and arguments, required or optional
207 * If non-NULL, the commands in @c chain will be registered in
208 * the same context and scope of this registration record.
209 * This allows modules to inherit lists commands from other
212 const struct command_registration *chain;
215 /// Use this as the last entry in an array of command_registration records.
216 #define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
219 * Register a command @c handler that can be called from scripts during
220 * the execution @c mode specified.
222 * If @c parent is non-NULL, the new command will be registered as a
223 * sub-command under it; otherwise, it will be available as a top-level
226 * @param cmd_ctx The command_context in which to register the command.
227 * @param parent Register this command as a child of this, or NULL to
228 * register a top-level command.
229 * @param rec A command_registration record that contains the desired
230 * command parameters.
231 * @returns The new command, if successful; otherwise, NULL.
233 struct command* register_command(struct command_context *cmd_ctx,
234 struct command *parent, const struct command_registration *rec);
236 #define COMMAND_REGISTER(_cmd_ctx, _parent, _name, _handler, _mode, _help) \
238 struct command_registration cr = { \
240 .handler = _handler, \
244 register_command(_cmd_ctx, _parent, &cr); \
248 * Register one or more commands in the specified context, as children
249 * of @c parent (or top-level commends, if NULL). In a registration's
250 * record contains a non-NULL @c chain member and name is NULL, the
251 * commands on the chain will be registered in the same context.
252 * Otherwise, the chained commands are added as children of the command.
254 * @param cmd_ctx The command_context in which to register the command.
255 * @param parent Register this command as a child of this, or NULL to
256 * register a top-level command.
257 * @param cmds Pointer to an array of command_registration records that
258 * contains the desired command parameters. The last record must have
259 * NULL for all fields.
260 * @returns ERROR_OK on success; ERROR_FAIL if any registration fails.
262 int register_commands(struct command_context *cmd_ctx, struct command *parent,
263 const struct command_registration *cmds);
267 * Unregisters command @c name from the given context, @c cmd_ctx.
268 * @param cmd_ctx The context of the registered command.
269 * @param parent The parent of the given command, or NULL.
270 * @param name The name of the command to unregister.
271 * @returns ERROR_OK on success, or an error code.
273 int unregister_command(struct command_context *cmd_ctx,
274 struct command *parent, const char *name);
276 * Unregisters all commands from the specfied context.
277 * @param cmd_ctx The context that will be cleared of registered commands.
278 * @param parent If given, only clear commands from under this one command.
279 * @returns ERROR_OK on success, or an error code.
281 int unregister_all_commands(struct command_context *cmd_ctx,
282 struct command *parent);
284 void command_set_output_handler(struct command_context* context,
285 command_output_handler_t output_handler, void *priv);
287 struct command_context* copy_command_context(struct command_context* context);
289 int command_context_mode(struct command_context *context, enum command_mode mode);
292 * Creates a new command context using the startup TCL provided.
294 struct command_context* command_init(const char *startup_tcl);
295 int command_done(struct command_context *context);
297 void command_print(struct command_context *context, const char *format, ...)
298 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
299 void command_print_sameline(struct command_context *context, const char *format, ...)
300 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
301 int command_run_line(struct command_context *context, char *line);
302 int command_run_linef(struct command_context *context, const char *format, ...)
303 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
304 void command_output_text(struct command_context *context, const char *data);
306 void process_jim_events(void);
308 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
309 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
310 #define ERROR_COMMAND_NOTFOUND (-602)
311 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
312 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
313 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
315 extern Jim_Interp *interp;
317 void register_jim(struct command_context *context, const char *name,
318 Jim_CmdProc cmd, const char *help);
320 int parse_ulong(const char *str, unsigned long *ul);
321 int parse_ullong(const char *str, unsigned long long *ul);
323 int parse_long(const char *str, long *ul);
324 int parse_llong(const char *str, long long *ul);
326 #define DECLARE_PARSE_WRAPPER(name, type) \
327 int parse##name(const char *str, type *ul)
329 DECLARE_PARSE_WRAPPER(_uint, unsigned);
330 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
331 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
332 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
334 DECLARE_PARSE_WRAPPER(_int, int);
335 DECLARE_PARSE_WRAPPER(_s32, int32_t);
336 DECLARE_PARSE_WRAPPER(_s16, int16_t);
337 DECLARE_PARSE_WRAPPER(_s8, int8_t);
340 * @brief parses the string @a in into @a out as a @a type, or prints
341 * a command error and passes the error code to the caller. If an error
342 * does occur, the calling function will return the error code produced
343 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
345 * This function may cause the calling function to return immediately,
346 * so it should be used carefully to avoid leaking resources. In most
347 * situations, parsing should be completed in full before proceding
348 * to allocate resources, and this strategy will most prevents leaks.
350 #define COMMAND_PARSE_NUMBER(type, in, out) \
352 int retval = parse_##type(in, &(out)); \
353 if (ERROR_OK != retval) { \
354 command_print(CMD_CTX, stringify(out) \
355 " option value ('%s') is not valid", in); \
361 * Parse the string @c as a binary parameter, storing the boolean value
362 * in @c out. The strings @c on and @c off are used to match different
363 * strings for true and false options (e.g. "on" and "off" or
364 * "enable" and "disable").
366 #define COMMAND_PARSE_BOOL(in, out, on, off) \
369 int retval = command_parse_bool_arg(in, &value); \
370 if (ERROR_OK != retval) { \
371 command_print(CMD_CTX, stringify(out) \
372 " option value ('%s') is not valid", in); \
373 command_print(CMD_CTX, " choices are '%s' or '%s'", \
380 int command_parse_bool_arg(const char *in, bool *out);
381 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
383 /// parses an on/off command argument
384 #define COMMAND_PARSE_ON_OFF(in, out) \
385 COMMAND_PARSE_BOOL(in, out, "on", "off")
386 /// parses an enable/disable command argument
387 #define COMMAND_PARSE_ENABLE(in, out) \
388 COMMAND_PARSE_BOOL(in, out, "enable", "disable")
390 void script_debug(Jim_Interp *interp, const char *cmd,
391 unsigned argc, Jim_Obj *const *argv);
393 #endif /* COMMAND_H */