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 low for at least 1ms to ensure that the device is ready for PDI mode to be entered */
169
	BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
170
	_delay_ms(1);
171

172
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
173
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
174
	_delay_us(1);
175

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

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

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

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

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

214
	/* Fire timer capture channel ISR to manage the software USART */
215
216
217
	ICR1   = BITS_BETWEEN_USART_CLOCKS;
	TCCR1B = (1 << WGM13) | (1 << WGM12) | (1 << CS10);
	TIMSK1 = (1 << ICIE1);
218
219
#endif

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
324
325
}

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

336
#if defined(XPROG_VIA_HARDWARE_USART)
337
	/* Wait until a byte has been received before reading */
338
	while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining);
339
	
340
341
342
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

343
	return UDR1;
344
345
#else
	/* Wait until a byte has been received before reading */
346
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
347
	while (SoftUSART_BitCount && TimeoutMSRemaining);
348

349
350
351
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

352
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
353
	return (uint8_t)SoftUSART_Data;
354
#endif
355
356
}

357
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
358
void XPROGTarget_SendBreak(void)
359
{
360
361
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
362
	  XPROGTarget_SetTxMode();
363

364
#if defined(XPROG_VIA_HARDWARE_USART)
365
	/* Need to do nothing for a full frame to send a BREAK */
366
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
367
	{
368
		/* Wait for a full cycle of the clock */
369
370
371
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
372
#else
373
374
375
376
377
378
	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
379
380
381

    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
}

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
399
	while (SoftUSART_BitCount && TimeoutMSRemaining);
400
	
401
402
403
404
405
406
	/* Wait for a full cycle of the clock */
	SoftUSART_Data     = 0x0001;
	SoftUSART_BitCount = 1;
	while (SoftUSART_BitCount);

	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
407
408
409
410
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
411
412
413
414
415
416
417
	else
	{
		BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
		BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;	
	}
#endif

418
419
420
    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
	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
436
	while (SoftUSART_BitCount && TimeoutMSRemaining);
437

438
439
440
441
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		BITBANG_PDIDATA_DDR  &= ~BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
442
443

		/* Wait until DATA line has been pulled up to idle by the target */
444
		while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining);
445
446
447
448
	}
	else
	{
		BITBANG_TPIDATA_DDR  &= ~BITBANG_TPIDATA_MASK;
449
450
451
		BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;

		/* Wait until DATA line has been pulled up to idle by the target */
452
		while (!(BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK) && TimeoutMSRemaining);
453
	}	
454
#endif
455

456
457
458
    if (TimeoutMSRemaining)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

459
	IsSending = false;
460
461
}

462
#endif