XPROGTarget.c 14.4 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Target-related functions for the PDI Protocol decoder.
 */

36
37
#define  INCLUDE_FROM_XPROGTARGET_C
#include "XPROGTarget.h"
38

39
#if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
40

41
/** Flag to indicate if the USART is currently in Tx or Rx mode. */
42
volatile bool               IsSending;
43

44
#if !defined(XPROG_VIA_HARDWARE_USART)
45
/** Software USART raw frame bits for transmission/reception. */
46
volatile uint16_t           SoftUSART_Data;
47

48
/** Bits remaining to be sent or received via the software USART - set as a GPIOR for speed. */
49
50
#define SoftUSART_BitCount  GPIOR2

51

52
/** ISR to manage the rising edge of the PDI/TPI software USART when bit-banged USART mode is selected. */
53
ISR(TIMER1_COMPA_vect, ISR_BLOCK)
54
55
{
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
56
	BITBANG_PDICLOCK_PIN |= BITBANG_PDICLOCK_MASK;
57
58
	TIFR1 |= (1 << OCF1B);
	TIMSK1 = (1 << OCIE1B);
59
60
61
62
63

	/* If not sending or receiving, just exit */
	if (!(SoftUSART_BitCount))
	  return;

64
65
66
67
68
69
70
	/* If at rising clock edge and we are in send mode, abort */
	if (IsSending)
	  return;
	  
	/* Wait for the start bit when receiving */
	if ((SoftUSART_BitCount == BITS_IN_USART_FRAME) && (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK))
	  return;
71

72
73
74
75
	/* Shift in the bit one less than the frame size in position, so that the start bit will eventually
	 * be discarded leaving the data to be byte-aligned for quick access (subtract 9 as we are ORing to the MSB) */
	if (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK)
	  ((uint8_t*)&SoftUSART_Data)[1] |= (1 << (BITS_IN_USART_FRAME - 9));
76

77
78
79
	SoftUSART_Data >>= 1;
	SoftUSART_BitCount--;
}
80

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/** ISR to manage the falling edge of the PDI/TPI software USART when bit-banged USART mode is selected. */
ISR(TIMER1_COMPB_vect, ISR_BLOCK)
{
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
	BITBANG_PDICLOCK_PIN |= BITBANG_PDICLOCK_MASK;
	TIFR1 |= (1 << OCF1A);
	TIMSK1 = (1 << OCIE1A);

	/* If not sending or receiving, just exit */
	if (!(SoftUSART_BitCount))
	  return;

	/* If at falling clock edge and we are in receive mode, abort */
	if (!IsSending)
	  return;

	/* Set the data line to the next bit value */
	if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
	  BITBANG_PDIDATA_PORT |=  BITBANG_PDIDATA_MASK;
	else
	  BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;		  

	SoftUSART_Data >>= 1;
	SoftUSART_BitCount--;
105
106
}

