XPROGProtocol.c 15.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
  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
 *
33
 *  XPROG Protocol handler, to process V2 Protocol wrapped XPROG commands used in Atmel programmer devices.
34
35
 */

36
37
#define  INCLUDE_FROM_XPROGPROTOCOL_C
#include "XPROGProtocol.h"
38

39
#if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
40
/** Base absolute address for the target's NVM controller for PDI programming */
41
uint32_t XPROG_Param_NVMBase = 0x010001C0;
42
43

/** Size in bytes of the target's EEPROM page */
44
45
46
47
48
49
50
uint16_t XPROG_Param_EEPageSize;

/** Address of the TPI device's NVMCMD register for TPI programming */
uint8_t  XPROG_Param_NVMCMDRegAddr;

/** Address of the TPI device's NVMCSR register for TPI programming */
uint8_t  XPROG_Param_NVMCSRRegAddr;
51

52
/** Currently selected XPROG programming protocol */
53
uint8_t  XPROG_SelectedProtocol = XPRG_PROTOCOL_PDI;
54
55
56

/** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI/TPI
 *  programming.
57
 */
58
void XPROGProtocol_SetMode(void)
59
60
61
62
63
64
{
	struct
	{
		uint8_t Protocol;
	} SetMode_XPROG_Params;
	
65
	Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params), NO_STREAM_CALLBACK);
66
67
68
69

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
70
	XPROG_SelectedProtocol = SetMode_XPROG_Params.Protocol;
71
	
72
	Endpoint_Write_Byte(CMD_XPROG_SETMODE);
73
	Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol != XPRG_PROTOCOL_JTAG) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
74
75
76
	Endpoint_ClearIN();	
}

77
78
79
/** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
 *  removed and processed so that the underlying XPROG command can be handled.
 */
80
void XPROGProtocol_Command(void)
81
82
{
	uint8_t XPROGCommand = Endpoint_Read_Byte();
83
	
84
85
86
	switch (XPROGCommand)
	{
		case XPRG_CMD_ENTER_PROGMODE:
87
			XPROGProtocol_EnterXPROGMode();
88
89
			break;
		case XPRG_CMD_LEAVE_PROGMODE:
90
			XPROGProtocol_LeaveXPROGMode();
91
92
			break;
		case XPRG_CMD_ERASE:
93
			XPROGProtocol_Erase();
94
95
			break;
		case XPRG_CMD_WRITE_MEM:
96
			XPROGProtocol_WriteMemory();
97
98
			break;
		case XPRG_CMD_READ_MEM:
99
			XPROGProtocol_ReadMemory();
100
101
			break;
		case XPRG_CMD_CRC:
102
			XPROGProtocol_ReadCRC();
103
104
			break;
		case XPRG_CMD_SET_PARAM:
105
			XPROGProtocol_SetParam();
106
107
108
109
			break;
	}
}

110
111
/** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
static void XPROGProtocol_EnterXPROGMode(void)
112
113
114
115
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
116
	bool NVMBusEnabled;
117

118
119
120
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Enable PDI programming mode with the attached target */
121
		XPROGTarget_EnableTargetPDI();
122

123
		/* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
124
125
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(PDI_RESET_KEY);
126

127
		/* Lower direction change guard time to 0 USART bits */
128
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_CTRL_REG);	
129
		XPROGTarget_SendByte(0x07);
130

131
		/* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
132
		XPROGTarget_SendByte(PDI_CMD_KEY);	
133
		for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
134
		  XPROGTarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
135
136

		/* Wait until the NVM bus becomes active */
137
		NVMBusEnabled = XMEGANVM_WaitWhileNVMBusBusy();
