arm7_9_common.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   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                                                        *
 ***************************************************************************/
 
#ifndef OPENOCD_TARGET_ARM7_9_COMMON_H
#define OPENOCD_TARGET_ARM7_9_COMMON_H
 
#include "arm.h"
#include "arm_jtag.h"
 
#define ARM7_9_COMMON_MAGIC 0x0a790a79U 
struct arm7_9_common {
    unsigned int common_magic;
 
    struct arm arm;
 
    struct arm_jtag jtag_info; 
    struct reg_cache *eice_cache; 
    uint32_t arm_bkpt; 
    uint16_t thumb_bkpt; 
    int sw_breakpoints_added; 
    int sw_breakpoint_count; 
    int breakpoint_count; 
    int wp_available; 
    int wp_available_max; 
    int wp0_used; 
    int wp1_used; 
    int wp1_used_default; 
    int dbgreq_adjust_pc; 
    bool use_dbgrq; 
    bool need_bypass_before_restart; 
    bool has_single_step;
    bool has_monitor_mode;
    bool has_vector_catch; 
    bool debug_entry_from_reset; 
    bool fast_memory_access;
    bool dcc_downloads;
 
    struct working_area *dcc_working_area;
 
    int (*examine_debug_reason)(struct target *target);
    void (*change_to_arm)(struct target *target, uint32_t *r0, uint32_t *pc);
    void (*read_core_regs)(struct target *target, uint32_t mask, uint32_t *core_regs[16]);
    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);
    void (*write_xpsr)(struct target *target, uint32_t xpsr, int spsr);
    void (*write_xpsr_im8)(struct target *target, uint8_t xpsr_im, int rot, int 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);
 
    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);
 
    void (*write_pc)(struct target *target, uint32_t pc);
    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);
    int (*post_debug_entry)(struct target *target);
    void (*pre_restore_context)(struct target *target);
    int (*write_memory)(struct target *target, target_addr_t address,
            uint32_t size, uint32_t count, const uint8_t *buffer);
    int (*bulk_write_memory)(struct target *target, target_addr_t address,
            uint32_t count, const uint8_t *buffer);
};
 
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)
{
    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_halt(struct target *target);
int arm7_9_resume(struct target *target, int current, target_addr_t address,
        int handle_breakpoints, int debug_execution);
int arm7_9_step(struct target *target, int current, target_addr_t address,
        int handle_breakpoints);
int arm7_9_read_memory(struct target *target, target_addr_t address,
        uint32_t size, uint32_t count, uint8_t *buffer);
int arm7_9_write_memory(struct target *target, target_addr_t address,
        uint32_t size, uint32_t count, const uint8_t *buffer);
int arm7_9_write_memory_opt(struct target *target, target_addr_t address,
        uint32_t size, uint32_t count, const uint8_t *buffer);
int arm7_9_write_memory_no_opt(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, target_addr_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);
void arm7_9_deinit(struct target *target);
int arm7_9_check_reset(struct target *target);
 
int arm7_9_endianness_callback(jtag_callback_data_t pu8_in,
        jtag_callback_data_t i_size, jtag_callback_data_t i_be,
        jtag_callback_data_t i_flip);
 
#endif /* OPENOCD_TARGET_ARM7_9_COMMON_H */