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.48"
36 #define ZYLIN_DATE __DATE__
37 #define ZYLIN_TIME __TIME__
38 #define ZYLIN_OPENOCD "$Revision: 1241 $"
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 int handle_zy1000_version_command(struct command_context_s
*cmd_ctx
, char *cmd
,
289 char **args
, int argc
)
293 return ERROR_COMMAND_SYNTAX_ERROR
;
297 command_print(cmd_ctx
, ZYLIN_OPENOCD_VERSION
);
299 else if (strcmp("openocd", args
[0]) == 0)
302 revision
= atol(ZYLIN_OPENOCD
+strlen("XRevision: "));
303 command_print(cmd_ctx
, "%d", revision
);
305 else if (strcmp("zy1000", args
[0]) == 0)
307 command_print(cmd_ctx
, "%s", ZYLIN_VERSION
);
309 else if (strcmp("date", args
[0]) == 0)
311 command_print(cmd_ctx
, "%s", ZYLIN_DATE
);
315 return ERROR_COMMAND_SYNTAX_ERROR
;
323 zylinjtag_Jim_Command_powerstatus(Jim_Interp
*interp
,
325 Jim_Obj
* const *argv
)
329 Jim_WrongNumArgs(interp
, 1, argv
, "powerstatus");
334 ZY1000_PEEK(ZY1000_JTAG_BASE
+0x10, status
);
336 Jim_SetResult(interp
, Jim_NewIntObj(interp
, (status
&0x80)!=0));
341 int zy1000_register_commands(struct command_context_s
*cmd_ctx
)
343 register_command(cmd_ctx
, NULL
, "power", handle_power_command
, COMMAND_ANY
,
344 "power <on/off> - turn power switch to target on/off. No arguments - print status.");
345 register_command(cmd_ctx
, NULL
, "zy1000_version", handle_zy1000_version_command
,
346 COMMAND_EXEC
, "show zy1000 version numbers");
348 Jim_CreateCommand(interp
, "powerstatus", zylinjtag_Jim_Command_powerstatus
, NULL
, NULL
);
356 int zy1000_init(void)
358 LOG_USER("%s", ZYLIN_OPENOCD_VERSION
);
360 ZY1000_POKE(ZY1000_JTAG_BASE
+0x10, 0x30); // Turn on LED1 & LED2
362 setPower(true); // on by default
365 /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
367 zy1000_speed(jtag_speed
);
369 bitbang_interface
= &zy1000_bitbang
;
374 int zy1000_quit(void)
383 int interface_jtag_execute_queue(void)
388 ZY1000_PEEK(ZY1000_JTAG_BASE
+0x10, empty
);
389 /* clear JTAG error register */
390 ZY1000_POKE(ZY1000_JTAG_BASE
+0x14, 0x400);
392 if ((empty
&0x400)!=0)
394 LOG_WARNING("RCLK timeout");
395 /* the error is informative only as we don't want to break the firmware if there
396 * is a false positive.
398 // return ERROR_FAIL;
407 static cyg_uint32
getShiftValue(void)
411 ZY1000_PEEK(ZY1000_JTAG_BASE
+0xc, value
);
412 VERBOSE(LOG_INFO("getShiftValue %08x", value
));
416 static cyg_uint32
getShiftValueFlip(void)
420 ZY1000_PEEK(ZY1000_JTAG_BASE
+0x18, value
);
421 VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value
));
427 static void shiftValueInnerFlip(const enum tap_state state
, const enum tap_state endState
, int repeat
, cyg_uint32 value
)
429 VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", jtag_state_name(state
), jtag_state_name(endState
), repeat
, value
));
433 ZY1000_POKE(ZY1000_JTAG_BASE
+0xc, value
);
434 ZY1000_POKE(ZY1000_JTAG_BASE
+0x8, (1<<15)|(repeat
<<8)|(a
<<4)|b
);
435 VERBOSE(getShiftValueFlip());
439 extern int jtag_check_value(u8
*captured
, void *priv
);
441 static void gotoEndState(void)
443 setCurrentState(cmd_queue_end_state
);
446 static __inline
void scanFields(int num_fields
, scan_field_t
*fields
, enum tap_state shiftState
, int pause
)
452 for (i
= 0; i
< num_fields
; i
++)
456 static u8
*in_buff
=NULL
; /* pointer to buffer for scanned data */
457 static int in_buff_size
=0;
461 // figure out where to store the input data
462 int num_bits
=fields
[i
].num_bits
;
463 if (fields
[i
].in_value
!=NULL
)
465 inBuffer
=fields
[i
].in_value
;
466 } else if (fields
[i
].in_handler
!=NULL
)
468 if (in_buff_size
*8<num_bits
)
470 // we need more space
474 in_buff_size
=(num_bits
+7)/8;
475 in_buff
=malloc(in_buff_size
);
478 LOG_ERROR("Out of memory");
479 jtag_error
=ERROR_JTAG_QUEUE_FAILED
;
486 // here we shuffle N bits out/in
490 enum tap_state pause_state
;
493 pause_state
=(shiftState
==TAP_DRSHIFT
)?TAP_DRSHIFT
:TAP_IRSHIFT
;
497 /* we have more to shift out */
498 } else if (pause
&&(i
== num_fields
-1))
500 /* this was the last to shift out this time */
501 pause_state
=(shiftState
==TAP_DRSHIFT
)?TAP_DRPAUSE
:TAP_IRPAUSE
;
504 // we have (num_bits+7)/8 bytes of bits to toggle out.
505 // bits are pushed out LSB to MSB
507 if (fields
[i
].out_value
!=NULL
)
511 value
|=fields
[i
].out_value
[(j
+l
)/8]<<l
;
514 /* mask away unused bits for easier debugging */
515 value
&=~(((u32
)0xffffffff)<<k
);
517 shiftValueInner(shiftState
, pause_state
, k
, value
);
521 // data in, LSB to MSB
522 value
=getShiftValue();
523 // we're shifting in data to MSB, shift data to be aligned for returning the value
528 inBuffer
[(j
+l
)/8]=(value
>>l
)&0xff;
534 if (fields
[i
].in_handler
!=NULL
)
537 int r
=fields
[i
].in_handler(inBuffer
, fields
[i
].in_handler_priv
, fields
+i
);
540 /* this will cause jtag_execute_queue() to return an error */
547 int interface_jtag_add_end_state(enum tap_state state
)
553 int interface_jtag_add_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state state
)
558 jtag_tap_t
*tap
, *nextTap
;
559 for(tap
= jtag_NextEnabledTap(NULL
); tap
!= NULL
; tap
=nextTap
)
561 nextTap
=jtag_NextEnabledTap(tap
);
562 int pause
=(nextTap
==NULL
);
566 scan_size
= tap
->ir_length
;
568 /* search the list */
569 for (j
=0; j
< num_fields
; j
++)
571 if (tap
== fields
[j
].tap
)
575 if ((jtag_verify_capture_ir
)&&(fields
[j
].in_handler
==NULL
))
577 jtag_set_check_value(fields
+j
, tap
->expected
, tap
->expected_mask
, NULL
);
578 } else if (jtag_verify_capture_ir
)
580 fields
[j
].in_check_value
= tap
->expected
;
581 fields
[j
].in_check_mask
= tap
->expected_mask
;
584 scanFields(1, fields
+j
, TAP_IRSHIFT
, pause
);
585 /* update device information */
586 buf_cpy(fields
[j
].out_value
, tap
->cur_instr
, scan_size
);
595 /* if a device isn't listed, set it to BYPASS */
596 u8 ones
[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
599 memset(&tmp
, 0, sizeof(tmp
));
600 tmp
.out_value
= ones
;
601 tmp
.num_bits
= scan_size
;
602 scanFields(1, &tmp
, TAP_IRSHIFT
, pause
);
603 /* update device information */
604 buf_cpy(tmp
.out_value
, tap
->cur_instr
, scan_size
);
617 int interface_jtag_add_plain_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state state
)
619 scanFields(num_fields
, fields
, TAP_IRSHIFT
, 1);
625 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
627 int interface_jtag_add_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state state
)
631 jtag_tap_t
*tap
, *nextTap
;
632 for(tap
= jtag_NextEnabledTap(NULL
); tap
!= NULL
; tap
=nextTap
)
634 nextTap
=jtag_NextEnabledTap(tap
);
636 int pause
=(nextTap
==NULL
);
638 for (j
=0; j
< num_fields
; j
++)
640 if (tap
== fields
[j
].tap
)
644 scanFields(1, fields
+j
, TAP_DRSHIFT
, pause
);
650 /* program the scan field to 1 bit length, and ignore it's value */
652 tmp
.out_value
= NULL
;
655 tmp
.in_check_value
= NULL
;
656 tmp
.in_check_mask
= NULL
;
657 tmp
.in_handler
= NULL
;
658 tmp
.in_handler_priv
= NULL
;
660 scanFields(1, &tmp
, TAP_DRSHIFT
, pause
);
670 int interface_jtag_add_plain_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state state
)
672 scanFields(num_fields
, fields
, TAP_DRSHIFT
, 1);
678 int interface_jtag_add_tlr()
680 setCurrentState(TAP_RESET
);
687 extern int jtag_nsrst_delay
;
688 extern int jtag_ntrst_delay
;
690 int interface_jtag_add_reset(int req_trst
, int req_srst
)
692 zy1000_reset(req_trst
, req_srst
);
696 static int zy1000_jtag_add_clocks(int num_cycles
, enum tap_state state
, enum tap_state clockstate
)
698 /* num_cycles can be 0 */
699 setCurrentState(clockstate
);
701 /* execute num_cycles, 32 at the time. */
703 for (i
=0; i
<num_cycles
; i
+=32)
707 if (num_cycles
-i
<num
)
711 shiftValueInner(clockstate
, clockstate
, num
, 0);
715 /* finish in end_state */
716 setCurrentState(state
);
718 enum tap_state t
=TAP_IDLE
;
719 /* test manual drive code on any target */
721 u8 tms_scan
= TAP_MOVE(t
, state
);
723 for (i
= 0; i
< 7; i
++)
725 tms
= (tms_scan
>> i
) & 1;
727 ZY1000_POKE(ZY1000_JTAG_BASE
+0x28, tms
);
730 ZY1000_POKE(ZY1000_JTAG_BASE
+0x20, state
);
737 int interface_jtag_add_runtest(int num_cycles
, enum tap_state state
)
739 return zy1000_jtag_add_clocks(num_cycles
, state
, TAP_IDLE
);
742 int interface_jtag_add_clocks(int num_cycles
)
744 return zy1000_jtag_add_clocks(num_cycles
, cmd_queue_cur_state
, cmd_queue_end_state
);
747 int interface_jtag_add_sleep(u32 us
)
753 int interface_jtag_add_pathmove(int num_states
, enum tap_state
*path
)
758 /*wait for the fifo to be empty*/
763 enum tap_state cur_state
=cmd_queue_cur_state
;
767 if (tap_transitions
[cur_state
].low
== path
[state_count
])
771 else if (tap_transitions
[cur_state
].high
== path
[state_count
])
777 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", jtag_state_name(cur_state
), jtag_state_name(path
[state_count
]));
782 ZY1000_POKE(ZY1000_JTAG_BASE
+0x28, tms
);
784 cur_state
= path
[state_count
];
790 ZY1000_POKE(ZY1000_JTAG_BASE
+0x20, cur_state
);
796 void embeddedice_write_dcc(jtag_tap_t
*tap
, int reg_addr
, u8
*buffer
, int little
, int count
)
798 // static int const reg_addr=0x5;
799 enum tap_state end_state
=cmd_queue_end_state
;
800 if (jtag_NextEnabledTap(jtag_NextEnabledTap(NULL
))==NULL
)
802 /* better performance via code duplication */
806 for (i
= 0; i
< count
; i
++)
808 shiftValueInner(TAP_DRSHIFT
, TAP_DRSHIFT
, 32, fast_target_buffer_get_u32(buffer
, 1));
809 shiftValueInner(TAP_DRSHIFT
, end_state
, 6, reg_addr
|(1<<5));
815 for (i
= 0; i
< count
; i
++)
817 shiftValueInner(TAP_DRSHIFT
, TAP_DRSHIFT
, 32, fast_target_buffer_get_u32(buffer
, 0));
818 shiftValueInner(TAP_DRSHIFT
, end_state
, 6, reg_addr
|(1<<5));
826 for (i
= 0; i
< count
; i
++)
828 embeddedice_write_reg_inner(tap
, reg_addr
, fast_target_buffer_get_u32(buffer
, little
));
834 int loadFile(const char *fileName
, void **data
, int *len
);
836 /* boolean parameter stored on config */
837 int boolParam(char *var
)
840 char *name
= alloc_printf("%s/%s", zylin_config_dir
, var
);
846 if (loadFile(name
, &data
, &len
) == ERROR_OK
)
850 result
= strncmp((char *) data
, "1", len
) == 0;