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 #define INCLUDE_JTAG_INTERFACE_H
28 bitq_interface_t* bitq_interface; /* low level bit queue interface */
30 static bitq_state_t bitq_in_state; /* state of input queue */
32 static u8* bitq_in_buffer; /* buffer dynamically reallocated as needed */
33 static int bitq_in_bufsize = 32; /* min. buffer size */
36 * input queue processing does not use jtag_read_buffer() to avoid unnecessary overhead
37 * also the buffer for incomming data is reallocated only if necessary
38 * no parameters, makes use of stored state information
40 void bitq_in_proc(void)
42 /* static information preserved between calls to increase performance */
43 static u8* in_buff; /* pointer to buffer for scanned data */
44 static int in_idx; /* index of byte being scanned */
45 static u8 in_mask; /* mask of next bit to be scanned */
50 /* loop through the queue */
51 while (bitq_in_state.cmd)
53 /* only JTAG_SCAN command may return data */
54 if (bitq_in_state.cmd->type==JTAG_SCAN)
56 /* loop through the fields */
57 while (bitq_in_state.field_idx<bitq_in_state.cmd->cmd.scan->num_fields)
59 field = &bitq_in_state.cmd->cmd.scan->fields[bitq_in_state.field_idx];
62 if (bitq_in_state.bit_pos==0)
64 /* initialize field scanning */
68 in_buff = field->in_value;
71 /* buffer reallocation needed? */
72 if (field->num_bits>bitq_in_bufsize * 8)
74 /* buffer previously allocated? */
75 if (bitq_in_buffer!=NULL)
79 bitq_in_buffer = NULL;
81 /* double the buffer size until it fits */
82 while (field->num_bits>bitq_in_bufsize * 8)
85 /* if necessary, allocate buffer and check for malloc error */
86 if (bitq_in_buffer==NULL && ( bitq_in_buffer = malloc(bitq_in_bufsize) )==NULL)
88 LOG_ERROR("malloc error");
91 in_buff = (void*) bitq_in_buffer;
96 while (bitq_in_state.bit_pos<field->num_bits)
98 if ( ( tdo = bitq_interface->in() )<0 )
100 #ifdef _DEBUG_JTAG_IO_
101 LOG_DEBUG("bitq in EOF");
108 in_buff[in_idx] |= in_mask;
116 bitq_in_state.bit_pos++;
120 bitq_in_state.field_idx++; /* advance to next field */
121 bitq_in_state.bit_pos = 0; /* start next field from the first bit */
124 bitq_in_state.cmd = bitq_in_state.cmd->next; /* advance to next command */
125 bitq_in_state.field_idx = 0; /* preselect first field */
130 void bitq_io(int tms, int tdi, int tdo_req)
132 bitq_interface->out(tms, tdi, tdo_req);
133 /* check and process the input queue */
134 if ( bitq_interface->in_rdy() )
139 void bitq_end_state(tap_state_t state)
141 if (state==TAP_INVALID)
144 if (!tap_is_state_stable(state))
146 LOG_ERROR("BUG: %i is not a valid end state", state);
149 tap_set_end_state(state);
153 void bitq_state_move(tap_state_t new_state)
158 if (!tap_is_state_stable(tap_get_state()) || !tap_is_state_stable(new_state))
160 LOG_ERROR("TAP move from or to unstable state");
164 tms_scan = tap_get_tms_path(tap_get_state(), new_state);
165 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
167 for (i = 0; i<tms_count; i++)
169 bitq_io(tms_scan & 1, 0, 0);
173 tap_set_state(new_state);
177 void bitq_path_move(pathmove_command_t* cmd)
181 for (i = 0; i<=cmd->num_states; i++)
183 if (tap_state_transition(tap_get_state(), false) == cmd->path[i])
185 else if (tap_state_transition(tap_get_state(), true) == cmd->path[i])
189 LOG_ERROR( "BUG: %s -> %s isn't a valid TAP transition", tap_state_name(
190 tap_get_state() ), tap_state_name(cmd->path[i]) );
194 tap_set_state(cmd->path[i]);
197 tap_set_end_state( tap_get_state() );
201 void bitq_runtest(int num_cycles)
205 /* only do a state_move when we're not already in IDLE */
206 if (tap_get_state() != TAP_IDLE)
207 bitq_state_move(TAP_IDLE);
209 /* execute num_cycles */
210 for (i = 0; i < num_cycles; i++)
213 /* finish in end_state */
214 if ( tap_get_state() != tap_get_end_state() )
215 bitq_state_move( tap_get_end_state() );
219 void bitq_scan_field(scan_field_t* field, int pause)
232 if (field->out_value==NULL)
234 /* just send zeros and request data from TDO */
235 for (bit_cnt = field->num_bits; bit_cnt>1; bit_cnt--)
236 bitq_io(0, 0, tdo_req);
238 bitq_io(pause, 0, tdo_req);
242 /* send data, and optionally request TDO */
244 out_ptr = field->out_value;
245 for (bit_cnt = field->num_bits; bit_cnt>1; bit_cnt--)
247 bitq_io(0, ( (*out_ptr) & out_mask )!=0, tdo_req);
257 bitq_io(pause, ( (*out_ptr) & out_mask )!=0, tdo_req);
263 if (tap_get_state()==TAP_IRSHIFT)
264 tap_set_state(TAP_IRPAUSE);
265 else if (tap_get_state()==TAP_DRSHIFT)
266 tap_set_state(TAP_DRPAUSE);
271 void bitq_scan(scan_command_t* cmd)
276 bitq_state_move(TAP_IRSHIFT);
278 bitq_state_move(TAP_DRSHIFT);
280 for (i = 0; i < cmd->num_fields - 1; i++)
281 bitq_scan_field(&cmd->fields[i], 0);
283 bitq_scan_field(&cmd->fields[i], 1);
287 int bitq_execute_queue(void)
289 jtag_command_t* cmd = jtag_command_queue; /* currently processed command */
291 bitq_in_state.cmd = jtag_command_queue;
292 bitq_in_state.field_idx = 0;
293 bitq_in_state.bit_pos = 0;
294 bitq_in_state.status = ERROR_OK;
301 #ifdef _DEBUG_JTAG_IO_
302 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
304 if ( (cmd->cmd.reset->trst == 1) || ( cmd->cmd.reset->srst && (jtag_reset_config & RESET_SRST_PULLS_TRST) ) )
306 tap_set_state(TAP_RESET);
308 bitq_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
309 if ( bitq_interface->in_rdy() )
314 #ifdef _DEBUG_JTAG_IO_
315 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
317 bitq_end_state(cmd->cmd.runtest->end_state);
318 bitq_runtest(cmd->cmd.runtest->num_cycles);
322 #ifdef _DEBUG_JTAG_IO_
323 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
325 bitq_end_state(cmd->cmd.statemove->end_state);
326 bitq_state_move( tap_get_end_state() ); /* uncoditional TAP move */
330 #ifdef _DEBUG_JTAG_IO_
331 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
332 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
334 bitq_path_move(cmd->cmd.pathmove);
338 #ifdef _DEBUG_JTAG_IO_
339 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
340 if (cmd->cmd.scan->ir_scan)
341 LOG_DEBUG("scan ir");
343 LOG_DEBUG("scan dr");
345 bitq_end_state(cmd->cmd.scan->end_state);
346 bitq_scan(cmd->cmd.scan);
347 if ( tap_get_state() != tap_get_end_state() )
348 bitq_state_move( tap_get_end_state() );
352 #ifdef _DEBUG_JTAG_IO_
353 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
355 bitq_interface->sleep(cmd->cmd.sleep->us);
356 if ( bitq_interface->in_rdy() )
361 LOG_ERROR("BUG: unknown JTAG command type encountered");
368 bitq_interface->flush();
371 if (bitq_in_state.cmd)
373 LOG_ERROR("missing data from bitq interface");
374 return ERROR_JTAG_QUEUE_FAILED;
376 if (bitq_interface->in()>=0)
378 LOG_ERROR("extra data from bitq interface");
379 return ERROR_JTAG_QUEUE_FAILED;
382 return bitq_in_state.status;
386 void bitq_cleanup(void)
388 if (bitq_in_buffer!=NULL)
390 free(bitq_in_buffer);
391 bitq_in_buffer = NULL;