jlink.c 21.1 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2007 by Juergen Stuber <juergen@jstuber.net>            *
 *   based on Dominic Rath's and Benedikt Sauter's usbprog.c               *
 *                                                                         *
5
6
7
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 *   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.             *
 ***************************************************************************/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "replacements.h"

#include "jtag.h"

#include <usb.h>
#include <string.h>

#include "log.h"

/* enable this to debug communication
 */
#if 0
#define _DEBUG_USB_COMMS_
#endif

#ifdef _DEBUG_JTAG_IO_
#define DEBUG_JTAG_IO(expr ...)	LOG_DEBUG(expr)
#else
#define DEBUG_JTAG_IO(expr ...)
#endif

#define VID 0x1366
#define PID 0x0101

#define JLINK_WRITE_ENDPOINT	0x02
#define JLINK_READ_ENDPOINT		0x81

#define JLINK_USB_TIMEOUT		100

57
58
#define JLINK_IN_BUFFER_SIZE			8192
#define JLINK_OUT_BUFFER_SIZE			8192
59
60
#define JLINK_EMU_RESULT_BUFFER_SIZE	64

61
62
63
/* Global USB buffers */
static u8 usb_in_buffer[JLINK_IN_BUFFER_SIZE];
static u8 usb_out_buffer[JLINK_OUT_BUFFER_SIZE];
64
static u8 usb_emu_result_buffer[JLINK_EMU_RESULT_BUFFER_SIZE];
65
66

/* Constants for JLink command */
67
68
69
#define EMU_CMD_VERSION     0x01
#define EMU_CMD_SET_SPEED   0x05
#define EMU_CMD_GET_STATE   0x07
70
#define EMU_CMD_HW_JTAG3    0xcf
71
72
73
74
#define EMU_CMD_HW_RESET0   0xdc
#define EMU_CMD_HW_RESET1   0xdd
#define EMU_CMD_HW_TRST0    0xde
#define EMU_CMD_HW_TRST1    0xdf
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

/* max speed 12MHz v5.0 jlink */
#define JLINK_MAX_SPEED 12000

/* External interface functions */
int jlink_execute_queue(void);
int jlink_speed(int speed);
int jlink_khz(int khz, int *jtag_speed);
int jlink_register_commands(struct command_context_s *cmd_ctx);
int jlink_init(void);
int jlink_quit(void);

/* CLI command handler functions */
int jlink_handle_jlink_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

/* Queue command functions */
void jlink_end_state(enum tap_state state);
void jlink_state_move(void);
void jlink_path_move(int num_states, enum tap_state *path);
void jlink_runtest(int num_cycles);
void jlink_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command);
void jlink_reset(int trst, int srst);
void jlink_simple_command(u8 command);
int jlink_get_status(void);

/* J-Link tap buffer functions */
ntfreak's avatar
ntfreak committed
101
102
void jlink_tap_init(void);
int jlink_tap_execute(void);
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
void jlink_tap_ensure_space(int scans, int bits);
void jlink_tap_append_step(int tms, int tdi);
void jlink_tap_append_scan(int length, u8 *buffer, scan_command_t *command);

/* Jlink lowlevel functions */
typedef struct jlink_jtag
{
	struct usb_dev_handle* usb_handle;
} jlink_jtag_t;

jlink_jtag_t *jlink_usb_open(void);
void jlink_usb_close(jlink_jtag_t *jlink_jtag);
int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length);
int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length);
int jlink_usb_read(jlink_jtag_t *jlink_jtag);
118
int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag);
119

120
121
122
/* helper functions */
int jlink_get_version_info(void);

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
#ifdef _DEBUG_USB_COMMS_
void jlink_debug_buffer(u8 *buffer, int length);
#endif

jlink_jtag_t* jlink_jtag_handle;

/***************************************************************************/
/* External interface implementation */

jtag_interface_t jlink_interface =
{
	.name = "jlink",
	.execute_queue = jlink_execute_queue,
	.speed = jlink_speed,
	.khz = jlink_khz,
	.register_commands = jlink_register_commands,
	.init = jlink_init,
	.quit = jlink_quit
};

