target_t -> struct target
[fw/openocd] / src / jtag / zy1000 / jtag_minidriver.h
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
20 #include <cyg/hal/hal_io.h>             // low level i/o
21
22 //#define VERBOSE(a) a
23 #define VERBOSE(a)
24
25 /* used to test manual mode */
26 #define TEST_MANUAL() 0
27
28 #if 0
29 int  diag_printf(const char *fmt, ...);
30 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b); diag_printf("poke 0x%08x,0x%08x\n", a, b)
31 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b); diag_printf("peek 0x%08x = 0x%08x\n", a, b)
32 #else
33 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b)
34 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b)
35 #endif
36
37 // FIFO empty?
38 static __inline__ void waitIdle(void)
39 {
40         cyg_uint32 empty;
41         do
42         {
43                 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
44         } while ((empty & 0x100) == 0);
45 }
46
47 static __inline__ void waitQueue(void)
48 {
49 //      waitIdle();
50 }
51
52 static void sampleShiftRegister(void)
53 {
54 #if 0
55         cyg_uint32 dummy;
56         waitIdle();
57         ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, dummy);
58 #endif
59 }
60
61 /* -O3 will inline this for us */
62 static void setCurrentState(enum tap_state state)
63 {
64         cyg_uint32 a;
65         a = state;
66         int repeat = 0;
67         if (state == TAP_RESET)
68         {
69                 // The FPGA nor we know the current state of the CPU TAP
70                 // controller. This will move it to TAP for sure.
71                 //
72                 // 5 should be enough here, 7 is what OpenOCD uses
73                 repeat = 7;
74         }
75         waitQueue();
76         sampleShiftRegister();
77         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | a);
78
79 }
80
81 /*
82  * Enter state and cause repeat transitions *out* of that state. So if the endState != state, then
83  * the transition from state to endState counts as a transition out of state.
84  */
85 static __inline__ void shiftValueInner(const enum tap_state state, const enum tap_state endState, int repeat, cyg_uint32 value)
86 {
87         cyg_uint32 a,b;
88         a = state;
89         b = endState;
90         waitQueue();
91         sampleShiftRegister();
92         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
93 #if 1
94 #if TEST_MANUAL()
95         if ((state == TAP_DRSHIFT) && (endState != TAP_DRSHIFT))
96         {
97                 int i;
98                 setCurrentState(state);
99                 for (i = 0; i < repeat; i++)
100                 {
101                         int tms;
102                         tms = 0;
103                         if ((i == repeat-1) && (state != endState))
104                         {
105                                 tms = 1;
106                         }
107                         /* shift out value */
108                         waitIdle();
109                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, (((value >> i)&1) << 1) | tms);
110                 }
111                 waitIdle();
112                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, 0);
113                 waitIdle();
114                 //ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRSHIFT); // set this state and things break => expected
115                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRPAUSE); // set this and things will work => expected. Not setting this is not sufficient to make things break.
116                 setCurrentState(endState);
117         } else
118         {
119                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
120         }
121 #else
122         /* fast version */
123         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
124 #endif
125 #else
126         /* maximum debug version */
127         if ((repeat > 0) && ((state == TAP_DRSHIFT)||(state == TAP_SI)))
128         {
129                 int i;
130                 /* sample shift register for every bit. */
131                 for (i = 0; i < repeat-1; i++)
132                 {
133                         sampleShiftRegister();
134                         ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> i);
135                         ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | a);
136                 }
137                 sampleShiftRegister();
138                 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> (repeat-1));
139                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | b);
140         } else
141         {
142                 sampleShiftRegister();
143                 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
144         }
145         sampleShiftRegister();
146 #endif
147 }
148
149
150
151 static __inline__ void interface_jtag_add_dr_out_core(struct jtag_tap *struct targetap,
152                 int num_fields,
153                 const int *num_bits,
154                 const uint32_t *value,
155                 enum tap_state end_state)
156 {
157         enum tap_state pause_state = TAP_DRSHIFT;
158
159         struct jtag_tap *tap, *nextTap;
160         for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
161         {
162                 nextTap = jtag_tap_next_enabled(tap);
163                 if (nextTap == NULL)
164                 {
165                         pause_state = end_state;
166                 }
167                 if (tap == struct targetap)
168                 {
169                         int j;
170                         for (j = 0; j < (num_fields-1); j++)
171                         {
172                                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[j], value[j]);
173                         }
174                         shiftValueInner(TAP_DRSHIFT, pause_state, num_bits[j], value[j]);
175                 } else
176                 {
177                         /* program the scan field to 1 bit length, and ignore it's value */
178                         shiftValueInner(TAP_DRSHIFT, pause_state, 1, 0);
179                 }
180         }
181 }
182
183 static __inline__ void interface_jtag_add_dr_out(struct jtag_tap *struct targetap,
184                 int num_fields,
185                 const int *num_bits,
186                 const uint32_t *value,
187                 enum tap_state end_state)
188 {
189
190         int singletap = (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL);
191         if ((singletap) && (num_fields == 3))
192         {
193                 /* used by embeddedice_write_reg_inner() */
194                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
195                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[1], value[1]);
196                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[2], value[2]);
197         } else if ((singletap) && (num_fields == 2))
198         {
199                 /* used by arm7 code */
200                 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
201                 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[1], value[1]);
202         } else
203         {
204                 interface_jtag_add_dr_out_core(struct targetap, num_fields, num_bits, value, end_state);
205         }
206 }
207
208 #define interface_jtag_add_callback(callback, in) callback(in)
209
210 #define interface_jtag_add_callback4(callback, in, data1, data2, data3) jtag_set_error(callback(in, data1, data2, data3))