Added WIN_LIBUSB_COMPAT compile time option to the AVRISP programmer project to make...
[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.fourwalledcubicle.com
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;
45
46 /** Address of the TPI device's NVMCMD register for TPI programming */
47 uint8_t XPROG_Param_NVMCMDRegAddr;
48
49 /** Address of the TPI device's NVMCSR register for TPI programming */
50 uint8_t XPROG_Param_NVMCSRRegAddr;
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;
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
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 XPROGTarget_DisableTargetPDI();
183 }
184 else
185 {
186 TINYNVM_WaitWhileNVMBusBusy();
187
188 /* Clear the NVMEN bit in the TPI CONTROL register to disable TPI mode */
189 XPROGTarget_SendByte(TPI_CMD_SSTCS | TPI_CTRL_REG);
190 XPROGTarget_SendByte(0x00);
191
192 XPROGTarget_DisableTargetTPI();
193 }
194
195 Endpoint_Write_Byte(CMD_XPROG);
196 Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
197 Endpoint_Write_Byte(XPRG_ERR_OK);
198 Endpoint_ClearIN();
199 }
200
201 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
202 static void XPROGProtocol_Erase(void)
203 {
204 uint8_t ReturnStatus = XPRG_ERR_OK;
205
206 struct
207 {
208 uint8_t MemoryType;
209 uint32_t Address;
210 } Erase_XPROG_Params;
211
212 Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params), NO_STREAM_CALLBACK);
213 Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
214
215 Endpoint_ClearOUT();
216 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
217 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
218
219 uint8_t EraseCommand;
220
221 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
222 {
223 /* Determine which NVM command to send to the device depending on the memory to erase */
224 switch (Erase_XPROG_Params.MemoryType)
225 {
226 case XPRG_ERASE_CHIP:
227 EraseCommand = XMEGA_NVM_CMD_CHIPERASE;
228 break;
229 case XPRG_ERASE_APP:
230 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSEC;
231 break;
232 case XPRG_ERASE_BOOT:
233 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSEC;
234 break;
235 case XPRG_ERASE_EEPROM:
236 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROM;
237 break;
238 case XPRG_ERASE_APP_PAGE:
239 EraseCommand = XMEGA_NVM_CMD_ERASEAPPSECPAGE;
240 break;
241 case XPRG_ERASE_BOOT_PAGE:
242 EraseCommand = XMEGA_NVM_CMD_ERASEBOOTSECPAGE;
243 break;
244 case XPRG_ERASE_EEPROM_PAGE:
245 EraseCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGE;
246 break;
247 case XPRG_ERASE_USERSIG:
248 EraseCommand = XMEGA_NVM_CMD_ERASEUSERSIG;
249 break;
250 default:
251 EraseCommand = XMEGA_NVM_CMD_NOOP;
252 break;
253 }
254
255 /* Erase the target memory, indicate timeout if ocurred */
256 if (!(XMEGANVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
257 ReturnStatus = XPRG_ERR_TIMEOUT;
258 }
259 else
260 {
261 if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
262 EraseCommand = TINY_NVM_CMD_CHIPERASE;
263 else
264 EraseCommand = TINY_NVM_CMD_SECTIONERASE;
265
266 /* Erase the target memory, indicate timeout if ocurred */
267 if (!(TINYNVM_EraseMemory(EraseCommand, Erase_XPROG_Params.Address)))
268 ReturnStatus = XPRG_ERR_TIMEOUT;
269 }
270
271 Endpoint_Write_Byte(CMD_XPROG);
272 Endpoint_Write_Byte(XPRG_CMD_ERASE);
273 Endpoint_Write_Byte(ReturnStatus);
274 Endpoint_ClearIN();
275 }
276
277 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
278 static void XPROGProtocol_WriteMemory(void)
279 {
280 uint8_t ReturnStatus = XPRG_ERR_OK;
281
282 struct
283 {
284 uint8_t MemoryType;
285 uint8_t PageMode;
286 uint32_t Address;
287 uint16_t Length;
288 uint8_t ProgData[256];
289 } WriteMemory_XPROG_Params;
290
291 Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
292 sizeof(WriteMemory_XPROG_Params).ProgData), NO_STREAM_CALLBACK);
293 WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
294 WriteMemory_XPROG_Params.Length = SwapEndian_16(WriteMemory_XPROG_Params.Length);
295 Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
296
297 Endpoint_ClearOUT();
298 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
299 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
300
301 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
302 {
303 /* Assume FLASH page programming by default, as it is the common case */
304 uint8_t WriteCommand = XMEGA_NVM_CMD_WRITEFLASHPAGE;
305 uint8_t WriteBuffCommand = XMEGA_NVM_CMD_LOADFLASHPAGEBUFF;
306 uint8_t EraseBuffCommand = XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF;
307 bool PagedMemory = true;
308
309 switch (WriteMemory_XPROG_Params.MemoryType)
310 {
311 case XPRG_MEM_TYPE_APPL:
312 WriteCommand = XMEGA_NVM_CMD_WRITEAPPSECPAGE;
313 break;
314 case XPRG_MEM_TYPE_BOOT:
315 WriteCommand = XMEGA_NVM_CMD_WRITEBOOTSECPAGE;
316 break;
317 case XPRG_MEM_TYPE_EEPROM:
318 WriteCommand = XMEGA_NVM_CMD_WRITEEEPROMPAGE;
319 WriteBuffCommand = XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF;
320 EraseBuffCommand = XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF;
321 break;
322 case XPRG_MEM_TYPE_USERSIG:
323 /* User signature is paged, but needs us to manually indicate the mode bits since the host doesn't set them */
324 WriteMemory_XPROG_Params.PageMode = (XPRG_PAGEMODE_ERASE | XPRG_PAGEMODE_WRITE);
325 WriteCommand = XMEGA_NVM_CMD_WRITEUSERSIG;
326 break;
327 case XPRG_MEM_TYPE_FUSE:
328 WriteCommand = XMEGA_NVM_CMD_WRITEFUSE;
329 PagedMemory = false;
330 break;
331 case XPRG_MEM_TYPE_LOCKBITS:
332 WriteCommand = XMEGA_NVM_CMD_WRITELOCK;
333 PagedMemory = false;
334 break;
335 }
336
337 /* Send the appropriate memory write commands to the device, indicate timeout if occurred */
338 if ((PagedMemory && !(XMEGANVM_WritePageMemory(WriteBuffCommand, EraseBuffCommand, WriteCommand,
339 WriteMemory_XPROG_Params.PageMode, WriteMemory_XPROG_Params.Address,
340 WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length))) ||
341 (!PagedMemory && !(XMEGANVM_WriteByteMemory(WriteCommand, WriteMemory_XPROG_Params.Address,
342 WriteMemory_XPROG_Params.ProgData[0]))))
343 {
344 ReturnStatus = XPRG_ERR_TIMEOUT;
345 }
346 }
347 else
348 {
349 /* Send write command to the TPI device, indicate timeout if occurred */
350 if (!(TINYNVM_WriteMemory(WriteMemory_XPROG_Params.Address, WriteMemory_XPROG_Params.ProgData,
351 WriteMemory_XPROG_Params.Length)))
352 {
353 ReturnStatus = XPRG_ERR_TIMEOUT;
354 }
355 }
356
357 Endpoint_Write_Byte(CMD_XPROG);
358 Endpoint_Write_Byte(XPRG_CMD_WRITE_MEM);
359 Endpoint_Write_Byte(ReturnStatus);
360 Endpoint_ClearIN();
361 }
362
363 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
364 * attached device.
365 */
366 static void XPROGProtocol_ReadMemory(void)
367 {
368 uint8_t ReturnStatus = XPRG_ERR_OK;
369
370 struct
371 {
372 uint8_t MemoryType;
373 uint32_t Address;
374 uint16_t Length;
375 } ReadMemory_XPROG_Params;
376
377 Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params), NO_STREAM_CALLBACK);
378 ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
379 ReadMemory_XPROG_Params.Length = SwapEndian_16(ReadMemory_XPROG_Params.Length);
380
381 Endpoint_ClearOUT();
382 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
383 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
384
385 uint8_t ReadBuffer[256];
386
387 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
388 {
389 /* Read the PDI target's memory, indicate timeout if occurred */
390 if (!(XMEGANVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
391 ReturnStatus = XPRG_ERR_TIMEOUT;
392 }
393 else
394 {
395 /* Read the TPI target's memory, indicate timeout if occurred */
396 if (!(TINYNVM_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length)))
397 ReturnStatus = XPRG_ERR_TIMEOUT;
398 }
399
400 Endpoint_Write_Byte(CMD_XPROG);
401 Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
402 Endpoint_Write_Byte(ReturnStatus);
403
404 if (ReturnStatus == XPRG_ERR_OK)
405 Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length, NO_STREAM_CALLBACK);
406
407 Endpoint_ClearIN();
408 }
409
410 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
411 * attached device's memory and a data set on the host.
412 */
413 static void XPROGProtocol_ReadCRC(void)
414 {
415 uint8_t ReturnStatus = XPRG_ERR_OK;
416
417 struct
418 {
419 uint8_t CRCType;
420 } ReadCRC_XPROG_Params;
421
422 Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params), NO_STREAM_CALLBACK);
423
424 Endpoint_ClearOUT();
425 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
426 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
427
428 uint32_t MemoryCRC;
429
430 if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
431 {
432 uint8_t CRCCommand;
433
434 /* Determine which NVM command to send to the device depending on the memory to CRC */
435 switch (ReadCRC_XPROG_Params.CRCType)
436 {
437 case XPRG_CRC_APP:
438 CRCCommand = XMEGA_NVM_CMD_APPCRC;
439 break;
440 case XPRG_CRC_BOOT:
441 CRCCommand = XMEGA_NVM_CMD_BOOTCRC;
442 break;
443 default:
444 CRCCommand = XMEGA_NVM_CMD_FLASHCRC;
445 break;
446 }
447
448 /* Perform and retrieve the memory CRC, indicate timeout if occurred */
449 if (!(XMEGANVM_GetMemoryCRC(CRCCommand, &MemoryCRC)))
450 ReturnStatus = XPRG_ERR_TIMEOUT;
451 }
452 else
453 {
454 /* TPI does not support memory CRC */
455 ReturnStatus = XPRG_ERR_FAILED;
456 }
457
458 Endpoint_Write_Byte(CMD_XPROG);
459 Endpoint_Write_Byte(XPRG_CMD_CRC);
460 Endpoint_Write_Byte(ReturnStatus);
461
462 if (ReturnStatus == XPRG_ERR_OK)
463 {
464 Endpoint_Write_Byte(MemoryCRC >> 16);
465 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
466 }
467
468 Endpoint_ClearIN();
469 }
470
471 /** Handler for the XPROG SET_PARAM command to set a XPROG parameter for use when communicating with the
472 * attached device.
473 */
474 static void XPROGProtocol_SetParam(void)
475 {
476 uint8_t ReturnStatus = XPRG_ERR_OK;
477
478 uint8_t XPROGParam = Endpoint_Read_Byte();
479
480 /* Determine which parameter is being set, store the new parameter value */
481 switch (XPROGParam)
482 {
483 case XPRG_PARAM_NVMBASE:
484 XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
485 break;
486 case XPRG_PARAM_EEPPAGESIZE:
487 XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
488 break;
489 case XPRG_PARAM_NVMCMD_REG:
490 XPROG_Param_NVMCMDRegAddr = Endpoint_Read_Byte();
491 break;
492 case XPRG_PARAM_NVMCSR_REG:
493 XPROG_Param_NVMCSRRegAddr = Endpoint_Read_Byte();
494 break;
495 default:
496 ReturnStatus = XPRG_ERR_FAILED;
497 break;
498 }
499
500 Endpoint_ClearOUT();
501 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
502 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
503
504 Endpoint_Write_Byte(CMD_XPROG);
505 Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
506 Endpoint_Write_Byte(ReturnStatus);
507 Endpoint_ClearIN();
508 }
509
510 #endif