openocd.c File Reference

Include dependency graph for openocd.c:

Go to the source code of this file.

Data Structures
struct	jim_scriptobj

Macros
#define	OPENOCD_VERSION    "Open On-Chip Debugger " VERSION RELSTR

Functions
	COMMAND_HANDLER (handle_add_script_search_dir_command)
	COMMAND_HANDLER (handle_init_command)
	COMMAND_HANDLER (handle_noinit_command)
static int	jim_expr_command (Jim_Interp *interp, int argc, Jim_Obj *const *argv)
static int	jim_version_command (Jim_Interp *interp, int argc, Jim_Obj *const *argv)
static int	log_target_callback_event_handler (struct target *target, enum target_event event, void *priv)
int	openocd_main (int argc, char *argv[])
	Different applications can define this entry point to override the default openocd main function. More...
static int	openocd_register_commands (struct command_context *cmd_ctx)
static int	openocd_thread (int argc, char *argv[], struct command_context *cmd_ctx)
	OpenOCD runtime meat that can become single-thread in future. More...
static struct command_context *	setup_command_handler (Jim_Interp *interp)
static int	workaround_for_jimtcl_expr (struct command_context *cmd_ctx)

Variables
static const struct command_registration	expr_handler []
struct command_context *	global_cmd_ctx
static bool	init_at_startup = true
static const struct command_registration	openocd_command_handlers []
static const char	openocd_startup_tcl []

Macro Definition Documentation

OPENOCD_VERSION

#define OPENOCD_VERSION    "Open On-Chip Debugger " VERSION RELSTR

Definition at line 44 of file openocd.c.

Function Documentation

COMMAND_HANDLER() [1/3]

COMMAND_HANDLER

(

handle_add_script_search_dir_command

)

Definition at line 184 of file openocd.c.

References add_script_search_dir(), CMD_ARGC, CMD_ARGV, ERROR_COMMAND_SYNTAX_ERROR, and ERROR_OK.

COMMAND_HANDLER() [2/3]

COMMAND_HANDLER

(

handle_init_command

)

Definition at line 109 of file openocd.c.

References adapter_init(), all_targets, CMD_ARGC, CMD_CTX, COMMAND_CONFIG, command_context_mode(), COMMAND_EXEC, command_run_line(), ERROR_COMMAND_SYNTAX_ERROR, ERROR_FAIL, ERROR_OK, gdb_target_add_all(), jtag_poll_mask(), jtag_poll_unmask(), LOG_DEBUG, log_target_callback_event_handler(), target_examine(), and target_register_event_callback().

COMMAND_HANDLER() [3/3]

COMMAND_HANDLER

(

handle_noinit_command

)

Definition at line 100 of file openocd.c.

References CMD_ARGC, ERROR_COMMAND_SYNTAX_ERROR, ERROR_OK, and init_at_startup.

jim_expr_command()

static int jim_expr_command ( Jim_Interp *  interp, int  argc, Jim_Obj *const *  argv  )

static

Definition at line 249 of file openocd.c.

jim_version_command()

static int jim_version_command ( Jim_Interp *  interp, int  argc, Jim_Obj *const *  argv  )

static

Definition at line 54 of file openocd.c.

References NULL, and OPENOCD_VERSION.

log_target_callback_event_handler()

static int log_target_callback_event_handler ( struct target *  target, enum target_event  event, void *  priv  )

static

Definition at line 74 of file openocd.c.

References ERROR_OK, target_arch_state(), TARGET_EVENT_GDB_END, TARGET_EVENT_GDB_START, TARGET_EVENT_HALTED, and target::verbose_halt_msg.

Referenced by COMMAND_HANDLER().

openocd_main()

int openocd_main	(	int	argc,
		char *	argv[]
	)

Different applications can define this entry point to override the default openocd main function.

On most systems, this will be defined in src/openocd.c.

Parameters

argc	normally passed from main()
argv	normally passed from main()

Returns

return code for main()

Definition at line 387 of file openocd.c.

References adapter_quit(), arm_cti_cleanup_all(), arm_tpiu_swo_cleanup_all(), COMMAND_CONFIG, command_context_mode(), command_exit(), command_set_output_handler(), configuration_output_handler(), dap_cleanup_all(), ERROR_FAIL, ERROR_OK, exit_on_signal(), flash_free_all_banks(), free_config(), gdb_service_free(), help_del_all_commands(), log_exit(), LOG_OUTPUT, NULL, openocd_thread(), rtt_exit(), rtt_init(), server_free(), server_host_os_close(), server_host_os_entry(), setup_command_handler(), unregister_all_commands(), and util_init().

Referenced by main().

openocd_register_commands()

static int openocd_register_commands ( struct command_context *  cmd_ctx )

static

Definition at line 228 of file openocd.c.

References NULL, openocd_command_handlers, and register_commands().

Referenced by setup_command_handler().

openocd_thread()

static int openocd_thread ( int  argc, char *  argv[], struct command_context *  cmd_ctx  )

static

OpenOCD runtime meat that can become single-thread in future.

It parse commandline, reads configuration, sets up the target and starts server loop. Commandline arguments are passed into this function from openocd_main().

Definition at line 342 of file openocd.c.

References command_run_line(), ERROR_COMMAND_CLOSE_CONNECTION, ERROR_FAIL, ERROR_OK, init_at_startup, last_signal, parse_cmdline_args(), parse_config_file(), server_init(), server_loop(), server_preinit(), and server_quit().

Referenced by openocd_main().

setup_command_handler()

static struct command_context* setup_command_handler ( Jim_Interp *  interp )

static

Definition at line 294 of file openocd.c.

References adapter_register_commands(), arm_tpiu_swo_register_commands(), command_done(), command_init(), cti_register_commands(), dap_register_commands(), ERROR_OK, flash_register_commands(), gdb_register_commands(), global_cmd_ctx, command_context::interp, LOG_DEBUG, log_init(), LOG_OUTPUT, log_register_commands(), nand_register_commands(), NULL, openocd_register_commands(), openocd_startup_tcl, OPENOCD_VERSION, pld_register_commands(), rtt_server_register_commands(), server_register_commands(), target_register_commands(), transport_register_commands(), and workaround_for_jimtcl_expr().

Referenced by openocd_main().

workaround_for_jimtcl_expr()

static int workaround_for_jimtcl_expr ( struct command_context *  cmd_ctx )

static

Definition at line 287 of file openocd.c.

References expr_handler, NULL, and register_commands().

Referenced by setup_command_handler().

Variable Documentation

expr_handler

const struct command_registration expr_handler[]

static

Initial value:

= {
    {
        .name = "expr",
        .jim_handler = jim_expr_command,
        .mode = COMMAND_ANY,
        .help = "",
        .usage = "",
    },
    COMMAND_REGISTRATION_DONE
}

Definition at line 249 of file openocd.c.

Referenced by workaround_for_jimtcl_expr().

global_cmd_ctx

struct command_context* global_cmd_ctx

Definition at line 292 of file openocd.c.

Referenced by current_command_context(), dsp563xx_get_default_memory(), jim_transport_select(), and setup_command_handler().

init_at_startup

bool init_at_startup = true

static

Definition at line 98 of file openocd.c.

Referenced by COMMAND_HANDLER(), and openocd_thread().

openocd_command_handlers

const struct command_registration openocd_command_handlers[]

static

Definition at line 184 of file openocd.c.

Referenced by openocd_register_commands().

openocd_startup_tcl

const char openocd_startup_tcl[]

static

Initial value:

= {
0 
}

Definition at line 48 of file openocd.c.

Referenced by setup_command_handler().