int jlink_execute_queue(void)
{
	jtag_command_t *cmd = jtag_command_queue;
	int scan_size;
	enum scan_type type;
	u8 *buffer;
	
	while (cmd != NULL)
	{
		switch (cmd->type)
		{
			case JTAG_END_STATE:
				DEBUG_JTAG_IO("end_state: %i", cmd->cmd.end_state->end_state);
			
				if (cmd->cmd.end_state->end_state != -1)
				{
					jlink_end_state(cmd->cmd.end_state->end_state);
				}
				break;
	
			case JTAG_RUNTEST:
				DEBUG_JTAG_IO( "runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
					cmd->cmd.runtest->end_state);
				
				if (cmd->cmd.runtest->end_state != -1)
				{
					jlink_end_state(cmd->cmd.runtest->end_state);
				}
				jlink_runtest(cmd->cmd.runtest->num_cycles);
				break;
	
			case JTAG_STATEMOVE:
175
				DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
176
177
178
179
180
181
182
183
184
			
				if (cmd->cmd.statemove->end_state != -1)
				{
					jlink_end_state(cmd->cmd.statemove->end_state);
				}
				jlink_state_move();
				break;
	
			case JTAG_PATHMOVE:
185
186
187
				DEBUG_JTAG_IO("pathmove: %i states, end in %i", \
					cmd->cmd.pathmove->num_states, \
					cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
188
189
190
191
192
193
194
195
196
			
				jlink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
				break;
	
			case JTAG_SCAN:
				DEBUG_JTAG_IO("scan end in %i", cmd->cmd.scan->end_state);
			
				if (cmd->cmd.scan->end_state != -1)
				{
197
					jlink_end_state(cmd->cmd.scan->end_state);
198
199
200
201
202
203
204
205
206
207
208
209
210
				}
			
				scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
				DEBUG_JTAG_IO("scan input, length = %d", scan_size);
				
#ifdef _DEBUG_USB_COMMS_
				jlink_debug_buffer(buffer, (scan_size + 7) / 8);
#endif
				type = jtag_scan_type(cmd->cmd.scan);
				jlink_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan);
				break;
	
			case JTAG_RESET:
211
				DEBUG_JTAG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
			
				jlink_tap_execute();
			
				if (cmd->cmd.reset->trst == 1)
				{
					cur_state = TAP_TLR;
				}
				jlink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
				break;
	
			case JTAG_SLEEP:
				DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
				jlink_tap_execute();
				jtag_sleep(cmd->cmd.sleep->us);
				break;
	
228
229
230
			default:
				LOG_ERROR("BUG: unknown JTAG command type encountered");
				exit(-1);
231
232
233
234
		}
		cmd = cmd->next;
	}
	
235
	return jlink_tap_execute();
236
237
238
239
240
241
242
243
244
245
246
247
248
}

/* Sets speed in kHz. */
int jlink_speed(int speed)
{
	int result;
	
	if (speed <= JLINK_MAX_SPEED)
	{
		/* check for RTCK setting */
		if (speed == 0)
			speed = -1;
		
249
		usb_out_buffer[0] = EMU_CMD_SET_SPEED;
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
		usb_out_buffer[1] = (speed >> 0) & 0xff;
		usb_out_buffer[2] = (speed >> 8) & 0xff;
		
		result = jlink_usb_write(jlink_jtag_handle, 3);
		
		if (result == 3)
		{
			return ERROR_OK;
		}
		else
		{
			LOG_ERROR("J-Link setting speed failed (%d)", result);
			return ERROR_JTAG_DEVICE_ERROR;
		}
	}
	else
	{
		LOG_INFO("Requested speed %dkHz exceeds maximum of %dkHz, ignored", speed, JLINK_MAX_SPEED);
	}
	
	return ERROR_OK;
}

int jlink_khz(int khz, int *jtag_speed)
{
	*jtag_speed = khz;
	
	return ERROR_OK;
}

int jlink_register_commands(struct command_context_s *cmd_ctx)
{
	register_command(cmd_ctx, NULL, "jlink_info", jlink_handle_jlink_info_command, COMMAND_EXEC,
		"query jlink info");
	return ERROR_OK;
}

