1 /***************************************************************************
2 * Copyright (C) 2007-2008 by Øyvind Harboe *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
18 ***************************************************************************/
23 #include "embeddedice.h"
24 #include "minidriver.h"
25 #include "interface.h"
27 #include <cyg/hal/hal_io.h> // low level i/o
28 #include <cyg/hal/hal_diag.h>
31 #define ZYLIN_VERSION "1.52"
32 #define ZYLIN_DATE __DATE__
33 #define ZYLIN_TIME __TIME__
34 #define ZYLIN_OPENOCD "$Revision$"
35 #define ZYLIN_OPENOCD_VERSION "Zylin JTAG ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE " " ZYLIN_TIME
37 /* low level command set
39 void zy1000_reset(int trst, int srst);
42 int zy1000_speed(int speed);
43 int zy1000_register_commands(struct command_context_s *cmd_ctx);
44 int zy1000_init(void);
45 int zy1000_quit(void);
47 /* interface commands */
48 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 static int zy1000_khz(int khz, int *jtag_speed)
58 *jtag_speed = 64000/khz;
63 static int zy1000_speed_div(int speed, int *khz)
77 static bool readPowerDropout(void)
80 // sample and clear power dropout
81 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x80);
82 HAL_READ_UINT32(ZY1000_JTAG_BASE + 0x10, state);
84 powerDropout = (state & 0x80) != 0;
89 static bool readSRST(void)
92 // sample and clear SRST sensing
93 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x00000040);
94 HAL_READ_UINT32(ZY1000_JTAG_BASE + 0x10, state);
96 srstAsserted = (state & 0x40) != 0;
100 static int zy1000_srst_asserted(int *srst_asserted)
102 *srst_asserted = readSRST();
106 static int zy1000_power_dropout(int *dropout)
108 *dropout = readPowerDropout();
113 jtag_interface_t zy1000_interface =
116 .execute_queue = NULL,
117 .speed = zy1000_speed,
118 .register_commands = zy1000_register_commands,
122 .speed_div = zy1000_speed_div,
123 .power_dropout = zy1000_power_dropout,
124 .srst_asserted = zy1000_srst_asserted,
127 void zy1000_reset(int trst, int srst)
129 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
132 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000001);
136 /* Danger!!! if clk != 0 when in
137 * idle in TAP_IDLE, reset halt on str912 will fail.
139 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000001);
144 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000002);
149 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000002);
152 if (trst||(srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
155 /* we're now in the RESET state until trst is deasserted */
156 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_RESET);
159 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
160 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
163 /* wait for srst to float back up */
167 for (i = 0; i<1000; i++)
169 // We don't want to sense our own reset, so we clear here.
170 // There is of course a timing hole where we could loose
181 LOG_USER("SRST didn't deassert after %dms", i);
184 LOG_USER("SRST took %dms to deassert", i);
189 int zy1000_speed(int speed)
195 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x100);
196 LOG_DEBUG("jtag_speed using RCLK");
200 if (speed > 8190 || speed < 2)
202 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
203 return ERROR_INVALID_ARGUMENTS;
206 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
207 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x100);
208 ZY1000_POKE(ZY1000_JTAG_BASE + 0x1c, speed&~1);
213 static bool savePower;
216 static void setPower(bool power)
221 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x14, 0x8);
224 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x8);
228 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
232 return ERROR_INVALID_ARGUMENTS;
237 if (strcmp(args[0], "on") == 0)
241 else if (strcmp(args[0], "off") == 0)
246 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
247 return ERROR_INVALID_ARGUMENTS;
251 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
257 /* Give TELNET a way to find out what version this is */
258 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
260 if ((argc < 1) || (argc > 2))
263 const char *version_str = NULL;
267 version_str = ZYLIN_OPENOCD_VERSION;
270 const char *str = Jim_GetString(argv[1], NULL);
271 if (strcmp("openocd", str) == 0)
274 revision = atol(ZYLIN_OPENOCD + strlen("XRevision: "));
275 sprintf(buff, "%d", revision);
278 else if (strcmp("zy1000", str) == 0)
280 version_str = ZYLIN_VERSION;
282 else if (strcmp("date", str) == 0)
284 version_str = ZYLIN_DATE;
292 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
299 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
301 Jim_Obj * const *argv)
305 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
310 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, status);
312 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80) != 0));
317 int zy1000_register_commands(struct command_context_s *cmd_ctx)
319 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
320 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
322 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
325 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
333 int zy1000_init(void)
335 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
337 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x30); // Turn on LED1 & LED2
339 setPower(true); // on by default
342 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
344 zy1000_speed(jtag_get_speed());
349 int zy1000_quit(void)
357 int interface_jtag_execute_queue(void)
362 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
363 /* clear JTAG error register */
364 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
366 if ((empty&0x400) != 0)
368 LOG_WARNING("RCLK timeout");
369 /* the error is informative only as we don't want to break the firmware if there
370 * is a false positive.
372 // return ERROR_FAIL;
381 static cyg_uint32 getShiftValue(void)
385 ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, value);
386 VERBOSE(LOG_INFO("getShiftValue %08x", value));
390 static cyg_uint32 getShiftValueFlip(void)
394 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x18, value);
395 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
401 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
403 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
407 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
408 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 15)|(repeat << 8)|(a << 4)|b);
409 VERBOSE(getShiftValueFlip());
413 extern int jtag_check_value(uint8_t *captured, void *priv);
415 static __inline void scanFields(int num_fields, const scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
421 for (i = 0; i < num_fields; i++)
425 uint8_t *inBuffer = NULL;
428 // figure out where to store the input data
429 int num_bits = fields[i].num_bits;
430 if (fields[i].in_value != NULL)
432 inBuffer = fields[i].in_value;
435 // here we shuffle N bits out/in
439 tap_state_t pause_state;
442 pause_state = (shiftState == TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
446 /* we have more to shift out */
447 } else if (i == num_fields-1)
449 /* this was the last to shift out this time */
450 pause_state = end_state;
453 // we have (num_bits + 7)/8 bytes of bits to toggle out.
454 // bits are pushed out LSB to MSB
456 if (fields[i].out_value != NULL)
458 for (l = 0; l<k; l += 8)
460 value|=fields[i].out_value[(j + l)/8]<<l;
463 /* mask away unused bits for easier debugging */
464 value&=~(((uint32_t)0xffffffff) << k);
466 shiftValueInner(shiftState, pause_state, k, value);
468 if (inBuffer != NULL)
470 // data in, LSB to MSB
471 value = getShiftValue();
472 // we're shifting in data to MSB, shift data to be aligned for returning the value
475 for (l = 0; l<k; l += 8)
477 inBuffer[(j + l)/8]=(value >> l)&0xff;
485 int interface_jtag_set_end_state(tap_state_t state)
491 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
496 jtag_tap_t *tap, *nextTap;
497 for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
499 nextTap = jtag_tap_next_enabled(tap);
500 tap_state_t end_state;
506 end_state = TAP_IRSHIFT;
511 scan_size = tap->ir_length;
513 /* search the list */
514 for (j = 0; j < num_fields; j++)
516 if (tap == fields[j].tap)
520 scanFields(1, fields + j, TAP_IRSHIFT, end_state);
521 /* update device information */
522 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
531 /* if a device isn't listed, set it to BYPASS */
532 uint8_t ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
535 memset(&tmp, 0, sizeof(tmp));
536 tmp.out_value = ones;
537 tmp.num_bits = scan_size;
538 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
539 /* update device information */
540 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
552 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
554 scanFields(num_fields, fields, TAP_IRSHIFT, state);
559 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
561 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
565 jtag_tap_t *tap, *nextTap;
566 for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
568 nextTap = jtag_tap_next_enabled(tap);
570 tap_state_t end_state;
576 end_state = TAP_DRSHIFT;
579 for (j = 0; j < num_fields; j++)
581 if (tap == fields[j].tap)
585 scanFields(1, fields + j, TAP_DRSHIFT, end_state);
591 /* program the scan field to 1 bit length, and ignore it's value */
593 tmp.out_value = NULL;
596 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
605 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
607 scanFields(num_fields, fields, TAP_DRSHIFT, state);
612 int interface_jtag_add_tlr()
614 setCurrentState(TAP_RESET);
621 extern int jtag_nsrst_delay;
622 extern int jtag_ntrst_delay;
624 int interface_jtag_add_reset(int req_trst, int req_srst)
626 zy1000_reset(req_trst, req_srst);
630 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
632 /* num_cycles can be 0 */
633 setCurrentState(clockstate);
635 /* execute num_cycles, 32 at the time. */
637 for (i = 0; i<num_cycles; i += 32)
641 if (num_cycles-i<num)
645 shiftValueInner(clockstate, clockstate, num, 0);
649 /* finish in end_state */
650 setCurrentState(state);
652 tap_state_t t = TAP_IDLE;
653 /* test manual drive code on any target */
655 uint8_t tms_scan = tap_get_tms_path(t, state);
656 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
658 for (i = 0; i < tms_count; i++)
660 tms = (tms_scan >> i) & 1;
662 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, tms);
665 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, state);
672 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
674 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
677 int interface_jtag_add_clocks(int num_cycles)
679 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_cur_state);
682 int interface_jtag_add_sleep(uint32_t us)
688 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
693 /*wait for the fifo to be empty*/
698 tap_state_t cur_state = cmd_queue_cur_state;
702 if (tap_state_transition(cur_state, false) == path[state_count])
706 else if (tap_state_transition(cur_state, true) == path[state_count])
712 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
717 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, tms);
719 cur_state = path[state_count];
725 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, cur_state);
731 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, uint8_t *buffer, int little, int count)
733 // static int const reg_addr = 0x5;
734 tap_state_t end_state = jtag_get_end_state();
735 if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL)
737 /* better performance via code duplication */
741 for (i = 0; i < count; i++)
743 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
744 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1 << 5));
750 for (i = 0; i < count; i++)
752 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
753 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1 << 5));
761 for (i = 0; i < count; i++)
763 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));