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 #define INCLUDE_JTAG_MINIDRIVER_H
24 #include "embeddedice.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 = bitbang_execute_queue,
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 bitbang_interface_t zy1000_bitbang =
133 .write = zy1000_write,
134 .reset = zy1000_reset
139 static void zy1000_write(int tck, int tms, int tdi)
144 int zy1000_read(void)
149 extern bool readSRST(void);
151 void zy1000_reset(int trst, int srst)
153 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
156 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
160 /* Danger!!! if clk!=0 when in
161 * idle in TAP_IDLE, reset halt on str912 will fail.
163 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
168 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
173 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
176 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
179 /* we're now in the RESET state until trst is deasserted */
180 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
183 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
184 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
187 /* wait for srst to float back up */
191 for (i=0; i<1000; i++)
193 // We don't want to sense our own reset, so we clear here.
194 // There is of course a timing hole where we could loose
205 LOG_USER("SRST didn't deassert after %dms", i);
208 LOG_USER("SRST took %dms to deassert", i);
213 int zy1000_speed(int speed)
219 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
220 LOG_DEBUG("jtag_speed using RCLK");
224 if(speed > 8190 || speed < 2)
226 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
227 return ERROR_INVALID_ARGUMENTS;
230 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
231 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
232 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
237 static bool savePower;
240 static void setPower(bool power)
245 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
248 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
252 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
256 return ERROR_INVALID_ARGUMENTS;
261 if (strcmp(args[0], "on") == 0)
265 else if (strcmp(args[0], "off") == 0)
270 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
271 return ERROR_INVALID_ARGUMENTS;
275 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
281 /* Give TELNET a way to find out what version this is */
282 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
284 if ((argc < 1) || (argc > 2))
287 const char *version_str=NULL;
291 version_str=ZYLIN_OPENOCD_VERSION;
294 const char *str = Jim_GetString(argv[1], NULL);
295 if (strcmp("openocd", str) == 0)
298 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
299 sprintf(buff, "%d", revision);
302 else if (strcmp("zy1000", str) == 0)
304 version_str=ZYLIN_VERSION;
306 else if (strcmp("date", str) == 0)
308 version_str=ZYLIN_DATE;
316 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
323 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
325 Jim_Obj * const *argv)
329 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
334 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
336 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
341 int zy1000_register_commands(struct command_context_s *cmd_ctx)
343 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
344 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
346 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
349 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
357 int zy1000_init(void)
359 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
361 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
363 setPower(true); // on by default
366 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
368 zy1000_speed(jtag_speed);
370 bitbang_interface = &zy1000_bitbang;
375 int zy1000_quit(void)
384 int interface_jtag_execute_queue(void)
389 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
390 /* clear JTAG error register */
391 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
393 if ((empty&0x400)!=0)
395 LOG_WARNING("RCLK timeout");
396 /* the error is informative only as we don't want to break the firmware if there
397 * is a false positive.
399 // return ERROR_FAIL;
408 static cyg_uint32 getShiftValue(void)
412 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
413 VERBOSE(LOG_INFO("getShiftValue %08x", value));
417 static cyg_uint32 getShiftValueFlip(void)
421 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
422 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
428 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
430 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
434 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
435 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
436 VERBOSE(getShiftValueFlip());
440 extern int jtag_check_value(u8 *captured, void *priv);
442 static void gotoEndState(void)
444 setCurrentState(cmd_queue_end_state);
447 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
453 for (i = 0; i < num_fields; i++)
457 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
458 static int in_buff_size=0;
462 // figure out where to store the input data
463 int num_bits=fields[i].num_bits;
464 if (fields[i].in_value!=NULL)
466 inBuffer=fields[i].in_value;
469 // here we shuffle N bits out/in
473 tap_state_t pause_state;
476 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
480 /* we have more to shift out */
481 } else if (i == num_fields-1)
483 /* this was the last to shift out this time */
484 pause_state=end_state;
487 // we have (num_bits+7)/8 bytes of bits to toggle out.
488 // bits are pushed out LSB to MSB
490 if (fields[i].out_value!=NULL)
494 value|=fields[i].out_value[(j+l)/8]<<l;
497 /* mask away unused bits for easier debugging */
498 value&=~(((u32)0xffffffff)<<k);
500 shiftValueInner(shiftState, pause_state, k, value);
504 // data in, LSB to MSB
505 value=getShiftValue();
506 // we're shifting in data to MSB, shift data to be aligned for returning the value
511 inBuffer[(j+l)/8]=(value>>l)&0xff;
519 int interface_jtag_add_end_state(tap_state_t state)
525 int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
530 jtag_tap_t *tap, *nextTap;
531 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
533 nextTap=jtag_NextEnabledTap(tap);
534 tap_state_t end_state;
537 end_state = cmd_queue_end_state;
540 end_state = TAP_IRSHIFT;
545 scan_size = tap->ir_length;
547 /* search the list */
548 for (j=0; j < num_fields; j++)
550 if (tap == fields[j].tap)
554 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
555 /* update device information */
556 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
565 /* if a device isn't listed, set it to BYPASS */
566 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
569 memset(&tmp, 0, sizeof(tmp));
570 tmp.out_value = ones;
571 tmp.num_bits = scan_size;
572 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
573 /* update device information */
574 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
586 int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
588 scanFields(num_fields, fields, TAP_IRSHIFT, cmd_queue_end_state);
593 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
595 int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
599 jtag_tap_t *tap, *nextTap;
600 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
602 nextTap=jtag_NextEnabledTap(tap);
604 tap_state_t end_state;
607 end_state = cmd_queue_end_state;
610 end_state = TAP_DRSHIFT;
613 for (j=0; j < num_fields; j++)
615 if (tap == fields[j].tap)
619 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
625 /* program the scan field to 1 bit length, and ignore it's value */
627 tmp.out_value = NULL;
630 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
639 int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
641 scanFields(num_fields, fields, TAP_DRSHIFT, cmd_queue_end_state);
646 int interface_jtag_add_tlr()
648 setCurrentState(TAP_RESET);
655 extern int jtag_nsrst_delay;
656 extern int jtag_ntrst_delay;
658 int interface_jtag_add_reset(int req_trst, int req_srst)
660 zy1000_reset(req_trst, req_srst);
664 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
666 /* num_cycles can be 0 */
667 setCurrentState(clockstate);
669 /* execute num_cycles, 32 at the time. */
671 for (i=0; i<num_cycles; i+=32)
675 if (num_cycles-i<num)
679 shiftValueInner(clockstate, clockstate, num, 0);
683 /* finish in end_state */
684 setCurrentState(state);
686 tap_state_t t=TAP_IDLE;
687 /* test manual drive code on any target */
689 u8 tms_scan = tap_get_tms_path(t, state);
690 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
692 for (i = 0; i < tms_count; i++)
694 tms = (tms_scan >> i) & 1;
696 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
699 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
706 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
708 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
711 int interface_jtag_add_clocks(int num_cycles)
713 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_end_state);
716 int interface_jtag_add_sleep(u32 us)
722 int interface_jtag_add_pathmove(int num_states, tap_state_t *path)
727 /*wait for the fifo to be empty*/
732 tap_state_t cur_state=cmd_queue_cur_state;
736 if (tap_state_transition(cur_state, false) == path[state_count])
740 else if (tap_state_transition(cur_state, true) == path[state_count])
746 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
751 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
753 cur_state = path[state_count];
759 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
765 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
767 // static int const reg_addr=0x5;
768 tap_state_t end_state=cmd_queue_end_state;
769 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL))==NULL)
771 /* better performance via code duplication */
775 for (i = 0; i < count; i++)
777 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
778 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
784 for (i = 0; i < count; i++)
786 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
787 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
795 for (i = 0; i < count; i++)
797 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
803 int loadFile(const char *fileName, void **data, int *len);
805 /* boolean parameter stored on config */
806 int boolParam(char *var)
809 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
815 if (loadFile(name, &data, &len) == ERROR_OK)
819 result = strncmp((char *) data, "1", len) == 0;