int jlink_init(void)
{
289
	int check_cnt;  
290
291
292
293
294
	
	jlink_jtag_handle = jlink_usb_open();
	
	if (jlink_jtag_handle == 0)
	{
295
		LOG_ERROR("Cannot find jlink Interface! Please check connection and permissions.");
296
297
298
		return ERROR_JTAG_INIT_FAILED;
	}
		
299
300
301
302
303
304
305
306
307
	check_cnt = 0;
	while (check_cnt < 3)
	{
		if (jlink_get_version_info() == ERROR_OK)
		{
			/* attempt to get status */
			jlink_get_status();
			break;
		}
308
		
309
310
311
312
313
314
315
		check_cnt++;
	}

	if (check_cnt == 3)
	{
		LOG_INFO("J-Link initial read failed, don't worry");
	}
316
317
318
319
320
	
	LOG_INFO("J-Link JTAG Interface ready");
	
	jlink_reset(0, 0);
	jlink_tap_init();
321
	
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
	return ERROR_OK;
}

int jlink_quit(void)
{
	jlink_usb_close(jlink_jtag_handle);
	return ERROR_OK;
}

/***************************************************************************/
/* Queue command implementations */

void jlink_end_state(enum tap_state state)
{
	if (tap_move_map[state] != -1)
	{
		end_state = state;
	}
	else
	{
		LOG_ERROR("BUG: %i is not a valid end state", state);
		exit(-1);
	}
}

/* Goes to the end state. */
void jlink_state_move(void)
{
	int i;
	int tms = 0;
	u8 tms_scan = TAP_MOVE(cur_state, end_state);
	
	for (i = 0; i < 7; i++)
	{
		tms = (tms_scan >> i) & 1;
		jlink_tap_append_step(tms, 0);
	}
	
	cur_state = end_state;
}

void jlink_path_move(int num_states, enum tap_state *path)
{
	int i;
	
	for (i = 0; i < num_states; i++)
	{
		if (path[i] == tap_transitions[cur_state].low)
		{
			jlink_tap_append_step(0, 0);
		}
		else if (path[i] == tap_transitions[cur_state].high)
		{
			jlink_tap_append_step(1, 0);
		}
		else
		{
			LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[path[i]]);
			exit(-1);
		}
		
		cur_state = path[i];
	}
	
	end_state = cur_state;
}

void jlink_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)
	{
		jlink_end_state(TAP_RTI);
		jlink_state_move();
	}
	
	/* execute num_cycles */
	for (i = 0; i < num_cycles; i++)
	{
		jlink_tap_append_step(0, 0);
	}
	
	/* finish in end_state */
	jlink_end_state(saved_end_state);
	if (cur_state != end_state)
	{
		jlink_state_move();
	}
}

void jlink_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size, scan_command_t *command)
{
	enum tap_state saved_end_state;
	
	jlink_tap_ensure_space(1, scan_size + 8);
	
	saved_end_state = end_state;
	
	/* Move to appropriate scan state */
	jlink_end_state(ir_scan ? TAP_SI : TAP_SD);
	
	jlink_state_move();
	jlink_end_state(saved_end_state);
	
	/* Scan */
	jlink_tap_append_scan(scan_size, buffer, command);
	
	/* We are in Exit1, go to Pause */
	jlink_tap_append_step(0, 0);
	
	cur_state = ir_scan ? TAP_PI : TAP_PD;
	
	if (cur_state != end_state)
	{
		jlink_state_move();
	}
}

void jlink_reset(int trst, int srst)
{
	LOG_DEBUG("trst: %i, srst: %i", trst, srst);
	
	/* Signals are active low */
449
	if (srst == 0)
450
	{
451
		jlink_simple_command(EMU_CMD_HW_RESET1);
452
	}
453
	else if (srst == 1)
454
	{
455
		jlink_simple_command(EMU_CMD_HW_RESET0);
456
457
	}
	
458
	if (trst == 0)
459
	{
460
		jlink_simple_command(EMU_CMD_HW_TRST1);
461
	}
462
	else if (trst == 1)
463
	{
464
		jlink_simple_command(EMU_CMD_HW_TRST0);
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
	}
}

void jlink_simple_command(u8 command)
{
	int result;
	
	DEBUG_JTAG_IO("0x%02x", command);
	
	usb_out_buffer[0] = command;
	result = jlink_usb_write(jlink_jtag_handle, 1);
	
	if (result != 1)
	{
		LOG_ERROR("J-Link command 0x%02x failed (%d)", command, result);
	}
}

