More svn to git version string fixes.
[dnglaze.git] / src / jtag / zy1000 / zy1000.c
blobe56f6d2144415d7be5bd0e72f47069f084b2b6e8
1 /***************************************************************************
2 * Copyright (C) 2007-2008 by Øyvind Harboe *
3 * *
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. *
8 * *
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. *
13 * *
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 ***************************************************************************/
19 #ifdef HAVE_CONFIG_H
20 #include "config.h"
21 #endif
23 #include "embeddedice.h"
24 #include "minidriver.h"
25 #include "interface.h"
26 #include "zy1000_version.h"
28 #include <cyg/hal/hal_io.h> // low level i/o
29 #include <cyg/hal/hal_diag.h>
31 #define ZYLIN_VERSION GIT_ZY1000_VERSION
32 #define ZYLIN_DATE __DATE__
33 #define ZYLIN_TIME __TIME__
34 #define ZYLIN_OPENOCD GIT_OPENOCD_VERSION
35 #define ZYLIN_OPENOCD_VERSION "ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE
37 /* low level command set
39 void zy1000_reset(int trst, int srst);
42 int zy1000_speed(int speed);
43 int zy1000_register_commands(struct command_context_s *cmd_ctx);
44 int zy1000_init(void);
45 int zy1000_quit(void);
47 /* interface commands */
48 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 static int zy1000_khz(int khz, int *jtag_speed)
52 if (khz == 0)
54 *jtag_speed = 0;
56 else
58 *jtag_speed = 64000/khz;
60 return ERROR_OK;
63 static int zy1000_speed_div(int speed, int *khz)
65 if (speed == 0)
67 *khz = 0;
69 else
71 *khz = 64000/speed;
74 return ERROR_OK;
77 static bool readPowerDropout(void)
79 cyg_uint32 state;
80 // sample and clear power dropout
81 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x80);
82 HAL_READ_UINT32(ZY1000_JTAG_BASE + 0x10, state);
83 bool powerDropout;
84 powerDropout = (state & 0x80) != 0;
85 return powerDropout;
89 static bool readSRST(void)
91 cyg_uint32 state;
92 // sample and clear SRST sensing
93 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x00000040);
94 HAL_READ_UINT32(ZY1000_JTAG_BASE + 0x10, state);
95 bool srstAsserted;
96 srstAsserted = (state & 0x40) != 0;
97 return srstAsserted;
100 static int zy1000_srst_asserted(int *srst_asserted)
102 *srst_asserted = readSRST();
103 return ERROR_OK;
106 static int zy1000_power_dropout(int *dropout)
108 *dropout = readPowerDropout();
109 return ERROR_OK;
113 jtag_interface_t zy1000_interface =
115 .name = "ZY1000",
116 .execute_queue = NULL,
117 .speed = zy1000_speed,
118 .register_commands = zy1000_register_commands,
119 .init = zy1000_init,
120 .quit = zy1000_quit,
121 .khz = zy1000_khz,
122 .speed_div = zy1000_speed_div,
123 .power_dropout = zy1000_power_dropout,
124 .srst_asserted = zy1000_srst_asserted,
127 void zy1000_reset(int trst, int srst)
129 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
130 if (!srst)
132 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000001);
134 else
136 /* Danger!!! if clk != 0 when in
137 * idle in TAP_IDLE, reset halt on str912 will fail.
139 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000001);
142 if (!trst)
144 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000002);
146 else
148 /* assert reset */
149 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000002);
152 if (trst||(srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
154 waitIdle();
155 /* we're now in the RESET state until trst is deasserted */
156 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_RESET);
157 } else
159 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
160 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
163 /* wait for srst to float back up */
164 if (!srst)
166 int i;
167 for (i = 0; i < 1000; i++)
169 // We don't want to sense our own reset, so we clear here.
170 // There is of course a timing hole where we could loose
171 // a "real" reset.
172 if (!readSRST())
173 break;
175 /* wait 1ms */
176 alive_sleep(1);
179 if (i == 1000)
181 LOG_USER("SRST didn't deassert after %dms", i);
182 } else if (i > 1)
184 LOG_USER("SRST took %dms to deassert", i);
189 int zy1000_speed(int speed)
191 if (speed == 0)
193 /*0 means RCLK*/
194 speed = 0;
195 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x100);
196 LOG_DEBUG("jtag_speed using RCLK");
198 else
200 if (speed > 8190 || speed < 2)
202 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
203 return ERROR_INVALID_ARGUMENTS;
206 LOG_USER("jtag_speed %d => JTAG clk=%f", speed, 64.0/(float)speed);
207 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x100);
208 ZY1000_POKE(ZY1000_JTAG_BASE + 0x1c, speed&~1);
210 return ERROR_OK;
213 static bool savePower;
216 static void setPower(bool power)
218 savePower = power;
219 if (power)
221 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x14, 0x8);
222 } else
224 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x8);
228 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
230 if (argc > 1)
232 return ERROR_INVALID_ARGUMENTS;
235 if (argc == 1)
237 if (strcmp(args[0], "on") == 0)
239 setPower(1);
241 else if (strcmp(args[0], "off") == 0)
243 setPower(0);
244 } else
246 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
247 return ERROR_INVALID_ARGUMENTS;
251 command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
253 return ERROR_OK;
257 /* Give TELNET a way to find out what version this is */
258 static int jim_zy1000_version(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
260 if ((argc < 1) || (argc > 2))
261 return JIM_ERR;
262 char buff[128];
263 const char *version_str = NULL;
265 if (argc == 1)
267 version_str = ZYLIN_OPENOCD_VERSION;
268 } else
270 const char *str = Jim_GetString(argv[1], NULL);
271 if (strcmp("openocd", str) == 0)
273 version_str = ZYLIN_OPENOCD;
275 else if (strcmp("zy1000", str) == 0)
277 version_str = ZYLIN_VERSION;
279 else if (strcmp("date", str) == 0)
281 version_str = ZYLIN_DATE;
283 else if (strcmp("time", str) == 0)
285 version_str = ZYLIN_TIME;
287 else if (strcmp("pcb", str) == 0)
289 #ifdef CYGPKG_HAL_NIOS2
290 version_str="c";
291 #else
292 version_str="b";
293 #endif
295 else
297 return JIM_ERR;
301 Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
303 return JIM_OK;
307 #ifdef CYGPKG_HAL_NIOS2
308 static int jim_zy1000_writefirmware(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
310 if (argc != 2)
311 return JIM_ERR;
313 int length;
314 int stat;
315 const char *str = Jim_GetString(argv[1], &length);
317 /* BUG!!!! skip header! */
318 void *firmware_address=0x4000000;
319 int firmware_length=0x100000;
321 if (length>firmware_length)
322 return JIM_ERR;
324 void *err_addr;
326 if ((stat = flash_erase((void *)firmware_address, firmware_length, (void **)&err_addr)) != 0)
328 return JIM_ERR;
331 if ((stat = flash_program(firmware_address, str, length, (void **)&err_addr)) != 0)
332 return JIM_ERR;
334 return JIM_OK;
336 #endif
338 static int
339 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
340 int argc,
341 Jim_Obj * const *argv)
343 if (argc != 1)
345 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
346 return JIM_ERR;
349 cyg_uint32 status;
350 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, status);
352 Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80) != 0));
354 return JIM_OK;
357 int zy1000_register_commands(struct command_context_s *cmd_ctx)
359 register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
360 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
362 Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
365 Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
367 #ifdef CYGPKG_HAL_NIOS2
368 Jim_CreateCommand(interp, "updatezy1000firmware", jim_zy1000_writefirmware, NULL, NULL);
369 #endif
372 return ERROR_OK;
378 int zy1000_init(void)
380 LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
382 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x30); // Turn on LED1 & LED2
384 setPower(true); // on by default
387 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
388 zy1000_reset(0, 0);
389 zy1000_speed(jtag_get_speed());
391 return ERROR_OK;
394 int zy1000_quit(void)
397 return ERROR_OK;
402 int interface_jtag_execute_queue(void)
404 cyg_uint32 empty;
406 waitIdle();
407 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
408 /* clear JTAG error register */
409 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
411 if ((empty&0x400) != 0)
413 LOG_WARNING("RCLK timeout");
414 /* the error is informative only as we don't want to break the firmware if there
415 * is a false positive.
417 // return ERROR_FAIL;
419 return ERROR_OK;
426 static cyg_uint32 getShiftValue(void)
428 cyg_uint32 value;
429 waitIdle();
430 ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, value);
431 VERBOSE(LOG_INFO("getShiftValue %08x", value));
432 return value;
434 #if 0
435 static cyg_uint32 getShiftValueFlip(void)
437 cyg_uint32 value;
438 waitIdle();
439 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x18, value);
440 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
441 return value;
443 #endif
445 #if 0
446 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
448 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
449 cyg_uint32 a,b;
450 a = state;
451 b = endState;
452 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
453 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 15) | (repeat << 8) | (a << 4) | b);
454 VERBOSE(getShiftValueFlip());
456 #endif
458 extern int jtag_check_value(uint8_t *captured, void *priv);
460 static void gotoEndState(tap_state_t end_state)
462 setCurrentState(end_state);
465 static __inline void scanFields(int num_fields, const scan_field_t *fields, tap_state_t shiftState, int pause)
467 int i;
468 int j;
469 int k;
471 for (i = 0; i < num_fields; i++)
473 cyg_uint32 value;
475 uint8_t *inBuffer = NULL;
478 // figure out where to store the input data
479 int num_bits = fields[i].num_bits;
480 if (fields[i].in_value != NULL)
482 inBuffer = fields[i].in_value;
485 // here we shuffle N bits out/in
486 j = 0;
487 while (j < num_bits)
489 tap_state_t pause_state;
490 int l;
491 k = num_bits-j;
492 pause_state = (shiftState == TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
493 if (k > 32)
495 k = 32;
496 /* we have more to shift out */
497 } else if (pause&&(i == num_fields-1))
499 /* this was the last to shift out this time */
500 pause_state = (shiftState==TAP_DRSHIFT)?TAP_DRPAUSE:TAP_IRPAUSE;
503 // we have (num_bits + 7)/8 bytes of bits to toggle out.
504 // bits are pushed out LSB to MSB
505 value = 0;
506 if (fields[i].out_value != NULL)
508 for (l = 0; l < k; l += 8)
510 value|=fields[i].out_value[(j + l)/8]<<l;
513 /* mask away unused bits for easier debugging */
514 value&=~(((uint32_t)0xffffffff) << k);
516 shiftValueInner(shiftState, pause_state, k, value);
518 if (inBuffer != NULL)
520 // data in, LSB to MSB
521 value = getShiftValue();
522 // we're shifting in data to MSB, shift data to be aligned for returning the value
523 value >>= 32-k;
525 for (l = 0; l < k; l += 8)
527 inBuffer[(j + l)/8]=(value >> l)&0xff;
530 j += k;
535 int interface_jtag_set_end_state(tap_state_t state)
537 return ERROR_OK;
541 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
544 int j;
545 int scan_size = 0;
546 jtag_tap_t *tap, *nextTap;
547 for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
549 nextTap = jtag_tap_next_enabled(tap);
550 int pause = (nextTap==NULL);
552 int found = 0;
554 scan_size = tap->ir_length;
556 /* search the list */
557 for (j = 0; j < num_fields; j++)
559 if (tap == fields[j].tap)
561 found = 1;
563 scanFields(1, fields + j, TAP_IRSHIFT, pause);
564 /* update device information */
565 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
567 tap->bypass = 0;
568 break;
572 if (!found)
574 /* if a device isn't listed, set it to BYPASS */
575 uint8_t ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
577 scan_field_t tmp;
578 memset(&tmp, 0, sizeof(tmp));
579 tmp.out_value = ones;
580 tmp.num_bits = scan_size;
581 scanFields(1, &tmp, TAP_IRSHIFT, pause);
582 /* update device information */
583 buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
584 tap->bypass = 1;
587 gotoEndState(state);
589 return ERROR_OK;
596 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
598 scanFields(num_fields, fields, TAP_IRSHIFT, 1);
599 gotoEndState(state);
601 return ERROR_OK;
604 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
606 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
609 int j;
610 jtag_tap_t *tap, *nextTap;
611 for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
613 nextTap = jtag_tap_next_enabled(tap);
614 int found = 0;
615 int pause = (nextTap==NULL);
617 for (j = 0; j < num_fields; j++)
619 if (tap == fields[j].tap)
621 found = 1;
623 scanFields(1, fields+j, TAP_DRSHIFT, pause);
626 if (!found)
628 scan_field_t tmp;
629 /* program the scan field to 1 bit length, and ignore it's value */
630 tmp.num_bits = 1;
631 tmp.out_value = NULL;
632 tmp.in_value = NULL;
634 scanFields(1, &tmp, TAP_DRSHIFT, pause);
636 else
640 gotoEndState(state);
641 return ERROR_OK;
644 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
646 scanFields(num_fields, fields, TAP_DRSHIFT, 1);
647 gotoEndState(state);
648 return ERROR_OK;
652 int interface_jtag_add_tlr()
654 setCurrentState(TAP_RESET);
655 return ERROR_OK;
661 int interface_jtag_add_reset(int req_trst, int req_srst)
663 zy1000_reset(req_trst, req_srst);
664 return ERROR_OK;
667 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
669 /* num_cycles can be 0 */
670 setCurrentState(clockstate);
672 /* execute num_cycles, 32 at the time. */
673 int i;
674 for (i = 0; i < num_cycles; i += 32)
676 int num;
677 num = 32;
678 if (num_cycles-i < num)
680 num = num_cycles-i;
682 shiftValueInner(clockstate, clockstate, num, 0);
685 #if !TEST_MANUAL()
686 /* finish in end_state */
687 setCurrentState(state);
688 #else
689 tap_state_t t = TAP_IDLE;
690 /* test manual drive code on any target */
691 int tms;
692 uint8_t tms_scan = tap_get_tms_path(t, state);
693 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
695 for (i = 0; i < tms_count; i++)
697 tms = (tms_scan >> i) & 1;
698 waitIdle();
699 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, tms);
701 waitIdle();
702 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, state);
703 #endif
706 return ERROR_OK;
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_cur_state);
719 int interface_jtag_add_sleep(uint32_t us)
721 jtag_sleep(us);
722 return ERROR_OK;
725 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
727 int state_count;
728 int tms = 0;
730 /*wait for the fifo to be empty*/
731 waitIdle();
733 state_count = 0;
735 tap_state_t cur_state = cmd_queue_cur_state;
737 while (num_states)
739 if (tap_state_transition(cur_state, false) == path[state_count])
741 tms = 0;
743 else if (tap_state_transition(cur_state, true) == path[state_count])
745 tms = 1;
747 else
749 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
750 exit(-1);
753 waitIdle();
754 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, tms);
756 cur_state = path[state_count];
757 state_count++;
758 num_states--;
761 waitIdle();
762 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, cur_state);
763 return ERROR_OK;
768 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, uint8_t *buffer, int little, int count)
770 // static int const reg_addr = 0x5;
771 tap_state_t end_state = jtag_get_end_state();
772 if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL)
774 /* better performance via code duplication */
775 if (little)
777 int i;
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));
782 buffer += 4;
784 } else
786 int i;
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));
791 buffer += 4;
795 else
797 int i;
798 for (i = 0; i < count; i++)
800 embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
801 buffer += 4;