Code Review / openocd.git / blob
? search:


0af99f93cedff51e439256aed8f53cf5fb32c186
[openocd.git] / src / jtag / jtag.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "replacements.h"
28
29 #include "jtag.h"
30
31 #include "command.h"
32 #include "log.h"
33
34 #include "stdlib.h"
35 #include "string.h"
36 #include <unistd.h>
37
38 /* note that this is not marked as static as it must be available from outside jtag.c for those
39 that implement the jtag_xxx() minidriver layer
40 */
41 int jtag_error=ERROR_OK;
42
43
44 char* tap_state_strings[16] =
45 {
46 "tlr",
47 "sds", "cd", "sd", "e1d", "pd", "e2d", "ud",
48 "rti",
49 "sis", "ci", "si", "e1i", "pi", "e2i", "ui"
50 };
51
52 typedef struct cmd_queue_page_s
53 {
54 void *address;
55 size_t used;
56 struct cmd_queue_page_s *next;
57 } cmd_queue_page_t;
58
59 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
60 static cmd_queue_page_t *cmd_queue_pages = NULL;
61
62 /* tap_move[i][j]: tap movement command to go from state i to state j
63 * 0: Test-Logic-Reset
64 * 1: Run-Test/Idle
65 * 2: Shift-DR
66 * 3: Pause-DR
67 * 4: Shift-IR
68 * 5: Pause-IR
69 *
70 * SD->SD and SI->SI have to be caught in interface specific code
71 */
72 u8 tap_move[6][6] =
73 {
74 /* TLR RTI SD PD SI PI */
75 {0x7f, 0x00, 0x17, 0x0a, 0x1b, 0x16}, /* TLR */
76 {0x7f, 0x00, 0x25, 0x05, 0x2b, 0x0b}, /* RTI */
77 {0x7f, 0x31, 0x00, 0x01, 0x0f, 0x2f}, /* SD */
78 {0x7f, 0x30, 0x20, 0x17, 0x1e, 0x2f}, /* PD */
79 {0x7f, 0x31, 0x07, 0x17, 0x00, 0x01}, /* SI */
80 {0x7f, 0x30, 0x1c, 0x17, 0x20, 0x2f} /* PI */
81 };
82
83 int tap_move_map[16] = {
84 0, -1, -1, 2, -1, 3, -1, -1,
85 1, -1, -1, 4, -1, 5, -1, -1
86 };
87
88 tap_transition_t tap_transitions[16] =
89 {
90 {TAP_TLR, TAP_RTI}, /* TLR */
91 {TAP_SIS, TAP_CD}, /* SDS */
92 {TAP_E1D, TAP_SD}, /* CD */
93 {TAP_E1D, TAP_SD}, /* SD */
94 {TAP_UD, TAP_PD}, /* E1D */
95 {TAP_E2D, TAP_PD}, /* PD */
96 {TAP_UD, TAP_SD}, /* E2D */
97 {TAP_SDS, TAP_RTI}, /* UD */
98 {TAP_SDS, TAP_RTI}, /* RTI */
99 {TAP_TLR, TAP_CI}, /* SIS */
100 {TAP_E1I, TAP_SI}, /* CI */
101 {TAP_E1I, TAP_SI}, /* SI */
102 {TAP_UI, TAP_PI}, /* E1I */
103 {TAP_E2I, TAP_PI}, /* PI */
104 {TAP_UI, TAP_SI}, /* E2I */
105 {TAP_SDS, TAP_RTI} /* UI */
106 };
107
108 char* jtag_event_strings[] =
109 {
110 "JTAG controller reset (TLR or TRST)"
111 };
112
113 /* kludge!!!! these are just global variables that the
114 * interface use internally. They really belong
115 * inside the drivers, but we don't want to break
116 * linking the drivers!!!!
117 */
118 enum tap_state end_state = TAP_TLR;
119 enum tap_state cur_state = TAP_TLR;
120 int jtag_trst = 0;
121 int jtag_srst = 0;
122
123 jtag_command_t *jtag_command_queue = NULL;
124 jtag_command_t **last_comand_pointer = &jtag_command_queue;
125 jtag_device_t *jtag_devices = NULL;
126 int jtag_num_devices = 0;
127 int jtag_ir_scan_size = 0;
128 enum reset_types jtag_reset_config = RESET_NONE;
129 enum tap_state cmd_queue_end_state = TAP_TLR;
130 enum tap_state cmd_queue_cur_state = TAP_TLR;
131
132 int jtag_verify_capture_ir = 1;
133
134 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
135 int jtag_nsrst_delay = 0; /* default to no nSRST delay */
136 int jtag_ntrst_delay = 0; /* default to no nTRST delay */
137
138 /* maximum number of JTAG devices expected in the chain
139 */
140 #define JTAG_MAX_CHAIN_SIZE 20
141
142 /* callbacks to inform high-level handlers about JTAG state changes */
143 jtag_event_callback_t *jtag_event_callbacks;
144
145 /* speed in kHz*/
146 static int speed_khz = 0;
147 /* flag if the kHz speed was defined */
148 static int hasKHz = 0;
149
150 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
151 */
152
153 #if BUILD_ECOSBOARD == 1
154 extern jtag_interface_t eCosBoard_interface;
155 #endif
156
157 #if BUILD_PARPORT == 1
158 extern jtag_interface_t parport_interface;
159 #endif
160
161 #if BUILD_DUMMY == 1
162 extern jtag_interface_t dummy_interface;
163 #endif
164
165 #if BUILD_FT2232_FTD2XX == 1
166 extern jtag_interface_t ft2232_interface;
167 #endif
168
169 #if BUILD_FT2232_LIBFTDI == 1
170 extern jtag_interface_t ft2232_interface;
171 #endif
172
173 #if BUILD_AMTJTAGACCEL == 1
174 extern jtag_interface_t amt_jtagaccel_interface;
175 #endif
176
177 #if BUILD_EP93XX == 1
178 extern jtag_interface_t ep93xx_interface;
179 #endif
180
181 #if BUILD_AT91RM9200 == 1
182 extern jtag_interface_t at91rm9200_interface;
183 #endif
184
185 #if BUILD_GW16012 == 1
186 extern jtag_interface_t gw16012_interface;
187 #endif
188
189 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
190 extern jtag_interface_t presto_interface;
191 #endif
192
193 #if BUILD_USBPROG == 1
194 extern jtag_interface_t usbprog_interface;
195 #endif
196
197 #if BUILD_JLINK == 1
198 extern jtag_interface_t jlink_interface;
199 #endif
200
201 jtag_interface_t *jtag_interfaces[] = {
202 #if BUILD_ECOSBOARD == 1
203 &eCosBoard_interface,
204 #endif
205 #if BUILD_PARPORT == 1
206 &parport_interface,
207 #endif
208 #if BUILD_DUMMY == 1
209 &dummy_interface,
210 #endif
211 #if BUILD_FT2232_FTD2XX == 1
212 &ft2232_interface,
213 #endif
214 #if BUILD_FT2232_LIBFTDI == 1
215 &ft2232_interface,
216 #endif
217 #if BUILD_AMTJTAGACCEL == 1
218 &amt_jtagaccel_interface,
219 #endif
220 #if BUILD_EP93XX == 1
221 &ep93xx_interface,
222 #endif
223 #if BUILD_AT91RM9200 == 1
224 &at91rm9200_interface,
225 #endif
226 #if BUILD_GW16012 == 1
227 &gw16012_interface,
228 #endif
229 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
230 &presto_interface,
231 #endif
232 #if BUILD_USBPROG == 1
233 &usbprog_interface,
234 #endif
235 #if BUILD_JLINK == 1
236 &jlink_interface,
237 #endif
238 NULL,
239 };
240
241 jtag_interface_t *jtag = NULL;
242
243 /* configuration */
244 jtag_interface_t *jtag_interface = NULL;
245 int jtag_speed = 0;
246
247
248
249 /* forward declarations */
250 void jtag_add_pathmove(int num_states, enum tap_state *path);
251 void jtag_add_runtest(int num_cycles, enum tap_state endstate);
252 void jtag_add_end_state(enum tap_state endstate);
253 void jtag_add_sleep(u32 us);
254 int jtag_execute_queue(void);
255
256
257 /* jtag commands */
258 int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
259 int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
260 int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
261 int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
262 int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
263 int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
264 int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
265
266 int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
267
268 int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
269 int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
270 int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
271 int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
272 int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
273
274 int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
275
276 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
277 {
278 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
279
280 if (callback == NULL)
281 {
282 return ERROR_INVALID_ARGUMENTS;
283 }
284
285 if (*callbacks_p)
286 {
287 while ((*callbacks_p)->next)
288 callbacks_p = &((*callbacks_p)->next);
289 callbacks_p = &((*callbacks_p)->next);
290 }
291
292 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
293 (*callbacks_p)->callback = callback;
294 (*callbacks_p)->priv = priv;
295 (*callbacks_p)->next = NULL;
296
297 return ERROR_OK;
298 }
299
300 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
301 {
302 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
303
304 if (callback == NULL)
305 {
306 return ERROR_INVALID_ARGUMENTS;
307 }
308
309 while (*callbacks_p)
310 {
311 jtag_event_callback_t **next = &((*callbacks_p)->next);
312 if ((*callbacks_p)->callback == callback)
313 {
314 free(*callbacks_p);
315 *callbacks_p = *next;
316 }
317 callbacks_p = next;
318 }
319
320 return ERROR_OK;
321 }
322
323 int jtag_call_event_callbacks(enum jtag_event event)
324 {
325 jtag_event_callback_t *callback = jtag_event_callbacks;
326
327 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
328
329 while (callback)
330 {
331 callback->callback(event, callback->priv);
332 callback = callback->next;
333 }
334
335 return ERROR_OK;
336 }
337
338 /* returns a pointer to the pointer of the last command in queue
339 * this may be a pointer to the root pointer (jtag_command_queue)
340 * or to the next member of the last but one command
341 */
342 jtag_command_t** jtag_get_last_command_p(void)
343 {
344 /* jtag_command_t *cmd = jtag_command_queue;
345
346 if (cmd)
347 while (cmd->next)
348 cmd = cmd->next;
349 else
350 return &jtag_command_queue;
351
352 return &cmd->next;*/
353
354 return last_comand_pointer;
355 }
356
357 /* returns a pointer to the n-th device in the scan chain */
358 jtag_device_t* jtag_get_device(int num)
359 {
360 jtag_device_t *device = jtag_devices;
361 int i = 0;
362
363 while (device)
364 {
365 if (num == i)
366 return device;
367 device = device->next;
368 i++;
369 }
370
371 LOG_ERROR("jtag device number %d not defined", num);
372 exit(-1);
373 }
374
375 void* cmd_queue_alloc(size_t size)
376 {
377 cmd_queue_page_t **p_page = &cmd_queue_pages;
378 int offset;
379 u8 *t;
380
381 if (*p_page)
382 {
383 while ((*p_page)->next)
384 p_page = &((*p_page)->next);
385 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
386 p_page = &((*p_page)->next);
387 }
388
389 if (!*p_page)
390 {
391 *p_page = malloc(sizeof(cmd_queue_page_t));
392 (*p_page)->used = 0;
393 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
394 (*p_page)->next = NULL;
395 }
396
397 offset = (*p_page)->used;
398 (*p_page)->used += size;
399
400 t=(u8 *)((*p_page)->address);
401 return t + offset;
402 }
403
404 void cmd_queue_free(void)
405 {
406 cmd_queue_page_t *page = cmd_queue_pages;
407
408 while (page)
409 {
410 cmd_queue_page_t *last = page;
411 free(page->address);
412 page = page->next;
413 free(last);
414 }
415
416 cmd_queue_pages = NULL;
417 }
418
419 static void jtag_prelude1(void)
420 {
421 if (jtag_trst == 1)
422 {
423 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
424 jtag_error=ERROR_JTAG_TRST_ASSERTED;
425 return;
426 }
427
428 if (cmd_queue_end_state == TAP_TLR)
429 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
430 }
431
432 static void jtag_prelude(enum tap_state state)
433 {
434 jtag_prelude1();
435
436 if (state != -1)
437 jtag_add_end_state(state);
438
439 cmd_queue_cur_state = cmd_queue_end_state;
440 }
441
442 void jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state state)
443 {
444 int retval;
445
446 jtag_prelude(state);
447
448 retval=interface_jtag_add_ir_scan(num_fields, fields, cmd_queue_end_state);
449 if (retval!=ERROR_OK)
450 jtag_error=retval;
451 }
452
453 int MINIDRIVER(interface_jtag_add_ir_scan)(int num_fields, scan_field_t *fields, enum tap_state state)
454 {
455 jtag_command_t **last_cmd;
456 jtag_device_t *device;
457 int i, j;
458 int scan_size = 0;
459
460
461 last_cmd = jtag_get_last_command_p();
462
463 /* allocate memory for a new list member */
464 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
465 (*last_cmd)->next = NULL;
466 last_comand_pointer = &((*last_cmd)->next);
467 (*last_cmd)->type = JTAG_SCAN;
468
469 /* allocate memory for ir scan command */
470 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
471 (*last_cmd)->cmd.scan->ir_scan = 1;
472 (*last_cmd)->cmd.scan->num_fields = jtag_num_devices; /* one field per device */
473 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(jtag_num_devices * sizeof(scan_field_t));
474 (*last_cmd)->cmd.scan->end_state = state;
475
476 for (i = 0; i < jtag_num_devices; i++)
477 {
478 int found = 0;
479 device = jtag_get_device(i);
480 scan_size = device->ir_length;
481 (*last_cmd)->cmd.scan->fields[i].device = i;
482 (*last_cmd)->cmd.scan->fields[i].num_bits = scan_size;
483 (*last_cmd)->cmd.scan->fields[i].in_value = NULL;
484 (*last_cmd)->cmd.scan->fields[i].in_handler = NULL; /* disable verification by default */
485
486 /* search the list */
487 for (j = 0; j < num_fields; j++)
488 {
489 if (i == fields[j].device)
490 {
491 found = 1;
492 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
493 (*last_cmd)->cmd.scan->fields[i].out_mask = buf_cpy(fields[j].out_mask, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
494
495 if (jtag_verify_capture_ir)
496 {
497 if (fields[j].in_handler==NULL)
498 {
499 jtag_set_check_value((*last_cmd)->cmd.scan->fields+i, device->expected, device->expected_mask, NULL);
500 } else
501 {
502 (*last_cmd)->cmd.scan->fields[i].in_handler = fields[j].in_handler;
503 (*last_cmd)->cmd.scan->fields[i].in_handler_priv = fields[j].in_handler_priv;
504 (*last_cmd)->cmd.scan->fields[i].in_check_value = device->expected;
505 (*last_cmd)->cmd.scan->fields[i].in_check_mask = device->expected_mask;
506 }
507 }
508
509 device->bypass = 0;
510 break;
511 }
512 }
513
514 if (!found)
515 {
516 /* if a device isn't listed, set it to BYPASS */
517 (*last_cmd)->cmd.scan->fields[i].out_value = buf_set_ones(cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
518 (*last_cmd)->cmd.scan->fields[i].out_mask = NULL;
519 device->bypass = 1;
520
521 }
522
523 /* update device information */
524 buf_cpy((*last_cmd)->cmd.scan->fields[i].out_value, jtag_get_device(i)->cur_instr, scan_size);
525 }
526
527 return ERROR_OK;
528 }
529
530 void jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state state)
531 {
532 int retval;
533
534 jtag_prelude(state);
535
536 retval=interface_jtag_add_plain_ir_scan(num_fields, fields, cmd_queue_end_state);
537 if (retval!=ERROR_OK)
538 jtag_error=retval;
539 }
540
541 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int num_fields, scan_field_t *fields, enum tap_state state)
542 {
543 int i;
544 jtag_command_t **last_cmd;
545
546 last_cmd = jtag_get_last_command_p();
547
548 /* allocate memory for a new list member */
549 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
550 (*last_cmd)->next = NULL;
551 last_comand_pointer = &((*last_cmd)->next);
552 (*last_cmd)->type = JTAG_SCAN;
553
554 /* allocate memory for ir scan command */
555 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
556 (*last_cmd)->cmd.scan->ir_scan = 1;
557 (*last_cmd)->cmd.scan->num_fields = num_fields;
558 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
559 (*last_cmd)->cmd.scan->end_state = state;
560
561 for (i = 0; i < num_fields; i++)
562 {
563 int num_bits = fields[i].num_bits;
564 int num_bytes = CEIL(fields[i].num_bits, 8);
565 (*last_cmd)->cmd.scan->fields[i].device = fields[i].device;
566 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
567 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
568 (*last_cmd)->cmd.scan->fields[i].out_mask = buf_cpy(fields[i].out_mask, cmd_queue_alloc(num_bytes), num_bits);
569 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
570 (*last_cmd)->cmd.scan->fields[i].in_check_value = fields[i].in_check_value;
571 (*last_cmd)->cmd.scan->fields[i].in_check_mask = fields[i].in_check_mask;
572 (*last_cmd)->cmd.scan->fields[i].in_handler = NULL;
573 (*last_cmd)->cmd.scan->fields[i].in_handler_priv = NULL;
574 }
575 return ERROR_OK;
576 }
577
578 void jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state state)
579 {
580 int retval;
581
582 jtag_prelude(state);
583
584 retval=interface_jtag_add_dr_scan(num_fields, fields, cmd_queue_end_state);
585 if (retval!=ERROR_OK)
586 jtag_error=retval;
587 }
588
589 int MINIDRIVER(interface_jtag_add_dr_scan)(int num_fields, scan_field_t *fields, enum tap_state state)
590 {
591 int i, j;
592 int bypass_devices = 0;
593 int field_count = 0;
594 int scan_size;
595
596 jtag_command_t **last_cmd = jtag_get_last_command_p();
597 jtag_device_t *device = jtag_devices;
598
599 /* count devices in bypass */
600 while (device)
601 {
602 if (device->bypass)
603 bypass_devices++;
604 device = device->next;
605 }
606 if (bypass_devices >= jtag_num_devices)
607 {
608 LOG_ERROR("all devices in bypass");
609 return ERROR_JTAG_DEVICE_ERROR;
610 }
611
612 /* allocate memory for a new list member */
613 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
614 last_comand_pointer = &((*last_cmd)->next);
615 (*last_cmd)->next = NULL;
616 (*last_cmd)->type = JTAG_SCAN;
617
618 /* allocate memory for dr scan command */
619 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
620 (*last_cmd)->cmd.scan->ir_scan = 0;
621 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
622 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
623 (*last_cmd)->cmd.scan->end_state = state;
624
625 for (i = 0; i < jtag_num_devices; i++)
626 {
627 int found = 0;
628 (*last_cmd)->cmd.scan->fields[field_count].device = i;
629
630 for (j = 0; j < num_fields; j++)
631 {
632 if (i == fields[j].device)
633 {
634 found = 1;
635 scan_size = fields[j].num_bits;
636 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
637 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(fields[j].out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
638 (*last_cmd)->cmd.scan->fields[field_count].out_mask = buf_cpy(fields[j].out_mask, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
639 (*last_cmd)->cmd.scan->fields[field_count].in_value = fields[j].in_value;
640 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = fields[j].in_check_value;
641 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = fields[j].in_check_mask;
642 (*last_cmd)->cmd.scan->fields[field_count].in_handler = fields[j].in_handler;
643 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = fields[j].in_handler_priv;
644 }
645 }
646 if (!found)
647 {
648 #ifdef _DEBUG_JTAG_IO_
649 /* if a device isn't listed, the BYPASS register should be selected */
650 if (!jtag_get_device(i)->bypass)
651 {
652 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
653 exit(-1);
654 }
655 #endif
656 /* program the scan field to 1 bit length, and ignore it's value */
657 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
658 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
659 (*last_cmd)->cmd.scan->fields[field_count].out_mask = NULL;
660 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
661 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
662 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
663 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
664 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
665 }
666 else
667 {
668 #ifdef _DEBUG_JTAG_IO_
669 /* if a device is listed, the BYPASS register must not be selected */
670 if (jtag_get_device(i)->bypass)
671 {
672 LOG_ERROR("BUG: scan data for a device in BYPASS");
673 exit(-1);
674 }
675 #endif
676 }
677 }
678 return ERROR_OK;
679 }
680
681 void MINIDRIVER(interface_jtag_add_dr_out)(int device_num,
682 int num_fields,
683 const int *num_bits,
684 const u32 *value,
685 enum tap_state end_state)
686 {
687 int i;
688 int field_count = 0;
689 int scan_size;
690 int bypass_devices = 0;
691
692 jtag_command_t **last_cmd = jtag_get_last_command_p();
693 jtag_device_t *device = jtag_devices;
694 /* count devices in bypass */
695 while (device)
696 {
697 if (device->bypass)
698 bypass_devices++;
699 device = device->next;
700 }
701
702 /* allocate memory for a new list member */
703 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
704 last_comand_pointer = &((*last_cmd)->next);
705 (*last_cmd)->next = NULL;
706 (*last_cmd)->type = JTAG_SCAN;
707
708 /* allocate memory for dr scan command */
709 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
710 (*last_cmd)->cmd.scan->ir_scan = 0;
711 (*last_cmd)->cmd.scan->num_fields = num_fields + bypass_devices;
712 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc((num_fields + bypass_devices) * sizeof(scan_field_t));
713 (*last_cmd)->cmd.scan->end_state = end_state;
714
715 for (i = 0; i < jtag_num_devices; i++)
716 {
717 (*last_cmd)->cmd.scan->fields[field_count].device = i;
718
719 if (i == device_num)
720 {
721 int j;
722 #ifdef _DEBUG_JTAG_IO_
723 /* if a device is listed, the BYPASS register must not be selected */
724 if (jtag_get_device(i)->bypass)
725 {
726 LOG_ERROR("BUG: scan data for a device in BYPASS");
727 exit(-1);
728 }
729 #endif
730 for (j = 0; j < num_fields; j++)
731 {
732 u8 out_value[4];
733 scan_size = num_bits[j];
734 buf_set_u32(out_value, 0, scan_size, value[j]);
735 (*last_cmd)->cmd.scan->fields[field_count].num_bits = scan_size;
736 (*last_cmd)->cmd.scan->fields[field_count].out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
737 (*last_cmd)->cmd.scan->fields[field_count].out_mask = NULL;
738 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
739 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
740 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
741 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
742 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
743 }
744 } else
745 {
746 #ifdef _DEBUG_JTAG_IO_
747 /* if a device isn't listed, the BYPASS register should be selected */
748 if (!jtag_get_device(i)->bypass)
749 {
750 LOG_ERROR("BUG: no scan data for a device not in BYPASS");
751 exit(-1);
752 }
753 #endif
754 /* program the scan field to 1 bit length, and ignore it's value */
755 (*last_cmd)->cmd.scan->fields[field_count].num_bits = 1;
756 (*last_cmd)->cmd.scan->fields[field_count].out_value = NULL;
757 (*last_cmd)->cmd.scan->fields[field_count].out_mask = NULL;
758 (*last_cmd)->cmd.scan->fields[field_count].in_value = NULL;
759 (*last_cmd)->cmd.scan->fields[field_count].in_check_value = NULL;
760 (*last_cmd)->cmd.scan->fields[field_count].in_check_mask = NULL;
761 (*last_cmd)->cmd.scan->fields[field_count].in_handler = NULL;
762 (*last_cmd)->cmd.scan->fields[field_count++].in_handler_priv = NULL;
763 }
764 }
765 }
766
767 void jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state state)
768 {
769 int retval;
770
771 jtag_prelude(state);
772
773 retval=interface_jtag_add_plain_dr_scan(num_fields, fields, cmd_queue_end_state);
774 if (retval!=ERROR_OK)
775 jtag_error=retval;
776 }
777
778 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int num_fields, scan_field_t *fields, enum tap_state state)
779 {
780 int i;
781 jtag_command_t **last_cmd = jtag_get_last_command_p();
782
783 /* allocate memory for a new list member */
784 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
785 last_comand_pointer = &((*last_cmd)->next);
786 (*last_cmd)->next = NULL;
787 (*last_cmd)->type = JTAG_SCAN;
788
789 /* allocate memory for scan command */
790 (*last_cmd)->cmd.scan = cmd_queue_alloc(sizeof(scan_command_t));
791 (*last_cmd)->cmd.scan->ir_scan = 0;
792 (*last_cmd)->cmd.scan->num_fields = num_fields;
793 (*last_cmd)->cmd.scan->fields = cmd_queue_alloc(num_fields * sizeof(scan_field_t));
794 (*last_cmd)->cmd.scan->end_state = state;
795
796 for (i = 0; i < num_fields; i++)
797 {
798 int num_bits = fields[i].num_bits;
799 int num_bytes = CEIL(fields[i].num_bits, 8);
800 (*last_cmd)->cmd.scan->fields[i].device = fields[i].device;
801 (*last_cmd)->cmd.scan->fields[i].num_bits = num_bits;
802 (*last_cmd)->cmd.scan->fields[i].out_value = buf_cpy(fields[i].out_value, cmd_queue_alloc(num_bytes), num_bits);
803 (*last_cmd)->cmd.scan->fields[i].out_mask = buf_cpy(fields[i].out_mask, cmd_queue_alloc(num_bytes), num_bits);
804 (*last_cmd)->cmd.scan->fields[i].in_value = fields[i].in_value;
805 (*last_cmd)->cmd.scan->fields[i].in_check_value = fields[i].in_check_value;
806 (*last_cmd)->cmd.scan->fields[i].in_check_mask = fields[i].in_check_mask;
807 (*last_cmd)->cmd.scan->fields[i].in_handler = fields[i].in_handler;
808 (*last_cmd)->cmd.scan->fields[i].in_handler_priv = fields[i].in_handler_priv;
809 }
810
811 return ERROR_OK;
812 }
813
814 void jtag_add_tlr(void)
815 {
816 jtag_prelude(TAP_TLR);
817
818 int retval;
819 retval=interface_jtag_add_tlr();
820 if (retval!=ERROR_OK)
821 jtag_error=retval;
822 }
823
824 int MINIDRIVER(interface_jtag_add_tlr)()
825 {
826 enum tap_state state = TAP_TLR;
827 jtag_command_t **last_cmd = jtag_get_last_command_p();
828
829 /* allocate memory for a new list member */
830 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
831 last_comand_pointer = &((*last_cmd)->next);
832 (*last_cmd)->next = NULL;
833 (*last_cmd)->type = JTAG_STATEMOVE;
834
835 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
836 (*last_cmd)->cmd.statemove->end_state = state;
837
838
839 return ERROR_OK;
840 }
841
842 void jtag_add_pathmove(int num_states, enum tap_state *path)
843 {
844 enum tap_state cur_state=cmd_queue_cur_state;
845 int i;
846 int retval;
847
848 /* the last state has to be a stable state */
849 if (tap_move_map[path[num_states - 1]] == -1)
850 {
851 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
852 exit(-1);
853 }
854
855 for (i=0; i<num_states; i++)
856 {
857 if (path[i] == TAP_TLR)
858 {
859 LOG_ERROR("BUG: TAP_TLR is not a valid state for pathmove sequences");
860 exit(-1);
861 }
862 if ((tap_transitions[cur_state].low != path[i])&&
863 (tap_transitions[cur_state].high != path[i]))
864 {
865 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[path[i]]);
866 exit(-1);
867 }
868 cur_state = path[i];
869 }
870
871 jtag_prelude1();
872
873
874 retval=interface_jtag_add_pathmove(num_states, path);
875 cmd_queue_cur_state = path[num_states - 1];
876 if (retval!=ERROR_OK)
877 jtag_error=retval;
878 }
879
880 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, enum tap_state *path)
881 {
882 jtag_command_t **last_cmd = jtag_get_last_command_p();
883 int i;
884
885 /* allocate memory for a new list member */
886 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
887 last_comand_pointer = &((*last_cmd)->next);
888 (*last_cmd)->next = NULL;
889 (*last_cmd)->type = JTAG_PATHMOVE;
890
891 (*last_cmd)->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
892 (*last_cmd)->cmd.pathmove->num_states = num_states;
893 (*last_cmd)->cmd.pathmove->path = cmd_queue_alloc(sizeof(enum tap_state) * num_states);
894
895 for (i = 0; i < num_states; i++)
896 (*last_cmd)->cmd.pathmove->path[i] = path[i];
897
898 return ERROR_OK;
899 }
900
901 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, enum tap_state state)
902 {
903 jtag_command_t **last_cmd = jtag_get_last_command_p();
904
905 /* allocate memory for a new list member */
906 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
907 (*last_cmd)->next = NULL;
908 last_comand_pointer = &((*last_cmd)->next);
909 (*last_cmd)->type = JTAG_RUNTEST;
910
911 (*last_cmd)->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
912 (*last_cmd)->cmd.runtest->num_cycles = num_cycles;
913 (*last_cmd)->cmd.runtest->end_state = state;
914
915 return ERROR_OK;
916 }
917
918 void jtag_add_runtest(int num_cycles, enum tap_state state)
919 {
920 int retval;
921
922 jtag_prelude(state);
923
924 /* executed by sw or hw fifo */
925 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
926 if (retval!=ERROR_OK)
927 jtag_error=retval;
928 }
929
930 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
931 {
932 int trst_with_tlr = 0;
933 int retval;
934
935 /* FIX!!! there are *many* different cases here. A better
936 * approach is needed for legal combinations of transitions...
937 */
938 if ((jtag_reset_config & RESET_HAS_SRST)&&
939 (jtag_reset_config & RESET_HAS_TRST)&&
940 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
941 {
942 if (((req_tlr_or_trst&&!jtag_trst)||
943 (!req_tlr_or_trst&&jtag_trst))&&
944 ((req_srst&&!jtag_srst)||
945 (!req_srst&&jtag_srst)))
946 {
947 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
948 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
949 }
950 }
951
952 /* Make sure that jtag_reset_config allows the requested reset */
953 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
954 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
955 {
956 LOG_ERROR("BUG: requested reset would assert trst");
957 jtag_error=ERROR_FAIL;
958 return;
959 }
960
961 /* if TRST pulls SRST, we reset with TAP T-L-R */
962 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
963 {
964 trst_with_tlr = 1;
965 }
966
967 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
968 {
969 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
970 jtag_error=ERROR_FAIL;
971 return;
972 }
973
974 if (req_tlr_or_trst)
975 {
976 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
977 {
978 jtag_trst = 1;
979 } else
980 {
981 trst_with_tlr = 1;
982 }
983 } else
984 {
985 jtag_trst = 0;
986 }
987
988 jtag_srst = req_srst;
989
990 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
991 if (retval!=ERROR_OK)
992 {
993 jtag_error=retval;
994 return;
995 }
996
997 if (jtag_srst)
998 {
999 LOG_DEBUG("SRST line asserted");
1000 }
1001 else
1002 {
1003 LOG_DEBUG("SRST line released");
1004 if (jtag_nsrst_delay)
1005 jtag_add_sleep(jtag_nsrst_delay * 1000);
1006 }
1007
1008 if (trst_with_tlr)
1009 {
1010 LOG_DEBUG("JTAG reset with TLR instead of TRST");
1011 jtag_add_end_state(TAP_TLR);
1012 jtag_add_tlr();
1013 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1014 return;
1015 }
1016
1017 if (jtag_trst)
1018 {
1019 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1020 * and inform possible listeners about this
1021 */
1022 LOG_DEBUG("TRST line asserted");
1023 cmd_queue_cur_state = TAP_TLR;
1024 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1025 }
1026 else
1027 {
1028 if (jtag_ntrst_delay)
1029 jtag_add_sleep(jtag_ntrst_delay * 1000);
1030 }
1031 }
1032
1033 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1034 {
1035 jtag_command_t **last_cmd = jtag_get_last_command_p();
1036
1037 /* allocate memory for a new list member */
1038 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1039 (*last_cmd)->next = NULL;
1040 last_comand_pointer = &((*last_cmd)->next);
1041 (*last_cmd)->type = JTAG_RESET;
1042
1043 (*last_cmd)->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1044 (*last_cmd)->cmd.reset->trst = req_trst;
1045 (*last_cmd)->cmd.reset->srst = req_srst;
1046
1047 return ERROR_OK;
1048 }
1049
1050 void jtag_add_end_state(enum tap_state state)
1051 {
1052 cmd_queue_end_state = state;
1053 if ((cmd_queue_end_state == TAP_SD)||(cmd_queue_end_state == TAP_SI))
1054 {
1055 LOG_ERROR("BUG: TAP_SD/SI can't be end state. Calling code should use a larger scan field");
1056 }
1057 }
1058
1059 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1060 {
1061 jtag_command_t **last_cmd = jtag_get_last_command_p();
1062
1063 /* allocate memory for a new list member */
1064 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1065 (*last_cmd)->next = NULL;
1066 last_comand_pointer = &((*last_cmd)->next);
1067 (*last_cmd)->type = JTAG_SLEEP;
1068
1069 (*last_cmd)->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1070 (*last_cmd)->cmd.sleep->us = us;
1071
1072 return ERROR_OK;
1073 }
1074
1075 void jtag_add_sleep(u32 us)
1076 {
1077 keep_alive(); /* we might be running on a very slow JTAG clk */
1078 int retval=interface_jtag_add_sleep(us);
1079 if (retval!=ERROR_OK)
1080 jtag_error=retval;
1081 return;
1082 }
1083
1084 int jtag_scan_size(scan_command_t *cmd)
1085 {
1086 int bit_count = 0;
1087 int i;
1088
1089 /* count bits in scan command */
1090 for (i = 0; i < cmd->num_fields; i++)
1091 {
1092 bit_count += cmd->fields[i].num_bits;
1093 }
1094
1095 return bit_count;
1096 }
1097
1098 int jtag_build_buffer(scan_command_t *cmd, u8 **buffer)
1099 {
1100 int bit_count = 0;
1101 int i;
1102
1103 bit_count = jtag_scan_size(cmd);
1104 *buffer = malloc(CEIL(bit_count, 8));
1105
1106 bit_count = 0;
1107
1108 for (i = 0; i < cmd->num_fields; i++)
1109 {
1110 if (cmd->fields[i].out_value)
1111 {
1112 #ifdef _DEBUG_JTAG_IO_
1113 char* char_buf = buf_to_str(cmd->fields[i].out_value, (cmd->fields[i].num_bits > 64) ? 64 : cmd->fields[i].num_bits, 16);
1114 #endif
1115 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1116 #ifdef _DEBUG_JTAG_IO_
1117 LOG_DEBUG("fields[%i].out_value: 0x%s", i, char_buf);
1118 free(char_buf);
1119 #endif
1120 }
1121
1122 bit_count += cmd->fields[i].num_bits;
1123 }
1124
1125 return bit_count;
1126 }
1127
1128 int jtag_read_buffer(u8 *buffer, scan_command_t *cmd)
1129 {
1130 int i;
1131 int bit_count = 0;
1132 int retval;
1133
1134 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1135 retval = ERROR_OK;
1136
1137 for (i = 0; i < cmd->num_fields; i++)
1138 {
1139 /* if neither in_value nor in_handler
1140 * are specified we don't have to examine this field
1141 */
1142 if (cmd->fields[i].in_value || cmd->fields[i].in_handler)
1143 {
1144 int num_bits = cmd->fields[i].num_bits;
1145 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1146
1147 #ifdef _DEBUG_JTAG_IO_
1148 char *char_buf;
1149
1150 char_buf = buf_to_str(captured, (num_bits > 64) ? 64 : num_bits, 16);
1151 LOG_DEBUG("fields[%i].in_value: 0x%s", i, char_buf);
1152 free(char_buf);
1153 #endif
1154
1155 if (cmd->fields[i].in_value)
1156 {
1157 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1158
1159 if (cmd->fields[i].in_handler)
1160 {
1161 if (cmd->fields[i].in_handler(cmd->fields[i].in_value, cmd->fields[i].in_handler_priv, cmd->fields+i) != ERROR_OK)
1162 {
1163 LOG_WARNING("in_handler reported a failed check");
1164 retval = ERROR_JTAG_QUEUE_FAILED;
1165 }
1166 }
1167 }
1168
1169 /* no in_value specified, but a handler takes care of the scanned data */
1170 if (cmd->fields[i].in_handler && (!cmd->fields[i].in_value))
1171 {
1172 if (cmd->fields[i].in_handler(captured, cmd->fields[i].in_handler_priv, cmd->fields+i) != ERROR_OK)
1173 {
1174 /* We're going to call the error:handler later, but if the in_handler
1175 * reported an error we report this failure upstream
1176 */
1177 LOG_WARNING("in_handler reported a failed check");
1178 retval = ERROR_JTAG_QUEUE_FAILED;
1179 }
1180 }
1181
1182 free(captured);
1183 }
1184 bit_count += cmd->fields[i].num_bits;
1185 }
1186
1187 return retval;
1188 }
1189
1190 int jtag_check_value(u8 *captured, void *priv, scan_field_t *field)
1191 {
1192 int retval = ERROR_OK;
1193 int num_bits = field->num_bits;
1194
1195 int compare_failed = 0;
1196
1197 if (field->in_check_mask)
1198 compare_failed = buf_cmp_mask(captured, field->in_check_value, field->in_check_mask, num_bits);
1199 else
1200 compare_failed = buf_cmp(captured, field->in_check_value, num_bits);
1201
1202 if (compare_failed)
1203 {
1204 /* An error handler could have caught the failing check
1205 * only report a problem when there wasn't a handler, or if the handler
1206 * acknowledged the error
1207 */
1208 if (compare_failed)
1209 {
1210 char *captured_char = buf_to_str(captured, (num_bits > 64) ? 64 : num_bits, 16);
1211 char *in_check_value_char = buf_to_str(field->in_check_value, (num_bits > 64) ? 64 : num_bits, 16);
1212
1213 if (field->in_check_mask)
1214 {
1215 char *in_check_mask_char;
1216 in_check_mask_char = buf_to_str(field->in_check_mask, (num_bits > 64) ? 64 : num_bits, 16);
1217 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s check_mask: 0x%s", captured_char, in_check_value_char, in_check_mask_char);
1218 free(in_check_mask_char);
1219 }
1220 else
1221 {
1222 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char, in_check_value_char);
1223 }
1224
1225 free(captured_char);
1226 free(in_check_value_char);
1227
1228 retval = ERROR_JTAG_QUEUE_FAILED;
1229 }
1230
1231 }
1232 return retval;
1233 }
1234
1235 /*
1236 set up checking of this field using the in_handler. The values passed in must be valid until
1237 after jtag_execute() has completed.
1238 */
1239 void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler)
1240 {
1241 if (value)
1242 field->in_handler = jtag_check_value;
1243 else
1244 field->in_handler = NULL; /* No check, e.g. embeddedice uses value==NULL to indicate no check */
1245 field->in_handler_priv = NULL;
1246 field->in_check_value = value;
1247 field->in_check_mask = mask;
1248 }
1249
1250 enum scan_type jtag_scan_type(scan_command_t *cmd)
1251 {
1252 int i;
1253 int type = 0;
1254
1255 for (i = 0; i < cmd->num_fields; i++)
1256 {
1257 if (cmd->fields[i].in_value || cmd->fields[i].in_handler)
1258 type |= SCAN_IN;
1259 if (cmd->fields[i].out_value)
1260 type |= SCAN_OUT;
1261 }
1262
1263 return type;
1264 }
1265
1266 int MINIDRIVER(interface_jtag_execute_queue)(void)
1267 {
1268 int retval;
1269
1270 if (jtag==NULL)
1271 {
1272 LOG_ERROR("No JTAG interface configured yet. Issue 'init' command in startup scripts before communicating with targets.");
1273 return ERROR_FAIL;
1274 }
1275
1276 retval = jtag->execute_queue();
1277
1278 cmd_queue_free();
1279
1280 jtag_command_queue = NULL;
1281 last_comand_pointer = &jtag_command_queue;
1282
1283 return retval;
1284 }
1285
1286 int jtag_execute_queue(void)
1287 {
1288 int retval=interface_jtag_execute_queue();
1289 if (retval==ERROR_OK)
1290 {
1291 retval=jtag_error;
1292 }
1293 jtag_error=ERROR_OK;
1294 return retval;
1295 }
1296
1297 int jtag_reset_callback(enum jtag_event event, void *priv)
1298 {
1299 jtag_device_t *device = priv;
1300
1301 LOG_DEBUG("-");
1302
1303 if (event == JTAG_TRST_ASSERTED)
1304 {
1305 buf_set_ones(device->cur_instr, device->ir_length);
1306 device->bypass = 1;
1307 }
1308
1309 return ERROR_OK;
1310 }
1311
1312 void jtag_sleep(u32 us)
1313 {
1314 alive_sleep(us/1000);
1315 }
1316
1317 /* Try to examine chain layout according to IEEE 1149.1 §12
1318 */
1319 int jtag_examine_chain(void)
1320 {
1321 jtag_device_t *device = jtag_devices;
1322 scan_field_t field;
1323 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1324 int i;
1325 int bit_count;
1326 int device_count = 0;
1327 u8 zero_check = 0x0;
1328 u8 one_check = 0xff;
1329
1330 field.device = 0;
1331 field.num_bits = sizeof(idcode_buffer) * 8;
1332 field.out_value = idcode_buffer;
1333 field.out_mask = NULL;
1334 field.in_value = idcode_buffer;
1335 field.in_check_value = NULL;
1336 field.in_check_mask = NULL;
1337 field.in_handler = NULL;
1338 field.in_handler_priv = NULL;
1339
1340 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1341 {
1342 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1343 }
1344
1345 jtag_add_plain_dr_scan(1, &field, TAP_TLR);
1346 jtag_execute_queue();
1347
1348 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1349 {
1350 zero_check |= idcode_buffer[i];
1351 one_check &= idcode_buffer[i];
1352 }
1353
1354 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1355 if ((zero_check == 0x00) || (one_check == 0xff))
1356 {
1357 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1358 return ERROR_JTAG_INIT_FAILED;
1359 }
1360
1361 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1362 {
1363 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1364 if ((idcode & 1) == 0)
1365 {
1366 /* LSB must not be 0, this indicates a device in bypass */
1367 LOG_WARNING("Device does not have IDCODE");
1368 idcode=0;
1369
1370 bit_count += 1;
1371 }
1372 else
1373 {
1374 u32 manufacturer;
1375 u32 part;
1376 u32 version;
1377
1378 if (idcode == 0x000000FF)
1379 {
1380 int unexpected=0;
1381 /* End of chain (invalid manufacturer ID)
1382 *
1383 * The JTAG examine is the very first thing that happens
1384 *
1385 * A single JTAG device requires only 64 bits to be read back correctly.
1386 *
1387 * The code below adds a check that the rest of the data scanned (640 bits)
1388 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1389 *
1390 * earlier and gives more helpful/explicit error messages.
1391 */
1392 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1393 {
1394 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1395 if (unexpected||(idcode != 0x000000FF))
1396 {
1397 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1398 unexpected = 1;
1399 }
1400 }
1401
1402 break;
1403 }
1404
1405 manufacturer = (idcode & 0xffe) >> 1;
1406 part = (idcode & 0xffff000) >> 12;
1407 version = (idcode & 0xf0000000) >> 28;
1408
1409 LOG_INFO("JTAG device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1410 idcode, manufacturer, part, version);
1411
1412 bit_count += 32;
1413 }
1414 if (device)
1415 {
1416 device->idcode = idcode;
1417 device = device->next;
1418 }
1419 device_count++;
1420 }
1421
1422 /* see if number of discovered devices matches configuration */
1423 if (device_count != jtag_num_devices)
1424 {
1425 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match configuration (%i)",
1426 device_count, jtag_num_devices);
1427 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1428 return ERROR_JTAG_INIT_FAILED;
1429 }
1430
1431 return ERROR_OK;
1432 }
1433
1434 int jtag_validate_chain(void)
1435 {
1436 jtag_device_t *device = jtag_devices;
1437 int total_ir_length = 0;
1438 u8 *ir_test = NULL;
1439 scan_field_t field;
1440 int chain_pos = 0;
1441
1442 while (device)
1443 {
1444 total_ir_length += device->ir_length;
1445 device = device->next;
1446 }
1447
1448 total_ir_length += 2;
1449 ir_test = malloc(CEIL(total_ir_length, 8));
1450 buf_set_ones(ir_test, total_ir_length);
1451
1452 field.device = 0;
1453 field.num_bits = total_ir_length;
1454 field.out_value = ir_test;
1455 field.out_mask = NULL;
1456 field.in_value = ir_test;
1457 field.in_check_value = NULL;
1458 field.in_check_mask = NULL;
1459 field.in_handler = NULL;
1460 field.in_handler_priv = NULL;
1461
1462 jtag_add_plain_ir_scan(1, &field, TAP_TLR);
1463 jtag_execute_queue();
1464
1465 device = jtag_devices;
1466 while (device)
1467 {
1468 if (buf_get_u32(ir_test, chain_pos, 2) != 0x1)
1469 {
1470 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1471 LOG_ERROR("Error validating JTAG scan chain, IR mismatch, scan returned 0x%s", cbuf);
1472 free(cbuf);
1473 free(ir_test);
1474 return ERROR_JTAG_INIT_FAILED;
1475 }
1476 chain_pos += device->ir_length;
1477 device = device->next;
1478 }
1479
1480 if (buf_get_u32(ir_test, chain_pos, 2) != 0x3)
1481 {
1482 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1483 LOG_ERROR("Error validating JTAG scan chain, IR mismatch, scan returned 0x%s", cbuf);
1484 free(cbuf);
1485 free(ir_test);
1486 return ERROR_JTAG_INIT_FAILED;
1487 }
1488
1489 free(ir_test);
1490
1491 return ERROR_OK;
1492 }
1493
1494
1495 static int
1496 jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
1497 {
1498 Jim_GetOptInfo goi;
1499 int e;
1500 Jim_Nvp *n;
1501 struct command_context_s *context;
1502
1503 enum {
1504 JTAG_CMD_INTERFACE,
1505 JTAG_CMD_INIT_RESET,
1506 };
1507
1508 const Jim_Nvp jtag_cmds[] = {
1509 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
1510 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
1511
1512 { .name = NULL, .value = -1 },
1513 };
1514
1515 context = Jim_GetAssocData(interp, "context");
1516 // go past the command
1517 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
1518
1519 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
1520 if( e != JIM_OK ){
1521 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
1522 return e;
1523 }
1524 Jim_SetEmptyResult( goi.interp );
1525 switch( n->value ){
1526 case JTAG_CMD_INTERFACE:
1527 // return the name of the interface
1528 // TCL code might need to know the exact type...
1529 // FUTURE: we allow this as a means to "set" the interface.
1530 if( goi.argc != 0 ){
1531 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1532 return JIM_ERR;
1533 }
1534 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
1535 return JIM_OK;
1536 case JTAG_CMD_INIT_RESET:
1537 if( goi.argc != 0 ){
1538 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1539 return JIM_ERR;
1540 }
1541 e = jtag_init_reset(context);
1542 if( e != ERROR_OK ){
1543 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
1544 return JIM_ERR;
1545 }
1546 return JIM_OK;
1547 }
1548
1549
1550 return JIM_ERR;
1551 }
1552
1553 int jtag_register_commands(struct command_context_s *cmd_ctx)
1554 {
1555 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
1556
1557 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
1558 COMMAND_CONFIG, NULL);
1559 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
1560 COMMAND_ANY, "set jtag speed (if supported)");
1561 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
1562 COMMAND_ANY, "same as jtag_speed, except it takes maximum khz as arguments. 0 KHz = RTCK.");
1563 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
1564 COMMAND_CONFIG, "jtag_device <ir_length> <ir_expected> <ir_mask>");
1565 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
1566 COMMAND_CONFIG, NULL);
1567 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
1568 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1569 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
1570 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1571
1572 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
1573 COMMAND_EXEC, "print current scan chain configuration");
1574
1575 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
1576 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
1577 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
1578 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
1579 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
1580 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
1581 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
1582 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1583 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1584
1585 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
1586 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
1587 return ERROR_OK;
1588 }
1589
1590 int jtag_interface_init(struct command_context_s *cmd_ctx)
1591 {
1592 if (jtag)
1593 return ERROR_OK;
1594
1595 if (!jtag_interface)
1596 {
1597 /* nothing was previously specified by "interface" command */
1598 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1599 return ERROR_JTAG_INVALID_INTERFACE;
1600 }
1601 if(hasKHz)
1602 {
1603 jtag_interface->khz(speed_khz, &jtag_speed);
1604 hasKHz = 0;
1605 }
1606
1607 if (jtag_interface->init() != ERROR_OK)
1608 return ERROR_JTAG_INIT_FAILED;
1609
1610
1611
1612 jtag = jtag_interface;
1613 return ERROR_OK;
1614 }
1615
1616 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1617 {
1618 jtag_device_t *device;
1619 int retval;
1620
1621 LOG_DEBUG("Init JTAG chain");
1622
1623 device = jtag_devices;
1624 jtag_ir_scan_size = 0;
1625 jtag_num_devices = 0;
1626 while (device != NULL)
1627 {
1628 jtag_ir_scan_size += device->ir_length;
1629 jtag_num_devices++;
1630 device = device->next;
1631 }
1632
1633 jtag_add_tlr();
1634 if ((retval=jtag_execute_queue())!=ERROR_OK)
1635 return retval;
1636
1637 /* examine chain first, as this could discover the real chain layout */
1638 if (jtag_examine_chain() != ERROR_OK)
1639 {
1640 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1641 }
1642
1643 if (jtag_validate_chain() != ERROR_OK)
1644 {
1645 LOG_ERROR("Could not validate JTAG chain, continuing anyway...");
1646 }
1647
1648 return ERROR_OK;
1649 }
1650
1651 int jtag_init_reset(struct command_context_s *cmd_ctx)
1652 {
1653 int retval;
1654
1655 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1656 return retval;
1657
1658 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / TLR");
1659
1660 /* Reset can happen after a power cycle.
1661 *
1662 * Ideally we would only assert TRST or run TLR before the target reset.
1663 *
1664 * However w/srst_pulls_trst, trst is asserted together with the target
1665 * reset whether we want it or not.
1666 *
1667 * NB! Some targets have JTAG circuitry disabled until a
1668 * trst & srst has been asserted.
1669 *
1670 * NB! here we assume nsrst/ntrst delay are sufficient!
1671 *
1672 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1673 *
1674 */
1675 jtag_add_reset(1, 0); /* TLR or TRST */
1676 if (jtag_reset_config & RESET_HAS_SRST)
1677 {
1678 jtag_add_reset(1, 1);
1679 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
1680 jtag_add_reset(0, 1);
1681 }
1682 jtag_add_reset(0, 0);
1683 if ((retval = jtag_execute_queue()) != ERROR_OK)
1684 return retval;
1685
1686 /* Check that we can communication on the JTAG chain + eventually we want to
1687 * be able to perform enumeration only after OpenOCD has started
1688 * telnet and GDB server
1689 *
1690 * That would allow users to more easily perform any magic they need to before
1691 * reset happens.
1692 */
1693 return jtag_init_inner(cmd_ctx);
1694 }
1695
1696 int jtag_init(struct command_context_s *cmd_ctx)
1697 {
1698 int retval;
1699 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1700 return retval;
1701 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
1702 {
1703 return ERROR_OK;
1704 }
1705 return jtag_init_reset(cmd_ctx);
1706 }
1707
1708 static int default_khz(int khz, int *jtag_speed)
1709 {
1710 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1711 return ERROR_FAIL;
1712 }
1713
1714 static int default_speed_div(int speed, int *khz)
1715 {
1716 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1717 return ERROR_FAIL;
1718 }
1719
1720 int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1721 {
1722 int i;
1723 int retval;
1724
1725 /* check whether the interface is already configured */
1726 if (jtag_interface)
1727 {
1728 LOG_WARNING("Interface already configured, ignoring");
1729 return ERROR_OK;
1730 }
1731
1732 /* interface name is a mandatory argument */
1733 if (argc < 1 || args[0][0] == '\0')
1734 {
1735 return ERROR_COMMAND_SYNTAX_ERROR;
1736 }
1737
1738 for (i=0; jtag_interfaces[i]; i++)
1739 {
1740 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
1741 {
1742 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
1743 {
1744 return retval;
1745 }
1746
1747 jtag_interface = jtag_interfaces[i];
1748
1749 if (jtag_interface->khz == NULL)
1750 {
1751 jtag_interface->khz = default_khz;
1752 }
1753 if (jtag_interface->speed_div == NULL)
1754 {
1755 jtag_interface->speed_div = default_speed_div;
1756 }
1757 return ERROR_OK;
1758 }
1759 }
1760
1761 /* no valid interface was found (i.e. the configuration option,
1762 * didn't match one of the compiled-in interfaces
1763 */
1764 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
1765 LOG_ERROR("compiled-in jtag interfaces:");
1766 for (i = 0; jtag_interfaces[i]; i++)
1767 {
1768 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
1769 }
1770
1771 return ERROR_JTAG_INVALID_INTERFACE;
1772 }
1773
1774 int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1775 {
1776 jtag_device_t **last_device_p = &jtag_devices;
1777
1778 if (*last_device_p)
1779 {
1780 while ((*last_device_p)->next)
1781 last_device_p = &((*last_device_p)->next);
1782 last_device_p = &((*last_device_p)->next);
1783 }
1784
1785 if (argc < 3)
1786 return ERROR_OK;
1787
1788 *last_device_p = malloc(sizeof(jtag_device_t));
1789 (*last_device_p)->ir_length = strtoul(args[0], NULL, 0);
1790
1791 (*last_device_p)->expected = malloc((*last_device_p)->ir_length);
1792 buf_set_u32((*last_device_p)->expected, 0, (*last_device_p)->ir_length, strtoul(args[1], NULL, 0));
1793 (*last_device_p)->expected_mask = malloc((*last_device_p)->ir_length);
1794 buf_set_u32((*last_device_p)->expected_mask, 0, (*last_device_p)->ir_length, strtoul(args[2], NULL, 0));
1795
1796 (*last_device_p)->cur_instr = malloc((*last_device_p)->ir_length);
1797 (*last_device_p)->bypass = 1;
1798 buf_set_ones((*last_device_p)->cur_instr, (*last_device_p)->ir_length);
1799
1800 (*last_device_p)->next = NULL;
1801
1802 jtag_register_event_callback(jtag_reset_callback, (*last_device_p));
1803
1804 jtag_num_devices++;
1805
1806 return ERROR_OK;
1807 }
1808
1809 int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1810 {
1811 jtag_device_t *device = jtag_devices;
1812 int device_count = 0;
1813
1814 while (device)
1815 {
1816 u32 expected, expected_mask, cur_instr;
1817 expected = buf_get_u32(device->expected, 0, device->ir_length);
1818 expected_mask = buf_get_u32(device->expected_mask, 0, device->ir_length);
1819 cur_instr = buf_get_u32(device->cur_instr, 0, device->ir_length);
1820 command_print(cmd_ctx, "%i: idcode: 0x%8.8x ir length %i, ir capture 0x%x, ir mask 0x%x, current instruction 0x%x", device_count, device->idcode, device->ir_length, expected, expected_mask, cur_instr);
1821 device = device->next;
1822 device_count++;
1823 }
1824
1825 return ERROR_OK;
1826 }
1827
1828 int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1829 {
1830 if (argc < 1)
1831 return ERROR_COMMAND_SYNTAX_ERROR;
1832
1833 if (argc >= 1)
1834 {
1835 if (strcmp(args[0], "none") == 0)
1836 jtag_reset_config = RESET_NONE;
1837 else if (strcmp(args[0], "trst_only") == 0)
1838 jtag_reset_config = RESET_HAS_TRST;
1839 else if (strcmp(args[0], "srst_only") == 0)
1840 jtag_reset_config = RESET_HAS_SRST;
1841 else if (strcmp(args[0], "trst_and_srst") == 0)
1842 jtag_reset_config = RESET_TRST_AND_SRST;
1843 else
1844 {
1845 LOG_ERROR("invalid reset_config argument, defaulting to none");
1846 jtag_reset_config = RESET_NONE;
1847 return ERROR_INVALID_ARGUMENTS;
1848 }
1849 }
1850
1851 if (argc >= 2)
1852 {
1853 if (strcmp(args[1], "separate") == 0)
1854 {
1855 /* seperate reset lines - default */
1856 } else
1857 {
1858 if (strcmp(args[1], "srst_pulls_trst") == 0)
1859 jtag_reset_config |= RESET_SRST_PULLS_TRST;
1860 else if (strcmp(args[1], "trst_pulls_srst") == 0)
1861 jtag_reset_config |= RESET_TRST_PULLS_SRST;
1862 else if (strcmp(args[1], "combined") == 0)
1863 jtag_reset_config |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
1864 else
1865 {
1866 LOG_ERROR("invalid reset_config argument, defaulting to none");
1867 jtag_reset_config = RESET_NONE;
1868 return ERROR_INVALID_ARGUMENTS;
1869 }
1870 }
1871 }
1872
1873 if (argc >= 3)
1874 {
1875 if (strcmp(args[2], "trst_open_drain") == 0)
1876 jtag_reset_config |= RESET_TRST_OPEN_DRAIN;
1877 else if (strcmp(args[2], "trst_push_pull") == 0)
1878 jtag_reset_config &= ~RESET_TRST_OPEN_DRAIN;
1879 else
1880 {
1881 LOG_ERROR("invalid reset_config argument, defaulting to none");
1882 jtag_reset_config = RESET_NONE;
1883 return ERROR_INVALID_ARGUMENTS;
1884 }
1885 }
1886
1887 if (argc >= 4)
1888 {
1889 if (strcmp(args[3], "srst_push_pull") == 0)
1890 jtag_reset_config |= RESET_SRST_PUSH_PULL;
1891 else if (strcmp(args[3], "srst_open_drain") == 0)
1892 jtag_reset_config &= ~RESET_SRST_PUSH_PULL;
1893 else
1894 {
1895 LOG_ERROR("invalid reset_config argument, defaulting to none");
1896 jtag_reset_config = RESET_NONE;
1897 return ERROR_INVALID_ARGUMENTS;
1898 }
1899 }
1900
1901 return ERROR_OK;
1902 }
1903
1904 int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1905 {
1906 if (argc < 1)
1907 {
1908 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
1909 exit(-1);
1910 }
1911 else
1912 {
1913 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
1914 }
1915
1916 return ERROR_OK;
1917 }
1918
1919 int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1920 {
1921 if (argc < 1)
1922 {
1923 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
1924 exit(-1);
1925 }
1926 else
1927 {
1928 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
1929 }
1930
1931 return ERROR_OK;
1932 }
1933
1934 int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1935 {
1936 int retval=ERROR_OK;
1937
1938 if (argc == 1)
1939 {
1940 LOG_DEBUG("handle jtag speed");
1941
1942 int cur_speed = 0;
1943 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
1944
1945 /* this command can be called during CONFIG,
1946 * in which case jtag isn't initialized */
1947 if (jtag)
1948 {
1949 retval=jtag->speed(cur_speed);
1950 }
1951 } else if (argc == 0)
1952 {
1953 } else
1954 {
1955 return ERROR_COMMAND_SYNTAX_ERROR;
1956 }
1957 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
1958
1959 return retval;
1960 }
1961
1962 int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1963 {
1964 int retval=ERROR_OK;
1965 LOG_DEBUG("handle jtag khz");
1966
1967 if(argc == 1)
1968 {
1969 speed_khz = strtoul(args[0], NULL, 0);
1970 if (jtag != NULL)
1971 {
1972 int cur_speed = 0;
1973 LOG_DEBUG("have interface set up");
1974 int speed_div1;
1975 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
1976 {
1977 speed_khz = 0;
1978 return retval;
1979 }
1980
1981 cur_speed = jtag_speed = speed_div1;
1982
1983 retval=jtag->speed(cur_speed);
1984 } else
1985 {
1986 hasKHz = 1;
1987 }
1988 } else if (argc==0)
1989 {
1990 } else
1991 {
1992 return ERROR_COMMAND_SYNTAX_ERROR;
1993 }
1994
1995 if (jtag!=NULL)
1996 {
1997 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
1998 return retval;
1999 }
2000
2001 command_print(cmd_ctx, "jtag_khz: %d", speed_khz);
2002 return retval;
2003
2004 }
2005
2006 int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2007 {
2008 enum tap_state state;
2009
2010 if (argc < 1)
2011 {
2012 return ERROR_COMMAND_SYNTAX_ERROR;
2013 }
2014 else
2015 {
2016 for (state = 0; state < 16; state++)
2017 {
2018 if (strcmp(args[0], tap_state_strings[state]) == 0)
2019 {
2020 jtag_add_end_state(state);
2021 jtag_execute_queue();
2022 }
2023 }
2024 }
2025 command_print(cmd_ctx, "current endstate: %s", tap_state_strings[cmd_queue_end_state]);
2026
2027 return ERROR_OK;
2028 }
2029
2030 int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2031 {
2032 int trst = -1;
2033 int srst = -1;
2034
2035 if (argc < 2)
2036 {
2037 return ERROR_COMMAND_SYNTAX_ERROR;
2038 }
2039
2040 if (args[0][0] == '1')
2041 trst = 1;
2042 else if (args[0][0] == '0')
2043 trst = 0;
2044 else
2045 {
2046 return ERROR_COMMAND_SYNTAX_ERROR;
2047 }
2048
2049 if (args[1][0] == '1')
2050 srst = 1;
2051 else if (args[1][0] == '0')
2052 srst = 0;
2053 else
2054 {
2055 return ERROR_COMMAND_SYNTAX_ERROR;
2056 }
2057
2058 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2059 return ERROR_JTAG_INIT_FAILED;
2060
2061 jtag_add_reset(trst, srst);
2062 jtag_execute_queue();
2063
2064 return ERROR_OK;
2065 }
2066
2067 int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2068 {
2069 if (argc < 1)
2070 {
2071 return ERROR_COMMAND_SYNTAX_ERROR;
2072 }
2073
2074 jtag_add_runtest(strtol(args[0], NULL, 0), -1);
2075 jtag_execute_queue();
2076
2077 return ERROR_OK;
2078
2079 }
2080
2081 int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2082 {
2083 int i;
2084 scan_field_t *fields;
2085
2086 if ((argc < 2) || (argc % 2))
2087 {
2088 return ERROR_COMMAND_SYNTAX_ERROR;
2089 }
2090
2091 fields = malloc(sizeof(scan_field_t) * argc / 2);
2092
2093 for (i = 0; i < argc / 2; i++)
2094 {
2095 int device = strtoul(args[i*2], NULL, 0);
2096 int field_size = jtag_get_device(device)->ir_length;
2097 fields[i].device = device;
2098 fields[i].out_value = malloc(CEIL(field_size, 8));
2099 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2100 fields[i].out_mask = NULL;
2101 fields[i].in_value = NULL;
2102 fields[i].in_check_mask = NULL;
2103 fields[i].in_handler = NULL;
2104 fields[i].in_handler_priv = NULL;
2105 }
2106
2107 jtag_add_ir_scan(argc / 2, fields, -1);
2108 jtag_execute_queue();
2109
2110 for (i = 0; i < argc / 2; i++)
2111 free(fields[i].out_value);
2112
2113 free (fields);
2114
2115 return ERROR_OK;
2116 }
2117
2118 int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2119 {
2120 int retval;
2121 scan_field_t *fields;
2122 int num_fields;
2123 int field_count = 0;
2124 int i, e;
2125 long device;
2126
2127 /* args[1] = device
2128 * args[2] = num_bits
2129 * args[3] = hex string
2130 * ... repeat num bits and hex string ...
2131 */
2132 if ((argc < 4) || ((argc % 2)!=0))
2133 {
2134 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2135 return JIM_ERR;
2136 }
2137
2138 for (i = 2; i < argc; i+=2)
2139 {
2140 long bits;
2141
2142 e = Jim_GetLong(interp, args[i], &bits);
2143 if (e != JIM_OK)
2144 return e;
2145 }
2146
2147 e = Jim_GetLong(interp, args[1], &device);
2148 if (e != JIM_OK)
2149 return e;
2150
2151 num_fields=(argc-2)/2;
2152 fields = malloc(sizeof(scan_field_t) * num_fields);
2153 for (i = 2; i < argc; i+=2)
2154 {
2155 long bits;
2156 int len;
2157 const char *str;
2158
2159 Jim_GetLong(interp, args[i], &bits);
2160 str = Jim_GetString(args[i+1], &len);
2161
2162 fields[field_count].device = device;
2163 fields[field_count].num_bits = bits;
2164 fields[field_count].out_value = malloc(CEIL(bits, 8));
2165 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2166 fields[field_count].out_mask = NULL;
2167 fields[field_count].in_value = fields[field_count].out_value;
2168 fields[field_count].in_check_mask = NULL;
2169 fields[field_count].in_check_value = NULL;
2170 fields[field_count].in_handler = NULL;
2171 fields[field_count++].in_handler_priv = NULL;
2172 }
2173
2174 jtag_add_dr_scan(num_fields, fields, -1);
2175 retval = jtag_execute_queue();
2176 if (retval != ERROR_OK)
2177 {
2178 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2179 Jim_AppendStrings(interp, Jim_GetResult(interp), "drscan: jtag execute failed", NULL);
2180 return JIM_ERR;
2181 }
2182
2183 field_count=0;
2184 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2185 for (i = 2; i < argc; i+=2)
2186 {
2187 long bits;
2188 char *str;
2189
2190 Jim_GetLong(interp, args[i], &bits);
2191 str = buf_to_str(fields[field_count].in_value, bits, 16);
2192 free(fields[field_count].out_value);
2193
2194 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2195 free(str);
2196 field_count++;
2197 }
2198
2199 Jim_SetResult(interp, list);
2200
2201 free(fields);
2202
2203 return JIM_OK;
2204 }
2205
2206 int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2207 {
2208 if (argc == 1)
2209 {
2210 if (strcmp(args[0], "enable") == 0)
2211 {
2212 jtag_verify_capture_ir = 1;
2213 }
2214 else if (strcmp(args[0], "disable") == 0)
2215 {
2216 jtag_verify_capture_ir = 0;
2217 } else
2218 {
2219 return ERROR_COMMAND_SYNTAX_ERROR;
2220 }
2221 } else if (argc != 0)
2222 {
2223 return ERROR_COMMAND_SYNTAX_ERROR;
2224 }
2225
2226 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2227
2228 return ERROR_OK;
2229 }
Open On-Chip Debugger

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)