arm.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) 2008 by Spencer Oliver
 * spen@spen-soft.co.uk
 *
 * Copyright (C) 2009 by Øyvind Harboe
 * oyvind.harboe@zylin.com
 *
 * Copyright (C) 2018 by Liviu Ionescu
 *   <ilg@livius.net>
 */
 
#ifndef OPENOCD_TARGET_ARM_H
#define OPENOCD_TARGET_ARM_H
 
#include <helper/command.h>
#include "target.h"
 
enum arm_core_type {
    ARM_CORE_TYPE_STD = -1,
    ARM_CORE_TYPE_SEC_EXT = 1,
    ARM_CORE_TYPE_VIRT_EXT,
    ARM_CORE_TYPE_M_PROFILE,
};
 
enum arm_arch {
    ARM_ARCH_UNKNOWN,
    ARM_ARCH_V4,
    ARM_ARCH_V6M,
    ARM_ARCH_V7M,
    ARM_ARCH_V8M,
};
 
enum arm_implementer {
    ARM_IMPLEMENTER_ARM = 0x41,
    ARM_IMPLEMENTER_INFINEON = 0x49,
    ARM_IMPLEMENTER_ARM_CHINA = 0x63,
    ARM_IMPLEMENTER_REALTEK = 0x72,
};
 
enum arm_mode {
    ARM_MODE_USR = 16,
    ARM_MODE_FIQ = 17,
    ARM_MODE_IRQ = 18,
    ARM_MODE_SVC = 19,
    ARM_MODE_MON = 22,
    ARM_MODE_ABT = 23,
    ARM_MODE_HYP = 26,
    ARM_MODE_UND = 27,
    ARM_MODE_1176_MON = 28,
    ARM_MODE_SYS = 31,
 
    ARM_MODE_THREAD = 0,
    ARM_MODE_USER_THREAD = 1,
    ARM_MODE_HANDLER = 2,
 
    ARMV8_64_EL0T = 0x0,
    ARMV8_64_EL1T = 0x4,
    ARMV8_64_EL1H = 0x5,
    ARMV8_64_EL2T = 0x8,
    ARMV8_64_EL2H = 0x9,
    ARMV8_64_EL3T = 0xC,
    ARMV8_64_EL3H = 0xD,
 
    ARM_MODE_ANY = -1
};
 
/* VFPv3 internal register numbers mapping to d0:31 */
enum {
    ARM_VFP_V3_D0 = 53,
    // numbering should not overlap with e.g. armv4_5.c arm_core_regs .gdb_index
    ARM_VFP_V3_D1,
    ARM_VFP_V3_D2,
    ARM_VFP_V3_D3,
    ARM_VFP_V3_D4,
    ARM_VFP_V3_D5,
    ARM_VFP_V3_D6,
    ARM_VFP_V3_D7,
    ARM_VFP_V3_D8,
    ARM_VFP_V3_D9,
    ARM_VFP_V3_D10,
    ARM_VFP_V3_D11,
    ARM_VFP_V3_D12,
    ARM_VFP_V3_D13,
    ARM_VFP_V3_D14,
    ARM_VFP_V3_D15,
    ARM_VFP_V3_D16,
    ARM_VFP_V3_D17,
    ARM_VFP_V3_D18,
    ARM_VFP_V3_D19,
    ARM_VFP_V3_D20,
    ARM_VFP_V3_D21,
    ARM_VFP_V3_D22,
    ARM_VFP_V3_D23,
    ARM_VFP_V3_D24,
    ARM_VFP_V3_D25,
    ARM_VFP_V3_D26,
    ARM_VFP_V3_D27,
    ARM_VFP_V3_D28,
    ARM_VFP_V3_D29,
    ARM_VFP_V3_D30,
    ARM_VFP_V3_D31,
    ARM_VFP_V3_FPSCR,
};
 
const char *arm_mode_name(unsigned int psr_mode);
bool is_arm_mode(unsigned int psr_mode);
 
enum arm_state {
    ARM_STATE_ARM,
    ARM_STATE_THUMB,
    ARM_STATE_JAZELLE,
    ARM_STATE_THUMB_EE,
    ARM_STATE_AARCH64,
};
 
enum arm_vfp_version {
    ARM_VFP_DISABLED,
    ARM_VFP_V1,
    ARM_VFP_V2,
    ARM_VFP_V3,
};
 
