src/target/mips32.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Spencer Oliver                                  *
   3  *   spen@spen-soft.co.uk                                                  *
   4  *                                                                         *
   5  *   Copyright (C) 2008 by David T.L. Wong                                 *
   6  *                                                                         *
   7  *   Copyright (C) 2011 by Drasko DRASKOVIC                                *
   8  *   drasko.draskovic@gmail.com                                            *
   9  *                                                                         *
  10  *   This program is free software; you can redistribute it and/or modify  *
  11  *   it under the terms of the GNU General Public License as published by  *
  12  *   the Free Software Foundation; either version 2 of the License, or     *
  13  *   (at your option) any later version.                                   *
  14  *                                                                         *
  15  *   This program is distributed in the hope that it will be useful,       *
  16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  18  *   GNU General Public License for more details.                          *
  19  *                                                                         *
  20  *   You should have received a copy of the GNU General Public License     *
  21  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  22  ***************************************************************************/
  23
  24 #ifndef OPENOCD_TARGET_MIPS32_H
  25 #define OPENOCD_TARGET_MIPS32_H
  26
  27 #include "target.h"
  28 #include "mips32_pracc.h"
  29
  30 #define MIPS32_COMMON_MAGIC             0xB320B320
  31
  32 /**
  33  * Memory segments (32bit kernel mode addresses)
  34  * These are the traditional names used in the 32-bit universe.
  35  */
  36 #define KUSEG                   0x00000000
  37 #define KSEG0                   0x80000000
  38 #define KSEG1                   0xa0000000
  39 #define KSEG2                   0xc0000000
  40 #define KSEG3                   0xe0000000
  41
  42 /** Returns the kernel segment base of a given address */
  43 #define KSEGX(a)                ((a) & 0xe0000000)
  44
  45 /** CP0 CONFIG regites fields */
  46 #define MIPS32_CONFIG0_KU_SHIFT 25
  47 #define MIPS32_CONFIG0_KU_MASK (0x7 << MIPS32_CONFIG0_KU_SHIFT)
  48
  49 #define MIPS32_CONFIG0_K0_SHIFT 0
  50 #define MIPS32_CONFIG0_K0_MASK (0x7 << MIPS32_CONFIG0_K0_SHIFT)
  51
  52 #define MIPS32_CONFIG0_K23_SHIFT 28
  53 #define MIPS32_CONFIG0_K23_MASK (0x7 << MIPS32_CONFIG0_K23_SHIFT)
  54
  55 #define MIPS32_CONFIG0_AR_SHIFT 10
  56 #define MIPS32_CONFIG0_AR_MASK (0x7 << MIPS32_CONFIG0_AR_SHIFT)
  57
  58 #define MIPS32_CONFIG1_DL_SHIFT 10
  59 #define MIPS32_CONFIG1_DL_MASK (0x7 << MIPS32_CONFIG1_DL_SHIFT)
  60
  61 #define MIPS32_ARCH_REL1 0x0
  62 #define MIPS32_ARCH_REL2 0x1
  63
  64 #define MIPS32_SCAN_DELAY_LEGACY_MODE 2000000
  65
  66 /* offsets into mips32 core register cache */
  67 enum {
  68         MIPS32_PC = 37,
  69         MIPS32_FIR = 71,
  70         MIPS32NUMCOREREGS
  71 };
  72
  73 enum mips32_isa_mode {
  74         MIPS32_ISA_MIPS32 = 0,
  75         MIPS32_ISA_MIPS16E = 1,
  76 };
  77
  78 struct mips32_comparator {
  79         int used;
  80         uint32_t bp_value;
  81         uint32_t reg_address;
  82 };
  83
  84 struct mips32_common {
  85         uint32_t common_magic;
  86         void *arch_info;
  87         struct reg_cache *core_cache;
  88         struct mips_ejtag ejtag_info;
  89         uint32_t core_regs[MIPS32NUMCOREREGS];
  90         enum mips32_isa_mode isa_mode;
  91
  92         /* working area for fastdata access */
  93         struct working_area *fast_data_area;
  94
  95         int bp_scanned;
  96         int num_inst_bpoints;
  97         int num_data_bpoints;
  98         int num_inst_bpoints_avail;
  99         int num_data_bpoints_avail;
 100         struct mips32_comparator *inst_break_list;
 101         struct mips32_comparator *data_break_list;
 102
 103         /* register cache to processor synchronization */
 104         int (*read_core_reg)(struct target *target, unsigned int num);
 105         int (*write_core_reg)(struct target *target, unsigned int num);
 106 };
 107
 108 static inline struct mips32_common *
 109 target_to_mips32(struct target *target)
 110 {
 111         return target->arch_info;
 112 }
 113
 114 struct mips32_core_reg {
 115         uint32_t num;
 116         struct target *target;
 117         struct mips32_common *mips32_common;
 118 };
 119
 120 struct mips32_algorithm {
 121         int common_magic;
 122         enum mips32_isa_mode isa_mode;
 123 };
 124
 125 #define MIPS32_OP_ADDIU 0x21
 126 #define MIPS32_OP_ANDI  0x0C
 127 #define MIPS32_OP_BEQ   0x04
 128 #define MIPS32_OP_BGTZ  0x07
 129 #define MIPS32_OP_BNE   0x05
 130 #define MIPS32_OP_ADDI  0x08
 131 #define MIPS32_OP_AND   0x24
 132 #define MIPS32_OP_CACHE 0x2F
 133 #define MIPS32_OP_COP0  0x10
 134 #define MIPS32_OP_J     0x02
 135 #define MIPS32_OP_JR    0x08
 136 #define MIPS32_OP_LUI   0x0F
 137 #define MIPS32_OP_LW    0x23
 138 #define MIPS32_OP_LBU   0x24
 139 #define MIPS32_OP_LHU   0x25
 140 #define MIPS32_OP_MFHI  0x10
 141 #define MIPS32_OP_MTHI  0x11
 142 #define MIPS32_OP_MFLO  0x12
 143 #define MIPS32_OP_MTLO  0x13
 144 #define MIPS32_OP_RDHWR 0x3B
 145 #define MIPS32_OP_SB    0x28
 146 #define MIPS32_OP_SH    0x29
 147 #define MIPS32_OP_SW    0x2B
 148 #define MIPS32_OP_ORI   0x0D
 149 #define MIPS32_OP_XORI  0x0E
 150 #define MIPS32_OP_XOR   0x26
 151 #define MIPS32_OP_SLTU  0x2B
 152 #define MIPS32_OP_SRL   0x03
 153 #define MIPS32_OP_SYNCI 0x1F
 154
 155 #define MIPS32_OP_REGIMM        0x01
 156 #define MIPS32_OP_SDBBP         0x3F
 157 #define MIPS32_OP_SPECIAL       0x00
 158 #define MIPS32_OP_SPECIAL2      0x07
 159 #define MIPS32_OP_SPECIAL3      0x1F
 160
 161 #define MIPS32_COP0_MF  0x00
 162 #define MIPS32_COP0_MT  0x04
 163
 164 #define MIPS32_R_INST(opcode, rs, rt, rd, shamt, funct) \
 165         (((opcode) << 26) | ((rs) << 21) | ((rt) << 16) | ((rd) << 11) | ((shamt) << 6) | (funct))
 166 #define MIPS32_I_INST(opcode, rs, rt, immd) \
 167         (((opcode) << 26) | ((rs) << 21) | ((rt) << 16) | (immd))
 168 #define MIPS32_J_INST(opcode, addr)     (((opcode) << 26) | (addr))
 169
 170 #define MIPS32_NOP                                              0
 171 #define MIPS32_ADDI(tar, src, val)              MIPS32_I_INST(MIPS32_OP_ADDI, src, tar, val)
 172 #define MIPS32_ADDU(dst, src, tar)              MIPS32_R_INST(MIPS32_OP_SPECIAL, src, tar, dst, 0, MIPS32_OP_ADDIU)
 173 #define MIPS32_AND(reg, off, val)               MIPS32_R_INST(0, off, val, reg, 0, MIPS32_OP_AND)
 174 #define MIPS32_ANDI(tar, src, val)              MIPS32_I_INST(MIPS32_OP_ANDI, src, tar, val)
 175 #define MIPS32_B(off)                                   MIPS32_BEQ(0, 0, off)
 176 #define MIPS32_BEQ(src, tar, off)               MIPS32_I_INST(MIPS32_OP_BEQ, src, tar, off)
 177 #define MIPS32_BGTZ(reg, off)                   MIPS32_I_INST(MIPS32_OP_BGTZ, reg, 0, off)
 178 #define MIPS32_BNE(src, tar, off)               MIPS32_I_INST(MIPS32_OP_BNE, src, tar, off)
 179 #define MIPS32_CACHE(op, off, base)             MIPS32_I_INST(MIPS32_OP_CACHE, base, op, off)
 180 #define MIPS32_J(tar)                           MIPS32_J_INST(MIPS32_OP_J, tar)
 181 #define MIPS32_JR(reg)                                  MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_JR)
 182 #define MIPS32_MFC0(gpr, cpr, sel)              MIPS32_R_INST(MIPS32_OP_COP0, MIPS32_COP0_MF, gpr, cpr, 0, sel)
 183 #define MIPS32_MTC0(gpr, cpr, sel)              MIPS32_R_INST(MIPS32_OP_COP0, MIPS32_COP0_MT, gpr, cpr, 0, sel)
 184 #define MIPS32_LBU(reg, off, base)              MIPS32_I_INST(MIPS32_OP_LBU, base, reg, off)
 185 #define MIPS32_LHU(reg, off, base)              MIPS32_I_INST(MIPS32_OP_LHU, base, reg, off)
 186 #define MIPS32_LUI(reg, val)                    MIPS32_I_INST(MIPS32_OP_LUI, 0, reg, val)
 187 #define MIPS32_LW(reg, off, base)               MIPS32_I_INST(MIPS32_OP_LW, base, reg, off)
 188 #define MIPS32_MFLO(reg)                                MIPS32_R_INST(0, 0, 0, reg, 0, MIPS32_OP_MFLO)
 189 #define MIPS32_MFHI(reg)                                MIPS32_R_INST(0, 0, 0, reg, 0, MIPS32_OP_MFHI)
 190 #define MIPS32_MTLO(reg)                                MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_MTLO)
 191 #define MIPS32_MTHI(reg)                                MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_MTHI)
 192 #define MIPS32_ORI(tar, src, val)               MIPS32_I_INST(MIPS32_OP_ORI, src, tar, val)
 193 #define MIPS32_XORI(tar, src, val)              MIPS32_I_INST(MIPS32_OP_XORI, src, tar, val)
 194 #define MIPS32_RDHWR(tar, dst)                  MIPS32_R_INST(MIPS32_OP_SPECIAL3, 0, tar, dst, 0, MIPS32_OP_RDHWR)
 195 #define MIPS32_SB(reg, off, base)               MIPS32_I_INST(MIPS32_OP_SB, base, reg, off)
 196 #define MIPS32_SH(reg, off, base)               MIPS32_I_INST(MIPS32_OP_SH, base, reg, off)
 197 #define MIPS32_SW(reg, off, base)               MIPS32_I_INST(MIPS32_OP_SW, base, reg, off)
 198 #define MIPS32_XOR(reg, val1, val2)             MIPS32_R_INST(0, val1, val2, reg, 0, MIPS32_OP_XOR)
 199 #define MIPS32_SRL(reg, src, off)               MIPS32_R_INST(0, 0, src, reg, off, MIPS32_OP_SRL)
 200 #define MIPS32_SLTU(dst, src, tar)              MIPS32_R_INST(MIPS32_OP_SPECIAL, src, tar, dst, 0, MIPS32_OP_SLTU)
 201 #define MIPS32_SYNCI(off, base)                 MIPS32_I_INST(MIPS32_OP_REGIMM, base, MIPS32_OP_SYNCI, off)
 202
 203 #define MIPS32_SYNC                     0xF
 204 #define MIPS32_SYNCI_STEP       0x1     /* reg num od address step size to be used with synci instruction */
 205
 206 /**
 207  * Cache operations definitions
 208  * Operation field is 5 bits long :
 209  * 1) bits 1..0 hold cache type
 210  * 2) bits 4..2 hold operation code
 211  */
 212 #define MIPS32_CACHE_D_HIT_WRITEBACK ((0x1 << 0) | (0x6 << 2))
 213 #define MIPS32_CACHE_I_HIT_INVALIDATE ((0x0 << 0) | (0x4 << 2))
 214
 215 /* ejtag specific instructions */
 216 #define MIPS32_DRET                                     0x4200001F
 217 #define MIPS32_SDBBP                            0x7000003F      /* MIPS32_J_INST(MIPS32_OP_SPECIAL2, MIPS32_OP_SDBBP) */
 218 #define MIPS16_SDBBP                            0xE801
 219
 220 /*MICRO MIPS INSTRUCTIONS, see doc MD00582 */
 221 #define POOL32A                                 0X00u
 222 #define POOL32AXf                               0x3Cu
 223 #define POOL32B                                 0x08u
 224 #define POOL32I                                 0x10u
 225 #define MMIPS32_OP_ADDI                 0x04u
 226 #define MMIPS32_OP_ADDIU                0x0Cu
 227 #define MMIPS32_OP_ADDU                 0x150u
 228 #define MMIPS32_OP_AND                  0x250u
 229 #define MMIPS32_OP_ANDI                 0x34u
 230 #define MMIPS32_OP_BEQ                  0x25u
 231 #define MMIPS32_OP_BGTZ                 0x06u
 232 #define MMIPS32_OP_BNE                  0x2Du
 233 #define MMIPS32_OP_CACHE                0x06u
 234 #define MMIPS32_OP_J                    0x35u
 235 #define MMIPS32_OP_JALR                 0x03Cu
 236 #define MMIPS32_OP_LB                   0x07u
 237 #define MMIPS32_OP_LBU                  0x05u
 238 #define MMIPS32_OP_LHU                  0x0Du
 239 #define MMIPS32_OP_LUI                  0x0Du
 240 #define MMIPS32_OP_LW                   0x3Fu
 241 #define MMIPS32_OP_MFC0                 0x03u
 242 #define MMIPS32_OP_MTC0                 0x0Bu
 243 #define MMIPS32_OP_MFLO                 0x075u
 244 #define MMIPS32_OP_MFHI                 0x035u
 245 #define MMIPS32_OP_MTLO                 0x0F5u
 246 #define MMIPS32_OP_MTHI                 0x0B5u
 247 #define MMIPS32_OP_MOVN                 0x018u
 248 #define MMIPS32_OP_ORI                  0x14u
 249 #define MMIPS32_OP_RDHWR                0x1ACu
 250 #define MMIPS32_OP_SB                   0x06u
 251 #define MMIPS32_OP_SH                   0x0Eu
 252 #define MMIPS32_OP_SW                   0x3Eu
 253 #define MMIPS32_OP_SLTU                 0x390u
 254 #define MMIPS32_OP_SLL                  0x000u
 255 #define MMIPS32_OP_SLTI                 0x24u
 256 #define MMIPS32_OP_SRL                  0x040u
 257 #define MMIPS32_OP_SYNCI                0x10u
 258 #define MMIPS32_OP_XOR                  0x310u
 259 #define MMIPS32_OP_XORI                 0x1Cu
 260
 261 #define MMIPS32_ADDI(tar, src, val)             MIPS32_I_INST(MMIPS32_OP_ADDI, tar, src, val)
 262 #define MMIPS32_ADDIU(tar, src, val)            MIPS32_I_INST(MMIPS32_OP_ADDIU, tar, src, val)
 263 #define MMIPS32_ADDU(dst, src, tar)             MIPS32_R_INST(POOL32A, tar, src, dst, 0, MMIPS32_OP_ADDU)
 264 #define MMIPS32_AND(dst, src, tar)              MIPS32_R_INST(POOL32A, tar, src, dst, 0, MMIPS32_OP_AND)
 265 #define MMIPS32_ANDI(tar, src, val)             MIPS32_I_INST(MMIPS32_OP_ANDI, tar, src, val)
 266
 267 #define MMIPS32_B(off)                          MMIPS32_BEQ(0, 0, off)
 268 #define MMIPS32_BEQ(src, tar, off)              MIPS32_I_INST(MMIPS32_OP_BEQ, tar, src, off)
 269 #define MMIPS32_BGTZ(reg, off)                  MIPS32_I_INST(POOL32I, MMIPS32_OP_BGTZ, reg, off)
 270 #define MMIPS32_BNE(src, tar, off)              MIPS32_I_INST(MMIPS32_OP_BNE, tar, src, off)
 271 #define MMIPS32_CACHE(op, off, base)            MIPS32_R_INST(POOL32B, op, base, MMIPS32_OP_CACHE << 1, 0, off)
 272
 273 #define MMIPS32_J(tar)                          MIPS32_J_INST(MMIPS32_OP_J, (0x07FFFFFFu & (tar)) >> 1)
 274 #define MMIPS32_JR(reg)                         MIPS32_R_INST(POOL32A, 0, reg, 0, MMIPS32_OP_JALR, POOL32AXf)
 275 #define MMIPS32_LB(reg, off, base)              MIPS32_I_INST(MMIPS32_OP_LB, reg, base, off)
 276 #define MMIPS32_LBU(reg, off, base)             MIPS32_I_INST(MMIPS32_OP_LBU, reg, base, off)
 277 #define MMIPS32_LHU(reg, off, base)             MIPS32_I_INST(MMIPS32_OP_LHU, reg, base, off)
 278 #define MMIPS32_LUI(reg, val)                   MIPS32_I_INST(POOL32I, MMIPS32_OP_LUI, reg, val)
 279 #define MMIPS32_LW(reg, off, base)              MIPS32_I_INST(MMIPS32_OP_LW, reg, base, off)
 280
 281 #define MMIPS32_MFC0(gpr, cpr, sel)             MIPS32_R_INST(POOL32A, gpr, cpr, sel, MMIPS32_OP_MFC0, POOL32AXf)
 282 #define MMIPS32_MFLO(reg)                       MIPS32_R_INST(POOL32A, 0, reg, 0, MMIPS32_OP_MFLO, POOL32AXf)
 283 #define MMIPS32_MFHI(reg)                       MIPS32_R_INST(POOL32A, 0, reg, 0, MMIPS32_OP_MFHI, POOL32AXf)
 284 #define MMIPS32_MTC0(gpr, cpr, sel)             MIPS32_R_INST(POOL32A, gpr, cpr, sel, MMIPS32_OP_MTC0, POOL32AXf)
 285 #define MMIPS32_MTLO(reg)                       MIPS32_R_INST(POOL32A, 0, reg, 0, MMIPS32_OP_MTLO, POOL32AXf)
 286 #define MMIPS32_MTHI(reg)                       MIPS32_R_INST(POOL32A, 0, reg, 0, MMIPS32_OP_MTHI, POOL32AXf)
 287
 288 #define MMIPS32_MOVN(dst, src, tar)             MIPS32_R_INST(POOL32A, tar, src, dst, 0, MMIPS32_OP_MOVN)
 289 #define MMIPS32_NOP                             0
 290 #define MMIPS32_ORI(tar, src, val)              MIPS32_I_INST(MMIPS32_OP_ORI, tar, src, val)
 291 #define MMIPS32_RDHWR(tar, dst)                 MIPS32_R_INST(POOL32A, dst, tar, 0, MMIPS32_OP_RDHWR, POOL32AXf)
 292 #define MMIPS32_SB(reg, off, base)              MIPS32_I_INST(MMIPS32_OP_SB, reg, base, off)
 293 #define MMIPS32_SH(reg, off, base)              MIPS32_I_INST(MMIPS32_OP_SH, reg, base, off)
 294 #define MMIPS32_SW(reg, off, base)              MIPS32_I_INST(MMIPS32_OP_SW, reg, base, off)
 295
 296 #define MMIPS32_SRL(reg, src, off)              MIPS32_R_INST(POOL32A, reg, src, off, 0, MMIPS32_OP_SRL)
 297 #define MMIPS32_SLTU(dst, src, tar)             MIPS32_R_INST(POOL32A, tar, src, dst, 0, MMIPS32_OP_SLTU)
 298 #define MMIPS32_SYNCI(off, base)                MIPS32_I_INST(POOL32I, MMIPS32_OP_SYNCI, base, off)
 299 #define MMIPS32_SLL(dst, src, sa)               MIPS32_R_INST(POOL32A, dst, src, sa, 0, MMIPS32_OP_SLL)
 300 #define MMIPS32_SLTI(tar, src, val)             MIPS32_I_INST(MMIPS32_OP_SLTI, tar, src, val)
 301 #define MMIPS32_SYNC                            0x00001A7Cu /* MIPS32_R_INST(POOL32A, 0, 0, 0, 0x1ADu, POOL32AXf) */
 302
 303 #define MMIPS32_XOR(reg, val1, val2)            MIPS32_R_INST(POOL32A, val1, val2, reg, 0, MMIPS32_OP_XOR)
 304 #define MMIPS32_XORI(tar, src, val)             MIPS32_I_INST(MMIPS32_OP_XORI, tar, src, val)
 305
 306 #define MMIPS32_SYNCI_STEP      0x1u    /* reg num od address step size to be used with synci instruction */
 307
 308
 309 /* ejtag specific instructions */
 310 #define MMIPS32_DRET                    0x0000E37Cu     /* MIPS32_R_INST(POOL32A, 0, 0, 0, 0x38D, POOL32AXf) */
 311 #define MMIPS32_SDBBP                   0x0000DB7Cu     /* MIPS32_R_INST(POOL32A, 0, 0, 0, 0x1BD, POOL32AXf) */
 312 #define MMIPS16_SDBBP                   0x46C0u         /* POOL16C instr */
 313
 314
 315 extern const struct command_registration mips32_command_handlers[];
 316
 317 int mips32_arch_state(struct target *target);
 318
 319 int mips32_init_arch_info(struct target *target,
 320                 struct mips32_common *mips32, struct jtag_tap *tap);
 321
 322 int mips32_restore_context(struct target *target);
 323 int mips32_save_context(struct target *target);
 324
 325 struct reg_cache *mips32_build_reg_cache(struct target *target);
 326
 327 int mips32_run_algorithm(struct target *target,
 328                 int num_mem_params, struct mem_param *mem_params,
 329                 int num_reg_params, struct reg_param *reg_params,
 330                 target_addr_t entry_point, target_addr_t exit_point,
 331                 int timeout_ms, void *arch_info);
 332
 333 int mips32_configure_break_unit(struct target *target);
 334
 335 int mips32_enable_interrupts(struct target *target, int enable);
 336
 337 int mips32_examine(struct target *target);
 338
 339 int mips32_register_commands(struct command_context *cmd_ctx);
 340
 341 int mips32_get_gdb_reg_list(struct target *target,
 342                 struct reg **reg_list[], int *reg_list_size,
 343                 enum target_register_class reg_class);
 344 int mips32_checksum_memory(struct target *target, target_addr_t address,
 345                 uint32_t count, uint32_t *checksum);
 346 int mips32_blank_check_memory(struct target *target,
 347                 target_addr_t address, uint32_t count, uint32_t *blank, uint8_t erased_value);
 348
 349 #endif /* OPENOCD_TARGET_MIPS32_H */