XPROGTarget.c 12.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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
  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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/** ISR to manage the TPI software USART when bit-banged TPI USART mode is selected. */
ISR(TIMER1_CAPT_vect, ISR_BLOCK)
{
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
	BITBANG_TPICLOCK_PIN |= BITBANG_TPICLOCK_MASK;

	/* 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 */
	if (BITBANG_TPICLOCK_PORT & BITBANG_TPICLOCK_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_TPIDATA_PIN & BITBANG_TPIDATA_MASK))
		  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 */
		if (BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK)
		  SoftUSART_Data |= (1 << (BITS_IN_USART_FRAME - 1));

		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 */
		if (SoftUSART_Data & 0x01)
		  BITBANG_TPIDATA_PORT |=  BITBANG_TPIDATA_MASK;
		else
		  BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;		  

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

/** ISR to manage the PDI software USART when bit-banged PDI USART mode is selected. */
99
ISR(TIMER1_COMPA_vect, ISR_BLOCK)
100
{
101
102
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
	BITBANG_PDICLOCK_PIN |= BITBANG_PDICLOCK_MASK;
103

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

108
109
	/* Check to see if we are at a rising or falling edge of the clock */
	if (BITBANG_PDICLOCK_PORT & BITBANG_PDICLOCK_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_PDIDATA_PIN & BITBANG_PDIDATA_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
		if (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK)
122
		  SoftUSART_Data |= (1 << (BITS_IN_USART_FRAME - 1));
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
136
137
138
139
140
141
		if (SoftUSART_Data & 0x01)
		  BITBANG_PDIDATA_PORT |=  BITBANG_PDIDATA_MASK;
		else
		  BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;		  

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
142
}
143
#endif
144

145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/** Enables the target's TPI interface, holding the target in reset until TPI mode is exited. */
void XPROGTarget_EnableTargetTPI(void)
{
	/* Set /RESET line low for at least 90ns to enable TPI functionality */
	RESET_LINE_DDR  |= RESET_LINE_MASK;
	RESET_LINE_PORT &= ~RESET_LINE_MASK;
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);

#if defined(XPROG_VIA_HARDWARE_USART)
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
		
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
	UBRR1  = (F_CPU / 1000000UL);
	UCSR1B = (1 << TXEN1);
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);

	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
#else
	/* Set DATA and CLOCK lines to outputs */
	BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR |= BITBANG_TPICLOCK_MASK;
	
	/* Set DATA line high for idle state */
	BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;

	/* Fire timer capture ISR every 100 cycles to manage the software USART */
177
	OCR1A   = 100;
178
179
180
181
182
183
184
185
186
	TCCR1B  = (1 << WGM13) | (1 << WGM12) | (1 << CS10);
	TIMSK1  = (1 << ICIE1);
	
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
#endif
}

187
/** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
188
void XPROGTarget_EnableTargetPDI(void)
189
{
190
#if defined(XPROG_VIA_HARDWARE_USART)
191
192
193
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
194
	
195
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
196
197
198
	PORTD |= (1 << 3);
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
199
	
200
201
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
202
	UBRR1  = (F_CPU / 1000000UL);
203
	UCSR1B = (1 << TXEN1);
204
205
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);

206
	/* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
207
208
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
209
210
211
212
213
214
215
216
217
218
#else
	/* Set DATA and CLOCK lines to outputs */
	BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
	
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
	BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);

219
	/* Fire timer compare ISR every 100 cycles to manage the software USART */
220
	OCR1A   = 100;
221
222
	TCCR1B  = (1 << WGM12) | (1 << CS10);
	TIMSK1  = (1 << OCIE1A);
223
	
224
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
225
226
	XPROGTarget_SendBreak();
	XPROGTarget_SendBreak();
227
#endif
228
229
}

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/** Disables the target's TPI interface, exits programming mode and starts the target's application. */
void XPROGTarget_DisableTargetTPI(void)
{
#if defined(XPROG_VIA_HARDWARE_USART)
	/* 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
	/* Set DATA and CLOCK lines to inputs */
	BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
	
	/* Tristate DATA and CLOCK lines */
	BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
	BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
#endif

	/* Tristate target /RESET line */
	RESET_LINE_DDR  &= ~RESET_LINE_MASK;
	RESET_LINE_PORT &= ~RESET_LINE_MASK;
}

