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"
26 #include <cyg/hal/hal_io.h> // low level i/o
27 #include <cyg/hal/hal_diag.h>
30 #define ZYLIN_VERSION "1.52"
31 #define ZYLIN_DATE __DATE__
32 #define ZYLIN_TIME __TIME__
33 #define ZYLIN_OPENOCD "$Revision$"
34 #define ZYLIN_OPENOCD_VERSION "Zylin JTAG ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE " " ZYLIN_TIME
35 const char *zylin_config_dir="/config/settings";
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 = bitbang_execute_queue,
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 bitbang_interface_t zy1000_bitbang =
132 .write = zy1000_write,
133 .reset = zy1000_reset
138 static void zy1000_write(int tck, int tms, int tdi)
143 int zy1000_read(void)
148 extern bool readSRST(void);
150 void zy1000_reset(int trst, int srst)
152 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
155 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
159 /* Danger!!! if clk!=0 when in
160 * idle in TAP_IDLE, reset halt on str912 will fail.
162 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
167 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
172 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
175 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
178 /* we're now in the RESET state until trst is deasserted */
179 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
182 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
183 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
186 /* wait for srst to float back up */
190 for (i=0; i<1000; i++)
192 // We don't want to sense our own reset, so we clear here.
193 // There is of course a timing hole where we could loose
204 LOG_USER("SRST didn't deassert after %dms", i);
207 LOG_USER("SRST took %dms to deassert", i);
212 int zy1000_speed(int speed)
218 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
219 LOG_DEBUG("jtag_speed using RCLK");
223 if(speed > 8190 || speed < 2)
225 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
226 return ERROR_INVALID_ARGUMENTS;
229 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
230 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
231 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
236 static bool savePower;
239 static void setPower(bool power)
244 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
247 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
251 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
255 return ERROR_INVALID_ARGUMENTS;
260 if (strcmp(args[0], "on") == 0)
264 else if (strcmp(args[0], "off") == 0)
269 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
270 return ERROR_INVALID_ARGUMENTS;
274 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
280 /* Give TELNET a way to find out what version this is */
281 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
283 if ((argc < 1) || (argc > 2))
286 const char *version_str=NULL;
290 version_str=ZYLIN_OPENOCD_VERSION;
293 const char *str = Jim_GetString(argv[1], NULL);
294 if (strcmp("openocd", str) == 0)
297 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
298 sprintf(buff, "%d", revision);
301 else if (strcmp("zy1000", str) == 0)
303 version_str=ZYLIN_VERSION;
305 else if (strcmp("date", str) == 0)
307 version_str=ZYLIN_DATE;
315 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
322 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
324 Jim_Obj * const *argv)
328 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
333 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
335 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
340 int zy1000_register_commands(struct command_context_s *cmd_ctx)
342 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
343 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
345 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
348 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
356 int zy1000_init(void)
358 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
360 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
362 setPower(true); // on by default
365 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
367 zy1000_speed(jtag_speed);
369 bitbang_interface = &zy1000_bitbang;
374 int zy1000_quit(void)
383 int interface_jtag_execute_queue(void)
388 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
389 /* clear JTAG error register */
390 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
392 if ((empty&0x400)!=0)
394 LOG_WARNING("RCLK timeout");
395 /* the error is informative only as we don't want to break the firmware if there
396 * is a false positive.
398 // return ERROR_FAIL;
407 static cyg_uint32 getShiftValue(void)
411 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
412 VERBOSE(LOG_INFO("getShiftValue %08x", value));
416 static cyg_uint32 getShiftValueFlip(void)
420 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
421 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
427 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
429 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
433 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
434 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
435 VERBOSE(getShiftValueFlip());
439 extern int jtag_check_value(u8 *captured, void *priv);
441 static void gotoEndState(void)
443 setCurrentState(cmd_queue_end_state);
446 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
452 for (i = 0; i < num_fields; i++)
456 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
457 static int in_buff_size=0;
461 // figure out where to store the input data
462 int num_bits=fields[i].num_bits;
463 if (fields[i].in_value!=NULL)
465 inBuffer=fields[i].in_value;
468 // here we shuffle N bits out/in
472 tap_state_t pause_state;
475 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
479 /* we have more to shift out */
480 } else if (i == num_fields-1)
482 /* this was the last to shift out this time */
483 pause_state=end_state;
486 // we have (num_bits+7)/8 bytes of bits to toggle out.
487 // bits are pushed out LSB to MSB
489 if (fields[i].out_value!=NULL)
493 value|=fields[i].out_value[(j+l)/8]<<l;
496 /* mask away unused bits for easier debugging */
497 value&=~(((u32)0xffffffff)<<k);
499 shiftValueInner(shiftState, pause_state, k, value);
503 // data in, LSB to MSB
504 value=getShiftValue();
505 // we're shifting in data to MSB, shift data to be aligned for returning the value
510 inBuffer[(j+l)/8]=(value>>l)&0xff;
518 int interface_jtag_add_end_state(tap_state_t state)
524 int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
529 jtag_tap_t *tap, *nextTap;
530 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
532 nextTap=jtag_NextEnabledTap(tap);
533 tap_state_t end_state;
536 end_state = cmd_queue_end_state;
539 end_state = TAP_IRSHIFT;
544 scan_size = tap->ir_length;
546 /* search the list */
547 for (j=0; j < num_fields; j++)
549 if (tap == fields[j].tap)
553 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
554 /* update device information */
555 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
564 /* if a device isn't listed, set it to BYPASS */
565 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
568 memset(&tmp, 0, sizeof(tmp));
569 tmp.out_value = ones;
570 tmp.num_bits = scan_size;
571 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
572 /* update device information */
573 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
585 int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
587 scanFields(num_fields, fields, TAP_IRSHIFT, cmd_queue_end_state);
592 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
594 int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
598 jtag_tap_t *tap, *nextTap;
599 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
601 nextTap=jtag_NextEnabledTap(tap);
603 tap_state_t end_state;
606 end_state = cmd_queue_end_state;
609 end_state = TAP_DRSHIFT;
612 for (j=0; j < num_fields; j++)
614 if (tap == fields[j].tap)
618 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
624 /* program the scan field to 1 bit length, and ignore it's value */
626 tmp.out_value = NULL;
629 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
638 int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
640 scanFields(num_fields, fields, TAP_DRSHIFT, cmd_queue_end_state);
645 int interface_jtag_add_tlr()
647 setCurrentState(TAP_RESET);
654 extern int jtag_nsrst_delay;
655 extern int jtag_ntrst_delay;
657 int interface_jtag_add_reset(int req_trst, int req_srst)
659 zy1000_reset(req_trst, req_srst);
663 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
665 /* num_cycles can be 0 */
666 setCurrentState(clockstate);
668 /* execute num_cycles, 32 at the time. */
670 for (i=0; i<num_cycles; i+=32)
674 if (num_cycles-i<num)
678 shiftValueInner(clockstate, clockstate, num, 0);
682 /* finish in end_state */
683 setCurrentState(state);
685 tap_state_t t=TAP_IDLE;
686 /* test manual drive code on any target */
688 u8 tms_scan = tap_get_tms_path(t, state);
689 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
691 for (i = 0; i < tms_count; i++)
693 tms = (tms_scan >> i) & 1;
695 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
698 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
705 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
707 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
710 int interface_jtag_add_clocks(int num_cycles)
712 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_end_state);
715 int interface_jtag_add_sleep(u32 us)
721 int interface_jtag_add_pathmove(int num_states, tap_state_t *path)
726 /*wait for the fifo to be empty*/
731 tap_state_t cur_state=cmd_queue_cur_state;
735 if (tap_state_transition(cur_state, false) == path[state_count])
739 else if (tap_state_transition(cur_state, true) == path[state_count])
745 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
750 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
752 cur_state = path[state_count];
758 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
764 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
766 // static int const reg_addr=0x5;
767 tap_state_t end_state=cmd_queue_end_state;
768 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL))==NULL)
770 /* better performance via code duplication */
774 for (i = 0; i < count; i++)
776 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
777 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
783 for (i = 0; i < count; i++)
785 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
786 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
794 for (i = 0; i < count; i++)
796 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
802 int loadFile(const char *fileName, void **data, int *len);
804 /* boolean parameter stored on config */
805 int boolParam(char *var)
808 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
814 if (loadFile(name, &data, &len) == ERROR_OK)
818 result = strncmp((char *) data, "1", len) == 0;