int jlink_get_status(void)
{
	int result;
	
487
	jlink_simple_command(EMU_CMD_GET_STATE);
488
489
	result = jlink_usb_read(jlink_jtag_handle);
	
490
	if (result == 8)
491
492
	{
		int vref = usb_in_buffer[0] + (usb_in_buffer[1] << 8);
493
		LOG_INFO("Vref = %d.%d TCK = %d TDI = %d TDO = %d TMS = %d SRST = %d TRST = %d\n", \
494
495
496
497
			vref / 1000, vref % 1000, \
			usb_in_buffer[2], usb_in_buffer[3], usb_in_buffer[4], \
			usb_in_buffer[5], usb_in_buffer[6], usb_in_buffer[7]);
		
498
		if (vref < 1500)
499
		{
500
			LOG_ERROR("Vref too low. Check Target Power\n");
501
502
503
504
		}
	}
	else
	{
505
		LOG_ERROR("J-Link command EMU_CMD_GET_STATE failed (%d)\n", result);
506
507
508
509
510
	}
	
	return ERROR_OK;
}

511
int jlink_get_version_info(void)
512
513
514
515
516
{
	int result;
	int len = 0;
	
	/* query hardware version */
517
	jlink_simple_command(EMU_CMD_VERSION);
518
519
520
521
522
523
524
	result = jlink_usb_read(jlink_jtag_handle);
	
	if (result == 2)
	{
		len = buf_get_u32(usb_in_buffer, 0, 16);
		result = jlink_usb_read(jlink_jtag_handle);
		
525
		if (result == len)
526
527
528
		{
			usb_in_buffer[result] = 0;
			LOG_INFO(usb_in_buffer);
529
			return ERROR_OK;
530
531
		}
	}
532
533
534
535
536
537
538
539
	
	LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)\n", result);
	return ERROR_JTAG_DEVICE_ERROR;
}

int jlink_handle_jlink_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	if (jlink_get_version_info() == ERROR_OK)
540
	{
541
542
		/* attempt to get status */
		jlink_get_status();
543
544
545
546
547
548
549
550
	}
	
	return ERROR_OK;
}

/***************************************************************************/
/* J-Link tap functions */

551
552
/* 2048 is the max value we can use here */
#define JLINK_TAP_BUFFER_SIZE 2048
553
554
555
556
557
558
559
560
561
562
563
564
565
566

static int tap_length;
static u8 tms_buffer[JLINK_TAP_BUFFER_SIZE];
static u8 tdi_buffer[JLINK_TAP_BUFFER_SIZE];
static u8 tdo_buffer[JLINK_TAP_BUFFER_SIZE];

typedef struct
{
	int first;	/* First bit position in tdo_buffer to read */
	int length; /* Number of bits to read */
	scan_command_t *command; /* Corresponding scan command */
	u8 *buffer;
} pending_scan_result_t;

567
#define MAX_PENDING_SCAN_RESULTS 256
568
569
570
571
572
573

static int pending_scan_results_length;
static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];

static int last_tms;

ntfreak's avatar
ntfreak committed
574
void jlink_tap_init(void)
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
{
	tap_length = 0;
	pending_scan_results_length = 0;
}

void jlink_tap_ensure_space(int scans, int bits)
{
	int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
	int available_bits = JLINK_TAP_BUFFER_SIZE * 8 - tap_length;
	
	if (scans > available_scans || bits > available_bits)
	{
		jlink_tap_execute();
	}
}

void jlink_tap_append_step(int tms, int tdi)
{
	last_tms = tms;
	int index = tap_length / 8;
	
	if (index < JLINK_TAP_BUFFER_SIZE)
	{
		int bit_index = tap_length % 8;
		u8 bit = 1 << bit_index;
		
		if (tms)
		{
			tms_buffer[index] |= bit;
		}
		else
		{
			tms_buffer[index] &= ~bit;
		}
		
		if (tdi)
		{
			tdi_buffer[index] |= bit;
		}
		else
		{
			tdi_buffer[index] &= ~bit;
		}
		
		tap_length++;
	}
	else
	{
		LOG_ERROR("jlink_tap_append_step, overflow");
	}
}

void jlink_tap_append_scan(int length, u8 *buffer, scan_command_t *command)
{
	pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
	int i;
	
	pending_scan_result->first = tap_length;
	pending_scan_result->length = length;
	pending_scan_result->command = command;
	pending_scan_result->buffer = buffer;
	
	for (i = 0; i < length; i++)
	{
		jlink_tap_append_step((i < length-1 ? 0 : 1), (buffer[i/8] >> (i%8)) & 1);
	}
	pending_scan_results_length++;
}

