PDIProtocol.c 12.7 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
/*
             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
 *
 *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.
 */

36
#define  INCLUDE_FROM_PDIPROTOCOL_C
37
38
#include "PDIProtocol.h"

39
#if defined(ENABLE_PDI_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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
uint32_t XPROG_Param_EEPageSize;

/** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
 *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
 */
void PDIProtocol_XPROG_SetMode(void)
{
	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);
	
61
62
	Serial_TxByte(SetMode_XPROG_Params.Protocol);
	
63
	Endpoint_Write_Byte(CMD_XPROG_SETMODE);
64
	Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
65
66
67
	Endpoint_ClearIN();	
}

68
69
70
/** 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.
 */
71
72
73
74
75
76
77
78
79
80
81
82
83
void PDIProtocol_XPROG_Command(void)
{
	uint8_t XPROGCommand = Endpoint_Read_Byte();

	switch (XPROGCommand)
	{
		case XPRG_CMD_ENTER_PROGMODE:
			PDIProtocol_EnterXPROGMode();
			break;
		case XPRG_CMD_LEAVE_PROGMODE:
			PDIProtocol_LeaveXPROGMode();
			break;
		case XPRG_CMD_ERASE:
84
			PDIProtocol_Erase();
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
			break;
		case XPRG_CMD_WRITE_MEM:
			PDIProtocol_WriteMemory();
			break;
		case XPRG_CMD_READ_MEM:
			PDIProtocol_ReadMemory();
			break;
		case XPRG_CMD_CRC:
			PDIProtocol_ReadCRC();
			break;
		case XPRG_CMD_SET_PARAM:
			PDIProtocol_SetParam();
			break;
	}
}

101
/** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
102
103
104
105
106
static void PDIProtocol_EnterXPROGMode(void)
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
107
108
	/* Enable PDI programming mode with the attached target */
	PDITarget_EnableTargetPDI();
109
	
110
	/* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
111
	PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
112
113
	PDITarget_SendByte(PDI_RESET_KEY);

114
	/* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
115
	PDITarget_SendByte(PDI_CMD_KEY);	
116
117
	for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
	  PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
118

119
	/* Wait until the NVM bus becomes active */
120
	bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy();
121
122
123
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
124
	Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
125
126
127
	Endpoint_ClearIN();
}

128
129
130
/** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 *  the attached device.
 */
131
132
133
134
135
static void PDIProtocol_LeaveXPROGMode(void)
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
136
	/* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
137
	PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);	
138
139
	PDITarget_SendByte(0x00);

140
141
	PDITarget_DisableTargetPDI();

142
143
144
145
146
147
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
	Endpoint_Write_Byte(XPRG_ERR_OK);
	Endpoint_ClearIN();
}

148
149
/** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
static void PDIProtocol_Erase(void)
150
151
152
153
154
155
156
157
158
159
{
	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));
160
	Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
161
162
163
164

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
165
	uint8_t EraseCommand = XMEGA_NVM_CMD_NOOP;
166
	
167
	/* Determine which NVM command to send to the device depending on the memory to erase */
168
	if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
169
	  EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
170
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
171
	  EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
172
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
173
	  EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
174
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
175
	  EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
176
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
177
	  EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
178
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
179
	  EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
180
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
181
	  EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
182
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
183
	  EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
184
	
185
	/* Erase the target memory, indicate timeout if ocurred */
186
	if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
187
	  ReturnStatus = XPRG_ERR_TIMEOUT;
188
189
190
191
192
193
194
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ERASE);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();	
}

195
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
196
197
198
199
200
201
202
static void PDIProtocol_WriteMemory(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
203
		uint8_t  PageMode;
204
205
		uint32_t Address;
		uint16_t Length;
206
		uint8_t  ProgData[256];
207
208
209
210
211
212
213
214
215
216
	} 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);
217

218
	/* Assume FLASH page programming by default, as it is the common case */
219
220
221
	uint8_t WriteCommand     = XMEGA_NVM_CMD_WRITEFLASHPAGE;
	uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
	uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
222
	bool    PagedMemory      = true;
223
224
225
	
	if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_APPL)
	{
226
		WriteCommand     = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
227
228
229
	}
	else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_BOOT)
	{
230
		WriteCommand     = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
231
232
233
	}
	else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_EEPROM)
	{
234
235
236
		WriteCommand     = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
		WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
		EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
237
238
239
	}
	else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_USERSIG)
	{
240
241
		/* 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);
242
		WriteCommand     = XMEGA_NVM_CMD_WRITEUSERSIG;
243
244
245
	}
	else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_FUSE)
	{
246
		WriteCommand     = XMEGA_NVM_CMD_WRITEFUSE;
247
		PagedMemory      = false;
248
249
250
	}
	else if (WriteMemory_XPROG_Params.MemoryType == XPRG_MEM_TYPE_LOCKBITS)
	{
251
		WriteCommand     = XMEGA_NVM_CMD_WRITELOCK;
252
		PagedMemory      = false;
253
	}
254
	
255
	/* Send the appropriate memory write commands to the device, indicate timeout if occurred */
256
	if ((PagedMemory && !XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand, 
257
258
		                                           WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
		                                           WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length)) ||
259
	   (!PagedMemory && !XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
260
	                                               WriteMemory_XPROG_Params.ProgData)))
261
	{
262
		ReturnStatus = XPRG_ERR_TIMEOUT;
263
	}
264
265
	
	Endpoint_Write_Byte(CMD_XPROG);
266
	Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
267
268
269
270
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

271
272
273
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 *  attached device.
 */
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
static void PDIProtocol_ReadMemory(void)
{
	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);
291

292
	uint8_t ReadBuffer[256];
293
	
294
	/* Read the target's memory, indicate timeout if occurred */
295
	if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
296
	  ReturnStatus = XPRG_ERR_TIMEOUT;
297

298
299
300
301
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);
	
302
303
304
	if (ReturnStatus == XPRG_ERR_OK)
	  Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
	
305
306
307
	Endpoint_ClearIN();
}

308
309
310
/** 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.
 */
311
312
313
314
static void PDIProtocol_ReadCRC(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
315
316
317
318
319
320
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
321
322
323
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
324
	uint8_t  CRCCommand = XMEGA_NVM_CMD_NOOP;
325
	uint32_t MemoryCRC;
326

327
	/* Determine which NVM command to send to the device depending on the memory to CRC */
328
	if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
329
	  CRCCommand = XMEGA_NVM_CMD_APPCRC;
330
	else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
331
	  CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
332
	else
333
	  CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
334
	
335
	/* Perform and retrieve the memory CRC, indicate timeout if occurred */
336
	if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
337
	  ReturnStatus = XPRG_ERR_TIMEOUT;
338
339
340
341
342
343
344
345
346
347
348
349
350
351
	
	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();	
}

352
353
354
/** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 *  attached device.
 */
355
356
357
358
359
360
static void PDIProtocol_SetParam(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
361
	/* Determine which parameter is being set, store the new parameter value */
362
	if (XPROGParam == XPRG_PARAM_NVMBASE)
363
	  XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
364
	else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
365
	  XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
366
367
368
369
370
371
372
373
374
375
376
377
378
	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