binarybuffer: regression fix
[openocd/dnglaze.git] / src / target / arm11_dbgtap.c
blobbdbcc8f3890ecdf921aaeebd137031fe0d5c7d3d
1 /***************************************************************************
2 * Copyright (C) 2008 digenius technology GmbH. *
3 * Michael Bruck *
4 * *
5 * Copyright (C) 2008,2009 Oyvind Harboe oyvind.harboe@zylin.com *
6 * *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program; if not, write to the *
19 * Free Software Foundation, Inc., *
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
21 ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
27 #include "arm_jtag.h"
28 #include "arm11_dbgtap.h"
30 #include "time_support.h"
32 #if 0
33 #define JTAG_DEBUG(expr ...) DEBUG(expr)
34 #else
35 #define JTAG_DEBUG(expr ...) do {} while (0)
36 #endif
39 This pathmove goes from Pause-IR to Shift-IR while avoiding RTI. The
40 behavior of the FTDI driver IIRC was to go via RTI.
42 Conversely there may be other places in this code where the ARM11 code relies
43 on the driver to hit through RTI when coming from Update-?R.
45 static const tap_state_t arm11_move_pi_to_si_via_ci[] =
47 TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IRSHIFT
51 int arm11_add_ir_scan_vc(int num_fields, struct scan_field *fields, tap_state_t state)
53 if (cmd_queue_cur_state == TAP_IRPAUSE)
54 jtag_add_pathmove(ARRAY_SIZE(arm11_move_pi_to_si_via_ci), arm11_move_pi_to_si_via_ci);
56 jtag_add_ir_scan(num_fields, fields, state);
57 return ERROR_OK;
60 static const tap_state_t arm11_move_pd_to_sd_via_cd[] =
62 TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DRSHIFT
65 int arm11_add_dr_scan_vc(int num_fields, struct scan_field *fields, tap_state_t state)
67 if (cmd_queue_cur_state == TAP_DRPAUSE)
68 jtag_add_pathmove(ARRAY_SIZE(arm11_move_pd_to_sd_via_cd), arm11_move_pd_to_sd_via_cd);
70 jtag_add_dr_scan(num_fields, fields, state);
71 return ERROR_OK;
75 /** Code de-clutter: Construct struct scan_field to write out a value
77 * \param arm11 Target state variable.
78 * \param num_bits Length of the data field
79 * \param out_data pointer to the data that will be sent out
80 * <em > (data is read when it is added to the JTAG queue)</em>
81 * \param in_data pointer to the memory that will receive data that was clocked in
82 * <em > (data is written when the JTAG queue is executed)</em>
83 * \param field target data structure that will be initialized
85 void arm11_setup_field(struct arm11_common * arm11, int num_bits, void * out_data, void * in_data, struct scan_field * field)
87 field->tap = arm11->target->tap;
88 field->num_bits = num_bits;
89 field->out_value = out_data;
90 field->in_value = in_data;
94 /** Write JTAG instruction register
96 * \param arm11 Target state variable.
97 * \param instr An ARM11 DBGTAP instruction. Use enum #arm11_instructions.
98 * \param state Pass the final TAP state or ARM11_TAP_DEFAULT for the default value (Pause-IR).
100 * \remarks This adds to the JTAG command queue but does \em not execute it.
102 void arm11_add_IR(struct arm11_common * arm11, uint8_t instr, tap_state_t state)
104 struct jtag_tap *tap;
105 tap = arm11->target->tap;
107 if (buf_get_u32(tap->cur_instr, 0, 5) == instr)
109 JTAG_DEBUG("IR <= 0x%02x SKIPPED", instr);
110 return;
113 JTAG_DEBUG("IR <= 0x%02x", instr);
115 struct scan_field field;
117 arm11_setup_field(arm11, 5, &instr, NULL, &field);
119 arm11_add_ir_scan_vc(1, &field, state == ARM11_TAP_DEFAULT ? TAP_IRPAUSE : state);
122 /** Verify shifted out data from Scan Chain Register (SCREG)
123 * Used as parameter to struct scan_field::in_handler in
124 * arm11_add_debug_SCAN_N().
127 static void arm11_in_handler_SCAN_N(uint8_t *in_value)
129 /** \todo TODO: clarify why this isnt properly masked in core.c jtag_read_buffer() */
130 uint8_t v = *in_value & 0x1F;
132 if (v != 0x10)
134 LOG_ERROR("'arm11 target' JTAG communication error SCREG SCAN OUT 0x%02x (expected 0x10)", v);
135 jtag_set_error(ERROR_FAIL);
138 JTAG_DEBUG("SCREG SCAN OUT 0x%02x", v);
141 /** Select and write to Scan Chain Register (SCREG)
143 * This function sets the instruction register to SCAN_N and writes
144 * the data register with the selected chain number.
146 * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0301f/Cacbjhfg.html
148 * \param arm11 Target state variable.
149 * \param chain Scan chain that will be selected.
150 * \param state Pass the final TAP state or ARM11_TAP_DEFAULT for the default
151 * value (Pause-DR).
153 * The chain takes effect when Update-DR is passed (usually when subsequently
154 * the INTEXT/EXTEST instructions are written).
156 * \warning (Obsolete) Using this twice in a row will \em fail. The first
157 * call will end in Pause-DR. The second call, due to the IR
158 * caching, will not go through Capture-DR when shifting in the
159 * new scan chain number. As a result the verification in
160 * arm11_in_handler_SCAN_N() must fail.
162 * \remarks This adds to the JTAG command queue but does \em not execute it.
165 int arm11_add_debug_SCAN_N(struct arm11_common * arm11, uint8_t chain, tap_state_t state)
167 JTAG_DEBUG("SCREG <= 0x%02x", chain);
169 arm11_add_IR(arm11, ARM11_SCAN_N, ARM11_TAP_DEFAULT);
171 struct scan_field field;
173 uint8_t tmp[1];
174 arm11_setup_field(arm11, 5, &chain, &tmp, &field);
176 arm11_add_dr_scan_vc(1, &field, state == ARM11_TAP_DEFAULT ? TAP_DRPAUSE : state);
178 jtag_execute_queue_noclear();
180 arm11_in_handler_SCAN_N(tmp);
182 arm11->jtag_info.cur_scan_chain = chain;
184 return jtag_execute_queue();
187 /** Write an instruction into the ITR register
189 * \param arm11 Target state variable.
190 * \param inst An ARM11 processor instruction/opcode.
191 * \param flag Optional parameter to retrieve the InstCompl flag
192 * (this will be written when the JTAG chain is executed).
193 * \param state Pass the final TAP state or ARM11_TAP_DEFAULT for the default
194 * value (Run-Test/Idle).
196 * \remarks By default this ends with Run-Test/Idle state
197 * and causes the instruction to be executed. If
198 * a subsequent write to DTR is needed before
199 * executing the instruction then TAP_DRPAUSE should be
200 * passed to \p state.
202 * \remarks This adds to the JTAG command queue but does \em not execute it.
204 void arm11_add_debug_INST(struct arm11_common * arm11, uint32_t inst, uint8_t * flag, tap_state_t state)
206 JTAG_DEBUG("INST <= 0x%08x", inst);
208 struct scan_field itr[2];
210 arm11_setup_field(arm11, 32, &inst, NULL, itr + 0);
211 arm11_setup_field(arm11, 1, NULL, flag, itr + 1);
213 arm11_add_dr_scan_vc(ARRAY_SIZE(itr), itr, state == ARM11_TAP_DEFAULT ? TAP_IDLE : state);
216 /** Read the Debug Status and Control Register (DSCR)
218 * same as CP14 c1
220 * \param arm11 Target state variable.
221 * \param value DSCR content
222 * \return Error status
224 * \remarks This is a stand-alone function that executes the JTAG command queue.
226 int arm11_read_DSCR(struct arm11_common * arm11, uint32_t *value)
228 int retval;
229 retval = arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
230 if (retval != ERROR_OK)
231 return retval;
233 arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
235 uint32_t dscr;
236 struct scan_field chain1_field;
238 arm11_setup_field(arm11, 32, NULL, &dscr, &chain1_field);
240 arm11_add_dr_scan_vc(1, &chain1_field, TAP_DRPAUSE);
242 CHECK_RETVAL(jtag_execute_queue());
244 if (arm11->last_dscr != dscr)
245 JTAG_DEBUG("DSCR = %08x (OLD %08x)", dscr, arm11->last_dscr);
247 arm11->last_dscr = dscr;
249 *value = dscr;
251 return ERROR_OK;
254 /** Write the Debug Status and Control Register (DSCR)
256 * same as CP14 c1
258 * \param arm11 Target state variable.
259 * \param dscr DSCR content
261 * \remarks This is a stand-alone function that executes the JTAG command queue.
263 int arm11_write_DSCR(struct arm11_common * arm11, uint32_t dscr)
265 int retval;
266 retval = arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
267 if (retval != ERROR_OK)
268 return retval;
270 arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
272 struct scan_field chain1_field;
274 arm11_setup_field(arm11, 32, &dscr, NULL, &chain1_field);
276 arm11_add_dr_scan_vc(1, &chain1_field, TAP_DRPAUSE);
278 CHECK_RETVAL(jtag_execute_queue());
280 JTAG_DEBUG("DSCR <= %08x (OLD %08x)", dscr, arm11->last_dscr);
282 arm11->last_dscr = dscr;
284 return ERROR_OK;
289 /** Get the debug reason from Debug Status and Control Register (DSCR)
291 * \param dscr DSCR value to analyze
292 * \return Debug reason
295 enum target_debug_reason arm11_get_DSCR_debug_reason(uint32_t dscr)
297 switch (dscr & ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK)
299 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_HALT:
300 LOG_INFO("Debug entry: JTAG HALT");
301 return DBG_REASON_DBGRQ;
303 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BREAKPOINT:
304 LOG_INFO("Debug entry: breakpoint");
305 return DBG_REASON_BREAKPOINT;
307 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_WATCHPOINT:
308 LOG_INFO("Debug entry: watchpoint");
309 return DBG_REASON_WATCHPOINT;
311 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_BKPT_INSTRUCTION:
312 LOG_INFO("Debug entry: BKPT instruction");
313 return DBG_REASON_BREAKPOINT;
315 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_EDBGRQ:
316 LOG_INFO("Debug entry: EDBGRQ signal");
317 return DBG_REASON_DBGRQ;
319 case ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_VECTOR_CATCH:
320 LOG_INFO("Debug entry: VCR vector catch");
321 return DBG_REASON_BREAKPOINT;
323 default:
324 LOG_INFO("Debug entry: unknown");
325 return DBG_REASON_DBGRQ;
331 /** Prepare the stage for ITR/DTR operations
332 * from the arm11_run_instr... group of functions.
334 * Put arm11_run_instr_data_prepare() and arm11_run_instr_data_finish()
335 * around a block of arm11_run_instr_... calls.
337 * Select scan chain 5 to allow quick access to DTR. When scan
338 * chain 4 is needed to put in a register the ITRSel instruction
339 * shortcut is used instead of actually changing the Scan_N
340 * register.
342 * \param arm11 Target state variable.
345 int arm11_run_instr_data_prepare(struct arm11_common * arm11)
347 return arm11_add_debug_SCAN_N(arm11, 0x05, ARM11_TAP_DEFAULT);
350 /** Cleanup after ITR/DTR operations
351 * from the arm11_run_instr... group of functions
353 * Put arm11_run_instr_data_prepare() and arm11_run_instr_data_finish()
354 * around a block of arm11_run_instr_... calls.
356 * Any IDLE can lead to an instruction execution when
357 * scan chains 4 or 5 are selected and the IR holds
358 * INTEST or EXTEST. So we must disable that before
359 * any following activities lead to an IDLE.
361 * \param arm11 Target state variable.
364 int arm11_run_instr_data_finish(struct arm11_common * arm11)
366 return arm11_add_debug_SCAN_N(arm11, 0x00, ARM11_TAP_DEFAULT);
371 /** Execute one or multiple instructions via ITR
373 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
375 * \param arm11 Target state variable.
376 * \param opcode Pointer to sequence of ARM opcodes
377 * \param count Number of opcodes to execute
380 int arm11_run_instr_no_data(struct arm11_common * arm11, uint32_t * opcode, size_t count)
382 arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
384 while (count--)
386 arm11_add_debug_INST(arm11, *opcode++, NULL, TAP_IDLE);
388 int i = 0;
389 while (1)
391 uint8_t flag;
393 arm11_add_debug_INST(arm11, 0, &flag, count ? TAP_IDLE : TAP_DRPAUSE);
395 CHECK_RETVAL(jtag_execute_queue());
397 if (flag)
398 break;
400 long long then = 0;
402 if (i == 1000)
404 then = timeval_ms();
406 if (i >= 1000)
408 if ((timeval_ms()-then) > 1000)
410 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
411 return ERROR_FAIL;
415 i++;
419 return ERROR_OK;
422 /** Execute one instruction via ITR
424 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
426 * \param arm11 Target state variable.
427 * \param opcode ARM opcode
430 int arm11_run_instr_no_data1(struct arm11_common * arm11, uint32_t opcode)
432 return arm11_run_instr_no_data(arm11, &opcode, 1);
436 /** Execute one instruction via ITR repeatedly while
437 * passing data to the core via DTR on each execution.
439 * The executed instruction \em must read data from DTR.
441 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
443 * \param arm11 Target state variable.
444 * \param opcode ARM opcode
445 * \param data Pointer to the data words to be passed to the core
446 * \param count Number of data words and instruction repetitions
449 int arm11_run_instr_data_to_core(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
451 arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
453 arm11_add_debug_INST(arm11, opcode, NULL, TAP_DRPAUSE);
455 arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
457 struct scan_field chain5_fields[3];
459 uint32_t Data;
460 uint8_t Ready;
461 uint8_t nRetry;
463 arm11_setup_field(arm11, 32, &Data, NULL, chain5_fields + 0);
464 arm11_setup_field(arm11, 1, NULL, &Ready, chain5_fields + 1);
465 arm11_setup_field(arm11, 1, NULL, &nRetry, chain5_fields + 2);
467 while (count--)
469 int i = 0;
472 Data = *data;
474 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields), chain5_fields, jtag_set_end_state(TAP_IDLE));
476 CHECK_RETVAL(jtag_execute_queue());
478 JTAG_DEBUG("DTR Ready %d nRetry %d", Ready, nRetry);
480 long long then = 0;
482 if (i == 1000)
484 then = timeval_ms();
486 if (i >= 1000)
488 if ((timeval_ms()-then) > 1000)
490 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
491 return ERROR_FAIL;
495 i++;
497 while (!Ready);
499 data++;
502 arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
504 int i = 0;
507 Data = 0;
509 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields), chain5_fields, TAP_DRPAUSE);
511 CHECK_RETVAL(jtag_execute_queue());
513 JTAG_DEBUG("DTR Data %08x Ready %d nRetry %d", Data, Ready, nRetry);
515 long long then = 0;
517 if (i == 1000)
519 then = timeval_ms();
521 if (i >= 1000)
523 if ((timeval_ms()-then) > 1000)
525 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
526 return ERROR_FAIL;
530 i++;
532 while (!Ready);
534 return ERROR_OK;
537 /** JTAG path for arm11_run_instr_data_to_core_noack
539 * The repeated TAP_IDLE's do not cause a repeated execution
540 * if passed without leaving the state.
542 * Since this is more than 7 bits (adjustable via adding more
543 * TAP_IDLE's) it produces an artificial delay in the lower
544 * layer (FT2232) that is long enough to finish execution on
545 * the core but still shorter than any manually inducible delays.
547 * To disable this code, try "memwrite burst false"
549 * FIX!!! should we use multiple TAP_IDLE here or not???
551 * https://lists.berlios.de/pipermail/openocd-development/2009-July/009698.html
552 * https://lists.berlios.de/pipermail/openocd-development/2009-August/009865.html
554 static const tap_state_t arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay[] =
556 TAP_DREXIT2, TAP_DRUPDATE, TAP_IDLE, TAP_IDLE, TAP_IDLE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DRSHIFT
561 /** Execute one instruction via ITR repeatedly while
562 * passing data to the core via DTR on each execution.
564 * No Ready check during transmission.
566 * The executed instruction \em must read data from DTR.
568 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
570 * \param arm11 Target state variable.
571 * \param opcode ARM opcode
572 * \param data Pointer to the data words to be passed to the core
573 * \param count Number of data words and instruction repetitions
576 int arm11_run_instr_data_to_core_noack(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
578 arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
580 arm11_add_debug_INST(arm11, opcode, NULL, TAP_DRPAUSE);
582 arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
584 struct scan_field chain5_fields[3];
586 arm11_setup_field(arm11, 32, NULL/*&Data*/, NULL, chain5_fields + 0);
587 arm11_setup_field(arm11, 1, NULL, NULL /*&Ready*/, chain5_fields + 1);
588 arm11_setup_field(arm11, 1, NULL, NULL, chain5_fields + 2);
590 uint8_t *Readies;
591 size_t readiesNum = (count + 1);
592 size_t bytes = sizeof(*Readies)*readiesNum;
593 Readies = (uint8_t *) malloc(bytes);
594 if (Readies == NULL)
596 LOG_ERROR("Out of memory allocating " ZU " bytes", bytes);
597 return ERROR_FAIL;
600 uint8_t * ReadyPos = Readies;
602 while (count--)
604 chain5_fields[0].out_value = (void *)(data++);
605 chain5_fields[1].in_value = ReadyPos++;
607 if (count)
609 jtag_add_dr_scan(ARRAY_SIZE(chain5_fields), chain5_fields, jtag_set_end_state(TAP_DRPAUSE));
610 jtag_add_pathmove(ARRAY_SIZE(arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay),
611 arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay);
613 else
615 jtag_add_dr_scan(ARRAY_SIZE(chain5_fields), chain5_fields, jtag_set_end_state(TAP_IDLE));
619 arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
621 chain5_fields[0].out_value = 0;
622 chain5_fields[1].in_value = ReadyPos++;
624 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields), chain5_fields, TAP_DRPAUSE);
626 int retval = jtag_execute_queue();
627 if (retval == ERROR_OK)
629 size_t error_count = 0;
631 for (size_t i = 0; i < readiesNum; i++)
633 if (Readies[i] != 1)
635 error_count++;
639 if (error_count > 0 )
640 LOG_ERROR(ZU " words out of " ZU " not transferred", error_count, readiesNum);
644 free(Readies);
646 return retval;
650 /** Execute an instruction via ITR while handing data into the core via DTR.
652 * The executed instruction \em must read data from DTR.
654 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
656 * \param arm11 Target state variable.
657 * \param opcode ARM opcode
658 * \param data Data word to be passed to the core via DTR
661 int arm11_run_instr_data_to_core1(struct arm11_common * arm11, uint32_t opcode, uint32_t data)
663 return arm11_run_instr_data_to_core(arm11, opcode, &data, 1);
667 /** Execute one instruction via ITR repeatedly while
668 * reading data from the core via DTR on each execution.
670 * The executed instruction \em must write data to DTR.
672 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
674 * \param arm11 Target state variable.
675 * \param opcode ARM opcode
676 * \param data Pointer to an array that receives the data words from the core
677 * \param count Number of data words and instruction repetitions
680 int arm11_run_instr_data_from_core(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
682 arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
684 arm11_add_debug_INST(arm11, opcode, NULL, TAP_IDLE);
686 arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
688 struct scan_field chain5_fields[3];
690 uint32_t Data;
691 uint8_t Ready;
692 uint8_t nRetry;
694 arm11_setup_field(arm11, 32, NULL, &Data, chain5_fields + 0);
695 arm11_setup_field(arm11, 1, NULL, &Ready, chain5_fields + 1);
696 arm11_setup_field(arm11, 1, NULL, &nRetry, chain5_fields + 2);
698 while (count--)
700 int i = 0;
703 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields), chain5_fields, count ? TAP_IDLE : TAP_DRPAUSE);
705 CHECK_RETVAL(jtag_execute_queue());
707 JTAG_DEBUG("DTR Data %08x Ready %d nRetry %d", Data, Ready, nRetry);
709 long long then = 0;
711 if (i == 1000)
713 then = timeval_ms();
715 if (i >= 1000)
717 if ((timeval_ms()-then) > 1000)
719 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
720 return ERROR_FAIL;
724 i++;
726 while (!Ready);
728 *data++ = Data;
731 return ERROR_OK;
734 /** Execute one instruction via ITR
735 * then load r0 into DTR and read DTR from core.
737 * The first executed instruction (\p opcode) should write data to r0.
739 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
741 * \param arm11 Target state variable.
742 * \param opcode ARM opcode to write r0 with the value of interest
743 * \param data Pointer to a data word that receives the value from r0 after \p opcode was executed.
746 int arm11_run_instr_data_from_core_via_r0(struct arm11_common * arm11, uint32_t opcode, uint32_t * data)
748 int retval;
749 retval = arm11_run_instr_no_data1(arm11, opcode);
750 if (retval != ERROR_OK)
751 return retval;
753 /* MCR p14,0,R0,c0,c5,0 (move r0 -> wDTR -> local var) */
754 arm11_run_instr_data_from_core(arm11, 0xEE000E15, data, 1);
756 return ERROR_OK;
759 /** Load data into core via DTR then move it to r0 then
760 * execute one instruction via ITR
762 * The final executed instruction (\p opcode) should read data from r0.
764 * \pre arm11_run_instr_data_prepare() / arm11_run_instr_data_finish() block
766 * \param arm11 Target state variable.
767 * \param opcode ARM opcode to read r0 act upon it
768 * \param data Data word that will be written to r0 before \p opcode is executed
771 int arm11_run_instr_data_to_core_via_r0(struct arm11_common * arm11, uint32_t opcode, uint32_t data)
773 int retval;
774 /* MRC p14,0,r0,c0,c5,0 */
775 retval = arm11_run_instr_data_to_core1(arm11, 0xEE100E15, data);
776 if (retval != ERROR_OK)
777 return retval;
779 retval = arm11_run_instr_no_data1(arm11, opcode);
780 if (retval != ERROR_OK)
781 return retval;
783 return ERROR_OK;
786 /** Apply reads and writes to scan chain 7
788 * \see struct arm11_sc7_action
790 * \param arm11 Target state variable.
791 * \param actions A list of read and/or write instructions
792 * \param count Number of instructions in the list.
795 int arm11_sc7_run(struct arm11_common * arm11, struct arm11_sc7_action * actions, size_t count)
797 int retval;
799 retval = arm11_add_debug_SCAN_N(arm11, 0x07, ARM11_TAP_DEFAULT);
800 if (retval != ERROR_OK)
801 return retval;
803 arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
805 struct scan_field chain7_fields[3];
807 uint8_t nRW;
808 uint32_t DataOut;
809 uint8_t AddressOut;
810 uint8_t Ready;
811 uint32_t DataIn;
812 uint8_t AddressIn;
814 arm11_setup_field(arm11, 1, &nRW, &Ready, chain7_fields + 0);
815 arm11_setup_field(arm11, 32, &DataOut, &DataIn, chain7_fields + 1);
816 arm11_setup_field(arm11, 7, &AddressOut, &AddressIn, chain7_fields + 2);
818 for (size_t i = 0; i < count + 1; i++)
820 if (i < count)
822 nRW = actions[i].write ? 1 : 0;
823 DataOut = actions[i].value;
824 AddressOut = actions[i].address;
826 else
828 nRW = 0;
829 DataOut = 0;
830 AddressOut = 0;
835 JTAG_DEBUG("SC7 <= Address %02x Data %08x nRW %d", AddressOut, DataOut, nRW);
837 arm11_add_dr_scan_vc(ARRAY_SIZE(chain7_fields), chain7_fields, TAP_DRPAUSE);
839 CHECK_RETVAL(jtag_execute_queue());
841 JTAG_DEBUG("SC7 => Address %02x Data %08x Ready %d", AddressIn, DataIn, Ready);
843 while (!Ready); /* 'nRW' is 'Ready' on read out */
845 if (i > 0)
847 if (actions[i - 1].address != AddressIn)
849 LOG_WARNING("Scan chain 7 shifted out unexpected address");
852 if (!actions[i - 1].write)
854 actions[i - 1].value = DataIn;
856 else
858 if (actions[i - 1].value != DataIn)
860 LOG_WARNING("Scan chain 7 shifted out unexpected data");
866 for (size_t i = 0; i < count; i++)
868 JTAG_DEBUG("SC7 %02d: %02x %s %08x", i, actions[i].address, actions[i].write ? "<=" : "=>", actions[i].value);
871 return ERROR_OK;
874 /** Clear VCR and all breakpoints and watchpoints via scan chain 7
876 * \param arm11 Target state variable.
879 void arm11_sc7_clear_vbw(struct arm11_common * arm11)
881 struct arm11_sc7_action clear_bw[arm11->brp + arm11->wrp + 1];
882 struct arm11_sc7_action * pos = clear_bw;
884 for (size_t i = 0; i < ARRAY_SIZE(clear_bw); i++)
886 clear_bw[i].write = true;
887 clear_bw[i].value = 0;
890 for (size_t i = 0; i < arm11->brp; i++)
891 (pos++)->address = ARM11_SC7_BCR0 + i;
894 for (size_t i = 0; i < arm11->wrp; i++)
895 (pos++)->address = ARM11_SC7_WCR0 + i;
898 (pos++)->address = ARM11_SC7_VCR;
900 arm11_sc7_run(arm11, clear_bw, ARRAY_SIZE(clear_bw));
903 /** Write VCR register
905 * \param arm11 Target state variable.
906 * \param value Value to be written
908 void arm11_sc7_set_vcr(struct arm11_common * arm11, uint32_t value)
910 struct arm11_sc7_action set_vcr;
912 set_vcr.write = true;
913 set_vcr.address = ARM11_SC7_VCR;
914 set_vcr.value = value;
917 arm11_sc7_run(arm11, &set_vcr, 1);
922 /** Read word from address
924 * \param arm11 Target state variable.
925 * \param address Memory address to be read
926 * \param result Pointer where to store result
929 int arm11_read_memory_word(struct arm11_common * arm11, uint32_t address, uint32_t * result)
931 int retval;
932 retval = arm11_run_instr_data_prepare(arm11);
933 if (retval != ERROR_OK)
934 return retval;
936 /* MRC p14,0,r0,c0,c5,0 (r0 = address) */
937 CHECK_RETVAL(arm11_run_instr_data_to_core1(arm11, 0xee100e15, address));
939 /* LDC p14,c5,[R0],#4 (DTR = [r0]) */
940 CHECK_RETVAL(arm11_run_instr_data_from_core(arm11, 0xecb05e01, result, 1));
942 return arm11_run_instr_data_finish(arm11);