zy1000: add support for Linux host
[openocd.git] / src / jtag / zy1000 / jtag_minidriver.h
1 /***************************************************************************
2 * Copyright (C) 2007-2010 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 /* used to test manual mode */
21 #define TEST_MANUAL() 0
22 #define VERBOSE(a)
23
24 #if BUILD_ZY1000_MASTER
25
26 #if BUILD_ECOSBOARD
27 #include <cyg/hal/hal_io.h> // low level i/o
28 #include <cyg/hal/hal_intr.h> // low level i/o
29 #define ZY1000_PEEK(a, b) HAL_READ_UINT32(a, b)
30 #define ZY1000_POKE(a, b) HAL_WRITE_UINT32(a, b)
31 #else
32 #define ZY1000_PEEK(a, b) do {b = *( ( volatile uint32_t *)(a) );} while (0)
33 #define ZY1000_POKE(a, b) do {*( ( volatile uint32_t *)(a) ) = b;} while (0)
34 extern volatile void *zy1000_jtag_master;
35 #define ZY1000_JTAG_BASE ((unsigned long)zy1000_jtag_master)
36 #endif
37
38 #else
39
40 /* redirect this to TCP/IP */
41 #define ZY1000_JTAG_BASE 0
42 extern void zy1000_tcpout(uint32_t address, uint32_t data);
43 extern uint32_t zy1000_tcpin(uint32_t address);
44 #define ZY1000_PEEK(a, b) b=zy1000_tcpin(a)
45 #define ZY1000_POKE(a, b) zy1000_tcpout(a, b)
46
47 #endif
48
49
50
51 #if BUILD_ZY1000_MASTER
52 // FIFO empty?
53 static __inline__ void waitIdle(void)
54 {
55 uint32_t empty;
56 do
57 {
58 ZY1000_PEEK(ZY1000_JTAG_BASE + 0x10, empty);
59 } while ((empty & 0x100) == 0);
60 }
61
62 static __inline__ void zy1000_flush_readqueue(void)
63 {
64 /* Not used w/hardware fifo */
65 }
66 static __inline__ void zy1000_flush_callbackqueue(void)
67 {
68 /* Not used w/hardware fifo */
69 }
70 #else
71 extern void waitIdle(void);
72 void zy1000_flush_readqueue(void);
73 void zy1000_flush_callbackqueue(void);
74 void zy1000_jtag_add_callback4(jtag_callback_t callback, jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3);
75 void zy1000_jtag_add_callback(jtag_callback1_t callback, jtag_callback_data_t data0);
76 #endif
77
78 static __inline__ void waitQueue(void)
79 {
80 // waitIdle();
81 }
82
83 static __inline__ void sampleShiftRegister(void)
84 {
85 #if 0
86 uint32_t dummy;
87 waitIdle();
88 ZY1000_PEEK(ZY1000_JTAG_BASE + 0xc, dummy);
89 #endif
90 }
91
92 static __inline__ void setCurrentState(enum tap_state state)
93 {
94 uint32_t a;
95 a = state;
96 int repeat = 0;
97 if (state == TAP_RESET)
98 {
99 // The FPGA nor we know the current state of the CPU TAP
100 // controller. This will move it to TAP for sure.
101 //
102 // 5 should be enough here, 7 is what OpenOCD uses
103 repeat = 7;
104 }
105 waitQueue();
106 sampleShiftRegister();
107 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | a);
108
109 }
110
111 /*
112 * Enter state and cause repeat transitions *out* of that state. So if the endState != state, then
113 * the transition from state to endState counts as a transition out of state.
114 */
115 static __inline__ void shiftValueInner(const enum tap_state state, const enum tap_state endState, int repeat, uint32_t value)
116 {
117 uint32_t a,b;
118 a = state;
119 b = endState;
120 waitQueue();
121 sampleShiftRegister();
122 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value);
123 #if 1
124 #if TEST_MANUAL()
125 if ((state == TAP_DRSHIFT) && (endState != TAP_DRSHIFT))
126 {
127 int i;
128 setCurrentState(state);
129 for (i = 0; i < repeat; i++)
130 {
131 int tms;
132 tms = 0;
133 if ((i == repeat-1) && (state != endState))
134 {
135 tms = 1;
136 }
137 /* shift out value */
138 waitIdle();
139 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, (((value >> i)&1) << 1) | tms);
140 }
141 waitIdle();
142 ZY1000_POKE(ZY1000_JTAG_BASE + 0x28, 0);
143 waitIdle();
144 //ZY1000_POKE(ZY1000_JTAG_BASE + 0x20, TAP_DRSHIFT); // set this state and things break => expected
145 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.
146 setCurrentState(endState);
147 } else
148 {
149 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
150 }
151 #else
152 /* fast version */
153 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
154 #endif
155 #else
156 /* maximum debug version */
157 if ((repeat > 0) && ((state == TAP_DRSHIFT)||(state == TAP_SI)))
158 {
159 int i;
160 /* sample shift register for every bit. */
161 for (i = 0; i < repeat-1; i++)
162 {
163 sampleShiftRegister();
164 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> i);
165 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | a);
166 }
167 sampleShiftRegister();
168 ZY1000_POKE(ZY1000_JTAG_BASE + 0xc, value >> (repeat-1));
169 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (1 << 8) | (a << 4) | b);
170 } else
171 {
172 sampleShiftRegister();
173 ZY1000_POKE(ZY1000_JTAG_BASE + 0x8, (repeat << 8) | (a << 4) | b);
174 }
175 sampleShiftRegister();
176 #endif
177 }
178
179
180
181 static __inline__ void interface_jtag_add_dr_out_core(struct jtag_tap *target_tap,
182 int num_fields,
183 const int *num_bits,
184 const uint32_t *value,
185 enum tap_state end_state)
186 {
187 enum tap_state pause_state = TAP_DRSHIFT;
188
189 struct jtag_tap *tap, *nextTap;
190 for (tap = jtag_tap_next_enabled(NULL); tap!= NULL; tap = nextTap)
191 {
192 nextTap = jtag_tap_next_enabled(tap);
193 if (nextTap == NULL)
194 {
195 pause_state = end_state;
196 }
197 if (tap == target_tap)
198 {
199 int j;
200 for (j = 0; j < (num_fields-1); j++)
201 {
202 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[j], value[j]);
203 }
204 shiftValueInner(TAP_DRSHIFT, pause_state, num_bits[j], value[j]);
205 } else
206 {
207 /* program the scan field to 1 bit length, and ignore it's value */
208 shiftValueInner(TAP_DRSHIFT, pause_state, 1, 0);
209 }
210 }
211 }
212
213 static __inline__ void interface_jtag_add_dr_out(struct jtag_tap *target_tap,
214 int num_fields,
215 const int *num_bits,
216 const uint32_t *value,
217 enum tap_state end_state)
218 {
219
220 int singletap = (jtag_tap_next_enabled(jtag_tap_next_enabled(NULL)) == NULL);
221 if ((singletap) && (num_fields == 3))
222 {
223 /* used by embeddedice_write_reg_inner() */
224 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
225 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[1], value[1]);
226 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[2], value[2]);
227 } else if ((singletap) && (num_fields == 2))
228 {
229 /* used by arm7 code */
230 shiftValueInner(TAP_DRSHIFT, TAP_DRSHIFT, num_bits[0], value[0]);
231 shiftValueInner(TAP_DRSHIFT, end_state, num_bits[1], value[1]);
232 } else
233 {
234 interface_jtag_add_dr_out_core(target_tap, num_fields, num_bits, value, end_state);
235 }
236 }
237
238 #if BUILD_ZY1000_MASTER
239 #define interface_jtag_add_callback(callback, in) callback(in)
240 #define interface_jtag_add_callback4(callback, in, data1, data2, data3) jtag_set_error(callback(in, data1, data2, data3))
241 #else
242 #define interface_jtag_add_callback(callback, in) zy1000_jtag_add_callback(callback, in)
243 #define interface_jtag_add_callback4(callback, in, data1, data2, data3) zy1000_jtag_add_callback4(callback, in, data1, data2, data3)
244 #endif

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)