#define ARM_COMMON_MAGIC 0x0A450A45U
 
struct arm {
    unsigned int common_magic;
 
    struct reg_cache *core_cache;
 
    struct reg *pc;
 
    struct reg *cpsr;
 
    struct reg *spsr;
 
    const int *map;
 
    enum arm_core_type core_type;
 
    enum arm_mode core_mode;
 
    enum arm_state core_state;
 
    enum arm_arch arch;
 
    int arm_vfp_version;
 
    int (*setup_semihosting)(struct target *target, int enable);
 
    struct target *target;
 
    struct arm_dpm *dpm;
 
    struct etm_context *etm;
 
    /* FIXME all these methods should take "struct arm *" not target */
 
    int (*full_context)(struct target *target);
 
    int (*read_core_reg)(struct target *target, struct reg *reg,
            int num, enum arm_mode mode);
    int (*write_core_reg)(struct target *target, struct reg *reg,
            int num, enum arm_mode mode, uint8_t *value);
 
    int (*mrc)(struct target *target, int cpnum,
            uint32_t op1, uint32_t op2,
            uint32_t crn, uint32_t crm,
            uint32_t *value);
 
    int (*mrrc)(struct target *target, int cpnum,
            uint32_t op, uint32_t crm,
            uint64_t *value);
 
    int (*mcr)(struct target *target, int cpnum,
            uint32_t op1, uint32_t op2,
            uint32_t crn, uint32_t crm,
            uint32_t value);
 
    int (*mcrr)(struct target *target, int cpnum,
            uint32_t op, uint32_t crm,
            uint64_t value);
 
    void *arch_info;
 
    struct adiv5_dap *dap;
};
 
static inline struct arm *target_to_arm(const struct target *target)
{
    assert(target);
    return target->arch_info;
}
 
static inline bool is_arm(struct arm *arm)
{
    assert(arm);
    return arm->common_magic == ARM_COMMON_MAGIC;
}
 
struct arm_algorithm {
    unsigned int common_magic;
 
    enum arm_mode core_mode;
    enum arm_state core_state;
};
 
struct arm_reg {
    int num;
    enum arm_mode mode;
    struct target *target;
    struct arm *arm;
    uint8_t value[16];
};
 
struct reg_cache *arm_build_reg_cache(struct target *target, struct arm *arm);
void arm_free_reg_cache(struct arm *arm);
 
struct reg_cache *armv8_build_reg_cache(struct target *target);
 
extern const struct command_registration arm_command_handlers[];
extern const struct command_registration arm_all_profiles_command_handlers[];
 
int arm_arch_state(struct target *target);
const char *arm_get_gdb_arch(const struct target *target);
int arm_get_gdb_reg_list(struct target *target,
        struct reg **reg_list[], int *reg_list_size,
        enum target_register_class reg_class);
const char *armv8_get_gdb_arch(const struct target *target);
int armv8_get_gdb_reg_list(struct target *target,
        struct reg **reg_list[], int *reg_list_size,
        enum target_register_class reg_class);
 
int arm_init_arch_info(struct target *target, struct arm *arm);
 
/* REVISIT rename this once it's usable by ARMv7-M */
int armv4_5_run_algorithm(struct target *target,
        int num_mem_params, struct mem_param *mem_params,
        int num_reg_params, struct reg_param *reg_params,
        target_addr_t entry_point, target_addr_t exit_point,
        unsigned int timeout_ms, void *arch_info);
int armv4_5_run_algorithm_inner(struct target *target,
        int num_mem_params, struct mem_param *mem_params,
        int num_reg_params, struct reg_param *reg_params,
        uint32_t entry_point, uint32_t exit_point,
        unsigned int timeout_ms, void *arch_info,
        int (*run_it)(struct target *target, uint32_t exit_point,
                unsigned int timeout_ms, void *arch_info));
 
int arm_checksum_memory(struct target *target,
        target_addr_t address, uint32_t count, uint32_t *checksum);
int arm_blank_check_memory(struct target *target,
        struct target_memory_check_block *blocks, int num_blocks, uint8_t erased_value);
 
void arm_set_cpsr(struct arm *arm, uint32_t cpsr);
struct reg *arm_reg_current(struct arm *arm, unsigned int regnum);
struct reg *armv8_reg_current(struct arm *arm, unsigned int regnum);
 
#endif /* OPENOCD_TARGET_ARM_H */