1 /***************************************************************************
2 * Copyright (C) 2007-2009 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 ***************************************************************************/
20 /* This file supports the zy1000 debugger: http://www.zylin.com/zy1000.html
22 * The zy1000 is a standalone debugger that has a web interface and
23 * requires no drivers on the developer host as all communication
24 * is via TCP/IP. The zy1000 gets it performance(~400-700kBytes/s
25 * DCC downloads @ 16MHz target) as it has an FPGA to hardware
26 * accelerate the JTAG commands, while offering *very* low latency
27 * between OpenOCD and the FPGA registers.
29 * The disadvantage of the zy1000 is that it has a feeble CPU compared to
30 * a PC(ca. 50-500 DMIPS depending on how one counts it), whereas a PC
31 * is on the order of 10000 DMIPS(i.e. at a factor of 20-200).
33 * The zy1000 revc hardware is using an Altera Nios CPU, whereas the
34 * revb is using ARM7 + Xilinx.
36 * See Zylin web pages or contact Zylin for more information.
38 * The reason this code is in OpenOCD rather than OpenOCD linked with the
39 * ZY1000 code is that OpenOCD is the long road towards getting
40 * libopenocd into place. libopenocd will support both low performance,
41 * low latency systems(embedded) and high performance high latency
48 #include <target/embeddedice.h>
49 #include <jtag/minidriver.h>
50 #include <jtag/interface.h>
51 #include "zy1000_version.h"
53 #include <cyg/hal/hal_io.h> // low level i/o
54 #include <cyg/hal/hal_diag.h>
58 #ifdef CYGPKG_HAL_NIOS2
59 #include <cyg/hal/io.h>
60 #include <cyg/firmwareutil/firmwareutil.h>
63 #define ZYLIN_VERSION GIT_ZY1000_VERSION
64 #define ZYLIN_DATE __DATE__
65 #define ZYLIN_TIME __TIME__
66 #define ZYLIN_OPENOCD GIT_OPENOCD_VERSION
67 #define ZYLIN_OPENOCD_VERSION "ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE
70 static int zy1000_khz(int khz
, int *jtag_speed
)
78 *jtag_speed
= 64000/khz
;
83 static int zy1000_speed_div(int speed
, int *khz
)
97 static bool readPowerDropout(void)
100 // sample and clear power dropout
101 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x80);
102 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x10, state
);
104 powerDropout
= (state
& 0x80) != 0;
109 static bool readSRST(void)
112 // sample and clear SRST sensing
113 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x00000040);
114 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x10, state
);
116 srstAsserted
= (state
& 0x40) != 0;
120 static int zy1000_srst_asserted(int *srst_asserted
)
122 *srst_asserted
= readSRST();
126 static int zy1000_power_dropout(int *dropout
)
128 *dropout
= readPowerDropout();
132 void zy1000_reset(int trst
, int srst
)
134 LOG_DEBUG("zy1000 trst=%d, srst=%d", trst
, srst
);
136 /* flush the JTAG FIFO. Not flushing the queue before messing with
137 * reset has such interesting bugs as causing hard to reproduce
138 * RCLK bugs as RCLK will stop responding when TRST is asserted
144 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x00000001);
148 /* Danger!!! if clk != 0 when in
149 * idle in TAP_IDLE, reset halt on str912 will fail.
151 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x00000001);
156 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x00000002);
161 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x00000002);
164 if (trst
||(srst
&& (jtag_get_reset_config() & RESET_SRST_PULLS_TRST
)))
166 /* we're now in the RESET state until trst is deasserted */
167 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, TAP_RESET
);
170 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
171 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x400);
174 /* wait for srst to float back up */
178 for (i
= 0; i
< 1000; i
++)
180 // We don't want to sense our own reset, so we clear here.
181 // There is of course a timing hole where we could loose
192 LOG_USER("SRST didn't deassert after %dms", i
);
195 LOG_USER("SRST took %dms to deassert", i
);
200 int zy1000_speed(int speed
)
206 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x100);
207 LOG_DEBUG("jtag_speed using RCLK");
211 if (speed
> 8190 || speed
< 2)
213 LOG_USER("valid ZY1000 jtag_speed=[8190,2]. Divisor is 64MHz / even values between 8190-2, i.e. min 7814Hz, max 32MHz");
214 return ERROR_INVALID_ARGUMENTS
;
217 LOG_USER("jtag_speed %d => JTAG clk=%f", speed
, 64.0/(float)speed
);
218 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x100);
219 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x1c, speed
&~1);
224 static bool savePower
;
227 static void setPower(bool power
)
232 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x8);
235 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x8);
239 COMMAND_HANDLER(handle_power_command
)
245 COMMAND_PARSE_ON_OFF(CMD_ARGV
[0], enable
);
250 LOG_INFO("Target power %s", savePower
? "on" : "off");
253 return ERROR_INVALID_ARGUMENTS
;
260 /* Give TELNET a way to find out what version this is */
261 static int jim_zy1000_version(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
263 if ((argc
< 1) || (argc
> 3))
265 const char *version_str
= NULL
;
269 version_str
= ZYLIN_OPENOCD_VERSION
;
272 const char *str
= Jim_GetString(argv
[1], NULL
);
273 const char *str2
= NULL
;
275 str2
= Jim_GetString(argv
[2], NULL
);
276 if (strcmp("openocd", str
) == 0)
278 version_str
= ZYLIN_OPENOCD
;
280 else if (strcmp("zy1000", str
) == 0)
282 version_str
= ZYLIN_VERSION
;
284 else if (strcmp("date", str
) == 0)
286 version_str
= ZYLIN_DATE
;
288 else if (strcmp("time", str
) == 0)
290 version_str
= ZYLIN_TIME
;
292 else if (strcmp("pcb", str
) == 0)
294 #ifdef CYGPKG_HAL_NIOS2
300 #ifdef CYGPKG_HAL_NIOS2
301 else if (strcmp("fpga", str
) == 0)
304 /* return a list of 32 bit integers to describe the expected
307 static char *fpga_id
= "0x12345678 0x12345678 0x12345678 0x12345678";
308 cyg_uint32 id
, timestamp
;
309 HAL_READ_UINT32(SYSID_BASE
, id
);
310 HAL_READ_UINT32(SYSID_BASE
+4, timestamp
);
311 sprintf(fpga_id
, "0x%08x 0x%08x 0x%08x 0x%08x", id
, timestamp
, SYSID_ID
, SYSID_TIMESTAMP
);
312 version_str
= fpga_id
;
313 if ((argc
>2) && (strcmp("time", str2
) == 0))
315 time_t last_mod
= timestamp
;
316 char * t
= ctime (&last_mod
) ;
329 Jim_SetResult(interp
, Jim_NewStringObj(interp
, version_str
, -1));
335 #ifdef CYGPKG_HAL_NIOS2
341 struct cyg_upgrade_info
*upgraded_file
;
344 static void report_info(void *data
, const char * format
, va_list args
)
346 char *s
= alloc_vprintf(format
, args
);
351 struct cyg_upgrade_info firmware_info
=
353 (cyg_uint8
*)0x84000000,
359 "ZylinNiosFirmware\n",
363 static int jim_zy1000_writefirmware(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
369 const char *str
= Jim_GetString(argv
[1], &length
);
373 if ((tmpFile
= open(firmware_info
.file
, O_RDWR
| O_CREAT
| O_TRUNC
)) <= 0)
378 success
= write(tmpFile
, str
, length
) == length
;
383 if (!cyg_firmware_upgrade(NULL
, firmware_info
))
391 zylinjtag_Jim_Command_powerstatus(Jim_Interp
*interp
,
393 Jim_Obj
* const *argv
)
397 Jim_WrongNumArgs(interp
, 1, argv
, "powerstatus");
402 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x10, status
);
404 Jim_SetResult(interp
, Jim_NewIntObj(interp
, (status
&0x80) != 0));
412 int zy1000_init(void)
414 LOG_USER("%s", ZYLIN_OPENOCD_VERSION
);
416 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x30); // Turn on LED1 & LED2
418 setPower(true); // on by default
421 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
423 zy1000_speed(jtag_get_speed());
428 int zy1000_quit(void)
436 int interface_jtag_execute_queue(void)
441 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x10, empty
);
442 /* clear JTAG error register */
443 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x400);
445 if ((empty
&0x400) != 0)
447 LOG_WARNING("RCLK timeout");
448 /* the error is informative only as we don't want to break the firmware if there
449 * is a false positive.
451 // return ERROR_FAIL;
460 static cyg_uint32
getShiftValue(void)
464 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0xc, value
);
465 VERBOSE(LOG_INFO("getShiftValue %08x", value
));
469 static cyg_uint32
getShiftValueFlip(void)
473 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x18, value
);
474 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value
));
480 static void shiftValueInnerFlip(const tap_state_t state
, const tap_state_t endState
, int repeat
, cyg_uint32 value
)
482 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state
), tap_state_name(endState
), repeat
, value
));
486 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0xc, value
);
487 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x8, (1 << 15) | (repeat
<< 8) | (a
<< 4) | b
);
488 VERBOSE(getShiftValueFlip());
492 static void gotoEndState(tap_state_t end_state
)
494 setCurrentState(end_state
);
497 static __inline
void scanFields(int num_fields
, const struct scan_field
*fields
, tap_state_t shiftState
, int pause
)
503 for (i
= 0; i
< num_fields
; i
++)
507 uint8_t *inBuffer
= NULL
;
510 // figure out where to store the input data
511 int num_bits
= fields
[i
].num_bits
;
512 if (fields
[i
].in_value
!= NULL
)
514 inBuffer
= fields
[i
].in_value
;
517 // here we shuffle N bits out/in
521 tap_state_t pause_state
;
524 pause_state
= (shiftState
== TAP_DRSHIFT
)?TAP_DRSHIFT
:TAP_IRSHIFT
;
528 /* we have more to shift out */
529 } else if (pause
&&(i
== num_fields
-1))
531 /* this was the last to shift out this time */
532 pause_state
= (shiftState
==TAP_DRSHIFT
)?TAP_DRPAUSE
:TAP_IRPAUSE
;
535 // we have (num_bits + 7)/8 bytes of bits to toggle out.
536 // bits are pushed out LSB to MSB
538 if (fields
[i
].out_value
!= NULL
)
540 for (l
= 0; l
< k
; l
+= 8)
542 value
|=fields
[i
].out_value
[(j
+ l
)/8]<<l
;
545 /* mask away unused bits for easier debugging */
548 value
&=~(((uint32_t)0xffffffff) << k
);
551 /* Shifting by >= 32 is not defined by the C standard
552 * and will in fact shift by &0x1f bits on nios */
555 shiftValueInner(shiftState
, pause_state
, k
, value
);
557 if (inBuffer
!= NULL
)
559 // data in, LSB to MSB
560 value
= getShiftValue();
561 // we're shifting in data to MSB, shift data to be aligned for returning the value
564 for (l
= 0; l
< k
; l
+= 8)
566 inBuffer
[(j
+ l
)/8]=(value
>> l
)&0xff;
574 int interface_jtag_add_ir_scan(int num_fields
, const struct scan_field
*fields
, tap_state_t state
)
579 struct jtag_tap
*tap
, *nextTap
;
580 for (tap
= jtag_tap_next_enabled(NULL
); tap
!= NULL
; tap
= nextTap
)
582 nextTap
= jtag_tap_next_enabled(tap
);
583 int pause
= (nextTap
==NULL
);
587 scan_size
= tap
->ir_length
;
589 /* search the list */
590 for (j
= 0; j
< num_fields
; j
++)
592 if (tap
== fields
[j
].tap
)
596 scanFields(1, fields
+ j
, TAP_IRSHIFT
, pause
);
597 /* update device information */
598 buf_cpy(fields
[j
].out_value
, tap
->cur_instr
, scan_size
);
607 /* if a device isn't listed, set it to BYPASS */
608 uint8_t ones
[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
610 struct scan_field tmp
;
611 memset(&tmp
, 0, sizeof(tmp
));
612 tmp
.out_value
= ones
;
613 tmp
.num_bits
= scan_size
;
614 scanFields(1, &tmp
, TAP_IRSHIFT
, pause
);
615 /* update device information */
616 buf_cpy(tmp
.out_value
, tap
->cur_instr
, scan_size
);
629 int interface_jtag_add_plain_ir_scan(int num_fields
, const struct scan_field
*fields
, tap_state_t state
)
631 scanFields(num_fields
, fields
, TAP_IRSHIFT
, 1);
637 int interface_jtag_add_dr_scan(int num_fields
, const struct scan_field
*fields
, tap_state_t state
)
641 struct jtag_tap
*tap
, *nextTap
;
642 for (tap
= jtag_tap_next_enabled(NULL
); tap
!= NULL
; tap
= nextTap
)
644 nextTap
= jtag_tap_next_enabled(tap
);
646 int pause
= (nextTap
==NULL
);
648 for (j
= 0; j
< num_fields
; j
++)
650 if (tap
== fields
[j
].tap
)
654 scanFields(1, fields
+j
, TAP_DRSHIFT
, pause
);
659 struct scan_field tmp
;
660 /* program the scan field to 1 bit length, and ignore it's value */
662 tmp
.out_value
= NULL
;
665 scanFields(1, &tmp
, TAP_DRSHIFT
, pause
);
675 int interface_jtag_add_plain_dr_scan(int num_fields
, const struct scan_field
*fields
, tap_state_t state
)
677 scanFields(num_fields
, fields
, TAP_DRSHIFT
, 1);
683 int interface_jtag_add_tlr()
685 setCurrentState(TAP_RESET
);
692 int interface_jtag_add_reset(int req_trst
, int req_srst
)
694 zy1000_reset(req_trst
, req_srst
);
698 static int zy1000_jtag_add_clocks(int num_cycles
, tap_state_t state
, tap_state_t clockstate
)
700 /* num_cycles can be 0 */
701 setCurrentState(clockstate
);
703 /* execute num_cycles, 32 at the time. */
705 for (i
= 0; i
< num_cycles
; i
+= 32)
709 if (num_cycles
-i
< num
)
713 shiftValueInner(clockstate
, clockstate
, num
, 0);
717 /* finish in end_state */
718 setCurrentState(state
);
720 tap_state_t t
= TAP_IDLE
;
721 /* test manual drive code on any target */
723 uint8_t tms_scan
= tap_get_tms_path(t
, state
);
724 int tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
726 for (i
= 0; i
< tms_count
; i
++)
728 tms
= (tms_scan
>> i
) & 1;
730 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x28, tms
);
733 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, state
);
740 int interface_jtag_add_runtest(int num_cycles
, tap_state_t state
)
742 return zy1000_jtag_add_clocks(num_cycles
, state
, TAP_IDLE
);
745 int interface_jtag_add_clocks(int num_cycles
)
747 return zy1000_jtag_add_clocks(num_cycles
, cmd_queue_cur_state
, cmd_queue_cur_state
);
750 int interface_jtag_add_sleep(uint32_t us
)
756 int interface_jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
761 /*wait for the fifo to be empty*/
766 tap_state_t cur_state
= cmd_queue_cur_state
;
770 if (tap_state_transition(cur_state
, false) == path
[state_count
])
774 else if (tap_state_transition(cur_state
, true) == path
[state_count
])
780 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[state_count
]));
785 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x28, tms
);
787 cur_state
= path
[state_count
];
793 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, cur_state
);
799 void embeddedice_write_dcc(struct jtag_tap
*tap
, int reg_addr
, uint8_t *buffer
, int little
, int count
)
801 // static int const reg_addr = 0x5;
802 tap_state_t end_state
= jtag_get_end_state();
803 if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL
)) == NULL
)
805 /* better performance via code duplication */
809 for (i
= 0; i
< count
; i
++)
811 shiftValueInner(TAP_DRSHIFT
, TAP_DRSHIFT
, 32, fast_target_buffer_get_u32(buffer
, 1));
812 shiftValueInner(TAP_DRSHIFT
, end_state
, 6, reg_addr
| (1 << 5));
818 for (i
= 0; i
< count
; i
++)
820 shiftValueInner(TAP_DRSHIFT
, TAP_DRSHIFT
, 32, fast_target_buffer_get_u32(buffer
, 0));
821 shiftValueInner(TAP_DRSHIFT
, end_state
, 6, reg_addr
| (1 << 5));
829 for (i
= 0; i
< count
; i
++)
831 embeddedice_write_reg_inner(tap
, reg_addr
, fast_target_buffer_get_u32(buffer
, little
));
838 static const struct command_registration zy1000_commands
[] = {
841 .handler
= handle_power_command
,
843 .help
= "Turn power switch to target on/off. "
844 "With no arguments, prints status.",
845 .usage
= "('on'|'off)",
848 .name
= "zy1000_version",
850 .jim_handler
= jim_zy1000_version
,
851 .help
= "Print version info for zy1000.",
852 .usage
= "['openocd'|'zy1000'|'date'|'time'|'pcb'|'fpga']",
855 .name
= "powerstatus",
857 .jim_handler
= zylinjtag_Jim_Command_powerstatus
,
858 .help
= "Returns power status of target",
860 #ifdef CYGPKG_HAL_NIOS2
862 .name
= "updatezy1000firmware",
864 .jim_handler
= jim_zy1000_writefirmware
,
865 .help
= "writes firmware to flash",
866 /* .usage = "some_string", */
869 COMMAND_REGISTRATION_DONE
874 struct jtag_interface zy1000_interface
=
877 .execute_queue
= NULL
,
878 .speed
= zy1000_speed
,
879 .commands
= zy1000_commands
,
883 .speed_div
= zy1000_speed_div
,
884 .power_dropout
= zy1000_power_dropout
,
885 .srst_asserted
= zy1000_srst_asserted
,
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)