cmd: add missing usage vars
[fw/openocd] / src / target / arm966e.c
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2008 by Spencer Oliver                                  *
6  *   spen@spen-soft.co.uk                                                  *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
22  ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "arm966e.h"
28 #include "target_type.h"
29 #include "arm_opcodes.h"
30
31
32 #if 0
33 #define _DEBUG_INSTRUCTION_EXECUTION_
34 #endif
35
36 int arm966e_init_arch_info(struct target *target, struct arm966e_common *arm966e, struct jtag_tap *tap)
37 {
38         struct arm7_9_common *arm7_9 = &arm966e->arm7_9_common;
39
40         /* initialize arm7/arm9 specific info (including armv4_5) */
41         arm9tdmi_init_arch_info(target, arm7_9, tap);
42
43         arm966e->common_magic = ARM966E_COMMON_MAGIC;
44
45         /* The ARM966E-S implements the ARMv5TE architecture which
46          * has the BKPT instruction, so we don't have to use a watchpoint comparator
47          */
48         arm7_9->arm_bkpt = ARMV5_BKPT(0x0);
49         arm7_9->thumb_bkpt = ARMV5_T_BKPT(0x0) & 0xffff;
50
51         return ERROR_OK;
52 }
53
54 static int arm966e_target_create(struct target *target, Jim_Interp *interp)
55 {
56         struct arm966e_common *arm966e = calloc(1,sizeof(struct arm966e_common));
57
58         return arm966e_init_arch_info(target, arm966e, target->tap);
59 }
60
61 static int arm966e_verify_pointer(struct command_context *cmd_ctx,
62                 struct arm966e_common *arm966e)
63 {
64         if (arm966e->common_magic != ARM966E_COMMON_MAGIC) {
65                 command_print(cmd_ctx, "target is not an ARM966");
66                 return ERROR_TARGET_INVALID;
67         }
68         return ERROR_OK;
69 }
70
71 /*
72  * REVISIT:  The "read_cp15" and "write_cp15" commands could hook up
73  * to eventual mrc() and mcr() routines ... the reg_addr values being
74  * constructed (for CP15 only) from Opcode_1, Opcode_2, and CRn values.
75  * See section 7.3 of the ARM966E-S TRM.
76  */
77
78 static int arm966e_read_cp15(struct target *target, int reg_addr, uint32_t *value)
79 {
80         int retval = ERROR_OK;
81         struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
82         struct arm_jtag *jtag_info = &arm7_9->jtag_info;
83         struct scan_field fields[3];
84         uint8_t reg_addr_buf = reg_addr & 0x3f;
85         uint8_t nr_w_buf = 0;
86
87         if ((retval = arm_jtag_scann(jtag_info, 0xf, TAP_IDLE)) != ERROR_OK)
88         {
89                 return retval;
90         }
91         retval = arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL, TAP_IDLE);
92         if (retval != ERROR_OK)
93                 return retval;
94
95         fields[0].num_bits = 32;
96         /* REVISIT: table 7-2 shows that bits 31-31 need to be
97          * specified for accessing BIST registers ...
98          */
99         fields[0].out_value = NULL;
100         fields[0].in_value = NULL;
101
102         fields[1].num_bits = 6;
103         fields[1].out_value = &reg_addr_buf;
104         fields[1].in_value = NULL;
105
106         fields[2].num_bits = 1;
107         fields[2].out_value = &nr_w_buf;
108         fields[2].in_value = NULL;
109
110         jtag_add_dr_scan(jtag_info->tap, 3, fields, TAP_IDLE);
111
112         fields[1].in_value = (uint8_t *)value;
113
114         jtag_add_dr_scan(jtag_info->tap, 3, fields, TAP_IDLE);
115
116         jtag_add_callback(arm_le_to_h_u32, (jtag_callback_data_t)value);
117
118
119 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
120         if ((retval = jtag_execute_queue()) != ERROR_OK)
121         {
122                 return retval;
123         }
124         LOG_DEBUG("addr: 0x%x value: %8.8x", reg_addr, *value);
125 #endif
126
127         return ERROR_OK;
128 }
129
130 // EXPORTED to str9x (flash)
131 int arm966e_write_cp15(struct target *target, int reg_addr, uint32_t value)
132 {
133         int retval = ERROR_OK;
134         struct arm7_9_common *arm7_9 = target_to_arm7_9(target);
135         struct arm_jtag *jtag_info = &arm7_9->jtag_info;
136         struct scan_field fields[3];
137         uint8_t reg_addr_buf = reg_addr & 0x3f;
138         uint8_t nr_w_buf = 1;
139         uint8_t value_buf[4];
140
141         buf_set_u32(value_buf, 0, 32, value);
142
143         if ((retval = arm_jtag_scann(jtag_info, 0xf, TAP_IDLE)) != ERROR_OK)
144         {
145                 return retval;
146         }
147         retval = arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL, TAP_IDLE);
148         if (retval != ERROR_OK)
149                 return retval;
150
151         fields[0].num_bits = 32;
152         fields[0].out_value = value_buf;
153         fields[0].in_value = NULL;
154
155         fields[1].num_bits = 6;
156         fields[1].out_value = &reg_addr_buf;
157         fields[1].in_value = NULL;
158
159         fields[2].num_bits = 1;
160         fields[2].out_value = &nr_w_buf;
161         fields[2].in_value = NULL;
162
163         jtag_add_dr_scan(jtag_info->tap, 3, fields, TAP_IDLE);
164
165 #ifdef _DEBUG_INSTRUCTION_EXECUTION_
166         LOG_DEBUG("addr: 0x%x value: %8.8x", reg_addr, value);
167 #endif
168
169         return ERROR_OK;
170 }
171
172 COMMAND_HANDLER(arm966e_handle_cp15_command)
173 {
174         int retval;
175         struct target *target = get_current_target(CMD_CTX);
176         struct arm966e_common *arm966e = target_to_arm966(target);
177
178         retval = arm966e_verify_pointer(CMD_CTX, arm966e);
179         if (retval != ERROR_OK)
180                 return retval;
181
182         if (target->state != TARGET_HALTED)
183         {
184                 command_print(CMD_CTX, "target must be stopped for \"%s\" command", CMD_NAME);
185                 return ERROR_OK;
186         }
187
188         /* one or more argument, access a single register (write if second argument is given */
189         if (CMD_ARGC >= 1)
190         {
191                 uint32_t address;
192                 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
193
194                 if (CMD_ARGC == 1)
195                 {
196                         uint32_t value;
197                         if ((retval = arm966e_read_cp15(target, address, &value)) != ERROR_OK)
198                         {
199                                 command_print(CMD_CTX,
200                                                 "couldn't access reg %" PRIi32,
201                                                 address);
202                                 return ERROR_OK;
203                         }
204                         if ((retval = jtag_execute_queue()) != ERROR_OK)
205                         {
206                                 return retval;
207                         }
208
209                         command_print(CMD_CTX, "%" PRIi32 ": %8.8" PRIx32,
210                                         address, value);
211                 }
212                 else if (CMD_ARGC == 2)
213                 {
214                         uint32_t value;
215                         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
216                         if ((retval = arm966e_write_cp15(target, address, value)) != ERROR_OK)
217                         {
218                                 command_print(CMD_CTX,
219                                                 "couldn't access reg %" PRIi32,
220                                                 address);
221                                 return ERROR_OK;
222                         }
223                         command_print(CMD_CTX, "%" PRIi32 ": %8.8" PRIx32,
224                                         address, value);
225                 }
226         }
227
228         return ERROR_OK;
229 }
230
231 static const struct command_registration arm966e_exec_command_handlers[] = {
232         {
233                 .name = "cp15",
234                 .handler = arm966e_handle_cp15_command,
235                 .mode = COMMAND_EXEC,
236                 .usage = "regnum [value]",
237                 .help = "display/modify cp15 register",
238         },
239         COMMAND_REGISTRATION_DONE
240 };
241
242 const struct command_registration arm966e_command_handlers[] = {
243         {
244                 .chain = arm9tdmi_command_handlers,
245         },
246         {
247                 .name = "arm966e",
248                 .mode = COMMAND_ANY,
249                 .help = "arm966e command group",
250                 .usage = "",
251                 .chain = arm966e_exec_command_handlers,
252         },
253         COMMAND_REGISTRATION_DONE
254 };
255
256 /** Holds methods for ARM966 targets. */
257 struct target_type arm966e_target =
258 {
259         .name = "arm966e",
260
261         .poll = arm7_9_poll,
262         .arch_state = arm_arch_state,
263
264         .target_request_data = arm7_9_target_request_data,
265
266         .halt = arm7_9_halt,
267         .resume = arm7_9_resume,
268         .step = arm7_9_step,
269
270         .assert_reset = arm7_9_assert_reset,
271         .deassert_reset = arm7_9_deassert_reset,
272         .soft_reset_halt = arm7_9_soft_reset_halt,
273
274         .get_gdb_reg_list = arm_get_gdb_reg_list,
275
276         .read_memory = arm7_9_read_memory,
277         .write_memory = arm7_9_write_memory,
278         .bulk_write_memory = arm7_9_bulk_write_memory,
279
280         .checksum_memory = arm_checksum_memory,
281         .blank_check_memory = arm_blank_check_memory,
282
283         .run_algorithm = armv4_5_run_algorithm,
284
285         .add_breakpoint = arm7_9_add_breakpoint,
286         .remove_breakpoint = arm7_9_remove_breakpoint,
287         .add_watchpoint = arm7_9_add_watchpoint,
288         .remove_watchpoint = arm7_9_remove_watchpoint,
289
290         .commands = arm966e_command_handlers,
291         .target_create = arm966e_target_create,
292         .init_target = arm9tdmi_init_target,
293         .examine = arm7_9_examine,
294         .check_reset = arm7_9_check_reset,
295 };