1 // SPDX-License-Identifier: GPL-2.0-or-later
3 /***************************************************************************
4 * Copyright (C) 2011 by Martin Schmoelzer *
5 * <martin.schmoelzer@student.tuwien.ac.at> *
6 ***************************************************************************/
16 /** Delay value for SCAN_IN operations with less than maximum TCK frequency */
17 uint8_t delay_scan_in
;
19 /** Delay value for SCAN_OUT operations with less than maximum TCK frequency */
20 uint8_t delay_scan_out
;
22 /** Delay value for SCAN_IO operations with less than maximum TCK frequency */
23 uint8_t delay_scan_io
;
25 /** Delay value for CLOCK_TCK operations with less than maximum frequency */
28 /** Delay value for CLOCK_TMS operations with less than maximum frequency */
32 * Perform JTAG SCAN-IN operation at maximum TCK frequency.
34 * Dummy data is shifted into the JTAG chain via TDI, TDO data is sampled and
35 * stored in the EP2 IN buffer.
37 * Maximum achievable TCK frequency is 182 kHz for ULINK clocked at 24 MHz.
39 * @param out_offset offset in OUT2BUF where payload data starts
42 void jtag_scan_in(uint8_t out_offset
, uint8_t in_offset
)
44 uint8_t scan_size_bytes
, bits_last_byte
;
45 uint8_t tms_count_start
, tms_count_end
;
46 uint8_t tms_sequence_start
, tms_sequence_end
;
47 uint8_t tdo_data
, i
, j
;
51 /* Get parameters from OUT2BUF */
52 scan_size_bytes
= OUT2BUF
[out_offset
];
53 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
54 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
55 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
56 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
57 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
59 if (tms_count_start
> 0)
60 jtag_clock_tms(tms_count_start
, tms_sequence_start
);
62 outb_buffer
= OUTB
& ~(PIN_TDI
| PIN_TCK
| PIN_TMS
);
64 /* Shift all bytes except the last byte */
65 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
68 for (j
= 0; j
< 8; j
++) {
69 OUTB
= outb_buffer
; /* TCK changes here */
70 tdo_data
= tdo_data
>> 1;
71 OUTB
= (outb_buffer
| PIN_TCK
);
77 /* Copy TDO data to IN2BUF */
78 IN2BUF
[i
+ in_offset
] = tdo_data
;
83 /* Shift the last byte */
84 for (j
= 0; j
< bits_last_byte
; j
++) {
85 /* Assert TMS signal if requested and this is the last bit */
86 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
87 outb_buffer
|= PIN_TMS
;
89 tms_sequence_end
= tms_sequence_end
>> 1;
92 OUTB
= outb_buffer
; /* TCK changes here */
93 tdo_data
= tdo_data
>> 1;
94 OUTB
= (outb_buffer
| PIN_TCK
);
99 tdo_data
= tdo_data
>> (8 - bits_last_byte
);
101 /* Copy TDO data to IN2BUF */
102 IN2BUF
[i
+ in_offset
] = tdo_data
;
104 /* Move to correct end state */
105 if (tms_count_end
> 0)
106 jtag_clock_tms(tms_count_end
, tms_sequence_end
);
110 * Perform JTAG SCAN-IN operation at variable TCK frequency.
112 * Dummy data is shifted into the JTAG chain via TDI, TDO data is sampled and
113 * stored in the EP2 IN buffer.
115 * Maximum achievable TCK frequency is 113 kHz for ULINK clocked at 24 MHz.
117 * @param out_offset offset in OUT2BUF where payload data starts
120 void jtag_slow_scan_in(uint8_t out_offset
, uint8_t in_offset
)
122 uint8_t scan_size_bytes
, bits_last_byte
;
123 uint8_t tms_count_start
, tms_count_end
;
124 uint8_t tms_sequence_start
, tms_sequence_end
;
125 uint8_t tdo_data
, i
, j
, k
;
129 /* Get parameters from OUT2BUF */
130 scan_size_bytes
= OUT2BUF
[out_offset
];
131 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
132 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
133 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
134 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
135 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
137 if (tms_count_start
> 0)
138 jtag_slow_clock_tms(tms_count_start
, tms_sequence_start
);
140 outb_buffer
= OUTB
& ~(PIN_TDI
| PIN_TCK
| PIN_TMS
);
142 /* Shift all bytes except the last byte */
143 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
146 for (j
= 0; j
< 8; j
++) {
147 OUTB
= outb_buffer
; /* TCK changes here */
148 for (k
= 0; k
< delay_scan_in
; k
++)
150 tdo_data
= tdo_data
>> 1;
152 OUTB
= (outb_buffer
| PIN_TCK
);
153 for (k
= 0; k
< delay_scan_in
; k
++)
160 /* Copy TDO data to IN2BUF */
161 IN2BUF
[i
+ in_offset
] = tdo_data
;
166 /* Shift the last byte */
167 for (j
= 0; j
< bits_last_byte
; j
++) {
168 /* Assert TMS signal if requested and this is the last bit */
169 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
170 outb_buffer
|= PIN_TMS
;
172 tms_sequence_end
= tms_sequence_end
>> 1;
175 OUTB
= outb_buffer
; /* TCK changes here */
176 for (k
= 0; k
< delay_scan_in
; k
++)
178 tdo_data
= tdo_data
>> 1;
180 OUTB
= (outb_buffer
| PIN_TCK
);
181 for (k
= 0; k
< delay_scan_in
; k
++)
187 tdo_data
= tdo_data
>> (8 - bits_last_byte
);
189 /* Copy TDO data to IN2BUF */
190 IN2BUF
[i
+ in_offset
] = tdo_data
;
192 /* Move to correct end state */
193 if (tms_count_end
> 0)
194 jtag_slow_clock_tms(tms_count_end
, tms_sequence_end
);
198 * Perform JTAG SCAN-OUT operation at maximum TCK frequency.
200 * Data stored in EP2 OUT buffer is shifted into the JTAG chain via TDI, TDO
201 * data is not sampled.
202 * The TAP-FSM state is always left in the PAUSE-DR/PAUSE-IR state.
204 * Maximum achievable TCK frequency is 142 kHz for ULINK clocked at 24 MHz.
206 * @param out_offset offset in OUT2BUF where payload data starts
208 void jtag_scan_out(uint8_t out_offset
)
210 uint8_t scan_size_bytes
, bits_last_byte
;
211 uint8_t tms_count_start
, tms_count_end
;
212 uint8_t tms_sequence_start
, tms_sequence_end
;
213 uint8_t tdi_data
, i
, j
;
217 /* Get parameters from OUT2BUF */
218 scan_size_bytes
= OUT2BUF
[out_offset
];
219 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
220 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
221 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
222 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
223 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
225 if (tms_count_start
> 0)
226 jtag_clock_tms(tms_count_start
, tms_sequence_start
);
228 outb_buffer
= OUTB
& ~(PIN_TCK
| PIN_TMS
);
230 /* Shift all bytes except the last byte */
231 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
232 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
234 for (j
= 0; j
< 8; j
++) {
236 outb_buffer
|= PIN_TDI
;
238 outb_buffer
&= ~PIN_TDI
;
240 OUTB
= outb_buffer
; /* TDI and TCK change here */
241 tdi_data
= tdi_data
>> 1;
242 OUTB
= (outb_buffer
| PIN_TCK
);
246 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
248 /* Shift the last byte */
249 for (j
= 0; j
< bits_last_byte
; j
++) {
251 outb_buffer
|= PIN_TDI
;
253 outb_buffer
&= ~PIN_TDI
;
255 /* Assert TMS signal if requested and this is the last bit */
256 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
257 outb_buffer
|= PIN_TMS
;
259 tms_sequence_end
= tms_sequence_end
>> 1;
262 OUTB
= outb_buffer
; /* TDI and TCK change here */
263 tdi_data
= tdi_data
>> 1;
264 OUTB
= (outb_buffer
| PIN_TCK
);
267 /* Move to correct end state */
268 if (tms_count_end
> 0)
269 jtag_clock_tms(tms_count_end
, tms_sequence_end
);
273 * Perform JTAG SCAN-OUT operation at maximum TCK frequency.
275 * Data stored in EP2 OUT buffer is shifted into the JTAG chain via TDI, TDO
276 * data is not sampled.
277 * The TAP-FSM state is always left in the PAUSE-DR/PAUSE-IR state.
279 * Maximum achievable TCK frequency is 97 kHz for ULINK clocked at 24 MHz.
281 * @param out_offset offset in OUT2BUF where payload data starts
283 void jtag_slow_scan_out(uint8_t out_offset
)
285 uint8_t scan_size_bytes
, bits_last_byte
;
286 uint8_t tms_count_start
, tms_count_end
;
287 uint8_t tms_sequence_start
, tms_sequence_end
;
288 uint8_t tdi_data
, i
, j
, k
;
292 /* Get parameters from OUT2BUF */
293 scan_size_bytes
= OUT2BUF
[out_offset
];
294 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
295 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
296 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
297 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
298 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
300 if (tms_count_start
> 0)
301 jtag_slow_clock_tms(tms_count_start
, tms_sequence_start
);
303 outb_buffer
= OUTB
& ~(PIN_TCK
| PIN_TMS
);
305 /* Shift all bytes except the last byte */
306 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
307 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
309 for (j
= 0; j
< 8; j
++) {
311 outb_buffer
|= PIN_TDI
;
313 outb_buffer
&= ~PIN_TDI
;
315 OUTB
= outb_buffer
; /* TDI and TCK change here */
316 for (k
= 0; k
< delay_scan_out
; k
++)
318 tdi_data
= tdi_data
>> 1;
320 OUTB
= (outb_buffer
| PIN_TCK
);
321 for (k
= 0; k
< delay_scan_out
; k
++)
326 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
328 /* Shift the last byte */
329 for (j
= 0; j
< bits_last_byte
; j
++) {
331 outb_buffer
|= PIN_TDI
;
333 outb_buffer
&= ~PIN_TDI
;
335 /* Assert TMS signal if requested and this is the last bit */
336 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
337 outb_buffer
|= PIN_TMS
;
339 tms_sequence_end
= tms_sequence_end
>> 1;
342 OUTB
= outb_buffer
; /* TDI and TCK change here */
343 for (k
= 0; k
< delay_scan_out
; k
++)
345 tdi_data
= tdi_data
>> 1;
347 OUTB
= (outb_buffer
| PIN_TCK
);
348 for (k
= 0; k
< delay_scan_out
; k
++)
352 /* Move to correct end state */
353 if (tms_count_end
> 0)
354 jtag_slow_clock_tms(tms_count_end
, tms_sequence_end
);
358 * Perform bidirectional JTAG SCAN operation at maximum TCK frequency.
360 * Data stored in EP2 OUT buffer is shifted into the JTAG chain via TDI, TDO
361 * data is sampled and stored in the EP2 IN buffer.
362 * The TAP-FSM state is always left in the PAUSE-DR/PAUSE-IR state.
364 * Maximum achievable TCK frequency is 100 kHz for ULINK clocked at 24 MHz.
366 * @param out_offset offset in OUT2BUF where payload data starts
369 void jtag_scan_io(uint8_t out_offset
, uint8_t in_offset
)
371 uint8_t scan_size_bytes
, bits_last_byte
;
372 uint8_t tms_count_start
, tms_count_end
;
373 uint8_t tms_sequence_start
, tms_sequence_end
;
374 uint8_t tdi_data
, tdo_data
, i
, j
;
378 /* Get parameters from OUT2BUF */
379 scan_size_bytes
= OUT2BUF
[out_offset
];
380 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
381 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
382 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
383 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
384 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
386 if (tms_count_start
> 0)
387 jtag_clock_tms(tms_count_start
, tms_sequence_start
);
389 outb_buffer
= OUTB
& ~(PIN_TCK
| PIN_TMS
);
391 /* Shift all bytes except the last byte */
392 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
393 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
396 for (j
= 0; j
< 8; j
++) {
398 outb_buffer
|= PIN_TDI
;
400 outb_buffer
&= ~PIN_TDI
;
402 OUTB
= outb_buffer
; /* TDI and TCK change here */
403 tdi_data
= tdi_data
>> 1;
404 OUTB
= (outb_buffer
| PIN_TCK
);
405 tdo_data
= tdo_data
>> 1;
411 /* Copy TDO data to IN2BUF */
412 IN2BUF
[i
+ in_offset
] = tdo_data
;
415 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
418 /* Shift the last byte */
419 for (j
= 0; j
< bits_last_byte
; j
++) {
421 outb_buffer
|= PIN_TDI
;
423 outb_buffer
&= ~PIN_TDI
;
425 /* Assert TMS signal if requested and this is the last bit */
426 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
427 outb_buffer
|= PIN_TMS
;
429 tms_sequence_end
= tms_sequence_end
>> 1;
432 OUTB
= outb_buffer
; /* TDI and TCK change here */
433 tdi_data
= tdi_data
>> 1;
434 OUTB
= (outb_buffer
| PIN_TCK
);
435 tdo_data
= tdo_data
>> 1;
440 tdo_data
= tdo_data
>> (8 - bits_last_byte
);
442 /* Copy TDO data to IN2BUF */
443 IN2BUF
[i
+ in_offset
] = tdo_data
;
445 /* Move to correct end state */
446 if (tms_count_end
> 0)
447 jtag_clock_tms(tms_count_end
, tms_sequence_end
);
451 * Perform bidirectional JTAG SCAN operation at maximum TCK frequency.
453 * Data stored in EP2 OUT buffer is shifted into the JTAG chain via TDI, TDO
454 * data is sampled and stored in the EP2 IN buffer.
455 * The TAP-FSM state is always left in the PAUSE-DR/PAUSE-IR state.
457 * Maximum achievable TCK frequency is 78 kHz for ULINK clocked at 24 MHz.
459 * @param out_offset offset in OUT2BUF where payload data starts
462 void jtag_slow_scan_io(uint8_t out_offset
, uint8_t in_offset
)
464 uint8_t scan_size_bytes
, bits_last_byte
;
465 uint8_t tms_count_start
, tms_count_end
;
466 uint8_t tms_sequence_start
, tms_sequence_end
;
467 uint8_t tdi_data
, tdo_data
, i
, j
, k
;
471 /* Get parameters from OUT2BUF */
472 scan_size_bytes
= OUT2BUF
[out_offset
];
473 bits_last_byte
= OUT2BUF
[out_offset
+ 1];
474 tms_count_start
= (OUT2BUF
[out_offset
+ 2] >> 4) & 0x0F;
475 tms_count_end
= OUT2BUF
[out_offset
+ 2] & 0x0F;
476 tms_sequence_start
= OUT2BUF
[out_offset
+ 3];
477 tms_sequence_end
= OUT2BUF
[out_offset
+ 4];
479 if (tms_count_start
> 0)
480 jtag_slow_clock_tms(tms_count_start
, tms_sequence_start
);
482 outb_buffer
= OUTB
& ~(PIN_TCK
| PIN_TMS
);
484 /* Shift all bytes except the last byte */
485 for (i
= 0; i
< scan_size_bytes
- 1; i
++) {
486 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
489 for (j
= 0; j
< 8; j
++) {
491 outb_buffer
|= PIN_TDI
;
493 outb_buffer
&= ~PIN_TDI
;
495 OUTB
= outb_buffer
; /* TDI and TCK change here */
496 for (k
= 0; k
< delay_scan_io
; k
++)
498 tdi_data
= tdi_data
>> 1;
500 OUTB
= (outb_buffer
| PIN_TCK
);
501 for (k
= 0; k
< delay_scan_io
; k
++)
503 tdo_data
= tdo_data
>> 1;
509 /* Copy TDO data to IN2BUF */
510 IN2BUF
[i
+ in_offset
] = tdo_data
;
513 tdi_data
= OUT2BUF
[i
+ out_offset
+ 5];
516 /* Shift the last byte */
517 for (j
= 0; j
< bits_last_byte
; j
++) {
519 outb_buffer
|= PIN_TDI
;
521 outb_buffer
&= ~PIN_TDI
;
523 /* Assert TMS signal if requested and this is the last bit */
524 if ((j
== bits_last_byte
- 1) && (tms_count_end
> 0)) {
525 outb_buffer
|= PIN_TMS
;
527 tms_sequence_end
= tms_sequence_end
>> 1;
530 OUTB
= outb_buffer
; /* TDI and TCK change here */
531 for (k
= 0; k
< delay_scan_io
; k
++)
533 tdi_data
= tdi_data
>> 1;
535 OUTB
= (outb_buffer
| PIN_TCK
);
536 for (k
= 0; k
< delay_scan_io
; k
++)
538 tdo_data
= tdo_data
>> 1;
543 tdo_data
= tdo_data
>> (8 - bits_last_byte
);
545 /* Copy TDO data to IN2BUF */
546 IN2BUF
[i
+ in_offset
] = tdo_data
;
548 /* Move to correct end state */
549 if (tms_count_end
> 0)
550 jtag_slow_clock_tms(tms_count_end
, tms_sequence_end
);
554 * Generate TCK clock cycles.
556 * Maximum achievable TCK frequency is 375 kHz for ULINK clocked at 24 MHz.
558 * @param count number of TCK clock cycles to generate.
560 void jtag_clock_tck(uint16_t count
)
563 uint8_t outb_buffer
= OUTB
& ~(PIN_TCK
);
565 for (i
= 0; i
< count
; i
++) {
567 OUTB
= outb_buffer
| PIN_TCK
;
572 * Generate TCK clock cycles at variable frequency.
574 * Maximum achievable TCK frequency is 166.6 kHz for ULINK clocked at 24 MHz.
576 * @param count number of TCK clock cycles to generate.
578 void jtag_slow_clock_tck(uint16_t count
)
582 uint8_t outb_buffer
= OUTB
& ~(PIN_TCK
);
584 for (i
= 0; i
< count
; i
++) {
586 for (j
= 0; j
< delay_tck
; j
++)
588 OUTB
= outb_buffer
| PIN_TCK
;
589 for (j
= 0; j
< delay_tck
; j
++)
595 * Perform TAP FSM state transitions at maximum TCK frequency.
597 * Maximum achievable TCK frequency is 176 kHz for ULINK clocked at 24 MHz.
599 * @param count the number of state transitions to perform.
600 * @param sequence the TMS pin levels for each state transition, starting with
601 * the least-significant bit.
603 void jtag_clock_tms(uint8_t count
, uint8_t sequence
)
605 uint8_t outb_buffer
= OUTB
& ~(PIN_TCK
);
608 for (i
= 0; i
< count
; i
++) {
609 /* Set TMS pin according to sequence parameter */
611 outb_buffer
|= PIN_TMS
;
613 outb_buffer
&= ~PIN_TMS
;
616 sequence
= sequence
>> 1;
617 OUTB
= outb_buffer
| PIN_TCK
;
622 * Perform TAP-FSM state transitions at less than maximum TCK frequency.
624 * Maximum achievable TCK frequency is 117 kHz for ULINK clocked at 24 MHz.
626 * @param count the number of state transitions to perform.
627 * @param sequence the TMS pin levels for each state transition, starting with
628 * the least-significant bit.
630 void jtag_slow_clock_tms(uint8_t count
, uint8_t sequence
)
632 uint8_t outb_buffer
= OUTB
& ~(PIN_TCK
);
635 for (i
= 0; i
< count
; i
++) {
636 /* Set TMS pin according to sequence parameter */
638 outb_buffer
|= PIN_TMS
;
640 outb_buffer
&= ~PIN_TMS
;
643 for (j
= 0; j
< delay_tms
; j
++)
645 sequence
= sequence
>> 1;
646 OUTB
= outb_buffer
| PIN_TCK
;
647 for (j
= 0; j
< delay_tms
; j
++)
653 * Get current JTAG signal states.
655 * @return a 16-bit integer where the most-significant byte contains the state
656 * of the JTAG input signals and the least-significant byte contains the state
657 * of the JTAG output signals.
659 uint16_t jtag_get_signals(void)
661 uint8_t input_signal_state
, output_signal_state
;
663 input_signal_state
= 0;
664 output_signal_state
= 0;
666 /* Get states of input pins */
668 input_signal_state
|= SIGNAL_TDO
;
670 input_signal_state
|= SIGNAL_BRKOUT
;
672 input_signal_state
|= SIGNAL_TRAP
;
674 /* Using RTCK this way would be extremely slow,
675 * implemented only for the sake of completeness */
676 input_signal_state
|= SIGNAL_RTCK
;
679 /* Get states of output pins */
680 output_signal_state
= PINSB
& MASK_PORTB_DIRECTION_OUT
;
682 return ((uint16_t)input_signal_state
<< 8) | ((uint16_t)output_signal_state
);
686 * Set state of JTAG output signals.
688 * @param low signals which should be de-asserted.
689 * @param high signals which should be asserted.
691 void jtag_set_signals(uint8_t low
, uint8_t high
)
693 OUTB
&= ~(low
& MASK_PORTB_DIRECTION_OUT
);
694 OUTB
|= (high
& MASK_PORTB_DIRECTION_OUT
);
698 * Configure TCK delay parameters.
700 * @param scan_in number of delay cycles in scan_in operations.
701 * @param scan_out number of delay cycles in scan_out operations.
702 * @param scan_io number of delay cycles in scan_io operations.
703 * @param tck number of delay cycles in clock_tck operations.
704 * @param tms number of delay cycles in clock_tms operations.
706 void jtag_configure_tck_delay(uint8_t scan_in
, uint8_t scan_out
,
707 uint8_t scan_io
, uint8_t tck
, uint8_t tms
)
709 delay_scan_in
= scan_in
;
710 delay_scan_out
= scan_out
;
711 delay_scan_io
= scan_io
;