XPROGTarget.c 14.1 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 PDI software USART when bit-banged PDI 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
59
60
61

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

62
	/* Check to see if we are at a rising or falling edge of the clock */
63
64
65
66
67
68
69
70
71
	if (BITBANG_PDICLOCK_PORT & BITBANG_PDICLOCK_MASK)
	{
		/* 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;
72

73
74
75
76
		/* 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));
77

78
79
80
81
82
83
84
85
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
	else
	{
		/* If at falling clock edge and we are in receive mode, abort */
		if (!IsSending)
		  return;
86

87
88
89
90
91
		/* 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;		  
92

93
94
95
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;	
	}
96
97
}

98
/** ISR to manage the TPI software USART when bit-banged TPI USART mode is selected. */
99
ISR(TIMER1_CAPT_vect, ISR_BLOCK)
100
{
101
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
102
	BITBANG_TPICLOCK_PIN = BITBANG_TPICLOCK_MASK;
103

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

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

124
125
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
126
	}
127
128
129
130
131
132
	else
	{
		/* If at falling clock edge and we are in receive mode, abort */
		if (!IsSending)
		  return;

133
		/* Set the data line to the next bit value */
134
135
		if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
		  BITBANG_TPIDATA_PORT |=  BITBANG_TPIDATA_MASK;
136
		else
137
		  BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;		  
138
139
140
141

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
142
}
143
#endif
144

145
146
/** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
void XPROGTarget_EnableTargetPDI(void)
147
{
148
149
	IsSending = false;

150
151
152
153
#if defined(XPROG_VIA_HARDWARE_USART)
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
154
	
155
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
156
	PORTD |= (1 << 3);
157
	_delay_us(1);
158
	
159
	/* Set up the synchronous USART for XMEGA communications - 8 data bits, even parity, 2 stop bits */
160
	UBRR1  = (F_CPU / XPROG_HARDWARE_SPEED);
161
162
163
164
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
#else
	/* Set DATA and CLOCK lines to outputs */
165
166
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
167
	
168
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
169
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
170
	_delay_us(1);
171

172
	/* Fire timer compare channel A ISR to manage the software USART */
173
174
175
	OCR1A  = BITS_BETWEEN_USART_CLOCKS;
	TCCR1B = (1 << WGM12) | (1 << CS10);
	TIMSK1 = (1 << OCIE1A);
176
177
178
#endif

	/* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
179
180
181
182
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
}

183
184
/** Enables the target's TPI interface, holding the target in reset until TPI mode is exited. */
void XPROGTarget_EnableTargetTPI(void)
185
{
186
187
	IsSending = false;

188
	/* Set /RESET line low for at least 400ns to enable TPI functionality */
189
190
	AUX_LINE_DDR  |=  AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
191
	_delay_us(1);
192

193
#if defined(XPROG_VIA_HARDWARE_USART)
194
195
196
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
197
		
198
	/* Set up the synchronous USART for TINY communications - 8 data bits, even parity, 2 stop bits */
199
	UBRR1  = (F_CPU / XPROG_HARDWARE_SPEED);
200
	UCSR1B = (1 << TXEN1);
201
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
202
203
#else
	/* Set DATA and CLOCK lines to outputs */
204
205
	BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR |= BITBANG_TPICLOCK_MASK;
206
	
207
208
	/* Set DATA line high for idle state */
	BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
209

210
	/* Fire timer capture channel ISR to manage the software USART */
211
212
213
	ICR1   = BITS_BETWEEN_USART_CLOCKS;
	TCCR1B = (1 << WGM13) | (1 << WGM12) | (1 << CS10);
	TIMSK1 = (1 << ICIE1);
214
215
#endif

216
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
217
218
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
219
220
}

221
222
/** Disables the target's PDI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetPDI(void)
223
{
224
225
226
	/* Switch to Rx mode to ensure that all pending transmissions are complete */
	XPROGTarget_SetRxMode();

227
228
#if defined(XPROG_VIA_HARDWARE_USART)
	/* Turn off receiver and transmitter of the USART, clear settings */
229
	UCSR1A  = ((1 << TXC1) | (1 << RXC1));
230
231
232
	UCSR1B  = 0;
	UCSR1C  = 0;

233
	/* Tristate all pins */
234
	DDRD  &= ~((1 << 5) | (1 << 3));
235
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
236
#else
237
238
239
	/* Turn off software USART management timer */
	TCCR1B = 0;

240
	/* Set DATA and CLOCK lines to inputs */
241
242
	BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
243
244
	
	/* Tristate DATA and CLOCK lines */
245
	BITBANG_PDIDATA_PORT  &= ~BITBANG_PDIDATA_MASK;
246
	BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;	
247
248
249
#endif
}

