XPROGTarget.c 9.65 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
36
37
38
/*
             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.
 */

#define  INCLUDE_FROM_PDITARGET_C
#include "PDITarget.h"

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 software USART when bit-banged USART mode is selected. */
53
ISR(TIMER1_COMPA_vect, ISR_BLOCK)
54
{
55
56
	/* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
	BITBANG_PDICLOCK_PIN |= BITBANG_PDICLOCK_MASK;
57

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

62
63
	/* Check to see if we are at a rising or falling edge of the clock */
	if (BITBANG_PDICLOCK_PORT & BITBANG_PDICLOCK_MASK)
64
	{
65
66
67
68
		/* If at rising clock edge and we are in send mode, abort */
		if (IsSending)
		  return;
		  
69
		/* Wait for the start bit when receiving */
70
		if ((SoftUSART_BitCount == BITS_IN_PDI_FRAME) && (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK))
71
72
		  return;
	
73
74
		/* 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
		if (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK)
76
		  SoftUSART_Data |= (1 << (BITS_IN_PDI_FRAME - 1));
77

78
79
		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
80
	}
81
82
83
84
85
86
	else
	{
		/* If at falling clock edge and we are in receive mode, abort */
		if (!IsSending)
		  return;

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

		SoftUSART_Data >>= 1;
		SoftUSART_BitCount--;
	}
96
}
97
#endif
98

99
/** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
100
101
void PDITarget_EnableTargetPDI(void)
{
102
#if defined(XPROG_VIA_HARDWARE_USART)
103
104
105
	/* Set Tx and XCK as outputs, Rx as input */
	DDRD |=  (1 << 5) | (1 << 3);
	DDRD &= ~(1 << 2);
106
	
107
	/* Set DATA line high for at least 90ns to disable /RESET functionality */
108
109
110
	PORTD |= (1 << 3);
	asm volatile ("NOP"::);
	asm volatile ("NOP"::);
111
	
112
113
	/* Set up the synchronous USART for XMEGA communications - 
	   8 data bits, even parity, 2 stop bits */
114
	UBRR1  = (F_CPU / 1000000UL);
115
	UCSR1B = (1 << TXEN1);
116
117
	UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);

118
	/* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
119
120
	PDITarget_SendBreak();
	PDITarget_SendBreak();
121
122
123
124
125
126
127
128
129
130
#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"::);

131
	/* Fire timer compare ISR every 100 cycles to manage the software USART */
132
	OCR1A   = 80;
133
134
	TCCR1B  = (1 << WGM12) | (1 << CS10);
	TIMSK1  = (1 << OCIE1A);
135
	
136
	/* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
137
138
139
	PDITarget_SendBreak();
	PDITarget_SendBreak();
#endif
140
141
}

142
/** Disables the target's PDI interface, exits programming mode and starts the target's application. */
143
144
void PDITarget_DisableTargetPDI(void)
{
145
#if defined(XPROG_VIA_HARDWARE_USART)
146
147
148
149
	/* Turn off receiver and transmitter of the USART, clear settings */
	UCSR1A |= (1 << TXC1) | (1 << RXC1);
	UCSR1B  = 0;
	UCSR1C  = 0;
150
151

	/* Set all USART lines as input, tristate */
152
	DDRD  &= ~((1 << 5) | (1 << 3));
153
	PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
154
155
156
157
158
159
160
161
162
#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
163
164
}

165
166
167
168
/** Sends a byte via the USART.
 *
 *  \param[in] Byte  Byte to send through the USART
 */
