build: cleanup src/target directory
[openocd.git] / src / target / etm.h
index 3e32fd27e891909104f1f35182858cf3d2049179..083409507d8d7dac0d605e1848c48cd621c6f186 100644 (file)
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 (V1.3 protocol) */
-enum
-{
+/* ETM registers (JTAG protocol) */
+enum {
        ETM_CTRL = 0x00,
        ETM_CONFIG = 0x01,
        ETM_TRIG_EVENT = 0x02,
-       ETM_MMD_CTRL = 0x03,
+       ETM_ASIC_CTRL = 0x03,
        ETM_STATUS = 0x04,
        ETM_SYS_CONFIG = 0x05,
        ETM_TRACE_RESOURCE_CTRL = 0x06,
        ETM_TRACE_EN_CTRL2 = 0x07,
        ETM_TRACE_EN_EVENT = 0x08,
        ETM_TRACE_EN_CTRL1 = 0x09,
+       /* optional FIFOFULL */
        ETM_FIFOFULL_REGION = 0x0a,
        ETM_FIFOFULL_LEVEL = 0x0b,
+       /* viewdata support */
        ETM_VIEWDATA_EVENT = 0x0c,
        ETM_VIEWDATA_CTRL1 = 0x0d,
-       ETM_VIEWDATA_CTRL2 = 0x0e,
+       ETM_VIEWDATA_CTRL2 = 0x0e,      /* optional */
        ETM_VIEWDATA_CTRL3 = 0x0f,
+       /* N pairs of ADDR_{COMPARATOR,ACCESS} registers */
        ETM_ADDR_COMPARATOR_VALUE = 0x10,
        ETM_ADDR_ACCESS_TYPE = 0x20,
+       /* N pairs of DATA_COMPARATOR_{VALUE,MASK} registers */
        ETM_DATA_COMPARATOR_VALUE = 0x30,
        ETM_DATA_COMPARATOR_MASK = 0x40,
-       ETM_COUNTER_INITAL_VALUE = 0x50,
+       /* N quads of COUNTER_{RELOAD_{VALUE,EVENT},ENABLE,VALUE} registers */
+       ETM_COUNTER_RELOAD_VALUE = 0x50,
        ETM_COUNTER_ENABLE = 0x54,
-       ETM_COUNTER_RELOAD_VALUE = 0x58,
+       ETM_COUNTER_RELOAD_EVENT = 0x58,
        ETM_COUNTER_VALUE = 0x5c,
-       ETM_SEQUENCER_CTRL = 0x60,
+       /* 6 sequencer event transitions */
+       ETM_SEQUENCER_EVENT = 0x60,
        ETM_SEQUENCER_STATE = 0x67,
+       /* N triggered outputs */
        ETM_EXTERNAL_OUTPUT = 0x68,
+       /* N task contexts */
        ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,
        ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,
+       ETM_ID = 0x79,
+};
+
+struct etm_reg {
+       uint32_t value;
+       const struct etm_reg_info *reg_info;
+       struct arm_jtag *jtag_info;
 };
 
-typedef struct etm_reg_s
-{
-       int addr;
-       arm_jtag_t *jtag_info;
-} etm_reg_t;
+/* 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 */
-       u16 packet;             /* packet data (4, 8 or 16 bit) */
+       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 */
-       void *capture_driver_priv;              /* capture driver private data */
-       u32 trigger_percent;                    /* percent of trace buffer to be filled after the trigger */
+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 */
        trace_status_t capture_status;  /* current state of capture run */
-       etmv1_trace_data_t *trace_data; /* trace data */
-       u32 trace_depth;                                /* number of trace cycles to be analyzed, 0 if no trace data available */
-       etm_portmode_t portmode;                /* normal, multiplexed or demultiplexed */
-       etmv1_tracemode_t tracemode;    /* type of information the trace contains (data, addres, contextID, ...) */
-       armv4_5_state_t core_state;             /* current core state (ARM, Thumb, Jazelle) */
-       struct image_s *image;                                  /* source for target opcodes */
-       u32 pipe_index;                                 /* current trace cycle */
-       u32 data_index;                                 /* cycle holding next data packet */
-       int data_half;                                  /* port half on a 16 bit port */
-       u32 current_pc;                                 /* current program counter */
-       u32 pc_ok;                                              /* full PC has been acquired */
-       u32 last_branch;                                /* last branch address output */
-       u32 last_branch_reason;                 /* branch reason code for the last branch encountered */
-       u32 last_ptr;                                   /* address of the last data access */
-       u32 ptr_ok;                                             /* whether last_ptr is valid */
-       u32 context_id;                                 /* context ID of the code being traced */
-       u32 last_instruction;                   /* index of last instruction executed (to calculate cycle timings) */
-} etm_context_t;
+       struct etmv1_trace_data *trace_data;    /* trace data */
+       uint32_t trace_depth;           /* number of cycles to be analyzed, 0 if no data available */
+       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 */
+       bool pc_ok;                     /* full PC has been acquired */
+       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) */
+};
 
 /* PIPESTAT values */
-typedef enum
-{
+typedef enum {
        STAT_IE = 0x0,
        STAT_ID = 0x1,
        STAT_IN = 0x2,
@@ -178,32 +200,23 @@ 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 */
        BR_NODEBUG = 0x3, /* ARM has exited for debug state */
-       BR_PERIOD  = 0x4, /* Peridioc synchronization point (ETM>=v1.2)*/
+       BR_PERIOD  = 0x4, /* Peridioc synchronization point (ETM >= v1.2)*/
        BR_RSVD5   = 0x5, /* reserved */
        BR_RSVD6   = 0x6, /* reserved */
        BR_RSVD7   = 0x7, /* reserved */
 } etmv1_branch_reason_t;
 
-extern char *etmv1v1_branch_reason_strings[];
+struct reg_cache *etm_build_reg_cache(struct target *target,
+               struct arm_jtag *jtag_info, struct etm_context *etm_ctx);
 
-extern reg_cache_t* etm_build_reg_cache(target_t *target, arm_jtag_t *jtag_info, etm_context_t *etm_ctx);
-extern int etm_read_reg(reg_t *reg);
-extern int etm_write_reg(reg_t *reg, u32 value);
-extern int etm_read_reg_w_check(reg_t *reg, uint8_t* check_value, uint8_t* check_mask);
-extern int etm_store_reg(reg_t *reg);
-extern int etm_set_reg(reg_t *reg, u32 value);
-extern int etm_set_reg_w_exec(reg_t *reg, uint8_t *buf);
-extern int etm_setup(target_t *target);
+int etm_setup(struct target *target);
 
-int etm_register_commands(struct command_context_s *cmd_ctx);
-int etm_register_user_commands(struct command_context_s *cmd_ctx);
-extern etm_context_t* etm_create_context(etm_portmode_t portmode, char *capture_driver_name);
+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)