XPROGProtocol.c 14 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
/*
             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
 *
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 */
41
uint32_t XPROG_Param_NVMBase    = 0x010001C0;
42
43

/** Size in bytes of the target's EEPROM page */
44
45
uint32_t XPROG_Param_EEPageSize;

46
/** Currently selected XPROG programming protocol */
47
uint8_t  XPROG_SelectedProtocol = XPRG_PROTOCOL_PDI;
48
49
50

/** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI/TPI
 *  programming.
51
 */
52
void XPROGProtocol_SetMode(void)
53
54
55
56
57
58
59
60
61
62
63
{
	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);
	
64
	XPROG_SelectedProtocol = SetMode_XPROG_Params.Protocol;
65
	
66
	Endpoint_Write_Byte(CMD_XPROG_SETMODE);
67
	Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol != XPRG_PROTOCOL_JTAG) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
68
69
70
	Endpoint_ClearIN();	
}

71
72
73
/** 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.
 */
74
void XPROGProtocol_Command(void)
75
76
77
78
79
80
{
	uint8_t XPROGCommand = Endpoint_Read_Byte();

	switch (XPROGCommand)
	{
		case XPRG_CMD_ENTER_PROGMODE:
81
			XPROGProtocol_EnterXPROGMode();
82
83
			break;
		case XPRG_CMD_LEAVE_PROGMODE:
84
			XPROGProtocol_LeaveXPROGMode();
85
86
			break;
		case XPRG_CMD_ERASE:
87
			XPROGProtocol_Erase();
88
89
			break;
		case XPRG_CMD_WRITE_MEM:
90
			XPROGProtocol_WriteMemory();
91
92
			break;
		case XPRG_CMD_READ_MEM:
93
			XPROGProtocol_ReadMemory();
94
95
			break;
		case XPRG_CMD_CRC:
96
			XPROGProtocol_ReadCRC();
97
98
			break;
		case XPRG_CMD_SET_PARAM:
99
			XPROGProtocol_SetParam();
100
101
102
103
			break;
	}
}

104
105
/** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
static void XPROGProtocol_EnterXPROGMode(void)
106
107
108
109
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
110
	bool NVMBusEnabled;
111

112
113
114
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Enable PDI programming mode with the attached target */
115
		XPROGTarget_EnableTargetPDI();
116
117
		
		/* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
118
119
		XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
		XPROGTarget_SendByte(PDI_RESET_KEY);
120
121

		/* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
122
		XPROGTarget_SendByte(PDI_CMD_KEY);	
123
		for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
124
		  XPROGTarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
125
126

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

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

163
		XPROGTarget_DisableTargetPDI();
164
165
166
	}
	else
	{
167
168
169
		/* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
		XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);	
		XPROGTarget_SendByte(0x00);
170
171
	
		XPROGTarget_DisableTargetTPI();
172
173
	}
	
174
175
176
177
178
179
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
	Endpoint_Write_Byte(XPRG_ERR_OK);
	Endpoint_ClearIN();
}

180
/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
181
static void XPROGProtocol_Erase(void)
182
183
184
185
186
187
188
189
190
191
{
	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));
192
	Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
193
194
195
196

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
197
	uint8_t EraseCommand = XMEGA_NVM_CMD_NOOP;
198
	
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
	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
	{
		// TODO
	}
227
228
229
230
231
232
233
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ERASE);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();	
}

234
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
235
static void XPROGProtocol_WriteMemory(void)
236
237
238
239
240
241
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
242
		uint8_t  PageMode;
243
244
		uint32_t Address;
		uint16_t Length;
245
		uint8_t  ProgData[256];
246
247
248
249
250
251
252
253
254
255
	} 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);
256

257
	/* Assume FLASH page programming by default, as it is the common case */
258
259
260
	uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
	uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
	uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
261
	bool    PagedMemory      = true;
262
263

	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
264
	{
265
266
267
268
269
270
271
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 */
		if ((PagedMemory && !XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, 
													   WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
													   WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||
		   (!PagedMemory && !XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
													   WriteMemory_XPROG_Params.ProgData)))
		{
			ReturnStatus = XPRG_ERR_TIMEOUT;
		}
305
	}
306
	else
307
	{
308
		// TODO
309
	}
310
311
	
	Endpoint_Write_Byte(CMD_XPROG);
312
	Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
313
314
315
316
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

317
318
319
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 *  attached device.
 */
320
static void XPROGProtocol_ReadMemory(void)
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
{
	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);
337

338
	uint8_t ReadBuffer[256];
339
	
340
341
342
343
344
345
346
347
348
349
	if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
	{
		/* Read the target's memory, indicate timeout if occurred */
		if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
		  ReturnStatus = XPRG_ERR_TIMEOUT;
	}
	else
	{
		// TODO
	}
350

351
352
353
354
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);
	
355
356
357
	if (ReturnStatus == XPRG_ERR_OK)
	  Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
	
358
359
360
	Endpoint_ClearIN();
}

361
362
363
/** 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.
 */
364
static void XPROGProtocol_ReadCRC(void)
365
366
367
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
368
369
370
371
372
373
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
374
375
376
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
377
	uint8_t  CRCCommand = XMEGA_NVM_CMD_NOOP;
378
	uint32_t MemoryCRC;
379

380
381
382
383
384
385
386
387
388
389
390
391
392
393
	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;
	}
394
	else
395
	{
396
397
		/* TPI does not support memory CRC */
		ReturnStatus = XPRG_ERR_FAILED;
398
	}
399
400
401
402
403
404
405
406
407
408
409
410
411
412
	
	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();	
}

413
/** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
414
415
 *  attached device.
 */
416
static void XPROGProtocol_SetParam(void)
417
418
419
420
421
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
422
	/* Determine which parameter is being set, store the new parameter value */
423
	if (XPROGParam == XPRG_PARAM_NVMBASE)
424
	  XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
425
	else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
426
	  XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
427
428
429
430
431
432
433
434
435
436
437
438
439
	else
	  ReturnStatus = XPRG_ERR_FAILED;
	
	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