169
void PDITarget_SendByte(const uint8_t Byte)
170
{
171
#if defined(XPROG_VIA_HARDWARE_USART)
172
173
174
175
176
	/* Switch to Tx mode if currently in Rx mode */
	if (!(IsSending))
	{
		PORTD  |=  (1 << 3);
		DDRD   |=  (1 << 3);
177

178
		UCSR1B |=  (1 << TXEN1);
179
		UCSR1B &= ~(1 << RXEN1);
180
181
182
183
184
185
		
		IsSending = true;
	}
	
	/* Wait until there is space in the hardware Tx buffer before writing */
	while (!(UCSR1A & (1 << UDRE1)));
186
187
	UCSR1A |= (1 << TXC1);
	UDR1    = Byte;
188
189
190
191
192
193
194
195
196
197
#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;
	}

198
199
	/* 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));
200

201
	/* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
202
	uint8_t ParityData    = Byte;
203
	while (ParityData)
204
	{
205
206
		NewUSARTData ^= (1 << 9);
		ParityData   &= (ParityData - 1);
207
208
	}

209
	/* Wait until transmitter is idle before writing new data */
210
211
212
	while (SoftUSART_BitCount);

	/* Data shifted out LSB first, START DATA PARITY STOP STOP */
213
	SoftUSART_Data     = NewUSARTData;
214
	SoftUSART_BitCount = BITS_IN_PDI_FRAME;
215
#endif
216
217
}

218
219
220
221
/** Receives a byte via the software USART, blocking until data is received.
 *
 *  \return Received byte from the USART
 */
222
223
uint8_t PDITarget_ReceiveByte(void)
{
224
#if defined(XPROG_VIA_HARDWARE_USART)
225
226
227
228
229
	/* Switch to Rx mode if currently in Tx mode */
	if (IsSending)
	{
		while (!(UCSR1A & (1 << TXC1)));
		UCSR1A |=  (1 << TXC1);
230

231
232
233
234
235
236
237
238
239
240
		UCSR1B &= ~(1 << TXEN1);
		UCSR1B |=  (1 << RXEN1);

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

	/* Wait until a byte has been received before reading */
241
242
	while (!(UCSR1A & (1 << RXC1)));
	return UDR1;
243
244
245
246
247
248
249
250
251
252
253
254
255
#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 */
256
	SoftUSART_BitCount = BITS_IN_PDI_FRAME;
257
258
	while (SoftUSART_BitCount);
	
259
	/* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
260
	return (uint8_t)SoftUSART_Data;
261
#endif
262
263
}

264
/** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
265
266
void PDITarget_SendBreak(void)
{
267
#if defined(XPROG_VIA_HARDWARE_USART)
268
269
270
271
272
273
274
275
276
277
278
	/* 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;
	}
279

280
	/* Need to do nothing for a full frame to send a BREAK */
281
	for (uint8_t i = 0; i < BITS_IN_PDI_FRAME; i++)
282
	{
283
		/* Wait for a full cycle of the clock */
284
285
286
		while (PIND & (1 << 5));
		while (!(PIND & (1 << 5)));
	}
287
288
289
290
291
292
293
294
295
296
297
298
299
300
#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;
301
	SoftUSART_BitCount = BITS_IN_PDI_FRAME;
302
#endif
303
304
}

305
306
307
308
309
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
 *  calculation.
 *
 *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 */
310
311
312
bool PDITarget_WaitWhileNVMBusBusy(void)
{
	TCNT0 = 0;
313
314
315
316
	TIFR0 = (1 << OCF1A);
			
	uint8_t TimeoutMS = PDI_NVM_TIMEOUT_MS;
	
317
	/* Poll the STATUS register to check to see if NVM access has been enabled */
318
	while (TimeoutMS)
319
320
321
322
323
	{
		/* Send the LDCS command to read the PDI STATUS register to see the NVM bus is active */
		PDITarget_SendByte(PDI_CMD_LDCS | PDI_STATUS_REG);
		if (PDITarget_ReceiveByte() & PDI_STATUS_NVM)
		  return true;
324
325
326
327
328
329

		if (TIFR0 & (1 << OCF1A))
		{
			TIFR0 = (1 << OCF1A);
			TimeoutMS--;
		}
330
331
332
333
334
	}
	
	return false;
}

335
#endif