1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
29 ***************************************************************************/
35 #include "interface.h"
38 * @see tap_set_state() and tap_get_state() accessors.
39 * Actual name is not important since accessors hide it.
41 static tap_state_t state_follower
= TAP_RESET
;
43 void tap_set_state_impl(tap_state_t new_state
)
45 /* this is the state we think the TAPs are in now, was cur_state */
46 state_follower
= new_state
;
49 tap_state_t
tap_get_state()
51 return state_follower
;
55 * @see tap_set_end_state() and tap_get_end_state() accessors.
56 * Actual name is not important because accessors hide it.
58 static tap_state_t end_state_follower
= TAP_RESET
;
60 void tap_set_end_state(tap_state_t new_end_state
)
62 /* this is the state we think the TAPs will be in at completion of the
63 current TAP operation, was end_state
65 end_state_follower
= new_end_state
;
68 tap_state_t
tap_get_end_state()
70 return end_state_follower
;
74 int tap_move_ndx(tap_state_t astate
)
76 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
82 case TAP_RESET
: ndx
= 0; break;
83 case TAP_DRSHIFT
: ndx
= 2; break;
84 case TAP_DRPAUSE
: ndx
= 3; break;
85 case TAP_IDLE
: ndx
= 1; break;
86 case TAP_IRSHIFT
: ndx
= 4; break;
87 case TAP_IRPAUSE
: ndx
= 5; break;
89 LOG_ERROR("fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate
));
97 /* tap_move[i][j]: tap movement command to go from state i to state j
105 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
115 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
116 * Read the bits from LSBit first to MSBit last (right-to-left).
118 #define HEX__(n) 0x##n##LU
121 (((x) & 0x0000000FLU)?(1 << 0):0) \
122 +(((x) & 0x000000F0LU)?(1 << 1):0) \
123 +(((x) & 0x00000F00LU)?(1 << 2):0) \
124 +(((x) & 0x0000F000LU)?(1 << 3):0) \
125 +(((x) & 0x000F0000LU)?(1 << 4):0) \
126 +(((x) & 0x00F00000LU)?(1 << 5):0) \
127 +(((x) & 0x0F000000LU)?(1 << 6):0) \
128 +(((x) & 0xF0000000LU)?(1 << 7):0)
130 #define B8(bits,count) { ((uint8_t)B8__(HEX__(bits))), (count) }
132 static const struct tms_sequences old_tms_seqs
[6][6] = /* [from_state_ndx][to_state_ndx] */
134 /* value clocked to TMS to move from one of six stable states to another.
135 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
136 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
137 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
141 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
142 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
143 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
144 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
145 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
146 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
147 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
152 static const struct tms_sequences short_tms_seqs
[6][6] = /* [from_state_ndx][to_state_ndx] */
154 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
156 OK, I added Peter's version of the state table, and it works OK for
157 me on MC1322x. I've recreated the jlink portion of patch with this
158 new state table. His changes to my state table are pretty minor in
159 terms of total transitions, but Peter feels that his version fixes
160 some long-standing problems.
163 I added the bit count into the table, reduced RESET column to 7 bits from 8.
166 state specific comments:
167 ------------------------
168 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
169 work better on ARM9 with ft2232 driver. (Dick)
171 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
172 needed on ARM9 with ft2232 driver. (Dick)
173 (For a total of *THREE* extra clocks in RESET; NOP.)
175 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
176 needed on ARM9 with ft2232 driver. (Dick)
177 (For a total of *TWO* extra clocks in RESET; NOP.)
179 RESET->* always adds one or more clocks in the target state,
180 which should be NOPS; except shift states which (as
181 noted above) add those clocks in RESET.
183 The X-to-X transitions always add clocks; from *SHIFT, they go
184 via IDLE and thus *DO HAVE SIDE EFFECTS* (capture and update).
188 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
189 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
190 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
191 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
192 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
193 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
194 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1)} /* IRPAUSE */
198 typedef const struct tms_sequences tms_table
[6][6];
200 static tms_table
*tms_seqs
=&short_tms_seqs
;
202 int tap_get_tms_path(tap_state_t from
, tap_state_t to
)
204 return (*tms_seqs
)[tap_move_ndx(from
)][tap_move_ndx(to
)].bits
;
208 int tap_get_tms_path_len(tap_state_t from
, tap_state_t to
)
210 return (*tms_seqs
)[tap_move_ndx(from
)][tap_move_ndx(to
)].bit_count
;
214 bool tap_is_state_stable(tap_state_t astate
)
218 /* A switch () is used because it is symbol dependent
219 (not value dependent like an array), and can also check bounds.
238 tap_state_t
tap_state_transition(tap_state_t cur_state
, bool tms
)
240 tap_state_t new_state
;
242 /* A switch is used because it is symbol dependent and not value dependent
243 like an array. Also it can check for out of range conditions.
251 new_state
= cur_state
;
256 new_state
= TAP_DRSELECT
;
259 new_state
= TAP_IRSELECT
;
263 new_state
= TAP_DREXIT1
;
267 new_state
= TAP_DRUPDATE
;
270 new_state
= TAP_DREXIT2
;
273 new_state
= TAP_RESET
;
277 new_state
= TAP_IREXIT1
;
281 new_state
= TAP_IRUPDATE
;
284 new_state
= TAP_IREXIT2
;
287 LOG_ERROR("fatal: invalid argument cur_state=%d", cur_state
);
300 new_state
= TAP_IDLE
;
303 new_state
= TAP_DRCAPTURE
;
308 new_state
= TAP_DRSHIFT
;
312 new_state
= TAP_DRPAUSE
;
315 new_state
= TAP_IRCAPTURE
;
320 new_state
= TAP_IRSHIFT
;
324 new_state
= TAP_IRPAUSE
;
327 LOG_ERROR("fatal: invalid argument cur_state=%d", cur_state
);
336 const char* tap_state_name(tap_state_t state
)
342 case TAP_RESET
: ret
= "RESET"; break;
343 case TAP_IDLE
: ret
= "RUN/IDLE"; break;
344 case TAP_DRSELECT
: ret
= "DRSELECT"; break;
345 case TAP_DRCAPTURE
: ret
= "DRCAPTURE"; break;
346 case TAP_DRSHIFT
: ret
= "DRSHIFT"; break;
347 case TAP_DREXIT1
: ret
= "DREXIT1"; break;
348 case TAP_DRPAUSE
: ret
= "DRPAUSE"; break;
349 case TAP_DREXIT2
: ret
= "DREXIT2"; break;
350 case TAP_DRUPDATE
: ret
= "DRUPDATE"; break;
351 case TAP_IRSELECT
: ret
= "IRSELECT"; break;
352 case TAP_IRCAPTURE
: ret
= "IRCAPTURE"; break;
353 case TAP_IRSHIFT
: ret
= "IRSHIFT"; break;
354 case TAP_IREXIT1
: ret
= "IREXIT1"; break;
355 case TAP_IRPAUSE
: ret
= "IRPAUSE"; break;
356 case TAP_IREXIT2
: ret
= "IREXIT2"; break;
357 case TAP_IRUPDATE
: ret
= "IRUPDATE"; break;
358 default: ret
= "???";
364 tap_state_t
tap_state_by_name(const char *name
)
368 /* standard SVF name is "IDLE" */
369 if (0 == strcasecmp(name
, "IDLE"))
372 for (x
= 0 ; x
< TAP_NUM_STATES
; x
++) {
373 /* be nice to the human */
374 if (0 == strcasecmp(name
, tap_state_name(x
))) {
382 #ifdef _DEBUG_JTAG_IO_
384 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
385 do { buf[len] = bit ? '1' : '0'; } while (0)
386 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
387 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
388 tap_state_name(a), tap_state_name(b), astr, bstr)
390 tap_state_t
jtag_debug_state_machine(const void *tms_buf
, const void *tdi_buf
,
391 unsigned tap_bits
, tap_state_t next_state
)
393 const uint8_t *tms_buffer
;
394 const uint8_t *tdi_buffer
;
399 unsigned tap_out_bits
;
403 tap_state_t last_state
;
405 // set startstate (and possibly last, if tap_bits == 0)
406 last_state
= next_state
;
407 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state
));
409 tms_buffer
= (const uint8_t *)tms_buf
;
410 tdi_buffer
= (const uint8_t *)tdi_buf
;
412 tap_bytes
= TAP_SCAN_BYTES(tap_bits
);
413 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits
, tap_bytes
);
416 for (cur_byte
= 0; cur_byte
< tap_bytes
; cur_byte
++)
418 for (cur_bit
= 0; cur_bit
< 8; cur_bit
++)
420 // make sure we do not run off the end of the buffers
421 unsigned tap_bit
= cur_byte
* 8 + cur_bit
;
422 if (tap_bit
== tap_bits
)
425 // check and save TMS bit
426 tap_bit
= !!(tms_buffer
[cur_byte
] & (1 << cur_bit
));
427 JTAG_DEBUG_STATE_APPEND(tms_str
, tap_out_bits
, tap_bit
);
429 // use TMS bit to find the next TAP state
430 next_state
= tap_state_transition(last_state
, tap_bit
);
432 // check and store TDI bit
433 tap_bit
= !!(tdi_buffer
[cur_byte
] & (1 << cur_bit
));
434 JTAG_DEBUG_STATE_APPEND(tdi_str
, tap_out_bits
, tap_bit
);
436 // increment TAP bits
439 // Only show TDO bits on state transitions, or
440 // after some number of bits in the same state.
441 if ((next_state
== last_state
) && (tap_out_bits
< 32))
444 // terminate strings and display state transition
445 tms_str
[tap_out_bits
] = tdi_str
[tap_out_bits
] = 0;
446 JTAG_DEBUG_STATE_PRINT(last_state
, next_state
, tms_str
, tdi_str
);
449 last_state
= next_state
;
456 // terminate strings and display state transition
457 tms_str
[tap_out_bits
] = tdi_str
[tap_out_bits
] = 0;
458 JTAG_DEBUG_STATE_PRINT(last_state
, next_state
, tms_str
, tdi_str
);
461 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state
));
465 #endif // _DEBUG_JTAG_IO_
467 void tap_use_new_tms_table(bool use_new
)
469 tms_seqs
= use_new
? &short_tms_seqs
: &old_tms_seqs
;
471 bool tap_uses_new_tms_table(void)
473 return tms_seqs
== &short_tms_seqs
;
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)