bitbang.c 9.34 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
23
24
25
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

#include "bitbang.h"

/* project specific includes */
#include "log.h"
#include "types.h"
#include "jtag.h"
#include "configuration.h"

/* system includes */
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

bitbang_interface_t *bitbang_interface;

oharboe's avatar
oharboe committed
42

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/* DANGER!!!! clock absolutely *MUST* be 0 in idle or reset won't work!
 * 
 * Set this to 1 and str912 reset halt will fail.
 * 
 * If someone can submit a patch with an explanation it will be greatly
 * appreciated, but as far as I can tell (ØH) DCLK is generated upon
 * clk=0 in TAP_RTI. Good luck deducing that from the ARM documentation!
 * The ARM documentation uses the term "DCLK is asserted while in the TAP_RTI 
 * state". With hardware there is no such thing as *while* in a state. There
 * are only edges. So clk => 0 is in fact a very subtle state transition that
 * happens *while* in the TAP_RTI state. "#&¤"#¤&"#&"#&
 * 
 * For "reset halt" the last thing that happens before srst is asserted
 * is that the breakpoint is set up. If DCLK is not wiggled one last
 * time before the reset, then the breakpoint is not set up and
 * "reset halt" will fail to halt.
 * 
 */
oharboe's avatar
oharboe committed
61
62
#define CLOCK_IDLE() 0 

63
64
int bitbang_execute_queue(void);

65
66
/* The bitbang driver leaves the TCK 0 when in idle */

67
68
69
70
71
72
void bitbang_end_state(enum tap_state state)
{
	if (tap_move_map[state] != -1)
		end_state = state;
	else
	{
73
		LOG_ERROR("BUG: %i is not a valid end state", state);
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
		exit(-1);
	}
}

void bitbang_state_move(void) {
	
	int i=0, tms=0;
	u8 tms_scan = TAP_MOVE(cur_state, end_state);
	
	for (i = 0; i < 7; i++)
	{
		tms = (tms_scan >> i) & 1;
		bitbang_interface->write(0, tms, 0);
		bitbang_interface->write(1, tms, 0);
	}
oharboe's avatar
oharboe committed
89
	bitbang_interface->write(CLOCK_IDLE(), tms, 0);
90
91
92
93
	
	cur_state = end_state;
}

94
95
96
97
void bitbang_path_move(pathmove_command_t *cmd)
{
	int num_states = cmd->num_states;
	int state_count;
98
	int tms = 0;
99
100
101
102
103
104

	state_count = 0;
	while (num_states)
	{
		if (tap_transitions[cur_state].low == cmd->path[state_count])
		{
105
			tms = 0;
106
107
108
		}
		else if (tap_transitions[cur_state].high == cmd->path[state_count])
		{
109
110
			tms = 1;
		}
111
112
		else
		{
113
			LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[cmd->path[state_count]]);
114
115
116
			exit(-1);
		}
		
117
118
119
		bitbang_interface->write(0, tms, 0);
		bitbang_interface->write(1, tms, 0);

120
121
122
123
124
		cur_state = cmd->path[state_count];
		state_count++;
		num_states--;
	}
	
oharboe's avatar
oharboe committed
125
	bitbang_interface->write(CLOCK_IDLE(), tms, 0);
126

127
128
129
	end_state = cur_state;
}

130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
void bitbang_runtest(int num_cycles)
{
	int i;
	
	enum tap_state saved_end_state = end_state;
	
	/* only do a state_move when we're not already in RTI */
	if (cur_state != TAP_RTI)
	{
		bitbang_end_state(TAP_RTI);
		bitbang_state_move();
	}
	
	/* execute num_cycles */
	for (i = 0; i < num_cycles; i++)
	{
		bitbang_interface->write(0, 0, 0);
oharboe's avatar
oharboe committed
147
		bitbang_interface->write(1, 0, 0);
148
	}
oharboe's avatar
oharboe committed
149
	bitbang_interface->write(CLOCK_IDLE(), 0, 0);
150
151
152
153
154
155
156
157
158
159
160
161
	
	/* finish in end_state */
	bitbang_end_state(saved_end_state);
	if (cur_state != end_state)
		bitbang_state_move();
}

