Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
arm_coresight: add include file and use it
[openocd.git] / src / target / arm_adi_v5.c
1 /***************************************************************************
2 * Copyright (C) 2006 by Magnus Lundin *
3 * lundin@mlu.mine.nu *
4 * *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
7 * *
8 * Copyright (C) 2009-2010 by Oyvind Harboe *
9 * oyvind.harboe@zylin.com *
10 * *
11 * Copyright (C) 2009-2010 by David Brownell *
12 * *
13 * Copyright (C) 2013 by Andreas Fritiofson *
14 * andreas.fritiofson@gmail.com *
15 * *
16 * Copyright (C) 2019-2021, Ampere Computing LLC *
17 * *
18 * This program is free software; you can redistribute it and/or modify *
19 * it under the terms of the GNU General Public License as published by *
20 * the Free Software Foundation; either version 2 of the License, or *
21 * (at your option) any later version. *
22 * *
23 * This program is distributed in the hope that it will be useful, *
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
26 * GNU General Public License for more details. *
27 * *
28 * You should have received a copy of the GNU General Public License *
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
30 ***************************************************************************/
31
32 /**
33 * @file
34 * This file implements support for the ARM Debug Interface version 5 (ADIv5)
35 * debugging architecture. Compared with previous versions, this includes
36 * a low pin-count Serial Wire Debug (SWD) alternative to JTAG for message
37 * transport, and focuses on memory mapped resources as defined by the
38 * CoreSight architecture.
39 *
40 * A key concept in ADIv5 is the Debug Access Port, or DAP. A DAP has two
41 * basic components: a Debug Port (DP) transporting messages to and from a
42 * debugger, and an Access Port (AP) accessing resources. Three types of DP
43 * are defined. One uses only JTAG for communication, and is called JTAG-DP.
44 * One uses only SWD for communication, and is called SW-DP. The third can
45 * use either SWD or JTAG, and is called SWJ-DP. The most common type of AP
46 * is used to access memory mapped resources and is called a MEM-AP. Also a
47 * JTAG-AP is also defined, bridging to JTAG resources; those are uncommon.
48 *
49 * This programming interface allows DAP pipelined operations through a
50 * transaction queue. This primarily affects AP operations (such as using
51 * a MEM-AP to access memory or registers). If the current transaction has
52 * not finished by the time the next one must begin, and the ORUNDETECT bit
53 * is set in the DP_CTRL_STAT register, the SSTICKYORUN status is set and
54 * further AP operations will fail. There are two basic methods to avoid
55 * such overrun errors. One involves polling for status instead of using
56 * transaction pipelining. The other involves adding delays to ensure the
57 * AP has enough time to complete one operation before starting the next
58 * one. (For JTAG these delays are controlled by memaccess_tck.)
59 */
60
61 /*
62 * Relevant specifications from ARM include:
63 *
64 * ARM(tm) Debug Interface v5 Architecture Specification ARM IHI 0031E
65 * CoreSight(tm) v1.0 Architecture Specification ARM IHI 0029B
66 *
67 * CoreSight(tm) DAP-Lite TRM, ARM DDI 0316D
68 * Cortex-M3(tm) TRM, ARM DDI 0337G
69 */
70
71 #ifdef HAVE_CONFIG_H
72 #include "config.h"
73 #endif
74
75 #include "jtag/interface.h"
76 #include "arm.h"
77 #include "arm_adi_v5.h"
78 #include "arm_coresight.h"
79 #include "jtag/swd.h"
80 #include "transport/transport.h"
81 #include <helper/align.h>
82 #include <helper/jep106.h>
83 #include <helper/time_support.h>
84 #include <helper/list.h>
85 #include <helper/jim-nvp.h>
86
87 /* ARM ADI Specification requires at least 10 bits used for TAR autoincrement */
88
89 /*
90 uint32_t tar_block_size(uint32_t address)
91 Return the largest block starting at address that does not cross a tar block size alignment boundary
92 */
93 static uint32_t max_tar_block_size(uint32_t tar_autoincr_block, target_addr_t address)
94 {
95 return tar_autoincr_block - ((tar_autoincr_block - 1) & address);
96 }
97
98 /***************************************************************************
99 * *
100 * DP and MEM-AP register access through APACC and DPACC *
101 * *
102 ***************************************************************************/
103
104 static int mem_ap_setup_csw(struct adiv5_ap *ap, uint32_t csw)
105 {
106 csw |= ap->csw_default;
107
108 if (csw != ap->csw_value) {
109 /* LOG_DEBUG("DAP: Set CSW %x",csw); */
110 int retval = dap_queue_ap_write(ap, MEM_AP_REG_CSW, csw);
111 if (retval != ERROR_OK) {
112 ap->csw_value = 0;
113 return retval;
114 }
115 ap->csw_value = csw;
116 }
117 return ERROR_OK;
118 }
119
120 static int mem_ap_setup_tar(struct adiv5_ap *ap, target_addr_t tar)
121 {
122 if (!ap->tar_valid || tar != ap->tar_value) {
123 /* LOG_DEBUG("DAP: Set TAR %x",tar); */
124 int retval = dap_queue_ap_write(ap, MEM_AP_REG_TAR, (uint32_t)(tar & 0xffffffffUL));
125 if (retval == ERROR_OK && is_64bit_ap(ap)) {
126 /* See if bits 63:32 of tar is different from last setting */
127 if ((ap->tar_value >> 32) != (tar >> 32))
128 retval = dap_queue_ap_write(ap, MEM_AP_REG_TAR64, (uint32_t)(tar >> 32));
129 }
130 if (retval != ERROR_OK) {
131 ap->tar_valid = false;
132 return retval;
133 }
134 ap->tar_value = tar;
135 ap->tar_valid = true;
136 }
137 return ERROR_OK;
138 }
139
140 static int mem_ap_read_tar(struct adiv5_ap *ap, target_addr_t *tar)
141 {
142 uint32_t lower;
143 uint32_t upper = 0;
144
145 int retval = dap_queue_ap_read(ap, MEM_AP_REG_TAR, &lower);
146 if (retval == ERROR_OK && is_64bit_ap(ap))
147 retval = dap_queue_ap_read(ap, MEM_AP_REG_TAR64, &upper);
148
149 if (retval != ERROR_OK) {
150 ap->tar_valid = false;
151 return retval;
152 }
153
154 retval = dap_run(ap->dap);
155 if (retval != ERROR_OK) {
156 ap->tar_valid = false;
157 return retval;
158 }
159
160 *tar = (((target_addr_t)upper) << 32) | (target_addr_t)lower;
161
162 ap->tar_value = *tar;
163 ap->tar_valid = true;
164 return ERROR_OK;
165 }
166
167 static uint32_t mem_ap_get_tar_increment(struct adiv5_ap *ap)
168 {
169 switch (ap->csw_value & CSW_ADDRINC_MASK) {
170 case CSW_ADDRINC_SINGLE:
171 switch (ap->csw_value & CSW_SIZE_MASK) {
172 case CSW_8BIT:
173 return 1;
174 case CSW_16BIT:
175 return 2;
176 case CSW_32BIT:
177 return 4;
178 default:
179 return 0;
180 }
181 case CSW_ADDRINC_PACKED:
182 return 4;
183 }
184 return 0;
185 }
186
187 /* mem_ap_update_tar_cache is called after an access to MEM_AP_REG_DRW
188 */
189 static void mem_ap_update_tar_cache(struct adiv5_ap *ap)
190 {
191 if (!ap->tar_valid)
192 return;
193
194 uint32_t inc = mem_ap_get_tar_increment(ap);
195 if (inc >= max_tar_block_size(ap->tar_autoincr_block, ap->tar_value))
196 ap->tar_valid = false;
197 else
198 ap->tar_value += inc;
199 }
200
201 /**
202 * Queue transactions setting up transfer parameters for the
203 * currently selected MEM-AP.
204 *
205 * Subsequent transfers using registers like MEM_AP_REG_DRW or MEM_AP_REG_BD2
206 * initiate data reads or writes using memory or peripheral addresses.
207 * If the CSW is configured for it, the TAR may be automatically
208 * incremented after each transfer.
209 *
210 * @param ap The MEM-AP.
211 * @param csw MEM-AP Control/Status Word (CSW) register to assign. If this
212 * matches the cached value, the register is not changed.
213 * @param tar MEM-AP Transfer Address Register (TAR) to assign. If this
214 * matches the cached address, the register is not changed.
215 *
216 * @return ERROR_OK if the transaction was properly queued, else a fault code.
217 */
218 static int mem_ap_setup_transfer(struct adiv5_ap *ap, uint32_t csw, target_addr_t tar)
219 {
220 int retval;
221 retval = mem_ap_setup_csw(ap, csw);
222 if (retval != ERROR_OK)
223 return retval;
224 retval = mem_ap_setup_tar(ap, tar);
225 if (retval != ERROR_OK)
226 return retval;
227 return ERROR_OK;
228 }
229
230 /**
231 * Asynchronous (queued) read of a word from memory or a system register.
232 *
233 * @param ap The MEM-AP to access.
234 * @param address Address of the 32-bit word to read; it must be
235 * readable by the currently selected MEM-AP.
236 * @param value points to where the word will be stored when the
237 * transaction queue is flushed (assuming no errors).
238 *
239 * @return ERROR_OK for success. Otherwise a fault code.
240 */
241 int mem_ap_read_u32(struct adiv5_ap *ap, target_addr_t address,
242 uint32_t *value)
243 {
244 int retval;
245
246 /* Use banked addressing (REG_BDx) to avoid some link traffic
247 * (updating TAR) when reading several consecutive addresses.
248 */
249 retval = mem_ap_setup_transfer(ap,
250 CSW_32BIT | (ap->csw_value & CSW_ADDRINC_MASK),
251 address & 0xFFFFFFFFFFFFFFF0ull);
252 if (retval != ERROR_OK)
253 return retval;
254
255 return dap_queue_ap_read(ap, MEM_AP_REG_BD0 | (address & 0xC), value);
256 }
257
258 /**
259 * Synchronous read of a word from memory or a system register.
260 * As a side effect, this flushes any queued transactions.
261 *
262 * @param ap The MEM-AP to access.
263 * @param address Address of the 32-bit word to read; it must be
264 * readable by the currently selected MEM-AP.
265 * @param value points to where the result will be stored.
266 *
267 * @return ERROR_OK for success; *value holds the result.
268 * Otherwise a fault code.
269 */
270 int mem_ap_read_atomic_u32(struct adiv5_ap *ap, target_addr_t address,
271 uint32_t *value)
272 {
273 int retval;
274
275 retval = mem_ap_read_u32(ap, address, value);
276 if (retval != ERROR_OK)
277 return retval;
278
279 return dap_run(ap->dap);
280 }
281
282 /**
283 * Asynchronous (queued) write of a word to memory or a system register.
284 *
285 * @param ap The MEM-AP to access.
286 * @param address Address to be written; it must be writable by
287 * the currently selected MEM-AP.
288 * @param value Word that will be written to the address when transaction
289 * queue is flushed (assuming no errors).
290 *
291 * @return ERROR_OK for success. Otherwise a fault code.
292 */
293 int mem_ap_write_u32(struct adiv5_ap *ap, target_addr_t address,
294 uint32_t value)
295 {
296 int retval;
297
298 /* Use banked addressing (REG_BDx) to avoid some link traffic
299 * (updating TAR) when writing several consecutive addresses.
300 */
301 retval = mem_ap_setup_transfer(ap,
302 CSW_32BIT | (ap->csw_value & CSW_ADDRINC_MASK),
303 address & 0xFFFFFFFFFFFFFFF0ull);
304 if (retval != ERROR_OK)
305 return retval;
306
307 return dap_queue_ap_write(ap, MEM_AP_REG_BD0 | (address & 0xC),
308 value);
309 }
310
311 /**
312 * Synchronous write of a word to memory or a system register.
313 * As a side effect, this flushes any queued transactions.
314 *
315 * @param ap The MEM-AP to access.
316 * @param address Address to be written; it must be writable by
317 * the currently selected MEM-AP.
318 * @param value Word that will be written.
319 *
320 * @return ERROR_OK for success; the data was written. Otherwise a fault code.
321 */
322 int mem_ap_write_atomic_u32(struct adiv5_ap *ap, target_addr_t address,
323 uint32_t value)
324 {
325 int retval = mem_ap_write_u32(ap, address, value);
326
327 if (retval != ERROR_OK)
328 return retval;
329
330 return dap_run(ap->dap);
331 }
332
333 /**
334 * Synchronous write of a block of memory, using a specific access size.
335 *
336 * @param ap The MEM-AP to access.
337 * @param buffer The data buffer to write. No particular alignment is assumed.
338 * @param size Which access size to use, in bytes. 1, 2 or 4.
339 * @param count The number of writes to do (in size units, not bytes).
340 * @param address Address to be written; it must be writable by the currently selected MEM-AP.
341 * @param addrinc Whether the target address should be increased for each write or not. This
342 * should normally be true, except when writing to e.g. a FIFO.
343 * @return ERROR_OK on success, otherwise an error code.
344 */
345 static int mem_ap_write(struct adiv5_ap *ap, const uint8_t *buffer, uint32_t size, uint32_t count,
346 target_addr_t address, bool addrinc)
347 {
348 struct adiv5_dap *dap = ap->dap;
349 size_t nbytes = size * count;
350 const uint32_t csw_addrincr = addrinc ? CSW_ADDRINC_SINGLE : CSW_ADDRINC_OFF;
351 uint32_t csw_size;
352 target_addr_t addr_xor;
353 int retval = ERROR_OK;
354
355 /* TI BE-32 Quirks mode:
356 * Writes on big-endian TMS570 behave very strangely. Observed behavior:
357 * size write address bytes written in order
358 * 4 TAR ^ 0 (val >> 24), (val >> 16), (val >> 8), (val)
359 * 2 TAR ^ 2 (val >> 8), (val)
360 * 1 TAR ^ 3 (val)
361 * For example, if you attempt to write a single byte to address 0, the processor
362 * will actually write a byte to address 3.
363 *
364 * To make writes of size < 4 work as expected, we xor a value with the address before
365 * setting the TAP, and we set the TAP after every transfer rather then relying on
366 * address increment. */
367
368 if (size == 4) {
369 csw_size = CSW_32BIT;
370 addr_xor = 0;
371 } else if (size == 2) {
372 csw_size = CSW_16BIT;
373 addr_xor = dap->ti_be_32_quirks ? 2 : 0;
374 } else if (size == 1) {
375 csw_size = CSW_8BIT;
376 addr_xor = dap->ti_be_32_quirks ? 3 : 0;
377 } else {
378 return ERROR_TARGET_UNALIGNED_ACCESS;
379 }
380
381 if (ap->unaligned_access_bad && (address % size != 0))
382 return ERROR_TARGET_UNALIGNED_ACCESS;
383
384 while (nbytes > 0) {
385 uint32_t this_size = size;
386
387 /* Select packed transfer if possible */
388 if (addrinc && ap->packed_transfers && nbytes >= 4
389 && max_tar_block_size(ap->tar_autoincr_block, address) >= 4) {
390 this_size = 4;
391 retval = mem_ap_setup_csw(ap, csw_size | CSW_ADDRINC_PACKED);
392 } else {
393 retval = mem_ap_setup_csw(ap, csw_size | csw_addrincr);
394 }
395
396 if (retval != ERROR_OK)
397 break;
398
399 retval = mem_ap_setup_tar(ap, address ^ addr_xor);
400 if (retval != ERROR_OK)
401 return retval;
402
403 /* How many source bytes each transfer will consume, and their location in the DRW,
404 * depends on the type of transfer and alignment. See ARM document IHI0031C. */
405 uint32_t outvalue = 0;
406 uint32_t drw_byte_idx = address;
407 if (dap->ti_be_32_quirks) {
408 switch (this_size) {
409 case 4:
410 outvalue |= (uint32_t)*buffer++ << 8 * (3 ^ (drw_byte_idx++ & 3) ^ addr_xor);
411 outvalue |= (uint32_t)*buffer++ << 8 * (3 ^ (drw_byte_idx++ & 3) ^ addr_xor);
412 outvalue |= (uint32_t)*buffer++ << 8 * (3 ^ (drw_byte_idx++ & 3) ^ addr_xor);
413 outvalue |= (uint32_t)*buffer++ << 8 * (3 ^ (drw_byte_idx & 3) ^ addr_xor);
414 break;
415 case 2:
416 outvalue |= (uint32_t)*buffer++ << 8 * (1 ^ (drw_byte_idx++ & 3) ^ addr_xor);
417 outvalue |= (uint32_t)*buffer++ << 8 * (1 ^ (drw_byte_idx & 3) ^ addr_xor);
418 break;
419 case 1:
420 outvalue |= (uint32_t)*buffer++ << 8 * (0 ^ (drw_byte_idx & 3) ^ addr_xor);
421 break;
422 }
423 } else {
424 switch (this_size) {
425 case 4:
426 outvalue |= (uint32_t)*buffer++ << 8 * (drw_byte_idx++ & 3);
427 outvalue |= (uint32_t)*buffer++ << 8 * (drw_byte_idx++ & 3);
428 /* fallthrough */
429 case 2:
430 outvalue |= (uint32_t)*buffer++ << 8 * (drw_byte_idx++ & 3);
431 /* fallthrough */
432 case 1:
433 outvalue |= (uint32_t)*buffer++ << 8 * (drw_byte_idx & 3);
434 }
435 }
436
437 nbytes -= this_size;
438
439 retval = dap_queue_ap_write(ap, MEM_AP_REG_DRW, outvalue);
440 if (retval != ERROR_OK)
441 break;
442
443 mem_ap_update_tar_cache(ap);
444 if (addrinc)
445 address += this_size;
446 }
447
448 /* REVISIT: Might want to have a queued version of this function that does not run. */
449 if (retval == ERROR_OK)
450 retval = dap_run(dap);
451
452 if (retval != ERROR_OK) {
453 target_addr_t tar;
454 if (mem_ap_read_tar(ap, &tar) == ERROR_OK)
455 LOG_ERROR("Failed to write memory at " TARGET_ADDR_FMT, tar);
456 else
457 LOG_ERROR("Failed to write memory and, additionally, failed to find out where");
458 }
459
460 return retval;
461 }
462
463 /**
464 * Synchronous read of a block of memory, using a specific access size.
465 *
466 * @param ap The MEM-AP to access.
467 * @param buffer The data buffer to receive the data. No particular alignment is assumed.
468 * @param size Which access size to use, in bytes. 1, 2 or 4.
469 * @param count The number of reads to do (in size units, not bytes).
470 * @param adr Address to be read; it must be readable by the currently selected MEM-AP.
471 * @param addrinc Whether the target address should be increased after each read or not. This
472 * should normally be true, except when reading from e.g. a FIFO.
473 * @return ERROR_OK on success, otherwise an error code.
474 */
475 static int mem_ap_read(struct adiv5_ap *ap, uint8_t *buffer, uint32_t size, uint32_t count,
476 target_addr_t adr, bool addrinc)
477 {
478 struct adiv5_dap *dap = ap->dap;
479 size_t nbytes = size * count;
480 const uint32_t csw_addrincr = addrinc ? CSW_ADDRINC_SINGLE : CSW_ADDRINC_OFF;
481 uint32_t csw_size;
482 target_addr_t address = adr;
483 int retval = ERROR_OK;
484
485 /* TI BE-32 Quirks mode:
486 * Reads on big-endian TMS570 behave strangely differently than writes.
487 * They read from the physical address requested, but with DRW byte-reversed.
488 * For example, a byte read from address 0 will place the result in the high bytes of DRW.
489 * Also, packed 8-bit and 16-bit transfers seem to sometimes return garbage in some bytes,
490 * so avoid them. */
491
492 if (size == 4)
493 csw_size = CSW_32BIT;
494 else if (size == 2)
495 csw_size = CSW_16BIT;
496 else if (size == 1)
497 csw_size = CSW_8BIT;
498 else
499 return ERROR_TARGET_UNALIGNED_ACCESS;
500
501 if (ap->unaligned_access_bad && (adr % size != 0))
502 return ERROR_TARGET_UNALIGNED_ACCESS;
503
504 /* Allocate buffer to hold the sequence of DRW reads that will be made. This is a significant
505 * over-allocation if packed transfers are going to be used, but determining the real need at
506 * this point would be messy. */
507 uint32_t *read_buf = calloc(count, sizeof(uint32_t));
508 /* Multiplication count * sizeof(uint32_t) may overflow, calloc() is safe */
509 uint32_t *read_ptr = read_buf;
510 if (!read_buf) {
511 LOG_ERROR("Failed to allocate read buffer");
512 return ERROR_FAIL;
513 }
514
515 /* Queue up all reads. Each read will store the entire DRW word in the read buffer. How many
516 * useful bytes it contains, and their location in the word, depends on the type of transfer
517 * and alignment. */
518 while (nbytes > 0) {
519 uint32_t this_size = size;
520
521 /* Select packed transfer if possible */
522 if (addrinc && ap->packed_transfers && nbytes >= 4
523 && max_tar_block_size(ap->tar_autoincr_block, address) >= 4) {
524 this_size = 4;
525 retval = mem_ap_setup_csw(ap, csw_size | CSW_ADDRINC_PACKED);
526 } else {
527 retval = mem_ap_setup_csw(ap, csw_size | csw_addrincr);
528 }
529 if (retval != ERROR_OK)
530 break;
531
532 retval = mem_ap_setup_tar(ap, address);
533 if (retval != ERROR_OK)
534 break;
535
536 retval = dap_queue_ap_read(ap, MEM_AP_REG_DRW, read_ptr++);
537 if (retval != ERROR_OK)
538 break;
539
540 nbytes -= this_size;
541 if (addrinc)
542 address += this_size;
543
544 mem_ap_update_tar_cache(ap);
545 }
546
547 if (retval == ERROR_OK)
548 retval = dap_run(dap);
549
550 /* Restore state */
551 address = adr;
552 nbytes = size * count;
553 read_ptr = read_buf;
554
555 /* If something failed, read TAR to find out how much data was successfully read, so we can
556 * at least give the caller what we have. */
557 if (retval != ERROR_OK) {
558 target_addr_t tar;
559 if (mem_ap_read_tar(ap, &tar) == ERROR_OK) {
560 /* TAR is incremented after failed transfer on some devices (eg Cortex-M4) */
561 LOG_ERROR("Failed to read memory at " TARGET_ADDR_FMT, tar);
562 if (nbytes > tar - address)
563 nbytes = tar - address;
564 } else {
565 LOG_ERROR("Failed to read memory and, additionally, failed to find out where");
566 nbytes = 0;
567 }
568 }
569
570 /* Replay loop to populate caller's buffer from the correct word and byte lane */
571 while (nbytes > 0) {
572 uint32_t this_size = size;
573
574 if (addrinc && ap->packed_transfers && nbytes >= 4
575 && max_tar_block_size(ap->tar_autoincr_block, address) >= 4) {
576 this_size = 4;
577 }
578
579 if (dap->ti_be_32_quirks) {
580 switch (this_size) {
581 case 4:
582 *buffer++ = *read_ptr >> 8 * (3 - (address++ & 3));
583 *buffer++ = *read_ptr >> 8 * (3 - (address++ & 3));
584 /* fallthrough */
585 case 2:
586 *buffer++ = *read_ptr >> 8 * (3 - (address++ & 3));
587 /* fallthrough */
588 case 1:
589 *buffer++ = *read_ptr >> 8 * (3 - (address++ & 3));
590 }
591 } else {
592 switch (this_size) {
593 case 4:
594 *buffer++ = *read_ptr >> 8 * (address++ & 3);
595 *buffer++ = *read_ptr >> 8 * (address++ & 3);
596 /* fallthrough */
597 case 2:
598 *buffer++ = *read_ptr >> 8 * (address++ & 3);
599 /* fallthrough */
600 case 1:
601 *buffer++ = *read_ptr >> 8 * (address++ & 3);
602 }
603 }
604
605 read_ptr++;
606 nbytes -= this_size;
607 }
608
609 free(read_buf);
610 return retval;
611 }
612
613 int mem_ap_read_buf(struct adiv5_ap *ap,
614 uint8_t *buffer, uint32_t size, uint32_t count, target_addr_t address)
615 {
616 return mem_ap_read(ap, buffer, size, count, address, true);
617 }
618
619 int mem_ap_write_buf(struct adiv5_ap *ap,
620 const uint8_t *buffer, uint32_t size, uint32_t count, target_addr_t address)
621 {
622 return mem_ap_write(ap, buffer, size, count, address, true);
623 }
624
625 int mem_ap_read_buf_noincr(struct adiv5_ap *ap,
626 uint8_t *buffer, uint32_t size, uint32_t count, target_addr_t address)
627 {
628 return mem_ap_read(ap, buffer, size, count, address, false);
629 }
630
631 int mem_ap_write_buf_noincr(struct adiv5_ap *ap,
632 const uint8_t *buffer, uint32_t size, uint32_t count, target_addr_t address)
633 {
634 return mem_ap_write(ap, buffer, size, count, address, false);
635 }
636
637 /*--------------------------------------------------------------------------*/
638
639
640 #define DAP_POWER_DOMAIN_TIMEOUT (10)
641
642 /*--------------------------------------------------------------------------*/
643
644 /**
645 * Invalidate cached DP select and cached TAR and CSW of all APs
646 */
647 void dap_invalidate_cache(struct adiv5_dap *dap)
648 {
649 dap->select = DP_SELECT_INVALID;
650 dap->last_read = NULL;
651
652 int i;
653 for (i = 0; i <= DP_APSEL_MAX; i++) {
654 /* force csw and tar write on the next mem-ap access */
655 dap->ap[i].tar_valid = false;
656 dap->ap[i].csw_value = 0;
657 }
658 }
659
660 /**
661 * Initialize a DAP. This sets up the power domains, prepares the DP
662 * for further use and activates overrun checking.
663 *
664 * @param dap The DAP being initialized.
665 */
666 int dap_dp_init(struct adiv5_dap *dap)
667 {
668 int retval;
669
670 LOG_DEBUG("%s", adiv5_dap_name(dap));
671
672 dap->do_reconnect = false;
673 dap_invalidate_cache(dap);
674
675 /*
676 * Early initialize dap->dp_ctrl_stat.
677 * In jtag mode only, if the following queue run (in dap_dp_poll_register)
678 * fails and sets the sticky error, it will trigger the clearing
679 * of the sticky. Without this initialization system and debug power
680 * would be disabled while clearing the sticky error bit.
681 */
682 dap->dp_ctrl_stat = CDBGPWRUPREQ | CSYSPWRUPREQ;
683
684 /*
685 * This write operation clears the sticky error bit in jtag mode only and
686 * is ignored in swd mode. It also powers-up system and debug domains in
687 * both jtag and swd modes, if not done before.
688 */
689 retval = dap_queue_dp_write(dap, DP_CTRL_STAT, dap->dp_ctrl_stat | SSTICKYERR);
690 if (retval != ERROR_OK)
691 return retval;
692
693 retval = dap_queue_dp_read(dap, DP_CTRL_STAT, NULL);
694 if (retval != ERROR_OK)
695 return retval;
696
697 retval = dap_queue_dp_write(dap, DP_CTRL_STAT, dap->dp_ctrl_stat);
698 if (retval != ERROR_OK)
699 return retval;
700
701 /* Check that we have debug power domains activated */
702 LOG_DEBUG("DAP: wait CDBGPWRUPACK");
703 retval = dap_dp_poll_register(dap, DP_CTRL_STAT,
704 CDBGPWRUPACK, CDBGPWRUPACK,
705 DAP_POWER_DOMAIN_TIMEOUT);
706 if (retval != ERROR_OK)
707 return retval;
708
709 if (!dap->ignore_syspwrupack) {
710 LOG_DEBUG("DAP: wait CSYSPWRUPACK");
711 retval = dap_dp_poll_register(dap, DP_CTRL_STAT,
712 CSYSPWRUPACK, CSYSPWRUPACK,
713 DAP_POWER_DOMAIN_TIMEOUT);
714 if (retval != ERROR_OK)
715 return retval;
716 }
717
718 retval = dap_queue_dp_read(dap, DP_CTRL_STAT, NULL);
719 if (retval != ERROR_OK)
720 return retval;
721
722 /* With debug power on we can activate OVERRUN checking */
723 dap->dp_ctrl_stat = CDBGPWRUPREQ | CSYSPWRUPREQ | CORUNDETECT;
724 retval = dap_queue_dp_write(dap, DP_CTRL_STAT, dap->dp_ctrl_stat);
725 if (retval != ERROR_OK)
726 return retval;
727 retval = dap_queue_dp_read(dap, DP_CTRL_STAT, NULL);
728 if (retval != ERROR_OK)
729 return retval;
730
731 retval = dap_run(dap);
732 if (retval != ERROR_OK)
733 return retval;
734
735 return retval;
736 }
737
738 /**
739 * Initialize a DAP or do reconnect if DAP is not accessible.
740 *
741 * @param dap The DAP being initialized.
742 */
743 int dap_dp_init_or_reconnect(struct adiv5_dap *dap)
744 {
745 LOG_DEBUG("%s", adiv5_dap_name(dap));
746
747 /*
748 * Early initialize dap->dp_ctrl_stat.
749 * In jtag mode only, if the following atomic reads fail and set the
750 * sticky error, it will trigger the clearing of the sticky. Without this
751 * initialization system and debug power would be disabled while clearing
752 * the sticky error bit.
753 */
754 dap->dp_ctrl_stat = CDBGPWRUPREQ | CSYSPWRUPREQ;
755
756 dap->do_reconnect = false;
757
758 dap_dp_read_atomic(dap, DP_CTRL_STAT, NULL);
759 if (dap->do_reconnect) {
760 /* dap connect calls dap_dp_init() after transport dependent initialization */
761 return dap->ops->connect(dap);
762 } else {
763 return dap_dp_init(dap);
764 }
765 }
766
767 /**
768 * Initialize a DAP. This sets up the power domains, prepares the DP
769 * for further use, and arranges to use AP #0 for all AP operations
770 * until dap_ap-select() changes that policy.
771 *
772 * @param ap The MEM-AP being initialized.
773 */
774 int mem_ap_init(struct adiv5_ap *ap)
775 {
776 /* check that we support packed transfers */
777 uint32_t csw, cfg;
778 int retval;
779 struct adiv5_dap *dap = ap->dap;
780
781 /* Set ap->cfg_reg before calling mem_ap_setup_transfer(). */
782 /* mem_ap_setup_transfer() needs to know if the MEM_AP supports LPAE. */
783 retval = dap_queue_ap_read(ap, MEM_AP_REG_CFG, &cfg);
784 if (retval != ERROR_OK)
785 return retval;
786
787 retval = dap_run(dap);
788 if (retval != ERROR_OK)
789 return retval;
790
791 ap->cfg_reg = cfg;
792 ap->tar_valid = false;
793 ap->csw_value = 0; /* force csw and tar write */
794 retval = mem_ap_setup_transfer(ap, CSW_8BIT | CSW_ADDRINC_PACKED, 0);
795 if (retval != ERROR_OK)
796 return retval;
797
798 retval = dap_queue_ap_read(ap, MEM_AP_REG_CSW, &csw);
799 if (retval != ERROR_OK)
800 return retval;
801
802 retval = dap_run(dap);
803 if (retval != ERROR_OK)
804 return retval;
805
806 if (csw & CSW_ADDRINC_PACKED)
807 ap->packed_transfers = true;
808 else
809 ap->packed_transfers = false;
810
811 /* Packed transfers on TI BE-32 processors do not work correctly in
812 * many cases. */
813 if (dap->ti_be_32_quirks)
814 ap->packed_transfers = false;
815
816 LOG_DEBUG("MEM_AP Packed Transfers: %s",
817 ap->packed_transfers ? "enabled" : "disabled");
818
819 /* The ARM ADI spec leaves implementation-defined whether unaligned
820 * memory accesses work, only work partially, or cause a sticky error.
821 * On TI BE-32 processors, reads seem to return garbage in some bytes
822 * and unaligned writes seem to cause a sticky error.
823 * TODO: it would be nice to have a way to detect whether unaligned
824 * operations are supported on other processors. */
825 ap->unaligned_access_bad = dap->ti_be_32_quirks;
826
827 LOG_DEBUG("MEM_AP CFG: large data %d, long address %d, big-endian %d",
828 !!(cfg & MEM_AP_REG_CFG_LD), !!(cfg & MEM_AP_REG_CFG_LA), !!(cfg & MEM_AP_REG_CFG_BE));
829
830 return ERROR_OK;
831 }
832
833 /**
834 * Put the debug link into SWD mode, if the target supports it.
835 * The link's initial mode may be either JTAG (for example,
836 * with SWJ-DP after reset) or SWD.
837 *
838 * Note that targets using the JTAG-DP do not support SWD, and that
839 * some targets which could otherwise support it may have been
840 * configured to disable SWD signaling
841 *
842 * @param dap The DAP used
843 * @return ERROR_OK or else a fault code.
844 */
845 int dap_to_swd(struct adiv5_dap *dap)
846 {
847 LOG_DEBUG("Enter SWD mode");
848
849 return dap_send_sequence(dap, JTAG_TO_SWD);
850 }
851
852 /**
853 * Put the debug link into JTAG mode, if the target supports it.
854 * The link's initial mode may be either SWD or JTAG.
855 *
856 * Note that targets implemented with SW-DP do not support JTAG, and
857 * that some targets which could otherwise support it may have been
858 * configured to disable JTAG signaling
859 *
860 * @param dap The DAP used
861 * @return ERROR_OK or else a fault code.
862 */
863 int dap_to_jtag(struct adiv5_dap *dap)
864 {
865 LOG_DEBUG("Enter JTAG mode");
866
867 return dap_send_sequence(dap, SWD_TO_JTAG);
868 }
869
870 /* CID interpretation -- see ARM IHI 0029E table B2-7
871 * and ARM IHI 0031E table D1-2.
872 *
873 * From 2009/11/25 commit 21378f58b604:
874 * "OptimoDE DESS" is ARM's semicustom DSPish stuff.
875 * Let's keep it as is, for the time being
876 */
877 static const char *class_description[16] = {
878 [0x0] = "Generic verification component",
879 [0x1] = "ROM table",
880 [0x2] = "Reserved",
881 [0x3] = "Reserved",
882 [0x4] = "Reserved",
883 [0x5] = "Reserved",
884 [0x6] = "Reserved",
885 [0x7] = "Reserved",
886 [0x8] = "Reserved",
887 [0x9] = "CoreSight component",
888 [0xA] = "Reserved",
889 [0xB] = "Peripheral Test Block",
890 [0xC] = "Reserved",
891 [0xD] = "OptimoDE DESS", /* see above */
892 [0xE] = "Generic IP component",
893 [0xF] = "CoreLink, PrimeCell or System component",
894 };
895
896 /*
897 * This function checks the ID for each access port to find the requested Access Port type
898 */
899 int dap_find_ap(struct adiv5_dap *dap, enum ap_type type_to_find, struct adiv5_ap **ap_out)
900 {
901 int ap_num;
902
903 /* Maximum AP number is 255 since the SELECT register is 8 bits */
904 for (ap_num = 0; ap_num <= DP_APSEL_MAX; ap_num++) {
905
906 /* read the IDR register of the Access Port */
907 uint32_t id_val = 0;
908
909 int retval = dap_queue_ap_read(dap_ap(dap, ap_num), AP_REG_IDR, &id_val);
910 if (retval != ERROR_OK)
911 return retval;
912
913 retval = dap_run(dap);
914
915 /* IDR bits:
916 * 31-28 : Revision
917 * 27-24 : JEDEC bank (0x4 for ARM)
918 * 23-17 : JEDEC code (0x3B for ARM)
919 * 16-13 : Class (0b1000=Mem-AP)
920 * 12-8 : Reserved
921 * 7-4 : AP Variant (non-zero for JTAG-AP)
922 * 3-0 : AP Type (0=JTAG-AP 1=AHB-AP 2=APB-AP 4=AXI-AP)
923 */
924
925 /* Reading register for a non-existent AP should not cause an error,
926 * but just to be sure, try to continue searching if an error does happen.
927 */
928 if ((retval == ERROR_OK) && /* Register read success */
929 ((id_val & IDR_JEP106) == IDR_JEP106_ARM) && /* Jedec codes match */
930 ((id_val & IDR_TYPE) == type_to_find)) { /* type matches*/
931
932 LOG_DEBUG("Found %s at AP index: %d (IDR=0x%08" PRIX32 ")",
933 (type_to_find == AP_TYPE_AHB3_AP) ? "AHB3-AP" :
934 (type_to_find == AP_TYPE_AHB5_AP) ? "AHB5-AP" :
935 (type_to_find == AP_TYPE_APB_AP) ? "APB-AP" :
936 (type_to_find == AP_TYPE_AXI_AP) ? "AXI-AP" :
937 (type_to_find == AP_TYPE_JTAG_AP) ? "JTAG-AP" : "Unknown",
938 ap_num, id_val);
939
940 *ap_out = &dap->ap[ap_num];
941 return ERROR_OK;
942 }
943 }
944
945 LOG_DEBUG("No %s found",
946 (type_to_find == AP_TYPE_AHB3_AP) ? "AHB3-AP" :
947 (type_to_find == AP_TYPE_AHB5_AP) ? "AHB5-AP" :
948 (type_to_find == AP_TYPE_APB_AP) ? "APB-AP" :
949 (type_to_find == AP_TYPE_AXI_AP) ? "AXI-AP" :
950 (type_to_find == AP_TYPE_JTAG_AP) ? "JTAG-AP" : "Unknown");
951 return ERROR_FAIL;
952 }
953
954 int dap_get_debugbase(struct adiv5_ap *ap,
955 target_addr_t *dbgbase, uint32_t *apid)
956 {
957 struct adiv5_dap *dap = ap->dap;
958 int retval;
959 uint32_t baseptr_upper, baseptr_lower;
960
961 if (ap->cfg_reg == MEM_AP_REG_CFG_INVALID) {
962 retval = dap_queue_ap_read(ap, MEM_AP_REG_CFG, &ap->cfg_reg);
963 if (retval != ERROR_OK)
964 return retval;
965 }
966 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE, &baseptr_lower);
967 if (retval != ERROR_OK)
968 return retval;
969 retval = dap_queue_ap_read(ap, AP_REG_IDR, apid);
970 if (retval != ERROR_OK)
971 return retval;
972 /* MEM_AP_REG_BASE64 is defined as 'RES0'; can be read and then ignored on 32 bits AP */
973 if (ap->cfg_reg == MEM_AP_REG_CFG_INVALID || is_64bit_ap(ap)) {
974 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE64, &baseptr_upper);
975 if (retval != ERROR_OK)
976 return retval;
977 }
978
979 retval = dap_run(dap);
980 if (retval != ERROR_OK)
981 return retval;
982
983 if (!is_64bit_ap(ap))
984 baseptr_upper = 0;
985 *dbgbase = (((target_addr_t)baseptr_upper) << 32) | baseptr_lower;
986
987 return ERROR_OK;
988 }
989
990 int dap_lookup_cs_component(struct adiv5_ap *ap,
991 target_addr_t dbgbase, uint8_t type, target_addr_t *addr, int32_t *idx)
992 {
993 uint32_t romentry, entry_offset = 0, devtype;
994 target_addr_t component_base;
995 int retval;
996
997 dbgbase &= 0xFFFFFFFFFFFFF000ull;
998 *addr = 0;
999
1000 do {
1001 retval = mem_ap_read_atomic_u32(ap, dbgbase |
1002 entry_offset, &romentry);
1003 if (retval != ERROR_OK)
1004 return retval;
1005
1006 component_base = dbgbase + (target_addr_t)(romentry & ARM_CS_ROMENTRY_OFFSET_MASK);
1007
1008 if (romentry & ARM_CS_ROMENTRY_PRESENT) {
1009 uint32_t c_cid1;
1010 retval = mem_ap_read_atomic_u32(ap, component_base + ARM_CS_CIDR1, &c_cid1);
1011 if (retval != ERROR_OK) {
1012 LOG_ERROR("Can't read component with base address " TARGET_ADDR_FMT
1013 ", the corresponding core might be turned off", component_base);
1014 return retval;
1015 }
1016 unsigned int class = (c_cid1 & ARM_CS_CIDR1_CLASS_MASK) >> ARM_CS_CIDR1_CLASS_SHIFT;
1017 if (class == ARM_CS_CLASS_0X1_ROM_TABLE) {
1018 retval = dap_lookup_cs_component(ap, component_base,
1019 type, addr, idx);
1020 if (retval == ERROR_OK)
1021 break;
1022 if (retval != ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1023 return retval;
1024 }
1025
1026 retval = mem_ap_read_atomic_u32(ap, component_base + ARM_CS_C9_DEVTYPE, &devtype);
1027 if (retval != ERROR_OK)
1028 return retval;
1029 if ((devtype & ARM_CS_C9_DEVTYPE_MASK) == type) {
1030 if (!*idx) {
1031 *addr = component_base;
1032 break;
1033 } else
1034 (*idx)--;
1035 }
1036 }
1037 entry_offset += 4;
1038 } while ((romentry > 0) && (entry_offset < 0xf00));
1039
1040 if (!*addr)
1041 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1042
1043 return ERROR_OK;
1044 }
1045
1046 static int dap_read_part_id(struct adiv5_ap *ap, target_addr_t component_base, uint32_t *cid, uint64_t *pid)
1047 {
1048 assert(IS_ALIGNED(component_base, ARM_CS_ALIGN));
1049 assert(ap && cid && pid);
1050
1051 uint32_t cid0, cid1, cid2, cid3;
1052 uint32_t pid0, pid1, pid2, pid3, pid4;
1053 int retval;
1054
1055 /* IDs are in last 4K section */
1056 retval = mem_ap_read_u32(ap, component_base + ARM_CS_PIDR0, &pid0);
1057 if (retval != ERROR_OK)
1058 return retval;
1059 retval = mem_ap_read_u32(ap, component_base + ARM_CS_PIDR1, &pid1);
1060 if (retval != ERROR_OK)
1061 return retval;
1062 retval = mem_ap_read_u32(ap, component_base + ARM_CS_PIDR2, &pid2);
1063 if (retval != ERROR_OK)
1064 return retval;
1065 retval = mem_ap_read_u32(ap, component_base + ARM_CS_PIDR3, &pid3);
1066 if (retval != ERROR_OK)
1067 return retval;
1068 retval = mem_ap_read_u32(ap, component_base + ARM_CS_PIDR4, &pid4);
1069 if (retval != ERROR_OK)
1070 return retval;
1071 retval = mem_ap_read_u32(ap, component_base + ARM_CS_CIDR0, &cid0);
1072 if (retval != ERROR_OK)
1073 return retval;
1074 retval = mem_ap_read_u32(ap, component_base + ARM_CS_CIDR1, &cid1);
1075 if (retval != ERROR_OK)
1076 return retval;
1077 retval = mem_ap_read_u32(ap, component_base + ARM_CS_CIDR2, &cid2);
1078 if (retval != ERROR_OK)
1079 return retval;
1080 retval = mem_ap_read_u32(ap, component_base + ARM_CS_CIDR3, &cid3);
1081 if (retval != ERROR_OK)
1082 return retval;
1083
1084 retval = dap_run(ap->dap);
1085 if (retval != ERROR_OK)
1086 return retval;
1087
1088 *cid = (cid3 & 0xff) << 24
1089 | (cid2 & 0xff) << 16
1090 | (cid1 & 0xff) << 8
1091 | (cid0 & 0xff);
1092 *pid = (uint64_t)(pid4 & 0xff) << 32
1093 | (pid3 & 0xff) << 24
1094 | (pid2 & 0xff) << 16
1095 | (pid1 & 0xff) << 8
1096 | (pid0 & 0xff);
1097
1098 return ERROR_OK;
1099 }
1100
1101 /* Part number interpretations are from Cortex
1102 * core specs, the CoreSight components TRM
1103 * (ARM DDI 0314H), CoreSight System Design
1104 * Guide (ARM DGI 0012D) and ETM specs; also
1105 * from chip observation (e.g. TI SDTI).
1106 */
1107
1108 /* The legacy code only used the part number field to identify CoreSight peripherals.
1109 * This meant that the same part number from two different manufacturers looked the same.
1110 * It is desirable for all future additions to identify with both part number and JEP106.
1111 * "ANY_ID" is a wildcard (any JEP106) only to preserve legacy behavior for legacy entries.
1112 */
1113
1114 #define ANY_ID 0x1000
1115
1116 #define ARM_ID 0x23B
1117
1118 static const struct {
1119 uint16_t designer_id;
1120 uint16_t part_num;
1121 const char *type;
1122 const char *full;
1123 } dap_partnums[] = {
1124 { ARM_ID, 0x000, "Cortex-M3 SCS", "(System Control Space)", },
1125 { ARM_ID, 0x001, "Cortex-M3 ITM", "(Instrumentation Trace Module)", },
1126 { ARM_ID, 0x002, "Cortex-M3 DWT", "(Data Watchpoint and Trace)", },
1127 { ARM_ID, 0x003, "Cortex-M3 FPB", "(Flash Patch and Breakpoint)", },
1128 { ARM_ID, 0x008, "Cortex-M0 SCS", "(System Control Space)", },
1129 { ARM_ID, 0x00a, "Cortex-M0 DWT", "(Data Watchpoint and Trace)", },
1130 { ARM_ID, 0x00b, "Cortex-M0 BPU", "(Breakpoint Unit)", },
1131 { ARM_ID, 0x00c, "Cortex-M4 SCS", "(System Control Space)", },
1132 { ARM_ID, 0x00d, "CoreSight ETM11", "(Embedded Trace)", },
1133 { ARM_ID, 0x00e, "Cortex-M7 FPB", "(Flash Patch and Breakpoint)", },
1134 { ARM_ID, 0x470, "Cortex-M1 ROM", "(ROM Table)", },
1135 { ARM_ID, 0x471, "Cortex-M0 ROM", "(ROM Table)", },
1136 { ARM_ID, 0x490, "Cortex-A15 GIC", "(Generic Interrupt Controller)", },
1137 { ARM_ID, 0x4a1, "Cortex-A53 ROM", "(v8 Memory Map ROM Table)", },
1138 { ARM_ID, 0x4a2, "Cortex-A57 ROM", "(ROM Table)", },
1139 { ARM_ID, 0x4a3, "Cortex-A53 ROM", "(v7 Memory Map ROM Table)", },
1140 { ARM_ID, 0x4a4, "Cortex-A72 ROM", "(ROM Table)", },
1141 { ARM_ID, 0x4a9, "Cortex-A9 ROM", "(ROM Table)", },
1142 { ARM_ID, 0x4aa, "Cortex-A35 ROM", "(v8 Memory Map ROM Table)", },
1143 { ARM_ID, 0x4af, "Cortex-A15 ROM", "(ROM Table)", },
1144 { ARM_ID, 0x4b5, "Cortex-R5 ROM", "(ROM Table)", },
1145 { ARM_ID, 0x4c0, "Cortex-M0+ ROM", "(ROM Table)", },
1146 { ARM_ID, 0x4c3, "Cortex-M3 ROM", "(ROM Table)", },
1147 { ARM_ID, 0x4c4, "Cortex-M4 ROM", "(ROM Table)", },
1148 { ARM_ID, 0x4c7, "Cortex-M7 PPB ROM", "(Private Peripheral Bus ROM Table)", },
1149 { ARM_ID, 0x4c8, "Cortex-M7 ROM", "(ROM Table)", },
1150 { ARM_ID, 0x4e0, "Cortex-A35 ROM", "(v7 Memory Map ROM Table)", },
1151 { ARM_ID, 0x4e4, "Cortex-A76 ROM", "(ROM Table)", },
1152 { ARM_ID, 0x906, "CoreSight CTI", "(Cross Trigger)", },
1153 { ARM_ID, 0x907, "CoreSight ETB", "(Trace Buffer)", },
1154 { ARM_ID, 0x908, "CoreSight CSTF", "(Trace Funnel)", },
1155 { ARM_ID, 0x909, "CoreSight ATBR", "(Advanced Trace Bus Replicator)", },
1156 { ARM_ID, 0x910, "CoreSight ETM9", "(Embedded Trace)", },
1157 { ARM_ID, 0x912, "CoreSight TPIU", "(Trace Port Interface Unit)", },
1158 { ARM_ID, 0x913, "CoreSight ITM", "(Instrumentation Trace Macrocell)", },
1159 { ARM_ID, 0x914, "CoreSight SWO", "(Single Wire Output)", },
1160 { ARM_ID, 0x917, "CoreSight HTM", "(AHB Trace Macrocell)", },
1161 { ARM_ID, 0x920, "CoreSight ETM11", "(Embedded Trace)", },
1162 { ARM_ID, 0x921, "Cortex-A8 ETM", "(Embedded Trace)", },
1163 { ARM_ID, 0x922, "Cortex-A8 CTI", "(Cross Trigger)", },
1164 { ARM_ID, 0x923, "Cortex-M3 TPIU", "(Trace Port Interface Unit)", },
1165 { ARM_ID, 0x924, "Cortex-M3 ETM", "(Embedded Trace)", },
1166 { ARM_ID, 0x925, "Cortex-M4 ETM", "(Embedded Trace)", },
1167 { ARM_ID, 0x930, "Cortex-R4 ETM", "(Embedded Trace)", },
1168 { ARM_ID, 0x931, "Cortex-R5 ETM", "(Embedded Trace)", },
1169 { ARM_ID, 0x932, "CoreSight MTB-M0+", "(Micro Trace Buffer)", },
1170 { ARM_ID, 0x941, "CoreSight TPIU-Lite", "(Trace Port Interface Unit)", },
1171 { ARM_ID, 0x950, "Cortex-A9 PTM", "(Program Trace Macrocell)", },
1172 { ARM_ID, 0x955, "Cortex-A5 ETM", "(Embedded Trace)", },
1173 { ARM_ID, 0x95a, "Cortex-A72 ETM", "(Embedded Trace)", },
1174 { ARM_ID, 0x95b, "Cortex-A17 PTM", "(Program Trace Macrocell)", },
1175 { ARM_ID, 0x95d, "Cortex-A53 ETM", "(Embedded Trace)", },
1176 { ARM_ID, 0x95e, "Cortex-A57 ETM", "(Embedded Trace)", },
1177 { ARM_ID, 0x95f, "Cortex-A15 PTM", "(Program Trace Macrocell)", },
1178 { ARM_ID, 0x961, "CoreSight TMC", "(Trace Memory Controller)", },
1179 { ARM_ID, 0x962, "CoreSight STM", "(System Trace Macrocell)", },
1180 { ARM_ID, 0x975, "Cortex-M7 ETM", "(Embedded Trace)", },
1181 { ARM_ID, 0x9a0, "CoreSight PMU", "(Performance Monitoring Unit)", },
1182 { ARM_ID, 0x9a1, "Cortex-M4 TPIU", "(Trace Port Interface Unit)", },
1183 { ARM_ID, 0x9a4, "CoreSight GPR", "(Granular Power Requester)", },
1184 { ARM_ID, 0x9a5, "Cortex-A5 PMU", "(Performance Monitor Unit)", },
1185 { ARM_ID, 0x9a7, "Cortex-A7 PMU", "(Performance Monitor Unit)", },
1186 { ARM_ID, 0x9a8, "Cortex-A53 CTI", "(Cross Trigger)", },
1187 { ARM_ID, 0x9a9, "Cortex-M7 TPIU", "(Trace Port Interface Unit)", },
1188 { ARM_ID, 0x9ae, "Cortex-A17 PMU", "(Performance Monitor Unit)", },
1189 { ARM_ID, 0x9af, "Cortex-A15 PMU", "(Performance Monitor Unit)", },
1190 { ARM_ID, 0x9b7, "Cortex-R7 PMU", "(Performance Monitor Unit)", },
1191 { ARM_ID, 0x9d3, "Cortex-A53 PMU", "(Performance Monitor Unit)", },
1192 { ARM_ID, 0x9d7, "Cortex-A57 PMU", "(Performance Monitor Unit)", },
1193 { ARM_ID, 0x9d8, "Cortex-A72 PMU", "(Performance Monitor Unit)", },
1194 { ARM_ID, 0x9da, "Cortex-A35 PMU/CTI/ETM", "(Performance Monitor Unit/Cross Trigger/ETM)", },
1195 { ARM_ID, 0xc05, "Cortex-A5 Debug", "(Debug Unit)", },
1196 { ARM_ID, 0xc07, "Cortex-A7 Debug", "(Debug Unit)", },
1197 { ARM_ID, 0xc08, "Cortex-A8 Debug", "(Debug Unit)", },
1198 { ARM_ID, 0xc09, "Cortex-A9 Debug", "(Debug Unit)", },
1199 { ARM_ID, 0xc0e, "Cortex-A17 Debug", "(Debug Unit)", },
1200 { ARM_ID, 0xc0f, "Cortex-A15 Debug", "(Debug Unit)", },
1201 { ARM_ID, 0xc14, "Cortex-R4 Debug", "(Debug Unit)", },
1202 { ARM_ID, 0xc15, "Cortex-R5 Debug", "(Debug Unit)", },
1203 { ARM_ID, 0xc17, "Cortex-R7 Debug", "(Debug Unit)", },
1204 { ARM_ID, 0xd03, "Cortex-A53 Debug", "(Debug Unit)", },
1205 { ARM_ID, 0xd04, "Cortex-A35 Debug", "(Debug Unit)", },
1206 { ARM_ID, 0xd07, "Cortex-A57 Debug", "(Debug Unit)", },
1207 { ARM_ID, 0xd08, "Cortex-A72 Debug", "(Debug Unit)", },
1208 { ARM_ID, 0xd0b, "Cortex-A76 Debug", "(Debug Unit)", },
1209 { 0x017, 0x9af, "MSP432 ROM", "(ROM Table)" },
1210 { 0x01f, 0xcd0, "Atmel CPU with DSU", "(CPU)" },
1211 { 0x041, 0x1db, "XMC4500 ROM", "(ROM Table)" },
1212 { 0x041, 0x1df, "XMC4700/4800 ROM", "(ROM Table)" },
1213 { 0x041, 0x1ed, "XMC1000 ROM", "(ROM Table)" },
1214 { 0x065, 0x000, "SHARC+/Blackfin+", "", },
1215 { 0x070, 0x440, "Qualcomm QDSS Component v1", "(Qualcomm Designed CoreSight Component v1)", },
1216 { 0x0bf, 0x100, "Brahma-B53 Debug", "(Debug Unit)", },
1217 { 0x0bf, 0x9d3, "Brahma-B53 PMU", "(Performance Monitor Unit)", },
1218 { 0x0bf, 0x4a1, "Brahma-B53 ROM", "(ROM Table)", },
1219 { 0x0bf, 0x721, "Brahma-B53 ROM", "(ROM Table)", },
1220 { 0x1eb, 0x181, "Tegra 186 ROM", "(ROM Table)", },
1221 { 0x1eb, 0x202, "Denver ETM", "(Denver Embedded Trace)", },
1222 { 0x1eb, 0x211, "Tegra 210 ROM", "(ROM Table)", },
1223 { 0x1eb, 0x302, "Denver Debug", "(Debug Unit)", },
1224 { 0x1eb, 0x402, "Denver PMU", "(Performance Monitor Unit)", },
1225 /* legacy comment: 0x113: what? */
1226 { ANY_ID, 0x120, "TI SDTI", "(System Debug Trace Interface)", }, /* from OMAP3 memmap */
1227 { ANY_ID, 0x343, "TI DAPCTL", "", }, /* from OMAP3 memmap */
1228 };
1229
1230 static int dap_rom_display(struct command_invocation *cmd,
1231 struct adiv5_ap *ap, target_addr_t dbgbase, int depth)
1232 {
1233 int retval;
1234 uint64_t pid;
1235 uint32_t cid;
1236 char tabs[16] = "";
1237
1238 if (depth > 16) {
1239 command_print(cmd, "\tTables too deep");
1240 return ERROR_FAIL;
1241 }
1242
1243 if (depth)
1244 snprintf(tabs, sizeof(tabs), "[L%02d] ", depth);
1245
1246 target_addr_t base_addr = dbgbase & 0xFFFFFFFFFFFFF000ull;
1247 command_print(cmd, "\t\tComponent base address " TARGET_ADDR_FMT, base_addr);
1248
1249 retval = dap_read_part_id(ap, base_addr, &cid, &pid);
1250 if (retval != ERROR_OK) {
1251 command_print(cmd, "\t\tCan't read component, the corresponding core might be turned off");
1252 return ERROR_OK; /* Don't abort recursion */
1253 }
1254
1255 if (!is_valid_arm_cs_cidr(cid)) {
1256 command_print(cmd, "\t\tInvalid CID 0x%08" PRIx32, cid);
1257 return ERROR_OK; /* Don't abort recursion */
1258 }
1259
1260 /* component may take multiple 4K pages */
1261 uint32_t size = ARM_CS_PIDR_SIZE(pid);
1262 if (size > 0)
1263 command_print(cmd, "\t\tStart address " TARGET_ADDR_FMT, base_addr - 0x1000 * size);
1264
1265 command_print(cmd, "\t\tPeripheral ID 0x%010" PRIx64, pid);
1266
1267 uint8_t class = (cid & ARM_CS_CIDR_CLASS_MASK) >> ARM_CS_CIDR_CLASS_SHIFT;
1268 uint16_t part_num = ARM_CS_PIDR_PART(pid);
1269 uint16_t designer_id = ARM_CS_PIDR_DESIGNER(pid);
1270
1271 if (pid & ARM_CS_PIDR_JEDEC) {
1272 /* JEP106 code */
1273 command_print(cmd, "\t\tDesigner is 0x%03" PRIx16 ", %s",
1274 designer_id, jep106_manufacturer(designer_id));
1275 } else {
1276 /* Legacy ASCII ID, clear invalid bits */
1277 designer_id &= 0x7f;
1278 command_print(cmd, "\t\tDesigner ASCII code 0x%02" PRIx16 ", %s",
1279 designer_id, designer_id == 0x41 ? "ARM" : "<unknown>");
1280 }
1281
1282 /* default values to be overwritten upon finding a match */
1283 const char *type = "Unrecognized";
1284 const char *full = "";
1285
1286 /* search dap_partnums[] array for a match */
1287 for (unsigned entry = 0; entry < ARRAY_SIZE(dap_partnums); entry++) {
1288
1289 if ((dap_partnums[entry].designer_id != designer_id) && (dap_partnums[entry].designer_id != ANY_ID))
1290 continue;
1291
1292 if (dap_partnums[entry].part_num != part_num)
1293 continue;
1294
1295 type = dap_partnums[entry].type;
1296 full = dap_partnums[entry].full;
1297 break;
1298 }
1299
1300 command_print(cmd, "\t\tPart is 0x%" PRIx16", %s %s", part_num, type, full);
1301 command_print(cmd, "\t\tComponent class is 0x%" PRIx8 ", %s", class, class_description[class]);
1302
1303 if (class == ARM_CS_CLASS_0X1_ROM_TABLE) {
1304 uint32_t memtype;
1305 retval = mem_ap_read_atomic_u32(ap, base_addr + ARM_CS_C1_MEMTYPE, &memtype);
1306 if (retval != ERROR_OK)
1307 return retval;
1308
1309 if (memtype & ARM_CS_C1_MEMTYPE_SYSMEM_MASK)
1310 command_print(cmd, "\t\tMEMTYPE system memory present on bus");
1311 else
1312 command_print(cmd, "\t\tMEMTYPE system memory not present: dedicated debug bus");
1313
1314 /* Read ROM table entries from base address until we get 0x00000000 or reach the reserved area */
1315 for (uint16_t entry_offset = 0; entry_offset < 0xF00; entry_offset += 4) {
1316 uint32_t romentry;
1317 retval = mem_ap_read_atomic_u32(ap, base_addr | entry_offset, &romentry);
1318 if (retval != ERROR_OK)
1319 return retval;
1320 command_print(cmd, "\t%sROMTABLE[0x%x] = 0x%" PRIx32 "",
1321 tabs, entry_offset, romentry);
1322 if (romentry & ARM_CS_ROMENTRY_PRESENT) {
1323 /* Recurse. "romentry" is signed */
1324 retval = dap_rom_display(cmd, ap, base_addr + (int32_t)(romentry & ARM_CS_ROMENTRY_OFFSET_MASK),
1325 depth + 1);
1326 if (retval != ERROR_OK)
1327 return retval;
1328 } else if (romentry != 0) {
1329 command_print(cmd, "\t\tComponent not present");
1330 } else {
1331 command_print(cmd, "\t%s\tEnd of ROM table", tabs);
1332 break;
1333 }
1334 }
1335 } else if (class == ARM_CS_CLASS_0X9_CS_COMPONENT) {
1336 const char *major = "Reserved", *subtype = "Reserved";
1337
1338 uint32_t devtype;
1339 retval = mem_ap_read_atomic_u32(ap, base_addr + ARM_CS_C9_DEVTYPE, &devtype);
1340 if (retval != ERROR_OK)
1341 return retval;
1342 unsigned int minor = (devtype & ARM_CS_C9_DEVTYPE_SUB_MASK) >> ARM_CS_C9_DEVTYPE_SUB_SHIFT;
1343 unsigned int devtype_major = (devtype & ARM_CS_C9_DEVTYPE_MAJOR_MASK) >> ARM_CS_C9_DEVTYPE_MAJOR_SHIFT;
1344 switch (devtype_major) {
1345 case 0:
1346 major = "Miscellaneous";
1347 switch (minor) {
1348 case 0:
1349 subtype = "other";
1350 break;
1351 case 4:
1352 subtype = "Validation component";
1353 break;
1354 }
1355 break;
1356 case 1:
1357 major = "Trace Sink";
1358 switch (minor) {
1359 case 0:
1360 subtype = "other";
1361 break;
1362 case 1:
1363 subtype = "Port";
1364 break;
1365 case 2:
1366 subtype = "Buffer";
1367 break;
1368 case 3:
1369 subtype = "Router";
1370 break;
1371 }
1372 break;
1373 case 2:
1374 major = "Trace Link";
1375 switch (minor) {
1376 case 0:
1377 subtype = "other";
1378 break;
1379 case 1:
1380 subtype = "Funnel, router";
1381 break;
1382 case 2:
1383 subtype = "Filter";
1384 break;
1385 case 3:
1386 subtype = "FIFO, buffer";
1387 break;
1388 }
1389 break;
1390 case 3:
1391 major = "Trace Source";
1392 switch (minor) {
1393 case 0:
1394 subtype = "other";
1395 break;
1396 case 1:
1397 subtype = "Processor";
1398 break;
1399 case 2:
1400 subtype = "DSP";
1401 break;
1402 case 3:
1403 subtype = "Engine/Coprocessor";
1404 break;
1405 case 4:
1406 subtype = "Bus";
1407 break;
1408 case 6:
1409 subtype = "Software";
1410 break;
1411 }
1412 break;
1413 case 4:
1414 major = "Debug Control";
1415 switch (minor) {
1416 case 0:
1417 subtype = "other";
1418 break;
1419 case 1:
1420 subtype = "Trigger Matrix";
1421 break;
1422 case 2:
1423 subtype = "Debug Auth";
1424 break;
1425 case 3:
1426 subtype = "Power Requestor";
1427 break;
1428 }
1429 break;
1430 case 5:
1431 major = "Debug Logic";
1432 switch (minor) {
1433 case 0:
1434 subtype = "other";
1435 break;
1436 case 1:
1437 subtype = "Processor";
1438 break;
1439 case 2:
1440 subtype = "DSP";
1441 break;
1442 case 3:
1443 subtype = "Engine/Coprocessor";
1444 break;
1445 case 4:
1446 subtype = "Bus";
1447 break;
1448 case 5:
1449 subtype = "Memory";
1450 break;
1451 }
1452 break;
1453 case 6:
1454 major = "Performance Monitor";
1455 switch (minor) {
1456 case 0:
1457 subtype = "other";
1458 break;
1459 case 1:
1460 subtype = "Processor";
1461 break;
1462 case 2:
1463 subtype = "DSP";
1464 break;
1465 case 3:
1466 subtype = "Engine/Coprocessor";
1467 break;
1468 case 4:
1469 subtype = "Bus";
1470 break;
1471 case 5:
1472 subtype = "Memory";
1473 break;
1474 }
1475 break;
1476 }
1477 command_print(cmd, "\t\tType is 0x%02x, %s, %s",
1478 devtype & ARM_CS_C9_DEVTYPE_MASK,
1479 major, subtype);
1480 /* REVISIT also show ARM_CS_C9_DEVID */
1481 }
1482
1483 return ERROR_OK;
1484 }
1485
1486 int dap_info_command(struct command_invocation *cmd,
1487 struct adiv5_ap *ap)
1488 {
1489 int retval;
1490 uint32_t apid;
1491 target_addr_t dbgbase;
1492 target_addr_t dbgaddr;
1493 uint8_t mem_ap;
1494
1495 /* Now we read ROM table ID registers, ref. ARM IHI 0029B sec */
1496 retval = dap_get_debugbase(ap, &dbgbase, &apid);
1497 if (retval != ERROR_OK)
1498 return retval;
1499
1500 command_print(cmd, "AP ID register 0x%8.8" PRIx32, apid);
1501 if (apid == 0) {
1502 command_print(cmd, "No AP found at this ap 0x%x", ap->ap_num);
1503 return ERROR_FAIL;
1504 }
1505
1506 switch (apid & (IDR_JEP106 | IDR_TYPE)) {
1507 case IDR_JEP106_ARM | AP_TYPE_JTAG_AP:
1508 command_print(cmd, "\tType is JTAG-AP");
1509 break;
1510 case IDR_JEP106_ARM | AP_TYPE_AHB3_AP:
1511 command_print(cmd, "\tType is MEM-AP AHB3");
1512 break;
1513 case IDR_JEP106_ARM | AP_TYPE_AHB5_AP:
1514 command_print(cmd, "\tType is MEM-AP AHB5");
1515 break;
1516 case IDR_JEP106_ARM | AP_TYPE_APB_AP:
1517 command_print(cmd, "\tType is MEM-AP APB");
1518 break;
1519 case IDR_JEP106_ARM | AP_TYPE_AXI_AP:
1520 command_print(cmd, "\tType is MEM-AP AXI");
1521 break;
1522 default:
1523 command_print(cmd, "\tUnknown AP type");
1524 break;
1525 }
1526
1527 /* NOTE: a MEM-AP may have a single CoreSight component that's
1528 * not a ROM table ... or have no such components at all.
1529 */
1530 mem_ap = (apid & IDR_CLASS) == AP_CLASS_MEM_AP;
1531 if (mem_ap) {
1532 if (is_64bit_ap(ap))
1533 dbgaddr = 0xFFFFFFFFFFFFFFFFull;
1534 else
1535 dbgaddr = 0xFFFFFFFFul;
1536
1537 command_print(cmd, "MEM-AP BASE " TARGET_ADDR_FMT, dbgbase);
1538
1539 if (dbgbase == dbgaddr || (dbgbase & 0x3) == 0x2) {
1540 command_print(cmd, "\tNo ROM table present");
1541 } else {
1542 if (dbgbase & 0x01)
1543 command_print(cmd, "\tValid ROM table present");
1544 else
1545 command_print(cmd, "\tROM table in legacy format");
1546
1547 dap_rom_display(cmd, ap, dbgbase & 0xFFFFFFFFFFFFF000ull, 0);
1548 }
1549 }
1550
1551 return ERROR_OK;
1552 }
1553
1554 enum adiv5_cfg_param {
1555 CFG_DAP,
1556 CFG_AP_NUM,
1557 CFG_BASEADDR,
1558 CFG_CTIBASE, /* DEPRECATED */
1559 };
1560
1561 static const struct jim_nvp nvp_config_opts[] = {
1562 { .name = "-dap", .value = CFG_DAP },
1563 { .name = "-ap-num", .value = CFG_AP_NUM },
1564 { .name = "-baseaddr", .value = CFG_BASEADDR },
1565 { .name = "-ctibase", .value = CFG_CTIBASE }, /* DEPRECATED */
1566 { .name = NULL, .value = -1 }
1567 };
1568
1569 static int adiv5_jim_spot_configure(struct jim_getopt_info *goi,
1570 struct adiv5_dap **dap_p, int *ap_num_p, uint32_t *base_p)
1571 {
1572 if (!goi->argc)
1573 return JIM_OK;
1574
1575 Jim_SetEmptyResult(goi->interp);
1576
1577 struct jim_nvp *n;
1578 int e = jim_nvp_name2value_obj(goi->interp, nvp_config_opts,
1579 goi->argv[0], &n);
1580 if (e != JIM_OK)
1581 return JIM_CONTINUE;
1582
1583 /* base_p can be NULL, then '-baseaddr' option is treated as unknown */
1584 if (!base_p && (n->value == CFG_BASEADDR || n->value == CFG_CTIBASE))
1585 return JIM_CONTINUE;
1586
1587 e = jim_getopt_obj(goi, NULL);
1588 if (e != JIM_OK)
1589 return e;
1590
1591 switch (n->value) {
1592 case CFG_DAP:
1593 if (goi->isconfigure) {
1594 Jim_Obj *o_t;
1595 struct adiv5_dap *dap;
1596 e = jim_getopt_obj(goi, &o_t);
1597 if (e != JIM_OK)
1598 return e;
1599 dap = dap_instance_by_jim_obj(goi->interp, o_t);
1600 if (!dap) {
1601 Jim_SetResultString(goi->interp, "DAP name invalid!", -1);
1602 return JIM_ERR;
1603 }
1604 if (*dap_p && *dap_p != dap) {
1605 Jim_SetResultString(goi->interp,
1606 "DAP assignment cannot be changed!", -1);
1607 return JIM_ERR;
1608 }
1609 *dap_p = dap;
1610 } else {
1611 if (goi->argc)
1612 goto err_no_param;
1613 if (!*dap_p) {
1614 Jim_SetResultString(goi->interp, "DAP not configured", -1);
1615 return JIM_ERR;
1616 }
1617 Jim_SetResultString(goi->interp, adiv5_dap_name(*dap_p), -1);
1618 }
1619 break;
1620
1621 case CFG_AP_NUM:
1622 if (goi->isconfigure) {
1623 jim_wide ap_num;
1624 e = jim_getopt_wide(goi, &ap_num);
1625 if (e != JIM_OK)
1626 return e;
1627 if (ap_num < 0 || ap_num > DP_APSEL_MAX) {
1628 Jim_SetResultString(goi->interp, "Invalid AP number!", -1);
1629 return JIM_ERR;
1630 }
1631 *ap_num_p = ap_num;
1632 } else {
1633 if (goi->argc)
1634 goto err_no_param;
1635 if (*ap_num_p == DP_APSEL_INVALID) {
1636 Jim_SetResultString(goi->interp, "AP number not configured", -1);
1637 return JIM_ERR;
1638 }
1639 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, *ap_num_p));
1640 }
1641 break;
1642
1643 case CFG_CTIBASE:
1644 LOG_WARNING("DEPRECATED! use \'-baseaddr' not \'-ctibase\'");
1645 /* fall through */
1646 case CFG_BASEADDR:
1647 if (goi->isconfigure) {
1648 jim_wide base;
1649 e = jim_getopt_wide(goi, &base);
1650 if (e != JIM_OK)
1651 return e;
1652 *base_p = (uint32_t)base;
1653 } else {
1654 if (goi->argc)
1655 goto err_no_param;
1656 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, *base_p));
1657 }
1658 break;
1659 };
1660
1661 return JIM_OK;
1662
1663 err_no_param:
1664 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
1665 return JIM_ERR;
1666 }
1667
1668 int adiv5_jim_configure(struct target *target, struct jim_getopt_info *goi)
1669 {
1670 struct adiv5_private_config *pc;
1671 int e;
1672
1673 pc = (struct adiv5_private_config *)target->private_config;
1674 if (!pc) {
1675 pc = calloc(1, sizeof(struct adiv5_private_config));
1676 pc->ap_num = DP_APSEL_INVALID;
1677 target->private_config = pc;
1678 }
1679
1680 target->has_dap = true;
1681
1682 e = adiv5_jim_spot_configure(goi, &pc->dap, &pc->ap_num, NULL);
1683 if (e != JIM_OK)
1684 return e;
1685
1686 if (pc->dap && !target->dap_configured) {
1687 if (target->tap_configured) {
1688 pc->dap = NULL;
1689 Jim_SetResultString(goi->interp,
1690 "-chain-position and -dap configparams are mutually exclusive!", -1);
1691 return JIM_ERR;
1692 }
1693 target->tap = pc->dap->tap;
1694 target->dap_configured = true;
1695 }
1696
1697 return JIM_OK;
1698 }
1699
1700 int adiv5_verify_config(struct adiv5_private_config *pc)
1701 {
1702 if (!pc)
1703 return ERROR_FAIL;
1704
1705 if (!pc->dap)
1706 return ERROR_FAIL;
1707
1708 return ERROR_OK;
1709 }
1710
1711 int adiv5_jim_mem_ap_spot_configure(struct adiv5_mem_ap_spot *cfg,
1712 struct jim_getopt_info *goi)
1713 {
1714 return adiv5_jim_spot_configure(goi, &cfg->dap, &cfg->ap_num, &cfg->base);
1715 }
1716
1717 int adiv5_mem_ap_spot_init(struct adiv5_mem_ap_spot *p)
1718 {
1719 p->dap = NULL;
1720 p->ap_num = DP_APSEL_INVALID;
1721 p->base = 0;
1722 return ERROR_OK;
1723 }
1724
1725 COMMAND_HANDLER(handle_dap_info_command)
1726 {
1727 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1728 uint32_t apsel;
1729
1730 switch (CMD_ARGC) {
1731 case 0:
1732 apsel = dap->apsel;
1733 break;
1734 case 1:
1735 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
1736 if (apsel > DP_APSEL_MAX) {
1737 command_print(CMD, "Invalid AP number");
1738 return ERROR_COMMAND_ARGUMENT_INVALID;
1739 }
1740 break;
1741 default:
1742 return ERROR_COMMAND_SYNTAX_ERROR;
1743 }
1744
1745 return dap_info_command(CMD, &dap->ap[apsel]);
1746 }
1747
1748 COMMAND_HANDLER(dap_baseaddr_command)
1749 {
1750 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1751 uint32_t apsel, baseaddr_lower, baseaddr_upper;
1752 struct adiv5_ap *ap;
1753 target_addr_t baseaddr;
1754 int retval;
1755
1756 baseaddr_upper = 0;
1757
1758 switch (CMD_ARGC) {
1759 case 0:
1760 apsel = dap->apsel;
1761 break;
1762 case 1:
1763 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
1764 /* AP address is in bits 31:24 of DP_SELECT */
1765 if (apsel > DP_APSEL_MAX) {
1766 command_print(CMD, "Invalid AP number");
1767 return ERROR_COMMAND_ARGUMENT_INVALID;
1768 }
1769 break;
1770 default:
1771 return ERROR_COMMAND_SYNTAX_ERROR;
1772 }
1773
1774 /* NOTE: assumes we're talking to a MEM-AP, which
1775 * has a base address. There are other kinds of AP,
1776 * though they're not common for now. This should
1777 * use the ID register to verify it's a MEM-AP.
1778 */
1779
1780 ap = dap_ap(dap, apsel);
1781 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE, &baseaddr_lower);
1782
1783 if (retval == ERROR_OK && ap->cfg_reg == MEM_AP_REG_CFG_INVALID)
1784 retval = dap_queue_ap_read(ap, MEM_AP_REG_CFG, &ap->cfg_reg);
1785
1786 if (retval == ERROR_OK && (ap->cfg_reg == MEM_AP_REG_CFG_INVALID || is_64bit_ap(ap))) {
1787 /* MEM_AP_REG_BASE64 is defined as 'RES0'; can be read and then ignored on 32 bits AP */
1788 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE64, &baseaddr_upper);
1789 }
1790
1791 if (retval == ERROR_OK)
1792 retval = dap_run(dap);
1793 if (retval != ERROR_OK)
1794 return retval;
1795
1796 if (is_64bit_ap(ap)) {
1797 baseaddr = (((target_addr_t)baseaddr_upper) << 32) | baseaddr_lower;
1798 command_print(CMD, "0x%016" PRIx64, baseaddr);
1799 } else
1800 command_print(CMD, "0x%08" PRIx32, baseaddr_lower);
1801
1802 return ERROR_OK;
1803 }
1804
1805 COMMAND_HANDLER(dap_memaccess_command)
1806 {
1807 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1808 uint32_t memaccess_tck;
1809
1810 switch (CMD_ARGC) {
1811 case 0:
1812 memaccess_tck = dap->ap[dap->apsel].memaccess_tck;
1813 break;
1814 case 1:
1815 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], memaccess_tck);
1816 break;
1817 default:
1818 return ERROR_COMMAND_SYNTAX_ERROR;
1819 }
1820 dap->ap[dap->apsel].memaccess_tck = memaccess_tck;
1821
1822 command_print(CMD, "memory bus access delay set to %" PRIu32 " tck",
1823 dap->ap[dap->apsel].memaccess_tck);
1824
1825 return ERROR_OK;
1826 }
1827
1828 COMMAND_HANDLER(dap_apsel_command)
1829 {
1830 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1831 uint32_t apsel;
1832
1833 switch (CMD_ARGC) {
1834 case 0:
1835 command_print(CMD, "%" PRIu32, dap->apsel);
1836 return ERROR_OK;
1837 case 1:
1838 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
1839 /* AP address is in bits 31:24 of DP_SELECT */
1840 if (apsel > DP_APSEL_MAX) {
1841 command_print(CMD, "Invalid AP number");
1842 return ERROR_COMMAND_ARGUMENT_INVALID;
1843 }
1844 break;
1845 default:
1846 return ERROR_COMMAND_SYNTAX_ERROR;
1847 }
1848
1849 dap->apsel = apsel;
1850 return ERROR_OK;
1851 }
1852
1853 COMMAND_HANDLER(dap_apcsw_command)
1854 {
1855 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1856 uint32_t apcsw = dap->ap[dap->apsel].csw_default;
1857 uint32_t csw_val, csw_mask;
1858
1859 switch (CMD_ARGC) {
1860 case 0:
1861 command_print(CMD, "ap %" PRIu32 " selected, csw 0x%8.8" PRIx32,
1862 dap->apsel, apcsw);
1863 return ERROR_OK;
1864 case 1:
1865 if (strcmp(CMD_ARGV[0], "default") == 0)
1866 csw_val = CSW_AHB_DEFAULT;
1867 else
1868 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], csw_val);
1869
1870 if (csw_val & (CSW_SIZE_MASK | CSW_ADDRINC_MASK)) {
1871 LOG_ERROR("CSW value cannot include 'Size' and 'AddrInc' bit-fields");
1872 return ERROR_COMMAND_ARGUMENT_INVALID;
1873 }
1874 apcsw = csw_val;
1875 break;
1876 case 2:
1877 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], csw_val);
1878 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], csw_mask);
1879 if (csw_mask & (CSW_SIZE_MASK | CSW_ADDRINC_MASK)) {
1880 LOG_ERROR("CSW mask cannot include 'Size' and 'AddrInc' bit-fields");
1881 return ERROR_COMMAND_ARGUMENT_INVALID;
1882 }
1883 apcsw = (apcsw & ~csw_mask) | (csw_val & csw_mask);
1884 break;
1885 default:
1886 return ERROR_COMMAND_SYNTAX_ERROR;
1887 }
1888 dap->ap[dap->apsel].csw_default = apcsw;
1889
1890 return 0;
1891 }
1892
1893
1894
1895 COMMAND_HANDLER(dap_apid_command)
1896 {
1897 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1898 uint32_t apsel, apid;
1899 int retval;
1900
1901 switch (CMD_ARGC) {
1902 case 0:
1903 apsel = dap->apsel;
1904 break;
1905 case 1:
1906 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
1907 /* AP address is in bits 31:24 of DP_SELECT */
1908 if (apsel > DP_APSEL_MAX) {
1909 command_print(CMD, "Invalid AP number");
1910 return ERROR_COMMAND_ARGUMENT_INVALID;
1911 }
1912 break;
1913 default:
1914 return ERROR_COMMAND_SYNTAX_ERROR;
1915 }
1916
1917 retval = dap_queue_ap_read(dap_ap(dap, apsel), AP_REG_IDR, &apid);
1918 if (retval != ERROR_OK)
1919 return retval;
1920 retval = dap_run(dap);
1921 if (retval != ERROR_OK)
1922 return retval;
1923
1924 command_print(CMD, "0x%8.8" PRIx32, apid);
1925
1926 return retval;
1927 }
1928
1929 COMMAND_HANDLER(dap_apreg_command)
1930 {
1931 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
1932 uint32_t apsel, reg, value;
1933 struct adiv5_ap *ap;
1934 int retval;
1935
1936 if (CMD_ARGC < 2 || CMD_ARGC > 3)
1937 return ERROR_COMMAND_SYNTAX_ERROR;
1938
1939 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], apsel);
1940 /* AP address is in bits 31:24 of DP_SELECT */
1941 if (apsel > DP_APSEL_MAX) {
1942 command_print(CMD, "Invalid AP number");
1943 return ERROR_COMMAND_ARGUMENT_INVALID;
1944 }
1945
1946 ap = dap_ap(dap, apsel);
1947
1948 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], reg);
1949 if (reg >= 256 || (reg & 3)) {
1950 command_print(CMD, "Invalid reg value (should be less than 256 and 4 bytes aligned)");
1951 return ERROR_COMMAND_ARGUMENT_INVALID;
1952 }
1953
1954 if (CMD_ARGC == 3) {
1955 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], value);
1956 switch (reg) {
1957 case MEM_AP_REG_CSW:
1958 ap->csw_value = 0; /* invalid, in case write fails */
1959 retval = dap_queue_ap_write(ap, reg, value);
1960 if (retval == ERROR_OK)
1961 ap->csw_value = value;
1962 break;
1963 case MEM_AP_REG_TAR:
1964 retval = dap_queue_ap_write(ap, reg, value);
1965 if (retval == ERROR_OK)
1966 ap->tar_value = (ap->tar_value & ~0xFFFFFFFFull) | value;
1967 else {
1968 /* To track independent writes to TAR and TAR64, two tar_valid flags */
1969 /* should be used. To keep it simple, tar_valid is only invalidated on a */
1970 /* write fail. This approach causes a later re-write of the TAR and TAR64 */
1971 /* if tar_valid is false. */
1972 ap->tar_valid = false;
1973 }
1974 break;
1975 case MEM_AP_REG_TAR64:
1976 retval = dap_queue_ap_write(ap, reg, value);
1977 if (retval == ERROR_OK)
1978 ap->tar_value = (ap->tar_value & 0xFFFFFFFFull) | (((target_addr_t)value) << 32);
1979 else {
1980 /* See above comment for the MEM_AP_REG_TAR failed write case */
1981 ap->tar_valid = false;
1982 }
1983 break;
1984 default:
1985 retval = dap_queue_ap_write(ap, reg, value);
1986 break;
1987 }
1988 } else {
1989 retval = dap_queue_ap_read(ap, reg, &value);
1990 }
1991 if (retval == ERROR_OK)
1992 retval = dap_run(dap);
1993
1994 if (retval != ERROR_OK)
1995 return retval;
1996
1997 if (CMD_ARGC == 2)
1998 command_print(CMD, "0x%08" PRIx32, value);
1999
2000 return retval;
2001 }
2002
2003 COMMAND_HANDLER(dap_dpreg_command)
2004 {
2005 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2006 uint32_t reg, value;
2007 int retval;
2008
2009 if (CMD_ARGC < 1 || CMD_ARGC > 2)
2010 return ERROR_COMMAND_SYNTAX_ERROR;
2011
2012 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], reg);
2013 if (reg >= 256 || (reg & 3)) {
2014 command_print(CMD, "Invalid reg value (should be less than 256 and 4 bytes aligned)");
2015 return ERROR_COMMAND_ARGUMENT_INVALID;
2016 }
2017
2018 if (CMD_ARGC == 2) {
2019 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2020 retval = dap_queue_dp_write(dap, reg, value);
2021 } else {
2022 retval = dap_queue_dp_read(dap, reg, &value);
2023 }
2024 if (retval == ERROR_OK)
2025 retval = dap_run(dap);
2026
2027 if (retval != ERROR_OK)
2028 return retval;
2029
2030 if (CMD_ARGC == 1)
2031 command_print(CMD, "0x%08" PRIx32, value);
2032
2033 return retval;
2034 }
2035
2036 COMMAND_HANDLER(dap_ti_be_32_quirks_command)
2037 {
2038 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2039 return CALL_COMMAND_HANDLER(handle_command_parse_bool, &dap->ti_be_32_quirks,
2040 "TI BE-32 quirks mode");
2041 }
2042
2043 const struct command_registration dap_instance_commands[] = {
2044 {
2045 .name = "info",
2046 .handler = handle_dap_info_command,
2047 .mode = COMMAND_EXEC,
2048 .help = "display ROM table for MEM-AP "
2049 "(default currently selected AP)",
2050 .usage = "[ap_num]",
2051 },
2052 {
2053 .name = "apsel",
2054 .handler = dap_apsel_command,
2055 .mode = COMMAND_ANY,
2056 .help = "Set the currently selected AP (default 0) "
2057 "and display the result",
2058 .usage = "[ap_num]",
2059 },
2060 {
2061 .name = "apcsw",
2062 .handler = dap_apcsw_command,
2063 .mode = COMMAND_ANY,
2064 .help = "Set CSW default bits",
2065 .usage = "[value [mask]]",
2066 },
2067
2068 {
2069 .name = "apid",
2070 .handler = dap_apid_command,
2071 .mode = COMMAND_EXEC,
2072 .help = "return ID register from AP "
2073 "(default currently selected AP)",
2074 .usage = "[ap_num]",
2075 },
2076 {
2077 .name = "apreg",
2078 .handler = dap_apreg_command,
2079 .mode = COMMAND_EXEC,
2080 .help = "read/write a register from AP "
2081 "(reg is byte address of a word register, like 0 4 8...)",
2082 .usage = "ap_num reg [value]",
2083 },
2084 {
2085 .name = "dpreg",
2086 .handler = dap_dpreg_command,
2087 .mode = COMMAND_EXEC,
2088 .help = "read/write a register from DP "
2089 "(reg is byte address (bank << 4 | reg) of a word register, like 0 4 8...)",
2090 .usage = "reg [value]",
2091 },
2092 {
2093 .name = "baseaddr",
2094 .handler = dap_baseaddr_command,
2095 .mode = COMMAND_EXEC,
2096 .help = "return debug base address from MEM-AP "
2097 "(default currently selected AP)",
2098 .usage = "[ap_num]",
2099 },
2100 {
2101 .name = "memaccess",
2102 .handler = dap_memaccess_command,
2103 .mode = COMMAND_EXEC,
2104 .help = "set/get number of extra tck for MEM-AP memory "
2105 "bus access [0-255]",
2106 .usage = "[cycles]",
2107 },
2108 {
2109 .name = "ti_be_32_quirks",
2110 .handler = dap_ti_be_32_quirks_command,
2111 .mode = COMMAND_CONFIG,
2112 .help = "set/get quirks mode for TI TMS450/TMS570 processors",
2113 .usage = "[enable]",
2114 },
2115 COMMAND_REGISTRATION_DONE
2116 };
Open On-Chip Debugger

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)