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
;
83 typedef struct command_s
86 struct command_s
*parent
;
87 struct command_s
*children
;
88 int (*handler
)(struct command_context_s
*context
, char* name
, char** args
, int argc
);
89 enum command_mode mode
;
90 struct command_s
*next
;
94 * @param c The command to be named.
95 * @param delim The character to place between command names.
96 * @returns A malloc'd string containing the full command name,
97 * which may include one or more ancestor components. Multiple names
98 * are separated by single spaces. The caller must free() the string
101 char *command_name(struct command_s
*c
, char delim
);
103 command_t
* register_command(command_context_t
*context
,
104 command_t
*parent
, char *name
,
105 int (*handler
)(struct command_context_s
*context
,
106 char* name
, char** args
, int argc
),
107 enum command_mode mode
, char *help
);
109 int unregister_command(command_context_t
*context
, char *name
);
110 int unregister_all_commands(command_context_t
*context
);
112 void command_set_output_handler(command_context_t
* context
,
113 command_output_handler_t output_handler
, void *priv
);
115 command_context_t
* copy_command_context(command_context_t
* context
);
117 int command_context_mode(command_context_t
*context
, enum command_mode mode
);
119 command_context_t
* command_init(void);
120 int command_done(command_context_t
*context
);
122 void command_print(command_context_t
*context
, const char *format
, ...)
123 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
124 void command_print_sameline(command_context_t
*context
, const char *format
, ...)
125 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
126 int command_run_line(command_context_t
*context
, char *line
);
127 int command_run_linef(command_context_t
*context
, const char *format
, ...)
128 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT
, 2, 3)));
129 void command_output_text(command_context_t
*context
, const char *data
);
131 void process_jim_events(void);
133 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
134 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
135 #define ERROR_COMMAND_NOTFOUND (-602)
136 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
137 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
138 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
140 extern int fast_and_dangerous
;
142 extern Jim_Interp
*interp
;
144 void register_jim(command_context_t
*context
, const char *name
, int (*cmd
)(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
), const char *help
);
146 long jim_global_long(const char *variable
);
148 int parse_ulong(const char *str
, unsigned long *ul
);
149 int parse_ullong(const char *str
, unsigned long long *ul
);
151 int parse_long(const char *str
, long *ul
);
152 int parse_llong(const char *str
, long long *ul
);
154 #define DECLARE_PARSE_WRAPPER(name, type) \
155 int parse##name(const char *str, type *ul)
157 DECLARE_PARSE_WRAPPER(_uint
, unsigned);
158 DECLARE_PARSE_WRAPPER(_u32
, uint32_t);
159 DECLARE_PARSE_WRAPPER(_u16
, uint16_t);
160 DECLARE_PARSE_WRAPPER(_u8
, uint8_t);
162 DECLARE_PARSE_WRAPPER(_int
, int);
163 DECLARE_PARSE_WRAPPER(_s32
, int32_t);
164 DECLARE_PARSE_WRAPPER(_s16
, int16_t);
165 DECLARE_PARSE_WRAPPER(_s8
, int8_t);
168 * @brief parses the string @a in into @a out as a @a type, or prints
169 * a command error and passes the error code to the caller. If an error
170 * does occur, the calling function will return the error code produced
171 * by the parsing function (one of ERROR_COMMAND_ARGUMENT_*).
173 * This function may cause the calling function to return immediately,
174 * so it should be used carefully to avoid leaking resources. In most
175 * situations, parsing should be completed in full before proceding
176 * to allocate resources, and this strategy will most prevents leaks.
178 #define COMMAND_PARSE_NUMBER(type, in, out) \
180 int retval = parse_##type(in, &(out)); \
181 if (ERROR_OK != retval) { \
182 command_print(cmd_ctx, stringify(out) \
183 " option value ('%s') is not valid", in); \
188 void script_debug(Jim_Interp
*interp
, const char *cmd
,
189 unsigned argc
, Jim_Obj
*const *argv
);
191 #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)