- convert all files to unix line-ending
[openocd.git] / src / target / etm.h
index bfa1252b761ca4284da449754785a326c1d0b73e..da47ff13ab9f67b559b6f9f5ec79ba7d81ab783b 100644 (file)
-/***************************************************************************\r
- *   Copyright (C) 2005, 2007 by Dominic Rath                              *\r
- *   Dominic.Rath@gmx.de                                                   *\r
- *                                                                         *\r
- *   Copyright (C) 2007 by Vincent Palatin                                 *\r
- *   vincent.palatin_openocd@m4x.org                                       *\r
- *                                                                         *\r
- *   This program is free software; you can redistribute it and/or modify  *\r
- *   it under the terms of the GNU General Public License as published by  *\r
- *   the Free Software Foundation; either version 2 of the License, or     *\r
- *   (at your option) any later version.                                   *\r
- *                                                                         *\r
- *   This program is distributed in the hope that it will be useful,       *\r
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *\r
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *\r
- *   GNU General Public License for more details.                          *\r
- *                                                                         *\r
- *   You should have received a copy of the GNU General Public License     *\r
- *   along with this program; if not, write to the                         *\r
- *   Free Software Foundation, Inc.,                                       *\r
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *\r
- ***************************************************************************/\r
-#ifndef ETM_H\r
-#define ETM_H\r
-\r
-#include "image.h"\r
-#include "trace.h"\r
-#include "target.h"\r
-#include "register.h"\r
-#include "arm_jtag.h"\r
-\r
-#include "armv4_5.h"\r
-\r
-/* ETM registers (V1.3 protocol) */\r
-enum\r
-{\r
-       ETM_CTRL = 0x00,\r
-       ETM_CONFIG = 0x01,\r
-       ETM_TRIG_EVENT = 0x02,\r
-       ETM_MMD_CTRL = 0x03,\r
-       ETM_STATUS = 0x04,\r
-       ETM_SYS_CONFIG = 0x05,\r
-       ETM_TRACE_RESOURCE_CTRL = 0x06,\r
-       ETM_TRACE_EN_CTRL2 = 0x07,\r
-       ETM_TRACE_EN_EVENT = 0x08,\r
-       ETM_TRACE_EN_CTRL1 = 0x09,\r
-       ETM_FIFOFULL_REGION = 0x0a,\r
-       ETM_FIFOFULL_LEVEL = 0x0b,\r
-       ETM_VIEWDATA_EVENT = 0x0c,\r
-       ETM_VIEWDATA_CTRL1 = 0x0d,\r
-       ETM_VIEWDATA_CTRL2 = 0x0e,\r
-       ETM_VIEWDATA_CTRL3 = 0x0f,\r
-       ETM_ADDR_COMPARATOR_VALUE = 0x10,\r
-       ETM_ADDR_ACCESS_TYPE = 0x20,\r
-       ETM_DATA_COMPARATOR_VALUE = 0x30,\r
-       ETM_DATA_COMPARATOR_MASK = 0x40,\r
-       ETM_COUNTER_INITAL_VALUE = 0x50,\r
-       ETM_COUNTER_ENABLE = 0x54,\r
-       ETM_COUNTER_RELOAD_VALUE = 0x58,\r
-       ETM_COUNTER_VALUE = 0x5c,\r
-       ETM_SEQUENCER_CTRL = 0x60,\r
-       ETM_SEQUENCER_STATE = 0x67,\r
-       ETM_EXTERNAL_OUTPUT = 0x68,\r
-       ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,\r
-       ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,   \r
-};\r
-\r
-typedef struct etm_reg_s\r
-{\r
-       int addr;\r
-       arm_jtag_t *jtag_info;\r
-} etm_reg_t;\r
-\r
-typedef enum\r
-{\r
-       /* Port width */\r
-       ETM_PORT_4BIT           = 0x00,\r
-       ETM_PORT_8BIT           = 0x10,\r
-       ETM_PORT_16BIT          = 0x20,\r
-       ETM_PORT_WIDTH_MASK     = 0x70, \r
-       /* Port modes */\r
-       ETM_PORT_NORMAL    = 0x00000,\r
-       ETM_PORT_MUXED     = 0x10000,\r
-       ETM_PORT_DEMUXED   = 0x20000,\r
-       ETM_PORT_MODE_MASK = 0x30000,\r
-       /* Clocking modes */\r
-       ETM_PORT_FULL_CLOCK = 0x0000,\r
-       ETM_PORT_HALF_CLOCK = 0x1000,\r
-       ETM_PORT_CLOCK_MASK = 0x1000,\r
-} etm_portmode_t;\r
-\r
-typedef enum\r
-{\r
-       /* Data trace */\r
-       ETMV1_TRACE_NONE         = 0x00,\r
-       ETMV1_TRACE_DATA     = 0x01,\r
-       ETMV1_TRACE_ADDR     = 0x02,\r
-       ETMV1_TRACE_MASK     = 0x03,\r
-       /* ContextID */\r
-       ETMV1_CONTEXTID_NONE = 0x00,\r
-       ETMV1_CONTEXTID_8    = 0x10,\r
-       ETMV1_CONTEXTID_16   = 0x20,\r
-       ETMV1_CONTEXTID_32   = 0x30,\r
-       ETMV1_CONTEXTID_MASK = 0x30,\r
-       /* Misc */\r
-       ETMV1_CYCLE_ACCURATE = 0x100,\r
-       ETMV1_BRANCH_OUTPUT = 0x200\r
-} etmv1_tracemode_t;\r
-\r
-/* forward-declare ETM context */\r
-struct etm_context_s;\r
-\r
-typedef struct etm_capture_driver_s\r
-{\r
-       char *name;\r
-       int (*register_commands)(struct command_context_s *cmd_ctx);\r
-       int (*init)(struct etm_context_s *etm_ctx);\r
-       trace_status_t (*status)(struct etm_context_s *etm_ctx);\r
-       int (*read_trace)(struct etm_context_s *etm_ctx);\r
-       int (*start_capture)(struct etm_context_s *etm_ctx);\r
-       int (*stop_capture)(struct etm_context_s *etm_ctx);\r
-} etm_capture_driver_t;\r
-\r
-enum\r
-{\r
-       ETMV1_TRACESYNC_CYCLE = 0x1,\r
-       ETMV1_TRIGGER_CYCLE = 0x2,\r
-};\r
-\r
-typedef struct etmv1_trace_data_s\r
-{\r
-       u8 pipestat;    /* bits 0-2 pipeline status */\r
-       u16 packet;             /* packet data (4, 8 or 16 bit) */\r
-       int flags;              /* ETMV1_TRACESYNC_CYCLE, ETMV1_TRIGGER_CYCLE */\r
-} etmv1_trace_data_t;\r
-\r
-/* describe a trace context\r
- * if support for ETMv2 or ETMv3 is to be implemented,\r
- * this will have to be split into version independent elements\r
- * and a version specific part\r
- */\r
-typedef struct etm_context_s\r
-{\r
-       target_t *target;                               /* target this ETM is connected to */\r
-       reg_cache_t *reg_cache;                 /* ETM register cache */\r
-       etm_capture_driver_t *capture_driver;   /* driver used to access ETM data */\r
-       void *capture_driver_priv;              /* capture driver private data */\r
-       u32 trigger_percent;                    /* percent of trace buffer to be filled after the trigger */\r
-       trace_status_t capture_status;  /* current state of capture run */ \r
-       etmv1_trace_data_t *trace_data; /* trace data */\r
-       u32 trace_depth;                                /* number of trace cycles to be analyzed, 0 if no trace data available */\r
-       etm_portmode_t portmode;                /* normal, multiplexed or demultiplexed */\r
-       etmv1_tracemode_t tracemode;    /* type of information the trace contains (data, addres, contextID, ...) */ \r
-       armv4_5_state_t core_state;             /* current core state (ARM, Thumb, Jazelle) */\r
-       image_t *image;                                 /* source for target opcodes */\r
-       u32 pipe_index;                                 /* current trace cycle */\r
-       u32 data_index;                                 /* cycle holding next data packet */\r
-       int data_half;                                  /* port half on a 16 bit port */\r
-       u32 current_pc;                                 /* current program counter */\r
-       u32 pc_ok;                                              /* full PC has been acquired */\r
-       u32 last_branch;                                /* last branch address output */ \r
-       u32 last_branch_reason;                 /* branch reason code for the last branch encountered */\r
-       u32 last_ptr;                                   /* address of the last data access */\r
-       u32 ptr_ok;                                             /* whether last_ptr is valid */ \r
-       u32 context_id;                                 /* context ID of the code being traced */\r
-       u32 last_instruction;                   /* index of last instruction executed (to calculate cycle timings) */\r
-} etm_context_t;\r
-\r
-/* PIPESTAT values */\r
-typedef enum\r
-{\r
-       STAT_IE = 0x0,\r
-       STAT_ID = 0x1,\r
-       STAT_IN = 0x2,\r
-       STAT_WT = 0x3,\r
-       STAT_BE = 0x4,\r
-       STAT_BD = 0x5,\r
-       STAT_TR = 0x6,\r
-       STAT_TD = 0x7\r
-} etmv1_pipestat_t;\r
-\r
-/* branch reason values */\r
-typedef enum\r
-{\r
-       BR_NORMAL  = 0x0, /* Normal PC change : periodic synchro (ETMv1.1) */\r
-       BR_ENABLE  = 0x1, /* Trace has been enabled */\r
-       BR_RESTART = 0x2, /* Trace restarted after a FIFO overflow */\r
-       BR_NODEBUG = 0x3, /* ARM has exited for debug state */\r
-       BR_PERIOD  = 0x4, /* Peridioc synchronization point (ETM>=v1.2)*/\r
-       BR_RSVD5   = 0x5, /* reserved */\r
-       BR_RSVD6   = 0x6, /* reserved */\r
-       BR_RSVD7   = 0x7, /* reserved */\r
-} etmv1_branch_reason_t;\r
-\r
-extern char *etmv1v1_branch_reason_strings[];\r
-\r
-extern reg_cache_t* etm_build_reg_cache(target_t *target, arm_jtag_t *jtag_info, etm_context_t *etm_ctx);\r
-extern int etm_read_reg(reg_t *reg);\r
-extern int etm_write_reg(reg_t *reg, u32 value);\r
-extern int etm_read_reg_w_check(reg_t *reg, u8* check_value, u8* check_mask);\r
-extern int etm_store_reg(reg_t *reg);\r
-extern int etm_set_reg(reg_t *reg, u32 value);\r
-extern int etm_set_reg_w_exec(reg_t *reg, u8 *buf);\r
-\r
-int etm_register_commands(struct command_context_s *cmd_ctx);\r
-int etm_register_user_commands(struct command_context_s *cmd_ctx);\r
-extern etm_context_t* etm_create_context(etm_portmode_t portmode, char *capture_driver_name);\r
-\r
-#define ERROR_ETM_INVALID_DRIVER       (-1300)\r
-#define ERROR_ETM_PORTMODE_NOT_SUPPORTED       (-1301)\r
-#define ERROR_ETM_CAPTURE_INIT_FAILED  (-1302)\r
-#define ERROR_ETM_ANALYSIS_FAILED      (-1303)\r
-\r
-#endif /* ETM_H */\r
+/***************************************************************************
+ *   Copyright (C) 2005, 2007 by Dominic Rath                              *
+ *   Dominic.Rath@gmx.de                                                   *
+ *                                                                         *
+ *   Copyright (C) 2007 by Vincent Palatin                                 *
+ *   vincent.palatin_openocd@m4x.org                                       *
+ *                                                                         *
+ *   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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifndef ETM_H
+#define ETM_H
+
+#include "image.h"
+#include "trace.h"
+#include "target.h"
+#include "register.h"
+#include "arm_jtag.h"
+
+#include "armv4_5.h"
+
+/* ETM registers (V1.3 protocol) */
+enum
+{
+       ETM_CTRL = 0x00,
+       ETM_CONFIG = 0x01,
+       ETM_TRIG_EVENT = 0x02,
+       ETM_MMD_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,
+       ETM_FIFOFULL_REGION = 0x0a,
+       ETM_FIFOFULL_LEVEL = 0x0b,
+       ETM_VIEWDATA_EVENT = 0x0c,
+       ETM_VIEWDATA_CTRL1 = 0x0d,
+       ETM_VIEWDATA_CTRL2 = 0x0e,
+       ETM_VIEWDATA_CTRL3 = 0x0f,
+       ETM_ADDR_COMPARATOR_VALUE = 0x10,
+       ETM_ADDR_ACCESS_TYPE = 0x20,
+       ETM_DATA_COMPARATOR_VALUE = 0x30,
+       ETM_DATA_COMPARATOR_MASK = 0x40,
+       ETM_COUNTER_INITAL_VALUE = 0x50,
+       ETM_COUNTER_ENABLE = 0x54,
+       ETM_COUNTER_RELOAD_VALUE = 0x58,
+       ETM_COUNTER_VALUE = 0x5c,
+       ETM_SEQUENCER_CTRL = 0x60,
+       ETM_SEQUENCER_STATE = 0x67,
+       ETM_EXTERNAL_OUTPUT = 0x68,
+       ETM_CONTEXTID_COMPARATOR_VALUE = 0x6c,
+       ETM_CONTEXTID_COMPARATOR_MASK = 0x6f,   
+};
+
+typedef struct etm_reg_s
+{
+       int addr;
+       arm_jtag_t *jtag_info;
+} etm_reg_t;
+
+typedef enum
+{
+       /* Port width */
+       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;
+
+/* 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
+{
+       ETMV1_TRACESYNC_CYCLE = 0x1,
+       ETMV1_TRIGGER_CYCLE = 0x2,
+};
+
+typedef struct etmv1_trace_data_s
+{
+       u8 pipestat;    /* bits 0-2 pipeline status */
+       u16 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 */
+       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) */
+       image_t *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;
+
+/* PIPESTAT values */
+typedef enum
+{
+       STAT_IE = 0x0,
+       STAT_ID = 0x1,
+       STAT_IN = 0x2,
+       STAT_WT = 0x3,
+       STAT_BE = 0x4,
+       STAT_BD = 0x5,
+       STAT_TR = 0x6,
+       STAT_TD = 0x7
+} etmv1_pipestat_t;
+
+/* branch reason values */
+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_RSVD5   = 0x5, /* reserved */
+       BR_RSVD6   = 0x6, /* reserved */
+       BR_RSVD7   = 0x7, /* reserved */
+} etmv1_branch_reason_t;
+
+extern char *etmv1v1_branch_reason_strings[];
+
+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, u8* check_value, u8* 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, u8 *buf);
+
+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);
+
+#define ERROR_ETM_INVALID_DRIVER       (-1300)
+#define ERROR_ETM_PORTMODE_NOT_SUPPORTED       (-1301)
+#define ERROR_ETM_CAPTURE_INIT_FAILED  (-1302)
+#define ERROR_ETM_ANALYSIS_FAILED      (-1303)
+
+#endif /* ETM_H */

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)