halting srst_pulls_trst targets is now snappier and has explicit warning.

[fw/openocd] / src / helper / command.h

diff --git a/src/helper/command.h b/src/helper/command.h
index 262786a82ac52d6cdac464edf7860e7c9990087e..d784af76e8ed60803b94e6e84fe6ee5e5751e6e8 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                      *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
@@ -34,8 +37,21 @@ typedef struct command_context_s
        enum command_mode mode;
        struct command_s *commands;
        int current_target;
-       int echo;
-       int (*output_handler)(struct command_context_s *context, char* line);
+       /* Execute a command.
+        * 
+        * If the command fails, it *MUST* return a value != ERROR_OK
+        * (many commands break this rule, patches welcome!)
+        * 
+        * This is *especially* important for commands such as writing
+        * to flash or verifying memory. The reason is that those commands
+        * can be used by programs to determine if the operation succeded
+        * or not. If the operation failed, then a program can try
+        * an alternative approach.
+        * 
+        * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
+        * printing out the syntax of the command.
+        */
+       int (*output_handler)(struct command_context_s *context, const char* line);
        void *output_handler_priv;
 } command_context_t;
 
@@ -46,22 +62,41 @@ typedef struct command_s
        struct command_s *children;
        int (*handler)(struct command_context_s *context, char* name, char** args, int argc);
        enum command_mode mode;
-       char *help;
-       int unique_len;
        struct command_s *next;
 } command_t;
 
 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);
 extern int unregister_command(command_context_t *context, char *name);
-extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, char* line), void *priv);
+extern int unregister_all_commands(command_context_t *context);
+extern void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv);
 extern command_context_t* copy_command_context(command_context_t* context);
+extern int command_context_mode(command_context_t *context, enum command_mode mode);
 extern command_context_t* command_init();
 extern int command_done(command_context_t *context);
 extern void command_print(command_context_t *context, char *format, ...);
+extern void command_print_sameline(command_context_t *context, char *format, ...);
 extern int command_run_line(command_context_t *context, char *line);
-extern int command_run_file(command_context_t *context, FILE *file, enum command_mode mode);
-
+extern int command_run_linef(command_context_t *context, char *format, ...);
+extern void command_output_text(command_context_t *context, const char *data);
 
 #define                ERROR_COMMAND_CLOSE_CONNECTION          (-600)
+#define                ERROR_COMMAND_SYNTAX_ERROR                      (-601)
+#define                ERROR_COMMAND_NOTFOUND                          (-602)
+
+extern int fast_and_dangerous;
+
+/* Integrate the JIM TCL interpretor into the command processing. */
+#include <stdarg.h>
+#if BUILD_ECOSBOARD
+/* Jim is provied by eCos */
+#include <cyg/jimtcl/jim.h>
+#else
+#define JIM_EMBEDDED
+#include "jim.h"
+#endif
+
+extern Jim_Interp *interp;
+
+void register_jim(command_context_t *context, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help);
 
 #endif /* COMMAND_H */