/* Pad and send a tap sequence to the device, and receive the answer.
 * For the purpose of padding we assume that we are in idle or pause state. */
ntfreak's avatar
ntfreak committed
646
int jlink_tap_execute(void)
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
{
	int byte_length;
	int tms_offset;
	int tdi_offset;
	int i;
	int result;
	
	if (tap_length > 0)
	{
		/* Pad last byte so that tap_length is divisible by 8 */
		while (tap_length % 8 != 0)
		{
			/* More of the last TMS value keeps us in the same state,
			 * analogous to free-running JTAG interfaces. */
			jlink_tap_append_step(last_tms, 0);
		}
	
		byte_length = tap_length / 8;
	
666
		usb_out_buffer[0] = EMU_CMD_HW_JTAG3;
667
668
669
		usb_out_buffer[1] = 0;
		usb_out_buffer[2] = (tap_length >> 0) & 0xff;
		usb_out_buffer[3] = (tap_length >> 8) & 0xff;
670
	
671
		tms_offset = 4;
672
673
		for (i = 0; i < byte_length; i++)
		{
674
			usb_out_buffer[tms_offset + i] = tms_buffer[i];
675
676
677
678
679
		}
		
		tdi_offset = tms_offset + byte_length;
		for (i = 0; i < byte_length; i++)
		{
680
			usb_out_buffer[tdi_offset + i] = tdi_buffer[i];
681
682
		}
	
683
		result = jlink_usb_message(jlink_jtag_handle, 4 + 2 * byte_length, byte_length);
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
	
		if (result == byte_length)
		{
			for (i = 0; i < byte_length; i++)
			{
				tdo_buffer[i] = usb_in_buffer[i];
			}
			
			for (i = 0; i < pending_scan_results_length; i++)
			{
				pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
				u8 *buffer = pending_scan_result->buffer;
				int length = pending_scan_result->length;
				int first = pending_scan_result->first;
				scan_command_t *command = pending_scan_result->command;
	
				/* Copy to buffer */
				buf_set_buf(tdo_buffer, first, buffer, 0, length);
	
				DEBUG_JTAG_IO("pending scan result, length = %d", length);
				
#ifdef _DEBUG_USB_COMMS_
				jlink_debug_buffer(buffer, byte_length);
#endif
	
709
710
711
				if (jtag_read_buffer(buffer, command) != ERROR_OK)
				{
					jlink_tap_init();
712
					return ERROR_JTAG_QUEUE_FAILED;
713
				}
714
		
715
716
				if (pending_scan_result->buffer != NULL)
				{
717
					free(pending_scan_result->buffer);
718
719
				}
			}
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
		}
		else
		{
			LOG_ERROR("jlink_tap_execute, wrong result %d, expected %d", result, byte_length);
			return ERROR_JTAG_QUEUE_FAILED;
		}
		
		jlink_tap_init();
	}
	
	return ERROR_OK;
}

/*****************************************************************************/
/* JLink USB low-level functions */

jlink_jtag_t* jlink_usb_open()
{
	struct usb_bus *busses;
	struct usb_bus *bus;
	struct usb_device *dev;
	
	jlink_jtag_t *result;
	
	result = (jlink_jtag_t*) malloc(sizeof(jlink_jtag_t));
	
	usb_init();
	usb_find_busses();
	usb_find_devices();
	
	busses = usb_get_busses();
	
	/* find jlink_jtag device in usb bus */
	
	for (bus = busses; bus; bus = bus->next)
	{
		for (dev = bus->devices; dev; dev = dev->next)
		{
			if ((dev->descriptor.idVendor == VID) && (dev->descriptor.idProduct == PID))
			{
				result->usb_handle = usb_open(dev);
				
				/* usb_set_configuration required under win32 */
				usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
				usb_claim_interface(result->usb_handle, 0);
765
766
767
768
769
770
				
#if 0
				/* 
				 * This makes problems under Mac OS X. And is not needed
				 * under Windows. Hopefully this will not break a linux build
				 */
771
				usb_set_altinterface(result->usb_handle, 0);
772
#endif				
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
				return result;
			}
		}
	}
	
	free(result);
	return NULL;
}