107
/** ISR to manage the TPI software USART when bit-banged TPI USART mode is selected. */
108
ISR(TIMER1_CAPT_vect, ISR_BLOCK)
109
{
110
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
111
	BITBANG_TPICLOCK_PIN |= BITBANG_TPICLOCK_MASK;
112

113
	/* If not sending or receiving, just exit */
114
	if (!(SoftUSART_BitCount))
115
	  return;
116

117
	/* Check to see if we are at a rising or falling edge of the clock */
118
	if (BITBANG_TPICLOCK_PORT & BITBANG_TPICLOCK_MASK)
119
	{
120
121
122
123
		/* If at rising clock edge and we are in send mode, abort */
		if (IsSending)
		  return;
		  
124
		/* Wait for the start bit when receiving */
125
		if ((SoftUSART_BitCount == BITS_IN_USART_FRAME) && (BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK))
126
127
		  return;
	
128
		/* Shift in the bit one less than the frame size in position, so that the start bit will eventually
129
		 * be discarded leaving the data to be byte-aligned for quick access (subtract 9 as we are ORing to the MSB) */
130
131
		if (BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK)
		 ((uint8_t*)&SoftUSART_Data)[1] |= (1 << (BITS_IN_USART_FRAME - 9));
132

133
134
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
135
	}
136
137
138
139
140
141
	else
	{
		/* If at falling clock edge and we are in receive mode, abort */
		if (!IsSending)
		  return;

142
		/* Set the data line to the next bit value */
143
144
		if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
		  BITBANG_TPIDATA_PORT |=  BITBANG_TPIDATA_MASK;
145
		else
146
		  BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;		  
147
148
149
150

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
151
}
152
#endif
153

154
155
/** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
void XPROGTarget_EnableTargetPDI(void)
156
{
157
158
	IsSending = false;

159
160
161
162
#if defined(XPROG_VIA_HARDWARE_USART)
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
163
	
164
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
165
	PORTD |= (1 << 3);
166
	_delay_us(1);
167
	
168
169
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
170
	UBRR1  = (F_CPU / 500000UL);
171
172
173
174
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
#else
	/* Set DATA and CLOCK lines to outputs */
175
176
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
177
	
178
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
179
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
180
	_delay_us(1);
181

182
183
	/* Fire timer compare channel A ISR to manage the software USART */
	OCR1A   = BITS_BETWEEN_USART_CLOCKS;
184
	OCR1B   = BITS_BETWEEN_USART_CLOCKS;
185
	TCCR1B  = (1 << WGM12) | (1 << CS10);
186
	TCCR1C  = (1 << FOC1B);
187
	TIMSK1  = (1 << OCIE1A);
188
189
190
#endif

	/* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
191
192
193
194
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
}

195
196
/** Enables the target's TPI interface, holding the target in reset until TPI mode is exited. */
void XPROGTarget_EnableTargetTPI(void)
197
{
198
199
	IsSending = false;

200
	/* Set /RESET line low for at least 400ns to enable TPI functionality */
201
202
	AUX_LINE_DDR  |=  AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
203
	_delay_us(1);
204

205
#if defined(XPROG_VIA_HARDWARE_USART)
206
207
208
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
209
		
210
	/* Set up the synchronous USART for TINY communications - 
211
	   8 data bits, even parity, 2 stop bits */
212
	UBRR1  = (F_CPU / 500000UL);
213
	UCSR1B = (1 << TXEN1);
214
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
215
216
#else
	/* Set DATA and CLOCK lines to outputs */
217
218
	BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR |= BITBANG_TPICLOCK_MASK;
219
	
220
221
	/* Set DATA line high for idle state */
	BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
222

223
224
225
226
	/* Fire timer capture channel ISR to manage the software USART */
	ICR1    = BITS_BETWEEN_USART_CLOCKS;
	TCCR1B  = (1 << WGM13) | (1 << WGM12) | (1 << CS10);
	TIMSK1  = (1 << ICIE1);
227
228
#endif

229
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
230
231
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
232
233
}

234
235
/** Disables the target's PDI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetPDI(void)
236
{
237
238
239
	/* Switch to Rx mode to ensure that all pending transmissions are complete */
	XPROGTarget_SetRxMode();

240
#if defined(XPROG_VIA_HARDWARE_USART)
241
242
243
244
	/* Set /RESET high for a one millisecond to ensure target device is restarted */
	PORTD |= (1 << 5);
	_delay_ms(1);

245
246
247
248
249
250
251
252
253
	/* Turn off receiver and transmitter of the USART, clear settings */
	UCSR1A |= (1 << TXC1) | (1 << RXC1);
	UCSR1B  = 0;
	UCSR1C  = 0;

	/* Set all USART lines as input, tristate */
	DDRD  &= ~((1 << 5) | (1 << 3));
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
#else
254
255
256
257
	/* Turn off software USART management timer */
	TCCR1B = 0;
	TCCR1C = 0;

258
259
260
261
	/* Set /RESET high for a one millisecond to ensure target device is restarted */
	BITBANG_PDICLOCK_PORT |= BITBANG_PDICLOCK_MASK;
	_delay_ms(1);

262
	/* Set DATA and CLOCK lines to inputs */
263
264
	BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
265
266
	
	/* Tristate DATA and CLOCK lines */
267
	BITBANG_PDIDATA_PORT  &= ~BITBANG_PDIDATA_MASK;
268
	BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;	
269
270
271
#endif
}

272
273
/** Disables the target's TPI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetTPI(void)
274
{
275
276
277
	/* Switch to Rx mode to ensure that all pending transmissions are complete */
	XPROGTarget_SetRxMode();

278
#if defined(XPROG_VIA_HARDWARE_USART)
279
280
281
282
	/* Turn off receiver and transmitter of the USART, clear settings */
	UCSR1A |= (1 << TXC1) | (1 << RXC1);
	UCSR1B  = 0;
	UCSR1C  = 0;
283
284

	/* Set all USART lines as input, tristate */
285
	DDRD  &= ~((1 << 5) | (1 << 3));
286
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
287
#else
288
289
290
	/* Turn off software USART management timer */
	TCCR1B = 0;

291
	/* Set DATA and CLOCK lines to inputs */
292
293
	BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
294
295
	
	/* Tristate DATA and CLOCK lines */
296
297
	BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
298
#endif
299
300

	/* Tristate target /RESET line */
