Convert DEBUG_JTAG_IO to LOG_DEBUG_IO
[openocd.git] / src / jtag / interface.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2009 Zachary T Welch *
9 * zw@superlucidity.net *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
24
25 #ifndef OPENOCD_JTAG_INTERFACE_H
26 #define OPENOCD_JTAG_INTERFACE_H
27
28 #include <jtag/jtag.h>
29 #include <target/armv7m_trace.h>
30
31 /* @file
32 * The "Cable Helper API" is what the cable drivers can use to help
33 * implement their "Cable API". So a Cable Helper API is a set of
34 * helper functions used by cable drivers, and this is different from a
35 * Cable API. A "Cable API" is what higher level code used to talk to a
36 * cable.
37 */
38
39
40 /** implementation of wrapper function tap_set_state() */
41 void tap_set_state_impl(tap_state_t new_state);
42
43 /**
44 * This function sets the state of a "state follower" which tracks the
45 * state of the TAPs connected to the cable. The state follower is
46 * hopefully always in the same state as the actual TAPs in the jtag
47 * chain, and will be so if there are no bugs in the tracking logic
48 * within that cable driver.
49 *
50 * All the cable drivers call this function to indicate the state they
51 * think the TAPs attached to their cables are in. Because this
52 * function can also log transitions, it will be helpful to call this
53 * function with every transition that the TAPs being manipulated are
54 * expected to traverse, not just end points of a multi-step state path.
55 *
56 * @param new_state The state we think the TAPs are currently in (or
57 * are about to enter).
58 */
59 #define tap_set_state(new_state) \
60 do { \
61 LOG_DEBUG_IO("tap_set_state(%s)", tap_state_name(new_state)); \
62 tap_set_state_impl(new_state); \
63 } while (0)
64
65 /**
66 * This function gets the state of the "state follower" which tracks the
67 * state of the TAPs connected to the cable. @see tap_set_state @return
68 * tap_state_t The state the TAPs are in now.
69 */
70 tap_state_t tap_get_state(void);
71
72 /**
73 * This function sets the state of an "end state follower" which tracks
74 * the state that any cable driver thinks will be the end (resultant)
75 * state of the current TAP SIR or SDR operation.
76 *
77 * At completion of that TAP operation this value is copied into the
78 * state follower via tap_set_state().
79 *
80 * @param new_end_state The state the TAPs should enter at completion of
81 * a pending TAP operation.
82 */
83 void tap_set_end_state(tap_state_t new_end_state);
84
85 /**
86 * For more information, @see tap_set_end_state
87 * @return tap_state_t - The state the TAPs should be in at completion of the current TAP operation.
88 */
89 tap_state_t tap_get_end_state(void);
90
91 /**
92 * This function provides a "bit sequence" indicating what has to be
93 * done with TMS during a sequence of seven TAP clock cycles in order to
94 * get from state \a "from" to state \a "to".
95 *
96 * The length of the sequence must be determined with a parallel call to
97 * tap_get_tms_path_len().
98 *
99 * @param from The starting state.
100 * @param to The desired final state.
101 * @return int The required TMS bit sequence, with the first bit in the
102 * sequence at bit 0.
103 */
104 int tap_get_tms_path(tap_state_t from, tap_state_t to);
105
106 /**
107 * Function int tap_get_tms_path_len
108 * returns the total number of bits that represents a TMS path
109 * transition as given by the function tap_get_tms_path().
110 *
111 * For at least one interface (JLink) it's not OK to simply "pad" TMS
112 * sequences to fit a whole byte. (I suspect this is a general TAP
113 * problem within OOCD.) Padding TMS causes all manner of instability
114 * that's not easily discovered. Using this routine we can apply
115 * EXACTLY the state transitions required to make something work - no
116 * more - no less.
117 *
118 * @param from is the starting state
119 * @param to is the resultant or final state
120 * @return int - the total number of bits in a transition.
121 */
122 int tap_get_tms_path_len(tap_state_t from, tap_state_t to);
123
124
125 /**
126 * Function tap_move_ndx
127 * when given a stable state, returns an index from 0-5. The index corresponds to a
128 * sequence of stable states which are given in this order: <p>
129 * { TAP_RESET, TAP_IDLE, TAP_DRSHIFT, TAP_DRPAUSE, TAP_IRSHIFT, TAP_IRPAUSE }
130 * <p>
131 * This sequence corresponds to look up tables which are used in some of the
132 * cable drivers.
133 * @param astate is the stable state to find in the sequence. If a non stable
134 * state is passed, this may cause the program to output an error message
135 * and terminate.
136 * @return int - the array (or sequence) index as described above
137 */
138 int tap_move_ndx(tap_state_t astate);
139
140 /**
141 * Function tap_is_state_stable
142 * returns true if the \a astate is stable.
143 */
144 bool tap_is_state_stable(tap_state_t astate);
145
146 /**
147 * Function tap_state_transition
148 * takes a current TAP state and returns the next state according to the tms value.
149 * @param current_state is the state of a TAP currently.
150 * @param tms is either zero or non-zero, just like a real TMS line in a jtag interface.
151 * @return tap_state_t - the next state a TAP would enter.
152 */
153 tap_state_t tap_state_transition(tap_state_t current_state, bool tms);
154
155 /** Allow switching between old and new TMS tables. @see tap_get_tms_path */
156 void tap_use_new_tms_table(bool use_new);
157 /** @returns True if new TMS table is active; false otherwise. */
158 bool tap_uses_new_tms_table(void);
159
160
161 /**
162 * @brief Prints verbose TAP state transitions for the given TMS/TDI buffers.
163 * @param tms_buf must points to a buffer containing the TMS bitstream.
164 * @param tdi_buf must points to a buffer containing the TDI bitstream.
165 * @param tap_len must specify the length of the TMS/TDI bitstreams.
166 * @param start_tap_state must specify the current TAP state.
167 * @returns the final TAP state; pass as @a start_tap_state in following call.
168 */
169 static inline tap_state_t jtag_debug_state_machine(const void *tms_buf,
170 const void *tdi_buf, unsigned tap_len, tap_state_t start_tap_state)
171 {
172 /* Private declaration */
173 tap_state_t jtag_debug_state_machine_(const void *tms_buf, const void *tdi_buf,
174 unsigned tap_len, tap_state_t start_tap_state);
175
176 if (LOG_LEVEL_IS(LOG_LVL_DEBUG_IO))
177 return jtag_debug_state_machine_(tms_buf, tdi_buf, tap_len, start_tap_state);
178 else
179 return start_tap_state;
180 }
181
182 /**
183 * Represents a driver for a debugging interface.
184 *
185 * @todo Rename; perhaps "debug_driver". This isn't an interface,
186 * it's a driver! Also, not all drivers support JTAG.
187 *
188 * @todo We need a per-instance structure too, and changes to pass
189 * that structure to the driver. Instances can for example be in
190 * either SWD or JTAG modes. This will help remove globals, and
191 * eventually to cope with systems which have more than one such
192 * debugging interface.
193 */
194 struct jtag_interface {
195 /** The name of the JTAG interface driver. */
196 const char * const name;
197
198 /**
199 * Bit vector listing capabilities exposed by this driver.
200 */
201 unsigned supported;
202 #define DEBUG_CAP_TMS_SEQ (1 << 0)
203
204 /** transports supported in C code (NULL terminated vector) */
205 const char * const *transports;
206
207 const struct swd_driver *swd;
208
209 /**
210 * Execute queued commands.
211 * @returns ERROR_OK on success, or an error code on failure.
212 */
213 int (*execute_queue)(void);
214
215 /**
216 * Set the interface speed.
217 * @param speed The new interface speed setting.
218 * @returns ERROR_OK on success, or an error code on failure.
219 */
220 int (*speed)(int speed);
221
222 /**
223 * The interface driver may register additional commands to expose
224 * additional features not covered by the standard command set.
225 */
226 const struct command_registration *commands;
227
228 /**
229 * Interface driver must initialize any resources and connect to a
230 * JTAG device.
231 *
232 * quit() is invoked if and only if init() succeeds. quit() is always
233 * invoked if init() succeeds. Same as malloc() + free(). Always
234 * invoke free() if malloc() succeeds and do not invoke free()
235 * otherwise.
236 *
237 * @returns ERROR_OK on success, or an error code on failure.
238 */
239 int (*init)(void);
240
241 /**
242 * Interface driver must tear down all resources and disconnect from
243 * the JTAG device.
244 *
245 * @returns ERROR_OK on success, or an error code on failure.
246 */
247 int (*quit)(void);
248
249 /**
250 * Returns JTAG maxium speed for KHz. 0 = RTCK. The function returns
251 * a failure if it can't support the KHz/RTCK.
252 *
253 * WARNING!!!! if RTCK is *slow* then think carefully about
254 * whether you actually want to support this in the driver.
255 * Many target scripts are written to handle the absence of RTCK
256 * and use a fallback kHz TCK.
257 * @returns ERROR_OK on success, or an error code on failure.
258 */
259 int (*khz)(int khz, int *jtag_speed);
260
261 /**
262 * Calculate the clock frequency (in KHz) for the given @a speed.
263 * @param speed The desired interface speed setting.
264 * @param khz On return, contains the speed in KHz (0 for RTCK).
265 * @returns ERROR_OK on success, or an error code if the
266 * interface cannot support the specified speed (KHz or RTCK).
267 */
268 int (*speed_div)(int speed, int *khz);
269
270 /**
271 * Read and clear the power dropout flag. Note that a power dropout
272 * can be transitionary, easily much less than a ms.
273 *
274 * To find out if the power is *currently* on, one must invoke this
275 * method twice. Once to clear the power dropout flag and a second
276 * time to read the current state. The default implementation
277 * never reports power dropouts.
278 *
279 * @returns ERROR_OK on success, or an error code on failure.
280 */
281 int (*power_dropout)(int *power_dropout);
282
283 /**
284 * Read and clear the srst asserted detection flag.
285 *
286 * Like power_dropout this does *not* read the current
287 * state. SRST assertion is transitionary and may be much
288 * less than 1ms, so the interface driver must watch for these
289 * events until this routine is called.
290 *
291 * @param srst_asserted On return, indicates whether SRST has
292 * been asserted.
293 * @returns ERROR_OK on success, or an error code on failure.
294 */
295 int (*srst_asserted)(int *srst_asserted);
296
297 /**
298 * Configure trace parameters for the adapter
299 *
300 * @param enabled Whether to enable trace
301 * @param pin_protocol Configured pin protocol
302 * @param port_size Trace port width for sync mode
303 * @param trace_freq A pointer to the configured trace
304 * frequency; if it points to 0, the adapter driver must write
305 * its maximum supported rate there
306 * @returns ERROR_OK on success, an error code on failure.
307 */
308 int (*config_trace)(bool enabled, enum tpiu_pin_protocol pin_protocol,
309 uint32_t port_size, unsigned int *trace_freq);
310
311 /**
312 * Poll for new trace data
313 *
314 * @param buf A pointer to buffer to store received data
315 * @param size A pointer to buffer size; must be filled with
316 * the actual amount of bytes written
317 *
318 * @returns ERROR_OK on success, an error code on failure.
319 */
320 int (*poll_trace)(uint8_t *buf, size_t *size);
321 };
322
323 extern const char * const jtag_only[];
324
325 void adapter_assert_reset(void);
326 void adapter_deassert_reset(void);
327 int adapter_config_trace(bool enabled, enum tpiu_pin_protocol pin_protocol,
328 uint32_t port_size, unsigned int *trace_freq);
329 int adapter_poll_trace(uint8_t *buf, size_t *size);
330
331 #endif /* OPENOCD_JTAG_INTERFACE_H */