Altered all endpoint/pipe stream transfers so that the new BytesProcessed parameter...
[pub/lufa.git] / Projects / AVRISP-MKII / Lib / ISP / ISPProtocol.c
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2011.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2011 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 * ISP Protocol handler, to process V2 Protocol wrapped ISP commands used in Atmel programmer devices.
34 */
35
36 #include "ISPProtocol.h"
37
38 #if defined(ENABLE_ISP_PROTOCOL) || defined(__DOXYGEN__)
39
40 /** Handler for the CMD_ENTER_PROGMODE_ISP command, which attempts to enter programming mode on
41 * the attached device, returning success or failure back to the host.
42 */
43 void ISPProtocol_EnterISPMode(void)
44 {
45 struct
46 {
47 uint8_t TimeoutMS;
48 uint8_t PinStabDelayMS;
49 uint8_t ExecutionDelayMS;
50 uint8_t SynchLoops;
51 uint8_t ByteDelay;
52 uint8_t PollValue;
53 uint8_t PollIndex;
54 uint8_t EnterProgBytes[4];
55 } Enter_ISP_Params;
56
57 Endpoint_Read_Stream_LE(&Enter_ISP_Params, sizeof(Enter_ISP_Params), NULL);
58
59 Endpoint_ClearOUT();
60 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
61 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
62
63 uint8_t ResponseStatus = STATUS_CMD_FAILED;
64
65 CurrentAddress = 0;
66
67 /* Perform execution delay, initialize SPI bus */
68 ISPProtocol_DelayMS(Enter_ISP_Params.ExecutionDelayMS);
69 ISPTarget_EnableTargetISP();
70
71 /* Continuously attempt to synchronize with the target until either the number of attempts specified
72 * by the host has exceeded, or the the device sends back the expected response values */
73 while (Enter_ISP_Params.SynchLoops-- && (ResponseStatus != STATUS_CMD_OK) && TimeoutTicksRemaining)
74 {
75 uint8_t ResponseBytes[4];
76
77 ISPTarget_ChangeTargetResetLine(true);
78 ISPProtocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);
79
80 for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)
81 {
82 ISPProtocol_DelayMS(Enter_ISP_Params.ByteDelay);
83 ResponseBytes[RByte] = ISPTarget_TransferByte(Enter_ISP_Params.EnterProgBytes[RByte]);
84 }
85
86 /* Check if polling disabled, or if the polled value matches the expected value */
87 if (!(Enter_ISP_Params.PollIndex) || (ResponseBytes[Enter_ISP_Params.PollIndex - 1] == Enter_ISP_Params.PollValue))
88 {
89 ResponseStatus = STATUS_CMD_OK;
90 }
91 else
92 {
93 ISPTarget_ChangeTargetResetLine(false);
94 ISPProtocol_DelayMS(Enter_ISP_Params.PinStabDelayMS);
95 }
96 }
97
98 Endpoint_Write_Byte(CMD_ENTER_PROGMODE_ISP);
99 Endpoint_Write_Byte(ResponseStatus);
100 Endpoint_ClearIN();
101 }
102
103 /** Handler for the CMD_LEAVE_ISP command, which releases the target from programming mode. */
104 void ISPProtocol_LeaveISPMode(void)
105 {
106 struct
107 {
108 uint8_t PreDelayMS;
109 uint8_t PostDelayMS;
110 } Leave_ISP_Params;
111
112 Endpoint_Read_Stream_LE(&Leave_ISP_Params, sizeof(Leave_ISP_Params), NULL);
113
114 Endpoint_ClearOUT();
115 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
116 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
117
118 /* Perform pre-exit delay, release the target /RESET, disable the SPI bus and perform the post-exit delay */
119 ISPProtocol_DelayMS(Leave_ISP_Params.PreDelayMS);
120 ISPTarget_ChangeTargetResetLine(false);
121 ISPTarget_DisableTargetISP();
122 ISPProtocol_DelayMS(Leave_ISP_Params.PostDelayMS);
123
124 Endpoint_Write_Byte(CMD_LEAVE_PROGMODE_ISP);
125 Endpoint_Write_Byte(STATUS_CMD_OK);
126 Endpoint_ClearIN();
127 }
128
129 /** Handler for the CMD_PROGRAM_FLASH_ISP and CMD_PROGRAM_EEPROM_ISP commands, writing out bytes,
130 * words or pages of data to the attached device.
131 *
132 * \param[in] V2Command Issued V2 Protocol command byte from the host
133 */
134 void ISPProtocol_ProgramMemory(uint8_t V2Command)
135 {
136 struct
137 {
138 uint16_t BytesToWrite;
139 uint8_t ProgrammingMode;
140 uint8_t DelayMS;
141 uint8_t ProgrammingCommands[3];
142 uint8_t PollValue1;
143 uint8_t PollValue2;
144 uint8_t ProgData[256]; // Note, the Jungo driver has a very short ACK timeout period, need to buffer the
145 } Write_Memory_Params; // whole page and ACK the packet as fast as possible to prevent it from aborting
146
147 Endpoint_Read_Stream_LE(&Write_Memory_Params, (sizeof(Write_Memory_Params) -
148 sizeof(Write_Memory_Params.ProgData)), NULL);
149 Write_Memory_Params.BytesToWrite = SwapEndian_16(Write_Memory_Params.BytesToWrite);
150
151 if (Write_Memory_Params.BytesToWrite > sizeof(Write_Memory_Params.ProgData))
152 {
153 Endpoint_ClearOUT();
154 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
155 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
156
157 Endpoint_Write_Byte(V2Command);
158 Endpoint_Write_Byte(STATUS_CMD_FAILED);
159 Endpoint_ClearIN();
160 return;
161 }
162
163 Endpoint_Read_Stream_LE(&Write_Memory_Params.ProgData, Write_Memory_Params.BytesToWrite, NULL);
164
165 Endpoint_ClearOUT();
166 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
167 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
168
169 uint8_t ProgrammingStatus = STATUS_CMD_OK;
170 uint8_t PollValue = (V2Command == CMD_PROGRAM_FLASH_ISP) ? Write_Memory_Params.PollValue1 :
171 Write_Memory_Params.PollValue2;
172 uint16_t PollAddress = 0;
173 uint8_t* NextWriteByte = Write_Memory_Params.ProgData;
174 uint16_t PageStartAddress = (CurrentAddress & 0xFFFF);
175
176 for (uint16_t CurrentByte = 0; CurrentByte < Write_Memory_Params.BytesToWrite; CurrentByte++)
177 {
178 uint8_t ByteToWrite = *(NextWriteByte++);
179 uint8_t ProgrammingMode = Write_Memory_Params.ProgrammingMode;
180
181 /* Check to see if we need to send a LOAD EXTENDED ADDRESS command to the target */
182 if (MustLoadExtendedAddress)
183 {
184 ISPTarget_LoadExtendedAddress();
185 MustLoadExtendedAddress = false;
186 }
187
188 ISPTarget_SendByte(Write_Memory_Params.ProgrammingCommands[0]);
189 ISPTarget_SendByte(CurrentAddress >> 8);
190 ISPTarget_SendByte(CurrentAddress & 0xFF);
191 ISPTarget_SendByte(ByteToWrite);
192
193 /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high
194 * or low byte at the current word address */
195 if (V2Command == CMD_PROGRAM_FLASH_ISP)
196 Write_Memory_Params.ProgrammingCommands[0] ^= READ_WRITE_HIGH_BYTE_MASK;
197
198 /* Check to see if we have a valid polling address */
199 if (!(PollAddress) && (ByteToWrite != PollValue))
200 {
201 if ((CurrentByte & 0x01) && (V2Command == CMD_PROGRAM_FLASH_ISP))
202 Write_Memory_Params.ProgrammingCommands[2] |= READ_WRITE_HIGH_BYTE_MASK;
203 else
204 Write_Memory_Params.ProgrammingCommands[2] &= ~READ_WRITE_HIGH_BYTE_MASK;
205
206 PollAddress = (CurrentAddress & 0xFFFF);
207 }
208
209 /* If in word programming mode, commit the byte to the target's memory */
210 if (!(ProgrammingMode & PROG_MODE_PAGED_WRITES_MASK))
211 {
212 /* If the current polling address is invalid, switch to timed delay write completion mode */
213 if (!(PollAddress) && !(ProgrammingMode & PROG_MODE_WORD_READYBUSY_MASK))
214 ProgrammingMode = (ProgrammingMode & ~PROG_MODE_WORD_VALUE_MASK) | PROG_MODE_WORD_TIMEDELAY_MASK;
215
216 ProgrammingStatus = ISPTarget_WaitForProgComplete(ProgrammingMode, PollAddress, PollValue,
217 Write_Memory_Params.DelayMS,
218 Write_Memory_Params.ProgrammingCommands[2]);
219
220 /* Abort the programming loop early if the byte/word programming failed */
221 if (ProgrammingStatus != STATUS_CMD_OK)
222 break;
223
224 /* Must reset the polling address afterwards, so it is not erronously used for the next byte */
225 PollAddress = 0;
226 }
227
228 /* EEPROM just increments the address each byte, flash needs to increment on each word and
229 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
230 * address boundary has been crossed */
231 if ((CurrentByte & 0x01) || (V2Command == CMD_PROGRAM_EEPROM_ISP))
232 {
233 CurrentAddress++;
234
235 if ((V2Command != CMD_PROGRAM_EEPROM_ISP) && !(CurrentAddress & 0xFFFF))
236 MustLoadExtendedAddress = true;
237 }
238 }
239
240 /* If the current page must be committed, send the PROGRAM PAGE command to the target */
241 if (Write_Memory_Params.ProgrammingMode & PROG_MODE_COMMIT_PAGE_MASK)
242 {
243 ISPTarget_SendByte(Write_Memory_Params.ProgrammingCommands[1]);
244 ISPTarget_SendByte(PageStartAddress >> 8);
245 ISPTarget_SendByte(PageStartAddress & 0xFF);
246 ISPTarget_SendByte(0x00);
247
248 /* Check if polling is enabled and possible, if not switch to timed delay mode */
249 if ((Write_Memory_Params.ProgrammingMode & PROG_MODE_PAGED_VALUE_MASK) && !(PollAddress))
250 {
251 Write_Memory_Params.ProgrammingMode = (Write_Memory_Params.ProgrammingMode & ~PROG_MODE_PAGED_VALUE_MASK) |
252 PROG_MODE_PAGED_TIMEDELAY_MASK;
253 }
254
255 ProgrammingStatus = ISPTarget_WaitForProgComplete(Write_Memory_Params.ProgrammingMode, PollAddress, PollValue,
256 Write_Memory_Params.DelayMS,
257 Write_Memory_Params.ProgrammingCommands[2]);
258
259 /* Check to see if the FLASH address has crossed the extended address boundary */
260 if ((V2Command == CMD_PROGRAM_FLASH_ISP) && !(CurrentAddress & 0xFFFF))
261 MustLoadExtendedAddress = true;
262 }
263
264 Endpoint_Write_Byte(V2Command);
265 Endpoint_Write_Byte(ProgrammingStatus);
266 Endpoint_ClearIN();
267 }
268
269 /** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes,
270 * words or pages of data from the attached device.
271 *
272 * \param[in] V2Command Issued V2 Protocol command byte from the host
273 */
274 void ISPProtocol_ReadMemory(uint8_t V2Command)
275 {
276 struct
277 {
278 uint16_t BytesToRead;
279 uint8_t ReadMemoryCommand;
280 } Read_Memory_Params;
281
282 Endpoint_Read_Stream_LE(&Read_Memory_Params, sizeof(Read_Memory_Params), NULL);
283 Read_Memory_Params.BytesToRead = SwapEndian_16(Read_Memory_Params.BytesToRead);
284
285 Endpoint_ClearOUT();
286 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
287 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
288
289 Endpoint_Write_Byte(V2Command);
290 Endpoint_Write_Byte(STATUS_CMD_OK);
291
292 /* Read each byte from the device and write them to the packet for the host */
293 for (uint16_t CurrentByte = 0; CurrentByte < Read_Memory_Params.BytesToRead; CurrentByte++)
294 {
295 /* Check to see if we need to send a LOAD EXTENDED ADDRESS command to the target */
296 if (MustLoadExtendedAddress)
297 {
298 ISPTarget_LoadExtendedAddress();
299 MustLoadExtendedAddress = false;
300 }
301
302 /* Read the next byte from the desired memory space in the device */
303 ISPTarget_SendByte(Read_Memory_Params.ReadMemoryCommand);
304 ISPTarget_SendByte(CurrentAddress >> 8);
305 ISPTarget_SendByte(CurrentAddress & 0xFF);
306 Endpoint_Write_Byte(ISPTarget_ReceiveByte());
307
308 /* Check if the endpoint bank is currently full, if so send the packet */
309 if (!(Endpoint_IsReadWriteAllowed()))
310 {
311 Endpoint_ClearIN();
312 Endpoint_WaitUntilReady();
313 }
314
315 /* AVR FLASH addressing requires us to modify the read command based on if we are reading a high
316 * or low byte at the current word address */
317 if (V2Command == CMD_READ_FLASH_ISP)
318 Read_Memory_Params.ReadMemoryCommand ^= READ_WRITE_HIGH_BYTE_MASK;
319
320 /* EEPROM just increments the address each byte, flash needs to increment on each word and
321 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
322 * address boundary has been crossed */
323 if ((CurrentByte & 0x01) || (V2Command == CMD_READ_EEPROM_ISP))
324 {
325 CurrentAddress++;
326
327 if ((V2Command != CMD_READ_EEPROM_ISP) && !(CurrentAddress & 0xFFFF))
328 MustLoadExtendedAddress = true;
329 }
330 }
331
332 Endpoint_Write_Byte(STATUS_CMD_OK);
333
334 bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());
335 Endpoint_ClearIN();
336
337 /* Ensure last packet is a short packet to terminate the transfer */
338 if (IsEndpointFull)
339 {
340 Endpoint_WaitUntilReady();
341 Endpoint_ClearIN();
342 Endpoint_WaitUntilReady();
343 }
344 }
345
346 /** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */
347 void ISPProtocol_ChipErase(void)
348 {
349 struct
350 {
351 uint8_t EraseDelayMS;
352 uint8_t PollMethod;
353 uint8_t EraseCommandBytes[4];
354 } Erase_Chip_Params;
355
356 Endpoint_Read_Stream_LE(&Erase_Chip_Params, sizeof(Erase_Chip_Params), NULL);
357
358 Endpoint_ClearOUT();
359 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
360 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
361
362 uint8_t ResponseStatus = STATUS_CMD_OK;
363
364 /* Send the chip erase commands as given by the host to the device */
365 for (uint8_t SByte = 0; SByte < sizeof(Erase_Chip_Params.EraseCommandBytes); SByte++)
366 ISPTarget_SendByte(Erase_Chip_Params.EraseCommandBytes[SByte]);
367
368 /* Use appropriate command completion check as given by the host (delay or busy polling) */
369 if (!(Erase_Chip_Params.PollMethod))
370 ISPProtocol_DelayMS(Erase_Chip_Params.EraseDelayMS);
371 else
372 ResponseStatus = ISPTarget_WaitWhileTargetBusy();
373
374 Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP);
375 Endpoint_Write_Byte(ResponseStatus);
376 Endpoint_ClearIN();
377 }
378
379 /** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands,
380 * reading the requested configuration byte from the device.
381 *
382 * \param[in] V2Command Issued V2 Protocol command byte from the host
383 */
384 void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command)
385 {
386 struct
387 {
388 uint8_t RetByte;
389 uint8_t ReadCommandBytes[4];
390 } Read_FuseLockSigOSCCAL_Params;
391
392 Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params, sizeof(Read_FuseLockSigOSCCAL_Params), NULL);
393
394 Endpoint_ClearOUT();
395 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
396 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
397
398 uint8_t ResponseBytes[4];
399
400 /* Send the Fuse or Lock byte read commands as given by the host to the device, store response */
401 for (uint8_t RByte = 0; RByte < sizeof(ResponseBytes); RByte++)
402 ResponseBytes[RByte] = ISPTarget_TransferByte(Read_FuseLockSigOSCCAL_Params.ReadCommandBytes[RByte]);
403
404 Endpoint_Write_Byte(V2Command);
405 Endpoint_Write_Byte(STATUS_CMD_OK);
406 Endpoint_Write_Byte(ResponseBytes[Read_FuseLockSigOSCCAL_Params.RetByte - 1]);
407 Endpoint_Write_Byte(STATUS_CMD_OK);
408 Endpoint_ClearIN();
409 }
410
411 /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration
412 * byte to the device.
413 *
414 * \param[in] V2Command Issued V2 Protocol command byte from the host
415 */
416 void ISPProtocol_WriteFuseLock(uint8_t V2Command)
417 {
418 struct
419 {
420 uint8_t WriteCommandBytes[4];
421 } Write_FuseLockSig_Params;
422
423 Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params, sizeof(Write_FuseLockSig_Params), NULL);
424
425 Endpoint_ClearOUT();
426 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
427 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
428
429 /* Send the Fuse or Lock byte program commands as given by the host to the device */
430 for (uint8_t SByte = 0; SByte < sizeof(Write_FuseLockSig_Params.WriteCommandBytes); SByte++)
431 ISPTarget_SendByte(Write_FuseLockSig_Params.WriteCommandBytes[SByte]);
432
433 Endpoint_Write_Byte(V2Command);
434 Endpoint_Write_Byte(STATUS_CMD_OK);
435 Endpoint_Write_Byte(STATUS_CMD_OK);
436 Endpoint_ClearIN();
437 }
438
439 /** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */
440 void ISPProtocol_SPIMulti(void)
441 {
442 struct
443 {
444 uint8_t TxBytes;
445 uint8_t RxBytes;
446 uint8_t RxStartAddr;
447 uint8_t TxData[255];
448 } SPI_Multi_Params;
449
450 Endpoint_Read_Stream_LE(&SPI_Multi_Params, (sizeof(SPI_Multi_Params) - sizeof(SPI_Multi_Params.TxData)), NULL);
451 Endpoint_Read_Stream_LE(&SPI_Multi_Params.TxData, SPI_Multi_Params.TxBytes, NULL);
452
453 Endpoint_ClearOUT();
454 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
455 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
456
457 Endpoint_Write_Byte(CMD_SPI_MULTI);
458 Endpoint_Write_Byte(STATUS_CMD_OK);
459
460 uint8_t CurrTxPos = 0;
461 uint8_t CurrRxPos = 0;
462
463 /* Write out bytes to transmit until the start of the bytes to receive is met */
464 while (CurrTxPos < SPI_Multi_Params.RxStartAddr)
465 {
466 if (CurrTxPos < SPI_Multi_Params.TxBytes)
467 ISPTarget_SendByte(SPI_Multi_Params.TxData[CurrTxPos]);
468 else
469 ISPTarget_SendByte(0);
470
471 CurrTxPos++;
472 }
473
474 /* Transmit remaining bytes with padding as needed, read in response bytes */
475 while (CurrRxPos < SPI_Multi_Params.RxBytes)
476 {
477 if (CurrTxPos < SPI_Multi_Params.TxBytes)
478 Endpoint_Write_Byte(ISPTarget_TransferByte(SPI_Multi_Params.TxData[CurrTxPos++]));
479 else
480 Endpoint_Write_Byte(ISPTarget_ReceiveByte());
481
482 /* Check to see if we have filled the endpoint bank and need to send the packet */
483 if (!(Endpoint_IsReadWriteAllowed()))
484 {
485 Endpoint_ClearIN();
486 Endpoint_WaitUntilReady();
487 }
488
489 CurrRxPos++;
490 }
491
492 Endpoint_Write_Byte(STATUS_CMD_OK);
493
494 bool IsEndpointFull = !(Endpoint_IsReadWriteAllowed());
495 Endpoint_ClearIN();
496
497 /* Ensure last packet is a short packet to terminate the transfer */
498 if (IsEndpointFull)
499 {
500 Endpoint_WaitUntilReady();
501 Endpoint_ClearIN();
502 Endpoint_WaitUntilReady();
503 }
504 }
505
506 /** Blocking delay for a given number of milliseconds.
507 *
508 * \param[in] DelayMS Number of milliseconds to delay for
509 */
510 void ISPProtocol_DelayMS(uint8_t DelayMS)
511 {
512 while (DelayMS-- && TimeoutTicksRemaining)
513 _delay_ms(1);
514 }
515
516 #endif