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 curently 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 /* static information preserved between calls to increase performance */
47 static int in_idx; /* index of byte being scanned */
48 static uint8_t in_mask; /* mask of next bit to be scanned */
50 struct scan_field* field;
53 /* loop through the queue */
54 while (bitq_in_state.cmd)
56 /* only JTAG_SCAN command may return data */
57 if (bitq_in_state.cmd->type == JTAG_SCAN)
59 /* loop through the fields */
60 while (bitq_in_state.field_idx < bitq_in_state.cmd->cmd.scan->num_fields)
62 field = &bitq_in_state.cmd->cmd.scan->fields[bitq_in_state.field_idx];
65 if (bitq_in_state.bit_pos == 0)
67 /* initialize field scanning */
73 while (bitq_in_state.bit_pos < field->num_bits)
75 if ((tdo = bitq_interface->in()) < 0)
77 #ifdef _DEBUG_JTAG_IO_
78 LOG_DEBUG("bitq in EOF");
83 field->in_value[in_idx] = 0;
85 field->in_value[in_idx] |= in_mask;
93 bitq_in_state.bit_pos++;
97 bitq_in_state.field_idx++; /* advance to next field */
98 bitq_in_state.bit_pos = 0; /* start next field from the first bit */
101 bitq_in_state.cmd = bitq_in_state.cmd->next; /* advance to next command */
102 bitq_in_state.field_idx = 0; /* preselect first field */
107 void bitq_io(int tms, int tdi, int tdo_req)
109 bitq_interface->out(tms, tdi, tdo_req);
110 /* check and process the input queue */
111 if (bitq_interface->in_rdy())
116 void bitq_end_state(tap_state_t state)
118 if (!tap_is_state_stable(state))
120 LOG_ERROR("BUG: %i is not a valid end state", state);
123 tap_set_end_state(state);
127 void bitq_state_move(tap_state_t new_state)
132 if (!tap_is_state_stable(tap_get_state()) || !tap_is_state_stable(new_state))
134 LOG_ERROR("TAP move from or to unstable state");
138 tms_scan = tap_get_tms_path(tap_get_state(), new_state);
139 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
141 for (i = 0; i < tms_count; i++)
143 bitq_io(tms_scan & 1, 0, 0);
147 tap_set_state(new_state);
151 void bitq_path_move(struct pathmove_command* cmd)
155 for (i = 0; i <= cmd->num_states; i++)
157 if (tap_state_transition(tap_get_state(), false) == cmd->path[i])
159 else if (tap_state_transition(tap_get_state(), true) == cmd->path[i])
163 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(
164 tap_get_state()), tap_state_name(cmd->path[i]));
168 tap_set_state(cmd->path[i]);
171 tap_set_end_state(tap_get_state());
175 void bitq_runtest(int num_cycles)
179 /* only do a state_move when we're not already in IDLE */
180 if (tap_get_state() != TAP_IDLE)
181 bitq_state_move(TAP_IDLE);
183 /* execute num_cycles */
184 for (i = 0; i < num_cycles; i++)
187 /* finish in end_state */
188 if (tap_get_state() != tap_get_end_state())
189 bitq_state_move(tap_get_end_state());
193 void bitq_scan_field(struct scan_field* field, int do_pause)
198 const uint8_t* out_ptr;
206 if (field->out_value == NULL)
208 /* just send zeros and request data from TDO */
209 for (bit_cnt = field->num_bits; bit_cnt > 1; bit_cnt--)
210 bitq_io(0, 0, tdo_req);
212 bitq_io(do_pause, 0, tdo_req);
216 /* send data, and optionally request TDO */
218 out_ptr = field->out_value;
219 for (bit_cnt = field->num_bits; bit_cnt > 1; bit_cnt--)
221 bitq_io(0, ((*out_ptr) & out_mask) != 0, tdo_req);
222 if (out_mask == 0x80)
231 bitq_io(do_pause, ((*out_ptr) & out_mask) != 0, tdo_req);
237 if (tap_get_state() == TAP_IRSHIFT)
238 tap_set_state(TAP_IRPAUSE);
239 else if (tap_get_state() == TAP_DRSHIFT)
240 tap_set_state(TAP_DRPAUSE);
245 void bitq_scan(struct scan_command* cmd)
250 bitq_state_move(TAP_IRSHIFT);
252 bitq_state_move(TAP_DRSHIFT);
254 for (i = 0; i < cmd->num_fields - 1; i++)
255 bitq_scan_field(&cmd->fields[i], 0);
257 bitq_scan_field(&cmd->fields[i], 1);
261 int bitq_execute_queue(void)
263 struct jtag_command* cmd = jtag_command_queue; /* currently processed command */
265 bitq_in_state.cmd = jtag_command_queue;
266 bitq_in_state.field_idx = 0;
267 bitq_in_state.bit_pos = 0;
268 bitq_in_state.status = ERROR_OK;
275 #ifdef _DEBUG_JTAG_IO_
276 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
278 if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_get_reset_config() & RESET_SRST_PULLS_TRST)))
280 tap_set_state(TAP_RESET);
282 bitq_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
283 if (bitq_interface->in_rdy())
288 #ifdef _DEBUG_JTAG_IO_
289 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
291 bitq_end_state(cmd->cmd.runtest->end_state);
292 bitq_runtest(cmd->cmd.runtest->num_cycles);
296 #ifdef _DEBUG_JTAG_IO_
297 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
299 bitq_end_state(cmd->cmd.statemove->end_state);
300 bitq_state_move(tap_get_end_state()); /* uncoditional TAP move */
304 #ifdef _DEBUG_JTAG_IO_
305 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
306 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
308 bitq_path_move(cmd->cmd.pathmove);
312 #ifdef _DEBUG_JTAG_IO_
313 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
314 if (cmd->cmd.scan->ir_scan)
315 LOG_DEBUG("scan ir");
317 LOG_DEBUG("scan dr");
319 bitq_end_state(cmd->cmd.scan->end_state);
320 bitq_scan(cmd->cmd.scan);
321 if (tap_get_state() != tap_get_end_state())
322 bitq_state_move(tap_get_end_state());
326 #ifdef _DEBUG_JTAG_IO_
327 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
329 bitq_interface->sleep(cmd->cmd.sleep->us);
330 if (bitq_interface->in_rdy())
335 LOG_ERROR("BUG: unknown JTAG command type encountered");
342 bitq_interface->flush();
345 if (bitq_in_state.cmd)
347 LOG_ERROR("missing data from bitq interface");
348 return ERROR_JTAG_QUEUE_FAILED;
350 if (bitq_interface->in() >= 0)
352 LOG_ERROR("extra data from bitq interface");
353 return ERROR_JTAG_QUEUE_FAILED;
356 return bitq_in_state.status;
360 void bitq_cleanup(void)