1 /***************************************************************************
2 * Copyright (C) 2007 by Pavel Chromy *
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. *
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. *
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 ***************************************************************************/
24 #include <jtag/jtag.h>
26 #include <jtag/interface.h>
29 struct bitq_interface* bitq_interface; /* low level bit queue interface */
31 /* state of input queue */
33 struct jtag_command *cmd; /* command currently processed */
34 int field_idx; /* index of field currently being processed */
35 int bit_pos; /* position of bit currently being processed */
36 int status; /* processing status */
38 static struct bitq_state bitq_in_state;
41 * input queue processing does not use jtag_read_buffer() to avoid unnecessary overhead
42 * no parameters, makes use of stored state information
44 void bitq_in_proc(void)
46 struct scan_field* field;
49 /* loop through the queue */
50 while (bitq_in_state.cmd)
52 /* only JTAG_SCAN command may return data */
53 if (bitq_in_state.cmd->type == JTAG_SCAN)
55 /* loop through the fields */
56 while (bitq_in_state.field_idx < bitq_in_state.cmd->cmd.scan->num_fields)
58 field = &bitq_in_state.cmd->cmd.scan->fields[bitq_in_state.field_idx];
62 while (bitq_in_state.bit_pos < field->num_bits)
64 /* index of byte being scanned */
65 int in_idx = bitq_in_state.bit_pos / 8;
66 /* mask of next bit to be scanned */
67 uint8_t in_mask = 1 << (bitq_in_state.bit_pos % 8);
69 if ((tdo = bitq_interface->in()) < 0)
71 #ifdef _DEBUG_JTAG_IO_
72 LOG_DEBUG("bitq in EOF");
77 field->in_value[in_idx] = 0;
79 field->in_value[in_idx] |= in_mask;
80 bitq_in_state.bit_pos++;
84 bitq_in_state.field_idx++; /* advance to next field */
85 bitq_in_state.bit_pos = 0; /* start next field from the first bit */
88 bitq_in_state.cmd = bitq_in_state.cmd->next; /* advance to next command */
89 bitq_in_state.field_idx = 0; /* preselect first field */
94 void bitq_io(int tms, int tdi, int tdo_req)
96 bitq_interface->out(tms, tdi, tdo_req);
97 /* check and process the input queue */
98 if (bitq_interface->in_rdy())
103 void bitq_end_state(tap_state_t state)
105 if (!tap_is_state_stable(state))
107 LOG_ERROR("BUG: %i is not a valid end state", state);
110 tap_set_end_state(state);
114 void bitq_state_move(tap_state_t new_state)
119 if (!tap_is_state_stable(tap_get_state()) || !tap_is_state_stable(new_state))
121 LOG_ERROR("TAP move from or to unstable state");
125 tms_scan = tap_get_tms_path(tap_get_state(), new_state);
126 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
128 for (i = 0; i < tms_count; i++)
130 bitq_io(tms_scan & 1, 0, 0);
134 tap_set_state(new_state);
138 void bitq_path_move(struct pathmove_command* cmd)
142 for (i = 0; i <= cmd->num_states; i++)
144 if (tap_state_transition(tap_get_state(), false) == cmd->path[i])
146 else if (tap_state_transition(tap_get_state(), true) == cmd->path[i])
150 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(
151 tap_get_state()), tap_state_name(cmd->path[i]));
155 tap_set_state(cmd->path[i]);
158 tap_set_end_state(tap_get_state());
162 void bitq_runtest(int num_cycles)
166 /* only do a state_move when we're not already in IDLE */
167 if (tap_get_state() != TAP_IDLE)
168 bitq_state_move(TAP_IDLE);
170 /* execute num_cycles */
171 for (i = 0; i < num_cycles; i++)
174 /* finish in end_state */
175 if (tap_get_state() != tap_get_end_state())
176 bitq_state_move(tap_get_end_state());
180 void bitq_scan_field(struct scan_field* field, int do_pause)
185 const uint8_t* out_ptr;
193 if (field->out_value == NULL)
195 /* just send zeros and request data from TDO */
196 for (bit_cnt = field->num_bits; bit_cnt > 1; bit_cnt--)
197 bitq_io(0, 0, tdo_req);
199 bitq_io(do_pause, 0, tdo_req);
203 /* send data, and optionally request TDO */
205 out_ptr = field->out_value;
206 for (bit_cnt = field->num_bits; bit_cnt > 1; bit_cnt--)
208 bitq_io(0, ((*out_ptr) & out_mask) != 0, tdo_req);
209 if (out_mask == 0x80)
218 bitq_io(do_pause, ((*out_ptr) & out_mask) != 0, tdo_req);
224 if (tap_get_state() == TAP_IRSHIFT)
225 tap_set_state(TAP_IRPAUSE);
226 else if (tap_get_state() == TAP_DRSHIFT)
227 tap_set_state(TAP_DRPAUSE);
232 void bitq_scan(struct scan_command* cmd)
237 bitq_state_move(TAP_IRSHIFT);
239 bitq_state_move(TAP_DRSHIFT);
241 for (i = 0; i < cmd->num_fields - 1; i++)
242 bitq_scan_field(&cmd->fields[i], 0);
244 bitq_scan_field(&cmd->fields[i], 1);
248 int bitq_execute_queue(void)
250 struct jtag_command* cmd = jtag_command_queue; /* currently processed command */
252 bitq_in_state.cmd = jtag_command_queue;
253 bitq_in_state.field_idx = 0;
254 bitq_in_state.bit_pos = 0;
255 bitq_in_state.status = ERROR_OK;
262 #ifdef _DEBUG_JTAG_IO_
263 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
265 if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
267 tap_set_state(TAP_RESET);
269 bitq_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
270 if (bitq_interface->in_rdy())
275 #ifdef _DEBUG_JTAG_IO_
276 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
278 bitq_end_state(cmd->cmd.runtest->end_state);
279 bitq_runtest(cmd->cmd.runtest->num_cycles);
283 #ifdef _DEBUG_JTAG_IO_
284 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
286 bitq_end_state(cmd->cmd.statemove->end_state);
287 bitq_state_move(tap_get_end_state()); /* uncoditional TAP move */
291 #ifdef _DEBUG_JTAG_IO_
292 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
293 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
295 bitq_path_move(cmd->cmd.pathmove);
299 #ifdef _DEBUG_JTAG_IO_
300 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
301 if (cmd->cmd.scan->ir_scan)
302 LOG_DEBUG("scan ir");
304 LOG_DEBUG("scan dr");
306 bitq_end_state(cmd->cmd.scan->end_state);
307 bitq_scan(cmd->cmd.scan);
308 if (tap_get_state() != tap_get_end_state())
309 bitq_state_move(tap_get_end_state());
313 #ifdef _DEBUG_JTAG_IO_
314 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
316 bitq_interface->sleep(cmd->cmd.sleep->us);
317 if (bitq_interface->in_rdy())
322 LOG_ERROR("BUG: unknown JTAG command type encountered");
329 bitq_interface->flush();
332 if (bitq_in_state.cmd)
334 LOG_ERROR("missing data from bitq interface");
335 return ERROR_JTAG_QUEUE_FAILED;
337 if (bitq_interface->in() >= 0)
339 LOG_ERROR("extra data from bitq interface");
340 return ERROR_JTAG_QUEUE_FAILED;
343 return bitq_in_state.status;
347 void bitq_cleanup(void)