250
251
/** Disables the target's TPI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetTPI(void)
252
{
253
254
255
	/* Switch to Rx mode to ensure that all pending transmissions are complete */
	XPROGTarget_SetRxMode();

256
#if defined(XPROG_VIA_HARDWARE_USART)
257
258
259
260
	/* Turn off receiver and transmitter of the USART, clear settings */
	UCSR1A |= (1 << TXC1) | (1 << RXC1);
	UCSR1B  = 0;
	UCSR1C  = 0;
261
262

	/* Set all USART lines as input, tristate */
263
	DDRD  &= ~((1 << 5) | (1 << 3));
264
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
265
#else
266
267
268
	/* Turn off software USART management timer */
	TCCR1B = 0;

269
	/* Set DATA and CLOCK lines to inputs */
270
271
	BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
272
273
	
	/* Tristate DATA and CLOCK lines */
274
275
	BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
276
#endif
277
278

	/* Tristate target /RESET line */
279
280
	AUX_LINE_DDR  &= ~AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
281
282
}

283
284
285
286
/** Sends a byte via the USART.
 *
 *  \param[in] Byte  Byte to send through the USART
 */
287
void XPROGTarget_SendByte(const uint8_t Byte)
288
{
289
290
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
291
292
293
	  XPROGTarget_SetTxMode();
	  
#if defined(XPROG_VIA_HARDWARE_USART)
294
295
	/* Wait until there is space in the hardware Tx buffer before writing */
	while (!(UCSR1A & (1 << UDRE1)));
296
297
	UCSR1A |= (1 << TXC1);
	UDR1    = Byte;
298
#else
299
300
	/* 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));
301

302
	/* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
303
	uint8_t ParityData = Byte;
304
	while (ParityData)
305
	{
306
307
		NewUSARTData ^= (1 << 9);
		ParityData   &= (ParityData - 1);
308
309
	}

310
	/* Wait until transmitter is idle before writing new data */
311
312
313
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
314
	SoftUSART_Data     = NewUSARTData;
315
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
316
#endif
317
318
}

319
320
321
322
/** Receives a byte via the software USART, blocking until data is received.
 *
 *  \return Received byte from the USART
 */
323
uint8_t XPROGTarget_ReceiveByte(void)
324
{
325
326
	/* Switch to Rx mode if currently in Tx mode */
	if (IsSending)
327
	  XPROGTarget_SetRxMode();
328

329
#if defined(XPROG_VIA_HARDWARE_USART)
330
	/* Wait until a byte has been received before reading */
331
332
333
334
335
336
337
338
339
340
	while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}	
	}
	
341
	return UDR1;
342
343
#else
	/* Wait until a byte has been received before reading */
344
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
345
346
347
348
349
350
351
352
353
	while (SoftUSART_BitCount && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}
354

355
356
357
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

358
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
359
	return (uint8_t)SoftUSART_Data;
360
#endif
361
362
}

363
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
364
void XPROGTarget_SendBreak(void)
365
{
366
367
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
368
	  XPROGTarget_SetTxMode();
369

370
#if defined(XPROG_VIA_HARDWARE_USART)
371
	/* Need to do nothing for a full frame to send a BREAK */
372
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
373
	{
374
		/* Wait for a full cycle of the clock */
375
376
377
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
378
#else
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
	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
402
403
404
405
406
407
408
409
410
	while (SoftUSART_BitCount && TimeoutMSRemaining)
	{	
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}
	
411
412
413
414
415
416
	/* Wait for a full cycle of the clock */
	SoftUSART_Data     = 0x0001;
	SoftUSART_BitCount = 1;
	while (SoftUSART_BitCount);

	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
417
418
419
420
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
	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
443
444
445
446
447
448
449
450
	while (SoftUSART_BitCount && TimeoutMSRemaining)
	{	
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}
451

452
453
454
455
456
457
458
459
460
461
462
463
	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 */
464
465
466
467
468
469
470
471
472
	while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}	
473
#endif
474

475
476
477
    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

478
	IsSending = false;
479
480
}

481
#endif