4f0f0ef073ebfb6c2dd842148331dd9034d9097c
[fw/openocd] / 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  *   This program is free software; you can redistribute it and/or modify  *
8  *   it under the terms of the GNU General Public License as published by  *
9  *   the Free Software Foundation; either version 2 of the License, or     *
10  *   (at your option) any later version.                                   *
11  *                                                                         *
12  *   This program is distributed in the hope that it will be useful,       *
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
15  *   GNU General Public License for more details.                          *
16  *                                                                         *
17  *   You should have received a copy of the GNU General Public License     *
18  *   along with this program; if not, write to the                         *
19  *   Free Software Foundation, Inc.,                                       *
20  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
21  ***************************************************************************/
22
23 #ifndef MIPS32_H
24 #define MIPS32_H
25
26 #include "target.h"
27 #include "mips32_pracc.h"
28
29 #define MIPS32_COMMON_MAGIC             0xB320B320
30
31 /* offsets into mips32 core register cache */
32 enum
33 {
34         MIPS32_PC = 37,
35         MIPS32NUMCOREREGS
36 };
37
38 enum mips32_isa_mode
39 {
40         MIPS32_ISA_MIPS32 = 0,
41         MIPS32_ISA_MIPS16E = 1,
42 };
43
44 struct mips32_comparator
45 {
46         int used;
47         uint32_t bp_value;
48         uint32_t reg_address;
49 };
50
51 struct mips32_common
52 {
53         uint32_t common_magic;
54         void *arch_info;
55         struct reg_cache *core_cache;
56         struct mips_ejtag ejtag_info;
57         uint32_t core_regs[MIPS32NUMCOREREGS];
58         enum mips32_isa_mode isa_mode;
59
60         /* working area for fastdata access */
61         struct working_area *fast_data_area;
62
63         int bp_scanned;
64         int num_inst_bpoints;
65         int num_data_bpoints;
66         int num_inst_bpoints_avail;
67         int num_data_bpoints_avail;
68         struct mips32_comparator *inst_break_list;
69         struct mips32_comparator *data_break_list;
70
71         /* register cache to processor synchronization */
72         int (*read_core_reg)(struct target *target, int num);
73         int (*write_core_reg)(struct target *target, int num);
74 };
75
76 static inline struct mips32_common *
77 target_to_mips32(struct target *target)
78 {
79         return target->arch_info;
80 }
81
82 struct mips32_core_reg
83 {
84         uint32_t num;
85         struct target *target;
86         struct mips32_common *mips32_common;
87 };
88
89 struct mips32_algorithm
90 {
91         int common_magic;
92         enum mips32_isa_mode isa_mode;
93 };
94
95 #define MIPS32_OP_BEQ   0x04
96 #define MIPS32_OP_BNE   0x05
97 #define MIPS32_OP_ADDI  0x08
98 #define MIPS32_OP_AND   0x24
99 #define MIPS32_OP_COP0  0x10
100 #define MIPS32_OP_JR    0x08
101 #define MIPS32_OP_LUI   0x0F
102 #define MIPS32_OP_LW    0x23
103 #define MIPS32_OP_LBU   0x24
104 #define MIPS32_OP_LHU   0x25
105 #define MIPS32_OP_MFHI  0x10
106 #define MIPS32_OP_MTHI  0x11
107 #define MIPS32_OP_MFLO  0x12
108 #define MIPS32_OP_MTLO  0x13
109 #define MIPS32_OP_SB    0x28
110 #define MIPS32_OP_SH    0x29
111 #define MIPS32_OP_SW    0x2B
112 #define MIPS32_OP_ORI   0x0D
113 #define MIPS32_OP_XOR   0x26
114 #define MIPS32_OP_SRL   0x03
115
116 #define MIPS32_COP0_MF  0x00
117 #define MIPS32_COP0_MT  0x04
118
119 #define MIPS32_R_INST(opcode, rs, rt, rd, shamt, funct) (((opcode) << 26) |((rs) << 21) | ((rt) << 16) | ((rd) << 11)| ((shamt) << 6) | (funct))
120 #define MIPS32_I_INST(opcode, rs, rt, immd)     (((opcode) << 26) |((rs) << 21) | ((rt) << 16) | (immd))
121 #define MIPS32_J_INST(opcode, addr)     (((opcode) << 26) |(addr))
122
123 #define MIPS32_NOP                                      0
124 #define MIPS32_ADDI(tar, src, val)      MIPS32_I_INST(MIPS32_OP_ADDI, src, tar, val)
125 #define MIPS32_AND(reg, off, val)       MIPS32_R_INST(0, off, val, reg, 0, MIPS32_OP_AND)
126 #define MIPS32_B(off)                           MIPS32_BEQ(0, 0, off)
127 #define MIPS32_BEQ(src,tar,off)         MIPS32_I_INST(MIPS32_OP_BEQ, src, tar, off)
128 #define MIPS32_BNE(src,tar,off)         MIPS32_I_INST(MIPS32_OP_BNE, src, tar, off)
129 #define MIPS32_JR(reg)                          MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_JR)
130 #define MIPS32_MFC0(gpr, cpr, sel)      MIPS32_R_INST(MIPS32_OP_COP0, MIPS32_COP0_MF, gpr, cpr, 0, sel)
131 #define MIPS32_MTC0(gpr,cpr, sel)       MIPS32_R_INST(MIPS32_OP_COP0, MIPS32_COP0_MT, gpr, cpr, 0, sel)
132 #define MIPS32_LBU(reg, off, base)      MIPS32_I_INST(MIPS32_OP_LBU, base, reg, off)
133 #define MIPS32_LHU(reg, off, base)      MIPS32_I_INST(MIPS32_OP_LHU, base, reg, off)
134 #define MIPS32_LUI(reg, val)            MIPS32_I_INST(MIPS32_OP_LUI, 0, reg, val)
135 #define MIPS32_LW(reg, off, base)       MIPS32_I_INST(MIPS32_OP_LW, base, reg, off)
136 #define MIPS32_MFLO(reg)                        MIPS32_R_INST(0, 0, 0, reg, 0, MIPS32_OP_MFLO)
137 #define MIPS32_MFHI(reg)                        MIPS32_R_INST(0, 0, 0, reg, 0, MIPS32_OP_MFHI)
138 #define MIPS32_MTLO(reg)                        MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_MTLO)
139 #define MIPS32_MTHI(reg)                        MIPS32_R_INST(0, reg, 0, 0, 0, MIPS32_OP_MTHI)
140 #define MIPS32_ORI(tar, src, val)       MIPS32_I_INST(MIPS32_OP_ORI, src, tar, val)
141 #define MIPS32_SB(reg, off, base)       MIPS32_I_INST(MIPS32_OP_SB, base, reg, off)
142 #define MIPS32_SH(reg, off, base)       MIPS32_I_INST(MIPS32_OP_SH, base, reg, off)
143 #define MIPS32_SW(reg, off, base)       MIPS32_I_INST(MIPS32_OP_SW, base, reg, off)
144 #define MIPS32_XOR(reg, val1, val2)     MIPS32_R_INST(0, val1, val2, reg, 0, MIPS32_OP_XOR)
145 #define MIPS32_SRL(reg, src, off)       MIPS32_R_INST(0, 0, src, reg, off, MIPS32_OP_SRL)
146
147 /* ejtag specific instructions */
148 #define MIPS32_DRET                                     0x4200001F
149 #define MIPS32_SDBBP                            0x7000003F
150 #define MIPS16_SDBBP                            0xE801
151
152 int mips32_arch_state(struct target *target);
153
154 int mips32_init_arch_info(struct target *target,
155                 struct mips32_common *mips32, struct jtag_tap *tap);
156
157 int mips32_restore_context(struct target *target);
158 int mips32_save_context(struct target *target);
159
160 struct reg_cache *mips32_build_reg_cache(struct target *target);
161
162 int mips32_run_algorithm(struct target *target,
163                 int num_mem_params, struct mem_param *mem_params,
164                 int num_reg_params, struct reg_param *reg_params,
165                 uint32_t entry_point, uint32_t exit_point,
166                 int timeout_ms, void *arch_info);
167
168 int mips32_configure_break_unit(struct target *target);
169
170 int mips32_enable_interrupts(struct target *target, int enable);
171
172 int mips32_examine(struct target *target);
173
174 int mips32_register_commands(struct command_context *cmd_ctx);
175
176 int mips32_get_gdb_reg_list(struct target *target,
177                 struct reg **reg_list[], int *reg_list_size);
178 int mips32_checksum_memory(struct target *target, uint32_t address,
179                 uint32_t count, uint32_t* checksum);
180 int mips32_blank_check_memory(struct target *target,
181                 uint32_t address, uint32_t count, uint32_t* blank);
182
183 #endif  /*MIPS32_H*/