openocd: src/target: replace the GPL-2.0-or-later license tag
[fw/openocd] / src / target / target.h
index b954ec22d2877f4228c37ec2343dff3b2bb4fce1..e221351a834c9d8e0176536ce6c03254ef557352 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
  *   Copyright (C) ST-Ericsson SA 2011                                     *
  *   michel.jaouen@stericsson.com : smp minimum support                    *
- *                                                                         *
- *   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/>. *
  ***************************************************************************/
 
 #ifndef OPENOCD_TARGET_TARGET_H
 #define OPENOCD_TARGET_TARGET_H
 
 #include <helper/list.h>
+#include "helper/replacements.h"
+#include "helper/system.h"
+#include <jim.h>
 
 struct reg;
 struct trace;
@@ -46,7 +38,7 @@ struct gdb_fileio_info;
 
 /*
  * TARGET_UNKNOWN = 0: we don't know anything about the target yet
- * TARGET_RUNNING = 1: the target is executing user code
+ * TARGET_RUNNING = 1: the target is executing or ready to execute user code
  * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
  * debugger. on an xscale it means that the debug handler is executing
  * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
@@ -154,7 +146,7 @@ struct target {
 
        struct target_event_action *event_action;
 
-       int reset_halt;                                         /* attempt resetting the CPU into the halted mode? */
+       bool reset_halt;                                                /* attempt resetting the CPU into the halted mode? */
        target_addr_t working_area;                             /* working area (initialised RAM). Evaluated
                                                                                 * upon first allocation from virtual/physical address. */
        bool working_area_virt_spec;            /* virtual address specified? */
