]> git.sur5r.net Git - openocd/blob - src/jtag/zy1000/zy1000.c
- Fixes '[|]' whitespace
[openocd] / src / jtag / zy1000 / zy1000.c
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
22
23 #include "embeddedice.h"
24 #include "minidriver.h"
25 #include "interface.h"
26
27 #include <cyg/hal/hal_io.h>             // low level i/o
28 #include <cyg/hal/hal_diag.h>
29
30
31 #define ZYLIN_VERSION "1.52"
32 #define ZYLIN_DATE __DATE__
33 #define ZYLIN_TIME __TIME__
34 #define ZYLIN_OPENOCD "$Revision$"
35 #define ZYLIN_OPENOCD_VERSION "Zylin JTAG ZY1000 " ZYLIN_VERSION " " ZYLIN_DATE " " ZYLIN_TIME
36
37 /* low level command set
38  */
39 void zy1000_reset(int trst, int srst);
40
41
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);
46
47 /* interface commands */
48 int zy1000_handle_zy1000_port_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49
50 static int zy1000_khz(int khz, int *jtag_speed)
51 {
52         if (khz == 0)
53         {
54                 *jtag_speed = 0;
55         }
56         else
57         {
58                 *jtag_speed = 64000/khz;
59         }
60         return ERROR_OK;
61 }
62
63 static int zy1000_speed_div(int speed, int *khz)
64 {
65         if (speed == 0)
66         {
67                 *khz = 0;
68         }
69         else
70         {
71                 *khz = 64000/speed;
72         }
73
74         return ERROR_OK;
75 }
76
77 static bool readPowerDropout(void)
78 {
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;
86 }
87
88
89 static bool readSRST(void)
90 {
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;
98 }
99
100 static int zy1000_srst_asserted(int *srst_asserted)
101 {
102         *srst_asserted = readSRST();
103         return ERROR_OK;
104 }
105
106 static int zy1000_power_dropout(int *dropout)
107 {
108         *dropout = readPowerDropout();
109         return ERROR_OK;
110 }
111
112
113 jtag_interface_t zy1000_interface =
114 {
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,
125 };
126
127 void zy1000_reset(int trst, int srst)
128 {
129         LOG_DEBUG("zy1000 trst=%d, srst=%d", trst, srst);
130         if (!srst)
131         {
132                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000001);
133         }
134         else
135         {
136                 /* Danger!!! if clk != 0 when in
137                  * idle in TAP_IDLE, reset halt on str912 will fail.
138                  */
139                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000001);
140         }
141
142         if (!trst)
143         {
144                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x00000002);
145         }
146         else
147         {
148                 /* assert reset */
149                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x00000002);
150         }
151
152         if (trst||(srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
153         {
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
158         {
159                 /* We'll get RCLK failure when we assert TRST, so clear any false positives here */
160                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
161         }
162
163         /* wait for srst to float back up */
164         if (!srst)
165         {
166                 int i;
167                 for (i = 0; i<1000; i++)
168                 {
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;
174
175                         /* wait 1ms */
176                         alive_sleep(1);
177                 }
178
179                 if (i == 1000)
180                 {
181                         LOG_USER("SRST didn't deassert after %dms", i);
182                 } else if (i>1)
183                 {
184                         LOG_USER("SRST took %dms to deassert", i);
185                 }
186         }
187 }
188
189 int zy1000_speed(int speed)
190 {
191         if (speed == 0)
192         {
193                 /*0 means RCLK*/
194                 speed = 0;
195                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x100);
196                 LOG_DEBUG("jtag_speed using RCLK");
197         }
198         else
199         {
200                 if (speed > 8190 || speed < 2)
201                 {
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;
204                 }
205
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);
209         }
210         return ERROR_OK;
211 }
212
213 static bool savePower;
214
215
216 static void setPower(bool power)
217 {
218         savePower = power;
219         if (power)
220         {
221                 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x14, 0x8);
222         } else
223         {
224                 HAL_WRITE_UINT32(ZY1000_JTAG_BASE + 0x10, 0x8);
225         }
226 }
227
228 int handle_power_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
229 {
230         if (argc > 1)
231         {
232                 return ERROR_INVALID_ARGUMENTS;
233         }
234
235         if (argc == 1)
236         {
237                 if (strcmp(args[0], "on") == 0)
238                 {
239                         setPower(1);
240                 }
241                 else if (strcmp(args[0], "off") == 0)
242                 {
243                         setPower(0);
244                 } else
245                 {
246                         command_print(cmd_ctx, "arg is \"on\" or \"off\"");
247                         return ERROR_INVALID_ARGUMENTS;
248                 }
249         }
250
251         command_print(cmd_ctx, "Target power %s", savePower ? "on" : "off");
252
253         return ERROR_OK;
254 }
255
256
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)
259 {
260         if ((argc < 1) || (argc > 2))
261                 return JIM_ERR;
262         char buff[128];
263         const char *version_str = NULL;
264
265         if (argc == 1)
266         {
267                 version_str = ZYLIN_OPENOCD_VERSION;
268         } else
269         {
270                 const char *str = Jim_GetString(argv[1], NULL);
271                 if (strcmp("openocd", str) == 0)
272                 {
273                         int revision;
274                         revision = atol(ZYLIN_OPENOCD + strlen("XRevision: "));
275                         sprintf(buff, "%d", revision);
276                         version_str = buff;
277                 }
278                 else if (strcmp("zy1000", str) == 0)
279                 {
280                         version_str = ZYLIN_VERSION;
281                 }
282                 else if (strcmp("date", str) == 0)
283                 {
284                         version_str = ZYLIN_DATE;
285                 }
286                 else
287                 {
288                         return JIM_ERR;
289                 }
290         }
291
292         Jim_SetResult(interp, Jim_NewStringObj(interp, version_str, -1));
293
294         return JIM_OK;
295 }
296
297
298 static int
299 zylinjtag_Jim_Command_powerstatus(Jim_Interp *interp,
300                                                                    int argc,
301                 Jim_Obj * const *argv)
302 {
303         if (argc != 1)
304         {
305                 Jim_WrongNumArgs(interp, 1, argv, "powerstatus");
306                 return JIM_ERR;
307         }
308
309         cyg_uint32 status;
310         ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, status);
311
312         Jim_SetResult(interp, Jim_NewIntObj(interp, (status&0x80) != 0));
313
314         return JIM_OK;
315 }
316
317 int zy1000_register_commands(struct command_context_s *cmd_ctx)
318 {
319         register_command(cmd_ctx, NULL, "power", handle_power_command, COMMAND_ANY,
320                         "power <on/off> - turn power switch to target on/off. No arguments - print status.");
321
322         Jim_CreateCommand(interp, "zy1000_version", jim_zy1000_version, NULL, NULL);
323
324
325         Jim_CreateCommand(interp, "powerstatus", zylinjtag_Jim_Command_powerstatus, NULL, NULL);
326
327         return ERROR_OK;
328 }
329
330
331
332
333 int zy1000_init(void)
334 {
335         LOG_USER("%s", ZYLIN_OPENOCD_VERSION);
336
337         ZY1000_POKE(ZY1000_JTAG_BASE + 0x10, 0x30); // Turn on LED1 & LED2
338
339         setPower(true); // on by default
340
341
342          /* deassert resets. Important to avoid infinite loop waiting for SRST to deassert */
343         zy1000_reset(0, 0);
344         zy1000_speed(jtag_get_speed());
345
346         return ERROR_OK;
347 }
348
349 int zy1000_quit(void)
350 {
351
352         return ERROR_OK;
353 }
354
355
356
357 int interface_jtag_execute_queue(void)
358 {
359         cyg_uint32 empty;
360
361         waitIdle();
362         ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
363         /* clear JTAG error register */
364         ZY1000_POKE(ZY1000_JTAG_BASE + 0x14, 0x400);
365
366         if ((empty&0x400) != 0)
367         {
368                 LOG_WARNING("RCLK timeout");
369                 /* the error is informative only as we don't want to break the firmware if there
370                  * is a false positive.
371                  */
372 //              return ERROR_FAIL;
373         }
374         return ERROR_OK;
375 }
376
377
378
379
380
381 static cyg_uint32 getShiftValue(void)
382 {
383         cyg_uint32 value;
384         waitIdle();
385         ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, value);
386         VERBOSE(LOG_INFO("getShiftValue %08x", value));
387         return value;
388 }
389 #if 0
390 static cyg_uint32 getShiftValueFlip(void)
391 {
392         cyg_uint32 value;
393         waitIdle();
394         ZY1000_PEEK(ZY1000_JTAG_BASE + 0x18, value);
395         VERBOSE(LOG_INFO("getShiftValue %08x (flipped)", value));
396         return value;
397 }
398 #endif
399
400 #if 0
401 static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
402 {
403         VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
404         cyg_uint32 a,b;
405         a = state;
406         b = endState;
407         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
408         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 15) | (repeat << 8) | (a << 4) | b);
409         VERBOSE(getShiftValueFlip());
410 }
411 #endif
412
413 extern int jtag_check_value(uint8_t *captured, void *priv);
414
415 static __inline void scanFields(int num_fields, const scan_field_t *fields, tap_state_t shiftState, tap_state_t end_state)
416 {
417         int i;
418         int j;
419         int k;
420
421         for (i = 0; i < num_fields; i++)
422         {
423                 cyg_uint32 value;
424
425                 uint8_t *inBuffer = NULL;
426
427
428                 // figure out where to store the input data
429                 int num_bits = fields[i].num_bits;
430                 if (fields[i].in_value != NULL)
431                 {
432                         inBuffer = fields[i].in_value;
433                 }
434
435                 // here we shuffle N bits out/in
436                 j = 0;
437                 while (j<num_bits)
438                 {
439                         tap_state_t pause_state;
440                         int l;
441                         k = num_bits-j;
442                         pause_state = (shiftState == TAP_DRSHIFT)?TAP_DRSHIFT:TAP_IRSHIFT;
443                         if (k>32)
444                         {
445                                 k = 32;
446                                 /* we have more to shift out */
447                         } else if (i == num_fields-1)
448                         {
449                                 /* this was the last to shift out this time */
450                                 pause_state = end_state;
451                         }
452
453                         // we have (num_bits + 7)/8 bytes of bits to toggle out.
454                         // bits are pushed out LSB to MSB
455                         value = 0;
456                         if (fields[i].out_value != NULL)
457                         {
458                                 for (l = 0; l<k; l += 8)
459                                 {
460                                         value|=fields[i].out_value[(j + l)/8]<<l;
461                                 }
462                         }
463                         /* mask away unused bits for easier debugging */
464                         value&=~(((uint32_t)0xffffffff) << k);
465
466                         shiftValueInner(shiftState, pause_state, k, value);
467
468                         if (inBuffer != NULL)
469                         {
470                                 // data in, LSB to MSB
471                                 value = getShiftValue();
472                                 // we're shifting in data to MSB, shift data to be aligned for returning the value
473                                 value >>= 32-k;
474
475                                 for (l = 0; l<k; l += 8)
476                                 {
477                                         inBuffer[(j + l)/8]=(value >> l)&0xff;
478                                 }
479                         }
480                         j += k;
481                 }
482         }
483 }
484
485 int interface_jtag_set_end_state(tap_state_t state)
486 {
487         return ERROR_OK;
488 }
489
490
491 int interface_jtag_add_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
492 {
493
494         int j;
495         int scan_size = 0;
496         jtag_tap_t *tap, *nextTap;
497         for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
498         {
499                 nextTap = jtag_tap_next_enabled(tap);
500                 tap_state_t end_state;
501                 if (nextTap == NULL)
502                 {
503                         end_state = state;
504                 } else
505                 {
506                         end_state = TAP_IRSHIFT;
507                 }
508
509                 int found = 0;
510
511                 scan_size = tap->ir_length;
512
513                 /* search the list */
514                 for (j = 0; j < num_fields; j++)
515                 {
516                         if (tap == fields[j].tap)
517                         {
518                                 found = 1;
519
520                                 scanFields(1, fields + j, TAP_IRSHIFT, end_state);
521                                 /* update device information */
522                                 buf_cpy(fields[j].out_value, tap->cur_instr, scan_size);
523
524                                 tap->bypass = 0;
525                                 break;
526                         }
527                 }
528
529                 if (!found)
530                 {
531                         /* if a device isn't listed, set it to BYPASS */
532                         uint8_t ones[]={0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff};
533
534                         scan_field_t tmp;
535                         memset(&tmp, 0, sizeof(tmp));
536                         tmp.out_value = ones;
537                         tmp.num_bits = scan_size;
538                         scanFields(1, &tmp, TAP_IRSHIFT, end_state);
539                         /* update device information */
540                         buf_cpy(tmp.out_value, tap->cur_instr, scan_size);
541                         tap->bypass = 1;
542                 }
543         }
544
545         return ERROR_OK;
546 }
547
548
549
550
551
552 int interface_jtag_add_plain_ir_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
553 {
554         scanFields(num_fields, fields, TAP_IRSHIFT, state);
555
556         return ERROR_OK;
557 }
558
559 /*extern jtag_command_t **jtag_get_last_command_p(void);*/
560
561 int interface_jtag_add_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
562 {
563
564         int j;
565         jtag_tap_t *tap, *nextTap;
566         for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
567         {
568                 nextTap = jtag_tap_next_enabled(tap);
569                 int found = 0;
570                 tap_state_t end_state;
571                 if (nextTap == NULL)
572                 {
573                         end_state = state;
574                 } else
575                 {
576                         end_state = TAP_DRSHIFT;
577                 }
578
579                 for (j = 0; j < num_fields; j++)
580                 {
581                         if (tap == fields[j].tap)
582                         {
583                                 found = 1;
584
585                                 scanFields(1, fields + j, TAP_DRSHIFT, end_state);
586                         }
587                 }
588                 if (!found)
589                 {
590                         scan_field_t tmp;
591                         /* program the scan field to 1 bit length, and ignore it's value */
592                         tmp.num_bits = 1;
593                         tmp.out_value = NULL;
594                         tmp.in_value = NULL;
595
596                         scanFields(1, &tmp, TAP_DRSHIFT, end_state);
597                 }
598                 else
599                 {
600                 }
601         }
602         return ERROR_OK;
603 }
604
605 int interface_jtag_add_plain_dr_scan(int num_fields, const scan_field_t *fields, tap_state_t state)
606 {
607         scanFields(num_fields, fields, TAP_DRSHIFT, state);
608         return ERROR_OK;
609 }
610
611
612 int interface_jtag_add_tlr()
613 {
614         setCurrentState(TAP_RESET);
615         return ERROR_OK;
616 }
617
618
619
620
621 extern int jtag_nsrst_delay;
622 extern int jtag_ntrst_delay;
623
624 int interface_jtag_add_reset(int req_trst, int req_srst)
625 {
626         zy1000_reset(req_trst, req_srst);
627         return ERROR_OK;
628 }
629
630 static int zy1000_jtag_add_clocks(int num_cycles, tap_state_t state, tap_state_t clockstate)
631 {
632         /* num_cycles can be 0 */
633         setCurrentState(clockstate);
634
635         /* execute num_cycles, 32 at the time. */
636         int i;
637         for (i = 0; i<num_cycles; i += 32)
638         {
639                 int num;
640                 num = 32;
641                 if (num_cycles-i<num)
642                 {
643                         num = num_cycles-i;
644                 }
645                 shiftValueInner(clockstate, clockstate, num, 0);
646         }
647
648 #if !TEST_MANUAL()
649         /* finish in end_state */
650         setCurrentState(state);
651 #else
652         tap_state_t t = TAP_IDLE;
653         /* test manual drive code on any target */
654         int tms;
655         uint8_t tms_scan = tap_get_tms_path(t, state);
656         int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
657
658         for (i = 0; i < tms_count; i++)
659         {
660                 tms = (tms_scan >> i) & 1;
661                 waitIdle();
662                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28,  tms);
663         }
664         waitIdle();
665         ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, state);
666 #endif
667
668
669         return ERROR_OK;
670 }
671
672 int interface_jtag_add_runtest(int num_cycles, tap_state_t state)
673 {
674         return zy1000_jtag_add_clocks(num_cycles, state, TAP_IDLE);
675 }
676
677 int interface_jtag_add_clocks(int num_cycles)
678 {
679         return zy1000_jtag_add_clocks(num_cycles, cmd_queue_cur_state, cmd_queue_cur_state);
680 }
681
682 int interface_jtag_add_sleep(uint32_t us)
683 {
684         jtag_sleep(us);
685         return ERROR_OK;
686 }
687
688 int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
689 {
690         int state_count;
691         int tms = 0;
692
693         /*wait for the fifo to be empty*/
694         waitIdle();
695
696         state_count = 0;
697
698         tap_state_t cur_state = cmd_queue_cur_state;
699
700         while (num_states)
701         {
702                 if (tap_state_transition(cur_state, false) == path[state_count])
703                 {
704                         tms = 0;
705                 }
706                 else if (tap_state_transition(cur_state, true) == path[state_count])
707                 {
708                         tms = 1;
709                 }
710                 else
711                 {
712                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[state_count]));
713                         exit(-1);
714                 }
715
716                 waitIdle();
717                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28,  tms);
718
719                 cur_state = path[state_count];
720                 state_count++;
721                 num_states--;
722         }
723
724         waitIdle();
725         ZY1000_POKE(ZY1000_JTAG_BASE + 0x20,  cur_state);
726         return ERROR_OK;
727 }
728
729
730
731 void embeddedice_write_dcc(jtag_tap_t *tap, int reg_addr, uint8_t *buffer, int little, int count)
732 {
733 //      static int const reg_addr = 0x5;
734         tap_state_t end_state = jtag_get_end_state();
735         if (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL)
736         {
737                 /* better performance via code duplication */
738                 if (little)
739                 {
740                         int i;
741                         for (i = 0; i < count; i++)
742                         {
743                                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 1));
744                                 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr | (1 << 5));
745                                 buffer += 4;
746                         }
747                 } else
748                 {
749                         int i;
750                         for (i = 0; i < count; i++)
751                         {
752                                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, 32, fast_target_buffer_get_u32(buffer, 0));
753                                 shiftValueInner(TAP_DRSHIFT, end_state, 6, reg_addr | (1 << 5));
754                                 buffer += 4;
755                         }
756                 }
757         }
758         else
759         {
760                 int i;
761                 for (i = 0; i < count; i++)
762                 {
763                         embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
764                         buffer += 4;
765                 }
766         }
767 }
768
769