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"
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
)
58 *jtag_speed
= 64000/khz
;
63 static int zy1000_speed_div(int speed
, int *khz
)
77 static bool readPowerDropout(void)
80 // sample and clear power dropout
81 HAL_WRITE_UINT32(ZY1000_JTAG_BASE
+ 0x10, 0x80);
82 HAL_READ_UINT32(ZY1000_JTAG_BASE
+ 0x10, state
);
84 powerDropout
= (state
& 0x80) != 0;
89 static bool readSRST(void)
92 // sample and clear SRST sensing
93 HAL_WRITE_UINT32(ZY1000_JTAG_BASE
+ 0x10, 0x00000040);
94 HAL_READ_UINT32(ZY1000_JTAG_BASE
+ 0x10, state
);
96 srstAsserted
= (state
& 0x40) != 0;
100 static int zy1000_srst_asserted(int *srst_asserted
)
102 *srst_asserted
= readSRST();
106 static int zy1000_power_dropout(int *dropout
)
108 *dropout
= readPowerDropout();
113 jtag_interface_t zy1000_interface
=
116 .execute_queue
= NULL
,
117 .speed
= zy1000_speed
,
118 .register_commands
= zy1000_register_commands
,
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
);
132 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x00000001);
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);
144 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x14, 0x00000002);
149 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x00000002);
152 if (trst
||(srst
&& (jtag_get_reset_config() & RESET_SRST_PULLS_TRST
)))
155 /* we're now in the RESET state until trst is deasserted */
156 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, TAP_RESET
);
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 */
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
181 LOG_USER("SRST didn't deassert after %dms", i
);
184 LOG_USER("SRST took %dms to deassert", i
);
189 int zy1000_speed(int speed
)
195 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x10, 0x100);
196 LOG_DEBUG("jtag_speed using RCLK");
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);
213 static bool savePower
;
216 static void setPower(bool power
)
221 HAL_WRITE_UINT32(ZY1000_JTAG_BASE
+ 0x14, 0x8);
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
)
232 return ERROR_INVALID_ARGUMENTS
;
237 if (strcmp(args
[0], "on") == 0)
241 else if (strcmp(args
[0], "off") == 0)
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");
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))
263 const char *version_str
= NULL
;
267 version_str
= ZYLIN_OPENOCD_VERSION
;
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
301 Jim_SetResult(interp
, Jim_NewStringObj(interp
, version_str
, -1));
307 #ifdef CYGPKG_HAL_NIOS2
308 static int jim_zy1000_writefirmware(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
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
)
326 if ((stat
= flash_erase((void *)firmware_address
, firmware_length
, (void **)&err_addr
)) != 0)
331 if ((stat
= flash_program(firmware_address
, str
, length
, (void **)&err_addr
)) != 0)
339 zylinjtag_Jim_Command_powerstatus(Jim_Interp
*interp
,
341 Jim_Obj
* const *argv
)
345 Jim_WrongNumArgs(interp
, 1, argv
, "powerstatus");
350 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x10, status
);
352 Jim_SetResult(interp
, Jim_NewIntObj(interp
, (status
&0x80) != 0));
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
);
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 */
389 zy1000_speed(jtag_get_speed());
394 int zy1000_quit(void)
402 int interface_jtag_execute_queue(void)
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;
426 static cyg_uint32
getShiftValue(void)
430 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0xc, value
);
431 VERBOSE(LOG_INFO("getShiftValue %08x", value
));
435 static cyg_uint32
getShiftValueFlip(void)
439 ZY1000_PEEK(ZY1000_JTAG_BASE
+ 0x18, value
);
440 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value
));
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
));
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());
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
)
471 for (i
= 0; i
< num_fields
; i
++)
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
489 tap_state_t pause_state
;
492 pause_state
= (shiftState
== TAP_DRSHIFT
)?TAP_DRSHIFT
:TAP_IRSHIFT
;
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
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
525 for (l
= 0; l
< k
; l
+= 8)
527 inBuffer
[(j
+ l
)/8]=(value
>> l
)&0xff;
535 int interface_jtag_set_end_state(tap_state_t state
)
541 int interface_jtag_add_ir_scan(int num_fields
, const scan_field_t
*fields
, tap_state_t state
)
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
);
554 scan_size
= tap
->ir_length
;
556 /* search the list */
557 for (j
= 0; j
< num_fields
; j
++)
559 if (tap
== fields
[j
].tap
)
563 scanFields(1, fields
+ j
, TAP_IRSHIFT
, pause
);
564 /* update device information */
565 buf_cpy(fields
[j
].out_value
, tap
->cur_instr
, scan_size
);
574 /* if a device isn't listed, set it to BYPASS */
575 uint8_t ones
[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
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
);
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);
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
)
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
);
615 int pause
= (nextTap
==NULL
);
617 for (j
= 0; j
< num_fields
; j
++)
619 if (tap
== fields
[j
].tap
)
623 scanFields(1, fields
+j
, TAP_DRSHIFT
, pause
);
629 /* program the scan field to 1 bit length, and ignore it's value */
631 tmp
.out_value
= NULL
;
634 scanFields(1, &tmp
, TAP_DRSHIFT
, pause
);
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);
652 int interface_jtag_add_tlr()
654 setCurrentState(TAP_RESET
);
661 int interface_jtag_add_reset(int req_trst
, int req_srst
)
663 zy1000_reset(req_trst
, req_srst
);
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. */
674 for (i
= 0; i
< num_cycles
; i
+= 32)
678 if (num_cycles
-i
< num
)
682 shiftValueInner(clockstate
, clockstate
, num
, 0);
686 /* finish in end_state */
687 setCurrentState(state
);
689 tap_state_t t
= TAP_IDLE
;
690 /* test manual drive code on any target */
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;
699 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x28, tms
);
702 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, state
);
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
)
725 int interface_jtag_add_pathmove(int num_states
, const tap_state_t
*path
)
730 /*wait for the fifo to be empty*/
735 tap_state_t cur_state
= cmd_queue_cur_state
;
739 if (tap_state_transition(cur_state
, false) == path
[state_count
])
743 else if (tap_state_transition(cur_state
, true) == path
[state_count
])
749 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state
), tap_state_name(path
[state_count
]));
754 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x28, tms
);
756 cur_state
= path
[state_count
];
762 ZY1000_POKE(ZY1000_JTAG_BASE
+ 0x20, cur_state
);
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 */
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));
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));
798 for (i
= 0; i
< count
; i
++)
800 embeddedice_write_reg_inner(tap
, reg_addr
, fast_target_buffer_get_u32(buffer
, little
));