138
139
140
	}
	else
	{
141
142
143
		/* Enable TPI programming mode with the attached target */
		XPROGTarget_EnableTargetTPI();
		
144
		/* Lower direction change guard time to 0 USART bits */
145
		XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
146
		XPROGTarget_SendByte(0x07);
147
		
148
149
150
151
152
153
154
		/* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
		XPROGTarget_SendByte(TPI_CMD_SKEY);	
		for (uint8_t i = sizeof(TPI_NVMENABLE_KEY); i > 0; i--)
		  XPROGTarget_SendByte(TPI_NVMENABLE_KEY[i - 1]);

		/* Wait until the NVM bus becomes active */
		NVMBusEnabled = TINYNVM_WaitWhileNVMBusBusy();
155
	}
156
157
158
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
159
	Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
160
161
162
	Endpoint_ClearIN();
}

163
164
165
/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 *  the attached device.
 */
166
static void XPROGProtocol_LeaveXPROGMode(void)
167
168
169
170
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
171
172
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
173
174
		XMEGANVM_WaitWhileNVMBusBusy();

175
		/* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
176
177
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(0x00);
178
179
180
181
		
		/* Clear /RESET key twice (for some reason this needs to be done twice to take effect) */
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(0x00);
182

183
		XPROGTarget_DisableTargetPDI();
184
185
186
	}
	else
	{
187
188
		TINYNVM_WaitWhileNVMBusBusy();

189
190
191
		/* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
		XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);	
		XPROGTarget_SendByte(0x00);
192
193
	
		XPROGTarget_DisableTargetTPI();
194
195
	}
	
196
197
198
199
200
201
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
	Endpoint_Write_Byte(XPRG_ERR_OK);
	Endpoint_ClearIN();
}

202
/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
203
static void XPROGProtocol_Erase(void)
204
205
206
207
208
209
210
211
212
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
	} Erase_XPROG_Params;

213
	Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NO_STREAM_CALLBACK);
214
	Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
215
216
217
218

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
219
220
	uint8_t EraseCommand;

221
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
222
	{	
223
		/* Determine which NVM command to send to the device depending on the memory to erase */
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
		switch (Erase_XPROG_Params.MemoryType)
		{
			case XPRG_ERASE_CHIP:
				EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
				break;
			case XPRG_ERASE_APP:
				EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
				break;
			case XPRG_ERASE_BOOT:
				EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
				break;
			case XPRG_ERASE_EEPROM:
				EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
				break;
			case XPRG_ERASE_APP_PAGE:
				EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
				break;
			case XPRG_ERASE_BOOT_PAGE:
				EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
				break;
			case XPRG_ERASE_EEPROM_PAGE:
				EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
				break;
			case XPRG_ERASE_USERSIG:
				EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
				break;
250
251
252
			default:
				EraseCommand = XMEGA_NVM_CMD_NOOP;
				break;
253
		}
254
255
256
257
258
259
260
		
		/* Erase the target memory, indicate timeout if ocurred */
		if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
261
262
263
264
265
		if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
		  EraseCommand = TINY_NVM_CMD_CHIPERASE;
		else
		  EraseCommand = TINY_NVM_CMD_SECTIONERASE;
	
266
		/* Erase the target memory, indicate timeout if ocurred */
267
		if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
268
		  ReturnStatus = XPRG_ERR_TIMEOUT;
269
	}
270
271
272
273
274
275
276
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ERASE);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();	
}

277
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
278
static void XPROGProtocol_WriteMemory(void)
279
280
281
282
283
284
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
285
		uint8_t  PageMode;
286
287
		uint32_t Address;
		uint16_t Length;
288
		uint8_t  ProgData[256];
289
290
291
	} WriteMemory_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
292
	                                                    sizeof(WriteMemory_XPROG_Params).ProgData), NO_STREAM_CALLBACK);
293
294
	WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
	WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
295
	Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
296
297
298

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
299

