XPROGTarget.c 14 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 not sending or receiving, just exit */
		if (!(SoftUSART_BitCount))
		  return;
86

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

91
92
93
94
95
		/* 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;		  
96

97
98
99
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;	
	}
100
101
}

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

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

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

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

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

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
146
}
147
#endif
148

149
150
/** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
void XPROGTarget_EnableTargetPDI(void)
151
{
152
153
	IsSending = false;

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

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

	/* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
185
186
187
188
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
}

189
190
/** Enables the target's TPI interface, holding the target in reset until TPI mode is exited. */
void XPROGTarget_EnableTargetTPI(void)
191
{
192
193
	IsSending = false;

194
	/* Set /RESET line low for at least 400ns to enable TPI functionality */
195
196
	AUX_LINE_DDR  |=  AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
197
	_delay_us(1);
198

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

217
218
219
220
	/* 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);
221
222
#endif

223
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
224
225
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
226
227
}

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

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

240
	/* Make Reset input with pullup to take target out of /RESET, tristate all other pins */
241
	DDRD  &= ~((1 << 5) | (1 << 3));
242
243
	PORTD &= ~((1 << 3) | (1 << 2));
	PORTD |=   (1 << 5);
244
#else
245
246
247
	/* Turn off software USART management timer */
	TCCR1B = 0;

248
	/* Make Reset input with pullup to take target out of /RESET, tristate all other pins */
249
250
	BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
251
	BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;	
252
	BITBANG_PDIDATA_PORT  |=  BITBANG_PDIDATA_MASK;
253
254
255
#endif
}

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

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

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

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

	/* Tristate target /RESET line */
285
286
	AUX_LINE_DDR  &= ~AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
287
288
}

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

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

316
	/* Wait until transmitter is idle before writing new data */
317
318
319
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
320
	SoftUSART_Data     = NewUSARTData;
321
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
322
#endif
323
324
}

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

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

361
362
363
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

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

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

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

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

467
468
469
    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

470
	IsSending = false;
471
472
}

473
#endif