301
302
	AUX_LINE_DDR  &= ~AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
303
304
}

305
306
307
308
/** Sends a byte via the USART.
 *
 *  \param[in] Byte  Byte to send through the USART
 */
309
void XPROGTarget_SendByte(const uint8_t Byte)
310
{
311
312
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
313
314
315
	  XPROGTarget_SetTxMode();
	  
#if defined(XPROG_VIA_HARDWARE_USART)
316
317
	/* Wait until there is space in the hardware Tx buffer before writing */
	while (!(UCSR1A & (1 << UDRE1)));
318
319
	UCSR1A |= (1 << TXC1);
	UDR1    = Byte;
320
#else
321
322
	/* Calculate the new USART frame data here while while we wait for a previous byte (if any) to finish sending */
	uint16_t NewUSARTData = ((1 << 11) | (1 << 10) | (0 << 9) | ((uint16_t)Byte << 1) | (0 << 0));
323

324
	/* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
325
	uint8_t ParityData = Byte;
326
	while (ParityData)
327
	{
328
329
		NewUSARTData ^= (1 << 9);
		ParityData   &= (ParityData - 1);
330
331
	}

332
	/* Wait until transmitter is idle before writing new data */
333
334
335
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
336
	SoftUSART_Data     = NewUSARTData;
337
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
338
#endif
339
340
}

341
342
343
344
/** Receives a byte via the software USART, blocking until data is received.
 *
 *  \return Received byte from the USART
 */
345
uint8_t XPROGTarget_ReceiveByte(void)
346
{
347
348
	/* Switch to Rx mode if currently in Tx mode */
	if (IsSending)
349
	  XPROGTarget_SetRxMode();
350

351
#if defined(XPROG_VIA_HARDWARE_USART)
352
	/* Wait until a byte has been received before reading */
353
354
355
356
357
358
359
360
361
362
363
	uint8_t TimeoutMSRemaining = 100;
	while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}	
	}
	
364
	return UDR1;
365
366
#else
	/* Wait until a byte has been received before reading */
367
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
368
369
370
371
372
373
374
375
376
377
	uint8_t TimeoutMSRemaining = 100;
	while (SoftUSART_BitCount && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}
378

379
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
380
	return (uint8_t)SoftUSART_Data;
381
#endif
382
383
}

384
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
385
void XPROGTarget_SendBreak(void)
386
{
387
388
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
389
	  XPROGTarget_SetTxMode();
390

391
#if defined(XPROG_VIA_HARDWARE_USART)
392
	/* Need to do nothing for a full frame to send a BREAK */
393
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
394
	{
395
		/* Wait for a full cycle of the clock */
396
397
398
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
399
#else
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
	while (SoftUSART_BitCount);

	/* Need to do nothing for a full frame to send a BREAK */
	SoftUSART_Data     = 0x0FFF;
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
#endif
}

static void XPROGTarget_SetTxMode(void)
{
#if defined(XPROG_VIA_HARDWARE_USART)
	/* Wait for a full cycle of the clock */
	while (PIND & (1 << 5));
	while (!(PIND & (1 << 5)));

	PORTD  |=  (1 << 3);
	DDRD   |=  (1 << 3);

	UCSR1B &= ~(1 << RXEN1);
	UCSR1B |=  (1 << TXEN1);
		
	IsSending = true;
#else
	while (SoftUSART_BitCount);

	/* Wait for a full cycle of the clock */
	SoftUSART_Data     = 0x0001;
	SoftUSART_BitCount = 1;
	while (SoftUSART_BitCount);

	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
431
432
433
434
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
	else
	{
		BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
		BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;	
	}
#endif

	IsSending = true;
}

static void XPROGTarget_SetRxMode(void)
{
#if defined(XPROG_VIA_HARDWARE_USART)
	while (!(UCSR1A & (1 << TXC1)));
	UCSR1A |=  (1 << TXC1);

	UCSR1B &= ~(1 << TXEN1);
	UCSR1B |=  (1 << RXEN1);

	DDRD   &= ~(1 << 3);
	PORTD  &= ~(1 << 3);
#else
457
458
	while (SoftUSART_BitCount);

459
460
461
462
463
464
465
466
467
468
469
470
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		BITBANG_PDIDATA_DDR  &= ~BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
	}
	else
	{
		BITBANG_TPIDATA_DDR  &= ~BITBANG_TPIDATA_MASK;
		BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;	
	}
	
	/* Wait until DATA line has been pulled up to idle by the target */
471
472
473
474
475
476
477
478
479
480
	uint8_t TimeoutMSRemaining = 100;
	while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}	
481
#endif
482
483

	IsSending = false;
484
485
}

486
#endif