XPROGTarget.c 13.9 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
160
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
161
	UBRR1  = (F_CPU / XPROG_HARDWARE_SPEED);
162
163
164
165
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
#else
	/* Set DATA and CLOCK lines to outputs */
166
167
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
168
	
169
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
170
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
171
	_delay_us(1);
172

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

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

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

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

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

213
214
215
216
	/* 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);
217
218
#endif

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

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

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

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

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

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

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

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

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

	/* Tristate target /RESET line */
282
283
	AUX_LINE_DDR  &= ~AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
284
285
}

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

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

313
	/* Wait until transmitter is idle before writing new data */
314
315
316
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
317
	SoftUSART_Data     = NewUSARTData;
318
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
319
#endif
320
321
}

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

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

358
359
360
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

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

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

373
#if defined(XPROG_VIA_HARDWARE_USART)
374
	/* Need to do nothing for a full frame to send a BREAK */
375
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
376
	{
377
		/* Wait for a full cycle of the clock */
378
379
380
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
381
#else
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
	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)
413
414
415
416
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
	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
439
440
	while (SoftUSART_BitCount);

441
442
443
444
445
446
447
448
449
450
451
452
	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 */
453
454
455
456
457
458
459
460
461
	while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining)
	{
		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
		{
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
		}
	}	
462
#endif
463

464
465
466
    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

467
	IsSending = false;
468
469
}

470
#endif