PDIProtocol.c 9.97 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
40
41
#if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)
#warning PDI Programming Protocol support is incomplete and not currently suitable for use.

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
uint32_t XPROG_Param_NVMBase;
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);
	
	Endpoint_Write_Byte(CMD_XPROG_SETMODE);
61
	Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
62
63
64
	Endpoint_ClearIN();	
}

65
66
67
/** 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.
 */
68
69
70
71
72
73
74
75
76
77
78
79
80
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:
81
			PDIProtocol_Erase();
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
			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;
	}
}

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

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

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

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

137
138
	PDITarget_DisableTargetPDI();

139
140
141
142
143
144
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
	Endpoint_Write_Byte(XPRG_ERR_OK);
	Endpoint_ClearIN();
}

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

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
	uint8_t EraseCommand;
	
	if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
	  EraseCommand = NVM_CMD_CHIPERASE;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
	  EraseCommand = NVM_CMD_ERASEAPPSEC;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
	  EraseCommand = NVM_CMD_ERASEBOOTSEC;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
	  EraseCommand = NVM_CMD_ERASEEEPROM;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
	  EraseCommand = NVM_CMD_ERASEAPPSECPAGE;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
	  EraseCommand = NVM_CMD_ERASEBOOTSECPAGE;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
	  EraseCommand = NVM_CMD_ERASEEEPROMPAGE;
	else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
	  EraseCommand = NVM_CMD_ERASEUSERSIG;
	
	NVMTarget_EraseMemory(EraseCommand, Erase_XPROG_Params.Address);
182
183
184
185
186
187
188
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_ERASE);
	Endpoint_Write_Byte(ReturnStatus);
	Endpoint_ClearIN();	
}

189
/** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
static void PDIProtocol_WriteMemory(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	struct
	{
		uint8_t  MemoryType;
		uint32_t Address;
		uint16_t Length;
		uint8_t  ProgData[256];
	} 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);
	
	// TODO: Send program command here via PDI protocol
	
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);	
	Endpoint_ClearIN();
}

219
220
221
/** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 *  attached device.
 */
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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);
239

240
241
242
	uint8_t ReadBuffer[ReadMemory_XPROG_Params.Length];
	NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length);

243
244
245
246
	Endpoint_Write_Byte(CMD_XPROG);
	Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
	Endpoint_Write_Byte(ReturnStatus);
	
247
248
249
	if (ReturnStatus == XPRG_ERR_OK)
	  Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
	
250
251
252
	Endpoint_ClearIN();
}

253
254
255
/** 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.
 */
256
257
258
259
static void PDIProtocol_ReadCRC(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;
	
260
261
262
263
264
265
	struct
	{
		uint8_t CRCType;
	} ReadCRC_XPROG_Params;
	
	Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
266
267
268
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
269
	uint32_t MemoryCRC;
270
	uint8_t  CRCCommand;
271
272

	if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
273
	  CRCCommand = NVM_CMD_APPCRC;
274
	else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
275
	  CRCCommand = NVM_CMD_BOOTCRC;
276
	else
277
278
279
	  CRCCommand = NVM_CMD_FLASHCRC;
	
	MemoryCRC = NVMTarget_GetMemoryCRC(CRCCommand);
280
281
282
283
284
285
286
287
288
289
290
291
292
293
	
	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();	
}

294
295
296
/** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 *  attached device.
 */
297
298
299
300
301
302
303
static void PDIProtocol_SetParam(void)
{
	uint8_t ReturnStatus = XPRG_ERR_OK;

	uint8_t XPROGParam = Endpoint_Read_Byte();
	
	if (XPROGParam == XPRG_PARAM_NVMBASE)
304
	  XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
305
	else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
306
	  XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
307
308
309
310
311
312
313
314
315
316
317
318
319
	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