command.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 ***************************************************************************/
 
#ifndef OPENOCD_HELPER_COMMAND_H
#define OPENOCD_HELPER_COMMAND_H
 
#include <stdint.h>
#include <stdbool.h>
 
#include <helper/jim-nvp.h>
#include <helper/list.h>
#include <helper/types.h>
 
/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
 * used for __attribute__((format( ... ))), with GCC v4.4 or later
 */
#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004)) && !defined(__clang__)
#define PRINTF_ATTRIBUTE_FORMAT gnu_printf
#else
#define PRINTF_ATTRIBUTE_FORMAT printf
#endif
 
enum command_mode {
    COMMAND_EXEC,
    COMMAND_CONFIG,
    COMMAND_ANY,
    COMMAND_UNKNOWN = -1, /* error condition */
};
 
struct command_context;
 
typedef int (*command_output_handler_t)(struct command_context *context,
        const char *line);
 
struct command_context {
    Jim_Interp *interp;
    enum command_mode mode;
    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;
    struct list_head *help_list;
};
 
struct command;
 
struct command_invocation {
    struct command_context *ctx;
    struct command *current;
    const char *name;
    unsigned int argc;
    const char **argv;
    Jim_Obj * const *jimtcl_argv;
    Jim_Obj *output;
};
 
bool jimcmd_is_oocd_command(Jim_Cmd *cmd);
 
void *jimcmd_privdata(Jim_Cmd *cmd);
 
#define __COMMAND_HANDLER(name, extra ...) \
        int name(struct command_invocation *cmd, ## extra)
 
#define CALL_COMMAND_HANDLER(name, extra ...) \
        name(cmd, ## extra)
 
#define COMMAND_HANDLER(name) \
        static __COMMAND_HANDLER(name)
 
#define COMMAND_HELPER(name, extra ...) __COMMAND_HANDLER(name, extra)
 
#define CMD (cmd)
#define CMD_CTX (cmd->ctx)
#define CMD_ARGC (cmd->argc)
#define CMD_ARGV (cmd->argv)
#define CMD_JIMTCL_ARGV (cmd->jimtcl_argv)
#define CMD_NAME (cmd->name)
#define CMD_CURRENT (cmd->current)
#define CMD_DATA (CMD_CURRENT->jim_handler_data)
 
typedef __COMMAND_HANDLER((*command_handler_t));
 
struct command {
    char *name;
    command_handler_t handler;
    void *jim_handler_data;
        /* Command handlers can use it for any handler specific data */
    struct target *jim_override_target;
        /* Used only for target of target-prefixed cmd */
    enum command_mode mode;
};
 
/*
 * Return the struct command pointer kept in private data
 * Used to enforce check on data type
 */
static inline struct command *jim_to_command(Jim_Interp *interp)
{
    return Jim_CmdPrivData(interp);
}
 
/*
 * Commands should be registered by filling in one or more of these
 * structures and passing them to [un]register_commands().
 *
 * A conventional format should be used for help strings, to provide both
 * usage and basic information:
 * @code
 * "@<options@> ... - some explanation text"
 * @endcode
 *
 * @param name The name of the command to register, which must not have
 * been registered previously in the intended context.
 * @param handler The callback function that will be called.  If NULL,
 * then the command serves as a placeholder for its children or a script.
 * @param mode The command mode(s) in which this command may be run.
 * @param help The help text that will be displayed to the user.
 */
struct command_registration {
    const char *name;
    command_handler_t handler;
    enum command_mode mode;
    const char *help;
    const char *usage;
 
    const struct command_registration *chain;
};
 
#define COMMAND_REGISTRATION_DONE { .name = NULL, .chain = NULL }
 
int __register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
        const struct command_registration *cmds, void *data,
        struct target *override_target);
 
static inline int register_commands(struct command_context *cmd_ctx, const char *cmd_prefix,
        const struct command_registration *cmds)
{
    return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, NULL);
}
 
static inline int register_commands_override_target(struct command_context *cmd_ctx,
        const char *cmd_prefix, const struct command_registration *cmds,
        struct target *target)
{
    return __register_commands(cmd_ctx, cmd_prefix, cmds, NULL, target);
}
 
static inline int register_commands_with_data(struct command_context *cmd_ctx,
        const char *cmd_prefix, const struct command_registration *cmds,
        void *data)
{
    return __register_commands(cmd_ctx, cmd_prefix, cmds, data, NULL);
}
 
int unregister_all_commands(struct command_context *cmd_ctx,
        const char *cmd_prefix);
 
int help_del_all_commands(struct command_context *cmd_ctx);
 
