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 #define INCLUDE_JTAG_INTERFACE_H
25 #include "embeddedice.h"
28 #include <cyg/hal/hal_io.h> // low level i/o
29 #include <cyg/hal/hal_diag.h>
32 #define ZYLIN_VERSION "1.52"
33 #define ZYLIN_DATE __DATE__
34 #define ZYLIN_TIME __TIME__
35 #define ZYLIN_OPENOCD "$Revision$"
36 #define ZYLIN_OPENOCD_VERSION "Zylin JTAG ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE " " ZYLIN_TIME
37 const char *zylin_config_dir="/config/settings";
39 /* low level command set
41 int zy1000_read(void);
42 static void zy1000_write(int tck, int tms, int tdi);
43 void zy1000_reset(int trst, int srst);
46 int zy1000_speed(int speed);
47 int zy1000_register_commands(struct command_context_s *cmd_ctx);
48 int zy1000_init(void);
49 int zy1000_quit(void);
51 /* interface commands */
52 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 static int zy1000_khz(int khz, int *jtag_speed)
62 *jtag_speed=64000/khz;
67 static int zy1000_speed_div(int speed, int *khz)
81 static bool readPowerDropout(void)
84 // sample and clear power dropout
85 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x80);
86 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
88 powerDropout = (state & 0x80) != 0;
93 static bool readSRST(void)
96 // sample and clear SRST sensing
97 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x00000040);
98 HAL_READ_UINT32(ZY1000_JTAG_BASE+0x10, state);
100 srstAsserted = (state & 0x40) != 0;
104 static int zy1000_srst_asserted(int *srst_asserted)
106 *srst_asserted=readSRST();
110 static int zy1000_power_dropout(int *dropout)
112 *dropout=readPowerDropout();
117 jtag_interface_t zy1000_interface =
120 .execute_queue = bitbang_execute_queue,
121 .speed = zy1000_speed,
122 .register_commands = zy1000_register_commands,
126 .speed_div = zy1000_speed_div,
127 .power_dropout = zy1000_power_dropout,
128 .srst_asserted = zy1000_srst_asserted,
131 bitbang_interface_t zy1000_bitbang =
134 .write = zy1000_write,
135 .reset = zy1000_reset
140 static void zy1000_write(int tck, int tms, int tdi)
145 int zy1000_read(void)
150 extern bool readSRST(void);
152 void zy1000_reset(int trst, int srst)
154 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
157 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000001);
161 /* Danger!!! if clk!=0 when in
162 * idle in TAP_IDLE, reset halt on str912 will fail.
164 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000001);
169 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x00000002);
174 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x00000002);
177 if (trst||(srst&&(jtag_reset_config & RESET_SRST_PULLS_TRST)))
180 /* we're now in the RESET state until trst is deasserted */
181 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, TAP_RESET);
184 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
185 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
188 /* wait for srst to float back up */
192 for (i=0; i<1000; i++)
194 // We don't want to sense our own reset, so we clear here.
195 // There is of course a timing hole where we could loose
206 LOG_USER("SRST didn't deassert after %dms", i);
209 LOG_USER("SRST took %dms to deassert", i);
214 int zy1000_speed(int speed)
220 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x100);
221 LOG_DEBUG("jtag_speed using RCLK");
225 if(speed > 8190 || speed < 2)
227 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
228 return ERROR_INVALID_ARGUMENTS;
231 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
232 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x100);
233 ZY1000_POKE(ZY1000_JTAG_BASE+0x1c, speed&~1);
238 static bool savePower;
241 static void setPower(bool power)
246 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x14, 0x8);
249 HAL_WRITE_UINT32(ZY1000_JTAG_BASE+0x10, 0x8);
253 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
257 return ERROR_INVALID_ARGUMENTS;
262 if (strcmp(args[0], "on") == 0)
266 else if (strcmp(args[0], "off") == 0)
271 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
272 return ERROR_INVALID_ARGUMENTS;
276 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
282 /* Give TELNET a way to find out what version this is */
283 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
285 if ((argc < 1) || (argc > 2))
288 const char *version_str=NULL;
292 version_str=ZYLIN_OPENOCD_VERSION;
295 const char *str = Jim_GetString(argv[1], NULL);
296 if (strcmp("openocd", str) == 0)
299 revision = atol(ZYLIN_OPENOCD+strlen("XRevision: "));
300 sprintf(buff, "%d", revision);
303 else if (strcmp("zy1000", str) == 0)
305 version_str=ZYLIN_VERSION;
307 else if (strcmp("date", str) == 0)
309 version_str=ZYLIN_DATE;
317 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
324 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
326 Jim_Obj * const *argv)
330 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
335 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, status);
337 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80)!=0));
342 int zy1000_register_commands(struct command_context_s *cmd_ctx)
344 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
345 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
347 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
350 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
358 int zy1000_init(void)
360 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
362 ZY1000_POKE(ZY1000_JTAG_BASE+0x10, 0x30); // Turn on LED1 & LED2
364 setPower(true); // on by default
367 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
369 zy1000_speed(jtag_speed);
371 bitbang_interface = &zy1000_bitbang;
376 int zy1000_quit(void)
383 void interface_jtag_add_scan_check_alloc(scan_field_t *field)
385 /* We're executing this synchronously, so try to use local storage. */
386 if (field->num_bits > 32)
388 unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
389 field->in_value = (u8 *)malloc(num_bytes);
390 field->allocated = 1;
393 field->in_value = field->intmp;
397 int interface_jtag_execute_queue(void)
402 ZY1000_PEEK(ZY1000_JTAG_BASE+0x10, empty);
403 /* clear JTAG error register */
404 ZY1000_POKE(ZY1000_JTAG_BASE+0x14, 0x400);
406 if ((empty&0x400)!=0)
408 LOG_WARNING("RCLK timeout");
409 /* the error is informative only as we don't want to break the firmware if there
410 * is a false positive.
412 // return ERROR_FAIL;
421 static cyg_uint32 getShiftValue(void)
425 ZY1000_PEEK(ZY1000_JTAG_BASE+0xc, value);
426 VERBOSE(LOG_INFO("getShiftValue %08x", value));
430 static cyg_uint32 getShiftValueFlip(void)
434 ZY1000_PEEK(ZY1000_JTAG_BASE+0x18, value);
435 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
441 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
443 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
447 ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
448 ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
449 VERBOSE(getShiftValueFlip());
453 extern int jtag_check_value(u8 *captured, void *priv);
455 static void gotoEndState(void)
457 setCurrentState(cmd_queue_end_state);
460 static __inline void scanFields(int num_fields, scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
466 for (i = 0; i < num_fields; i++)
470 static u8 *in_buff=NULL; /* pointer to buffer for scanned data */
471 static int in_buff_size=0;
475 // figure out where to store the input data
476 int num_bits=fields[i].num_bits;
477 if (fields[i].in_value!=NULL)
479 inBuffer=fields[i].in_value;
482 // here we shuffle N bits out/in
486 tap_state_t pause_state;
489 pause_state=(shiftState==TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
493 /* we have more to shift out */
494 } else if (i == num_fields-1)
496 /* this was the last to shift out this time */
497 pause_state=end_state;
500 // we have (num_bits+7)/8 bytes of bits to toggle out.
501 // bits are pushed out LSB to MSB
503 if (fields[i].out_value!=NULL)
507 value|=fields[i].out_value[(j+l)/8]<<l;
510 /* mask away unused bits for easier debugging */
511 value&=~(((u32)0xffffffff)<<k);
513 shiftValueInner(shiftState, pause_state, k, value);
517 // data in, LSB to MSB
518 value=getShiftValue();
519 // we're shifting in data to MSB, shift data to be aligned for returning the value
524 inBuffer[(j+l)/8]=(value>>l)&0xff;
532 int interface_jtag_add_end_state(tap_state_t state)
538 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
543 jtag_tap_t *tap, *nextTap;
544 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
546 nextTap=jtag_NextEnabledTap(tap);
547 tap_state_t end_state;
550 end_state = cmd_queue_end_state;
553 end_state = TAP_IRSHIFT;
558 scan_size = tap->ir_length;
560 /* search the list */
561 for (j=0; j < num_fields; j++)
563 if (tap == fields[j].tap)
567 scanFields(1, fields+j, TAP_IRSHIFT, end_state);
568 /* update device information */
569 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
578 /* if a device isn't listed, set it to BYPASS */
579 u8 ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
582 memset(&tmp, 0, sizeof(tmp));
583 tmp.out_value = ones;
584 tmp.num_bits = scan_size;
585 scanFields(1, &tmp, TAP_IRSHIFT, end_state);
586 /* update device information */
587 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
599 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
601 scanFields(num_fields, fields, TAP_IRSHIFT, cmd_queue_end_state);
606 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
608 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
612 jtag_tap_t *tap, *nextTap;
613 for(tap = jtag_NextEnabledTap(NULL); tap!= NULL; tap=nextTap)
615 nextTap=jtag_NextEnabledTap(tap);
617 tap_state_t end_state;
620 end_state = cmd_queue_end_state;
623 end_state = TAP_DRSHIFT;
626 for (j=0; j < num_fields; j++)
628 if (tap == fields[j].tap)
632 scanFields(1, fields+j, TAP_DRSHIFT, end_state);
638 /* program the scan field to 1 bit length, and ignore it's value */
640 tmp.out_value = NULL;
643 scanFields(1, &tmp, TAP_DRSHIFT, end_state);
652 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
654 scanFields(num_fields, fields, TAP_DRSHIFT, cmd_queue_end_state);
659 int interface_jtag_add_tlr()
661 setCurrentState(TAP_RESET);
668 extern int jtag_nsrst_delay;
669 extern int jtag_ntrst_delay;
671 int interface_jtag_add_reset(int req_trst, int req_srst)
673 zy1000_reset(req_trst, req_srst);
677 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
679 /* num_cycles can be 0 */
680 setCurrentState(clockstate);
682 /* execute num_cycles, 32 at the time. */
684 for (i=0; i<num_cycles; i+=32)
688 if (num_cycles-i<num)
692 shiftValueInner(clockstate, clockstate, num, 0);
696 /* finish in end_state */
697 setCurrentState(state);
699 tap_state_t t=TAP_IDLE;
700 /* test manual drive code on any target */
702 u8 tms_scan = tap_get_tms_path(t, state);
703 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
705 for (i = 0; i < tms_count; i++)
707 tms = (tms_scan >> i) & 1;
709 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
712 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, state);
719 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
721 return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
724 int interface_jtag_add_clocks(int num_cycles)
726 return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_end_state);
729 int interface_jtag_add_sleep(u32 us)
735 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
740 /*wait for the fifo to be empty*/
745 tap_state_t cur_state=cmd_queue_cur_state;
749 if (tap_state_transition(cur_state, false) == path[state_count])
753 else if (tap_state_transition(cur_state, true) == path[state_count])
759 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
764 ZY1000_POKE(ZY1000_JTAG_BASE+0x28, tms);
766 cur_state = path[state_count];
772 ZY1000_POKE(ZY1000_JTAG_BASE+0x20, cur_state);
778 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
780 // static int const reg_addr=0x5;
781 tap_state_t end_state=cmd_queue_end_state;
782 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL))==NULL)
784 /* better performance via code duplication */
788 for (i = 0; i < count; i++)
790 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
791 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
797 for (i = 0; i < count; i++)
799 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
800 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr|(1<<5));
808 for (i = 0; i < count; i++)
810 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
816 int loadFile(const char *fileName, void **data, int *len);
818 /* boolean parameter stored on config */
819 int boolParam(char *var)
822 char *name = alloc_printf("%s/%s", zylin_config_dir, var);
828 if (loadFile(name, &data, &len) == ERROR_OK)
832 result = strncmp((char *) data, "1", len) == 0;