- fixed arm926 cp15 command bug (thanks to Vincent Palatin for this patch)
[openocd.git] / src / jtag / jtag.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
14 * *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #ifndef JTAG_H
21 #define JTAG_H
22
23 #include "types.h"
24 #include "binarybuffer.h"
25
26 #include "command.h"
27
28 #if 1
29 #define _DEBUG_JTAG_IO_
30 #endif
31
32 /* Tap States
33 * TLR - Test-Logic-Reset, RTI - Run-Test/Idle,
34 * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR,
35 * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR,
36 * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR,
37 * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR
38 */
39 enum tap_state
40 {
41 TAP_TLR = 0x0, TAP_RTI = 0x8,
42 TAP_SDS = 0x1, TAP_CD = 0x2, TAP_SD = 0x3, TAP_E1D = 0x4,
43 TAP_PD = 0x5, TAP_E2D = 0x6, TAP_UD = 0x7,
44 TAP_SIS = 0x9, TAP_CI = 0xa, TAP_SI = 0xb, TAP_E1I = 0xc,
45 TAP_PI = 0xd, TAP_E2I = 0xe, TAP_UI = 0xf
46 };
47
48 typedef struct tap_transition_s
49 {
50 enum tap_state high;
51 enum tap_state low;
52 } tap_transition_t;
53
54 extern char* tap_state_strings[16];
55 extern int tap_move_map[16]; /* map 16 TAP states to 6 stable states */
56 extern u8 tap_move[6][6]; /* value scanned to TMS to move from one of six stable states to another */
57 extern tap_transition_t tap_transitions[16]; /* describe the TAP state diagram */
58
59 extern enum tap_state end_state; /* finish DR scans in dr_end_state */
60 extern enum tap_state cur_state; /* current TAP state */
61
62 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
63
64 typedef struct scan_field_s
65 {
66 int device; /* ordinal device number this instruction refers to */
67 int num_bits; /* number of bits this field specifies (up to 32) */
68 u8 *out_value; /* value to be scanned into the device */
69 u8 *out_mask; /* only masked bits care */
70 u8 *in_value; /* pointer to a 32-bit memory location to take data scanned out */
71 u8 *in_check_value; /* used to validate scan results */
72 u8 *in_check_mask; /* check specified bits against check_value */
73 int (*in_handler)(u8 *in_value, void *priv); /* process received buffer using this handler */
74 void *in_handler_priv; /* additional information for the in_handler */
75 } scan_field_t;
76
77 enum scan_type
78 {
79 /* IN: from device to host, OUT: from host to device */
80 SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
81 };
82
83 typedef struct scan_command_s
84 {
85 int ir_scan; /* instruction/not data scan */
86 int num_fields; /* number of fields in *fields array */
87 scan_field_t *fields; /* pointer to an array of data scan fields */
88 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
89 } scan_command_t;
90
91 typedef struct statemove_command_s
92 {
93 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
94 } statemove_command_t;
95
96 typedef struct pathmove_command_s
97 {
98 int num_states; /* number of states in *path */
99 enum tap_state *path; /* states that have to be passed */
100 } pathmove_command_t;
101
102 typedef struct runtest_command_s
103 {
104 int num_cycles; /* number of cycles that should be spent in Run-Test/Idle */
105 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
106 } runtest_command_t;
107
108 typedef struct reset_command_s
109 {
110 int trst; /* trst/srst 0: deassert, 1: assert, -1: don't change */
111 int srst;
112 } reset_command_t;
113
114 typedef struct end_state_command_s
115 {
116 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
117 } end_state_command_t;
118
119 typedef struct sleep_command_s
120 {
121 u32 us; /* number of microseconds to sleep */
122 } sleep_command_t;
123
124 typedef union jtag_command_container_u
125 {
126 scan_command_t *scan;
127 statemove_command_t *statemove;
128 pathmove_command_t *pathmove;
129 runtest_command_t *runtest;
130 reset_command_t *reset;
131 end_state_command_t *end_state;
132 sleep_command_t *sleep;
133 } jtag_command_container_t;
134
135 enum jtag_command_type
136 {
137 JTAG_SCAN = 1,
138 JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
139 JTAG_RESET = 4, JTAG_END_STATE = 5,
140 JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
141 };
142
143 typedef struct jtag_command_s
144 {
145 jtag_command_container_t cmd;
146 enum jtag_command_type type;
147 struct jtag_command_s *next;
148 } jtag_command_t;
149
150 extern jtag_command_t *jtag_command_queue;
151
152 typedef struct jtag_device_s
153 {
154 int ir_length; /* size of instruction register */
155 u8 *expected; /* Capture-IR expected value */
156 u8 *expected_mask; /* Capture-IR expected mask */
157 u32 idcode; /* device identification code */
158 u8 *cur_instr; /* current instruction */
159 int bypass; /* bypass register selected */
160 struct jtag_device_s *next;
161 } jtag_device_t;
162
163 extern jtag_device_t *jtag_devices;
164 extern int jtag_num_devices;
165 extern int jtag_ir_scan_size;
166
167 enum reset_line_mode
168 {
169 LINE_OPEN_DRAIN = 0x0,
170 LINE_PUSH_PULL = 0x1,
171 };
172
173 typedef struct jtag_interface_s
174 {
175 char* name;
176
177 /* queued command execution
178 */
179 int (*execute_queue)(void);
180
181 /* optional command support
182 */
183 int support_pathmove;
184
185 /* interface initalization
186 */
187 int (*speed)(int speed);
188 int (*register_commands)(struct command_context_s *cmd_ctx);
189 int (*init)(void);
190 int (*quit)(void);
191
192 } jtag_interface_t;
193
194 enum jtag_event
195 {
196 JTAG_SRST_ASSERTED,
197 JTAG_TRST_ASSERTED,
198 JTAG_SRST_RELEASED,
199 JTAG_TRST_RELEASED,
200 };
201
202 extern char* jtag_event_strings[];
203
204 extern int jtag_trst;
205 extern int jtag_srst;
206
207 typedef struct jtag_event_callback_s
208 {
209 int (*callback)(enum jtag_event event, void *priv);
210 void *priv;
211 struct jtag_event_callback_s *next;
212 } jtag_event_callback_t;
213
214 extern jtag_event_callback_t *jtag_event_callbacks;
215
216 extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */
217 extern enum tap_state end_state;
218 extern enum tap_state cur_state;
219
220 extern char* jtag_interface;
221 extern int jtag_speed;
222
223 enum reset_types
224 {
225 RESET_NONE = 0x0,
226 RESET_HAS_TRST = 0x1,
227 RESET_HAS_SRST = 0x2,
228 RESET_TRST_AND_SRST = 0x3,
229 RESET_SRST_PULLS_TRST = 0x4,
230 RESET_TRST_PULLS_SRST = 0x8,
231 RESET_TRST_OPEN_DRAIN = 0x10,
232 RESET_SRST_PUSH_PULL = 0x20,
233 };
234
235 extern enum reset_types jtag_reset_config;
236
237 /* JTAG subsystem */
238 extern int jtag_init(struct command_context_s *cmd_ctx);
239 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
240
241 /* JTAG interface */
242 extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
243 extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
244 extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
245 extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
246 extern int jtag_add_statemove(enum tap_state endstate);
247 extern int jtag_add_pathmove(int num_states, enum tap_state *path);
248 extern int jtag_add_runtest(int num_cycles, enum tap_state endstate);
249 extern int jtag_add_reset(int trst, int srst);
250 extern int jtag_add_end_state(enum tap_state endstate);
251 extern int jtag_add_sleep(u32 us);
252 extern int jtag_execute_queue(void);
253 extern int jtag_cancel_queue(void);
254
255 /* JTAG support functions */
256 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
257 extern int jtag_scan_size(scan_command_t *cmd);
258 extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
259 extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
260 extern jtag_device_t* jtag_get_device(int num);
261 extern void jtag_sleep(u32 us);
262 extern int jtag_call_event_callbacks(enum jtag_event event);
263 extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
264
265 /* error codes
266 * JTAG subsystem uses codes between -100 and -199 */
267
268 #define ERROR_JTAG_INIT_FAILED (-100)
269 #define ERROR_JTAG_INVALID_INTERFACE (-101)
270 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
271 #define ERROR_JTAG_TRST_ASSERTED (-103)
272 #define ERROR_JTAG_QUEUE_FAILED (-104)
273 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105)
274 #define ERROR_JTAG_RESET_CANT_SRST (-106)
275 #define ERROR_JTAG_DEVICE_ERROR (-107)
276 #endif /* JTAG_H */