@@ -197,8 +189,10 @@ struct target {
        bool rtos_auto_detect;                          /* A flag that indicates that the RTOS has been specified as "auto"
                                                                                 * and must be detected when symbols are offered */
        struct backoff_timer backoff;
-       int smp;                                                        /* add some target attributes for smp support */
-       struct target_list *head;
+       int smp;                                                        /* Unique non-zero number for each SMP group */
+       struct list_head *smp_targets;          /* list all targets in this smp group/cluster
+                                                                                * The head of the list is shared between the
+                                                                                * cluster, thus here there is a pointer */
        /* the gdb service is there in case of smp, we have only one gdb server
         * for all smp target
         * the target attached to the gdb is changing dynamically by changing
@@ -210,13 +204,15 @@ struct target {
 
        char *gdb_port_override;                        /* target-specific override for gdb_port */
 
+       int gdb_max_connections;                        /* max number of simultaneous gdb connections */
+
        /* The semihosting information, extracted from the target. */
        struct semihosting *semihosting;
 };
 
 struct target_list {
+       struct list_head lh;
        struct target *target;
-       struct target_list *next;
 };
 
 struct gdb_fileio_info {
@@ -258,6 +254,8 @@ enum target_event {
        TARGET_EVENT_RESUMED,           /* target resumed to normal execution */
        TARGET_EVENT_RESUME_START,
        TARGET_EVENT_RESUME_END,
+       TARGET_EVENT_STEP_START,
+       TARGET_EVENT_STEP_END,
 
        TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
        TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
@@ -287,12 +285,21 @@ enum target_event {
        TARGET_EVENT_GDB_FLASH_WRITE_END,
 
        TARGET_EVENT_TRACE_CONFIG,
+
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x100 = 0x100, /* semihosting allows user cmds from 0x100 to 0x1ff */
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x101 = 0x101,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x102 = 0x102,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x103 = 0x103,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x104 = 0x104,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x105 = 0x105,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x106 = 0x106,
+       TARGET_EVENT_SEMIHOSTING_USER_CMD_0x107 = 0x107,
 };
 
 struct target_event_action {
        enum target_event event;
-       struct Jim_Interp *interp;
-       struct Jim_Obj *body;
+       Jim_Interp *interp;
+       Jim_Obj *body;
        struct target_event_action *next;
 };
 
@@ -326,7 +333,7 @@ struct target_timer_callback {
        unsigned int time_ms;
        enum target_timer_type type;
        bool removed;
-       struct timeval when;
+       int64_t when;   /* output of timeval_ms() */
        void *priv;
        struct target_timer_callback *next;
 };
@@ -400,6 +407,11 @@ int target_call_timer_callbacks(void);
  * a synchronous command completes.
  */
 int target_call_timer_callbacks_now(void);
+/**
+ * Returns when the next registered event will take place. Callers can use this
+ * to go to sleep until that time occurs.
+ */
+int64_t target_timer_next_event(void);
 
 struct target *get_target_by_num(int num);
 struct target *get_current_target(struct command_context *cmd_ctx);
@@ -535,7 +547,7 @@ int target_step(struct target *target,
 int target_run_algorithm(struct target *target,
                int num_mem_params, struct mem_param *mem_params,
                int num_reg_params, struct reg_param *reg_param,
-               uint32_t entry_point, uint32_t exit_point,
+               target_addr_t entry_point, target_addr_t exit_point,
                int timeout_ms, void *arch_info);
 
 /**
@@ -546,7 +558,7 @@ int target_run_algorithm(struct target *target,
 int target_start_algorithm(struct target *target,
                int num_mem_params, struct mem_param *mem_params,
                int num_reg_params, struct reg_param *reg_params,
-               uint32_t entry_point, uint32_t exit_point,
+               target_addr_t entry_point, target_addr_t exit_point,
                void *arch_info);
 
 /**
@@ -557,7 +569,7 @@ int target_start_algorithm(struct target *target,
 int target_wait_algorithm(struct target *target,
                int num_mem_params, struct mem_param *mem_params,
                int num_reg_params, struct reg_param *reg_params,
-               uint32_t exit_point, int timeout_ms,
+               target_addr_t exit_point, int timeout_ms,
                void *arch_info);
 
 /**
@@ -572,6 +584,18 @@ int target_run_flash_async_algorithm(struct target *target,
                uint32_t entry_point, uint32_t exit_point,
                void *arch_info);
 
+/**
+ * This routine is a wrapper for asynchronous algorithms.
+ *
+ */
+int target_run_read_async_algorithm(struct target *target,
+               uint8_t *buffer, uint32_t count, int block_size,
+               int num_mem_params, struct mem_param *mem_params,
+               int num_reg_params, struct reg_param *reg_params,
+               uint32_t buffer_start, uint32_t buffer_size,
+               uint32_t entry_point, uint32_t exit_point,
+               void *arch_info);
+
 /**
  * Read @a count items of @a size bytes from the memory of @a target at
  * the @a address given.
@@ -665,6 +689,13 @@ target_addr_t target_address_max(struct target *target);
  */
 unsigned target_address_bits(struct target *target);
 
+/**
+ * Return the number of data bits this target supports.
+ *
+ * This routine is a wrapper for target->type->data_bits.
+ */
+unsigned int target_data_bits(struct target *target);
+
 /** Return the *name* of this targets current state */
 const char *target_state_name(struct target *target);
 
@@ -695,6 +726,13 @@ int target_alloc_working_area(struct target *target,
  */
 int target_alloc_working_area_try(struct target *target,
                uint32_t size, struct working_area **area);
+/**
+ * Free a working area.
+ * Restore target data if area backup is configured.
+ * @param target
+ * @param area Pointer to the area to be freed or NULL
+ * @returns ERROR_OK if successful; error code if restore failed
+ */
 int target_free_working_area(struct target *target, struct working_area *area);
 void target_free_all_working_areas(struct target *target);
 uint32_t target_get_working_area_avail(struct target *target);
@@ -745,6 +783,9 @@ void target_handle_md_output(struct command_invocation *cmd,
        struct target *target, target_addr_t address, unsigned size,
        unsigned count, const uint8_t *buffer);
 
+int target_profiling_default(struct target *target, uint32_t *samples, uint32_t
+               max_num_samples, uint32_t *num_samples, uint32_t seconds);
+
 #define ERROR_TARGET_INVALID   (-300)
 #define ERROR_TARGET_INIT_FAILED (-301)
 #define ERROR_TARGET_TIMEOUT   (-302)
@@ -757,7 +798,10 @@ void target_handle_md_output(struct command_invocation *cmd,
 #define ERROR_TARGET_NOT_RUNNING (-310)
 #define ERROR_TARGET_NOT_EXAMINED (-311)
 #define ERROR_TARGET_DUPLICATE_BREAKPOINT (-312)
+#define ERROR_TARGET_ALGO_EXIT  (-313)
 
 extern bool get_target_reset_nag(void);
 
+#define TARGET_DEFAULT_POLLING_INTERVAL                100
+
 #endif /* OPENOCD_TARGET_TARGET_H */