1 /***************************************************************************
2 * Copyright (C) 2008 by Spencer Oliver *
3 * spen@spen-soft.co.uk *
5 * Copyright (C) 2008 by David T.L. Wong *
7 * Copyright (C) 2009 by David N. Claffey <dnclaffey@gmail.com> *
9 * Copyright (C) 2011 by Drasko DRASKOVIC *
10 * drasko.draskovic@gmail.com *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
24 ***************************************************************************/
27 * This version has optimized assembly routines for 32 bit operations:
30 * - write array of words
32 * One thing to be aware of is that the MIPS32 cpu will execute the
33 * instruction after a branch instruction (one delay slot).
40 * The LW $1, ($2 +100) instruction is also executed. If this is
41 * not wanted a NOP can be inserted:
48 * or the code can be changed to:
54 * The original code contained NOPs. I have removed these and moved
57 * These changes result in a 35% speed increase when programming an
60 * More improvement could be gained if the registers do no need
61 * to be preserved but in that case the routines should be aware
62 * OpenOCD is used as a flash programmer or as a debug tool.
71 #include <helper/time_support.h>
74 #include "mips32_pracc.h"
76 static int wait_for_pracc_rw(struct mips_ejtag
*ejtag_info
, uint32_t *ctrl
)
79 int64_t then
= timeval_ms();
81 /* wait for the PrAcc to become "1" */
82 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_CONTROL
);
85 ejtag_ctrl
= ejtag_info
->ejtag_ctrl
;
86 int retval
= mips_ejtag_drscan_32(ejtag_info
, &ejtag_ctrl
);
87 if (retval
!= ERROR_OK
)
90 if (ejtag_ctrl
& EJTAG_CTRL_PRACC
)
93 int64_t timeout
= timeval_ms() - then
;
95 LOG_DEBUG("DEBUGMODULE: No memory access in progress!");
96 return ERROR_JTAG_DEVICE_ERROR
;
104 /* Shift in control and address for a new processor access, save them in ejtag_info */
105 static int mips32_pracc_read_ctrl_addr(struct mips_ejtag
*ejtag_info
)
107 int retval
= wait_for_pracc_rw(ejtag_info
, &ejtag_info
->pa_ctrl
);
108 if (retval
!= ERROR_OK
)
111 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_ADDRESS
);
112 ejtag_info
->pa_addr
= 0;
113 retval
= mips_ejtag_drscan_32(ejtag_info
, &ejtag_info
->pa_addr
);
118 /* Finish processor access */
119 static void mips32_pracc_finish(struct mips_ejtag
*ejtag_info
)
121 uint32_t ctrl
= ejtag_info
->ejtag_ctrl
& ~EJTAG_CTRL_PRACC
;
122 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_CONTROL
);
123 mips_ejtag_drscan_32_out(ejtag_info
, ctrl
);
126 int mips32_pracc_clean_text_jump(struct mips_ejtag
*ejtag_info
)
128 uint32_t jt_code
= MIPS32_J((0x0FFFFFFF & MIPS32_PRACC_TEXT
) >> 2);
130 /* do 3 0/nops to clean pipeline before a jump to pracc text, NOP in delay slot */
131 for (int i
= 0; i
!= 5; i
++) {
133 int retval
= wait_for_pracc_rw(ejtag_info
, &ejtag_info
->pa_ctrl
);
134 if (retval
!= ERROR_OK
)
137 /* Data or instruction out */
138 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_DATA
);
139 uint32_t data
= (i
== 3) ? jt_code
: MIPS32_NOP
;
140 mips_ejtag_drscan_32_out(ejtag_info
, data
);
143 mips32_pracc_finish(ejtag_info
);
146 if (ejtag_info
->mode
!= 0) /* async mode support only for MIPS ... */
149 for (int i
= 0; i
!= 2; i
++) {
150 int retval
= mips32_pracc_read_ctrl_addr(ejtag_info
);
151 if (retval
!= ERROR_OK
)
154 if (ejtag_info
->pa_addr
!= MIPS32_PRACC_TEXT
) { /* LEXRA/BMIPS ?, shift out another NOP, max 2 */
155 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_DATA
);
156 mips_ejtag_drscan_32_out(ejtag_info
, MIPS32_NOP
);
157 mips32_pracc_finish(ejtag_info
);
165 int mips32_pracc_exec(struct mips_ejtag
*ejtag_info
, struct pracc_queue_info
*ctx
, uint32_t *param_out
)
168 int store_pending
= 0; /* increases with every store instruction at dmseg, decreases with every store pa */
169 uint32_t max_store_addr
= 0; /* for store pa address testing */
170 bool restart
= 0; /* restarting control */
171 int restart_count
= 0;
173 bool final_check
= 0; /* set to 1 if in final checks after function code shifted out */
174 bool pass
= 0; /* to check the pass through pracc text after function code sent */
179 if (restart_count
< 3) { /* max 3 restarts allowed */
180 retval
= mips32_pracc_clean_text_jump(ejtag_info
);
181 if (retval
!= ERROR_OK
)
184 return ERROR_JTAG_DEVICE_ERROR
;
188 LOG_DEBUG("restarting code");
191 retval
= mips32_pracc_read_ctrl_addr(ejtag_info
); /* update current pa info: control and address */
192 if (retval
!= ERROR_OK
)
195 /* Check for read or write access */
196 if (ejtag_info
->pa_ctrl
& EJTAG_CTRL_PRNW
) { /* write/store access */
197 /* Check for pending store from a previous store instruction at dmseg */
198 if (store_pending
== 0) {
199 LOG_DEBUG("unexpected write at address %" PRIx32
, ejtag_info
->pa_addr
);
200 if (code_count
< 2) { /* allow for restart */
204 return ERROR_JTAG_DEVICE_ERROR
;
207 if (ejtag_info
->pa_addr
< MIPS32_PRACC_PARAM_OUT
|| ejtag_info
->pa_addr
> max_store_addr
) {
209 LOG_DEBUG("writing at unexpected address %" PRIx32
, ejtag_info
->pa_addr
);
210 return ERROR_JTAG_DEVICE_ERROR
;
215 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_DATA
);
216 retval
= mips_ejtag_drscan_32(ejtag_info
, &data
);
217 if (retval
!= ERROR_OK
)
220 /* store data at param out, address based offset */
221 param_out
[(ejtag_info
->pa_addr
- MIPS32_PRACC_PARAM_OUT
) / 4] = data
;
224 } else { /* read/fetch access */
225 if (!final_check
) { /* executing function code */
227 if (ejtag_info
->pa_addr
!= (MIPS32_PRACC_TEXT
+ code_count
* 4)) {
228 LOG_DEBUG("reading at unexpected address %" PRIx32
", expected %x",
229 ejtag_info
->pa_addr
, MIPS32_PRACC_TEXT
+ code_count
* 4);
231 /* restart code execution only in some cases */
232 if (code_count
== 1 && ejtag_info
->pa_addr
== MIPS32_PRACC_TEXT
&& restart_count
== 0) {
233 LOG_DEBUG("restarting, without clean jump");
237 } else if (code_count
< 2) {
242 return ERROR_JTAG_DEVICE_ERROR
;
244 /* check for store instruction at dmseg */
245 uint32_t store_addr
= ctx
->pracc_list
[ctx
->max_code
+ code_count
];
246 if (store_addr
!= 0) {
247 if (store_addr
> max_store_addr
)
248 max_store_addr
= store_addr
;
252 instr
= ctx
->pracc_list
[code_count
++];
253 if (code_count
== ctx
->code_count
) /* last instruction, start final check */
256 } else { /* final check after function code shifted out */
258 if (ejtag_info
->pa_addr
== MIPS32_PRACC_TEXT
) {
259 if (!pass
) { /* first pass through pracc text */
260 if (store_pending
== 0) /* done, normal exit */
262 pass
= 1; /* pracc text passed */
263 code_count
= 0; /* restart code count */
265 LOG_DEBUG("unexpected second pass through pracc text");
266 return ERROR_JTAG_DEVICE_ERROR
;
269 if (ejtag_info
->pa_addr
!= (MIPS32_PRACC_TEXT
+ code_count
* 4)) {
270 LOG_DEBUG("unexpected read address in final check: %" PRIx32
", expected: %x",
271 ejtag_info
->pa_addr
, MIPS32_PRACC_TEXT
+ code_count
* 4);
272 return ERROR_JTAG_DEVICE_ERROR
;
276 if ((code_count
- ctx
->code_count
) > 1) { /* allow max 2 instruction delay slot */
277 LOG_DEBUG("failed to jump back to pracc text");
278 return ERROR_JTAG_DEVICE_ERROR
;
281 if (code_count
> 10) { /* enough, abandone */
282 LOG_DEBUG("execution abandoned, store pending: %d", store_pending
);
283 return ERROR_JTAG_DEVICE_ERROR
;
285 instr
= MIPS32_NOP
; /* shift out NOPs instructions */
289 /* Send instruction out */
290 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_DATA
);
291 mips_ejtag_drscan_32_out(ejtag_info
, instr
);
293 /* finish processor access, let the processor eat! */
294 mips32_pracc_finish(ejtag_info
);
296 if (instr
== MIPS32_DRET
) /* after leaving debug mode nothing to do */
297 return jtag_execute_queue();
299 if (store_pending
== 0 && pass
) { /* store access done, but after passing pracc text */
300 LOG_DEBUG("warning: store access pass pracc text");
306 inline void pracc_queue_init(struct pracc_queue_info
*ctx
)
308 ctx
->retval
= ERROR_OK
;
310 ctx
->store_count
= 0;
312 ctx
->pracc_list
= malloc(2 * ctx
->max_code
* sizeof(uint32_t));
313 if (ctx
->pracc_list
== NULL
) {
314 LOG_ERROR("Out of memory");
315 ctx
->retval
= ERROR_FAIL
;
319 inline void pracc_add(struct pracc_queue_info
*ctx
, uint32_t addr
, uint32_t instr
)
321 ctx
->pracc_list
[ctx
->max_code
+ ctx
->code_count
] = addr
;
322 ctx
->pracc_list
[ctx
->code_count
++] = instr
;
327 inline void pracc_queue_free(struct pracc_queue_info
*ctx
)
329 if (ctx
->code_count
> ctx
->max_code
) /* Only for internal check, will be erased */
330 LOG_ERROR("Internal error, code count: %d > max code: %d", ctx
->code_count
, ctx
->max_code
);
331 if (ctx
->pracc_list
!= NULL
)
332 free(ctx
->pracc_list
);
335 int mips32_pracc_queue_exec(struct mips_ejtag
*ejtag_info
, struct pracc_queue_info
*ctx
, uint32_t *buf
)
337 if (ejtag_info
->mode
== 0)
338 return mips32_pracc_exec(ejtag_info
, ctx
, buf
);
348 } *scan_in
= malloc(sizeof(union scan_in
) * (ctx
->code_count
+ ctx
->store_count
));
349 if (scan_in
== NULL
) {
350 LOG_ERROR("Out of memory");
354 unsigned num_clocks
=
355 ((uint64_t)(ejtag_info
->scan_delay
) * jtag_get_speed_khz() + 500000) / 1000000;
357 uint32_t ejtag_ctrl
= ejtag_info
->ejtag_ctrl
& ~EJTAG_CTRL_PRACC
;
358 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_ALL
);
361 for (int i
= 0; i
!= 2 * ctx
->code_count
; i
++) {
363 if (i
& 1u) { /* Check store address from previous instruction, if not the first */
364 if (i
< 2 || 0 == ctx
->pracc_list
[ctx
->max_code
+ (i
/ 2) - 1])
367 data
= ctx
->pracc_list
[i
/ 2];
369 jtag_add_clocks(num_clocks
);
370 mips_ejtag_add_scan_96(ejtag_info
, ejtag_ctrl
, data
, scan_in
[scan_count
++].scan_96
);
373 int retval
= jtag_execute_queue(); /* execute queued scans */
374 if (retval
!= ERROR_OK
)
377 uint32_t fetch_addr
= MIPS32_PRACC_TEXT
; /* start address */
379 for (int i
= 0; i
!= 2 * ctx
->code_count
; i
++) { /* verify every pracc access */
380 uint32_t store_addr
= 0;
381 if (i
& 1u) { /* Read store addres from previous instruction, if not the first */
382 store_addr
= ctx
->pracc_list
[ctx
->max_code
+ (i
/ 2) - 1];
383 if (i
< 2 || 0 == store_addr
)
387 ejtag_ctrl
= buf_get_u32(scan_in
[scan_count
].scan_32
.ctrl
, 0, 32);
388 if (!(ejtag_ctrl
& EJTAG_CTRL_PRACC
)) {
389 LOG_ERROR("Error: access not pending count: %d", scan_count
);
394 uint32_t addr
= buf_get_u32(scan_in
[scan_count
].scan_32
.addr
, 0, 32);
396 if (store_addr
!= 0) {
397 if (!(ejtag_ctrl
& EJTAG_CTRL_PRNW
)) {
398 LOG_ERROR("Not a store/write access, count: %d", scan_count
);
402 if (addr
!= store_addr
) {
403 LOG_ERROR("Store address mismatch, read: %" PRIx32
" expected: %" PRIx32
" count: %d",
404 addr
, store_addr
, scan_count
);
408 int buf_index
= (addr
- MIPS32_PRACC_PARAM_OUT
) / 4;
409 buf
[buf_index
] = buf_get_u32(scan_in
[scan_count
].scan_32
.data
, 0, 32);
412 if (ejtag_ctrl
& EJTAG_CTRL_PRNW
) {
413 LOG_ERROR("Not a fetch/read access, count: %d", scan_count
);
417 if (addr
!= fetch_addr
) {
418 LOG_ERROR("Fetch addr mismatch, read: %" PRIx32
" expected: %" PRIx32
" count: %d",
419 addr
, fetch_addr
, scan_count
);
432 int mips32_pracc_read_u32(struct mips_ejtag
*ejtag_info
, uint32_t addr
, uint32_t *buf
)
434 struct pracc_queue_info ctx
= {.max_code
= 8};
435 pracc_queue_init(&ctx
);
436 if (ctx
.retval
!= ERROR_OK
)
439 pracc_add(&ctx
, 0, MIPS32_LUI(15, PRACC_UPPER_BASE_ADDR
)); /* $15 = MIPS32_PRACC_BASE_ADDR */
440 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16((addr
+ 0x8000)))); /* load $8 with modified upper address */
441 pracc_add(&ctx
, 0, MIPS32_LW(8, LOWER16(addr
), 8)); /* lw $8, LOWER16(addr)($8) */
442 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
,
443 MIPS32_SW(8, PRACC_OUT_OFFSET
, 15)); /* sw $8,PRACC_OUT_OFFSET($15) */
444 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(ejtag_info
->reg8
))); /* restore upper 16 of $8 */
445 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(ejtag_info
->reg8
))); /* restore lower 16 of $8 */
446 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
447 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* move COP0 DeSave to $15 */
449 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, buf
);
451 pracc_queue_free(&ctx
);
455 int mips32_pracc_read_mem(struct mips_ejtag
*ejtag_info
, uint32_t addr
, int size
, int count
, void *buf
)
457 if (count
== 1 && size
== 4)
458 return mips32_pracc_read_u32(ejtag_info
, addr
, (uint32_t *)buf
);
460 uint32_t *data
= NULL
;
461 struct pracc_queue_info ctx
= {.max_code
= 256 * 3 + 8 + 1}; /* alloc memory for the worst case */
462 pracc_queue_init(&ctx
);
463 if (ctx
.retval
!= ERROR_OK
)
467 data
= malloc(256 * sizeof(uint32_t));
469 LOG_ERROR("Out of memory");
474 uint32_t *buf32
= buf
;
475 uint16_t *buf16
= buf
;
481 int this_round_count
= (count
> 256) ? 256 : count
;
482 uint32_t last_upper_base_addr
= UPPER16((addr
+ 0x8000));
484 pracc_add(&ctx
, 0, MIPS32_LUI(15, PRACC_UPPER_BASE_ADDR
)); /* $15 = MIPS32_PRACC_BASE_ADDR */
485 pracc_add(&ctx
, 0, MIPS32_LUI(9, last_upper_base_addr
)); /* load the upper memory address in $9 */
487 for (int i
= 0; i
!= this_round_count
; i
++) { /* Main code loop */
488 uint32_t upper_base_addr
= UPPER16((addr
+ 0x8000));
489 if (last_upper_base_addr
!= upper_base_addr
) { /* if needed, change upper address in $9 */
490 pracc_add(&ctx
, 0, MIPS32_LUI(9, upper_base_addr
));
491 last_upper_base_addr
= upper_base_addr
;
495 pracc_add(&ctx
, 0, MIPS32_LW(8, LOWER16(addr
), 9)); /* load from memory to $8 */
497 pracc_add(&ctx
, 0, MIPS32_LHU(8, LOWER16(addr
), 9));
499 pracc_add(&ctx
, 0, MIPS32_LBU(8, LOWER16(addr
), 9));
501 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
+ i
* 4,
502 MIPS32_SW(8, PRACC_OUT_OFFSET
+ i
* 4, 15)); /* store $8 at param out */
505 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(ejtag_info
->reg8
))); /* restore upper 16 bits of reg 8 */
506 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(ejtag_info
->reg8
))); /* restore lower 16 bits of reg 8 */
507 pracc_add(&ctx
, 0, MIPS32_LUI(9, UPPER16(ejtag_info
->reg9
))); /* restore upper 16 bits of reg 9 */
508 pracc_add(&ctx
, 0, MIPS32_ORI(9, 9, LOWER16(ejtag_info
->reg9
))); /* restore lower 16 bits of reg 9 */
510 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
511 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* restore $15 from DeSave */
514 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, buf32
);
515 if (ctx
.retval
!= ERROR_OK
)
517 buf32
+= this_round_count
;
519 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, data
);
520 if (ctx
.retval
!= ERROR_OK
)
523 uint32_t *data_p
= data
;
524 for (int i
= 0; i
!= this_round_count
; i
++) {
526 *buf16
++ = *data_p
++;
531 count
-= this_round_count
;
534 pracc_queue_free(&ctx
);
540 int mips32_cp0_read(struct mips_ejtag
*ejtag_info
, uint32_t *val
, uint32_t cp0_reg
, uint32_t cp0_sel
)
542 struct pracc_queue_info ctx
= {.max_code
= 7};
543 pracc_queue_init(&ctx
);
544 if (ctx
.retval
!= ERROR_OK
)
547 pracc_add(&ctx
, 0, MIPS32_LUI(15, PRACC_UPPER_BASE_ADDR
)); /* $15 = MIPS32_PRACC_BASE_ADDR */
548 pracc_add(&ctx
, 0, MIPS32_MFC0(8, cp0_reg
, cp0_sel
)); /* move cp0 reg / sel to $8 */
549 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
,
550 MIPS32_SW(8, PRACC_OUT_OFFSET
, 15)); /* store $8 to pracc_out */
551 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* restore $15 from DeSave */
552 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(ejtag_info
->reg8
))); /* restore upper 16 bits of $8 */
553 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
554 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(ejtag_info
->reg8
))); /* restore lower 16 bits of $8 */
556 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, val
);
558 pracc_queue_free(&ctx
);
562 int mips32_cp0_write(struct mips_ejtag
*ejtag_info
, uint32_t val
, uint32_t cp0_reg
, uint32_t cp0_sel
)
564 struct pracc_queue_info ctx
= {.max_code
= 6};
565 pracc_queue_init(&ctx
);
566 if (ctx
.retval
!= ERROR_OK
)
569 pracc_add(&ctx
, 0, MIPS32_LUI(15, UPPER16(val
))); /* Load val to $15 */
570 pracc_add(&ctx
, 0, MIPS32_ORI(15, 15, LOWER16(val
)));
572 pracc_add(&ctx
, 0, MIPS32_MTC0(15, cp0_reg
, cp0_sel
)); /* write $15 to cp0 reg / sel */
574 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
575 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* restore $15 from DeSave */
577 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, NULL
);
579 pracc_queue_free(&ctx
);
584 * \b mips32_pracc_sync_cache
586 * Synchronize Caches to Make Instruction Writes Effective
587 * (ref. doc. MIPS32 Architecture For Programmers Volume II: The MIPS32 Instruction Set,
588 * Document Number: MD00086, Revision 2.00, June 9, 2003)
590 * When the instruction stream is written, the SYNCI instruction should be used
591 * in conjunction with other instructions to make the newly-written instructions effective.
594 * A program that loads another program into memory is actually writing the D- side cache.
595 * The instructions it has loaded can't be executed until they reach the I-cache.
597 * After the instructions have been written, the loader should arrange
598 * to write back any containing D-cache line and invalidate any locations
599 * already in the I-cache.
601 * If the cache coherency attribute (CCA) is set to zero, it's a write through cache, there is no need
604 * In the latest MIPS32/64 CPUs, MIPS provides the synci instruction,
605 * which does the whole job for a cache-line-sized chunk of the memory you just loaded:
606 * That is, it arranges a D-cache write-back (if CCA = 3) and an I-cache invalidate.
608 * The line size is obtained with the rdhwr SYNCI_Step in release 2 or from cp0 config 1 register in release 1.
610 static int mips32_pracc_synchronize_cache(struct mips_ejtag
*ejtag_info
,
611 uint32_t start_addr
, uint32_t end_addr
, int cached
, int rel
)
613 struct pracc_queue_info ctx
= {.max_code
= 256 * 2 + 5};
614 pracc_queue_init(&ctx
);
615 if (ctx
.retval
!= ERROR_OK
)
617 /** Find cache line size in bytes */
619 if (rel
) { /* Release 2 (rel = 1) */
620 pracc_add(&ctx
, 0, MIPS32_LUI(15, PRACC_UPPER_BASE_ADDR
)); /* $15 = MIPS32_PRACC_BASE_ADDR */
622 pracc_add(&ctx
, 0, MIPS32_RDHWR(8, MIPS32_SYNCI_STEP
)); /* load synci_step value to $8 */
624 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
,
625 MIPS32_SW(8, PRACC_OUT_OFFSET
, 15)); /* store $8 to pracc_out */
627 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(ejtag_info
->reg8
))); /* restore upper 16 bits of $8 */
628 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(ejtag_info
->reg8
))); /* restore lower 16 bits of $8 */
629 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
630 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* move COP0 DeSave to $15 */
632 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, &clsiz
);
633 if (ctx
.retval
!= ERROR_OK
)
636 } else { /* Release 1 (rel = 0) */
638 ctx
.retval
= mips32_cp0_read(ejtag_info
, &conf
, 16, 1);
639 if (ctx
.retval
!= ERROR_OK
)
642 uint32_t dl
= (conf
& MIPS32_CONFIG1_DL_MASK
) >> MIPS32_CONFIG1_DL_SHIFT
;
644 /* dl encoding : dl=1 => 4 bytes, dl=2 => 8 bytes, etc... max dl=6 => 128 bytes cache line size */
651 goto exit
; /* Nothing to do */
653 /* make sure clsiz is power of 2 */
654 if (clsiz
& (clsiz
- 1)) {
655 LOG_DEBUG("clsiz must be power of 2");
656 ctx
.retval
= ERROR_FAIL
;
660 /* make sure start_addr and end_addr have the same offset inside de cache line */
661 start_addr
|= clsiz
- 1;
662 end_addr
|= clsiz
- 1;
666 uint32_t last_upper_base_addr
= UPPER16((start_addr
+ 0x8000));
668 pracc_add(&ctx
, 0, MIPS32_LUI(15, last_upper_base_addr
)); /* load upper memory base address to $15 */
670 while (start_addr
<= end_addr
) { /* main loop */
671 uint32_t upper_base_addr
= UPPER16((start_addr
+ 0x8000));
672 if (last_upper_base_addr
!= upper_base_addr
) { /* if needed, change upper address in $15 */
673 pracc_add(&ctx
, 0, MIPS32_LUI(15, upper_base_addr
));
674 last_upper_base_addr
= upper_base_addr
;
677 pracc_add(&ctx
, 0, MIPS32_SYNCI(LOWER16(start_addr
), 15)); /* synci instruction, offset($15) */
681 pracc_add(&ctx
, 0, MIPS32_CACHE(MIPS32_CACHE_D_HIT_WRITEBACK
,
682 LOWER16(start_addr
), 15)); /* cache Hit_Writeback_D, offset($15) */
684 pracc_add(&ctx
, 0, MIPS32_CACHE(MIPS32_CACHE_I_HIT_INVALIDATE
,
685 LOWER16(start_addr
), 15)); /* cache Hit_Invalidate_I, offset($15) */
689 if (count
== 256 && start_addr
<= end_addr
) { /* more ?, then execute code list */
690 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
691 pracc_add(&ctx
, 0, MIPS32_NOP
); /* nop in delay slot */
693 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, NULL
);
694 if (ctx
.retval
!= ERROR_OK
)
701 pracc_add(&ctx
, 0, MIPS32_SYNC
);
702 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
703 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* restore $15 from DeSave*/
705 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, NULL
);
707 pracc_queue_free(&ctx
);
711 static int mips32_pracc_write_mem_generic(struct mips_ejtag
*ejtag_info
,
712 uint32_t addr
, int size
, int count
, const void *buf
)
714 struct pracc_queue_info ctx
= {.max_code
= 128 * 3 + 5 + 1}; /* alloc memory for the worst case */
715 pracc_queue_init(&ctx
);
716 if (ctx
.retval
!= ERROR_OK
)
719 const uint32_t *buf32
= buf
;
720 const uint16_t *buf16
= buf
;
721 const uint8_t *buf8
= buf
;
726 int this_round_count
= (count
> 128) ? 128 : count
;
727 uint32_t last_upper_base_addr
= UPPER16((addr
+ 0x8000));
729 pracc_add(&ctx
, 0, MIPS32_LUI(15, last_upper_base_addr
)); /* load $15 with memory base address */
731 for (int i
= 0; i
!= this_round_count
; i
++) {
732 uint32_t upper_base_addr
= UPPER16((addr
+ 0x8000));
733 if (last_upper_base_addr
!= upper_base_addr
) {
734 pracc_add(&ctx
, 0, MIPS32_LUI(15, upper_base_addr
)); /* if needed, change upper address in $15*/
735 last_upper_base_addr
= upper_base_addr
;
738 if (size
== 4) { /* for word writes check if one half word is 0 and load it accordingly */
739 if (LOWER16(*buf32
) == 0)
740 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(*buf32
))); /* load only upper value */
741 else if (UPPER16(*buf32
) == 0)
742 pracc_add(&ctx
, 0, MIPS32_ORI(8, 0, LOWER16(*buf32
))); /* load only lower */
744 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(*buf32
))); /* load upper and lower */
745 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(*buf32
)));
747 pracc_add(&ctx
, 0, MIPS32_SW(8, LOWER16(addr
), 15)); /* store word to memory */
750 } else if (size
== 2) {
751 pracc_add(&ctx
, 0, MIPS32_ORI(8, 0, *buf16
)); /* load lower value */
752 pracc_add(&ctx
, 0, MIPS32_SH(8, LOWER16(addr
), 15)); /* store half word to memory */
756 pracc_add(&ctx
, 0, MIPS32_ORI(8, 0, *buf8
)); /* load lower value */
757 pracc_add(&ctx
, 0, MIPS32_SB(8, LOWER16(addr
), 15)); /* store byte to memory */
763 pracc_add(&ctx
, 0, MIPS32_LUI(8, UPPER16(ejtag_info
->reg8
))); /* restore upper 16 bits of reg 8 */
764 pracc_add(&ctx
, 0, MIPS32_ORI(8, 8, LOWER16(ejtag_info
->reg8
))); /* restore lower 16 bits of reg 8 */
766 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
767 pracc_add(&ctx
, 0, MIPS32_MFC0(15, 31, 0)); /* restore $15 from DeSave */
769 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, NULL
);
770 if (ctx
.retval
!= ERROR_OK
)
772 count
-= this_round_count
;
775 pracc_queue_free(&ctx
);
779 int mips32_pracc_write_mem(struct mips_ejtag
*ejtag_info
, uint32_t addr
, int size
, int count
, const void *buf
)
781 int retval
= mips32_pracc_write_mem_generic(ejtag_info
, addr
, size
, count
, buf
);
782 if (retval
!= ERROR_OK
)
786 * If we are in the cacheable region and cache is activated,
787 * we must clean D$ (if Cache Coherency Attribute is set to 3) + invalidate I$ after we did the write,
788 * so that changes do not continue to live only in D$ (if CCA = 3), but to be
789 * replicated in I$ also (maybe we wrote the istructions)
794 if ((KSEGX(addr
) == KSEG1
) || ((addr
>= 0xff200000) && (addr
<= 0xff3fffff)))
795 return retval
; /*Nothing to do*/
797 mips32_cp0_read(ejtag_info
, &conf
, 16, 0);
799 switch (KSEGX(addr
)) {
801 cached
= (conf
& MIPS32_CONFIG0_KU_MASK
) >> MIPS32_CONFIG0_KU_SHIFT
;
804 cached
= (conf
& MIPS32_CONFIG0_K0_MASK
) >> MIPS32_CONFIG0_K0_SHIFT
;
808 cached
= (conf
& MIPS32_CONFIG0_K23_MASK
) >> MIPS32_CONFIG0_K23_SHIFT
;
816 * Check cachablitiy bits coherency algorithm
817 * is the region cacheable or uncached.
818 * If cacheable we have to synchronize the cache
820 if (cached
== 3 || cached
== 0) { /* Write back cache or write through cache */
821 uint32_t start_addr
= addr
;
822 uint32_t end_addr
= addr
+ count
* size
;
823 uint32_t rel
= (conf
& MIPS32_CONFIG0_AR_MASK
) >> MIPS32_CONFIG0_AR_SHIFT
;
825 LOG_DEBUG("Unknown release in cache code");
828 retval
= mips32_pracc_synchronize_cache(ejtag_info
, start_addr
, end_addr
, cached
, rel
);
834 int mips32_pracc_write_regs(struct mips_ejtag
*ejtag_info
, uint32_t *regs
)
836 static const uint32_t cp0_write_code
[] = {
837 MIPS32_MTC0(1, 12, 0), /* move $1 to status */
838 MIPS32_MTLO(1), /* move $1 to lo */
839 MIPS32_MTHI(1), /* move $1 to hi */
840 MIPS32_MTC0(1, 8, 0), /* move $1 to badvaddr */
841 MIPS32_MTC0(1, 13, 0), /* move $1 to cause*/
842 MIPS32_MTC0(1, 24, 0), /* move $1 to depc (pc) */
845 struct pracc_queue_info ctx
= {.max_code
= 37 * 2 + 7 + 1};
846 pracc_queue_init(&ctx
);
847 if (ctx
.retval
!= ERROR_OK
)
850 /* load registers 2 to 31 with lui and ori instructions, check if some instructions can be saved */
851 for (int i
= 2; i
< 32; i
++) {
852 if (LOWER16((regs
[i
])) == 0) /* if lower half word is 0, lui instruction only */
853 pracc_add(&ctx
, 0, MIPS32_LUI(i
, UPPER16((regs
[i
]))));
854 else if (UPPER16((regs
[i
])) == 0) /* if upper half word is 0, ori with $0 only*/
855 pracc_add(&ctx
, 0, MIPS32_ORI(i
, 0, LOWER16((regs
[i
]))));
856 else { /* default, load with lui and ori instructions */
857 pracc_add(&ctx
, 0, MIPS32_LUI(i
, UPPER16((regs
[i
]))));
858 pracc_add(&ctx
, 0, MIPS32_ORI(i
, i
, LOWER16((regs
[i
]))));
862 for (int i
= 0; i
!= 6; i
++) {
863 pracc_add(&ctx
, 0, MIPS32_LUI(1, UPPER16((regs
[i
+ 32])))); /* load CPO value in $1, with lui and ori */
864 pracc_add(&ctx
, 0, MIPS32_ORI(1, 1, LOWER16((regs
[i
+ 32]))));
865 pracc_add(&ctx
, 0, cp0_write_code
[i
]); /* write value from $1 to CPO register */
867 pracc_add(&ctx
, 0, MIPS32_MTC0(15, 31, 0)); /* load $15 in DeSave */
868 pracc_add(&ctx
, 0, MIPS32_LUI(1, UPPER16((regs
[1])))); /* load upper half word in $1 */
869 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
870 pracc_add(&ctx
, 0, MIPS32_ORI(1, 1, LOWER16((regs
[1])))); /* load lower half word in $1 */
872 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, NULL
);
874 ejtag_info
->reg8
= regs
[8];
875 ejtag_info
->reg9
= regs
[9];
877 pracc_queue_free(&ctx
);
881 int mips32_pracc_read_regs(struct mips_ejtag
*ejtag_info
, uint32_t *regs
)
883 static int cp0_read_code
[] = {
884 MIPS32_MFC0(8, 12, 0), /* move status to $8 */
885 MIPS32_MFLO(8), /* move lo to $8 */
886 MIPS32_MFHI(8), /* move hi to $8 */
887 MIPS32_MFC0(8, 8, 0), /* move badvaddr to $8 */
888 MIPS32_MFC0(8, 13, 0), /* move cause to $8 */
889 MIPS32_MFC0(8, 24, 0), /* move depc (pc) to $8 */
892 struct pracc_queue_info ctx
= {.max_code
= 49};
893 pracc_queue_init(&ctx
);
894 if (ctx
.retval
!= ERROR_OK
)
897 pracc_add(&ctx
, 0, MIPS32_MTC0(1, 31, 0)); /* move $1 to COP0 DeSave */
898 pracc_add(&ctx
, 0, MIPS32_LUI(1, PRACC_UPPER_BASE_ADDR
)); /* $1 = MIP32_PRACC_BASE_ADDR */
900 for (int i
= 2; i
!= 32; i
++) /* store GPR's 2 to 31 */
901 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
+ (i
* 4),
902 MIPS32_SW(i
, PRACC_OUT_OFFSET
+ (i
* 4), 1));
904 for (int i
= 0; i
!= 6; i
++) {
905 pracc_add(&ctx
, 0, cp0_read_code
[i
]); /* load COP0 needed registers to $8 */
906 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
+ (i
+ 32) * 4, /* store $8 at PARAM OUT */
907 MIPS32_SW(8, PRACC_OUT_OFFSET
+ (i
+ 32) * 4, 1));
909 pracc_add(&ctx
, 0, MIPS32_MFC0(8, 31, 0)); /* move DeSave to $8, reg1 value */
910 pracc_add(&ctx
, MIPS32_PRACC_PARAM_OUT
+ 4, /* store reg1 value from $8 to param out */
911 MIPS32_SW(8, PRACC_OUT_OFFSET
+ 4, 1));
913 pracc_add(&ctx
, 0, MIPS32_MFC0(1, 31, 0)); /* move COP0 DeSave to $1, restore reg1 */
914 pracc_add(&ctx
, 0, MIPS32_B(NEG16(ctx
.code_count
+ 1))); /* jump to start */
915 pracc_add(&ctx
, 0, MIPS32_MTC0(15, 31, 0)); /* load $15 in DeSave */
917 ctx
.retval
= mips32_pracc_queue_exec(ejtag_info
, &ctx
, regs
);
919 ejtag_info
->reg8
= regs
[8]; /* reg8 is saved but not restored, next called function should restore it */
920 ejtag_info
->reg9
= regs
[9];
922 pracc_queue_free(&ctx
);
926 /* fastdata upload/download requires an initialized working area
927 * to load the download code; it should not be called otherwise
928 * fetch order from the fastdata area
933 int mips32_pracc_fastdata_xfer(struct mips_ejtag
*ejtag_info
, struct working_area
*source
,
934 int write_t
, uint32_t addr
, int count
, uint32_t *buf
)
936 uint32_t handler_code
[] = {
937 /* caution when editing, table is modified below */
938 /* r15 points to the start of this code */
939 MIPS32_SW(8, MIPS32_FASTDATA_HANDLER_SIZE
- 4, 15),
940 MIPS32_SW(9, MIPS32_FASTDATA_HANDLER_SIZE
- 8, 15),
941 MIPS32_SW(10, MIPS32_FASTDATA_HANDLER_SIZE
- 12, 15),
942 MIPS32_SW(11, MIPS32_FASTDATA_HANDLER_SIZE
- 16, 15),
943 /* start of fastdata area in t0 */
944 MIPS32_LUI(8, UPPER16(MIPS32_PRACC_FASTDATA_AREA
)),
945 MIPS32_ORI(8, 8, LOWER16(MIPS32_PRACC_FASTDATA_AREA
)),
946 MIPS32_LW(9, 0, 8), /* start addr in t1 */
947 MIPS32_LW(10, 0, 8), /* end addr to t2 */
949 /* 8 */ MIPS32_LW(11, 0, 0), /* lw t3,[t8 | r9] */
950 /* 9 */ MIPS32_SW(11, 0, 0), /* sw t3,[r9 | r8] */
951 MIPS32_BNE(10, 9, NEG16(3)), /* bne $t2,t1,loop */
952 MIPS32_ADDI(9, 9, 4), /* addi t1,t1,4 */
954 MIPS32_LW(8, MIPS32_FASTDATA_HANDLER_SIZE
- 4, 15),
955 MIPS32_LW(9, MIPS32_FASTDATA_HANDLER_SIZE
- 8, 15),
956 MIPS32_LW(10, MIPS32_FASTDATA_HANDLER_SIZE
- 12, 15),
957 MIPS32_LW(11, MIPS32_FASTDATA_HANDLER_SIZE
- 16, 15),
959 MIPS32_LUI(15, UPPER16(MIPS32_PRACC_TEXT
)),
960 MIPS32_ORI(15, 15, LOWER16(MIPS32_PRACC_TEXT
)),
961 MIPS32_JR(15), /* jr start */
962 MIPS32_MFC0(15, 31, 0), /* move COP0 DeSave to $15 */
965 uint32_t jmp_code
[] = {
966 /* 0 */ MIPS32_LUI(15, 0), /* addr of working area added below */
967 /* 1 */ MIPS32_ORI(15, 15, 0), /* addr of working area added below */
968 MIPS32_JR(15), /* jump to ram program */
973 uint32_t val
, ejtag_ctrl
;
975 if (source
->size
< MIPS32_FASTDATA_HANDLER_SIZE
)
976 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
979 handler_code
[8] = MIPS32_LW(11, 0, 8); /* load data from probe at fastdata area */
980 handler_code
[9] = MIPS32_SW(11, 0, 9); /* store data to RAM @ r9 */
982 handler_code
[8] = MIPS32_LW(11, 0, 9); /* load data from RAM @ r9 */
983 handler_code
[9] = MIPS32_SW(11, 0, 8); /* store data to probe at fastdata area */
986 /* write program into RAM */
987 if (write_t
!= ejtag_info
->fast_access_save
) {
988 mips32_pracc_write_mem(ejtag_info
, source
->address
, 4, ARRAY_SIZE(handler_code
), handler_code
);
989 /* save previous operation to speed to any consecutive read/writes */
990 ejtag_info
->fast_access_save
= write_t
;
993 LOG_DEBUG("%s using 0x%.8" TARGET_PRIxADDR
" for write handler", __func__
, source
->address
);
995 jmp_code
[0] |= UPPER16(source
->address
);
996 jmp_code
[1] |= LOWER16(source
->address
);
998 for (i
= 0; i
< (int) ARRAY_SIZE(jmp_code
); i
++) {
999 retval
= wait_for_pracc_rw(ejtag_info
, &ejtag_ctrl
);
1000 if (retval
!= ERROR_OK
)
1003 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_DATA
);
1004 mips_ejtag_drscan_32_out(ejtag_info
, jmp_code
[i
]);
1006 /* Clear the access pending bit (let the processor eat!) */
1007 mips32_pracc_finish(ejtag_info
);
1010 /* wait PrAcc pending bit for FASTDATA write, read address */
1011 retval
= mips32_pracc_read_ctrl_addr(ejtag_info
);
1012 if (retval
!= ERROR_OK
)
1015 /* next fetch to dmseg should be in FASTDATA_AREA, check */
1016 if (ejtag_info
->pa_addr
!= MIPS32_PRACC_FASTDATA_AREA
)
1019 /* Send the load start address */
1021 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_FASTDATA
);
1022 mips_ejtag_fastdata_scan(ejtag_info
, 1, &val
);
1024 retval
= wait_for_pracc_rw(ejtag_info
, &ejtag_ctrl
);
1025 if (retval
!= ERROR_OK
)
1028 /* Send the load end address */
1029 val
= addr
+ (count
- 1) * 4;
1030 mips_ejtag_set_instr(ejtag_info
, EJTAG_INST_FASTDATA
);
1031 mips_ejtag_fastdata_scan(ejtag_info
, 1, &val
);
1033 unsigned num_clocks
= 0; /* like in legacy code */
1034 if (ejtag_info
->mode
!= 0)
1035 num_clocks
= ((uint64_t)(ejtag_info
->scan_delay
) * jtag_get_speed_khz() + 500000) / 1000000;
1037 for (i
= 0; i
< count
; i
++) {
1038 jtag_add_clocks(num_clocks
);
1039 retval
= mips_ejtag_fastdata_scan(ejtag_info
, write_t
, buf
++);
1040 if (retval
!= ERROR_OK
)
1044 retval
= jtag_execute_queue();
1045 if (retval
!= ERROR_OK
) {
1046 LOG_ERROR("fastdata load failed");
1050 retval
= mips32_pracc_read_ctrl_addr(ejtag_info
);
1051 if (retval
!= ERROR_OK
)
1054 if (ejtag_info
->pa_addr
!= MIPS32_PRACC_TEXT
)
1055 LOG_ERROR("mini program did not return to start");
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)