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 int zy1000_read(void);
40 static void zy1000_write(int tck, int tms, int tdi);
41 void zy1000_reset(int trst, int srst);
44 int zy1000_speed(int speed);
45 int zy1000_register_commands(struct command_context_s *cmd_ctx);
46 int zy1000_init(void);
47 int zy1000_quit(void);
49 /* interface commands */
50 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 static int zy1000_khz(int khz, int *jtag_speed)
60 *jtag_speed=64000/khz;
65 static int zy1000_speed_div(int speed, int *khz)
79 static bool readPowerDropout(void)
82 // sample and clear power dropout
83 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x80);
84 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
86 powerDropout = (state & 0x80) != 0;
91 static bool readSRST(void)
94 // sample and clear SRST sensing
95 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x00000040);
96 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
98 srstAsserted = (state & 0x40) != 0;
102 static int zy1000_srst_asserted(int *srst_asserted)
104 *srst_asserted=readSRST();
108 static int zy1000_power_dropout(int *dropout)
110 *dropout=readPowerDropout();
115 jtag_interface_t zy1000_interface =
118 .execute_queue = NULL,
119 .speed = zy1000_speed,
120 .register_commands = zy1000_register_commands,
124 .speed_div = zy1000_speed_div,
125 .power_dropout = zy1000_power_dropout,
126 .srst_asserted = zy1000_srst_asserted,
129 static void zy1000_write(int tck, int tms, int tdi)
134 int zy1000_read(void)
139 extern bool readSRST(void);
141 void zy1000_reset(int trst, int srst)
143 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
146 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
150 /* Danger!!! if clk!=0 when in
151 * idle in TAP_IDLE, reset halt on str912 will fail.
153 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
158 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
163 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
166 if (trst||(srst&&(jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
169 /* we're now in the RESET state until trst is deasserted */
170 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
173 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
174 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
177 /* wait for srst to float back up */
181 for (i=0; i<1000; i++)
183 // We don't want to sense our own reset, so we clear here.
184 // There is of course a timing hole where we could loose
195 LOG_USER("SRST didn't deassert after %dms", i);
198 LOG_USER("SRST took %dms to deassert", i);
203 int zy1000_speed(int speed)
209 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
210 LOG_DEBUG("jtag_speed using RCLK");
214 if(speed > 8190 || speed < 2)
216 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
217 return ERROR_INVALID_ARGUMENTS;
220 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
221 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
222 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
227 static bool savePower;
230 static void setPower(bool power)
235 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
238 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
242 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
246 return ERROR_INVALID_ARGUMENTS;
251 if (strcmp(args[0], "on") == 0)
255 else if (strcmp(args[0], "off") == 0)
260 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
261 return ERROR_INVALID_ARGUMENTS;
265 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
271 /* Give TELNET a way to find out what version this is */
272 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
274 if ((argc < 1) || (argc > 2))
277 const char *version_str=NULL;
281 version_str=ZYLIN_OPENOCD_VERSION;
284 const char *str = Jim_GetString(argv[1], NULL);
285 if (strcmp("openocd", str) == 0)
288 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
289 sprintf(buff, "%d", revision);
292 else if (strcmp("zy1000", str) == 0)
294 version_str=ZYLIN_VERSION;
296 else if (strcmp("date", str) == 0)
298 version_str=ZYLIN_DATE;
306 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
313 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
315 Jim_Obj * const *argv)
319 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
324 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
326 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
331 int zy1000_register_commands(struct command_context_s *cmd_ctx)
333 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
334 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
336 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
339 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
347 int zy1000_init(void)
349 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
351 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
353 setPower(true); // on by default
356 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
358 zy1000_speed(jtag_get_speed());
363 int zy1000_quit(void)
371 int interface_jtag_execute_queue(void)
376 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
377 /* clear JTAG error register */
378 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
380 if ((empty&0x400)!=0)
382 LOG_WARNING("RCLK timeout");
383 /* the error is informative only as we don't want to break the firmware if there
384 * is a false positive.
386 // return ERROR_FAIL;
395 static cyg_uint32 getShiftValue(void)
399 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
400 VERBOSE(LOG_INFO("getShiftValue %08x", value));
404 static cyg_uint32 getShiftValueFlip(void)
408 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
409 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
415 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
417 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
421 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
422 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
423 VERBOSE(getShiftValueFlip());
427 extern int jtag_check_value(uint8_t *captured, void *priv);
429 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
435 for (i = 0; i < num_fields; i++)
439 static uint8_t *in_buff=NULL; /* pointer to buffer for scanned data */
440 static int in_buff_size=0;
441 uint8_t *inBuffer=NULL;
444 // figure out where to store the input data
445 int num_bits=fields[i].num_bits;
446 if (fields[i].in_value!=NULL)
448 inBuffer=fields[i].in_value;
451 // here we shuffle N bits out/in
455 tap_state_t pause_state;
458 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
462 /* we have more to shift out */
463 } else if (i == num_fields-1)
465 /* this was the last to shift out this time */
466 pause_state=end_state;
469 // we have (num_bits+7)/8 bytes of bits to toggle out.
470 // bits are pushed out LSB to MSB
472 if (fields[i].out_value!=NULL)
476 value|=fields[i].out_value[(j+l)/8]<<l;
479 /* mask away unused bits for easier debugging */
480 value&=~(((uint32_t)0xffffffff)<<k);
482 shiftValueInner(shiftState, pause_state, k, value);
486 // data in, LSB to MSB
487 value=getShiftValue();
488 // we're shifting in data to MSB, shift data to be aligned for returning the value
493 inBuffer[(j+l)/8]=(value>>l)&0xff;
501 int interface_jtag_set_end_state(tap_state_t state)
507 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
512 jtag_tap_t *tap, *nextTap;
513 for(tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap=nextTap)
515 nextTap=jtag_tap_next_enabled(tap);
516 tap_state_t end_state;
522 end_state = TAP_IRSHIFT;
527 scan_size = tap->ir_length;
529 /* search the list */
530 for (j=0; j < num_fields; j++)
532 if (tap == fields[j].tap)
536 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
537 /* update device information */
538 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
547 /* if a device isn't listed, set it to BYPASS */
548 uint8_t ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
551 memset(&tmp, 0, sizeof(tmp));
552 tmp.out_value = ones;
553 tmp.num_bits = scan_size;
554 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
555 /* update device information */
556 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
568 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
570 scanFields(num_fields, fields, TAP_IRSHIFT, state);
575 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
577 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
581 jtag_tap_t *tap, *nextTap;
582 for(tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap=nextTap)
584 nextTap=jtag_tap_next_enabled(tap);
586 tap_state_t end_state;
592 end_state = TAP_DRSHIFT;
595 for (j=0; j < num_fields; j++)
597 if (tap == fields[j].tap)
601 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
607 /* program the scan field to 1 bit length, and ignore it's value */
609 tmp.out_value = NULL;
612 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
621 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
623 scanFields(num_fields, fields, TAP_DRSHIFT, state);
628 int interface_jtag_add_tlr()
630 setCurrentState(TAP_RESET);
637 extern int jtag_nsrst_delay;
638 extern int jtag_ntrst_delay;
640 int interface_jtag_add_reset(int req_trst, int req_srst)
642 zy1000_reset(req_trst, req_srst);
646 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
648 /* num_cycles can be 0 */
649 setCurrentState(clockstate);
651 /* execute num_cycles, 32 at the time. */
653 for (i=0; i<num_cycles; i+=32)
657 if (num_cycles-i<num)
661 shiftValueInner(clockstate, clockstate, num, 0);
665 /* finish in end_state */
666 setCurrentState(state);
668 tap_state_t t=TAP_IDLE;
669 /* test manual drive code on any target */
671 uint8_t tms_scan = tap_get_tms_path(t, state);
672 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
674 for (i = 0; i < tms_count; i++)
676 tms = (tms_scan >> i) & 1;
678 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
681 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
688 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
690 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
693 int interface_jtag_add_clocks(int num_cycles)
695 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_cur_state);
698 int interface_jtag_add_sleep(uint32_t us)
704 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
709 /*wait for the fifo to be empty*/
714 tap_state_t cur_state=cmd_queue_cur_state;
718 if (tap_state_transition(cur_state, false) == path[state_count])
722 else if (tap_state_transition(cur_state, true) == path[state_count])
728 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
733 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
735 cur_state = path[state_count];
741 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
747 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, uint8_t *buffer, int little, int count)
749 // static int const reg_addr=0x5;
750 tap_state_t end_state=jtag_get_end_state();
751 if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL))==NULL)
753 /* better performance via code duplication */
757 for (i = 0; i < count; i++)
759 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
760 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
766 for (i = 0; i < count; i++)
768 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
769 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
777 for (i = 0; i < count; i++)
779 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));