void jlink_usb_close(jlink_jtag_t *jlink_jtag)
{
	usb_close(jlink_jtag->usb_handle);
	free(jlink_jtag);
}

/* Send a message and receive the reply. */
int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length)
{
	int result;
792
	int result2;
793
794
795
796
797
	
	result = jlink_usb_write(jlink_jtag, out_length);
	if (result == out_length)
	{
		result = jlink_usb_read(jlink_jtag);
798
		if (result == in_length || result == in_length+1)
799
		{
800
			if (result == in_length)
801
			{
802
803
804
				/* Must read the result from the EMU too */
				result2 = jlink_usb_read_emu_result(jlink_jtag);
				if (1 == result2)
805
				{
806
807
808
809
810
811
812
813
814
815
					/* Check the result itself */
					if (0 == usb_emu_result_buffer[0])
					{
						return result;
					}
					else
					{
						LOG_ERROR("jlink_usb_read_emu_result (requested=0, result=%d)", usb_emu_result_buffer[0]);
						return -1;				
					}
816
817
818
				}
				else
				{
819
820
					LOG_ERROR("jlink_usb_read_emu_result len (requested=1, result=%d)", result2);
					return -1;
821
822
823
824
				}
			}
			else
			{
825
				/* Check the result itself */
826
				if (0 == usb_in_buffer[result-1])
827
828
829
830
831
832
833
834
				{
					return result-1;
				}
				else
				{
					LOG_ERROR("jlink_usb_read_emu_result (requested=0, result=%d)", usb_in_buffer[result]);
					return -1;				
				}
835
			}
836
		}
837
838
		else
		{
839
840
			LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
			return -1;
841
		}
842
843
844
845
	}
	else
	{
		LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
846
		return -1;
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
	}
}

/* Write data from out_buffer to USB. */
int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length)
{
	int result;
	
	if (out_length > JLINK_OUT_BUFFER_SIZE)
	{
		LOG_ERROR("jlink_jtag_write illegal out_length=%d (max=%d)", out_length, JLINK_OUT_BUFFER_SIZE);
		return -1;
	}
	
	result = usb_bulk_write(jlink_jtag->usb_handle, JLINK_WRITE_ENDPOINT, \
		usb_out_buffer, out_length, JLINK_USB_TIMEOUT);
	
	DEBUG_JTAG_IO("jlink_usb_write, out_length = %d, result = %d", out_length, result);
	
#ifdef _DEBUG_USB_COMMS_
	jlink_debug_buffer(usb_out_buffer, out_length);
#endif
	return result;
}

/* Read data from USB into in_buffer. */
int jlink_usb_read(jlink_jtag_t *jlink_jtag)
{
	int result = usb_bulk_read(jlink_jtag->usb_handle, JLINK_READ_ENDPOINT, \
		usb_in_buffer, JLINK_IN_BUFFER_SIZE, JLINK_USB_TIMEOUT);

	DEBUG_JTAG_IO("jlink_usb_read, result = %d", result);
	
#ifdef _DEBUG_USB_COMMS_
	jlink_debug_buffer(usb_in_buffer, result);
#endif
883
	return result;
884
885
}

886
/* Read the result from the previous EMU cmd into result_buffer. */
887
int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag)
888
889
890
891
892
893
894
895
896
897
898
899
{
	int result = usb_bulk_read(jlink_jtag->usb_handle, JLINK_READ_ENDPOINT, \
		usb_emu_result_buffer, JLINK_EMU_RESULT_BUFFER_SIZE, JLINK_USB_TIMEOUT);

	DEBUG_JTAG_IO("jlink_usb_read_result, result = %d", result);
	
#ifdef _DEBUG_USB_COMMS_
	jlink_debug_buffer(usb_emu_result_buffer, result);
#endif
	return result;
}

900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
#ifdef _DEBUG_USB_COMMS_
#define BYTES_PER_LINE  16

void jlink_debug_buffer(u8 *buffer, int length)
{
	char line[81];
	char s[4];
	int i;
	int j;
	
	for (i = 0; i < length; i += BYTES_PER_LINE)
	{
		snprintf(line, 5, "%04x", i);
		for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
		{
			snprintf(s, 4, " %02x", buffer[j]);
			strcat(line, s);
		}
		LOG_DEBUG(line);
	}
}
#endif