3 Copyright (C) Dean Camera, 2011.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
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
33 * ISP Protocol handler, to process V2 Protocol wrapped ISP commands used in Atmel programmer devices.
36 #include "ISPProtocol.h"
38 #if defined(ENABLE_ISP_PROTOCOL) || defined(__DOXYGEN__)
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.
43 void ISPProtocol_EnterISPMode(void)
48 uint8_t PinStabDelayMS
;
49 uint8_t ExecutionDelayMS
;
54 uint8_t EnterProgBytes
[4];
57 Endpoint_Read_Stream_LE(&Enter_ISP_Params
, sizeof(Enter_ISP_Params
), NULL
);
60 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
61 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
63 uint8_t ResponseStatus
= STATUS_CMD_FAILED
;
67 /* Perform execution delay, initialize SPI bus */
68 ISPProtocol_DelayMS(Enter_ISP_Params
.ExecutionDelayMS
);
69 ISPTarget_EnableTargetISP();
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
)
75 uint8_t ResponseBytes
[4];
77 ISPTarget_ChangeTargetResetLine(true);
78 ISPProtocol_DelayMS(Enter_ISP_Params
.PinStabDelayMS
);
80 for (uint8_t RByte
= 0; RByte
< sizeof(ResponseBytes
); RByte
++)
82 ISPProtocol_DelayMS(Enter_ISP_Params
.ByteDelay
);
83 ResponseBytes
[RByte
] = ISPTarget_TransferByte(Enter_ISP_Params
.EnterProgBytes
[RByte
]);
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
))
89 ResponseStatus
= STATUS_CMD_OK
;
93 ISPTarget_ChangeTargetResetLine(false);
94 ISPProtocol_DelayMS(Enter_ISP_Params
.PinStabDelayMS
);
98 Endpoint_Write_Byte(CMD_ENTER_PROGMODE_ISP
);
99 Endpoint_Write_Byte(ResponseStatus
);
103 /** Handler for the CMD_LEAVE_ISP command, which releases the target from programming mode. */
104 void ISPProtocol_LeaveISPMode(void)
112 Endpoint_Read_Stream_LE(&Leave_ISP_Params
, sizeof(Leave_ISP_Params
), NULL
);
115 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
116 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
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
);
124 Endpoint_Write_Byte(CMD_LEAVE_PROGMODE_ISP
);
125 Endpoint_Write_Byte(STATUS_CMD_OK
);
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.
132 * \param[in] V2Command Issued V2 Protocol command byte from the host
134 void ISPProtocol_ProgramMemory(uint8_t V2Command
)
138 uint16_t BytesToWrite
;
139 uint8_t ProgrammingMode
;
141 uint8_t ProgrammingCommands
[3];
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
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
);
151 if (Write_Memory_Params
.BytesToWrite
> sizeof(Write_Memory_Params
.ProgData
))
154 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
155 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
157 Endpoint_Write_Byte(V2Command
);
158 Endpoint_Write_Byte(STATUS_CMD_FAILED
);
163 Endpoint_Read_Stream_LE(&Write_Memory_Params
.ProgData
, Write_Memory_Params
.BytesToWrite
, NULL
);
166 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
167 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
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);
176 for (uint16_t CurrentByte
= 0; CurrentByte
< Write_Memory_Params
.BytesToWrite
; CurrentByte
++)
178 uint8_t ByteToWrite
= *(NextWriteByte
++);
179 uint8_t ProgrammingMode
= Write_Memory_Params
.ProgrammingMode
;
181 /* Check to see if we need to send a LOAD EXTENDED ADDRESS command to the target */
182 if (MustLoadExtendedAddress
)
184 ISPTarget_LoadExtendedAddress();
185 MustLoadExtendedAddress
= false;
188 ISPTarget_SendByte(Write_Memory_Params
.ProgrammingCommands
[0]);
189 ISPTarget_SendByte(CurrentAddress
>> 8);
190 ISPTarget_SendByte(CurrentAddress
& 0xFF);
191 ISPTarget_SendByte(ByteToWrite
);
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
;
198 /* Check to see if we have a valid polling address */
199 if (!(PollAddress
) && (ByteToWrite
!= PollValue
))
201 if ((CurrentByte
& 0x01) && (V2Command
== CMD_PROGRAM_FLASH_ISP
))
202 Write_Memory_Params
.ProgrammingCommands
[2] |= READ_WRITE_HIGH_BYTE_MASK
;
204 Write_Memory_Params
.ProgrammingCommands
[2] &= ~READ_WRITE_HIGH_BYTE_MASK
;
206 PollAddress
= (CurrentAddress
& 0xFFFF);
209 /* If in word programming mode, commit the byte to the target's memory */
210 if (!(ProgrammingMode
& PROG_MODE_PAGED_WRITES_MASK
))
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
;
216 ProgrammingStatus
= ISPTarget_WaitForProgComplete(ProgrammingMode
, PollAddress
, PollValue
,
217 Write_Memory_Params
.DelayMS
,
218 Write_Memory_Params
.ProgrammingCommands
[2]);
220 /* Abort the programming loop early if the byte/word programming failed */
221 if (ProgrammingStatus
!= STATUS_CMD_OK
)
224 /* Must reset the polling address afterwards, so it is not erronously used for the next byte */
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
))
235 if ((V2Command
!= CMD_PROGRAM_EEPROM_ISP
) && !(CurrentAddress
& 0xFFFF))
236 MustLoadExtendedAddress
= true;
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
)
243 ISPTarget_SendByte(Write_Memory_Params
.ProgrammingCommands
[1]);
244 ISPTarget_SendByte(PageStartAddress
>> 8);
245 ISPTarget_SendByte(PageStartAddress
& 0xFF);
246 ISPTarget_SendByte(0x00);
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
))
251 Write_Memory_Params
.ProgrammingMode
= (Write_Memory_Params
.ProgrammingMode
& ~PROG_MODE_PAGED_VALUE_MASK
) |
252 PROG_MODE_PAGED_TIMEDELAY_MASK
;
255 ProgrammingStatus
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
,
256 Write_Memory_Params
.DelayMS
,
257 Write_Memory_Params
.ProgrammingCommands
[2]);
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;
264 Endpoint_Write_Byte(V2Command
);
265 Endpoint_Write_Byte(ProgrammingStatus
);
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.
272 * \param[in] V2Command Issued V2 Protocol command byte from the host
274 void ISPProtocol_ReadMemory(uint8_t V2Command
)
278 uint16_t BytesToRead
;
279 uint8_t ReadMemoryCommand
;
280 } Read_Memory_Params
;
282 Endpoint_Read_Stream_LE(&Read_Memory_Params
, sizeof(Read_Memory_Params
), NULL
);
283 Read_Memory_Params
.BytesToRead
= SwapEndian_16(Read_Memory_Params
.BytesToRead
);
286 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
287 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
289 Endpoint_Write_Byte(V2Command
);
290 Endpoint_Write_Byte(STATUS_CMD_OK
);
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
++)
295 /* Check to see if we need to send a LOAD EXTENDED ADDRESS command to the target */
296 if (MustLoadExtendedAddress
)
298 ISPTarget_LoadExtendedAddress();
299 MustLoadExtendedAddress
= false;
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());
308 /* Check if the endpoint bank is currently full, if so send the packet */
309 if (!(Endpoint_IsReadWriteAllowed()))
312 Endpoint_WaitUntilReady();
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
;
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
))
327 if ((V2Command
!= CMD_READ_EEPROM_ISP
) && !(CurrentAddress
& 0xFFFF))
328 MustLoadExtendedAddress
= true;
332 Endpoint_Write_Byte(STATUS_CMD_OK
);
334 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
337 /* Ensure last packet is a short packet to terminate the transfer */
340 Endpoint_WaitUntilReady();
342 Endpoint_WaitUntilReady();
346 /** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */
347 void ISPProtocol_ChipErase(void)
351 uint8_t EraseDelayMS
;
353 uint8_t EraseCommandBytes
[4];
356 Endpoint_Read_Stream_LE(&Erase_Chip_Params
, sizeof(Erase_Chip_Params
), NULL
);
359 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
360 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
362 uint8_t ResponseStatus
= STATUS_CMD_OK
;
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
]);
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
);
372 ResponseStatus
= ISPTarget_WaitWhileTargetBusy();
374 Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP
);
375 Endpoint_Write_Byte(ResponseStatus
);
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.
382 * \param[in] V2Command Issued V2 Protocol command byte from the host
384 void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command
)
389 uint8_t ReadCommandBytes
[4];
390 } Read_FuseLockSigOSCCAL_Params
;
392 Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params
, sizeof(Read_FuseLockSigOSCCAL_Params
), NULL
);
395 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
396 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
398 uint8_t ResponseBytes
[4];
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
]);
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
);
411 /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration
412 * byte to the device.
414 * \param[in] V2Command Issued V2 Protocol command byte from the host
416 void ISPProtocol_WriteFuseLock(uint8_t V2Command
)
420 uint8_t WriteCommandBytes
[4];
421 } Write_FuseLockSig_Params
;
423 Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params
, sizeof(Write_FuseLockSig_Params
), NULL
);
426 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
427 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
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
]);
433 Endpoint_Write_Byte(V2Command
);
434 Endpoint_Write_Byte(STATUS_CMD_OK
);
435 Endpoint_Write_Byte(STATUS_CMD_OK
);
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)
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
);
454 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
455 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
457 Endpoint_Write_Byte(CMD_SPI_MULTI
);
458 Endpoint_Write_Byte(STATUS_CMD_OK
);
460 uint8_t CurrTxPos
= 0;
461 uint8_t CurrRxPos
= 0;
463 /* Write out bytes to transmit until the start of the bytes to receive is met */
464 while (CurrTxPos
< SPI_Multi_Params
.RxStartAddr
)
466 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
467 ISPTarget_SendByte(SPI_Multi_Params
.TxData
[CurrTxPos
]);
469 ISPTarget_SendByte(0);
474 /* Transmit remaining bytes with padding as needed, read in response bytes */
475 while (CurrRxPos
< SPI_Multi_Params
.RxBytes
)
477 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
478 Endpoint_Write_Byte(ISPTarget_TransferByte(SPI_Multi_Params
.TxData
[CurrTxPos
++]));
480 Endpoint_Write_Byte(ISPTarget_ReceiveByte());
482 /* Check to see if we have filled the endpoint bank and need to send the packet */
483 if (!(Endpoint_IsReadWriteAllowed()))
486 Endpoint_WaitUntilReady();
492 Endpoint_Write_Byte(STATUS_CMD_OK
);
494 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
497 /* Ensure last packet is a short packet to terminate the transfer */
500 Endpoint_WaitUntilReady();
502 Endpoint_WaitUntilReady();
506 /** Blocking delay for a given number of milliseconds.
508 * \param[in] DelayMS Number of milliseconds to delay for
510 void ISPProtocol_DelayMS(uint8_t DelayMS
)
512 while (DelayMS
-- && TimeoutTicksRemaining
)