3 Copyright (C) Dean Camera, 2010.
5 dean [at] fourwalledcubicle [dot] com
6 www.fourwalledcubicle.com
10 Copyright 2010 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
), NO_STREAM_CALLBACK
);
60 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
61 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
63 uint8_t ResponseStatus
= STATUS_CMD_FAILED
;
67 /* Set up the synchronous USART to generate the recovery clock on XCK pin */
68 UBRR1
= (F_CPU
/ 500000UL);
69 UCSR1B
= (1 << TXEN1
);
70 UCSR1C
= (1 << UMSEL10
) | (1 << UPM11
) | (1 << USBS1
) | (1 << UCSZ11
) | (1 << UCSZ10
) | (1 << UCPOL1
);
73 /* Perform execution delay, initialize SPI bus */
74 ISPProtocol_DelayMS(Enter_ISP_Params
.ExecutionDelayMS
);
75 SPI_Init(ISPTarget_GetSPIPrescalerMask() | SPI_SCK_LEAD_RISING
| SPI_SAMPLE_LEADING
| SPI_MODE_MASTER
);
77 /* Continuously attempt to synchronize with the target until either the number of attempts specified
78 * by the host has exceeded, or the the device sends back the expected response values */
79 while (Enter_ISP_Params
.SynchLoops
-- && (ResponseStatus
== STATUS_CMD_FAILED
) && TimeoutMSRemaining
)
81 uint8_t ResponseBytes
[4];
83 ISPTarget_ChangeTargetResetLine(true);
84 ISPProtocol_DelayMS(Enter_ISP_Params
.PinStabDelayMS
);
86 for (uint8_t RByte
= 0; RByte
< sizeof(ResponseBytes
); RByte
++)
88 ISPProtocol_DelayMS(Enter_ISP_Params
.ByteDelay
);
89 ResponseBytes
[RByte
] = SPI_TransferByte(Enter_ISP_Params
.EnterProgBytes
[RByte
]);
92 /* Check if polling disabled, or if the polled value matches the expected value */
93 if (!(Enter_ISP_Params
.PollIndex
) || (ResponseBytes
[Enter_ISP_Params
.PollIndex
- 1] == Enter_ISP_Params
.PollValue
))
95 ResponseStatus
= STATUS_CMD_OK
;
99 ISPTarget_ChangeTargetResetLine(false);
100 ISPProtocol_DelayMS(Enter_ISP_Params
.PinStabDelayMS
);
104 Endpoint_Write_Byte(CMD_ENTER_PROGMODE_ISP
);
105 Endpoint_Write_Byte(ResponseStatus
);
109 /** Handler for the CMD_LEAVE_ISP command, which releases the target from programming mode. */
110 void ISPProtocol_LeaveISPMode(void)
118 Endpoint_Read_Stream_LE(&Leave_ISP_Params
, sizeof(Leave_ISP_Params
), NO_STREAM_CALLBACK
);
121 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
122 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
124 /* Perform pre-exit delay, release the target /RESET, disable the SPI bus and perform the post-exit delay */
125 ISPProtocol_DelayMS(Leave_ISP_Params
.PreDelayMS
);
126 ISPTarget_ChangeTargetResetLine(false);
128 ISPProtocol_DelayMS(Leave_ISP_Params
.PostDelayMS
);
130 /* Turn off the synchronous USART to terminate the recovery clock on XCK pin */
131 UBRR1
= (F_CPU
/ 500000UL);
132 UCSR1B
= (1 << TXEN1
);
133 UCSR1C
= (1 << UMSEL10
) | (1 << UPM11
) | (1 << USBS1
) | (1 << UCSZ11
) | (1 << UCSZ10
) | (1 << UCPOL1
);
136 Endpoint_Write_Byte(CMD_LEAVE_PROGMODE_ISP
);
137 Endpoint_Write_Byte(STATUS_CMD_OK
);
141 /** Handler for the CMD_PROGRAM_FLASH_ISP and CMD_PROGRAM_EEPROM_ISP commands, writing out bytes,
142 * words or pages of data to the attached device.
144 * \param[in] V2Command Issued V2 Protocol command byte from the host
146 void ISPProtocol_ProgramMemory(uint8_t V2Command
)
150 uint16_t BytesToWrite
;
151 uint8_t ProgrammingMode
;
153 uint8_t ProgrammingCommands
[3];
156 uint8_t ProgData
[256]; // Note, the Jungo driver has a very short ACK timeout period, need to buffer the
157 } Write_Memory_Params
; // whole page and ACK the packet as fast as possible to prevent it from aborting
159 Endpoint_Read_Stream_LE(&Write_Memory_Params
, (sizeof(Write_Memory_Params
) -
160 sizeof(Write_Memory_Params
.ProgData
)), NO_STREAM_CALLBACK
);
163 Write_Memory_Params
.BytesToWrite
= SwapEndian_16(Write_Memory_Params
.BytesToWrite
);
165 if (Write_Memory_Params
.BytesToWrite
> sizeof(Write_Memory_Params
.ProgData
))
168 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
169 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
171 Endpoint_Write_Byte(V2Command
);
172 Endpoint_Write_Byte(STATUS_CMD_FAILED
);
177 Endpoint_Read_Stream_LE(&Write_Memory_Params
.ProgData
, Write_Memory_Params
.BytesToWrite
, NO_STREAM_CALLBACK
);
180 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
181 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
183 uint8_t ProgrammingStatus
= STATUS_CMD_OK
;
184 uint16_t PollAddress
= 0;
185 uint8_t PollValue
= (V2Command
== CMD_PROGRAM_FLASH_ISP
) ? Write_Memory_Params
.PollValue1
:
186 Write_Memory_Params
.PollValue2
;
187 uint8_t* NextWriteByte
= Write_Memory_Params
.ProgData
;
189 /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a
190 * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB
194 if (CurrentAddress
& (1UL << 31))
195 ISPTarget_LoadExtendedAddress();
197 MustSetAddress
= false;
200 /* Check the programming mode desired by the host, either Paged or Word memory writes */
201 if (Write_Memory_Params
.ProgrammingMode
& PROG_MODE_PAGED_WRITES_MASK
)
203 uint16_t StartAddress
= (CurrentAddress
& 0xFFFF);
205 /* Paged mode memory programming */
206 for (uint16_t CurrentByte
= 0; CurrentByte
< Write_Memory_Params
.BytesToWrite
; CurrentByte
++)
208 bool IsOddByte
= (CurrentByte
& 0x01);
209 uint8_t ByteToWrite
= *(NextWriteByte
++);
211 SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[0]);
212 SPI_SendByte(CurrentAddress
>> 8);
213 SPI_SendByte(CurrentAddress
& 0xFF);
214 SPI_SendByte(ByteToWrite
);
216 /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high
217 * or low byte at the current word address */
218 if (V2Command
== CMD_PROGRAM_FLASH_ISP
)
219 Write_Memory_Params
.ProgrammingCommands
[0] ^= READ_WRITE_HIGH_BYTE_MASK
;
221 /* Check to see the write completion method, to see if we have a valid polling address */
222 if (!(PollAddress
) && (ByteToWrite
!= PollValue
))
224 if (IsOddByte
&& (V2Command
== CMD_PROGRAM_FLASH_ISP
))
225 Write_Memory_Params
.ProgrammingCommands
[2] |= READ_WRITE_HIGH_BYTE_MASK
;
227 PollAddress
= (CurrentAddress
& 0xFFFF);
230 /* EEPROM increments the address on each byte, flash needs to increment on each word */
231 if (IsOddByte
|| (V2Command
== CMD_PROGRAM_EEPROM_ISP
))
235 /* If the current page must be committed, send the PROGRAM PAGE command to the target */
236 if (Write_Memory_Params
.ProgrammingMode
& PROG_MODE_COMMIT_PAGE_MASK
)
238 SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[1]);
239 SPI_SendByte(StartAddress
>> 8);
240 SPI_SendByte(StartAddress
& 0xFF);
243 /* Check if polling is possible, if not switch to timed delay mode */
246 Write_Memory_Params
.ProgrammingMode
&= ~PROG_MODE_PAGED_VALUE_MASK
;
247 Write_Memory_Params
.ProgrammingMode
|= PROG_MODE_PAGED_TIMEDELAY_MASK
;
250 ProgrammingStatus
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
,
251 Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]);
253 /* Check to see if the FLASH address has crossed the extended address boundary */
254 if ((V2Command
== CMD_PROGRAM_FLASH_ISP
) && !(CurrentAddress
& 0xFFFF))
255 ISPTarget_LoadExtendedAddress();
260 /* Word/byte mode memory programming */
261 for (uint16_t CurrentByte
= 0; CurrentByte
< Write_Memory_Params
.BytesToWrite
; CurrentByte
++)
263 bool IsOddByte
= (CurrentByte
& 0x01);
264 uint8_t ByteToWrite
= *(NextWriteByte
++);
266 SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[0]);
267 SPI_SendByte(CurrentAddress
>> 8);
268 SPI_SendByte(CurrentAddress
& 0xFF);
269 SPI_SendByte(ByteToWrite
);
271 /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high
272 * or low byte at the current word address */
273 if (V2Command
== CMD_PROGRAM_FLASH_ISP
)
274 Write_Memory_Params
.ProgrammingCommands
[0] ^= READ_WRITE_HIGH_BYTE_MASK
;
276 if (ByteToWrite
!= PollValue
)
278 if (IsOddByte
&& (V2Command
== CMD_PROGRAM_FLASH_ISP
))
279 Write_Memory_Params
.ProgrammingCommands
[2] |= READ_WRITE_HIGH_BYTE_MASK
;
281 PollAddress
= (CurrentAddress
& 0xFFFF);
284 ProgrammingStatus
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
,
285 Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]);
287 /* Abort the programming loop early if the byte/word programming failed */
288 if (ProgrammingStatus
!= STATUS_CMD_OK
)
291 /* EEPROM just increments the address each byte, flash needs to increment on each word and
292 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
293 * address boundary has been crossed */
294 if (V2Command
== CMD_PROGRAM_EEPROM_ISP
)
300 if (!(++CurrentAddress
& 0xFFFF))
301 ISPTarget_LoadExtendedAddress();
306 Endpoint_Write_Byte(V2Command
);
307 Endpoint_Write_Byte(ProgrammingStatus
);
311 /** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes,
312 * words or pages of data from the attached device.
314 * \param[in] V2Command Issued V2 Protocol command byte from the host
316 void ISPProtocol_ReadMemory(uint8_t V2Command
)
320 uint16_t BytesToRead
;
321 uint8_t ReadMemoryCommand
;
322 } Read_Memory_Params
;
324 Endpoint_Read_Stream_LE(&Read_Memory_Params
, sizeof(Read_Memory_Params
), NO_STREAM_CALLBACK
);
325 Read_Memory_Params
.BytesToRead
= SwapEndian_16(Read_Memory_Params
.BytesToRead
);
328 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
329 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
331 Endpoint_Write_Byte(V2Command
);
332 Endpoint_Write_Byte(STATUS_CMD_OK
);
334 /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a
335 * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB
339 if (CurrentAddress
& (1UL << 31))
340 ISPTarget_LoadExtendedAddress();
342 MustSetAddress
= false;
345 /* Read each byte from the device and write them to the packet for the host */
346 for (uint16_t CurrentByte
= 0; CurrentByte
< Read_Memory_Params
.BytesToRead
; CurrentByte
++)
348 /* Read the next byte from the desired memory space in the device */
349 SPI_SendByte(Read_Memory_Params
.ReadMemoryCommand
);
350 SPI_SendByte(CurrentAddress
>> 8);
351 SPI_SendByte(CurrentAddress
& 0xFF);
352 Endpoint_Write_Byte(SPI_ReceiveByte());
354 /* Check if the endpoint bank is currently full, if so send the packet */
355 if (!(Endpoint_IsReadWriteAllowed()))
358 Endpoint_WaitUntilReady();
361 /* AVR FLASH addressing requires us to modify the read command based on if we are reading a high
362 * or low byte at the current word address */
363 if (V2Command
== CMD_READ_FLASH_ISP
)
364 Read_Memory_Params
.ReadMemoryCommand
^= READ_WRITE_HIGH_BYTE_MASK
;
366 /* EEPROM just increments the address each byte, flash needs to increment on each word and
367 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
368 * address boundary has been crossed */
369 if (V2Command
== CMD_READ_EEPROM_ISP
)
373 else if (CurrentByte
& 0x01)
375 if (!(++CurrentAddress
& 0xFFFF))
376 ISPTarget_LoadExtendedAddress();
380 Endpoint_Write_Byte(STATUS_CMD_OK
);
382 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
385 /* Ensure last packet is a short packet to terminate the transfer */
388 Endpoint_WaitUntilReady();
390 Endpoint_WaitUntilReady();
394 /** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */
395 void ISPProtocol_ChipErase(void)
399 uint8_t EraseDelayMS
;
401 uint8_t EraseCommandBytes
[4];
404 Endpoint_Read_Stream_LE(&Erase_Chip_Params
, sizeof(Erase_Chip_Params
), NO_STREAM_CALLBACK
);
407 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
408 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
410 uint8_t ResponseStatus
= STATUS_CMD_OK
;
412 /* Send the chip erase commands as given by the host to the device */
413 for (uint8_t SByte
= 0; SByte
< sizeof(Erase_Chip_Params
.EraseCommandBytes
); SByte
++)
414 SPI_SendByte(Erase_Chip_Params
.EraseCommandBytes
[SByte
]);
416 /* Use appropriate command completion check as given by the host (delay or busy polling) */
417 if (!(Erase_Chip_Params
.PollMethod
))
418 ISPProtocol_DelayMS(Erase_Chip_Params
.EraseDelayMS
);
420 ResponseStatus
= ISPTarget_WaitWhileTargetBusy();
422 Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP
);
423 Endpoint_Write_Byte(ResponseStatus
);
427 /** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands,
428 * reading the requested configuration byte from the device.
430 * \param[in] V2Command Issued V2 Protocol command byte from the host
432 void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command
)
437 uint8_t ReadCommandBytes
[4];
438 } Read_FuseLockSigOSCCAL_Params
;
440 Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params
, sizeof(Read_FuseLockSigOSCCAL_Params
), NO_STREAM_CALLBACK
);
443 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
444 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
446 uint8_t ResponseBytes
[4];
448 /* Send the Fuse or Lock byte read commands as given by the host to the device, store response */
449 for (uint8_t RByte
= 0; RByte
< sizeof(ResponseBytes
); RByte
++)
450 ResponseBytes
[RByte
] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params
.ReadCommandBytes
[RByte
]);
452 Endpoint_Write_Byte(V2Command
);
453 Endpoint_Write_Byte(STATUS_CMD_OK
);
454 Endpoint_Write_Byte(ResponseBytes
[Read_FuseLockSigOSCCAL_Params
.RetByte
- 1]);
455 Endpoint_Write_Byte(STATUS_CMD_OK
);
459 /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration
460 * byte to the device.
462 * \param[in] V2Command Issued V2 Protocol command byte from the host
464 void ISPProtocol_WriteFuseLock(uint8_t V2Command
)
468 uint8_t WriteCommandBytes
[4];
469 } Write_FuseLockSig_Params
;
471 Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params
, sizeof(Write_FuseLockSig_Params
), NO_STREAM_CALLBACK
);
474 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
475 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
477 /* Send the Fuse or Lock byte program commands as given by the host to the device */
478 for (uint8_t SByte
= 0; SByte
< sizeof(Write_FuseLockSig_Params
.WriteCommandBytes
); SByte
++)
479 SPI_SendByte(Write_FuseLockSig_Params
.WriteCommandBytes
[SByte
]);
481 Endpoint_Write_Byte(V2Command
);
482 Endpoint_Write_Byte(STATUS_CMD_OK
);
483 Endpoint_Write_Byte(STATUS_CMD_OK
);
487 /** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */
488 void ISPProtocol_SPIMulti(void)
498 Endpoint_Read_Stream_LE(&SPI_Multi_Params
, (sizeof(SPI_Multi_Params
) - sizeof(SPI_Multi_Params
.TxData
)), NO_STREAM_CALLBACK
);
499 Endpoint_Read_Stream_LE(&SPI_Multi_Params
.TxData
, SPI_Multi_Params
.TxBytes
, NO_STREAM_CALLBACK
);
502 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
503 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
505 Endpoint_Write_Byte(CMD_SPI_MULTI
);
506 Endpoint_Write_Byte(STATUS_CMD_OK
);
508 uint8_t CurrTxPos
= 0;
509 uint8_t CurrRxPos
= 0;
511 /* Write out bytes to transmit until the start of the bytes to receive is met */
512 while (CurrTxPos
< SPI_Multi_Params
.RxStartAddr
)
514 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
515 SPI_SendByte(SPI_Multi_Params
.TxData
[CurrTxPos
]);
522 /* Transmit remaining bytes with padding as needed, read in response bytes */
523 while (CurrRxPos
< SPI_Multi_Params
.RxBytes
)
525 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
526 Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params
.TxData
[CurrTxPos
++]));
528 Endpoint_Write_Byte(SPI_ReceiveByte());
530 /* Check to see if we have filled the endpoint bank and need to send the packet */
531 if (!(Endpoint_IsReadWriteAllowed()))
534 Endpoint_WaitUntilReady();
540 Endpoint_Write_Byte(STATUS_CMD_OK
);
542 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
545 /* Ensure last packet is a short packet to terminate the transfer */
548 Endpoint_WaitUntilReady();
550 Endpoint_WaitUntilReady();
554 /** Blocking delay for a given number of milliseconds.
556 * \param[in] DelayMS Number of milliseconds to delay for
558 void ISPProtocol_DelayMS(uint8_t DelayMS
)
560 while (DelayMS
-- && TimeoutMSRemaining
)
562 if (TimeoutMSRemaining
)
563 TimeoutMSRemaining
--;