XPROGTarget.c 13.5 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
74
		  return;
	
		/* 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 */
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
99
/** ISR to manage the TPI software USART when bit-banged TPI USART mode is selected. */
ISR(TIMER1_COMPB_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
120
		/* 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 */
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
157
158
159
	
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
	PORTD |= (1 << 3);
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
	
160
161
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
162
	UBRR1  = (F_CPU / 500000UL);
163
164
165
166
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
#else
	/* Set DATA and CLOCK lines to outputs */
167
168
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
169
	
170
171
172
173
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
174

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

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

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

191
	/* Set /RESET line low for at least 90ns to enable TPI functionality */
192
193
	AUX_LINE_DDR  |=  AUX_LINE_MASK;
	AUX_LINE_PORT &= ~AUX_LINE_MASK;
194
195
196
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);

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 - 
203
	   8 data bits, even parity, 2 stop bits */
204
	UBRR1  = (F_CPU / 500000UL);
205
	UCSR1B = (1 << TXEN1);
206
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
207
208
#else
	/* Set DATA and CLOCK lines to outputs */
209
210
	BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR |= BITBANG_TPICLOCK_MASK;
211
	
212
213
	/* Set DATA line high for idle state */
	BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
214

215
216
	/* Fire timer capture channel B ISR to manage the software USART */
	OCR1B   = BITS_BETWEEN_USART_CLOCKS;
217
	TCCR1B  = (1 << WGM12) | (1 << CS10);
218
	TIMSK1  = (1 << OCIE1B);
219
220
#endif

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

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

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

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

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

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

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

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

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

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

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

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

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
321
	SoftUSART_Data     = NewUSARTData;
322
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
323
#endif
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
	return UDR1;
340
341
#else
	/* Wait until a byte has been received before reading */
342
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
343
344
	while (SoftUSART_BitCount && TimeoutMSRemaining);

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

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

357
#if defined(XPROG_VIA_HARDWARE_USART)
358
	/* Need to do nothing for a full frame to send a BREAK */
359
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
360
	{
361
		/* Wait for a full cycle of the clock */
362
363
364
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
365
#else
366
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
	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)
397
398
399
400
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	}
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
	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
423
424
	while (SoftUSART_BitCount);

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

	IsSending = false;
441
442
}

443
#endif