84518b0a10199e856ddcb73a204fe0d12e2e7c8c
[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(ap->dap), 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(ap->dap), (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(ap->dap), (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(ap->dap), &lower);
146 if (retval == ERROR_OK && is_64bit_ap(ap))
147 retval = dap_queue_ap_read(ap, MEM_AP_REG_TAR64(ap->dap), &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(ap->dap) | (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(ap->dap) | (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(dap), 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(dap), 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(dap), &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(dap), &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 #define ARCH_ID(architect, archid) ( \
897 (((architect) << ARM_CS_C9_DEVARCH_ARCHITECT_SHIFT) & ARM_CS_C9_DEVARCH_ARCHITECT_MASK) | \
898 (((archid) << ARM_CS_C9_DEVARCH_ARCHID_SHIFT) & ARM_CS_C9_DEVARCH_ARCHID_MASK) \
899 )
900
901 static const struct {
902 uint32_t arch_id;
903 const char *description;
904 } class0x9_devarch[] = {
905 /* keep same unsorted order as in ARM IHI0029E */
906 { ARCH_ID(ARM_ID, 0x0A00), "RAS architecture" },
907 { ARCH_ID(ARM_ID, 0x1A01), "Instrumentation Trace Macrocell (ITM) architecture" },
908 { ARCH_ID(ARM_ID, 0x1A02), "DWT architecture" },
909 { ARCH_ID(ARM_ID, 0x1A03), "Flash Patch and Breakpoint unit (FPB) architecture" },
910 { ARCH_ID(ARM_ID, 0x2A04), "Processor debug architecture (ARMv8-M)" },
911 { ARCH_ID(ARM_ID, 0x6A05), "Processor debug architecture (ARMv8-R)" },
912 { ARCH_ID(ARM_ID, 0x0A10), "PC sample-based profiling" },
913 { ARCH_ID(ARM_ID, 0x4A13), "Embedded Trace Macrocell (ETM) architecture" },
914 { ARCH_ID(ARM_ID, 0x1A14), "Cross Trigger Interface (CTI) architecture" },
915 { ARCH_ID(ARM_ID, 0x6A15), "Processor debug architecture (v8.0-A)" },
916 { ARCH_ID(ARM_ID, 0x7A15), "Processor debug architecture (v8.1-A)" },
917 { ARCH_ID(ARM_ID, 0x8A15), "Processor debug architecture (v8.2-A)" },
918 { ARCH_ID(ARM_ID, 0x2A16), "Processor Performance Monitor (PMU) architecture" },
919 { ARCH_ID(ARM_ID, 0x0A17), "Memory Access Port v2 architecture" },
920 { ARCH_ID(ARM_ID, 0x0A27), "JTAG Access Port v2 architecture" },
921 { ARCH_ID(ARM_ID, 0x0A31), "Basic trace router" },
922 { ARCH_ID(ARM_ID, 0x0A37), "Power requestor" },
923 { ARCH_ID(ARM_ID, 0x0A47), "Unknown Access Port v2 architecture" },
924 { ARCH_ID(ARM_ID, 0x0A50), "HSSTP architecture" },
925 { ARCH_ID(ARM_ID, 0x0A63), "System Trace Macrocell (STM) architecture" },
926 { ARCH_ID(ARM_ID, 0x0A75), "CoreSight ELA architecture" },
927 { ARCH_ID(ARM_ID, 0x0AF7), "CoreSight ROM architecture" },
928 };
929
930 #define DEVARCH_ID_MASK (ARM_CS_C9_DEVARCH_ARCHITECT_MASK | ARM_CS_C9_DEVARCH_ARCHID_MASK)
931 #define DEVARCH_MEM_AP ARCH_ID(ARM_ID, 0x0A17)
932 #define DEVARCH_ROM_C_0X9 ARCH_ID(ARM_ID, 0x0AF7)
933
934 static const char *class0x9_devarch_description(uint32_t devarch)
935 {
936 if (!(devarch & ARM_CS_C9_DEVARCH_PRESENT))
937 return "not present";
938
939 for (unsigned int i = 0; i < ARRAY_SIZE(class0x9_devarch); i++)
940 if ((devarch & DEVARCH_ID_MASK) == class0x9_devarch[i].arch_id)
941 return class0x9_devarch[i].description;
942
943 return "unknown";
944 }
945
946 static const struct {
947 enum ap_type type;
948 const char *description;
949 } ap_types[] = {
950 { AP_TYPE_JTAG_AP, "JTAG-AP" },
951 { AP_TYPE_COM_AP, "COM-AP" },
952 { AP_TYPE_AHB3_AP, "MEM-AP AHB3" },
953 { AP_TYPE_APB_AP, "MEM-AP APB2 or APB3" },
954 { AP_TYPE_AXI_AP, "MEM-AP AXI3 or AXI4" },
955 { AP_TYPE_AHB5_AP, "MEM-AP AHB5" },
956 { AP_TYPE_APB4_AP, "MEM-AP APB4" },
957 { AP_TYPE_AXI5_AP, "MEM-AP AXI5" },
958 { AP_TYPE_AHB5H_AP, "MEM-AP AHB5 with enhanced HPROT" },
959 };
960
961 static const char *ap_type_to_description(enum ap_type type)
962 {
963 for (unsigned int i = 0; i < ARRAY_SIZE(ap_types); i++)
964 if (type == ap_types[i].type)
965 return ap_types[i].description;
966
967 return "Unknown";
968 }
969
970 bool is_ap_num_valid(struct adiv5_dap *dap, uint64_t ap_num)
971 {
972 if (!dap)
973 return false;
974
975 /* no autodetection, by now, so uninitialized is equivalent to ADIv5 for
976 * backward compatibility */
977 if (!is_adiv6(dap)) {
978 if (ap_num > DP_APSEL_MAX)
979 return false;
980 return true;
981 }
982
983 if (is_adiv6(dap)) {
984 if (ap_num & 0x0fffULL)
985 return false;
986 if (dap->asize != 0)
987 if (ap_num & ((~0ULL) << dap->asize))
988 return false;
989 return true;
990 }
991
992 return false;
993 }
994
995 /*
996 * This function checks the ID for each access port to find the requested Access Port type
997 * It also calls dap_get_ap() to increment the AP refcount
998 */
999 int dap_find_get_ap(struct adiv5_dap *dap, enum ap_type type_to_find, struct adiv5_ap **ap_out)
1000 {
1001 if (is_adiv6(dap)) {
1002 /* TODO: scan the ROM table and detect the AP available */
1003 LOG_DEBUG("On ADIv6 we cannot scan all the possible AP");
1004 return ERROR_FAIL;
1005 }
1006
1007 /* Maximum AP number is 255 since the SELECT register is 8 bits */
1008 for (unsigned int ap_num = 0; ap_num <= DP_APSEL_MAX; ap_num++) {
1009 struct adiv5_ap *ap = dap_get_ap(dap, ap_num);
1010 if (!ap)
1011 continue;
1012
1013 /* read the IDR register of the Access Port */
1014 uint32_t id_val = 0;
1015
1016 int retval = dap_queue_ap_read(ap, AP_REG_IDR(dap), &id_val);
1017 if (retval != ERROR_OK) {
1018 dap_put_ap(ap);
1019 return retval;
1020 }
1021
1022 retval = dap_run(dap);
1023
1024 /* Reading register for a non-existent AP should not cause an error,
1025 * but just to be sure, try to continue searching if an error does happen.
1026 */
1027 if (retval == ERROR_OK && (id_val & AP_TYPE_MASK) == type_to_find) {
1028 LOG_DEBUG("Found %s at AP index: %d (IDR=0x%08" PRIX32 ")",
1029 ap_type_to_description(type_to_find),
1030 ap_num, id_val);
1031
1032 *ap_out = ap;
1033 return ERROR_OK;
1034 }
1035 dap_put_ap(ap);
1036 }
1037
1038 LOG_DEBUG("No %s found", ap_type_to_description(type_to_find));
1039 return ERROR_FAIL;
1040 }
1041
1042 static inline bool is_ap_in_use(struct adiv5_ap *ap)
1043 {
1044 return ap->refcount > 0 || ap->config_ap_never_release;
1045 }
1046
1047 static struct adiv5_ap *_dap_get_ap(struct adiv5_dap *dap, uint64_t ap_num)
1048 {
1049 if (!is_ap_num_valid(dap, ap_num)) {
1050 LOG_ERROR("Invalid AP#0x%" PRIx64, ap_num);
1051 return NULL;
1052 }
1053 if (is_adiv6(dap)) {
1054 for (unsigned int i = 0; i <= DP_APSEL_MAX; i++) {
1055 struct adiv5_ap *ap = &dap->ap[i];
1056 if (is_ap_in_use(ap) && ap->ap_num == ap_num) {
1057 ++ap->refcount;
1058 return ap;
1059 }
1060 }
1061 for (unsigned int i = 0; i <= DP_APSEL_MAX; i++) {
1062 struct adiv5_ap *ap = &dap->ap[i];
1063 if (!is_ap_in_use(ap)) {
1064 ap->ap_num = ap_num;
1065 ++ap->refcount;
1066 return ap;
1067 }
1068 }
1069 LOG_ERROR("No more AP available!");
1070 return NULL;
1071 }
1072
1073 /* ADIv5 */
1074 struct adiv5_ap *ap = &dap->ap[ap_num];
1075 ap->ap_num = ap_num;
1076 ++ap->refcount;
1077 return ap;
1078 }
1079
1080 /* Return AP with specified ap_num. Increment AP refcount */
1081 struct adiv5_ap *dap_get_ap(struct adiv5_dap *dap, uint64_t ap_num)
1082 {
1083 struct adiv5_ap *ap = _dap_get_ap(dap, ap_num);
1084 if (ap)
1085 LOG_DEBUG("refcount AP#0x%" PRIx64 " get %u", ap_num, ap->refcount);
1086 return ap;
1087 }
1088
1089 /* Return AP with specified ap_num. Increment AP refcount and keep it non-zero */
1090 struct adiv5_ap *dap_get_config_ap(struct adiv5_dap *dap, uint64_t ap_num)
1091 {
1092 struct adiv5_ap *ap = _dap_get_ap(dap, ap_num);
1093 if (ap) {
1094 ap->config_ap_never_release = true;
1095 LOG_DEBUG("refcount AP#0x%" PRIx64 " get_config %u", ap_num, ap->refcount);
1096 }
1097 return ap;
1098 }
1099
1100 /* Decrement AP refcount and release the AP when refcount reaches zero */
1101 int dap_put_ap(struct adiv5_ap *ap)
1102 {
1103 if (ap->refcount == 0) {
1104 LOG_ERROR("BUG: refcount AP#0x%" PRIx64 " put underflow", ap->ap_num);
1105 return ERROR_FAIL;
1106 }
1107
1108 --ap->refcount;
1109
1110 LOG_DEBUG("refcount AP#0x%" PRIx64 " put %u", ap->ap_num, ap->refcount);
1111 if (!is_ap_in_use(ap)) {
1112 /* defaults from dap_instance_init() */
1113 ap->ap_num = DP_APSEL_INVALID;
1114 ap->memaccess_tck = 255;
1115 ap->tar_autoincr_block = (1 << 10);
1116 ap->csw_default = CSW_AHB_DEFAULT;
1117 ap->cfg_reg = MEM_AP_REG_CFG_INVALID;
1118 }
1119 return ERROR_OK;
1120 }
1121
1122 static int dap_get_debugbase(struct adiv5_ap *ap,
1123 target_addr_t *dbgbase, uint32_t *apid)
1124 {
1125 struct adiv5_dap *dap = ap->dap;
1126 int retval;
1127 uint32_t baseptr_upper, baseptr_lower;
1128
1129 if (ap->cfg_reg == MEM_AP_REG_CFG_INVALID) {
1130 retval = dap_queue_ap_read(ap, MEM_AP_REG_CFG(dap), &ap->cfg_reg);
1131 if (retval != ERROR_OK)
1132 return retval;
1133 }
1134 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE(dap), &baseptr_lower);
1135 if (retval != ERROR_OK)
1136 return retval;
1137 retval = dap_queue_ap_read(ap, AP_REG_IDR(dap), apid);
1138 if (retval != ERROR_OK)
1139 return retval;
1140 /* MEM_AP_REG_BASE64 is defined as 'RES0'; can be read and then ignored on 32 bits AP */
1141 if (ap->cfg_reg == MEM_AP_REG_CFG_INVALID || is_64bit_ap(ap)) {
1142 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE64(dap), &baseptr_upper);
1143 if (retval != ERROR_OK)
1144 return retval;
1145 }
1146
1147 retval = dap_run(dap);
1148 if (retval != ERROR_OK)
1149 return retval;
1150
1151 if (!is_64bit_ap(ap))
1152 baseptr_upper = 0;
1153 *dbgbase = (((target_addr_t)baseptr_upper) << 32) | baseptr_lower;
1154
1155 return ERROR_OK;
1156 }
1157
1158 int adiv6_dap_read_baseptr(struct command_invocation *cmd, struct adiv5_dap *dap, uint64_t *baseptr)
1159 {
1160 uint32_t baseptr_lower, baseptr_upper = 0;
1161 int retval;
1162
1163 if (dap->asize > 32) {
1164 retval = dap_queue_dp_read(dap, DP_BASEPTR1, &baseptr_upper);
1165 if (retval != ERROR_OK)
1166 return retval;
1167 }
1168
1169 retval = dap_dp_read_atomic(dap, DP_BASEPTR0, &baseptr_lower);
1170 if (retval != ERROR_OK)
1171 return retval;
1172
1173 if ((baseptr_lower & DP_BASEPTR0_VALID) != DP_BASEPTR0_VALID) {
1174 command_print(cmd, "System root table not present");
1175 return ERROR_FAIL;
1176 }
1177
1178 baseptr_lower &= ~0x0fff;
1179 *baseptr = (((uint64_t)baseptr_upper) << 32) | baseptr_lower;
1180
1181 return ERROR_OK;
1182 }
1183
1184 /**
1185 * Method to access the CoreSight component.
1186 * On ADIv5, CoreSight components are on the bus behind a MEM-AP.
1187 * On ADIv6, CoreSight components can either be on the bus behind a MEM-AP
1188 * or directly in the AP.
1189 */
1190 enum coresight_access_mode {
1191 CS_ACCESS_AP,
1192 CS_ACCESS_MEM_AP,
1193 };
1194
1195 /** Holds registers and coordinates of a CoreSight component */
1196 struct cs_component_vals {
1197 struct adiv5_ap *ap;
1198 target_addr_t component_base;
1199 uint64_t pid;
1200 uint32_t cid;
1201 uint32_t devarch;
1202 uint32_t devid;
1203 uint32_t devtype_memtype;
1204 enum coresight_access_mode mode;
1205 };
1206
1207 /**
1208 * Helper to read CoreSight component's registers, either on the bus
1209 * behind a MEM-AP or directly in the AP.
1210 *
1211 * @param mode Method to access the component (AP or MEM-AP).
1212 * @param ap Pointer to AP containing the component.
1213 * @param component_base On MEM-AP access method, base address of the component.
1214 * @param reg Offset of the component's register to read.
1215 * @param value Pointer to the store the read value.
1216 *
1217 * @return ERROR_OK on success, else a fault code.
1218 */
1219 static int dap_queue_read_reg(enum coresight_access_mode mode, struct adiv5_ap *ap,
1220 uint64_t component_base, unsigned int reg, uint32_t *value)
1221 {
1222 if (mode == CS_ACCESS_AP)
1223 return dap_queue_ap_read(ap, reg, value);
1224
1225 /* mode == CS_ACCESS_MEM_AP */
1226 return mem_ap_read_u32(ap, component_base + reg, value);
1227 }
1228
1229 /**
1230 * Read the CoreSight registers needed during ROM Table Parsing (RTP).
1231 *
1232 * @param mode Method to access the component (AP or MEM-AP).
1233 * @param ap Pointer to AP containing the component.
1234 * @param component_base On MEM-AP access method, base address of the component.
1235 * @param v Pointer to the struct holding the value of registers.
1236 *
1237 * @return ERROR_OK on success, else a fault code.
1238 */
1239 static int rtp_read_cs_regs(enum coresight_access_mode mode, struct adiv5_ap *ap,
1240 target_addr_t component_base, struct cs_component_vals *v)
1241 {
1242 assert(IS_ALIGNED(component_base, ARM_CS_ALIGN));
1243 assert(ap && v);
1244
1245 uint32_t cid0, cid1, cid2, cid3;
1246 uint32_t pid0, pid1, pid2, pid3, pid4;
1247 int retval = ERROR_OK;
1248
1249 v->ap = ap;
1250 v->component_base = component_base;
1251 v->mode = mode;
1252
1253 /* sort by offset to gain speed */
1254
1255 /*
1256 * Registers DEVARCH, DEVID and DEVTYPE are valid on Class 0x9 devices
1257 * only, but are at offset above 0xf00, so can be read on any device
1258 * without triggering error. Read them for eventual use on Class 0x9.
1259 */
1260 if (retval == ERROR_OK)
1261 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_C9_DEVARCH, &v->devarch);
1262
1263 if (retval == ERROR_OK)
1264 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_C9_DEVID, &v->devid);
1265
1266 /* Same address as ARM_CS_C1_MEMTYPE */
1267 if (retval == ERROR_OK)
1268 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_C9_DEVTYPE, &v->devtype_memtype);
1269
1270 if (retval == ERROR_OK)
1271 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_PIDR4, &pid4);
1272
1273 if (retval == ERROR_OK)
1274 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_PIDR0, &pid0);
1275 if (retval == ERROR_OK)
1276 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_PIDR1, &pid1);
1277 if (retval == ERROR_OK)
1278 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_PIDR2, &pid2);
1279 if (retval == ERROR_OK)
1280 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_PIDR3, &pid3);
1281
1282 if (retval == ERROR_OK)
1283 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_CIDR0, &cid0);
1284 if (retval == ERROR_OK)
1285 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_CIDR1, &cid1);
1286 if (retval == ERROR_OK)
1287 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_CIDR2, &cid2);
1288 if (retval == ERROR_OK)
1289 retval = dap_queue_read_reg(mode, ap, component_base, ARM_CS_CIDR3, &cid3);
1290
1291 if (retval == ERROR_OK)
1292 retval = dap_run(ap->dap);
1293 if (retval != ERROR_OK) {
1294 LOG_DEBUG("Failed read CoreSight registers");
1295 return retval;
1296 }
1297
1298 v->cid = (cid3 & 0xff) << 24
1299 | (cid2 & 0xff) << 16
1300 | (cid1 & 0xff) << 8
1301 | (cid0 & 0xff);
1302 v->pid = (uint64_t)(pid4 & 0xff) << 32
1303 | (pid3 & 0xff) << 24
1304 | (pid2 & 0xff) << 16
1305 | (pid1 & 0xff) << 8
1306 | (pid0 & 0xff);
1307
1308 return ERROR_OK;
1309 }
1310
1311 /* Part number interpretations are from Cortex
1312 * core specs, the CoreSight components TRM
1313 * (ARM DDI 0314H), CoreSight System Design
1314 * Guide (ARM DGI 0012D) and ETM specs; also
1315 * from chip observation (e.g. TI SDTI).
1316 */
1317
1318 static const struct dap_part_nums {
1319 uint16_t designer_id;
1320 uint16_t part_num;
1321 const char *type;
1322 const char *full;
1323 } dap_part_nums[] = {
1324 { ARM_ID, 0x000, "Cortex-M3 SCS", "(System Control Space)", },
1325 { ARM_ID, 0x001, "Cortex-M3 ITM", "(Instrumentation Trace Module)", },
1326 { ARM_ID, 0x002, "Cortex-M3 DWT", "(Data Watchpoint and Trace)", },
1327 { ARM_ID, 0x003, "Cortex-M3 FPB", "(Flash Patch and Breakpoint)", },
1328 { ARM_ID, 0x008, "Cortex-M0 SCS", "(System Control Space)", },
1329 { ARM_ID, 0x00a, "Cortex-M0 DWT", "(Data Watchpoint and Trace)", },
1330 { ARM_ID, 0x00b, "Cortex-M0 BPU", "(Breakpoint Unit)", },
1331 { ARM_ID, 0x00c, "Cortex-M4 SCS", "(System Control Space)", },
1332 { ARM_ID, 0x00d, "CoreSight ETM11", "(Embedded Trace)", },
1333 { ARM_ID, 0x00e, "Cortex-M7 FPB", "(Flash Patch and Breakpoint)", },
1334 { ARM_ID, 0x193, "SoC-600 TSGEN", "(Timestamp Generator)", },
1335 { ARM_ID, 0x470, "Cortex-M1 ROM", "(ROM Table)", },
1336 { ARM_ID, 0x471, "Cortex-M0 ROM", "(ROM Table)", },
1337 { ARM_ID, 0x490, "Cortex-A15 GIC", "(Generic Interrupt Controller)", },
1338 { ARM_ID, 0x492, "Cortex-R52 GICD", "(Distributor)", },
1339 { ARM_ID, 0x493, "Cortex-R52 GICR", "(Redistributor)", },
1340 { ARM_ID, 0x4a1, "Cortex-A53 ROM", "(v8 Memory Map ROM Table)", },
1341 { ARM_ID, 0x4a2, "Cortex-A57 ROM", "(ROM Table)", },
1342 { ARM_ID, 0x4a3, "Cortex-A53 ROM", "(v7 Memory Map ROM Table)", },
1343 { ARM_ID, 0x4a4, "Cortex-A72 ROM", "(ROM Table)", },
1344 { ARM_ID, 0x4a9, "Cortex-A9 ROM", "(ROM Table)", },
1345 { ARM_ID, 0x4aa, "Cortex-A35 ROM", "(v8 Memory Map ROM Table)", },
1346 { ARM_ID, 0x4af, "Cortex-A15 ROM", "(ROM Table)", },
1347 { ARM_ID, 0x4b5, "Cortex-R5 ROM", "(ROM Table)", },
1348 { ARM_ID, 0x4b8, "Cortex-R52 ROM", "(ROM Table)", },
1349 { ARM_ID, 0x4c0, "Cortex-M0+ ROM", "(ROM Table)", },
1350 { ARM_ID, 0x4c3, "Cortex-M3 ROM", "(ROM Table)", },
1351 { ARM_ID, 0x4c4, "Cortex-M4 ROM", "(ROM Table)", },
1352 { ARM_ID, 0x4c7, "Cortex-M7 PPB ROM", "(Private Peripheral Bus ROM Table)", },
1353 { ARM_ID, 0x4c8, "Cortex-M7 ROM", "(ROM Table)", },
1354 { ARM_ID, 0x4e0, "Cortex-A35 ROM", "(v7 Memory Map ROM Table)", },
1355 { ARM_ID, 0x4e4, "Cortex-A76 ROM", "(ROM Table)", },
1356 { ARM_ID, 0x906, "CoreSight CTI", "(Cross Trigger)", },
1357 { ARM_ID, 0x907, "CoreSight ETB", "(Trace Buffer)", },
1358 { ARM_ID, 0x908, "CoreSight CSTF", "(Trace Funnel)", },
1359 { ARM_ID, 0x909, "CoreSight ATBR", "(Advanced Trace Bus Replicator)", },
1360 { ARM_ID, 0x910, "CoreSight ETM9", "(Embedded Trace)", },
1361 { ARM_ID, 0x912, "CoreSight TPIU", "(Trace Port Interface Unit)", },
1362 { ARM_ID, 0x913, "CoreSight ITM", "(Instrumentation Trace Macrocell)", },
1363 { ARM_ID, 0x914, "CoreSight SWO", "(Single Wire Output)", },
1364 { ARM_ID, 0x917, "CoreSight HTM", "(AHB Trace Macrocell)", },
1365 { ARM_ID, 0x920, "CoreSight ETM11", "(Embedded Trace)", },
1366 { ARM_ID, 0x921, "Cortex-A8 ETM", "(Embedded Trace)", },
1367 { ARM_ID, 0x922, "Cortex-A8 CTI", "(Cross Trigger)", },
1368 { ARM_ID, 0x923, "Cortex-M3 TPIU", "(Trace Port Interface Unit)", },
1369 { ARM_ID, 0x924, "Cortex-M3 ETM", "(Embedded Trace)", },
1370 { ARM_ID, 0x925, "Cortex-M4 ETM", "(Embedded Trace)", },
1371 { ARM_ID, 0x930, "Cortex-R4 ETM", "(Embedded Trace)", },
1372 { ARM_ID, 0x931, "Cortex-R5 ETM", "(Embedded Trace)", },
1373 { ARM_ID, 0x932, "CoreSight MTB-M0+", "(Micro Trace Buffer)", },
1374 { ARM_ID, 0x941, "CoreSight TPIU-Lite", "(Trace Port Interface Unit)", },
1375 { ARM_ID, 0x950, "Cortex-A9 PTM", "(Program Trace Macrocell)", },
1376 { ARM_ID, 0x955, "Cortex-A5 ETM", "(Embedded Trace)", },
1377 { ARM_ID, 0x95a, "Cortex-A72 ETM", "(Embedded Trace)", },
1378 { ARM_ID, 0x95b, "Cortex-A17 PTM", "(Program Trace Macrocell)", },
1379 { ARM_ID, 0x95d, "Cortex-A53 ETM", "(Embedded Trace)", },
1380 { ARM_ID, 0x95e, "Cortex-A57 ETM", "(Embedded Trace)", },
1381 { ARM_ID, 0x95f, "Cortex-A15 PTM", "(Program Trace Macrocell)", },
1382 { ARM_ID, 0x961, "CoreSight TMC", "(Trace Memory Controller)", },
1383 { ARM_ID, 0x962, "CoreSight STM", "(System Trace Macrocell)", },
1384 { ARM_ID, 0x975, "Cortex-M7 ETM", "(Embedded Trace)", },
1385 { ARM_ID, 0x9a0, "CoreSight PMU", "(Performance Monitoring Unit)", },
1386 { ARM_ID, 0x9a1, "Cortex-M4 TPIU", "(Trace Port Interface Unit)", },
1387 { ARM_ID, 0x9a4, "CoreSight GPR", "(Granular Power Requester)", },
1388 { ARM_ID, 0x9a5, "Cortex-A5 PMU", "(Performance Monitor Unit)", },
1389 { ARM_ID, 0x9a7, "Cortex-A7 PMU", "(Performance Monitor Unit)", },
1390 { ARM_ID, 0x9a8, "Cortex-A53 CTI", "(Cross Trigger)", },
1391 { ARM_ID, 0x9a9, "Cortex-M7 TPIU", "(Trace Port Interface Unit)", },
1392 { ARM_ID, 0x9ae, "Cortex-A17 PMU", "(Performance Monitor Unit)", },
1393 { ARM_ID, 0x9af, "Cortex-A15 PMU", "(Performance Monitor Unit)", },
1394 { ARM_ID, 0x9b6, "Cortex-R52 PMU/CTI/ETM", "(Performance Monitor Unit/Cross Trigger/ETM)", },
1395 { ARM_ID, 0x9b7, "Cortex-R7 PMU", "(Performance Monitor Unit)", },
1396 { ARM_ID, 0x9d3, "Cortex-A53 PMU", "(Performance Monitor Unit)", },
1397 { ARM_ID, 0x9d7, "Cortex-A57 PMU", "(Performance Monitor Unit)", },
1398 { ARM_ID, 0x9d8, "Cortex-A72 PMU", "(Performance Monitor Unit)", },
1399 { ARM_ID, 0x9da, "Cortex-A35 PMU/CTI/ETM", "(Performance Monitor Unit/Cross Trigger/ETM)", },
1400 { ARM_ID, 0x9e2, "SoC-600 APB-AP", "(APB4 Memory Access Port)", },
1401 { ARM_ID, 0x9e3, "SoC-600 AHB-AP", "(AHB5 Memory Access Port)", },
1402 { ARM_ID, 0x9e4, "SoC-600 AXI-AP", "(AXI Memory Access Port)", },
1403 { ARM_ID, 0x9e5, "SoC-600 APv1 Adapter", "(Access Port v1 Adapter)", },
1404 { ARM_ID, 0x9e6, "SoC-600 JTAG-AP", "(JTAG Access Port)", },
1405 { ARM_ID, 0x9e7, "SoC-600 TPIU", "(Trace Port Interface Unit)", },
1406 { ARM_ID, 0x9e8, "SoC-600 TMC ETR/ETS", "(Embedded Trace Router/Streamer)", },
1407 { ARM_ID, 0x9e9, "SoC-600 TMC ETB", "(Embedded Trace Buffer)", },
1408 { ARM_ID, 0x9ea, "SoC-600 TMC ETF", "(Embedded Trace FIFO)", },
1409 { ARM_ID, 0x9eb, "SoC-600 ATB Funnel", "(Trace Funnel)", },
1410 { ARM_ID, 0x9ec, "SoC-600 ATB Replicator", "(Trace Replicator)", },
1411 { ARM_ID, 0x9ed, "SoC-600 CTI", "(Cross Trigger)", },
1412 { ARM_ID, 0x9ee, "SoC-600 CATU", "(Address Translation Unit)", },
1413 { ARM_ID, 0xc05, "Cortex-A5 Debug", "(Debug Unit)", },
1414 { ARM_ID, 0xc07, "Cortex-A7 Debug", "(Debug Unit)", },
1415 { ARM_ID, 0xc08, "Cortex-A8 Debug", "(Debug Unit)", },
1416 { ARM_ID, 0xc09, "Cortex-A9 Debug", "(Debug Unit)", },
1417 { ARM_ID, 0xc0e, "Cortex-A17 Debug", "(Debug Unit)", },
1418 { ARM_ID, 0xc0f, "Cortex-A15 Debug", "(Debug Unit)", },
1419 { ARM_ID, 0xc14, "Cortex-R4 Debug", "(Debug Unit)", },
1420 { ARM_ID, 0xc15, "Cortex-R5 Debug", "(Debug Unit)", },
1421 { ARM_ID, 0xc17, "Cortex-R7 Debug", "(Debug Unit)", },
1422 { ARM_ID, 0xd03, "Cortex-A53 Debug", "(Debug Unit)", },
1423 { ARM_ID, 0xd04, "Cortex-A35 Debug", "(Debug Unit)", },
1424 { ARM_ID, 0xd07, "Cortex-A57 Debug", "(Debug Unit)", },
1425 { ARM_ID, 0xd08, "Cortex-A72 Debug", "(Debug Unit)", },
1426 { ARM_ID, 0xd0b, "Cortex-A76 Debug", "(Debug Unit)", },
1427 { ARM_ID, 0xd0c, "Neoverse N1", "(Debug Unit)", },
1428 { ARM_ID, 0xd13, "Cortex-R52 Debug", "(Debug Unit)", },
1429 { ARM_ID, 0xd49, "Neoverse N2", "(Debug Unit)", },
1430 { 0x017, 0x120, "TI SDTI", "(System Debug Trace Interface)", }, /* from OMAP3 memmap */
1431 { 0x017, 0x343, "TI DAPCTL", "", }, /* from OMAP3 memmap */
1432 { 0x017, 0x9af, "MSP432 ROM", "(ROM Table)" },
1433 { 0x01f, 0xcd0, "Atmel CPU with DSU", "(CPU)" },
1434 { 0x041, 0x1db, "XMC4500 ROM", "(ROM Table)" },
1435 { 0x041, 0x1df, "XMC4700/4800 ROM", "(ROM Table)" },
1436 { 0x041, 0x1ed, "XMC1000 ROM", "(ROM Table)" },
1437 { 0x065, 0x000, "SHARC+/Blackfin+", "", },
1438 { 0x070, 0x440, "Qualcomm QDSS Component v1", "(Qualcomm Designed CoreSight Component v1)", },
1439 { 0x0bf, 0x100, "Brahma-B53 Debug", "(Debug Unit)", },
1440 { 0x0bf, 0x9d3, "Brahma-B53 PMU", "(Performance Monitor Unit)", },
1441 { 0x0bf, 0x4a1, "Brahma-B53 ROM", "(ROM Table)", },
1442 { 0x0bf, 0x721, "Brahma-B53 ROM", "(ROM Table)", },
1443 { 0x1eb, 0x181, "Tegra 186 ROM", "(ROM Table)", },
1444 { 0x1eb, 0x202, "Denver ETM", "(Denver Embedded Trace)", },
1445 { 0x1eb, 0x211, "Tegra 210 ROM", "(ROM Table)", },
1446 { 0x1eb, 0x302, "Denver Debug", "(Debug Unit)", },
1447 { 0x1eb, 0x402, "Denver PMU", "(Performance Monitor Unit)", },
1448 };
1449
1450 static const struct dap_part_nums *pidr_to_part_num(unsigned int designer_id, unsigned int part_num)
1451 {
1452 static const struct dap_part_nums unknown = {
1453 .type = "Unrecognized",
1454 .full = "",
1455 };
1456
1457 for (unsigned int i = 0; i < ARRAY_SIZE(dap_part_nums); i++)
1458 if (dap_part_nums[i].designer_id == designer_id && dap_part_nums[i].part_num == part_num)
1459 return &dap_part_nums[i];
1460
1461 return &unknown;
1462 }
1463
1464 static int dap_devtype_display(struct command_invocation *cmd, uint32_t devtype)
1465 {
1466 const char *major = "Reserved", *subtype = "Reserved";
1467 const unsigned int minor = (devtype & ARM_CS_C9_DEVTYPE_SUB_MASK) >> ARM_CS_C9_DEVTYPE_SUB_SHIFT;
1468 const unsigned int devtype_major = (devtype & ARM_CS_C9_DEVTYPE_MAJOR_MASK) >> ARM_CS_C9_DEVTYPE_MAJOR_SHIFT;
1469 switch (devtype_major) {
1470 case 0:
1471 major = "Miscellaneous";
1472 switch (minor) {
1473 case 0:
1474 subtype = "other";
1475 break;
1476 case 4:
1477 subtype = "Validation component";
1478 break;
1479 }
1480 break;
1481 case 1:
1482 major = "Trace Sink";
1483 switch (minor) {
1484 case 0:
1485 subtype = "other";
1486 break;
1487 case 1:
1488 subtype = "Port";
1489 break;
1490 case 2:
1491 subtype = "Buffer";
1492 break;
1493 case 3:
1494 subtype = "Router";
1495 break;
1496 }
1497 break;
1498 case 2:
1499 major = "Trace Link";
1500 switch (minor) {
1501 case 0:
1502 subtype = "other";
1503 break;
1504 case 1:
1505 subtype = "Funnel, router";
1506 break;
1507 case 2:
1508 subtype = "Filter";
1509 break;
1510 case 3:
1511 subtype = "FIFO, buffer";
1512 break;
1513 }
1514 break;
1515 case 3:
1516 major = "Trace Source";
1517 switch (minor) {
1518 case 0:
1519 subtype = "other";
1520 break;
1521 case 1:
1522 subtype = "Processor";
1523 break;
1524 case 2:
1525 subtype = "DSP";
1526 break;
1527 case 3:
1528 subtype = "Engine/Coprocessor";
1529 break;
1530 case 4:
1531 subtype = "Bus";
1532 break;
1533 case 6:
1534 subtype = "Software";
1535 break;
1536 }
1537 break;
1538 case 4:
1539 major = "Debug Control";
1540 switch (minor) {
1541 case 0:
1542 subtype = "other";
1543 break;
1544 case 1:
1545 subtype = "Trigger Matrix";
1546 break;
1547 case 2:
1548 subtype = "Debug Auth";
1549 break;
1550 case 3:
1551 subtype = "Power Requestor";
1552 break;
1553 }
1554 break;
1555 case 5:
1556 major = "Debug Logic";
1557 switch (minor) {
1558 case 0:
1559 subtype = "other";
1560 break;
1561 case 1:
1562 subtype = "Processor";
1563 break;
1564 case 2:
1565 subtype = "DSP";
1566 break;
1567 case 3:
1568 subtype = "Engine/Coprocessor";
1569 break;
1570 case 4:
1571 subtype = "Bus";
1572 break;
1573 case 5:
1574 subtype = "Memory";
1575 break;
1576 }
1577 break;
1578 case 6:
1579 major = "Performance Monitor";
1580 switch (minor) {
1581 case 0:
1582 subtype = "other";
1583 break;
1584 case 1:
1585 subtype = "Processor";
1586 break;
1587 case 2:
1588 subtype = "DSP";
1589 break;
1590 case 3:
1591 subtype = "Engine/Coprocessor";
1592 break;
1593 case 4:
1594 subtype = "Bus";
1595 break;
1596 case 5:
1597 subtype = "Memory";
1598 break;
1599 }
1600 break;
1601 }
1602 command_print(cmd, "\t\tType is 0x%02x, %s, %s",
1603 devtype & ARM_CS_C9_DEVTYPE_MASK,
1604 major, subtype);
1605 return ERROR_OK;
1606 }
1607
1608 /**
1609 * Actions/operations to be executed while parsing ROM tables.
1610 */
1611 struct rtp_ops {
1612 /**
1613 * Executed at the start of a new AP, typically to print the AP header.
1614 * @param ap Pointer to AP.
1615 * @param depth The current depth level of ROM table.
1616 * @param priv Pointer to private data.
1617 * @return ERROR_OK on success, else a fault code.
1618 */
1619 int (*ap_header)(struct adiv5_ap *ap, int depth, void *priv);
1620 /**
1621 * Executed at the start of a new MEM-AP, typically to print the MEM-AP header.
1622 * @param retval Error encountered while reading AP.
1623 * @param ap Pointer to AP.
1624 * @param dbgbase Value of MEM-AP Debug Base Address register.
1625 * @param apid Value of MEM-AP IDR Identification Register.
1626 * @param depth The current depth level of ROM table.
1627 * @param priv Pointer to private data.
1628 * @return ERROR_OK on success, else a fault code.
1629 */
1630 int (*mem_ap_header)(int retval, struct adiv5_ap *ap, uint64_t dbgbase,
1631 uint32_t apid, int depth, void *priv);
1632 /**
1633 * Executed when a CoreSight component is parsed, typically to print
1634 * information on the component.
1635 * @param retval Error encountered while reading component's registers.
1636 * @param v Pointer to a container of the component's registers.
1637 * @param depth The current depth level of ROM table.
1638 * @param priv Pointer to private data.
1639 * @return ERROR_OK on success, else a fault code.
1640 */
1641 int (*cs_component)(int retval, struct cs_component_vals *v, int depth, void *priv);
1642 /**
1643 * Executed for each entry of a ROM table, typically to print the entry
1644 * and information about validity or end-of-table mark.
1645 * @param retval Error encountered while reading the ROM table entry.
1646 * @param depth The current depth level of ROM table.
1647 * @param offset The offset of the entry in the ROM table.
1648 * @param romentry The value of the ROM table entry.
1649 * @param priv Pointer to private data.
1650 * @return ERROR_OK on success, else a fault code.
1651 */
1652 int (*rom_table_entry)(int retval, int depth, unsigned int offset, uint64_t romentry,
1653 void *priv);
1654 /**
1655 * Private data
1656 */
1657 void *priv;
1658 };
1659
1660 /**
1661 * Wrapper around struct rtp_ops::ap_header.
1662 */
1663 static int rtp_ops_ap_header(const struct rtp_ops *ops,
1664 struct adiv5_ap *ap, int depth)
1665 {
1666 if (ops->ap_header)
1667 return ops->ap_header(ap, depth, ops->priv);
1668
1669 return ERROR_OK;
1670 }
1671
1672 /**
1673 * Wrapper around struct rtp_ops::mem_ap_header.
1674 * Input parameter @a retval is propagated.
1675 */
1676 static int rtp_ops_mem_ap_header(const struct rtp_ops *ops,
1677 int retval, struct adiv5_ap *ap, uint64_t dbgbase, uint32_t apid, int depth)
1678 {
1679 if (!ops->mem_ap_header)
1680 return retval;
1681
1682 int retval1 = ops->mem_ap_header(retval, ap, dbgbase, apid, depth, ops->priv);
1683 if (retval != ERROR_OK)
1684 return retval;
1685 return retval1;
1686 }
1687
1688 /**
1689 * Wrapper around struct rtp_ops::cs_component.
1690 * Input parameter @a retval is propagated.
1691 */
1692 static int rtp_ops_cs_component(const struct rtp_ops *ops,
1693 int retval, struct cs_component_vals *v, int depth)
1694 {
1695 if (!ops->cs_component)
1696 return retval;
1697
1698 int retval1 = ops->cs_component(retval, v, depth, ops->priv);
1699 if (retval != ERROR_OK)
1700 return retval;
1701 return retval1;
1702 }
1703
1704 /**
1705 * Wrapper around struct rtp_ops::rom_table_entry.
1706 * Input parameter @a retval is propagated.
1707 */
1708 static int rtp_ops_rom_table_entry(const struct rtp_ops *ops,
1709 int retval, int depth, unsigned int offset, uint64_t romentry)
1710 {
1711 if (!ops->rom_table_entry)
1712 return retval;
1713
1714 int retval1 = ops->rom_table_entry(retval, depth, offset, romentry, ops->priv);
1715 if (retval != ERROR_OK)
1716 return retval;
1717 return retval1;
1718 }
1719
1720 /* Broken ROM tables can have circular references. Stop after a while */
1721 #define ROM_TABLE_MAX_DEPTH (16)
1722
1723 /**
1724 * Value used only during lookup of a CoreSight component in ROM table.
1725 * Return CORESIGHT_COMPONENT_FOUND when component is found.
1726 * Return ERROR_OK when component is not found yet.
1727 * Return any other ERROR_* in case of error.
1728 */
1729 #define CORESIGHT_COMPONENT_FOUND (1)
1730
1731 static int rtp_ap(const struct rtp_ops *ops, struct adiv5_ap *ap, int depth);
1732 static int rtp_cs_component(enum coresight_access_mode mode, const struct rtp_ops *ops,
1733 struct adiv5_ap *ap, target_addr_t dbgbase, bool *is_mem_ap, int depth);
1734
1735 static int rtp_rom_loop(enum coresight_access_mode mode, const struct rtp_ops *ops,
1736 struct adiv5_ap *ap, target_addr_t base_address, int depth,
1737 unsigned int width, unsigned int max_entries)
1738 {
1739 /* ADIv6 AP ROM table provide offset from current AP */
1740 if (mode == CS_ACCESS_AP)
1741 base_address = ap->ap_num;
1742
1743 assert(IS_ALIGNED(base_address, ARM_CS_ALIGN));
1744
1745 unsigned int offset = 0;
1746 while (max_entries--) {
1747 uint64_t romentry;
1748 uint32_t romentry_low, romentry_high;
1749 target_addr_t component_base;
1750 unsigned int saved_offset = offset;
1751
1752 int retval = dap_queue_read_reg(mode, ap, base_address, offset, &romentry_low);
1753 offset += 4;
1754 if (retval == ERROR_OK && width == 64) {
1755 retval = dap_queue_read_reg(mode, ap, base_address, offset, &romentry_high);
1756 offset += 4;
1757 }
1758 if (retval == ERROR_OK)
1759 retval = dap_run(ap->dap);
1760 if (retval != ERROR_OK) {
1761 LOG_DEBUG("Failed read ROM table entry");
1762 return retval;
1763 }
1764
1765 if (width == 64) {
1766 romentry = (((uint64_t)romentry_high) << 32) | romentry_low;
1767 component_base = base_address +
1768 ((((uint64_t)romentry_high) << 32) | (romentry_low & ARM_CS_ROMENTRY_OFFSET_MASK));
1769 } else {
1770 romentry = romentry_low;
1771 /* "romentry" is signed */
1772 component_base = base_address + (int32_t)(romentry_low & ARM_CS_ROMENTRY_OFFSET_MASK);
1773 if (!is_64bit_ap(ap))
1774 component_base = (uint32_t)component_base;
1775 }
1776 retval = rtp_ops_rom_table_entry(ops, retval, depth, saved_offset, romentry);
1777 if (retval != ERROR_OK)
1778 return retval;
1779
1780 if (romentry == 0) {
1781 /* End of ROM table */
1782 break;
1783 }
1784
1785 if (!(romentry & ARM_CS_ROMENTRY_PRESENT))
1786 continue;
1787
1788 /* Recurse */
1789 if (mode == CS_ACCESS_AP) {
1790 struct adiv5_ap *next_ap = dap_get_ap(ap->dap, component_base);
1791 if (!next_ap) {
1792 LOG_DEBUG("Wrong AP # 0x%" PRIx64, component_base);
1793 continue;
1794 }
1795 retval = rtp_ap(ops, next_ap, depth + 1);
1796 dap_put_ap(next_ap);
1797 } else {
1798 /* mode == CS_ACCESS_MEM_AP */
1799 retval = rtp_cs_component(mode, ops, ap, component_base, NULL, depth + 1);
1800 }
1801 if (retval == CORESIGHT_COMPONENT_FOUND)
1802 return CORESIGHT_COMPONENT_FOUND;
1803 if (retval != ERROR_OK) {
1804 /* TODO: do we need to send an ABORT before continuing? */
1805 LOG_DEBUG("Ignore error parsing CoreSight component");
1806 continue;
1807 }
1808 }
1809
1810 return ERROR_OK;
1811 }
1812
1813 static int rtp_cs_component(enum coresight_access_mode mode, const struct rtp_ops *ops,
1814 struct adiv5_ap *ap, target_addr_t base_address, bool *is_mem_ap, int depth)
1815 {
1816 struct cs_component_vals v;
1817 int retval;
1818
1819 assert(IS_ALIGNED(base_address, ARM_CS_ALIGN));
1820
1821 if (is_mem_ap)
1822 *is_mem_ap = false;
1823
1824 if (depth > ROM_TABLE_MAX_DEPTH)
1825 retval = ERROR_FAIL;
1826 else
1827 retval = rtp_read_cs_regs(mode, ap, base_address, &v);
1828
1829 retval = rtp_ops_cs_component(ops, retval, &v, depth);
1830 if (retval == CORESIGHT_COMPONENT_FOUND)
1831 return CORESIGHT_COMPONENT_FOUND;
1832 if (retval != ERROR_OK)
1833 return ERROR_OK; /* Don't abort recursion */
1834
1835 if (!is_valid_arm_cs_cidr(v.cid))
1836 return ERROR_OK; /* Don't abort recursion */
1837
1838 const unsigned int class = ARM_CS_CIDR_CLASS(v.cid);
1839
1840 if (class == ARM_CS_CLASS_0X1_ROM_TABLE)
1841 return rtp_rom_loop(mode, ops, ap, base_address, depth, 32, 960);
1842
1843 if (class == ARM_CS_CLASS_0X9_CS_COMPONENT) {
1844 if ((v.devarch & ARM_CS_C9_DEVARCH_PRESENT) == 0)
1845 return ERROR_OK;
1846
1847 if (is_mem_ap && (v.devarch & DEVARCH_ID_MASK) == DEVARCH_MEM_AP)
1848 *is_mem_ap = true;
1849
1850 /* quit if not ROM table */
1851 if ((v.devarch & DEVARCH_ID_MASK) != DEVARCH_ROM_C_0X9)
1852 return ERROR_OK;
1853
1854 if ((v.devid & ARM_CS_C9_DEVID_FORMAT_MASK) == ARM_CS_C9_DEVID_FORMAT_64BIT)
1855 return rtp_rom_loop(mode, ops, ap, base_address, depth, 64, 256);
1856 else
1857 return rtp_rom_loop(mode, ops, ap, base_address, depth, 32, 512);
1858 }
1859
1860 /* Class other than 0x1 and 0x9 */
1861 return ERROR_OK;
1862 }
1863
1864 static int rtp_ap(const struct rtp_ops *ops, struct adiv5_ap *ap, int depth)
1865 {
1866 uint32_t apid;
1867 target_addr_t dbgbase, invalid_entry;
1868
1869 int retval = rtp_ops_ap_header(ops, ap, depth);
1870 if (retval != ERROR_OK || depth > ROM_TABLE_MAX_DEPTH)
1871 return ERROR_OK; /* Don't abort recursion */
1872
1873 if (is_adiv6(ap->dap)) {
1874 bool is_mem_ap;
1875 retval = rtp_cs_component(CS_ACCESS_AP, ops, ap, 0, &is_mem_ap, depth);
1876 if (retval == CORESIGHT_COMPONENT_FOUND)
1877 return CORESIGHT_COMPONENT_FOUND;
1878 if (retval != ERROR_OK)
1879 return ERROR_OK; /* Don't abort recursion */
1880
1881 if (!is_mem_ap)
1882 return ERROR_OK;
1883 /* Continue for an ADIv6 MEM-AP */
1884 }
1885
1886 /* Now we read ROM table ID registers, ref. ARM IHI 0029B sec */
1887 retval = dap_get_debugbase(ap, &dbgbase, &apid);
1888 if (retval != ERROR_OK)
1889 return retval;
1890 retval = rtp_ops_mem_ap_header(ops, retval, ap, dbgbase, apid, depth);
1891 if (retval != ERROR_OK)
1892 return retval;
1893
1894 if (apid == 0)
1895 return ERROR_FAIL;
1896
1897 /* NOTE: a MEM-AP may have a single CoreSight component that's
1898 * not a ROM table ... or have no such components at all.
1899 */
1900 const unsigned int class = (apid & AP_REG_IDR_CLASS_MASK) >> AP_REG_IDR_CLASS_SHIFT;
1901
1902 if (class == AP_REG_IDR_CLASS_MEM_AP) {
1903 if (is_64bit_ap(ap))
1904 invalid_entry = 0xFFFFFFFFFFFFFFFFull;
1905 else
1906 invalid_entry = 0xFFFFFFFFul;
1907
1908 if (dbgbase != invalid_entry && (dbgbase & 0x3) != 0x2) {
1909 retval = rtp_cs_component(CS_ACCESS_MEM_AP, ops, ap,
1910 dbgbase & 0xFFFFFFFFFFFFF000ull, NULL, depth);
1911 if (retval == CORESIGHT_COMPONENT_FOUND)
1912 return CORESIGHT_COMPONENT_FOUND;
1913 }
1914 }
1915
1916 return ERROR_OK;
1917 }
1918
1919 /* Actions for command "dap info" */
1920
1921 static int dap_info_ap_header(struct adiv5_ap *ap, int depth, void *priv)
1922 {
1923 struct command_invocation *cmd = priv;
1924
1925 if (depth > ROM_TABLE_MAX_DEPTH) {
1926 command_print(cmd, "\tTables too deep");
1927 return ERROR_FAIL;
1928 }
1929
1930 command_print(cmd, "%sAP # 0x%" PRIx64, (depth) ? "\t\t" : "", ap->ap_num);
1931 return ERROR_OK;
1932 }
1933
1934 static int dap_info_mem_ap_header(int retval, struct adiv5_ap *ap,
1935 target_addr_t dbgbase, uint32_t apid, int depth, void *priv)
1936 {
1937 struct command_invocation *cmd = priv;
1938 target_addr_t invalid_entry;
1939 char tabs[17] = "";
1940
1941 if (retval != ERROR_OK) {
1942 command_print(cmd, "\t\tCan't read MEM-AP, the corresponding core might be turned off");
1943 return retval;
1944 }
1945
1946 if (depth > ROM_TABLE_MAX_DEPTH) {
1947 command_print(cmd, "\tTables too deep");
1948 return ERROR_FAIL;
1949 }
1950
1951 if (depth)
1952 snprintf(tabs, sizeof(tabs), "\t[L%02d] ", depth);
1953
1954 command_print(cmd, "\t\tAP ID register 0x%8.8" PRIx32, apid);
1955 if (apid == 0) {
1956 command_print(cmd, "\t\tNo AP found at this AP#0x%" PRIx64, ap->ap_num);
1957 return ERROR_FAIL;
1958 }
1959
1960 command_print(cmd, "\t\tType is %s", ap_type_to_description(apid & AP_TYPE_MASK));
1961
1962 /* NOTE: a MEM-AP may have a single CoreSight component that's
1963 * not a ROM table ... or have no such components at all.
1964 */
1965 const unsigned int class = (apid & AP_REG_IDR_CLASS_MASK) >> AP_REG_IDR_CLASS_SHIFT;
1966
1967 if (class == AP_REG_IDR_CLASS_MEM_AP) {
1968 if (is_64bit_ap(ap))
1969 invalid_entry = 0xFFFFFFFFFFFFFFFFull;
1970 else
1971 invalid_entry = 0xFFFFFFFFul;
1972
1973 command_print(cmd, "%sMEM-AP BASE " TARGET_ADDR_FMT, tabs, dbgbase);
1974
1975 if (dbgbase == invalid_entry || (dbgbase & 0x3) == 0x2) {
1976 command_print(cmd, "\t\tNo ROM table present");
1977 } else {
1978 if (dbgbase & 0x01)
1979 command_print(cmd, "\t\tValid ROM table present");
1980 else
1981 command_print(cmd, "\t\tROM table in legacy format");
1982 }
1983 }
1984
1985 return ERROR_OK;
1986 }
1987
1988 static int dap_info_cs_component(int retval, struct cs_component_vals *v, int depth, void *priv)
1989 {
1990 struct command_invocation *cmd = priv;
1991
1992 if (depth > ROM_TABLE_MAX_DEPTH) {
1993 command_print(cmd, "\tTables too deep");
1994 return ERROR_FAIL;
1995 }
1996
1997 if (v->mode == CS_ACCESS_MEM_AP)
1998 command_print(cmd, "\t\tComponent base address " TARGET_ADDR_FMT, v->component_base);
1999
2000 if (retval != ERROR_OK) {
2001 command_print(cmd, "\t\tCan't read component, the corresponding core might be turned off");
2002 return retval;
2003 }
2004
2005 if (!is_valid_arm_cs_cidr(v->cid)) {
2006 command_print(cmd, "\t\tInvalid CID 0x%08" PRIx32, v->cid);
2007 return ERROR_OK; /* Don't abort recursion */
2008 }
2009
2010 /* component may take multiple 4K pages */
2011 uint32_t size = ARM_CS_PIDR_SIZE(v->pid);
2012 if (size > 0)
2013 command_print(cmd, "\t\tStart address " TARGET_ADDR_FMT, v->component_base - 0x1000 * size);
2014
2015 command_print(cmd, "\t\tPeripheral ID 0x%010" PRIx64, v->pid);
2016
2017 const unsigned int part_num = ARM_CS_PIDR_PART(v->pid);
2018 unsigned int designer_id = ARM_CS_PIDR_DESIGNER(v->pid);
2019
2020 if (v->pid & ARM_CS_PIDR_JEDEC) {
2021 /* JEP106 code */
2022 command_print(cmd, "\t\tDesigner is 0x%03x, %s",
2023 designer_id, jep106_manufacturer(designer_id));
2024 } else {
2025 /* Legacy ASCII ID, clear invalid bits */
2026 designer_id &= 0x7f;
2027 command_print(cmd, "\t\tDesigner ASCII code 0x%02x, %s",
2028 designer_id, designer_id == 0x41 ? "ARM" : "<unknown>");
2029 }
2030
2031 const struct dap_part_nums *partnum = pidr_to_part_num(designer_id, part_num);
2032 command_print(cmd, "\t\tPart is 0x%03x, %s %s", part_num, partnum->type, partnum->full);
2033
2034 const unsigned int class = ARM_CS_CIDR_CLASS(v->cid);
2035 command_print(cmd, "\t\tComponent class is 0x%x, %s", class, class_description[class]);
2036
2037 if (class == ARM_CS_CLASS_0X1_ROM_TABLE) {
2038 if (v->devtype_memtype & ARM_CS_C1_MEMTYPE_SYSMEM_MASK)
2039 command_print(cmd, "\t\tMEMTYPE system memory present on bus");
2040 else
2041 command_print(cmd, "\t\tMEMTYPE system memory not present: dedicated debug bus");
2042 return ERROR_OK;
2043 }
2044
2045 if (class == ARM_CS_CLASS_0X9_CS_COMPONENT) {
2046 dap_devtype_display(cmd, v->devtype_memtype);
2047
2048 /* REVISIT also show ARM_CS_C9_DEVID */
2049
2050 if ((v->devarch & ARM_CS_C9_DEVARCH_PRESENT) == 0)
2051 return ERROR_OK;
2052
2053 unsigned int architect_id = ARM_CS_C9_DEVARCH_ARCHITECT(v->devarch);
2054 unsigned int revision = ARM_CS_C9_DEVARCH_REVISION(v->devarch);
2055 command_print(cmd, "\t\tDev Arch is 0x%08" PRIx32 ", %s \"%s\" rev.%u", v->devarch,
2056 jep106_manufacturer(architect_id), class0x9_devarch_description(v->devarch),
2057 revision);
2058
2059 if ((v->devarch & DEVARCH_ID_MASK) == DEVARCH_ROM_C_0X9) {
2060 command_print(cmd, "\t\tType is ROM table");
2061
2062 if (v->devid & ARM_CS_C9_DEVID_SYSMEM_MASK)
2063 command_print(cmd, "\t\tMEMTYPE system memory present on bus");
2064 else
2065 command_print(cmd, "\t\tMEMTYPE system memory not present: dedicated debug bus");
2066 }
2067 return ERROR_OK;
2068 }
2069
2070 /* Class other than 0x1 and 0x9 */
2071 return ERROR_OK;
2072 }
2073
2074 static int dap_info_rom_table_entry(int retval, int depth,
2075 unsigned int offset, uint64_t romentry, void *priv)
2076 {
2077 struct command_invocation *cmd = priv;
2078 char tabs[16] = "";
2079
2080 if (depth)
2081 snprintf(tabs, sizeof(tabs), "[L%02d] ", depth);
2082
2083 if (retval != ERROR_OK) {
2084 command_print(cmd, "\t%sROMTABLE[0x%x] Read error", tabs, offset);
2085 command_print(cmd, "\t\tUnable to continue");
2086 command_print(cmd, "\t%s\tStop parsing of ROM table", tabs);
2087 return retval;
2088 }
2089
2090 command_print(cmd, "\t%sROMTABLE[0x%x] = 0x%08" PRIx64,
2091 tabs, offset, romentry);
2092
2093 if (romentry == 0) {
2094 command_print(cmd, "\t%s\tEnd of ROM table", tabs);
2095 return ERROR_OK;
2096 }
2097
2098 if (!(romentry & ARM_CS_ROMENTRY_PRESENT)) {
2099 command_print(cmd, "\t\tComponent not present");
2100 return ERROR_OK;
2101 }
2102
2103 return ERROR_OK;
2104 }
2105
2106 int dap_info_command(struct command_invocation *cmd, struct adiv5_ap *ap)
2107 {
2108 struct rtp_ops dap_info_ops = {
2109 .ap_header = dap_info_ap_header,
2110 .mem_ap_header = dap_info_mem_ap_header,
2111 .cs_component = dap_info_cs_component,
2112 .rom_table_entry = dap_info_rom_table_entry,
2113 .priv = cmd,
2114 };
2115
2116 return rtp_ap(&dap_info_ops, ap, 0);
2117 }
2118
2119 /* Actions for dap_lookup_cs_component() */
2120
2121 struct dap_lookup_data {
2122 /* input */
2123 unsigned int idx;
2124 unsigned int type;
2125 /* output */
2126 uint64_t component_base;
2127 };
2128
2129 static int dap_lookup_cs_component_cs_component(int retval,
2130 struct cs_component_vals *v, int depth, void *priv)
2131 {
2132 struct dap_lookup_data *lookup = priv;
2133
2134 if (retval != ERROR_OK)
2135 return retval;
2136
2137 if (!is_valid_arm_cs_cidr(v->cid))
2138 return ERROR_OK;
2139
2140 const unsigned int class = ARM_CS_CIDR_CLASS(v->cid);
2141 if (class != ARM_CS_CLASS_0X9_CS_COMPONENT)
2142 return ERROR_OK;
2143
2144 if ((v->devtype_memtype & ARM_CS_C9_DEVTYPE_MASK) != lookup->type)
2145 return ERROR_OK;
2146
2147 if (lookup->idx) {
2148 /* search for next one */
2149 --lookup->idx;
2150 return ERROR_OK;
2151 }
2152
2153 /* Found! */
2154 lookup->component_base = v->component_base;
2155 return CORESIGHT_COMPONENT_FOUND;
2156 }
2157
2158 int dap_lookup_cs_component(struct adiv5_ap *ap, uint8_t type,
2159 target_addr_t *addr, int32_t core_id)
2160 {
2161 struct dap_lookup_data lookup = {
2162 .type = type,
2163 .idx = core_id,
2164 };
2165 struct rtp_ops dap_lookup_cs_component_ops = {
2166 .ap_header = NULL,
2167 .mem_ap_header = NULL,
2168 .cs_component = dap_lookup_cs_component_cs_component,
2169 .rom_table_entry = NULL,
2170 .priv = &lookup,
2171 };
2172
2173 int retval = rtp_ap(&dap_lookup_cs_component_ops, ap, 0);
2174 if (retval == CORESIGHT_COMPONENT_FOUND) {
2175 LOG_DEBUG("CS lookup found at 0x%" PRIx64, lookup.component_base);
2176 *addr = lookup.component_base;
2177 return ERROR_OK;
2178 }
2179 if (retval != ERROR_OK) {
2180 LOG_DEBUG("CS lookup error %d", retval);
2181 return retval;
2182 }
2183 LOG_DEBUG("CS lookup not found");
2184 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
2185 }
2186
2187 enum adiv5_cfg_param {
2188 CFG_DAP,
2189 CFG_AP_NUM,
2190 CFG_BASEADDR,
2191 CFG_CTIBASE, /* DEPRECATED */
2192 };
2193
2194 static const struct jim_nvp nvp_config_opts[] = {
2195 { .name = "-dap", .value = CFG_DAP },
2196 { .name = "-ap-num", .value = CFG_AP_NUM },
2197 { .name = "-baseaddr", .value = CFG_BASEADDR },
2198 { .name = "-ctibase", .value = CFG_CTIBASE }, /* DEPRECATED */
2199 { .name = NULL, .value = -1 }
2200 };
2201
2202 static int adiv5_jim_spot_configure(struct jim_getopt_info *goi,
2203 struct adiv5_dap **dap_p, uint64_t *ap_num_p, uint32_t *base_p)
2204 {
2205 assert(dap_p && ap_num_p);
2206
2207 if (!goi->argc)
2208 return JIM_OK;
2209
2210 Jim_SetEmptyResult(goi->interp);
2211
2212 struct jim_nvp *n;
2213 int e = jim_nvp_name2value_obj(goi->interp, nvp_config_opts,
2214 goi->argv[0], &n);
2215 if (e != JIM_OK)
2216 return JIM_CONTINUE;
2217
2218 /* base_p can be NULL, then '-baseaddr' option is treated as unknown */
2219 if (!base_p && (n->value == CFG_BASEADDR || n->value == CFG_CTIBASE))
2220 return JIM_CONTINUE;
2221
2222 e = jim_getopt_obj(goi, NULL);
2223 if (e != JIM_OK)
2224 return e;
2225
2226 switch (n->value) {
2227 case CFG_DAP:
2228 if (goi->isconfigure) {
2229 Jim_Obj *o_t;
2230 struct adiv5_dap *dap;
2231 e = jim_getopt_obj(goi, &o_t);
2232 if (e != JIM_OK)
2233 return e;
2234 dap = dap_instance_by_jim_obj(goi->interp, o_t);
2235 if (!dap) {
2236 Jim_SetResultString(goi->interp, "DAP name invalid!", -1);
2237 return JIM_ERR;
2238 }
2239 if (*dap_p && *dap_p != dap) {
2240 Jim_SetResultString(goi->interp,
2241 "DAP assignment cannot be changed!", -1);
2242 return JIM_ERR;
2243 }
2244 *dap_p = dap;
2245 } else {
2246 if (goi->argc)
2247 goto err_no_param;
2248 if (!*dap_p) {
2249 Jim_SetResultString(goi->interp, "DAP not configured", -1);
2250 return JIM_ERR;
2251 }
2252 Jim_SetResultString(goi->interp, adiv5_dap_name(*dap_p), -1);
2253 }
2254 break;
2255
2256 case CFG_AP_NUM:
2257 if (goi->isconfigure) {
2258 /* jim_wide is a signed 64 bits int, ap_num is unsigned with max 52 bits */
2259 jim_wide ap_num;
2260 e = jim_getopt_wide(goi, &ap_num);
2261 if (e != JIM_OK)
2262 return e;
2263 /* we still don't know dap->adi_version */
2264 if (ap_num < 0 || (ap_num > DP_APSEL_MAX && (ap_num & 0xfff))) {
2265 Jim_SetResultString(goi->interp, "Invalid AP number!", -1);
2266 return JIM_ERR;
2267 }
2268 *ap_num_p = ap_num;
2269 } else {
2270 if (goi->argc)
2271 goto err_no_param;
2272 if (*ap_num_p == DP_APSEL_INVALID) {
2273 Jim_SetResultString(goi->interp, "AP number not configured", -1);
2274 return JIM_ERR;
2275 }
2276 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, *ap_num_p));
2277 }
2278 break;
2279
2280 case CFG_CTIBASE:
2281 LOG_WARNING("DEPRECATED! use \'-baseaddr' not \'-ctibase\'");
2282 /* fall through */
2283 case CFG_BASEADDR:
2284 if (goi->isconfigure) {
2285 jim_wide base;
2286 e = jim_getopt_wide(goi, &base);
2287 if (e != JIM_OK)
2288 return e;
2289 *base_p = (uint32_t)base;
2290 } else {
2291 if (goi->argc)
2292 goto err_no_param;
2293 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, *base_p));
2294 }
2295 break;
2296 };
2297
2298 return JIM_OK;
2299
2300 err_no_param:
2301 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
2302 return JIM_ERR;
2303 }
2304
2305 int adiv5_jim_configure(struct target *target, struct jim_getopt_info *goi)
2306 {
2307 struct adiv5_private_config *pc;
2308 int e;
2309
2310 pc = (struct adiv5_private_config *)target->private_config;
2311 if (!pc) {
2312 pc = calloc(1, sizeof(struct adiv5_private_config));
2313 if (!pc) {
2314 LOG_ERROR("Out of memory");
2315 return JIM_ERR;
2316 }
2317 pc->ap_num = DP_APSEL_INVALID;
2318 target->private_config = pc;
2319 }
2320
2321 target->has_dap = true;
2322
2323 e = adiv5_jim_spot_configure(goi, &pc->dap, &pc->ap_num, NULL);
2324 if (e != JIM_OK)
2325 return e;
2326
2327 if (pc->dap && !target->dap_configured) {
2328 if (target->tap_configured) {
2329 pc->dap = NULL;
2330 Jim_SetResultString(goi->interp,
2331 "-chain-position and -dap configparams are mutually exclusive!", -1);
2332 return JIM_ERR;
2333 }
2334 target->tap = pc->dap->tap;
2335 target->dap_configured = true;
2336 }
2337
2338 return JIM_OK;
2339 }
2340
2341 int adiv5_verify_config(struct adiv5_private_config *pc)
2342 {
2343 if (!pc)
2344 return ERROR_FAIL;
2345
2346 if (!pc->dap)
2347 return ERROR_FAIL;
2348
2349 return ERROR_OK;
2350 }
2351
2352 int adiv5_jim_mem_ap_spot_configure(struct adiv5_mem_ap_spot *cfg,
2353 struct jim_getopt_info *goi)
2354 {
2355 return adiv5_jim_spot_configure(goi, &cfg->dap, &cfg->ap_num, &cfg->base);
2356 }
2357
2358 int adiv5_mem_ap_spot_init(struct adiv5_mem_ap_spot *p)
2359 {
2360 p->dap = NULL;
2361 p->ap_num = DP_APSEL_INVALID;
2362 p->base = 0;
2363 return ERROR_OK;
2364 }
2365
2366 COMMAND_HANDLER(handle_dap_info_command)
2367 {
2368 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2369 uint64_t apsel;
2370
2371 switch (CMD_ARGC) {
2372 case 0:
2373 apsel = dap->apsel;
2374 break;
2375 case 1:
2376 if (!strcmp(CMD_ARGV[0], "root")) {
2377 if (!is_adiv6(dap)) {
2378 command_print(CMD, "Option \"root\" not allowed with ADIv5 DAP");
2379 return ERROR_COMMAND_ARGUMENT_INVALID;
2380 }
2381 int retval = adiv6_dap_read_baseptr(CMD, dap, &apsel);
2382 if (retval != ERROR_OK) {
2383 command_print(CMD, "Failed reading DAP baseptr");
2384 return retval;
2385 }
2386 break;
2387 }
2388 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
2389 if (!is_ap_num_valid(dap, apsel)) {
2390 command_print(CMD, "Invalid AP number");
2391 return ERROR_COMMAND_ARGUMENT_INVALID;
2392 }
2393 break;
2394 default:
2395 return ERROR_COMMAND_SYNTAX_ERROR;
2396 }
2397
2398 struct adiv5_ap *ap = dap_get_ap(dap, apsel);
2399 if (!ap) {
2400 command_print(CMD, "Cannot get AP");
2401 return ERROR_FAIL;
2402 }
2403
2404 int retval = dap_info_command(CMD, ap);
2405 dap_put_ap(ap);
2406 return retval;
2407 }
2408
2409 COMMAND_HANDLER(dap_baseaddr_command)
2410 {
2411 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2412 uint64_t apsel;
2413 uint32_t baseaddr_lower, baseaddr_upper;
2414 struct adiv5_ap *ap;
2415 target_addr_t baseaddr;
2416 int retval;
2417
2418 baseaddr_upper = 0;
2419
2420 switch (CMD_ARGC) {
2421 case 0:
2422 apsel = dap->apsel;
2423 break;
2424 case 1:
2425 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
2426 if (!is_ap_num_valid(dap, apsel)) {
2427 command_print(CMD, "Invalid AP number");
2428 return ERROR_COMMAND_ARGUMENT_INVALID;
2429 }
2430 break;
2431 default:
2432 return ERROR_COMMAND_SYNTAX_ERROR;
2433 }
2434
2435 /* NOTE: assumes we're talking to a MEM-AP, which
2436 * has a base address. There are other kinds of AP,
2437 * though they're not common for now. This should
2438 * use the ID register to verify it's a MEM-AP.
2439 */
2440
2441 ap = dap_get_ap(dap, apsel);
2442 if (!ap) {
2443 command_print(CMD, "Cannot get AP");
2444 return ERROR_FAIL;
2445 }
2446
2447 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE(dap), &baseaddr_lower);
2448
2449 if (retval == ERROR_OK && ap->cfg_reg == MEM_AP_REG_CFG_INVALID)
2450 retval = dap_queue_ap_read(ap, MEM_AP_REG_CFG(dap), &ap->cfg_reg);
2451
2452 if (retval == ERROR_OK && (ap->cfg_reg == MEM_AP_REG_CFG_INVALID || is_64bit_ap(ap))) {
2453 /* MEM_AP_REG_BASE64 is defined as 'RES0'; can be read and then ignored on 32 bits AP */
2454 retval = dap_queue_ap_read(ap, MEM_AP_REG_BASE64(dap), &baseaddr_upper);
2455 }
2456
2457 if (retval == ERROR_OK)
2458 retval = dap_run(dap);
2459 dap_put_ap(ap);
2460 if (retval != ERROR_OK)
2461 return retval;
2462
2463 if (is_64bit_ap(ap)) {
2464 baseaddr = (((target_addr_t)baseaddr_upper) << 32) | baseaddr_lower;
2465 command_print(CMD, "0x%016" PRIx64, baseaddr);
2466 } else
2467 command_print(CMD, "0x%08" PRIx32, baseaddr_lower);
2468
2469 return ERROR_OK;
2470 }
2471
2472 COMMAND_HANDLER(dap_memaccess_command)
2473 {
2474 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2475 struct adiv5_ap *ap;
2476 uint32_t memaccess_tck;
2477
2478 switch (CMD_ARGC) {
2479 case 0:
2480 ap = dap_get_ap(dap, dap->apsel);
2481 if (!ap) {
2482 command_print(CMD, "Cannot get AP");
2483 return ERROR_FAIL;
2484 }
2485 memaccess_tck = ap->memaccess_tck;
2486 break;
2487 case 1:
2488 ap = dap_get_config_ap(dap, dap->apsel);
2489 if (!ap) {
2490 command_print(CMD, "Cannot get AP");
2491 return ERROR_FAIL;
2492 }
2493 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], memaccess_tck);
2494 ap->memaccess_tck = memaccess_tck;
2495 break;
2496 default:
2497 return ERROR_COMMAND_SYNTAX_ERROR;
2498 }
2499
2500 dap_put_ap(ap);
2501
2502 command_print(CMD, "memory bus access delay set to %" PRIu32 " tck",
2503 memaccess_tck);
2504
2505 return ERROR_OK;
2506 }
2507
2508 COMMAND_HANDLER(dap_apsel_command)
2509 {
2510 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2511 uint64_t apsel;
2512
2513 switch (CMD_ARGC) {
2514 case 0:
2515 command_print(CMD, "0x%" PRIx64, dap->apsel);
2516 return ERROR_OK;
2517 case 1:
2518 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
2519 if (!is_ap_num_valid(dap, apsel)) {
2520 command_print(CMD, "Invalid AP number");
2521 return ERROR_COMMAND_ARGUMENT_INVALID;
2522 }
2523 break;
2524 default:
2525 return ERROR_COMMAND_SYNTAX_ERROR;
2526 }
2527
2528 dap->apsel = apsel;
2529 return ERROR_OK;
2530 }
2531
2532 COMMAND_HANDLER(dap_apcsw_command)
2533 {
2534 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2535 struct adiv5_ap *ap;
2536 uint32_t csw_val, csw_mask;
2537
2538 switch (CMD_ARGC) {
2539 case 0:
2540 ap = dap_get_ap(dap, dap->apsel);
2541 if (!ap) {
2542 command_print(CMD, "Cannot get AP");
2543 return ERROR_FAIL;
2544 }
2545 command_print(CMD, "AP#0x%" PRIx64 " selected, csw 0x%8.8" PRIx32,
2546 dap->apsel, ap->csw_default);
2547 break;
2548 case 1:
2549 if (strcmp(CMD_ARGV[0], "default") == 0)
2550 csw_val = CSW_AHB_DEFAULT;
2551 else
2552 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], csw_val);
2553
2554 if (csw_val & (CSW_SIZE_MASK | CSW_ADDRINC_MASK)) {
2555 LOG_ERROR("CSW value cannot include 'Size' and 'AddrInc' bit-fields");
2556 return ERROR_COMMAND_ARGUMENT_INVALID;
2557 }
2558 ap = dap_get_config_ap(dap, dap->apsel);
2559 if (!ap) {
2560 command_print(CMD, "Cannot get AP");
2561 return ERROR_FAIL;
2562 }
2563 ap->csw_default = csw_val;
2564 break;
2565 case 2:
2566 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], csw_val);
2567 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], csw_mask);
2568 if (csw_mask & (CSW_SIZE_MASK | CSW_ADDRINC_MASK)) {
2569 LOG_ERROR("CSW mask cannot include 'Size' and 'AddrInc' bit-fields");
2570 return ERROR_COMMAND_ARGUMENT_INVALID;
2571 }
2572 ap = dap_get_config_ap(dap, dap->apsel);
2573 if (!ap) {
2574 command_print(CMD, "Cannot get AP");
2575 return ERROR_FAIL;
2576 }
2577 ap->csw_default = (ap->csw_default & ~csw_mask) | (csw_val & csw_mask);
2578 break;
2579 default:
2580 return ERROR_COMMAND_SYNTAX_ERROR;
2581 }
2582 dap_put_ap(ap);
2583
2584 return ERROR_OK;
2585 }
2586
2587
2588
2589 COMMAND_HANDLER(dap_apid_command)
2590 {
2591 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2592 uint64_t apsel;
2593 uint32_t apid;
2594 int retval;
2595
2596 switch (CMD_ARGC) {
2597 case 0:
2598 apsel = dap->apsel;
2599 break;
2600 case 1:
2601 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
2602 if (!is_ap_num_valid(dap, apsel)) {
2603 command_print(CMD, "Invalid AP number");
2604 return ERROR_COMMAND_ARGUMENT_INVALID;
2605 }
2606 break;
2607 default:
2608 return ERROR_COMMAND_SYNTAX_ERROR;
2609 }
2610
2611 struct adiv5_ap *ap = dap_get_ap(dap, apsel);
2612 if (!ap) {
2613 command_print(CMD, "Cannot get AP");
2614 return ERROR_FAIL;
2615 }
2616 retval = dap_queue_ap_read(ap, AP_REG_IDR(dap), &apid);
2617 if (retval != ERROR_OK) {
2618 dap_put_ap(ap);
2619 return retval;
2620 }
2621 retval = dap_run(dap);
2622 dap_put_ap(ap);
2623 if (retval != ERROR_OK)
2624 return retval;
2625
2626 command_print(CMD, "0x%8.8" PRIx32, apid);
2627
2628 return retval;
2629 }
2630
2631 COMMAND_HANDLER(dap_apreg_command)
2632 {
2633 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2634 uint64_t apsel;
2635 uint32_t reg, value;
2636 int retval;
2637
2638 if (CMD_ARGC < 2 || CMD_ARGC > 3)
2639 return ERROR_COMMAND_SYNTAX_ERROR;
2640
2641 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], apsel);
2642 if (!is_ap_num_valid(dap, apsel)) {
2643 command_print(CMD, "Invalid AP number");
2644 return ERROR_COMMAND_ARGUMENT_INVALID;
2645 }
2646
2647 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], reg);
2648 if (is_adiv6(dap)) {
2649 if (reg >= 4096 || (reg & 3)) {
2650 command_print(CMD, "Invalid reg value (should be less than 4096 and 4 bytes aligned)");
2651 return ERROR_COMMAND_ARGUMENT_INVALID;
2652 }
2653 } else { /* ADI version 5 */
2654 if (reg >= 256 || (reg & 3)) {
2655 command_print(CMD, "Invalid reg value (should be less than 256 and 4 bytes aligned)");
2656 return ERROR_COMMAND_ARGUMENT_INVALID;
2657 }
2658 }
2659
2660 struct adiv5_ap *ap = dap_get_ap(dap, apsel);
2661 if (!ap) {
2662 command_print(CMD, "Cannot get AP");
2663 return ERROR_FAIL;
2664 }
2665
2666 if (CMD_ARGC == 3) {
2667 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], value);
2668 /* see if user supplied register address is a match for the CSW or TAR register */
2669 if (reg == MEM_AP_REG_CSW(dap)) {
2670 ap->csw_value = 0; /* invalid, in case write fails */
2671 retval = dap_queue_ap_write(ap, reg, value);
2672 if (retval == ERROR_OK)
2673 ap->csw_value = value;
2674 } else if (reg == MEM_AP_REG_TAR(dap)) {
2675 retval = dap_queue_ap_write(ap, reg, value);
2676 if (retval == ERROR_OK)
2677 ap->tar_value = (ap->tar_value & ~0xFFFFFFFFull) | value;
2678 else {
2679 /* To track independent writes to TAR and TAR64, two tar_valid flags */
2680 /* should be used. To keep it simple, tar_valid is only invalidated on a */
2681 /* write fail. This approach causes a later re-write of the TAR and TAR64 */
2682 /* if tar_valid is false. */
2683 ap->tar_valid = false;
2684 }
2685 } else if (reg == MEM_AP_REG_TAR64(dap)) {
2686 retval = dap_queue_ap_write(ap, reg, value);
2687 if (retval == ERROR_OK)
2688 ap->tar_value = (ap->tar_value & 0xFFFFFFFFull) | (((target_addr_t)value) << 32);
2689 else {
2690 /* See above comment for the MEM_AP_REG_TAR failed write case */
2691 ap->tar_valid = false;
2692 }
2693 } else {
2694 retval = dap_queue_ap_write(ap, reg, value);
2695 }
2696 } else {
2697 retval = dap_queue_ap_read(ap, reg, &value);
2698 }
2699 if (retval == ERROR_OK)
2700 retval = dap_run(dap);
2701
2702 dap_put_ap(ap);
2703
2704 if (retval != ERROR_OK)
2705 return retval;
2706
2707 if (CMD_ARGC == 2)
2708 command_print(CMD, "0x%08" PRIx32, value);
2709
2710 return retval;
2711 }
2712
2713 COMMAND_HANDLER(dap_dpreg_command)
2714 {
2715 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2716 uint32_t reg, value;
2717 int retval;
2718
2719 if (CMD_ARGC < 1 || CMD_ARGC > 2)
2720 return ERROR_COMMAND_SYNTAX_ERROR;
2721
2722 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], reg);
2723 if (reg >= 256 || (reg & 3)) {
2724 command_print(CMD, "Invalid reg value (should be less than 256 and 4 bytes aligned)");
2725 return ERROR_COMMAND_ARGUMENT_INVALID;
2726 }
2727
2728 if (CMD_ARGC == 2) {
2729 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2730 retval = dap_queue_dp_write(dap, reg, value);
2731 } else {
2732 retval = dap_queue_dp_read(dap, reg, &value);
2733 }
2734 if (retval == ERROR_OK)
2735 retval = dap_run(dap);
2736
2737 if (retval != ERROR_OK)
2738 return retval;
2739
2740 if (CMD_ARGC == 1)
2741 command_print(CMD, "0x%08" PRIx32, value);
2742
2743 return retval;
2744 }
2745
2746 COMMAND_HANDLER(dap_ti_be_32_quirks_command)
2747 {
2748 struct adiv5_dap *dap = adiv5_get_dap(CMD_DATA);
2749 return CALL_COMMAND_HANDLER(handle_command_parse_bool, &dap->ti_be_32_quirks,
2750 "TI BE-32 quirks mode");
2751 }
2752
2753 const struct command_registration dap_instance_commands[] = {
2754 {
2755 .name = "info",
2756 .handler = handle_dap_info_command,
2757 .mode = COMMAND_EXEC,
2758 .help = "display ROM table for specified MEM-AP (default currently selected AP) "
2759 "or the ADIv6 root ROM table",
2760 .usage = "[ap_num | 'root']",
2761 },
2762 {
2763 .name = "apsel",
2764 .handler = dap_apsel_command,
2765 .mode = COMMAND_ANY,
2766 .help = "Set the currently selected AP (default 0) "
2767 "and display the result",
2768 .usage = "[ap_num]",
2769 },
2770 {
2771 .name = "apcsw",
2772 .handler = dap_apcsw_command,
2773 .mode = COMMAND_ANY,
2774 .help = "Set CSW default bits",
2775 .usage = "[value [mask]]",
2776 },
2777
2778 {
2779 .name = "apid",
2780 .handler = dap_apid_command,
2781 .mode = COMMAND_EXEC,
2782 .help = "return ID register from AP "
2783 "(default currently selected AP)",
2784 .usage = "[ap_num]",
2785 },
2786 {
2787 .name = "apreg",
2788 .handler = dap_apreg_command,
2789 .mode = COMMAND_EXEC,
2790 .help = "read/write a register from AP "
2791 "(reg is byte address of a word register, like 0 4 8...)",
2792 .usage = "ap_num reg [value]",
2793 },
2794 {
2795 .name = "dpreg",
2796 .handler = dap_dpreg_command,
2797 .mode = COMMAND_EXEC,
2798 .help = "read/write a register from DP "
2799 "(reg is byte address (bank << 4 | reg) of a word register, like 0 4 8...)",
2800 .usage = "reg [value]",
2801 },
2802 {
2803 .name = "baseaddr",
2804 .handler = dap_baseaddr_command,
2805 .mode = COMMAND_EXEC,
2806 .help = "return debug base address from MEM-AP "
2807 "(default currently selected AP)",
2808 .usage = "[ap_num]",
2809 },
2810 {
2811 .name = "memaccess",
2812 .handler = dap_memaccess_command,
2813 .mode = COMMAND_EXEC,
2814 .help = "set/get number of extra tck for MEM-AP memory "
2815 "bus access [0-255]",
2816 .usage = "[cycles]",
2817 },
2818 {
2819 .name = "ti_be_32_quirks",
2820 .handler = dap_ti_be_32_quirks_command,
2821 .mode = COMMAND_CONFIG,
2822 .help = "set/get quirks mode for TI TMS450/TMS570 processors",
2823 .usage = "[enable]",
2824 },
2825 COMMAND_REGISTRATION_DONE
2826 };

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)