c574efd507e2f03511e4b84e1c46f4cc5a4a604f
[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 */
39 /* be used for __attribute__((format( ... ))) */
40 #ifdef IS_MINGW
41 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
42 #else
43 #define PRINTF_ATTRIBUTE_FORMAT printf
44 #endif
45
46 enum command_mode
47 {
48 COMMAND_EXEC,
49 COMMAND_CONFIG,
50 COMMAND_ANY,
51 };
52
53 typedef struct command_context_s
54 {
55 enum command_mode mode;
56 struct command_s *commands;
57 int current_target;
58 /* Execute a command.
59 *
60 * If the command fails, it *MUST* return a value != ERROR_OK
61 * (many commands break this rule, patches welcome!)
62 *
63 * This is *especially* important for commands such as writing
64 * to flash or verifying memory. The reason is that those commands
65 * can be used by programs to determine if the operation succeded
66 * or not. If the operation failed, then a program can try
67 * an alternative approach.
68 *
69 * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
70 * printing out the syntax of the command.
71 */
72 int (*output_handler)(struct command_context_s *context, const char* line);
73 void *output_handler_priv;
74 } command_context_t;
75
76 typedef struct command_s
77 {
78 char *name;
79 struct command_s *parent;
80 struct command_s *children;
81 int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
82 enum command_mode mode;
83 struct command_s *next;
84 } command_t;
85
86 extern command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help);
87 extern int unregister_command(command_context_t *context, char *name);
88 extern int unregister_all_commands(command_context_t *context);
89 extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
90 extern command_context_t* copy_command_context(command_context_t* context);
91 extern int command_context_mode(command_context_t *context, enum command_mode mode);
92 extern command_context_t* command_init(void);
93 extern int command_done(command_context_t *context);
94
95 extern void command_print(command_context_t *context, const char *format, ...)
96 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
97 extern void command_print_sameline(command_context_t *context, const char *format, ...)
98 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
99 extern int command_run_line(command_context_t *context, char *line);
100 extern int command_run_linef(command_context_t *context, const char *format, ...)
101 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
102 extern void command_output_text(command_context_t *context, const char *data);
103
104 extern void process_jim_events(void);
105
106 #define ERROR_COMMAND_CLOSE_CONNECTION (-600)
107 #define ERROR_COMMAND_SYNTAX_ERROR (-601)
108 #define ERROR_COMMAND_NOTFOUND (-602)
109 #define ERROR_COMMAND_ARGUMENT_INVALID (-603)
110 #define ERROR_COMMAND_ARGUMENT_OVERFLOW (-604)
111 #define ERROR_COMMAND_ARGUMENT_UNDERFLOW (-605)
112
113 extern int fast_and_dangerous;
114
115 extern Jim_Interp *interp;
116
117 void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
118
119 long jim_global_long(const char *variable);
120
121 int parse_ulong(const char *str, unsigned long *ul);
122 int parse_ullong(const char *str, unsigned long long *ul);
123
124 int parse_long(const char *str, long *ul);
125 int parse_llong(const char *str, long long *ul);
126
127 #define DECLARE_PARSE_WRAPPER(name, type) \
128 int parse##name(const char *str, type *ul)
129
130 DECLARE_PARSE_WRAPPER(_uint, unsigned);
131 DECLARE_PARSE_WRAPPER(_u32, uint32_t);
132 DECLARE_PARSE_WRAPPER(_u16, uint16_t);
133 DECLARE_PARSE_WRAPPER(_u8, uint8_t);
134
135 DECLARE_PARSE_WRAPPER(_int, int);
136 DECLARE_PARSE_WRAPPER(_s32, int32_t);
137 DECLARE_PARSE_WRAPPER(_s16, int16_t);
138 DECLARE_PARSE_WRAPPER(_s8, int8_t);
139
140 void script_debug(Jim_Interp *interp, const char *cmd, int argc, Jim_Obj *const *argv);
141
142 #endif /* COMMAND_H */