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
;
40 static uint8_t* bitq_in_buffer
; /* buffer dynamically reallocated as needed */
41 static int bitq_in_bufsize
= 32; /* min. buffer size */
44 * input queue processing does not use jtag_read_buffer() to avoid unnecessary overhead
45 * also the buffer for incomming data is reallocated only if necessary
46 * no parameters, makes use of stored state information
48 void bitq_in_proc(void)
50 /* static information preserved between calls to increase performance */
51 static uint8_t* in_buff
; /* pointer to buffer for scanned data */
52 static int in_idx
; /* index of byte being scanned */
53 static uint8_t in_mask
; /* mask of next bit to be scanned */
55 struct scan_field
* field
;
58 /* loop through the queue */
59 while (bitq_in_state
.cmd
)
61 /* only JTAG_SCAN command may return data */
62 if (bitq_in_state
.cmd
->type
== JTAG_SCAN
)
64 /* loop through the fields */
65 while (bitq_in_state
.field_idx
< bitq_in_state
.cmd
->cmd
.scan
->num_fields
)
67 field
= &bitq_in_state
.cmd
->cmd
.scan
->fields
[bitq_in_state
.field_idx
];
70 if (bitq_in_state
.bit_pos
== 0)
72 /* initialize field scanning */
76 in_buff
= field
->in_value
;
79 /* buffer reallocation needed? */
80 if (field
->num_bits
> bitq_in_bufsize
* 8)
82 /* buffer previously allocated? */
83 if (bitq_in_buffer
!= NULL
)
87 bitq_in_buffer
= NULL
;
89 /* double the buffer size until it fits */
90 while (field
->num_bits
> bitq_in_bufsize
* 8)
93 /* if necessary, allocate buffer and check for malloc error */
94 if (bitq_in_buffer
== NULL
&& (bitq_in_buffer
= malloc(bitq_in_bufsize
)) == NULL
)
96 LOG_ERROR("malloc error");
99 in_buff
= (void*) bitq_in_buffer
;
104 while (bitq_in_state
.bit_pos
< field
->num_bits
)
106 if ((tdo
= bitq_interface
->in()) < 0)
108 #ifdef _DEBUG_JTAG_IO_
109 LOG_DEBUG("bitq in EOF");
116 in_buff
[in_idx
] |= in_mask
;
124 bitq_in_state
.bit_pos
++;
128 bitq_in_state
.field_idx
++; /* advance to next field */
129 bitq_in_state
.bit_pos
= 0; /* start next field from the first bit */
132 bitq_in_state
.cmd
= bitq_in_state
.cmd
->next
; /* advance to next command */
133 bitq_in_state
.field_idx
= 0; /* preselect first field */
138 void bitq_io(int tms
, int tdi
, int tdo_req
)
140 bitq_interface
->out(tms
, tdi
, tdo_req
);
141 /* check and process the input queue */
142 if (bitq_interface
->in_rdy())
147 void bitq_end_state(tap_state_t state
)
149 if (!tap_is_state_stable(state
))
151 LOG_ERROR("BUG: %i is not a valid end state", state
);
154 tap_set_end_state(state
);
158 void bitq_state_move(tap_state_t new_state
)
163 if (!tap_is_state_stable(tap_get_state()) || !tap_is_state_stable(new_state
))
165 LOG_ERROR("TAP move from or to unstable state");
169 tms_scan
= tap_get_tms_path(tap_get_state(), new_state
);
170 int tms_count
= tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
172 for (i
= 0; i
< tms_count
; i
++)
174 bitq_io(tms_scan
& 1, 0, 0);
178 tap_set_state(new_state
);
182 void bitq_path_move(struct pathmove_command
* cmd
)
186 for (i
= 0; i
<= cmd
->num_states
; i
++)
188 if (tap_state_transition(tap_get_state(), false) == cmd
->path
[i
])
190 else if (tap_state_transition(tap_get_state(), true) == cmd
->path
[i
])
194 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(
195 tap_get_state()), tap_state_name(cmd
->path
[i
]));
199 tap_set_state(cmd
->path
[i
]);
202 tap_set_end_state(tap_get_state());
206 void bitq_runtest(int num_cycles
)
210 /* only do a state_move when we're not already in IDLE */
211 if (tap_get_state() != TAP_IDLE
)
212 bitq_state_move(TAP_IDLE
);
214 /* execute num_cycles */
215 for (i
= 0; i
< num_cycles
; i
++)
218 /* finish in end_state */
219 if (tap_get_state() != tap_get_end_state())
220 bitq_state_move(tap_get_end_state());
224 void bitq_scan_field(struct scan_field
* field
, int pause
)
229 const uint8_t* out_ptr
;
237 if (field
->out_value
== NULL
)
239 /* just send zeros and request data from TDO */
240 for (bit_cnt
= field
->num_bits
; bit_cnt
> 1; bit_cnt
--)
241 bitq_io(0, 0, tdo_req
);
243 bitq_io(pause
, 0, tdo_req
);
247 /* send data, and optionally request TDO */
249 out_ptr
= field
->out_value
;
250 for (bit_cnt
= field
->num_bits
; bit_cnt
> 1; bit_cnt
--)
252 bitq_io(0, ((*out_ptr
) & out_mask
) != 0, tdo_req
);
253 if (out_mask
== 0x80)
262 bitq_io(pause
, ((*out_ptr
) & out_mask
) != 0, tdo_req
);
268 if (tap_get_state() == TAP_IRSHIFT
)
269 tap_set_state(TAP_IRPAUSE
);
270 else if (tap_get_state() == TAP_DRSHIFT
)
271 tap_set_state(TAP_DRPAUSE
);
276 void bitq_scan(struct scan_command
* cmd
)
281 bitq_state_move(TAP_IRSHIFT
);
283 bitq_state_move(TAP_DRSHIFT
);
285 for (i
= 0; i
< cmd
->num_fields
- 1; i
++)
286 bitq_scan_field(&cmd
->fields
[i
], 0);
288 bitq_scan_field(&cmd
->fields
[i
], 1);
292 int bitq_execute_queue(void)
294 struct jtag_command
* cmd
= jtag_command_queue
; /* currently processed command */
296 bitq_in_state
.cmd
= jtag_command_queue
;
297 bitq_in_state
.field_idx
= 0;
298 bitq_in_state
.bit_pos
= 0;
299 bitq_in_state
.status
= ERROR_OK
;
306 #ifdef _DEBUG_JTAG_IO_
307 LOG_DEBUG("reset trst: %i srst %i", cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
309 if ((cmd
->cmd
.reset
->trst
== 1) || (cmd
->cmd
.reset
->srst
&& (jtag_get_reset_config() & RESET_SRST_PULLS_TRST
)))
311 tap_set_state(TAP_RESET
);
313 bitq_interface
->reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
314 if (bitq_interface
->in_rdy())
319 #ifdef _DEBUG_JTAG_IO_
320 LOG_DEBUG("runtest %i cycles, end in %i", cmd
->cmd
.runtest
->num_cycles
, cmd
->cmd
.runtest
->end_state
);
322 bitq_end_state(cmd
->cmd
.runtest
->end_state
);
323 bitq_runtest(cmd
->cmd
.runtest
->num_cycles
);
327 #ifdef _DEBUG_JTAG_IO_
328 LOG_DEBUG("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
330 bitq_end_state(cmd
->cmd
.statemove
->end_state
);
331 bitq_state_move(tap_get_end_state()); /* uncoditional TAP move */
335 #ifdef _DEBUG_JTAG_IO_
336 LOG_DEBUG("pathmove: %i states, end in %i", cmd
->cmd
.pathmove
->num_states
,
337 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
339 bitq_path_move(cmd
->cmd
.pathmove
);
343 #ifdef _DEBUG_JTAG_IO_
344 LOG_DEBUG("scan end in %i", cmd
->cmd
.scan
->end_state
);
345 if (cmd
->cmd
.scan
->ir_scan
)
346 LOG_DEBUG("scan ir");
348 LOG_DEBUG("scan dr");
350 bitq_end_state(cmd
->cmd
.scan
->end_state
);
351 bitq_scan(cmd
->cmd
.scan
);
352 if (tap_get_state() != tap_get_end_state())
353 bitq_state_move(tap_get_end_state());
357 #ifdef _DEBUG_JTAG_IO_
358 LOG_DEBUG("sleep %i", cmd
->cmd
.sleep
->us
);
360 bitq_interface
->sleep(cmd
->cmd
.sleep
->us
);
361 if (bitq_interface
->in_rdy())
366 LOG_ERROR("BUG: unknown JTAG command type encountered");
373 bitq_interface
->flush();
376 if (bitq_in_state
.cmd
)
378 LOG_ERROR("missing data from bitq interface");
379 return ERROR_JTAG_QUEUE_FAILED
;
381 if (bitq_interface
->in() >= 0)
383 LOG_ERROR("extra data from bitq interface");
384 return ERROR_JTAG_QUEUE_FAILED
;
387 return bitq_in_state
.status
;
391 void bitq_cleanup(void)
393 if (bitq_in_buffer
!= NULL
)
395 free(bitq_in_buffer
);
396 bitq_in_buffer
= NULL
;