cleanup: rename armv4_5 to arm for readability
[openocd.git] / src / target / arm7_9_common.h
index e77bedac0190da377837d8944b2f206ea9cded30..536f561770e76e6078900188a8013da38d26b418 100644 (file)
@@ -2,6 +2,15 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
+ *   Copyright (C) 2008 by Hongtao Zheng                                   *
+ *   hontor@126.com                                                        *
+ *                                                                         *
  *   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     *
 #ifndef ARM7_9_COMMON_H
 #define ARM7_9_COMMON_H
 
-#include "armv4_5.h"
+#include "arm.h"
 #include "arm_jtag.h"
-#include "breakpoints.h"
-#include "target.h"
 
-#include "etb.h"
+#define        ARM7_9_COMMON_MAGIC 0x0a790a79 /**< */
+
+/**
+ * Structure for items that are common between both ARM7 and ARM9 targets.
+ */
+struct arm7_9_common
+{
+       struct arm arm;
+       uint32_t common_magic;
+
+       struct arm_jtag jtag_info; /**< JTAG information for target */
+       struct reg_cache *eice_cache; /**< Embedded ICE register cache */
+
+       uint32_t arm_bkpt; /**< ARM breakpoint instruction */
+       uint16_t thumb_bkpt; /**< Thumb breakpoint instruction */
+
+       int sw_breakpoints_added; /**< Specifies which watchpoint software breakpoints are setup on */
+       int sw_breakpoint_count; /**< keep track of number of software breakpoints we have set */
+       int breakpoint_count; /**< Current number of set breakpoints */
+       int wp_available; /**< Current number of available watchpoint units */
+       int wp_available_max; /**< Maximum number of available watchpoint units */
+       int wp0_used; /**< Specifies if and how watchpoint unit 0 is used */
+       int wp1_used; /**< Specifies if and how watchpoint unit 1 is used */
+       int wp1_used_default; /**< Specifies if and how watchpoint unit 1 is used by default */
+       int dbgreq_adjust_pc; /**< Amount of PC adjustment caused by a DBGREQ */
+       bool use_dbgrq; /**< Specifies if DBGRQ should be used to halt the target */
+       bool need_bypass_before_restart; /**< Specifies if there should be a bypass before a JTAG restart */
+
+       bool has_single_step;
+       bool has_monitor_mode;
+       bool has_vector_catch; /**< Specifies if the target has a reset vector catch */
+
+       bool debug_entry_from_reset; /**< Specifies if debug entry was from a reset */
+
+       bool fast_memory_access;
+       bool dcc_downloads;
+
+       struct working_area *dcc_working_area;
+
+       int (*examine_debug_reason)(struct target *target); /**< Function for determining why debug state was entered */
+
+       void (*change_to_arm)(struct target *target, uint32_t *r0, uint32_t *pc); /**< Function for changing from Thumb to ARM mode */
+
+       void (*read_core_regs)(struct target *target, uint32_t mask, uint32_t *core_regs[16]); /**< Function for reading the core registers */
+       void (*read_core_regs_target_buffer)(struct target *target, uint32_t mask, void *buffer, int size);
+       void (*read_xpsr)(struct target *target, uint32_t *xpsr, int spsr); /**< Function for reading CPSR or SPSR */
+
+       void (*write_xpsr)(struct target *target, uint32_t xpsr, int spsr); /**< Function for writing to CPSR or SPSR */
+       void (*write_xpsr_im8)(struct target *target, uint8_t xpsr_im, int rot, int spsr); /**< Function for writing an immediate value to CPSR or SPSR */
+       void (*write_core_regs)(struct target *target, uint32_t mask, uint32_t core_regs[16]);
+
+       void (*load_word_regs)(struct target *target, uint32_t mask);
+       void (*load_hword_reg)(struct target *target, int num);
+       void (*load_byte_reg)(struct target *target, int num);
 
-#define        ARM7_9_COMMON_MAGIC 0x0a790a79
+       void (*store_word_regs)(struct target *target, uint32_t mask);
+       void (*store_hword_reg)(struct target *target, int num);
+       void (*store_byte_reg)(struct target *target, int num);
 
-typedef struct arm7_9_common_s
+       void (*write_pc)(struct target *target, uint32_t pc); /**< Function for writing to the program counter */
+       void (*branch_resume)(struct target *target);
+       void (*branch_resume_thumb)(struct target *target);
+
+       void (*enable_single_step)(struct target *target, uint32_t next_pc);
+       void (*disable_single_step)(struct target *target);
+
+       void (*set_special_dbgrq)(struct target *target); /**< Function for setting DBGRQ if the normal way won't work */
+
+       int (*post_debug_entry)(struct target *target); /**< Callback function called after entering debug mode */
+
+       void (*pre_restore_context)(struct target *target); /**< Callback function called before restoring the processor context */
+};
+
+static inline struct arm7_9_common *
+target_to_arm7_9(struct target *target)
+{
+       return container_of(target->arch_info, struct arm7_9_common,
+                       arm);
+}
+
+static inline bool is_arm7_9(struct arm7_9_common *arm7_9)
 {
-       int common_magic;
-       
-       arm_jtag_t jtag_info;
-       reg_cache_t *eice_cache;
-       reg_cache_t *etm_cache;
-       
-       u32 arm_bkpt;
-       u16 thumb_bkpt;
-       int sw_bkpts_use_wp;
-       int wp_available;
-       int wp0_used;
-       int wp1_used;
-       int sw_bkpts_enabled;
-       int force_hw_bkpts;
-       int dbgreq_adjust_pc;
-       int use_dbgrq;
-       
-       int has_etm;
-       etb_t *etb;
-       int has_single_step;
-       int has_monitor_mode;
-       int has_vector_catch;
-       
-       int reinit_embeddedice;
-       int debug_entry_from_reset;
-       
-       struct working_area_s *dcc_working_area;
-       
-       int fast_memory_access;
-       int dcc_downloads;
-
-       int (*examine_debug_reason)(target_t *target);
-       
-       void (*change_to_arm)(target_t *target, u32 *r0, u32 *pc);
-       
-       void (*read_core_regs)(target_t *target, u32 mask, u32 *core_regs[16]);
-       void (*read_core_regs_target_buffer)(target_t *target, u32 mask, void *buffer, int size);
-       void (*read_xpsr)(target_t *target, u32 *xpsr, int spsr);
-       
-       void (*write_xpsr)(target_t *target, u32 xpsr, int spsr);
-       void (*write_xpsr_im8)(target_t *target, u8 xpsr_im, int rot, int spsr);
-       void (*write_core_regs)(target_t *target, u32 mask, u32 core_regs[16]);
-       
-       void (*load_word_regs)(target_t *target, u32 mask);
-       void (*load_hword_reg)(target_t *target, int num);
-       void (*load_byte_reg)(target_t *target, int num);
-
-       void (*store_word_regs)(target_t *target, u32 mask);
-       void (*store_hword_reg)(target_t *target, int num);
-       void (*store_byte_reg)(target_t *target, int num);
-       
-       void (*write_pc)(target_t *target, u32 pc);
-       void (*branch_resume)(target_t *target);
-       void (*branch_resume_thumb)(target_t *target);
-       
-       void (*enable_single_step)(target_t *target);
-       void (*disable_single_step)(target_t *target);
-       
-       void (*pre_debug_entry)(target_t *target);
-       void (*post_debug_entry)(target_t *target);
-       
-       void (*pre_restore_context)(target_t *target);
-       void (*post_restore_context)(target_t *target);
-       
-       armv4_5_common_t armv4_5_common;
-       void *arch_info;
-
-} arm7_9_common_t;
-
-int arm7_9_register_commands(struct command_context_s *cmd_ctx);
-
-enum target_state arm7_9_poll(target_t *target);
-
-int arm7_9_assert_reset(target_t *target);
-int arm7_9_deassert_reset(target_t *target);
-int arm7_9_reset_request_halt(target_t *target);
-int arm7_9_early_halt(target_t *target);
-int arm7_9_soft_reset_halt(struct target_s *target);
-int arm7_9_prepare_reset_halt(struct target_s *target);
-
-int arm7_9_halt(target_t *target);
-int arm7_9_debug_entry(target_t *target);
-int arm7_9_full_context(target_t *target);
-int arm7_9_resume(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
-int arm7_9_step(struct target_s *target, int current, u32 address, int handle_breakpoints);
-int arm7_9_read_core_reg(struct target_s *target, int num, enum armv4_5_mode mode);
-int arm7_9_read_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
-int arm7_9_write_memory(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
-int arm7_9_bulk_write_memory(target_t *target, u32 address, u32 count, u8 *buffer);
-
-int arm7_9_run_algorithm(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_prams, reg_param_t *reg_param, u32 entry_point, void *arch_info);
-
-int arm7_9_add_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
-int arm7_9_remove_breakpoint(struct target_s *target, breakpoint_t *breakpoint);
-int arm7_9_add_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
-int arm7_9_remove_watchpoint(struct target_s *target, watchpoint_t *watchpoint);
-
-void arm7_9_enable_eice_step(target_t *target);
-void arm7_9_disable_eice_step(target_t *target);
-
-int arm7_9_execute_sys_speed(struct target_s *target);
-
-int arm7_9_init_arch_info(target_t *target, arm7_9_common_t *arm7_9);
-int arm7_9_get_arch_pointers(target_t *target, armv4_5_common_t **armv4_5_p, arm7_9_common_t **arm7_9_p);
+       return arm7_9->common_magic == ARM7_9_COMMON_MAGIC;
+}
+
+extern const struct command_registration arm7_9_command_handlers[];
+
+int arm7_9_poll(struct target *target);
+
+int arm7_9_target_request_data(struct target *target, uint32_t size, uint8_t *buffer);
+
+int arm7_9_assert_reset(struct target *target);
+int arm7_9_deassert_reset(struct target *target);
+int arm7_9_reset_request_halt(struct target *target);
+int arm7_9_early_halt(struct target *target);
+int arm7_9_soft_reset_halt(struct target *target);
+int arm7_9_prepare_reset_halt(struct target *target);
+
+int arm7_9_halt(struct target *target);
+int arm7_9_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
+int arm7_9_step(struct target *target, int current, uint32_t address, int handle_breakpoints);
+int arm7_9_read_memory(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
+int arm7_9_write_memory(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
+int arm7_9_bulk_write_memory(struct target *target, uint32_t address, uint32_t count, const uint8_t *buffer);
+
+int arm7_9_run_algorithm(struct target *target, int num_mem_params, struct mem_param *mem_params, int num_reg_prams, struct reg_param *reg_param, uint32_t entry_point, void *arch_info);
+
+int arm7_9_add_breakpoint(struct target *target, struct breakpoint *breakpoint);
+int arm7_9_remove_breakpoint(struct target *target, struct breakpoint *breakpoint);
+int arm7_9_add_watchpoint(struct target *target, struct watchpoint *watchpoint);
+int arm7_9_remove_watchpoint(struct target *target, struct watchpoint *watchpoint);
+
+void arm7_9_enable_eice_step(struct target *target, uint32_t next_pc);
+void arm7_9_disable_eice_step(struct target *target);
+
+int arm7_9_execute_sys_speed(struct target *target);
 
+int arm7_9_init_arch_info(struct target *target, struct arm7_9_common *arm7_9);
+int arm7_9_examine(struct target *target);
+int arm7_9_check_reset(struct target *target);
 
 #endif /* ARM7_9_COMMON_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)