Added new XCK_RESCUE_CLOCK_ENABLE compile time option to the AVRISP-MKII clone progra...
[pub/lufa.git] / Projects / AVRISP-MKII / Lib / XPROG / XPROGProtocol.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2010.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 *
33 * XPROG Protocol handler, to process V2 Protocol wrapped XPROG commands used in Atmel programmer devices.
34 */
35
36 #define INCLUDE_FROM_XPROGPROTOCOL_C
37 #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 uint16_t XPROG_Param_EEPageSize = 32;
45
46 /** Address of the TPI device's NVMCMD register for TPI programming */
47 uint8_t XPROG_Param_NVMCMDRegAddr = 0x33;
48
49 /** Address of the TPI device's NVMCSR register for TPI programming */
50 uint8_t XPROG_Param_NVMCSRRegAddr = 0x32;
51
52 /** Currently selected XPROG programming protocol */
53 uint8_t XPROG_SelectedProtocol = XPRG_PROTOCOL_PDI;
54
55 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI/TPI
56 * programming.
57 */
58 void XPROGProtocol_SetMode(void)
59 {
60 struct
61 {
62 uint8_t Protocol;
63 } SetMode_XPROG_Params;
64
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 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
70
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 Endpoint_ClearIN();
76 }
77
78 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
79 * removed and processed so that the underlying XPROG command can be handled.
80 */
81 void XPROGProtocol_Command(void)
82 {
83 uint8_t XPROGCommand = Endpoint_Read_Byte();
84
85 switch (XPROGCommand)
86 {
87 case XPRG_CMD_ENTER_PROGMODE:
88 XPROGProtocol_EnterXPROGMode();
89 break;
90 case XPRG_CMD_LEAVE_PROGMODE:
91 XPROGProtocol_LeaveXPROGMode();
92 break;
93 case XPRG_CMD_ERASE:
94 XPROGProtocol_Erase();
95 break;
96 case XPRG_CMD_WRITE_MEM:
97 XPROGProtocol_WriteMemory();
98 break;
99 case XPRG_CMD_READ_MEM:
100 XPROGProtocol_ReadMemory();
101 break;
102 case XPRG_CMD_CRC:
103 XPROGProtocol_ReadCRC();
104 break;
105 case XPRG_CMD_SET_PARAM:
106 XPROGProtocol_SetParam();
107 break;
108 }
109 }
110
111 /** Handler for the XPROG ENTER_PROGMODE command to establish a connection with the attached device. */
112 static void XPROGProtocol_EnterXPROGMode(void)
113 {
114 Endpoint_ClearOUT();
115 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
116 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
117
118 bool NVMBusEnabled = false;
119
120 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
121 {
122 /* 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 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
127 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 else if (XPROG_SelectedProtocol == XPRG_PROTOCOL_TPI)
142 {
143 /* Enable TPI programming mode with the attached target */
144 XPROGTarget_EnableTargetTPI();
145
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 /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
151 XPROGTarget_SendByte(TPI_CMD_SKEY);
152 for (uint8_t i = sizeof(TPI_NVMENABLE_KEY); i > 0; i--)
153 XPROGTarget_SendByte(TPI_NVMENABLE_KEY[i - 1]);
154
155 /* Wait until the NVM bus becomes active */
156 NVMBusEnabled = TINYNVM_WaitWhileNVMBusBusy();
157 }
158
159 Endpoint_Write_Byte(CMD_XPROG);
160 Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
161 Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
162 Endpoint_ClearIN();
163 }
164
165 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
166 * the attached device.
167 */
168 static void XPROGProtocol_LeaveXPROGMode(void)
169 {
170 Endpoint_ClearOUT();
171 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
172 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
173
174 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
175 {
176 XMEGANVM_WaitWhileNVMBusBusy();
177
178 /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
179 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
180 XPROGTarget_SendByte(0x00);
181
182 /* Do it twice to make sure it takes affect (silicon bug?) */
183 XPROGTarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
184 XPROGTarget_SendByte(0x00);
185
186 XPROGTarget_DisableTargetPDI();
187 }
188 else
189 {
190 TINYNVM_WaitWhileNVMBusBusy();
191
192 /* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
193 XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
194 XPROGTarget_SendByte(0x00);
195
196 XPROGTarget_DisableTargetTPI();
197 }
198
199 #if defined(XCK_RESCUE_CLOCK_ENABLE) && defined(ENABLE_ISP_PROTOCOL)
200 ISPTarget_ConfigureRescueClock();
201 #endif
202
203 Endpoint_Write_Byte(CMD_XPROG);
204 Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
205 Endpoint_Write_Byte(XPRG_ERR_OK);
206 Endpoint_ClearIN();
207 }
208
209 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
210 static void XPROGProtocol_Erase(void)
211 {
212 uint8_t ReturnStatus = XPRG_ERR_OK;
213
214 struct
215 {
216 uint8_t MemoryType;
217 uint32_t Address;
218 } Erase_XPROG_Params;
219
220 Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NO_STREAM_CALLBACK);
221 Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
222
223 Endpoint_ClearOUT();
224 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
225 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
226
227 uint8_t EraseCommand;
228
229 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
230 {
231 /* Determine which NVM command to send to the device depending on the memory to erase */
232 switch (Erase_XPROG_Params.MemoryType)
233 {
234 case XPRG_ERASE_CHIP:
235 EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
236 break;
237 case XPRG_ERASE_APP:
238 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
239 break;
240 case XPRG_ERASE_BOOT:
241 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
242 break;
243 case XPRG_ERASE_EEPROM:
244 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
245 break;
246 case XPRG_ERASE_APP_PAGE:
247 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
248 break;
249 case XPRG_ERASE_BOOT_PAGE:
250 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
251 break;
252 case XPRG_ERASE_EEPROM_PAGE:
253 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
254 break;
255 case XPRG_ERASE_USERSIG:
256 EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
257 break;
258 default:
259 EraseCommand = XMEGA_NVM_CMD_NOOP;
260 break;
261 }
262
263 /* Erase the target memory, indicate timeout if occurred */
264 if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
265 ReturnStatus = XPRG_ERR_TIMEOUT;
266 }
267 else
268 {
269 if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
270 EraseCommand = TINY_NVM_CMD_CHIPERASE;
271 else
272 EraseCommand = TINY_NVM_CMD_SECTIONERASE;
273
274 /* Erase the target memory, indicate timeout if occurred */
275 if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
276 ReturnStatus = XPRG_ERR_TIMEOUT;
277 }
278
279 Endpoint_Write_Byte(CMD_XPROG);
280 Endpoint_Write_Byte(XPRG_CMD_ERASE);
281 Endpoint_Write_Byte(ReturnStatus);
282 Endpoint_ClearIN();
283 }
284
285 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
286 static void XPROGProtocol_WriteMemory(void)
287 {
288 uint8_t ReturnStatus = XPRG_ERR_OK;
289
290 struct
291 {
292 uint8_t MemoryType;
293 uint8_t PageMode;
294 uint32_t Address;
295 uint16_t Length;
296 uint8_t ProgData[256];
297 } WriteMemory_XPROG_Params;
298
299 Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
300 sizeof(WriteMemory_XPROG_Params).ProgData), NO_STREAM_CALLBACK);
301 WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
302 WriteMemory_XPROG_Params.Length = SwapEndian_16(WriteMemory_XPROG_Params.Length);
303 Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
304
305 Endpoint_ClearOUT();
306 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
307 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
308
309 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
310 {
311 /* Assume FLASH page programming by default, as it is the common case */
312 uint8_t WriteCommand = XMEGA_NVM_CMD_WRITEFLASHPAGE;
313 uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
314 uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
315 bool PagedMemory = true;
316
317 switch (WriteMemory_XPROG_Params.MemoryType)
318 {
319 case XPRG_MEM_TYPE_APPL:
320 WriteCommand = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
321 break;
322 case XPRG_MEM_TYPE_BOOT:
323 WriteCommand = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
324 break;
325 case XPRG_MEM_TYPE_EEPROM:
326 WriteCommand = XMEGA_NVM_CMD_ERASEWRITEEEPROMPAGE;
327 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
328 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
329 break;
330 case XPRG_MEM_TYPE_USERSIG:
331 WriteCommand = XMEGA_NVM_CMD_WRITEUSERSIG;
332 break;
333 case XPRG_MEM_TYPE_FUSE:
334 WriteCommand = XMEGA_NVM_CMD_WRITEFUSE;
335 PagedMemory = false;
336 break;
337 case XPRG_MEM_TYPE_LOCKBITS:
338 WriteCommand = XMEGA_NVM_CMD_WRITELOCK;
339 PagedMemory = false;
340 break;
341 }
342
343 /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
344 if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
345 WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
346 WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
347 (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
348 WriteMemory_XPROG_Params.ProgData[0]))))
349 {
350 ReturnStatus = XPRG_ERR_TIMEOUT;
351 }
352 }
353 else
354 {
355 /* Send write command to the TPI device, indicate timeout if occurred */
356 if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
357 WriteMemory_XPROG_Params.Length)))
358 {
359 ReturnStatus = XPRG_ERR_TIMEOUT;
360 }
361 }
362
363 Endpoint_Write_Byte(CMD_XPROG);
364 Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
365 Endpoint_Write_Byte(ReturnStatus);
366 Endpoint_ClearIN();
367 }
368
369 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
370 * attached device.
371 */
372 static void XPROGProtocol_ReadMemory(void)
373 {
374 uint8_t ReturnStatus = XPRG_ERR_OK;
375
376 struct
377 {
378 uint8_t MemoryType;
379 uint32_t Address;
380 uint16_t Length;
381 } ReadMemory_XPROG_Params;
382
383 Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
384 ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
385 ReadMemory_XPROG_Params.Length = SwapEndian_16(ReadMemory_XPROG_Params.Length);
386
387 Endpoint_ClearOUT();
388 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
389 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
390
391 uint8_t ReadBuffer[256];
392
393 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
394 {
395 /* Read the PDI target's memory, indicate timeout if occurred */
396 if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
397 ReturnStatus = XPRG_ERR_TIMEOUT;
398 }
399 else
400 {
401 /* Read the TPI target's memory, indicate timeout if occurred */
402 if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
403 ReturnStatus = XPRG_ERR_TIMEOUT;
404 }
405
406 Endpoint_Write_Byte(CMD_XPROG);
407 Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
408 Endpoint_Write_Byte(ReturnStatus);
409
410 if (ReturnStatus == XPRG_ERR_OK)
411 Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
412
413 Endpoint_ClearIN();
414 }
415
416 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
417 * attached device's memory and a data set on the host.
418 */
419 static void XPROGProtocol_ReadCRC(void)
420 {
421 uint8_t ReturnStatus = XPRG_ERR_OK;
422
423 struct
424 {
425 uint8_t CRCType;
426 } ReadCRC_XPROG_Params;
427
428 Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
429
430 Endpoint_ClearOUT();
431 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
432 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
433
434 uint32_t MemoryCRC;
435
436 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
437 {
438 uint8_t CRCCommand;
439
440 /* Determine which NVM command to send to the device depending on the memory to CRC */
441 switch (ReadCRC_XPROG_Params.CRCType)
442 {
443 case XPRG_CRC_APP:
444 CRCCommand = XMEGA_NVM_CMD_APPCRC;
445 break;
446 case XPRG_CRC_BOOT:
447 CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
448 break;
449 default:
450 CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
451 break;
452 }
453
454 /* Perform and retrieve the memory CRC, indicate timeout if occurred */
455 if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
456 ReturnStatus = XPRG_ERR_TIMEOUT;
457 }
458 else
459 {
460 /* TPI does not support memory CRC */
461 ReturnStatus = XPRG_ERR_FAILED;
462 }
463
464 Endpoint_Write_Byte(CMD_XPROG);
465 Endpoint_Write_Byte(XPRG_CMD_CRC);
466 Endpoint_Write_Byte(ReturnStatus);
467
468 if (ReturnStatus == XPRG_ERR_OK)
469 {
470 Endpoint_Write_Byte(MemoryCRC >> 16);
471 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
472 }
473
474 Endpoint_ClearIN();
475 }
476
477 /** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
478 * attached device.
479 */
480 static void XPROGProtocol_SetParam(void)
481 {
482 uint8_t ReturnStatus = XPRG_ERR_OK;
483
484 uint8_t XPROGParam = Endpoint_Read_Byte();
485
486 /* Determine which parameter is being set, store the new parameter value */
487 switch (XPROGParam)
488 {
489 case XPRG_PARAM_NVMBASE:
490 XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
491 break;
492 case XPRG_PARAM_EEPPAGESIZE:
493 XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
494 break;
495 case XPRG_PARAM_NVMCMD_REG:
496 XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
497 break;
498 case XPRG_PARAM_NVMCSR_REG:
499 XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
500 break;
501 default:
502 ReturnStatus = XPRG_ERR_FAILED;
503 break;
504 }
505
506 Endpoint_ClearOUT();
507 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
508 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
509
510 Endpoint_Write_Byte(CMD_XPROG);
511 Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
512 Endpoint_Write_Byte(ReturnStatus);
513 Endpoint_ClearIN();
514 }
515
516 #endif
517