contrib: replace the BSD-3-Clause license tag
[fw/openocd] / src / openocd.c
index bd52f4acf57b36aee476ae1b79f5a0dd6dc41bdb..b65d4715288cd3eacdb340f2481bd2dddb6d7567 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,19 +9,6 @@
  *                                                                         *
  *   Copyright (C) 2008 Richard Missenden                                  *
  *   richard.missenden@googlemail.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     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   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, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #endif
 
 #include "openocd.h"
-#include <jtag/driver.h>
+#include <jtag/adapter.h>
 #include <jtag/jtag.h>
 #include <transport/transport.h>
-#include <helper/ioutil.h>
 #include <helper/util.h>
 #include <helper/configuration.h>
 #include <flash/nor/core.h>
 #include <flash/nand/core.h>
 #include <pld/pld.h>
-#include <flash/mflash.h>
 #include <target/arm_cti.h>
 #include <target/arm_adi_v5.h>
+#include <target/arm_tpiu_swo.h>
+#include <rtt/rtt.h>
 
 #include <server/server.h>
 #include <server/gdb_server.h>
+#include <server/rtt_server.h>
 
 #ifdef HAVE_STRINGS_H
 #include <strings.h>
@@ -87,13 +77,13 @@ static int log_target_callback_event_handler(struct target *target,
 {
        switch (event) {
                case TARGET_EVENT_GDB_START:
-                       target->display = 0;
+                       target->verbose_halt_msg = false;
                        break;
                case TARGET_EVENT_GDB_END:
-                       target->display = 1;
+                       target->verbose_halt_msg = true;
                        break;
                case TARGET_EVENT_HALTED:
-                       if (target->display) {
+                       if (target->verbose_halt_msg) {
                                /* do not display information when debugger caused the halt */
                                target_arch_state(target);
                        }
@@ -129,8 +119,10 @@ COMMAND_HANDLER(handle_init_command)
 
        initialized = 1;
 
+       bool save_poll_mask = jtag_poll_mask();
+
        retval = command_run_line(CMD_CTX, "target init");
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return ERROR_FAIL;
 
        retval = adapter_init(CMD_CTX);
@@ -149,11 +141,11 @@ COMMAND_HANDLER(handle_init_command)
        command_context_mode(CMD_CTX, COMMAND_EXEC);
 
        retval = command_run_line(CMD_CTX, "transport init");
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return ERROR_FAIL;
 
        retval = command_run_line(CMD_CTX, "dap init");
-       if (ERROR_OK != retval)
+       if (retval != ERROR_OK)
                return ERROR_FAIL;
 
        LOG_DEBUG("Examining targets...");
@@ -165,9 +157,6 @@ COMMAND_HANDLER(handle_init_command)
        if (command_run_line(CMD_CTX, "flash init") != ERROR_OK)
                return ERROR_FAIL;
 
-       if (command_run_line(CMD_CTX, "mflash init") != ERROR_OK)
-               return ERROR_FAIL;
-
        if (command_run_line(CMD_CTX, "nand init") != ERROR_OK)
                return ERROR_FAIL;
 
@@ -175,11 +164,20 @@ COMMAND_HANDLER(handle_init_command)
                return ERROR_FAIL;
        command_context_mode(CMD_CTX, COMMAND_EXEC);
 
+       /* in COMMAND_EXEC, after target_examine(), only tpiu or only swo */
+       if (command_run_line(CMD_CTX, "tpiu init") != ERROR_OK)
+               return ERROR_FAIL;
+
+       jtag_poll_unmask(save_poll_mask);
+
        /* initialize telnet subsystem */
        gdb_target_add_all(all_targets);
 
        target_register_event_callback(log_target_callback_event_handler, CMD_CTX);
 
+       if (command_run_line(CMD_CTX, "_run_post_init_commands") != ERROR_OK)
+               return ERROR_FAIL;
+
        return ERROR_OK;
 }
 
@@ -232,12 +230,68 @@ static int openocd_register_commands(struct command_context *cmd_ctx)
        return register_commands(cmd_ctx, NULL, openocd_command_handlers);
 }
 
+/*
+ * TODO: to be removed after v0.12.0
+ * workaround for syntax change of "expr" in jimtcl 0.81
+ * replace "expr" with openocd version that prints the deprecated msg
+ */
+struct jim_scriptobj {
+       void *token;
+       Jim_Obj *filename_obj;
+       int len;
+       int subst_flags;
+       int in_use;
+       int firstline;
+       int linenr;
+       int missing;
+};
+
+static int jim_expr_command(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
+{
+       if (argc == 2)
+               return Jim_EvalExpression(interp, argv[1]);
+
+       if (argc > 2) {
+               Jim_Obj *obj = Jim_ConcatObj(interp, argc - 1, argv + 1);
+               Jim_IncrRefCount(obj);
+               const char *s = Jim_String(obj);
+               struct jim_scriptobj *script = Jim_GetIntRepPtr(interp->currentScriptObj);
+               if (interp->currentScriptObj == interp->emptyObj ||
+                               strcmp(interp->currentScriptObj->typePtr->name, "script") ||
+                               script->subst_flags ||
+                               script->filename_obj == interp->emptyObj)
+                       LOG_WARNING("DEPRECATED! use 'expr { %s }' not 'expr %s'", s, s);
+               else
+                       LOG_WARNING("DEPRECATED! (%s:%d) use 'expr { %s }' not 'expr %s'",
+                                               Jim_String(script->filename_obj), script->linenr, s, s);
+               int retcode = Jim_EvalExpression(interp, obj);
+               Jim_DecrRefCount(interp, obj);
+               return retcode;
+       }
+
+       Jim_WrongNumArgs(interp, 1, argv, "expression ?...?");
+       return JIM_ERR;
+}
+
+static const struct command_registration expr_handler[] = {
+       {
+               .name = "expr",
+               .jim_handler = jim_expr_command,
+               .mode = COMMAND_ANY,
+               .help = "",
+               .usage = "",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
+static int workaround_for_jimtcl_expr(struct command_context *cmd_ctx)
+{
+       return register_commands(cmd_ctx, NULL, expr_handler);
+}
+
 struct command_context *global_cmd_ctx;
 
-/* NB! this fn can be invoked outside this file for non PC hosted builds
- * NB! do not change to 'static'!!!!
- */
-struct command_context *setup_command_handler(Jim_Interp *interp)
+static struct command_context *setup_command_handler(Jim_Interp *interp)
 {
        log_init();
        LOG_DEBUG("log_init: complete");
@@ -247,24 +301,26 @@ struct command_context *setup_command_handler(Jim_Interp *interp)
        /* register subsystem commands */
        typedef int (*command_registrant_t)(struct command_context *cmd_ctx_value);
        static const command_registrant_t command_registrants[] = {
+               &workaround_for_jimtcl_expr,
                &openocd_register_commands,
                &server_register_commands,
                &gdb_register_commands,
                &log_register_commands,
+               &rtt_server_register_commands,
                &transport_register_commands,
-               &interface_register_commands,
+               &adapter_register_commands,
                &target_register_commands,
                &flash_register_commands,
                &nand_register_commands,
                &pld_register_commands,
-               &mflash_register_commands,
                &cti_register_commands,
                &dap_register_commands,
+               &arm_tpiu_swo_register_commands,
                NULL
        };
-       for (unsigned i = 0; NULL != command_registrants[i]; i++) {
+       for (unsigned i = 0; command_registrants[i]; i++) {
                int retval = (*command_registrants[i])(cmd_ctx);
-               if (ERROR_OK != retval) {
+               if (retval != ERROR_OK) {
                        command_done(cmd_ctx);
                        return NULL;
                }
@@ -303,12 +359,12 @@ static int openocd_thread(int argc, char *argv[], struct command_context *cmd_ct
        }
 
        ret = server_init(cmd_ctx);
-       if (ERROR_OK != ret)
+       if (ret != ERROR_OK)
                return ERROR_FAIL;
 
        if (init_at_startup) {
                ret = command_run_line(cmd_ctx, "init");
-               if (ERROR_OK != ret) {
+               if (ret != ERROR_OK) {
                        server_quit();
                        return ERROR_FAIL;
                }
@@ -340,7 +396,7 @@ int openocd_main(int argc, char *argv[])
        if (util_init(cmd_ctx) != ERROR_OK)
                return EXIT_FAILURE;
 
-       if (ioutil_init(cmd_ctx) != ERROR_OK)
+       if (rtt_init() != ERROR_OK)
                return EXIT_FAILURE;
 
        LOG_OUTPUT("For bug reports, read\n\t"
@@ -350,24 +406,38 @@ int openocd_main(int argc, char *argv[])
        command_context_mode(cmd_ctx, COMMAND_CONFIG);
        command_set_output_handler(cmd_ctx, configuration_output_handler, NULL);
 
+       server_host_os_entry();
+
        /* Start the executable meat that can evolve into thread in future. */
        ret = openocd_thread(argc, argv, cmd_ctx);
 
+       flash_free_all_banks();
        gdb_service_free();
+       arm_tpiu_swo_cleanup_all();
        server_free();
 
        unregister_all_commands(cmd_ctx, NULL);
+       help_del_all_commands(cmd_ctx);
 
-       /* Shutdown commandline interface */
-       command_exit(cmd_ctx);
+       /* free all DAP and CTI objects */
+       arm_cti_cleanup_all();
+       dap_cleanup_all();
 
        adapter_quit();
 
+       server_host_os_close();
+
+       /* Shutdown commandline interface */
+       command_exit(cmd_ctx);
+
+       rtt_exit();
        free_config();
 
-       if (ERROR_FAIL == ret)
+       log_exit();
+
+       if (ret == ERROR_FAIL)
                return EXIT_FAILURE;
-       else if (ERROR_OK != ret)
+       else if (ret != ERROR_OK)
                exit_on_signal(ret);
 
        return ret;