XPROGTarget.c 13.7 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
53
/** ISR to manage the PDI software USART when bit-banged PDI USART mode is selected. */
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
62

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

	/* Check to see if we are at a rising or falling edge of the clock */
63
	if (BITBANG_PDICLOCK_PORT & BITBANG_PDICLOCK_MASK)
64
65
66
67
68
69
	{
		/* If at rising clock edge and we are in send mode, abort */
		if (IsSending)
		  return;
		  
		/* Wait for the start bit when receiving */
70
		if ((SoftUSART_BitCount == BITS_IN_USART_FRAME) && (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK))
71
72
73
		  return;
	
		/* Shift in the bit one less than the frame size in position, so that the start bit will eventually
74
		 * be discarded leaving the data to be byte-aligned for quick access (subtract 9 as we are ORing to the MSB) */
75
76
		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
86
87

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
	else
	{
		/* If at falling clock edge and we are in receive mode, abort */
		if (!IsSending)
		  return;

		/* Set the data line to the next bit value */
88
89
		if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
		  BITBANG_PDIDATA_PORT |=  BITBANG_PDIDATA_MASK;
90
		else
91
		  BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;		  
92
93
94
95
96
97

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

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
156
	/* Set DATA line high for at least 90ns to disable /RESET functionality (note: too long will enable it again,
	 * so a fixed number of NOPs are used here */
157
	PORTD |= (1 << 3);
158
159
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
160
	
161
162
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
163
	UBRR1  = (F_CPU / 500000UL);
164
165
166
167
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
#else
	/* Set DATA and CLOCK lines to outputs */
168
169
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
170
	
171
172
	/* Set DATA line high for at least 90ns to disable /RESET functionality (note: too long will enable it again,
	 * so a fixed number of NOPs are used here */
173
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
174
175
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
176

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

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

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

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

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

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

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

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

233
#if defined(XPROG_VIA_HARDWARE_USART)
234
235
236
237
	/* Set /RESET high for a one millisecond to ensure target device is restarted */
	PORTD |= (1 << 5);
	_delay_ms(1);

238
239
240
241
242
243
244
245
246
	/* 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
247
248
249
250
	/* Set /RESET high for a one millisecond to ensure target device is restarted */
	BITBANG_PDICLOCK_PORT |= BITBANG_PDICLOCK_MASK;
	_delay_ms(1);

251
	/* Set DATA and CLOCK lines to inputs */
252
253
	BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
254
255
	
	/* Tristate DATA and CLOCK lines */
256
257
	BITBANG_PDIDATA_PORT  &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;
258
259
260
#endif
}

261
262
/** Disables the target's TPI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetTPI(void)
263
{
264
265
266
	/* Switch to Rx mode to ensure that all pending transmissions are complete */
	XPROGTarget_SetRxMode();

267
#if defined(XPROG_VIA_HARDWARE_USART)
268
269
270
271
	/* Turn off receiver and transmitter of the USART, clear settings */
	UCSR1A |= (1 << TXC1) | (1 << RXC1);
	UCSR1B  = 0;
	UCSR1C  = 0;
272
273

	/* Set all USART lines as input, tristate */
274
	DDRD  &= ~((1 << 5) | (1 << 3));
275
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
276
277
#else
	/* Set DATA and CLOCK lines to inputs */
278
279
	BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
280
281
	
	/* Tristate DATA and CLOCK lines */
282
283
	BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
284
#endif
285
286

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

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

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

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

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

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

337
#if defined(XPROG_VIA_HARDWARE_USART)
338
	/* Wait until a byte has been received before reading */
339
	while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining);
340
	return UDR1;
341
342
#else
	/* Wait until a byte has been received before reading */
343
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
344
345
	while (SoftUSART_BitCount && TimeoutMSRemaining);

346
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
347
	return (uint8_t)SoftUSART_Data;
348
#endif
349
350
}

351
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
352
void XPROGTarget_SendBreak(void)
353
{
354
355
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
356
	  XPROGTarget_SetTxMode();
357

358
#if defined(XPROG_VIA_HARDWARE_USART)
359
	/* Need to do nothing for a full frame to send a BREAK */
360
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
361
	{
362
		/* Wait for a full cycle of the clock */
363
364
365
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
366
#else
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
	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)
398
399
400
401
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
	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
424
425
	while (SoftUSART_BitCount);

426
427
428
429
430
431
432
433
434
435
436
437
	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 */
438
	while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining);
439
#endif
440
441

	IsSending = false;
442
443
}

444
#endif