XPROGProtocol.c 15 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

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
65
66
67
68
69
{
	struct
	{
		uint8_t Protocol;
	} SetMode_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));

	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

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

		/* Wait until the NVM bus becomes active */
133
		NVMBusEnabled = XMEGANVM_WaitWhileNVMBusBusy();
134
135
136
	}
	else
	{
137
138
139
		/* Enable TPI programming mode with the attached target */
		XPROGTarget_EnableTargetTPI();
		
140
141
142
143
144
145
146
		/* 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();
147
	}
148
149
150
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
151
	Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
152
153
154
	Endpoint_ClearIN();
}

155
156
157
/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 *  the attached device.
 */
158
static void XPROGProtocol_LeaveXPROGMode(void)
159
160
161
162
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
163
164
165
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
166
167
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(0x00);
168

169
		XPROGTarget_DisableTargetPDI();
170
171
172
	}
	else
	{
173
174
175
		/* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
		XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);	
		XPROGTarget_SendByte(0x00);
176
177
	
		XPROGTarget_DisableTargetTPI();
178
179
	}
	
180
181
182
183
184
185
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
	Endpoint_Write_Byte(XPRG_ERR_OK);
	Endpoint_ClearIN();
}

186
/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
187
static void XPROGProtocol_Erase(void)
188
189
190
191
192
193
194
195
196
197
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
	} Erase_XPROG_Params;

	Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
198
	Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
199
200
201
202

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
203
	uint8_t EraseCommand = XMEGA_NVM_CMD_NOOP;
204
	
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Determine which NVM command to send to the device depending on the memory to erase */
		if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
		  EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
		  EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
		  EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
		  EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
		  EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
		  EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
		  EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
		else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
		  EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
		
		/* Erase the target memory, indicate timeout if ocurred */
		if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
231
232
233
		/* Erase the target memory, indicate timeout if ocurred */
		if (!(TINYNVM_EraseMemory()))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
234
	}
235
236
237
238
239
240
241
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ERASE);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();	
}

242
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
243
static void XPROGProtocol_WriteMemory(void)
244
245
246
247
248
249
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
250
		uint8_t  PageMode;
251
252
		uint32_t Address;
		uint16_t Length;
253
		uint8_t  ProgData[256];
254
255
256
257
258
259
260
261
262
263
	} WriteMemory_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
	                                                    sizeof(WriteMemory_XPROG_Params).ProgData));
	WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
	WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
	Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
264

265
	/* Assume FLASH page programming by default, as it is the common case */
266
267
268
	uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
	uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
	uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
269
	bool    PagedMemory      = true;
270
271

	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
272
	{
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
		if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)
		{
			WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
		}
		else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)
		{
			WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
		}
		else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)
		{
			WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
			WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
			EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
		}
		else if (WriteMemory_XPROG_Params.MemoryType == 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;
		}
		else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)
		{
			WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
			PagedMemory      = false;
		}
		else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)
		{
			WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
			PagedMemory      = false;
		}
		
		/* Send the appropriate memory write commands to the device, indicate timeout if occurred */
305
		if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, 
306
													   WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
307
308
309
													   WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
		   (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
													   WriteMemory_XPROG_Params.ProgData[0]))))
310
311
312
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
313
	}
314
	else
315
	{
316
317
318
		/* Send write command to the TPI device, indicate timeout if occurred */
		if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData[0])))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
319
	}
320
321
	
	Endpoint_Write_Byte(CMD_XPROG);
322
	Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
323
324
325
326
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

327
328
329
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 *  attached device.
 */
330
static void XPROGProtocol_ReadMemory(void)
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
		uint16_t Length;
	} ReadMemory_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
	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);
347

348
	uint8_t ReadBuffer[256];
349
	
350
351
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
352
		/* Read the PDI target's memory, indicate timeout if occurred */
353
354
355
356
357
		if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
358
359
360
		/* 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;
361
	}
362

363
364
365
366
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);
	
367
368
369
	if (ReturnStatus == XPRG_ERR_OK)
	  Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
	
370
371
372
	Endpoint_ClearIN();
}

373
374
375
/** 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.
 */
376
static void XPROGProtocol_ReadCRC(void)
377
378
379
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
380
381
382
383
384
385
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
386
387
388
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
389
	uint8_t  CRCCommand = XMEGA_NVM_CMD_NOOP;
390
	uint32_t MemoryCRC;
391

392
393
394
395
396
397
398
399
400
401
402
403
404
405
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Determine which NVM command to send to the device depending on the memory to CRC */
		if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
		  CRCCommand = XMEGA_NVM_CMD_APPCRC;
		else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
		  CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
		else
		  CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
		
		/* Perform and retrieve the memory CRC, indicate timeout if occurred */
		if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
406
	else
407
	{
408
409
		/* TPI does not support memory CRC */
		ReturnStatus = XPRG_ERR_FAILED;
410
	}
411
412
413
414
415
416
417
418
419
420
421
422
423
424
	
	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();	
}

425
/** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
426
427
 *  attached device.
 */
428
static void XPROGProtocol_SetParam(void)
429
430
431
432
433
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
434
	/* Determine which parameter is being set, store the new parameter value */
435
436
437
438
439
440
441
442
	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;
443
444
445
446
447
448
		case XPRG_PARAM_NVMCMD:
			XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
			break;
		case XPRG_PARAM_NVMCSR:
			XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
			break;
449
450
451
452
453
		default:
			ReturnStatus = XPRG_ERR_FAILED;
			break;
	}

454
455
456
457
458
459
460
461
462
463
	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