XPROGProtocol.c 15.9 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

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

78
79
80
/** 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.
 */
81
void XPROGProtocol_Command(void)
82
83
{
	uint8_t XPROGCommand = Endpoint_Read_Byte();
84
	
85
86
87
	switch (XPROGCommand)
	{
		case XPRG_CMD_ENTER_PROGMODE:
88
			XPROGProtocol_EnterXPROGMode();
89
90
			break;
		case XPRG_CMD_LEAVE_PROGMODE:
91
			XPROGProtocol_LeaveXPROGMode();
92
93
			break;
		case XPRG_CMD_ERASE:
94
			XPROGProtocol_Erase();
95
96
			break;
		case XPRG_CMD_WRITE_MEM:
97
			XPROGProtocol_WriteMemory();
98
99
			break;
		case XPRG_CMD_READ_MEM:
100
			XPROGProtocol_ReadMemory();
101
102
			break;
		case XPRG_CMD_CRC:
103
			XPROGProtocol_ReadCRC();
104
105
			break;
		case XPRG_CMD_SET_PARAM:
106
			XPROGProtocol_SetParam();
107
108
109
110
			break;
	}
}

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

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

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

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

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

		/* Wait until the NVM bus becomes active */
139
		NVMBusEnabled = XMEGANVM_WaitWhileNVMBusBusy();
140
141
142
	}
	else
	{
143
144
145
		/* Enable TPI programming mode with the attached target */
		XPROGTarget_EnableTargetTPI();
		
146
		/* Lower direction change guard time to 0 USART bits */
147
		XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
148
		XPROGTarget_SendByte(0x07);
149
		
150
151
152
153
154
155
156
		/* 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();
157
	}
158
159
160
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
161
	Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
162
163
164
	Endpoint_ClearIN();
}

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

178
		/* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
179
180
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(0x00);
181

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

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

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

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
	} Erase_XPROG_Params;

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

	Endpoint_ClearOUT();
216
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
217
218
	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

	Endpoint_ClearOUT();
298
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
299
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
300

301
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
302
	{
303
304
305
306
307
		/* 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;
308
309
		
		switch (WriteMemory_XPROG_Params.MemoryType)
310
		{
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
			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;
335
336
337
		}
		
		/* Send the appropriate memory write commands to the device, indicate timeout if occurred */
338
		if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, 
339
													   WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
340
341
342
													   WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
		   (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
													   WriteMemory_XPROG_Params.ProgData[0]))))
343
344
345
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
346
	}
347
	else
348
	{
349
		/* Send write command to the TPI device, indicate timeout if occurred */
350
351
352
353
354
		if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
		      WriteMemory_XPROG_Params.Length)))
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
355
	}
356
357
	
	Endpoint_Write_Byte(CMD_XPROG);
358
	Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
359
360
361
362
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

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

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
		uint16_t Length;
	} ReadMemory_XPROG_Params;
	
377
	Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
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();
382
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
383
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
384

385
	uint8_t ReadBuffer[256];
386
	
387
388
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
389
		/* Read the PDI target's memory, indicate timeout if occurred */
390
391
392
393
394
		if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
395
396
397
		/* 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;
398
	}
399

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

410
411
412
/** 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.
 */
413
static void XPROGProtocol_ReadCRC(void)
414
415
416
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
417
418
419
420
421
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
422
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
423

424
	Endpoint_ClearOUT();
425
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
426
427
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
428
	uint32_t MemoryCRC;
429

430
431
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
432
433
		uint8_t CRCCommand;

434
		/* Determine which NVM command to send to the device depending on the memory to CRC */
435
436
437
438
439
440
441
442
443
444
445
446
		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;
		}
447
448
449
450
451
		
		/* Perform and retrieve the memory CRC, indicate timeout if occurred */
		if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
452
	else
453
	{
454
455
		/* TPI does not support memory CRC */
		ReturnStatus = XPRG_ERR_FAILED;
456
	}
457
458
459
460
461
462
463
464
465
466
467
468
469
470
	
	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();	
}

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

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
480
	/* Determine which parameter is being set, store the new parameter value */
481
482
483
484
485
486
487
488
	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;
489
		case XPRG_PARAM_NVMCMD_REG:
490
491
			XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
			break;
492
		case XPRG_PARAM_NVMCSR_REG:
493
494
			XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
			break;
495
496
497
498
499
		default:
			ReturnStatus = XPRG_ERR_FAILED;
			break;
	}

500
	Endpoint_ClearOUT();
501
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
502
503
504
505
506
507
508
509
510
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
		  
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();
}

#endif