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 extern int jtag_error;
44 /* low level command set
46 int zy1000_read(void);
47 static void zy1000_write(int tck, int tms, int tdi);
48 void zy1000_reset(int trst, int srst);
51 int zy1000_speed(int speed);
52 int zy1000_register_commands(struct command_context_s *cmd_ctx);
53 int zy1000_init(void);
54 int zy1000_quit(void);
56 /* interface commands */
57 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
59 static int zy1000_khz(int khz, int *jtag_speed)
67 *jtag_speed=64000/khz;
72 static int zy1000_speed_div(int speed, int *khz)
86 static bool readPowerDropout(void)
89 // sample and clear power dropout
90 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x80);
91 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
93 powerDropout = (state & 0x80) != 0;
98 static bool readSRST(void)
101 // sample and clear SRST sensing
102 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x00000040);
103 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
105 srstAsserted = (state & 0x40) != 0;
109 static int zy1000_srst_asserted(int *srst_asserted)
111 *srst_asserted=readSRST();
115 static int zy1000_power_dropout(int *dropout)
117 *dropout=readPowerDropout();
122 jtag_interface_t zy1000_interface =
125 .execute_queue = bitbang_execute_queue,
126 .speed = zy1000_speed,
127 .register_commands = zy1000_register_commands,
131 .speed_div = zy1000_speed_div,
132 .power_dropout = zy1000_power_dropout,
133 .srst_asserted = zy1000_srst_asserted,
136 bitbang_interface_t zy1000_bitbang =
139 .write = zy1000_write,
140 .reset = zy1000_reset
145 static void zy1000_write(int tck, int tms, int tdi)
150 int zy1000_read(void)
155 extern bool readSRST(void);
157 void zy1000_reset(int trst, int srst)
159 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
162 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
166 /* Danger!!! if clk!=0 when in
167 * idle in TAP_IDLE, reset halt on str912 will fail.
169 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
174 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
179 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
182 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
185 /* we're now in the RESET state until trst is deasserted */
186 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
189 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
190 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
193 /* wait for srst to float back up */
197 for (i=0; i<1000; i++)
199 // We don't want to sense our own reset, so we clear here.
200 // There is of course a timing hole where we could loose
211 LOG_USER("SRST didn't deassert after %dms", i);
214 LOG_USER("SRST took %dms to deassert", i);
219 int zy1000_speed(int speed)
225 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
226 LOG_DEBUG("jtag_speed using RCLK");
230 if(speed > 8190 || speed < 2)
232 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
233 return ERROR_INVALID_ARGUMENTS;
236 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
237 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
238 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
243 static bool savePower;
246 static void setPower(bool power)
251 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
254 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
258 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
262 return ERROR_INVALID_ARGUMENTS;
267 if (strcmp(args[0], "on") == 0)
271 else if (strcmp(args[0], "off") == 0)
276 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
277 return ERROR_INVALID_ARGUMENTS;
281 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
287 /* Give TELNET a way to find out what version this is */
288 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
290 if ((argc < 1) || (argc > 2))
293 const char *version_str=NULL;
297 version_str=ZYLIN_OPENOCD_VERSION;
300 const char *str = Jim_GetString(argv[1], NULL);
301 if (strcmp("openocd", str) == 0)
304 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
305 sprintf(buff, "%d", revision);
308 else if (strcmp("zy1000", str) == 0)
310 version_str=ZYLIN_VERSION;
312 else if (strcmp("date", str) == 0)
314 version_str=ZYLIN_DATE;
322 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
329 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
331 Jim_Obj * const *argv)
335 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
340 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
342 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
347 int zy1000_register_commands(struct command_context_s *cmd_ctx)
349 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
350 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
352 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
355 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
363 int zy1000_init(void)
365 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
367 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
369 setPower(true); // on by default
372 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
374 zy1000_speed(jtag_speed);
376 bitbang_interface = &zy1000_bitbang;
381 int zy1000_quit(void)
390 int interface_jtag_execute_queue(void)
395 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
396 /* clear JTAG error register */
397 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
399 if ((empty&0x400)!=0)
401 LOG_WARNING("RCLK timeout");
402 /* the error is informative only as we don't want to break the firmware if there
403 * is a false positive.
405 // return ERROR_FAIL;
414 static cyg_uint32 getShiftValue(void)
418 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
419 VERBOSE(LOG_INFO("getShiftValue %08x", value));
423 static cyg_uint32 getShiftValueFlip(void)
427 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
428 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
434 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
436 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
440 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
441 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
442 VERBOSE(getShiftValueFlip());
446 extern int jtag_check_value(u8 *captured, void *priv);
448 static void gotoEndState(void)
450 setCurrentState(cmd_queue_end_state);
453 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, int pause)
459 for (i = 0; i < num_fields; i++)
463 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
464 static int in_buff_size=0;
468 // figure out where to store the input data
469 int num_bits=fields[i].num_bits;
470 if (fields[i].in_value!=NULL)
472 inBuffer=fields[i].in_value;
473 } else if (fields[i].in_handler!=NULL)
475 if (in_buff_size*8<num_bits)
477 // we need more space
481 in_buff_size=(num_bits+7)/8;
482 in_buff=malloc(in_buff_size);
485 LOG_ERROR("Out of memory");
486 jtag_error=ERROR_JTAG_QUEUE_FAILED;
493 // here we shuffle N bits out/in
497 tap_state_t pause_state;
500 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
504 /* we have more to shift out */
505 } else if (pause&&(i == num_fields-1))
507 /* this was the last to shift out this time */
508 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRPAUSE:TAP_IRPAUSE;
511 // we have (num_bits+7)/8 bytes of bits to toggle out.
512 // bits are pushed out LSB to MSB
514 if (fields[i].out_value!=NULL)
518 value|=fields[i].out_value[(j+l)/8]<<l;
521 /* mask away unused bits for easier debugging */
522 value&=~(((u32)0xffffffff)<<k);
524 shiftValueInner(shiftState, pause_state, k, value);
528 // data in, LSB to MSB
529 value=getShiftValue();
530 // we're shifting in data to MSB, shift data to be aligned for returning the value
535 inBuffer[(j+l)/8]=(value>>l)&0xff;
541 if (fields[i].in_handler!=NULL)
544 int r=fields[i].in_handler(inBuffer, fields[i].in_handler_priv, fields+i);
547 /* this will cause jtag_execute_queue() to return an error */
554 int interface_jtag_add_end_state(tap_state_t state)
560 int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
565 jtag_tap_t *tap, *nextTap;
566 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
568 nextTap=jtag_NextEnabledTap(tap);
569 int pause=(nextTap==NULL);
573 scan_size = tap->ir_length;
575 /* search the list */
576 for (j=0; j < num_fields; j++)
578 if (tap == fields[j].tap)
582 if ((jtag_verify_capture_ir)&&(fields[j].in_handler==NULL))
584 jtag_set_check_value(fields+j, tap->expected, tap->expected_mask, NULL);
585 } else if (jtag_verify_capture_ir)
587 fields[j].in_check_value = tap->expected;
588 fields[j].in_check_mask = tap->expected_mask;
591 scanFields(1, fields+j, TAP_IRSHIFT, pause);
592 /* update device information */
593 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
602 /* if a device isn't listed, set it to BYPASS */
603 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
606 memset(&tmp, 0, sizeof(tmp));
607 tmp.out_value = ones;
608 tmp.num_bits = scan_size;
609 scanFields(1, &tmp, TAP_IRSHIFT, pause);
610 /* update device information */
611 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
624 int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, tap_state_t state)
626 scanFields(num_fields, fields, TAP_IRSHIFT, 1);
632 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
634 int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
638 jtag_tap_t *tap, *nextTap;
639 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
641 nextTap=jtag_NextEnabledTap(tap);
643 int pause=(nextTap==NULL);
645 for (j=0; j < num_fields; j++)
647 if (tap == fields[j].tap)
651 scanFields(1, fields+j, TAP_DRSHIFT, pause);
657 /* program the scan field to 1 bit length, and ignore it's value */
659 tmp.out_value = NULL;
661 tmp.in_check_value = NULL;
662 tmp.in_check_mask = NULL;
663 tmp.in_handler = NULL;
664 tmp.in_handler_priv = NULL;
666 scanFields(1, &tmp, TAP_DRSHIFT, pause);
676 int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, tap_state_t state)
678 scanFields(num_fields, fields, TAP_DRSHIFT, 1);
684 int interface_jtag_add_tlr()
686 setCurrentState(TAP_RESET);
693 extern int jtag_nsrst_delay;
694 extern int jtag_ntrst_delay;
696 int interface_jtag_add_reset(int req_trst, int req_srst)
698 zy1000_reset(req_trst, req_srst);
702 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
704 /* num_cycles can be 0 */
705 setCurrentState(clockstate);
707 /* execute num_cycles, 32 at the time. */
709 for (i=0; i<num_cycles; i+=32)
713 if (num_cycles-i<num)
717 shiftValueInner(clockstate, clockstate, num, 0);
721 /* finish in end_state */
722 setCurrentState(state);
724 tap_state_t t=TAP_IDLE;
725 /* test manual drive code on any target */
727 u8 tms_scan = tap_get_tms_path(t, state);
729 for (i = 0; i < 7; i++)
731 tms = (tms_scan >> i) & 1;
733 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
736 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
743 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
745 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
748 int interface_jtag_add_clocks(int num_cycles)
750 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_end_state);
753 int interface_jtag_add_sleep(u32 us)
759 int interface_jtag_add_pathmove(int num_states, tap_state_t *path)
764 /*wait for the fifo to be empty*/
769 tap_state_t cur_state=cmd_queue_cur_state;
773 if (tap_state_transition(cur_state, false) == path[state_count])
777 else if (tap_state_transition(cur_state, true) == path[state_count])
783 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
788 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
790 cur_state = path[state_count];
796 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
802 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
804 // static int const reg_addr=0x5;
805 tap_state_t end_state=cmd_queue_end_state;
806 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL))==NULL)
808 /* better performance via code duplication */
812 for (i = 0; i < count; i++)
814 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
815 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
821 for (i = 0; i < count; i++)
823 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
824 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
832 for (i = 0; i < count; i++)
834 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
840 int loadFile(const char *fileName, void **data, int *len);
842 /* boolean parameter stored on config */
843 int boolParam(char *var)
846 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
852 if (loadFile(name, &data, &len) == ERROR_OK)
856 result = strncmp((char *) data, "1", len) == 0;