Ensure Cortex-M reset wakes device from sleep (wfi/wfe)
[fw/openocd] / src / target / arm11.h
index aa36b2934d74e1735ab13681cc5778a0042a8595..fd7af157a2f98ec2a3e1a76a01b8b1372ffdac4f 100644 (file)
 #ifndef ARM11_H
 #define ARM11_H
 
-#include "target.h"
-#include "register.h"
-#include "jtag.h"
-
-#define asizeof(x)     (sizeof(x) / sizeof((x)[0]))
-
-#define NEW(type, variable, items)                     \
-       type * variable = calloc(1, sizeof(type) * items)
+#include "arm.h"
+#include "arm_dpm.h"
+
+#define ARM11_TAP_DEFAULT                       TAP_INVALID
+
+#define CHECK_RETVAL(action)                   \
+       do {                                    \
+               int __retval = (action);        \
+               if (__retval != ERROR_OK) {     \
+                       LOG_DEBUG("error while calling \"%s\"", \
+                               # action);     \
+                       return __retval;        \
+               }                               \
+       } while (0)
+
+/* bits from ARMv7 DIDR */
+enum arm11_debug_version {
+       ARM11_DEBUG_V6                  = 0x01,
+       ARM11_DEBUG_V61                 = 0x02,
+       ARM11_DEBUG_V7                  = 0x03,
+       ARM11_DEBUG_V7_CP14             = 0x04,
+};
 
-/* For MinGW use 'I' prefix to print size_t (instead of 'z') */
+struct arm11_common {
+       struct arm arm;
 
-#ifndef __MSVCRT__
-#define ZU             "%zu"
-#else
-#define ZU             "%Iu"
-#endif
+       /** Debug module state. */
+       struct arm_dpm dpm;
+       struct arm11_sc7_action *bpwp_actions;
+       unsigned bpwp_n;
 
-#define ARM11_REGCACHE_MODEREGS                0
-#define ARM11_REGCACHE_FREGS           0
+       size_t brp;                     /**< Number of Breakpoint Register Pairs from DIDR      */
+       size_t free_brps;               /**< Number of breakpoints allocated */
 
-#define ARM11_REGCACHE_COUNT           (20 +                                   \
-                                        23 * ARM11_REGCACHE_MODEREGS +                 \
-                                         9 * ARM11_REGCACHE_FREGS)
+       uint32_t dscr;                  /**< Last retrieved DSCR value. */
 
-#define ARM11_TAP_DEFAULT                      TAP_INVALID
+       uint32_t saved_rdtr;
+       uint32_t saved_wdtr;
 
+       bool is_rdtr_saved;
+       bool is_wdtr_saved;
 
-#define CHECK_RETVAL(action)                                                           \
-do {                                                                                                           \
-       int __retval = (action);                                                                \
-                                                                                                                       \
-       if (__retval != ERROR_OK)                                                               \
-       {                                                                                                               \
-               LOG_DEBUG("error while calling \"" # action "\"");      \
-               return __retval;                                                                        \
-       }                                                                                                               \
-                                                                                                                       \
-} while (0)
+       bool simulate_reset_on_next_halt;       /**< Perform cleanups of the ARM state on next halt **/
 
+       /* Per-core configurable options.
+        * NOTE that several of these boolean options should not exist
+        * once the relevant code is known to work correctly.
+        */
+       bool memwrite_burst;
+       bool memwrite_error_fatal;
+       bool step_irq_enable;
+       bool hardware_step;
 
-typedef struct arm11_register_history_s
-{
-       uint32_t                value;
-       uint8_t         valid;
-}arm11_register_history_t;
+       /** Configured Vector Catch Register settings. */
+       uint32_t vcr;
 
-enum arm11_debug_version
-{
-       ARM11_DEBUG_V6                  = 0x01,
-       ARM11_DEBUG_V61                 = 0x02,
-       ARM11_DEBUG_V7                  = 0x03,
-       ARM11_DEBUG_V7_CP14             = 0x04,
+       struct arm_jtag jtag_info;
 };
 
-typedef struct arm11_common_s
+static inline struct arm11_common *target_to_arm11(struct target *target)
 {
-       target_t *      target;         /**< Reference back to the owner */
-
-       /** \name Processor type detection */
-       /*@{*/
-
-       uint32_t                device_id;              /**< IDCODE readout                             */
-       uint32_t                didr;                   /**< DIDR readout (debug capabilities)  */
-       uint8_t         implementor;    /**< DIDR Implementor readout           */
-
-       size_t  brp;                    /**< Number of Breakpoint Register Pairs from DIDR      */
-       size_t  wrp;                    /**< Number of Watchpoint Register Pairs from DIDR      */
-
-       enum arm11_debug_version
-               debug_version;          /**< ARM debug architecture from DIDR   */
-       /*@}*/
-
-       uint32_t                last_dscr;              /**< Last retrieved DSCR value;
-                                                            Use only for debug message generation              */
-
-       bool    trst_active;
-       bool    halt_requested;                                 /**< Keep track if arm11_halt() calls occured
-                                                                                                during reset. Otherwise do it ASAP. */
-
-       bool    simulate_reset_on_next_halt;    /**< Perform cleanups of the ARM state on next halt */
-
-       /** \name Shadow registers to save processor state */
-       /*@{*/
-
-       reg_t * reg_list;                                                       /**< target register list */
-       uint32_t                reg_values[ARM11_REGCACHE_COUNT];       /**< data for registers */
-
-       /*@}*/
-
-       arm11_register_history_t
-               reg_history[ARM11_REGCACHE_COUNT];      /**< register state before last resume */
-
-       size_t  free_brps;                              /**< keep track of breakpoints allocated by arm11_add_breakpoint() */
-       size_t  free_wrps;                              /**< keep track of breakpoints allocated by arm11_add_watchpoint() */
-
-       // GA
-       reg_cache_t *core_cache;
-} arm11_common_t;
-
+       return container_of(target->arch_info, struct arm11_common, arm);
+}
 
 /**
  * ARM11 DBGTAP instructions
  *
  * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/I1006229.html
  */
-enum arm11_instructions
-{
+enum arm11_instructions {
        ARM11_EXTEST    = 0x00,
        ARM11_SCAN_N    = 0x02,
        ARM11_RESTART   = 0x04,
-       ARM11_HALT          = 0x08,
+       ARM11_HALT          = 0x08,
        ARM11_INTEST    = 0x0C,
        ARM11_ITRSEL    = 0x1D,
        ARM11_IDCODE    = 0x1E,
        ARM11_BYPASS    = 0x1F,
 };
 
-enum arm11_dscr
-{
-       ARM11_DSCR_CORE_HALTED                                                                  = 1 << 0,
-       ARM11_DSCR_CORE_RESTARTED                                                               = 1 << 1,
-
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK                                   = 0x0F << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT                                   = 0x00 << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT                             = 0x01 << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT                             = 0x02 << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION               = 0x03 << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ                                 = 0x04 << 2,
-       ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH                   = 0x05 << 2,
-
-       ARM11_DSCR_STICKY_PRECISE_DATA_ABORT                                    = 1 << 6,
-       ARM11_DSCR_STICKY_IMPRECISE_DATA_ABORT                                  = 1 << 7,
-       ARM11_DSCR_INTERRUPTS_DISABLE                                                   = 1 << 11,
-       ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE                               = 1 << 13,
-       ARM11_DSCR_MODE_SELECT                                                                  = 1 << 14,
-       ARM11_DSCR_WDTR_FULL                                                                    = 1 << 29,
-       ARM11_DSCR_RDTR_FULL                                                                    = 1 << 30,
-};
-
-enum arm11_cpsr
-{
-       ARM11_CPSR_T                            = 1 << 5,
-       ARM11_CPSR_J                            = 1 << 24,
-};
-
-enum arm11_sc7
-{
-       ARM11_SC7_NULL                          = 0,
-       ARM11_SC7_VCR                           = 7,
-       ARM11_SC7_PC                            = 8,
-       ARM11_SC7_BVR0                          = 64,
-       ARM11_SC7_BCR0                          = 80,
-       ARM11_SC7_WVR0                          = 96,
-       ARM11_SC7_WCR0                          = 112,
+enum arm11_sc7 {
+       ARM11_SC7_NULL                          = 0,
+       ARM11_SC7_VCR                           = 7,
+       ARM11_SC7_PC                            = 8,
+       ARM11_SC7_BVR0                          = 64,
+       ARM11_SC7_BCR0                          = 80,
+       ARM11_SC7_WVR0                          = 96,
+       ARM11_SC7_WCR0                          = 112,
 };
 
-typedef struct arm11_reg_state_s
-{
-       uint32_t                                def_index;
-       target_t *                      target;
-} arm11_reg_state_t;
-
-/* poll current target status */
-int arm11_poll(struct target_s *target);
-/* architecture specific status reply */
-int arm11_arch_state(struct target_s *target);
-
-/* target request support */
-int arm11_target_request_data(struct target_s *target, uint32_t size, uint8_t *buffer);
-
-/* target execution control */
-int arm11_halt(struct target_s *target);
-int arm11_resume(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
-int arm11_step(struct target_s *target, int current, uint32_t address, int handle_breakpoints);
-int arm11_examine(struct target_s *target);
-
-/* target reset control */
-int arm11_assert_reset(struct target_s *target);
-int arm11_deassert_reset(struct target_s *target);
-int arm11_soft_reset_halt(struct target_s *target);
-
-/* target register access for gdb */
-int arm11_get_gdb_reg_list(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
-
-/* target memory access
-* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
-* count: number of items of <size>
-*/
-int arm11_read_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
-int arm11_write_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
-
-/* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
-int arm11_bulk_write_memory(struct target_s *target, uint32_t address, uint32_t count, uint8_t *buffer);
-
-int arm11_checksum_memory(struct target_s *target, uint32_t address, uint32_t count, uint32_t* checksum);
-
-/* target break-/watchpoint control
-* rw: 0 = write, 1 = read, 2 = access
-*/
-int arm11_add_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
-int arm11_remove_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
-int arm11_add_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
-int arm11_remove_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
-
-/* target algorithm support */
-int arm11_run_algorithm(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info);
-
-int arm11_register_commands(struct command_context_s *cmd_ctx);
-int arm11_target_create(struct target_s *target, Jim_Interp *interp);
-int arm11_init_target(struct command_context_s *cmd_ctx, struct target_s *target);
-int arm11_quit(void);
-
-/* helpers */
-int arm11_build_reg_cache(target_t *target);
-int arm11_set_reg(reg_t *reg, uint8_t *buf);
-int arm11_get_reg(reg_t *reg);
-
-void arm11_record_register_history(arm11_common_t * arm11);
-void arm11_dump_reg_changes(arm11_common_t * arm11);
-
-/* internals */
-
-void arm11_setup_field                 (arm11_common_t * arm11, int num_bits, void * in_data, void * out_data, scan_field_t * field);
-void arm11_add_IR                              (arm11_common_t * arm11, uint8_t instr, tap_state_t state);
-void arm11_add_debug_SCAN_N            (arm11_common_t * arm11, uint8_t chain, tap_state_t state);
-void arm11_add_debug_INST              (arm11_common_t * arm11, uint32_t inst, uint8_t * flag, tap_state_t state);
-int arm11_read_DSCR                            (arm11_common_t * arm11, uint32_t *dscr);
-int arm11_write_DSCR                   (arm11_common_t * arm11, uint32_t dscr);
-
-enum target_debug_reason arm11_get_DSCR_debug_reason(uint32_t dscr);
-
-void arm11_run_instr_data_prepare                      (arm11_common_t * arm11);
-void arm11_run_instr_data_finish                       (arm11_common_t * arm11);
-int arm11_run_instr_no_data                                    (arm11_common_t * arm11, uint32_t * opcode, size_t count);
-int arm11_run_instr_no_data1                           (arm11_common_t * arm11, uint32_t opcode);
-int arm11_run_instr_data_to_core                       (arm11_common_t * arm11, uint32_t opcode, uint32_t * data, size_t count);
-int arm11_run_instr_data_to_core_noack         (arm11_common_t * arm11, uint32_t opcode, uint32_t * data, size_t count);
-int arm11_run_instr_data_to_core1                      (arm11_common_t * arm11, uint32_t opcode, uint32_t data);
-int arm11_run_instr_data_from_core                     (arm11_common_t * arm11, uint32_t opcode, uint32_t * data, size_t count);
-int arm11_run_instr_data_from_core_via_r0      (arm11_common_t * arm11, uint32_t opcode, uint32_t * data);
-void arm11_run_instr_data_to_core_via_r0       (arm11_common_t * arm11, uint32_t opcode, uint32_t data);
-
-int arm11_add_dr_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state);
-int arm11_add_ir_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state);
-
-/** Used to make a list of read/write commands for scan chain 7
- *
- *  Use with arm11_sc7_run()
- */
-typedef struct arm11_sc7_action_s
-{
-       bool    write;                          /**< Access mode: true for write, false for read.       */
-       uint8_t         address;                        /**< Register address mode. Use enum #arm11_sc7         */
-       uint32_t                value;                          /**< If write then set this to value to be written.
-                                                                        In read mode this receives the read value when the
-                                                                        function returns.                                      */
-} arm11_sc7_action_t;
-
-int arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t count);
-
-/* Mid-level helper functions */
-void arm11_sc7_clear_vbw(arm11_common_t * arm11);
-void arm11_sc7_set_vcr(arm11_common_t * arm11, uint32_t value);
-
-int arm11_read_memory_word(arm11_common_t * arm11, uint32_t address, uint32_t * result);
-
-#endif /* ARM11_H */
+#endif /* ARM11_H */