void command_set_output_handler(struct command_context *context,
        command_output_handler_t output_handler, void *priv);
 
 
int command_context_mode(struct command_context *context, enum command_mode mode);
 
/* Return the current command context associated with the Jim interpreter or
 * alternatively the global default command interpreter
 */
struct command_context *current_command_context(Jim_Interp *interp);
struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp);
void command_exit(struct command_context *context);
struct command_context *copy_command_context(struct command_context *cmd_ctx);
void command_done(struct command_context *context);
 
/*
 * command_print() and command_print_sameline() are used to produce the TCL
 * output of OpenOCD commands. command_print() automatically adds a '\n' at
 * the end or the format string. Use command_print_sameline() to avoid the
 * trailing '\n', e.g. to concatenate the command output in the same line.
 * The very last '\n' of the command is stripped away (see run_command()).
 * For commands that strictly require a '\n' as last output character, add
 * it explicitly with either an empty command_print() or with a '\n' in the
 * last command_print() and add a comment to document it.
 */
void command_print(struct command_invocation *cmd, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
void command_print_sameline(struct command_invocation *cmd, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
 
int command_run_line(struct command_context *context, char *line);
int command_run_linef(struct command_context *context, const char *format, ...)
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 2, 3)));
void command_output_text(struct command_context *context, const char *data);
 
void process_jim_events(struct command_context *cmd_ctx);
 
#define ERROR_COMMAND_CLOSE_CONNECTION      (-600)
#define ERROR_COMMAND_SYNTAX_ERROR          (-601)
#define ERROR_COMMAND_NOTFOUND              (-602)
#define ERROR_COMMAND_ARGUMENT_INVALID      (-603)
#define ERROR_COMMAND_ARGUMENT_OVERFLOW     (-604)
#define ERROR_COMMAND_ARGUMENT_UNDERFLOW    (-605)
 
int parse_ulong(const char *str, unsigned long *ul);
int parse_ullong(const char *str, unsigned long long *ul);
 
int parse_long(const char *str, long *ul);
int parse_llong(const char *str, long long *ul);
 
#define DECLARE_PARSE_WRAPPER(name, type) \
        int parse ## name(const char *str, type * ul)
 
DECLARE_PARSE_WRAPPER(_uint, unsigned int);
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);
 
#define COMMAND_PARSE_NUMBER(type, in, out) \
    do { \
        int retval_macro_tmp = parse_ ## type(in, &(out)); \
        if (retval_macro_tmp != ERROR_OK) { \
            command_print(CMD, stringify(out) \
                " option value ('%s') is not valid", in); \
            return retval_macro_tmp; \
        } \
    } while (0)
 
#define COMMAND_PARSE_ADDRESS(in, out) \
    COMMAND_PARSE_NUMBER(target_addr, in, out)
 
#define COMMAND_PARSE_ADDITIONAL_NUMBER(type, argn, out, name_str) \
    do { \
        if (argn+1 >= CMD_ARGC || CMD_ARGV[argn+1][0] == '-') { \
            command_print(CMD, "no " name_str " given"); \
            return ERROR_FAIL; \
        } \
        ++argn; \
        COMMAND_PARSE_NUMBER(type, CMD_ARGV[argn], out); \
    } while (0)
 
#define COMMAND_PARSE_OPTIONAL_NUMBER(type, argn, out) \
    do { \
        if (argn+1 < CMD_ARGC && CMD_ARGV[argn+1][0] != '-') { \
            ++argn; \
            COMMAND_PARSE_NUMBER(type, CMD_ARGV[argn], out); \
        } \
    } while (0)
 
#define COMMAND_PARSE_BOOL(in, out, on, off) \
    do { \
        bool value; \
        int retval_macro_tmp = command_parse_bool_arg(in, &value); \
        if (retval_macro_tmp != ERROR_OK) { \
            command_print(CMD, stringify(out) \
                " option value ('%s') is not valid", in); \
            command_print(CMD, "  choices are '%s' or '%s'", \
                on, off); \
            return retval_macro_tmp; \
        } \
        out = value; \
    } while (0)
 
int command_parse_bool_arg(const char *in, bool *out);
COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label);
 
COMMAND_HELPER(command_parse_str_to_buf, const char *str, void *buf, unsigned int buf_len);
 
#define COMMAND_PARSE_ON_OFF(in, out) \
    COMMAND_PARSE_BOOL(in, out, "on", "off")
#define COMMAND_PARSE_ENABLE(in, out) \
    COMMAND_PARSE_BOOL(in, out, "enable", "disable")
 
#endif /* OPENOCD_HELPER_COMMAND_H */