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 ***************************************************************************/
27 #include "../target/embeddedice.h"
30 #include <cyg/hal/hal_io.h> // low level i/o
31 #include <cyg/hal/hal_diag.h>
35 #define ZYLIN_VERSION "1.51"
36 #define ZYLIN_DATE __DATE__
37 #define ZYLIN_TIME __TIME__
38 #define ZYLIN_OPENOCD "$Revision$"
39 #define ZYLIN_OPENOCD_VERSION "Zylin JTAG ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE " " ZYLIN_TIME
40 const char *zylin_config_dir="/config/settings";
42 /* low level command set
44 int zy1000_read(void);
45 static void zy1000_write(int tck, int tms, int tdi);
46 void zy1000_reset(int trst, int srst);
49 int zy1000_speed(int speed);
50 int zy1000_register_commands(struct command_context_s *cmd_ctx);
51 int zy1000_init(void);
52 int zy1000_quit(void);
54 /* interface commands */
55 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
57 static int zy1000_khz(int khz, int *jtag_speed)
65 *jtag_speed=64000/khz;
70 static int zy1000_speed_div(int speed, int *khz)
84 static bool readPowerDropout(void)
87 // sample and clear power dropout
88 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x80);
89 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
91 powerDropout = (state & 0x80) != 0;
96 static bool readSRST(void)
99 // sample and clear SRST sensing
100 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x00000040);
101 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
103 srstAsserted = (state & 0x40) != 0;
107 static int zy1000_srst_asserted(int *srst_asserted)
109 *srst_asserted=readSRST();
113 static int zy1000_power_dropout(int *dropout)
115 *dropout=readPowerDropout();
120 jtag_interface_t zy1000_interface =
123 .execute_queue = bitbang_execute_queue,
124 .speed = zy1000_speed,
125 .register_commands = zy1000_register_commands,
129 .speed_div = zy1000_speed_div,
130 .power_dropout = zy1000_power_dropout,
131 .srst_asserted = zy1000_srst_asserted,
134 bitbang_interface_t zy1000_bitbang =
137 .write = zy1000_write,
138 .reset = zy1000_reset
143 static void zy1000_write(int tck, int tms, int tdi)
148 int zy1000_read(void)
153 extern bool readSRST(void);
155 void zy1000_reset(int trst, int srst)
157 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
160 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
164 /* Danger!!! if clk!=0 when in
165 * idle in TAP_IDLE, reset halt on str912 will fail.
167 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
172 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
177 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
180 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
183 /* we're now in the RESET state until trst is deasserted */
184 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
187 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
188 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
191 /* wait for srst to float back up */
195 for (i=0; i<1000; i++)
197 // We don't want to sense our own reset, so we clear here.
198 // There is of course a timing hole where we could loose
209 LOG_USER("SRST didn't deassert after %dms", i);
212 LOG_USER("SRST took %dms to deassert", i);
217 int zy1000_speed(int speed)
223 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
224 LOG_DEBUG("jtag_speed using RCLK");
228 if(speed > 8190 || speed < 2)
230 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
231 return ERROR_INVALID_ARGUMENTS;
234 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
235 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
236 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
241 static bool savePower;
244 static void setPower(bool power)
249 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
252 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
256 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
260 return ERROR_INVALID_ARGUMENTS;
265 if (strcmp(args[0], "on") == 0)
269 else if (strcmp(args[0], "off") == 0)
274 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
275 return ERROR_INVALID_ARGUMENTS;
279 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
285 /* Give TELNET a way to find out what version this is */
286 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
288 if ((argc < 1) || (argc > 2))
291 const char *version_str=NULL;
295 version_str=ZYLIN_OPENOCD_VERSION;
298 const char *str = Jim_GetString(argv[1], NULL);
299 if (strcmp("openocd", str) == 0)
302 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
303 sprintf(buff, "%d", revision);
306 else if (strcmp("zy1000", str) == 0)
308 version_str=ZYLIN_VERSION;
310 else if (strcmp("date", str) == 0)
312 version_str=ZYLIN_DATE;
320 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
327 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
329 Jim_Obj * const *argv)
333 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
338 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
340 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
345 int zy1000_register_commands(struct command_context_s *cmd_ctx)
347 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
348 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
350 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
353 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
361 int zy1000_init(void)
363 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
365 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
367 setPower(true); // on by default
370 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
372 zy1000_speed(jtag_speed);
374 bitbang_interface = &zy1000_bitbang;
379 int zy1000_quit(void)
388 int interface_jtag_execute_queue(void)
393 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
394 /* clear JTAG error register */
395 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
397 if ((empty&0x400)!=0)
399 LOG_WARNING("RCLK timeout");
400 /* the error is informative only as we don't want to break the firmware if there
401 * is a false positive.
403 // return ERROR_FAIL;
412 static cyg_uint32 getShiftValue(void)
416 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
417 VERBOSE(LOG_INFO("getShiftValue %08x", value));
421 static cyg_uint32 getShiftValueFlip(void)
425 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
426 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
432 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
434 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
438 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
439 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
440 VERBOSE(getShiftValueFlip());
444 extern int jtag_check_value(u8 *captured, void *priv);
446 static void gotoEndState(void)
448 setCurrentState(cmd_queue_end_state);
451 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
457 for (i = 0; i < num_fields; i++)
461 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
462 static int in_buff_size=0;
466 // figure out where to store the input data
467 int num_bits=fields[i].num_bits;
468 if (fields[i].in_value!=NULL)
470 inBuffer=fields[i].in_value;
473 // here we shuffle N bits out/in
477 tap_state_t pause_state;
480 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
484 /* we have more to shift out */
485 } else if (i == num_fields-1)
487 /* this was the last to shift out this time */
488 pause_state=end_state;
491 // we have (num_bits+7)/8 bytes of bits to toggle out.
492 // bits are pushed out LSB to MSB
494 if (fields[i].out_value!=NULL)
498 value|=fields[i].out_value[(j+l)/8]<<l;
501 /* mask away unused bits for easier debugging */
502 value&=~(((u32)0xffffffff)<<k);
504 shiftValueInner(shiftState, pause_state, k, value);
508 // data in, LSB to MSB
509 value=getShiftValue();
510 // we're shifting in data to MSB, shift data to be aligned for returning the value
515 inBuffer[(j+l)/8]=(value>>l)&0xff;
523 int interface_jtag_add_end_state(tap_state_t state)
529 int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
534 jtag_tap_t *tap, *nextTap;
535 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
537 nextTap=jtag_NextEnabledTap(tap);
538 tap_state_t end_state;
541 end_state = cmd_queue_end_state;
544 end_state = TAP_IRSHIFT;
549 scan_size = tap->ir_length;
551 /* search the list */
552 for (j=0; j < num_fields; j++)
554 if (tap == fields[j].tap)
558 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
559 /* update device information */
560 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
569 /* if a device isn't listed, set it to BYPASS */
570 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
573 memset(&tmp, 0, sizeof(tmp));
574 tmp.out_value = ones;
575 tmp.num_bits = scan_size;
576 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
577 /* update device information */
578 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
590 int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
592 scanFields(num_fields, fields, TAP_IRSHIFT, cmd_queue_end_state);
597 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
599 int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
603 jtag_tap_t *tap, *nextTap;
604 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
606 nextTap=jtag_NextEnabledTap(tap);
608 tap_state_t end_state;
611 end_state = cmd_queue_end_state;
614 end_state = TAP_DRSHIFT;
617 for (j=0; j < num_fields; j++)
619 if (tap == fields[j].tap)
623 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
629 /* program the scan field to 1 bit length, and ignore it's value */
631 tmp.out_value = NULL;
634 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
643 int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
645 scanFields(num_fields, fields, TAP_DRSHIFT, cmd_queue_end_state);
650 int interface_jtag_add_tlr()
652 setCurrentState(TAP_RESET);
659 extern int jtag_nsrst_delay;
660 extern int jtag_ntrst_delay;
662 int interface_jtag_add_reset(int req_trst, int req_srst)
664 zy1000_reset(req_trst, req_srst);
668 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
670 /* num_cycles can be 0 */
671 setCurrentState(clockstate);
673 /* execute num_cycles, 32 at the time. */
675 for (i=0; i<num_cycles; i+=32)
679 if (num_cycles-i<num)
683 shiftValueInner(clockstate, clockstate, num, 0);
687 /* finish in end_state */
688 setCurrentState(state);
690 tap_state_t t=TAP_IDLE;
691 /* test manual drive code on any target */
693 u8 tms_scan = tap_get_tms_path(t, state);
695 for (i = 0; i < 7; i++)
697 tms = (tms_scan >> i) & 1;
699 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
702 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
709 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
711 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
714 int interface_jtag_add_clocks(int num_cycles)
716 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_end_state);
719 int interface_jtag_add_sleep(u32 us)
725 int interface_jtag_add_pathmove(int num_states, tap_state_t *path)
730 /*wait for the fifo to be empty*/
735 tap_state_t cur_state=cmd_queue_cur_state;
739 if (tap_state_transition(cur_state, false) == path[state_count])
743 else if (tap_state_transition(cur_state, true) == path[state_count])
749 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
754 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
756 cur_state = path[state_count];
762 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
768 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
770 // static int const reg_addr=0x5;
771 tap_state_t end_state=cmd_queue_end_state;
772 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL))==NULL)
774 /* better performance via code duplication */
778 for (i = 0; i < count; i++)
780 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
781 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
787 for (i = 0; i < count; i++)
789 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
790 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
798 for (i = 0; i < count; i++)
800 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
806 int loadFile(const char *fileName, void **data, int *len);
808 /* boolean parameter stored on config */
809 int boolParam(char *var)
812 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
818 if (loadFile(name, &data, &len) == ERROR_OK)
822 result = strncmp((char *) data, "1", len) == 0;