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
26 #include "interface.h"
29 bitq_interface_t* bitq_interface; /* low level bit queue interface */
31 static bitq_state_t bitq_in_state; /* state of input queue */
33 static u8* bitq_in_buffer; /* buffer dynamically reallocated as needed */
34 static int bitq_in_bufsize = 32; /* min. buffer size */
37 * input queue processing does not use jtag_read_buffer() to avoid unnecessary overhead
38 * also the buffer for incomming data is reallocated only if necessary
39 * no parameters, makes use of stored state information
41 void bitq_in_proc(void)
43 /* static information preserved between calls to increase performance */
44 static u8* in_buff; /* pointer to buffer for scanned data */
45 static int in_idx; /* index of byte being scanned */
46 static u8 in_mask; /* mask of next bit to be scanned */
51 /* loop through the queue */
52 while (bitq_in_state.cmd)
54 /* only JTAG_SCAN command may return data */
55 if (bitq_in_state.cmd->type==JTAG_SCAN)
57 /* loop through the fields */
58 while (bitq_in_state.field_idx<bitq_in_state.cmd->cmd.scan->num_fields)
60 field = &bitq_in_state.cmd->cmd.scan->fields[bitq_in_state.field_idx];
63 if (bitq_in_state.bit_pos==0)
65 /* initialize field scanning */
69 in_buff = field->in_value;
72 /* buffer reallocation needed? */
73 if (field->num_bits>bitq_in_bufsize * 8)
75 /* buffer previously allocated? */
76 if (bitq_in_buffer!=NULL)
80 bitq_in_buffer = NULL;
82 /* double the buffer size until it fits */
83 while (field->num_bits>bitq_in_bufsize * 8)
86 /* if necessary, allocate buffer and check for malloc error */
87 if (bitq_in_buffer==NULL && ( bitq_in_buffer = malloc(bitq_in_bufsize) )==NULL)
89 LOG_ERROR("malloc error");
92 in_buff = (void*) bitq_in_buffer;
97 while (bitq_in_state.bit_pos<field->num_bits)
99 if ( ( tdo = bitq_interface->in() )<0 )
101 #ifdef _DEBUG_JTAG_IO_
102 LOG_DEBUG("bitq in EOF");
109 in_buff[in_idx] |= in_mask;
117 bitq_in_state.bit_pos++;
121 bitq_in_state.field_idx++; /* advance to next field */
122 bitq_in_state.bit_pos = 0; /* start next field from the first bit */
125 bitq_in_state.cmd = bitq_in_state.cmd->next; /* advance to next command */
126 bitq_in_state.field_idx = 0; /* preselect first field */
131 void bitq_io(int tms, int tdi, int tdo_req)
133 bitq_interface->out(tms, tdi, tdo_req);
134 /* check and process the input queue */
135 if ( bitq_interface->in_rdy() )
140 void bitq_end_state(tap_state_t state)
142 if (state==TAP_INVALID)
145 if (!tap_is_state_stable(state))
147 LOG_ERROR("BUG: %i is not a valid end state", state);
150 tap_set_end_state(state);
154 void bitq_state_move(tap_state_t new_state)
159 if (!tap_is_state_stable(tap_get_state()) || !tap_is_state_stable(new_state))
161 LOG_ERROR("TAP move from or to unstable state");
165 tms_scan = tap_get_tms_path(tap_get_state(), new_state);
166 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
168 for (i = 0; i<tms_count; i++)
170 bitq_io(tms_scan & 1, 0, 0);
174 tap_set_state(new_state);
178 void bitq_path_move(pathmove_command_t* cmd)
182 for (i = 0; i<=cmd->num_states; i++)
184 if (tap_state_transition(tap_get_state(), false) == cmd->path[i])
186 else if (tap_state_transition(tap_get_state(), true) == cmd->path[i])
190 LOG_ERROR( "BUG: %s -> %s isn't a valid TAP transition", tap_state_name(
191 tap_get_state() ), tap_state_name(cmd->path[i]) );
195 tap_set_state(cmd->path[i]);
198 tap_set_end_state( tap_get_state() );
202 void bitq_runtest(int num_cycles)
206 /* only do a state_move when we're not already in IDLE */
207 if (tap_get_state() != TAP_IDLE)
208 bitq_state_move(TAP_IDLE);
210 /* execute num_cycles */
211 for (i = 0; i < num_cycles; i++)
214 /* finish in end_state */
215 if ( tap_get_state() != tap_get_end_state() )
216 bitq_state_move( tap_get_end_state() );
220 void bitq_scan_field(scan_field_t* field, int pause)
233 if (field->out_value==NULL)
235 /* just send zeros and request data from TDO */
236 for (bit_cnt = field->num_bits; bit_cnt>1; bit_cnt--)
237 bitq_io(0, 0, tdo_req);
239 bitq_io(pause, 0, tdo_req);
243 /* send data, and optionally request TDO */
245 out_ptr = field->out_value;
246 for (bit_cnt = field->num_bits; bit_cnt>1; bit_cnt--)
248 bitq_io(0, ( (*out_ptr) & out_mask )!=0, tdo_req);
258 bitq_io(pause, ( (*out_ptr) & out_mask )!=0, tdo_req);
264 if (tap_get_state()==TAP_IRSHIFT)
265 tap_set_state(TAP_IRPAUSE);
266 else if (tap_get_state()==TAP_DRSHIFT)
267 tap_set_state(TAP_DRPAUSE);
272 void bitq_scan(scan_command_t* cmd)
277 bitq_state_move(TAP_IRSHIFT);
279 bitq_state_move(TAP_DRSHIFT);
281 for (i = 0; i < cmd->num_fields - 1; i++)
282 bitq_scan_field(&cmd->fields[i], 0);
284 bitq_scan_field(&cmd->fields[i], 1);
288 int bitq_execute_queue(void)
290 jtag_command_t* cmd = jtag_command_queue; /* currently processed command */
292 bitq_in_state.cmd = jtag_command_queue;
293 bitq_in_state.field_idx = 0;
294 bitq_in_state.bit_pos = 0;
295 bitq_in_state.status = ERROR_OK;
302 #ifdef _DEBUG_JTAG_IO_
303 LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
305 if ( (cmd->cmd.reset->trst == 1) || ( cmd->cmd.reset->srst && (jtag_reset_config & RESET_SRST_PULLS_TRST) ) )
307 tap_set_state(TAP_RESET);
309 bitq_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
310 if ( bitq_interface->in_rdy() )
315 #ifdef _DEBUG_JTAG_IO_
316 LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
318 bitq_end_state(cmd->cmd.runtest->end_state);
319 bitq_runtest(cmd->cmd.runtest->num_cycles);
323 #ifdef _DEBUG_JTAG_IO_
324 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
326 bitq_end_state(cmd->cmd.statemove->end_state);
327 bitq_state_move( tap_get_end_state() ); /* uncoditional TAP move */
331 #ifdef _DEBUG_JTAG_IO_
332 LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
333 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
335 bitq_path_move(cmd->cmd.pathmove);
339 #ifdef _DEBUG_JTAG_IO_
340 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
341 if (cmd->cmd.scan->ir_scan)
342 LOG_DEBUG("scan ir");
344 LOG_DEBUG("scan dr");
346 bitq_end_state(cmd->cmd.scan->end_state);
347 bitq_scan(cmd->cmd.scan);
348 if ( tap_get_state() != tap_get_end_state() )
349 bitq_state_move( tap_get_end_state() );
353 #ifdef _DEBUG_JTAG_IO_
354 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
356 bitq_interface->sleep(cmd->cmd.sleep->us);
357 if ( bitq_interface->in_rdy() )
362 LOG_ERROR("BUG: unknown JTAG command type encountered");
369 bitq_interface->flush();
372 if (bitq_in_state.cmd)
374 LOG_ERROR("missing data from bitq interface");
375 return ERROR_JTAG_QUEUE_FAILED;
377 if (bitq_interface->in()>=0)
379 LOG_ERROR("extra data from bitq interface");
380 return ERROR_JTAG_QUEUE_FAILED;
383 return bitq_in_state.status;
387 void bitq_cleanup(void)
389 if (bitq_in_buffer!=NULL)
391 free(bitq_in_buffer);
392 bitq_in_buffer = NULL;