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
36 const char *zylin_config_dir="/config/settings";
38 /* low level command set
40 int zy1000_read(void);
41 static void zy1000_write(int tck, int tms, int tdi);
42 void zy1000_reset(int trst, int srst);
45 int zy1000_speed(int speed);
46 int zy1000_register_commands(struct command_context_s *cmd_ctx);
47 int zy1000_init(void);
48 int zy1000_quit(void);
50 /* interface commands */
51 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 static int zy1000_khz(int khz, int *jtag_speed)
61 *jtag_speed=64000/khz;
66 static int zy1000_speed_div(int speed, int *khz)
80 static bool readPowerDropout(void)
83 // sample and clear power dropout
84 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x80);
85 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
87 powerDropout = (state & 0x80) != 0;
92 static bool readSRST(void)
95 // sample and clear SRST sensing
96 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x00000040);
97 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
99 srstAsserted = (state & 0x40) != 0;
103 static int zy1000_srst_asserted(int *srst_asserted)
105 *srst_asserted=readSRST();
109 static int zy1000_power_dropout(int *dropout)
111 *dropout=readPowerDropout();
116 jtag_interface_t zy1000_interface =
119 .execute_queue = NULL,
120 .speed = zy1000_speed,
121 .register_commands = zy1000_register_commands,
125 .speed_div = zy1000_speed_div,
126 .power_dropout = zy1000_power_dropout,
127 .srst_asserted = zy1000_srst_asserted,
130 static void zy1000_write(int tck, int tms, int tdi)
135 int zy1000_read(void)
140 extern bool readSRST(void);
142 void zy1000_reset(int trst, int srst)
144 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
147 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
151 /* Danger!!! if clk!=0 when in
152 * idle in TAP_IDLE, reset halt on str912 will fail.
154 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
159 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
164 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
167 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
170 /* we're now in the RESET state until trst is deasserted */
171 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
174 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
175 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
178 /* wait for srst to float back up */
182 for (i=0; i<1000; i++)
184 // We don't want to sense our own reset, so we clear here.
185 // There is of course a timing hole where we could loose
196 LOG_USER("SRST didn't deassert after %dms", i);
199 LOG_USER("SRST took %dms to deassert", i);
204 int zy1000_speed(int speed)
210 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
211 LOG_DEBUG("jtag_speed using RCLK");
215 if(speed > 8190 || speed < 2)
217 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
218 return ERROR_INVALID_ARGUMENTS;
221 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
222 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
223 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
228 static bool savePower;
231 static void setPower(bool power)
236 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
239 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
243 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
247 return ERROR_INVALID_ARGUMENTS;
252 if (strcmp(args[0], "on") == 0)
256 else if (strcmp(args[0], "off") == 0)
261 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
262 return ERROR_INVALID_ARGUMENTS;
266 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
272 /* Give TELNET a way to find out what version this is */
273 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
275 if ((argc < 1) || (argc > 2))
278 const char *version_str=NULL;
282 version_str=ZYLIN_OPENOCD_VERSION;
285 const char *str = Jim_GetString(argv[1], NULL);
286 if (strcmp("openocd", str) == 0)
289 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
290 sprintf(buff, "%d", revision);
293 else if (strcmp("zy1000", str) == 0)
295 version_str=ZYLIN_VERSION;
297 else if (strcmp("date", str) == 0)
299 version_str=ZYLIN_DATE;
307 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
314 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
316 Jim_Obj * const *argv)
320 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
325 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
327 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
332 int zy1000_register_commands(struct command_context_s *cmd_ctx)
334 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
335 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
337 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
340 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
348 int zy1000_init(void)
350 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
352 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
354 setPower(true); // on by default
357 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
359 zy1000_speed(jtag_get_speed());
364 int zy1000_quit(void)
372 int interface_jtag_execute_queue(void)
377 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
378 /* clear JTAG error register */
379 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
381 if ((empty&0x400)!=0)
383 LOG_WARNING("RCLK timeout");
384 /* the error is informative only as we don't want to break the firmware if there
385 * is a false positive.
387 // return ERROR_FAIL;
396 static cyg_uint32 getShiftValue(void)
400 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
401 VERBOSE(LOG_INFO("getShiftValue %08x", value));
405 static cyg_uint32 getShiftValueFlip(void)
409 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
410 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
416 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
418 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
422 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
423 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
424 VERBOSE(getShiftValueFlip());
428 extern int jtag_check_value(u8 *captured, void *priv);
430 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
436 for (i = 0; i < num_fields; i++)
440 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
441 static int in_buff_size=0;
445 // figure out where to store the input data
446 int num_bits=fields[i].num_bits;
447 if (fields[i].in_value!=NULL)
449 inBuffer=fields[i].in_value;
452 // here we shuffle N bits out/in
456 tap_state_t pause_state;
459 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
463 /* we have more to shift out */
464 } else if (i == num_fields-1)
466 /* this was the last to shift out this time */
467 pause_state=end_state;
470 // we have (num_bits+7)/8 bytes of bits to toggle out.
471 // bits are pushed out LSB to MSB
473 if (fields[i].out_value!=NULL)
477 value|=fields[i].out_value[(j+l)/8]<<l;
480 /* mask away unused bits for easier debugging */
481 value&=~(((u32)0xffffffff)<<k);
483 shiftValueInner(shiftState, pause_state, k, value);
487 // data in, LSB to MSB
488 value=getShiftValue();
489 // we're shifting in data to MSB, shift data to be aligned for returning the value
494 inBuffer[(j+l)/8]=(value>>l)&0xff;
502 int interface_jtag_set_end_state(tap_state_t state)
508 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
513 jtag_tap_t *tap, *nextTap;
514 for(tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap=nextTap)
516 nextTap=jtag_tap_next_enabled(tap);
517 tap_state_t end_state;
523 end_state = TAP_IRSHIFT;
528 scan_size = tap->ir_length;
530 /* search the list */
531 for (j=0; j < num_fields; j++)
533 if (tap == fields[j].tap)
537 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
538 /* update device information */
539 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
548 /* if a device isn't listed, set it to BYPASS */
549 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
552 memset(&tmp, 0, sizeof(tmp));
553 tmp.out_value = ones;
554 tmp.num_bits = scan_size;
555 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
556 /* update device information */
557 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
569 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
571 scanFields(num_fields, fields, TAP_IRSHIFT, state);
576 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
578 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
582 jtag_tap_t *tap, *nextTap;
583 for(tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap=nextTap)
585 nextTap=jtag_tap_next_enabled(tap);
587 tap_state_t end_state;
593 end_state = TAP_DRSHIFT;
596 for (j=0; j < num_fields; j++)
598 if (tap == fields[j].tap)
602 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
608 /* program the scan field to 1 bit length, and ignore it's value */
610 tmp.out_value = NULL;
613 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
622 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
624 scanFields(num_fields, fields, TAP_DRSHIFT, state);
629 int interface_jtag_add_tlr()
631 setCurrentState(TAP_RESET);
638 extern int jtag_nsrst_delay;
639 extern int jtag_ntrst_delay;
641 int interface_jtag_add_reset(int req_trst, int req_srst)
643 zy1000_reset(req_trst, req_srst);
647 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
649 /* num_cycles can be 0 */
650 setCurrentState(clockstate);
652 /* execute num_cycles, 32 at the time. */
654 for (i=0; i<num_cycles; i+=32)
658 if (num_cycles-i<num)
662 shiftValueInner(clockstate, clockstate, num, 0);
666 /* finish in end_state */
667 setCurrentState(state);
669 tap_state_t t=TAP_IDLE;
670 /* test manual drive code on any target */
672 u8 tms_scan = tap_get_tms_path(t, state);
673 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
675 for (i = 0; i < tms_count; i++)
677 tms = (tms_scan >> i) & 1;
679 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
682 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
689 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
691 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
694 int interface_jtag_add_clocks(int num_cycles)
696 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_cur_state);
699 int interface_jtag_add_sleep(u32 us)
705 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
710 /*wait for the fifo to be empty*/
715 tap_state_t cur_state=cmd_queue_cur_state;
719 if (tap_state_transition(cur_state, false) == path[state_count])
723 else if (tap_state_transition(cur_state, true) == path[state_count])
729 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
734 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
736 cur_state = path[state_count];
742 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
748 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
750 // static int const reg_addr=0x5;
751 tap_state_t end_state=jtag_get_end_state();
752 if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL))==NULL)
754 /* better performance via code duplication */
758 for (i = 0; i < count; i++)
760 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
761 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
767 for (i = 0; i < count; i++)
769 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
770 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
778 for (i = 0; i < count; i++)
780 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
786 int loadFile(const char *fileName, void **data, int *len);
788 /* boolean parameter stored on config */
789 int boolParam(char *var)
792 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
798 if (loadFile(name, &data, &len) == ERROR_OK)
802 result = strncmp((char *) data, "1", len) == 0;