void bitbang_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
{
	enum tap_state saved_end_state = end_state;
	int bit_cnt;
	
162
163
164
165
166
167
	if (!((!ir_scan && (cur_state == TAP_SD)) || (ir_scan && (cur_state == TAP_SI))))
	{
		if (ir_scan)
			bitbang_end_state(TAP_SI);
		else
			bitbang_end_state(TAP_SD);
168

169
170
171
		bitbang_state_move();
		bitbang_end_state(saved_end_state);
	}
172

173
	for (bit_cnt = 0; bit_cnt < scan_size; bit_cnt++)
174
	{
175
176
177
178
		/* if we're just reading the scan, but don't care about the output
		 * default to outputting 'low', this also makes valgrind traces more readable,
		 * as it removes the dependency on an uninitialised value
		 */ 
179
180
		if ((type != SCAN_IN) && ((buffer[bit_cnt/8] >> (bit_cnt % 8)) & 0x1))
		{
181
182
			bitbang_interface->write(0, (bit_cnt==scan_size-1) ? 1 : 0, 1);
			bitbang_interface->write(1, (bit_cnt==scan_size-1) ? 1 : 0, 1);
183
		} else {
184
185
			bitbang_interface->write(0, (bit_cnt==scan_size-1) ? 1 : 0, 0);
			bitbang_interface->write(1, (bit_cnt==scan_size-1) ? 1 : 0, 0);
186
187
188
189
		}
		
		if (type != SCAN_OUT)
		{
190
191
192
193
194
195
196
197
198
199
			/*
			TDO should be sampled on the rising edge, and will change 
			on the falling edge. 
			
			Because there is no way to read the signal exactly at the rising edge,
			read after the rising edge.

			This is plain IEEE 1149 JTAG - nothing specific to the OpenOCD or its JTAG
			API. 
			*/
200
201
202
203
204
205
			if (bitbang_interface->read())
				buffer[(bit_cnt)/8] |= 1 << ((bit_cnt) % 8);
			else
				buffer[(bit_cnt)/8] &= ~(1 << ((bit_cnt) % 8));
		}
	}
206
207
208
209
210
211
212
213
	
	/* TAP_SD & TAP_SI are illegal end states, so we always transition to the pause
	 * state which is a legal stable state from which statemove will work.
	 *  
	 * Exit1 -> Pause 
	 */
	bitbang_interface->write(0, 0, 0);
	bitbang_interface->write(1, 0, 0);
oharboe's avatar
oharboe committed
214
	bitbang_interface->write(CLOCK_IDLE(), 0, 0);
215
216
217
	
	if (ir_scan)
		cur_state = TAP_PI;
218
	else
219
220
221
222
		cur_state = TAP_PD;
	
	if (cur_state != end_state)
		bitbang_state_move();
223
224
225
226
227
228
229
230
}

int bitbang_execute_queue(void)
{
	jtag_command_t *cmd = jtag_command_queue; /* currently processed command */
	int scan_size;
	enum scan_type type;
	u8 *buffer;
231
	int retval;
232
233
234
	
	if (!bitbang_interface)
	{
235
		LOG_ERROR("BUG: Bitbang interface called, but not yet initialized");
236
237
		exit(-1);
	}
238
239
240
241
242
	
	/* return ERROR_OK, unless a jtag_read_buffer returns a failed check
	 * that wasn't handled by a caller-provided error handler
	 */ 
	retval = ERROR_OK;
243
		
drath's avatar
drath committed
244
245
246
	if(bitbang_interface->blink)
		bitbang_interface->blink(1);

247
248
249
250
251
252
	while (cmd)
	{
		switch (cmd->type)
		{
			case JTAG_END_STATE:
#ifdef _DEBUG_JTAG_IO_
253
				LOG_DEBUG("end_state: %i", cmd->cmd.end_state->end_state);
254
255
256
257
258
259
#endif
				if (cmd->cmd.end_state->end_state != -1)
					bitbang_end_state(cmd->cmd.end_state->end_state);
				break;
			case JTAG_RESET:
#ifdef _DEBUG_JTAG_IO_
260
				LOG_DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
261
#endif
262
				if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_reset_config & RESET_SRST_PULLS_TRST)))
263
264
265
266
267
268
269
				{
					cur_state = TAP_TLR;
				}
				bitbang_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
				break;
			case JTAG_RUNTEST:
#ifdef _DEBUG_JTAG_IO_
270
				LOG_DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
271
272
273
274
275
276
277
#endif
				if (cmd->cmd.runtest->end_state != -1)
					bitbang_end_state(cmd->cmd.runtest->end_state);
				bitbang_runtest(cmd->cmd.runtest->num_cycles);
				break;
			case JTAG_STATEMOVE:
#ifdef _DEBUG_JTAG_IO_
278
				LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
279
280
281
282
283
#endif
				if (cmd->cmd.statemove->end_state != -1)
					bitbang_end_state(cmd->cmd.statemove->end_state);
				bitbang_state_move();
				break;
284
285
			case JTAG_PATHMOVE:
#ifdef _DEBUG_JTAG_IO_
286
				LOG_DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
287
288
289
#endif
				bitbang_path_move(cmd->cmd.pathmove);
				break;
290
291
			case JTAG_SCAN:
#ifdef _DEBUG_JTAG_IO_
292
				LOG_DEBUG("%s scan end in %i",  (cmd->cmd.scan->ir_scan) ? "IR" : "DR", cmd->cmd.scan->end_state);
293
294
295
296
297
298
299
#endif
				if (cmd->cmd.scan->end_state != -1)
					bitbang_end_state(cmd->cmd.scan->end_state);
				scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
				type = jtag_scan_type(cmd->cmd.scan);
				bitbang_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
				if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
300
					retval = ERROR_JTAG_QUEUE_FAILED;
301
302
303
304
305
				if (buffer)
					free(buffer);
				break;
			case JTAG_SLEEP:
#ifdef _DEBUG_JTAG_IO_
306
				LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
307
308
309
310
#endif
				jtag_sleep(cmd->cmd.sleep->us);
				break;
			default:
311
				LOG_ERROR("BUG: unknown JTAG command type encountered");
312
313
314
315
				exit(-1);
		}
		cmd = cmd->next;
	}
drath's avatar
drath committed
316
317
	if(bitbang_interface->blink)
		bitbang_interface->blink(0);
318
	
319
	return retval;
320
321
}