300
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
301
	{
302
303
304
305
306
		/* Assume FLASH page programming by default, as it is the common case */
		uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
		uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
		uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
		bool    PagedMemory      = true;
307
308
		
		switch (WriteMemory_XPROG_Params.MemoryType)
309
		{
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
			case XPRG_MEM_TYPE_APPL:
				WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
				break;
			case XPRG_MEM_TYPE_BOOT:
				WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
				break;
			case XPRG_MEM_TYPE_EEPROM:
				WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
				WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
				EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;			
				break;
			case XPRG_MEM_TYPE_USERSIG:
				/* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
				WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
				WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
				break;
			case XPRG_MEM_TYPE_FUSE:
				WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
				PagedMemory      = false;
				break;
			case XPRG_MEM_TYPE_LOCKBITS:
				WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
				PagedMemory      = false;
				break;
334
335
336
		}
		
		/* Send the appropriate memory write commands to the device, indicate timeout if occurred */
337
		if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, 
338
													   WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
339
340
341
													   WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
		   (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
													   WriteMemory_XPROG_Params.ProgData[0]))))
342
343
344
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
345
	}
346
	else
347
	{
348
		/* Send write command to the TPI device, indicate timeout if occurred */
349
350
351
352
353
		if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
		      WriteMemory_XPROG_Params.Length)))
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
354
	}
355
356
	
	Endpoint_Write_Byte(CMD_XPROG);
357
	Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
358
359
360
361
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

362
363
364
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 *  attached device.
 */
365
static void XPROGProtocol_ReadMemory(void)
366
367
368
369
370
371
372
373
374
375
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
		uint16_t Length;
	} ReadMemory_XPROG_Params;
	
376
	Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
377
378
379
380
381
	ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
	ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
382

383
	uint8_t ReadBuffer[256];
384
	
385
386
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
387
		/* Read the PDI target's memory, indicate timeout if occurred */
388
389
390
391
392
		if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
393
394
395
		/* Read the TPI target's memory, indicate timeout if occurred */
		if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
396
	}
397

398
399
400
401
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);
	
402
	if (ReturnStatus == XPRG_ERR_OK)
403
	  Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
404
	
405
406
407
	Endpoint_ClearIN();
}

408
409
410
/** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 *  attached device's memory and a data set on the host.
 */
411
static void XPROGProtocol_ReadCRC(void)
412
413
414
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
415
416
417
418
419
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
420
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
421

422
423
424
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
425
	uint32_t MemoryCRC;
426

427
428
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
429
430
		uint8_t CRCCommand;

431
		/* Determine which NVM command to send to the device depending on the memory to CRC */
432
433
434
435
436
437
438
439
440
441
442
443
		switch (ReadCRC_XPROG_Params.CRCType)
		{
			case XPRG_CRC_APP:
				CRCCommand = XMEGA_NVM_CMD_APPCRC;
				break;
			case XPRG_CRC_BOOT:
				CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
				break;
			default:
				CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
				break;
		}
444
445
446
447
448
		
		/* Perform and retrieve the memory CRC, indicate timeout if occurred */
		if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
449
	else
450
	{
451
452
		/* TPI does not support memory CRC */
		ReturnStatus = XPRG_ERR_FAILED;
453
	}
454
455
456
457
458
459
460
461
462
463
464
465
466
467
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_CRC);
	Endpoint_Write_Byte(ReturnStatus);
	
	if (ReturnStatus == XPRG_ERR_OK)
	{
		Endpoint_Write_Byte(MemoryCRC >> 16);
		Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);		
	}
	
	Endpoint_ClearIN();	
}

468
/** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
469
470
 *  attached device.
 */
471
static void XPROGProtocol_SetParam(void)
472
473
474
475
476
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
477
	/* Determine which parameter is being set, store the new parameter value */
478
479
480
481
482
483
484
485
	switch (XPROGParam)
	{
		case XPRG_PARAM_NVMBASE:
			XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
			break;
		case XPRG_PARAM_EEPPAGESIZE:
			XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
			break;
486
		case XPRG_PARAM_NVMCMD_REG:
487
488
			XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
			break;
489
		case XPRG_PARAM_NVMCSR_REG:
490
491
			XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
			break;
492
493
494
495
496
		default:
			ReturnStatus = XPRG_ERR_FAILED;
			break;
	}

497
498
499
500
501
502
503
504
505
506
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
		  
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();
}

#endif