update files to correct FSF address
[openocd.git] / src / target / etm.h
index b2426c7497e97ffc73c0f5c6024d8be0f22a1a12..ded18e97547e169a598d2631a97c97ba897ae9d6 100644 (file)
  *   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.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
+
 #ifndef ETM_H
 #define ETM_H
 
 #include "trace.h"
 #include "arm_jtag.h"
-#include "armv4_5.h"
 
-struct image_s;
+struct image;
 
 /* ETM registers (JTAG protocol) */
-enum
-{
+enum {
        ETM_CTRL = 0x00,
        ETM_CONFIG = 0x01,
        ETM_TRIG_EVENT = 0x02,
@@ -69,97 +68,110 @@ enum
        /* N task contexts */
        ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,
        ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,
+       ETM_ID = 0x79,
 };
 
-typedef struct etm_reg_s
-{
+struct etm_reg {
        uint32_t value;
        const struct etm_reg_info *reg_info;
-       arm_jtag_t *jtag_info;
-} etm_reg_t;
+       struct arm_jtag *jtag_info;
+};
+
+/* Subset of ETM_CTRL bit assignments.  Many of these
+ * control the configuration of trace output, which
+ * hooks up either to ETB or to an external device.
+ *
+ * NOTE that these have evolved since the ~v1.3 defns ...
+ */
+enum {
+       ETM_CTRL_POWERDOWN      = (1 << 0),
+       ETM_CTRL_MONITOR_CPRT   = (1 << 1),
+
+       /* bits 3:2 == trace type */
+       ETM_CTRL_TRACE_DATA     = (1 << 2),
+       ETM_CTRL_TRACE_ADDR     = (2 << 2),
+       ETM_CTRL_TRACE_MASK     = (3 << 2),
 
-typedef enum
-{
-       /* Port width */
+       /* Port width (bits 21 and 6:4) */
        ETM_PORT_4BIT           = 0x00,
        ETM_PORT_8BIT           = 0x10,
        ETM_PORT_16BIT          = 0x20,
-       ETM_PORT_WIDTH_MASK     = 0x70,
-       /* Port modes */
-       ETM_PORT_NORMAL    = 0x00000,
-       ETM_PORT_MUXED     = 0x10000,
-       ETM_PORT_DEMUXED   = 0x20000,
-       ETM_PORT_MODE_MASK = 0x30000,
-       /* Clocking modes */
-       ETM_PORT_FULL_CLOCK = 0x0000,
-       ETM_PORT_HALF_CLOCK = 0x1000,
-       ETM_PORT_CLOCK_MASK = 0x1000,
-} etm_portmode_t;
-
-typedef enum
-{
-       /* Data trace */
-       ETMV1_TRACE_NONE         = 0x00,
-       ETMV1_TRACE_DATA     = 0x01,
-       ETMV1_TRACE_ADDR     = 0x02,
-       ETMV1_TRACE_MASK     = 0x03,
-       /* ContextID */
-       ETMV1_CONTEXTID_NONE = 0x00,
-       ETMV1_CONTEXTID_8    = 0x10,
-       ETMV1_CONTEXTID_16   = 0x20,
-       ETMV1_CONTEXTID_32   = 0x30,
-       ETMV1_CONTEXTID_MASK = 0x30,
-       /* Misc */
-       ETMV1_CYCLE_ACCURATE = 0x100,
-       ETMV1_BRANCH_OUTPUT = 0x200
-} etmv1_tracemode_t;
+       ETM_PORT_24BIT          = 0x30,
+       ETM_PORT_32BIT          = 0x40,
+       ETM_PORT_48BIT          = 0x50,
+       ETM_PORT_64BIT          = 0x60,
+       ETM_PORT_1BIT           = 0x00 | (1 << 21),
+       ETM_PORT_2BIT           = 0x10 | (1 << 21),
+       ETM_PORT_WIDTH_MASK     = 0x70 | (1 << 21),
+
+       ETM_CTRL_FIFOFULL_STALL = (1 << 7),
+       ETM_CTRL_BRANCH_OUTPUT  = (1 << 8),
+       ETM_CTRL_DBGRQ          = (1 << 9),
+       ETM_CTRL_ETM_PROG       = (1 << 10),
+       ETM_CTRL_ETMEN          = (1 << 11),
+       ETM_CTRL_CYCLE_ACCURATE = (1 << 12),
+
+       /* Clocking modes -- up to v2.1, bit 13 */
+       ETM_PORT_FULL_CLOCK     = (0 << 13),
+       ETM_PORT_HALF_CLOCK     = (1 << 13),
+       ETM_PORT_CLOCK_MASK     = (1 << 13),
+
+       /* bits 15:14 == context ID size used in tracing */
+       ETM_CTRL_CONTEXTID_NONE = (0 << 14),
+       ETM_CTRL_CONTEXTID_8    = (1 << 14),
+       ETM_CTRL_CONTEXTID_16   = (2 << 14),
+       ETM_CTRL_CONTEXTID_32   = (3 << 14),
+       ETM_CTRL_CONTEXTID_MASK = (3 << 14),
+
+       /* Port modes -- bits 17:16, tied to clocking mode */
+       ETM_PORT_NORMAL         = (0 << 16),
+       ETM_PORT_MUXED          = (1 << 16),
+       ETM_PORT_DEMUXED        = (2 << 16),
+       ETM_PORT_MODE_MASK      = (3 << 16),
+
+       /* bits 31:18 defined in v3.0 and later (e.g. ARM11+) */
+};
 
 /* forward-declare ETM context */
-struct etm_context_s;
-
-typedef struct etm_capture_driver_s
-{
-       char *name;
-       int (*register_commands)(struct command_context_s *cmd_ctx);
-       int (*init)(struct etm_context_s *etm_ctx);
-       trace_status_t (*status)(struct etm_context_s *etm_ctx);
-       int (*read_trace)(struct etm_context_s *etm_ctx);
-       int (*start_capture)(struct etm_context_s *etm_ctx);
-       int (*stop_capture)(struct etm_context_s *etm_ctx);
-} etm_capture_driver_t;
-
-enum
-{
+struct etm_context;
+
+struct etm_capture_driver {
+       const char *name;
+       const struct command_registration *commands;
+       int (*init)(struct etm_context *etm_ctx);
+       trace_status_t (*status)(struct etm_context *etm_ctx);
+       int (*read_trace)(struct etm_context *etm_ctx);
+       int (*start_capture)(struct etm_context *etm_ctx);
+       int (*stop_capture)(struct etm_context *etm_ctx);
+};
+
+enum {
        ETMV1_TRACESYNC_CYCLE = 0x1,
        ETMV1_TRIGGER_CYCLE = 0x2,
 };
 
-typedef struct etmv1_trace_data_s
-{
+struct etmv1_trace_data {
        uint8_t pipestat;       /* bits 0-2 pipeline status */
        uint16_t packet;                /* packet data (4, 8 or 16 bit) */
        int flags;              /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */
-} etmv1_trace_data_t;
+};
 
 /* describe a trace context
  * if support for ETMv2 or ETMv3 is to be implemented,
  * this will have to be split into version independent elements
  * and a version specific part
  */
-typedef struct etm_context_s
-{
-       target_t *target;               /* target this ETM is connected to */
-       reg_cache_t *reg_cache;         /* ETM register cache */
-       etm_capture_driver_t *capture_driver;   /* driver used to access ETM data */
+struct etm_context {
+       struct target *target;          /* target this ETM is connected to */
+       struct reg_cache *reg_cache;            /* ETM register cache */
+       struct etm_capture_driver *capture_driver;      /* driver used to access ETM data */
        void *capture_driver_priv;      /* capture driver private data */
-       uint32_t trigger_percent;       /* how much trace buffer to fill after trigger */
        trace_status_t capture_status;  /* current state of capture run */
-       etmv1_trace_data_t *trace_data; /* trace data */
+       struct etmv1_trace_data *trace_data;    /* trace data */
        uint32_t trace_depth;           /* number of cycles to be analyzed, 0 if no data available */
-       etm_portmode_t portmode;        /* normal, multiplexed or demultiplexed */
-       etmv1_tracemode_t tracemode;    /* type of info trace contains */
-       armv4_5_state_t core_state;     /* current core state */
-       struct image_s *image;          /* source for target opcodes */
+       uint32_t control;       /* shadow of ETM_CTRL */
+       int /*arm_state*/ core_state;   /* current core state */
+       struct image *image;            /* source for target opcodes */
        uint32_t pipe_index;            /* current trace cycle */
        uint32_t data_index;            /* cycle holding next data packet */
        bool data_half;                 /* port half on a 16 bit port */
@@ -167,16 +179,16 @@ typedef struct etm_context_s
        bool ptr_ok;                    /* whether last_ptr is valid */
        uint8_t bcd_vers;               /* e.g. 0x13 == ETMv1.3 */
        uint32_t config;                /* cache of ETM_CONFIG value */
+       uint32_t id;                    /* cache of ETM_ID value, or 0 */
        uint32_t current_pc;            /* current program counter */
        uint32_t last_branch;           /* last branch address output */
        uint32_t last_branch_reason;    /* type of last branch encountered */
        uint32_t last_ptr;              /* address of the last data access */
        uint32_t last_instruction;      /* index of last executed (to calc timings) */
-} etm_context_t;
+};
 
 /* PIPESTAT values */
-typedef enum
-{
+typedef enum {
        STAT_IE = 0x0,
        STAT_ID = 0x1,
        STAT_IN = 0x2,
@@ -188,8 +200,7 @@ typedef enum
 } etmv1_pipestat_t;
 
 /* branch reason values */
-typedef enum
-{
+typedef enum {
        BR_NORMAL  = 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */
        BR_ENABLE  = 0x1, /* Trace has been enabled */
        BR_RESTART = 0x2, /* Trace restarted after a FIFO overflow */
@@ -200,10 +211,12 @@ typedef enum
        BR_RSVD7   = 0x7, /* reserved */
 } etmv1_branch_reason_t;
 
-extern reg_cache_t* etm_build_reg_cache(target_t *target, arm_jtag_t *jtag_info, etm_context_t *etm_ctx);
-extern int etm_setup(target_t *target);
+struct reg_cache *etm_build_reg_cache(struct target *target,
+               struct arm_jtag *jtag_info, struct etm_context *etm_ctx);
+
+int etm_setup(struct target *target);
 
-int etm_register_commands(struct command_context_s *cmd_ctx);
+extern const struct command_registration etm_command_handlers[];
 
 #define ERROR_ETM_INVALID_DRIVER       (-1300)
 #define ERROR_ETM_PORTMODE_NOT_SUPPORTED       (-1301)

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)