X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Fcommand.h;h=f9c02e57383878392115268c83022f568cc2f4a5;hp=7c8c0121bf4e03b19b0208bc3fbe97af392a987a;hb=6c0590cb4d3e7701658279ee76d96e5c077fb256;hpb=8b00e56e6433cff3ff818835953b27765aaabab0
diff --git a/src/helper/command.h b/src/helper/command.h
index 7c8c0121bf..f9c02e5738 100644
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -16,25 +16,18 @@
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see . *
***************************************************************************/
-#ifndef COMMAND_H
-#define COMMAND_H
+#ifndef OPENOCD_HELPER_COMMAND_H
+#define OPENOCD_HELPER_COMMAND_H
-#include
-
-/* Integrate the JIM TCL interpretor into the command processing. */
-#if BUILD_ECOSBOARD
-#include
-#include
-#endif
-
-#include
+#include
+#include
#include
+#include
+
/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
* used for __attribute__((format( ... ))), with GCC v4.4 or later
*/
@@ -52,7 +45,7 @@ enum command_mode {
struct command_context;
-/* / The type signature for command context's output handler. */
+/** The type signature for command context's output handler. */
typedef int (*command_output_handler_t)(struct command_context *context,
const char *line);
@@ -60,7 +53,15 @@ struct command_context {
Jim_Interp *interp;
enum command_mode mode;
struct command *commands;
- int current_target;
+ struct target *current_target;
+ /* The target set by 'targets xx' command or the latest created */
+ struct target *current_target_override;
+ /* If set overrides current_target
+ * It happens during processing of
+ * 1) a target prefixed command
+ * 2) an event handler
+ * Pay attention to reentrancy when setting override.
+ */
command_output_handler_t output_handler;
void *output_handler_priv;
};
@@ -171,14 +172,19 @@ struct command_invocation {
typedef __COMMAND_HANDLER((*command_handler_t));
struct command {
- const char *name;
- const char *help;
- const char *usage;
+ char *name;
+ char *help;
+ char *usage;
struct command *parent;
struct command *children;
command_handler_t handler;
- Jim_CmdProc jim_handler;
+ Jim_CmdProc *jim_handler;
void *jim_handler_data;
+ /* Currently used only for target of target-prefixed cmd.
+ * Native OpenOCD commands use jim_handler_data exclusively
+ * as a target override.
+ * Jim handlers outside of target cmd tree can use
+ * jim_handler_data for any handler specific data */
enum command_mode mode;
struct command *next;
};
@@ -213,11 +219,11 @@ char *command_name(struct command *c, char delim);
struct command_registration {
const char *name;
command_handler_t handler;
- Jim_CmdProc jim_handler;
+ Jim_CmdProc *jim_handler;
void *jim_handler_data;
enum command_mode mode;
const char *help;
- /* / a string listing the options and arguments, required or optional */
+ /** a string listing the options and arguments, required or optional */
const char *usage;
/**
@@ -229,7 +235,7 @@ struct command_registration {
const struct command_registration *chain;
};
-/* / Use this as the last entry in an array of command_registration records. */
+/** Use this as the last entry in an array of command_registration records. */
#define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
/**
@@ -318,6 +324,14 @@ struct command_context *current_command_context(Jim_Interp *interp);
* creates a command interpreter.
*/
struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
+/**
+ * Shutdown a command context.
+ *
+ * Free the command context and the associated Jim interpreter.
+ *
+ * @param context The command_context that will be destroyed.
+ */
+void command_exit(struct command_context *context);
/**
* Creates a copy of an existing command context. This does not create
* a deep copy of the command list, so modifications in one context will
@@ -362,15 +376,19 @@ int parse_llong(const char *str, long long *ul);
int parse ## name(const char *str, type * ul)
DECLARE_PARSE_WRAPPER(_uint, unsigned);
+DECLARE_PARSE_WRAPPER(_u64, uint64_t);
DECLARE_PARSE_WRAPPER(_u32, uint32_t);
DECLARE_PARSE_WRAPPER(_u16, uint16_t);
DECLARE_PARSE_WRAPPER(_u8, uint8_t);
DECLARE_PARSE_WRAPPER(_int, int);
+DECLARE_PARSE_WRAPPER(_s64, int64_t);
DECLARE_PARSE_WRAPPER(_s32, int32_t);
DECLARE_PARSE_WRAPPER(_s16, int16_t);
DECLARE_PARSE_WRAPPER(_s8, int8_t);
+DECLARE_PARSE_WRAPPER(_target_addr, target_addr_t);
+
/**
* @brief parses the string @a in into @a out as a @a type, or prints
* a command error and passes the error code to the caller. If an error
@@ -392,6 +410,9 @@ DECLARE_PARSE_WRAPPER(_s8, int8_t);
} \
} while (0)
+#define COMMAND_PARSE_ADDRESS(in, out) \
+ COMMAND_PARSE_NUMBER(target_addr, in, out)
+
/**
* Parse the string @c as a binary parameter, storing the boolean value
* in @c out. The strings @c on and @c off are used to match different
@@ -415,14 +436,14 @@ DECLARE_PARSE_WRAPPER(_s8, int8_t);
int command_parse_bool_arg(const char *in, bool *out);
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
-/* / parses an on/off command argument */
+/** parses an on/off command argument */
#define COMMAND_PARSE_ON_OFF(in, out) \
COMMAND_PARSE_BOOL(in, out, "on", "off")
-/* / parses an enable/disable command argument */
+/** parses an enable/disable command argument */
#define COMMAND_PARSE_ENABLE(in, out) \
COMMAND_PARSE_BOOL(in, out, "enable", "disable")
void script_debug(Jim_Interp *interp, const char *cmd,
unsigned argc, Jim_Obj * const *argv);
-#endif /* COMMAND_H */
+#endif /* OPENOCD_HELPER_COMMAND_H */