257
/** Disables the target's PDI interface, exits programming mode and starts the target's application. */
258
void XPROGTarget_DisableTargetPDI(void)
259
{
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
270
271
272
273
274
275
276
277
#else
	/* Set DATA and CLOCK lines to inputs */
	BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
	
	/* Tristate DATA and CLOCK lines */
	BITBANG_PDIDATA_PORT  &= ~BITBANG_PDIDATA_MASK;
	BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;
#endif
278
279
}

280
281
282
283
/** Sends a byte via the USART.
 *
 *  \param[in] Byte  Byte to send through the USART
 */
284
void XPROGTarget_SendByte(const uint8_t Byte)
285
{
286
#if defined(XPROG_VIA_HARDWARE_USART)
287
288
289
290
291
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
	{
		PORTD  |=  (1 << 3);
		DDRD   |=  (1 << 3);
292

293
		UCSR1B |=  (1 << TXEN1);
294
		UCSR1B &= ~(1 << RXEN1);
295
296
297
298
299
300
		
		IsSending = true;
	}
	
	/* Wait until there is space in the hardware Tx buffer before writing */
	while (!(UCSR1A & (1 << UDRE1)));
301
302
	UCSR1A |= (1 << TXC1);
	UDR1    = Byte;
303
304
305
306
307
308
309
310
311
312
#else
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;

		IsSending = true;
	}

313
314
	/* 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));
315

316
	/* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
317
	uint8_t ParityData    = Byte;
318
	while (ParityData)
319
	{
320
321
		NewUSARTData ^= (1 << 9);
		ParityData   &= (ParityData - 1);
322
323
	}

324
	/* Wait until transmitter is idle before writing new data */
325
326
327
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
328
	SoftUSART_Data     = NewUSARTData;
329
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
330
#endif
331
332
}

333
334
335
336
/** Receives a byte via the software USART, blocking until data is received.
 *
 *  \return Received byte from the USART
 */
337
uint8_t XPROGTarget_ReceiveByte(void)
338
{
339
#if defined(XPROG_VIA_HARDWARE_USART)
340
341
342
343
344
	/* Switch to Rx mode if currently in Tx mode */
	if (IsSending)
	{
		while (!(UCSR1A & (1 << TXC1)));
		UCSR1A |=  (1 << TXC1);
345

346
347
348
349
350
351
352
353
354
355
		UCSR1B &= ~(1 << TXEN1);
		UCSR1B |=  (1 << RXEN1);

		DDRD   &= ~(1 << 3);
		PORTD  &= ~(1 << 3);
		
		IsSending = false;
	}

	/* Wait until a byte has been received before reading */
356
	while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining);
357
	return UDR1;
358
359
360
361
362
363
364
365
366
367
368
369
370
#else
	/* Switch to Rx mode if currently in Tx mode */
	if (IsSending)
	{
		while (SoftUSART_BitCount);

		BITBANG_PDIDATA_DDR  &= ~BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;

		IsSending = false;
	}

	/* Wait until a byte has been received before reading */
371
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
372
373
	while (SoftUSART_BitCount && TimeoutMSRemaining);

374
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
375
	return (uint8_t)SoftUSART_Data;
376
#endif
377
378
}

379
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
380
void XPROGTarget_SendBreak(void)
381
{
382
#if defined(XPROG_VIA_HARDWARE_USART)
383
384
385
386
387
388
389
390
391
392
393
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
	{
		PORTD  |=  (1 << 3);
		DDRD   |=  (1 << 3);

		UCSR1B &= ~(1 << RXEN1);
		UCSR1B |=  (1 << TXEN1);
		
		IsSending = true;
	}
394

395
	/* Need to do nothing for a full frame to send a BREAK */
396
	for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
397
	{
398
		/* Wait for a full cycle of the clock */
399
400
401
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
402
403
404
405
406
407
408
409
410
411
412
413
414
415
#else
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
	{
		BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
		BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;

		IsSending = true;
	}
	
	while (SoftUSART_BitCount);

	/* Need to do nothing for a full frame to send a BREAK */
	SoftUSART_Data     = 0x0FFF;
416
	SoftUSART_BitCount = BITS_IN_USART_FRAME;
417
#endif
418
419
}

420
#endif