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 just increments the address each byte, flash needs to increment on each word and
231 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
232 * address boundary has been crossed */
233 if (V2Command
== CMD_PROGRAM_EEPROM_ISP
)
239 if (!(++CurrentAddress
& 0xFFFF))
240 ISPTarget_LoadExtendedAddress();
244 /* If the current page must be committed, send the PROGRAM PAGE command to the target */
245 if (Write_Memory_Params
.ProgrammingMode
& PROG_MODE_COMMIT_PAGE_MASK
)
247 SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[1]);
248 SPI_SendByte(StartAddress
>> 8);
249 SPI_SendByte(StartAddress
& 0xFF);
252 /* Check if polling is possible, if not switch to timed delay mode */
255 Write_Memory_Params
.ProgrammingMode
&= ~PROG_MODE_PAGED_VALUE_MASK
;
256 Write_Memory_Params
.ProgrammingMode
|= PROG_MODE_PAGED_TIMEDELAY_MASK
;
259 ProgrammingStatus
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
,
260 Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]);
265 /* Word/byte mode memory programming */
266 for (uint16_t CurrentByte
= 0; CurrentByte
< Write_Memory_Params
.BytesToWrite
; CurrentByte
++)
268 bool IsOddByte
= (CurrentByte
& 0x01);
269 uint8_t ByteToWrite
= *(NextWriteByte
++);
271 SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[0]);
272 SPI_SendByte(CurrentAddress
>> 8);
273 SPI_SendByte(CurrentAddress
& 0xFF);
274 SPI_SendByte(ByteToWrite
);
276 /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high
277 * or low byte at the current word address */
278 if (V2Command
== CMD_PROGRAM_FLASH_ISP
)
279 Write_Memory_Params
.ProgrammingCommands
[0] ^= READ_WRITE_HIGH_BYTE_MASK
;
281 if (ByteToWrite
!= PollValue
)
283 if (IsOddByte
&& (V2Command
== CMD_PROGRAM_FLASH_ISP
))
284 Write_Memory_Params
.ProgrammingCommands
[2] |= READ_WRITE_HIGH_BYTE_MASK
;
286 PollAddress
= (CurrentAddress
& 0xFFFF);
289 /* EEPROM just increments the address each byte, flash needs to increment on each word and
290 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
291 * address boundary has been crossed */
292 if (V2Command
== CMD_PROGRAM_EEPROM_ISP
)
298 if (!(++CurrentAddress
& 0xFFFF))
299 ISPTarget_LoadExtendedAddress();
302 ProgrammingStatus
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
,
303 Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]);
305 if (ProgrammingStatus
!= STATUS_CMD_OK
)
310 Endpoint_Write_Byte(V2Command
);
311 Endpoint_Write_Byte(ProgrammingStatus
);
315 /** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes,
316 * words or pages of data from the attached device.
318 * \param[in] V2Command Issued V2 Protocol command byte from the host
320 void ISPProtocol_ReadMemory(uint8_t V2Command
)
324 uint16_t BytesToRead
;
325 uint8_t ReadMemoryCommand
;
326 } Read_Memory_Params
;
328 Endpoint_Read_Stream_LE(&Read_Memory_Params
, sizeof(Read_Memory_Params
), NO_STREAM_CALLBACK
);
329 Read_Memory_Params
.BytesToRead
= SwapEndian_16(Read_Memory_Params
.BytesToRead
);
332 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
333 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
335 Endpoint_Write_Byte(V2Command
);
336 Endpoint_Write_Byte(STATUS_CMD_OK
);
338 /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a
339 * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB
343 if (CurrentAddress
& (1UL << 31))
344 ISPTarget_LoadExtendedAddress();
346 MustSetAddress
= false;
349 /* Read each byte from the device and write them to the packet for the host */
350 for (uint16_t CurrentByte
= 0; CurrentByte
< Read_Memory_Params
.BytesToRead
; CurrentByte
++)
352 /* Read the next byte from the desired memory space in the device */
353 SPI_SendByte(Read_Memory_Params
.ReadMemoryCommand
);
354 SPI_SendByte(CurrentAddress
>> 8);
355 SPI_SendByte(CurrentAddress
& 0xFF);
356 Endpoint_Write_Byte(SPI_ReceiveByte());
358 /* Check if the endpoint bank is currently full, if so send the packet */
359 if (!(Endpoint_IsReadWriteAllowed()))
362 Endpoint_WaitUntilReady();
365 /* AVR FLASH addressing requires us to modify the read command based on if we are reading a high
366 * or low byte at the current word address */
367 if (V2Command
== CMD_READ_FLASH_ISP
)
368 Read_Memory_Params
.ReadMemoryCommand
^= READ_WRITE_HIGH_BYTE_MASK
;
370 /* EEPROM just increments the address each byte, flash needs to increment on each word and
371 * also check to ensure that a LOAD EXTENDED ADDRESS command is issued each time the extended
372 * address boundary has been crossed */
373 if (V2Command
== CMD_READ_EEPROM_ISP
)
377 else if (CurrentByte
& 0x01)
379 if (!(++CurrentAddress
& 0xFFFF))
380 ISPTarget_LoadExtendedAddress();
384 Endpoint_Write_Byte(STATUS_CMD_OK
);
386 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
389 /* Ensure last packet is a short packet to terminate the transfer */
392 Endpoint_WaitUntilReady();
394 Endpoint_WaitUntilReady();
398 /** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */
399 void ISPProtocol_ChipErase(void)
403 uint8_t EraseDelayMS
;
405 uint8_t EraseCommandBytes
[4];
408 Endpoint_Read_Stream_LE(&Erase_Chip_Params
, sizeof(Erase_Chip_Params
), NO_STREAM_CALLBACK
);
411 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
412 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
414 uint8_t ResponseStatus
= STATUS_CMD_OK
;
416 /* Send the chip erase commands as given by the host to the device */
417 for (uint8_t SByte
= 0; SByte
< sizeof(Erase_Chip_Params
.EraseCommandBytes
); SByte
++)
418 SPI_SendByte(Erase_Chip_Params
.EraseCommandBytes
[SByte
]);
420 /* Use appropriate command completion check as given by the host (delay or busy polling) */
421 if (!(Erase_Chip_Params
.PollMethod
))
422 ISPProtocol_DelayMS(Erase_Chip_Params
.EraseDelayMS
);
424 ResponseStatus
= ISPTarget_WaitWhileTargetBusy();
426 Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP
);
427 Endpoint_Write_Byte(ResponseStatus
);
431 /** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands,
432 * reading the requested configuration byte from the device.
434 * \param[in] V2Command Issued V2 Protocol command byte from the host
436 void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command
)
441 uint8_t ReadCommandBytes
[4];
442 } Read_FuseLockSigOSCCAL_Params
;
444 Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params
, sizeof(Read_FuseLockSigOSCCAL_Params
), NO_STREAM_CALLBACK
);
447 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
448 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
450 uint8_t ResponseBytes
[4];
452 /* Send the Fuse or Lock byte read commands as given by the host to the device, store response */
453 for (uint8_t RByte
= 0; RByte
< sizeof(ResponseBytes
); RByte
++)
454 ResponseBytes
[RByte
] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params
.ReadCommandBytes
[RByte
]);
456 Endpoint_Write_Byte(V2Command
);
457 Endpoint_Write_Byte(STATUS_CMD_OK
);
458 Endpoint_Write_Byte(ResponseBytes
[Read_FuseLockSigOSCCAL_Params
.RetByte
- 1]);
459 Endpoint_Write_Byte(STATUS_CMD_OK
);
463 /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration
464 * byte to the device.
466 * \param[in] V2Command Issued V2 Protocol command byte from the host
468 void ISPProtocol_WriteFuseLock(uint8_t V2Command
)
472 uint8_t WriteCommandBytes
[4];
473 } Write_FuseLockSig_Params
;
475 Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params
, sizeof(Write_FuseLockSig_Params
), NO_STREAM_CALLBACK
);
478 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
479 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
481 /* Send the Fuse or Lock byte program commands as given by the host to the device */
482 for (uint8_t SByte
= 0; SByte
< sizeof(Write_FuseLockSig_Params
.WriteCommandBytes
); SByte
++)
483 SPI_SendByte(Write_FuseLockSig_Params
.WriteCommandBytes
[SByte
]);
485 Endpoint_Write_Byte(V2Command
);
486 Endpoint_Write_Byte(STATUS_CMD_OK
);
487 Endpoint_Write_Byte(STATUS_CMD_OK
);
491 /** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */
492 void ISPProtocol_SPIMulti(void)
502 Endpoint_Read_Stream_LE(&SPI_Multi_Params
, (sizeof(SPI_Multi_Params
) - sizeof(SPI_Multi_Params
.TxData
)), NO_STREAM_CALLBACK
);
503 Endpoint_Read_Stream_LE(&SPI_Multi_Params
.TxData
, SPI_Multi_Params
.TxBytes
, NO_STREAM_CALLBACK
);
506 Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
);
507 Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
);
509 Endpoint_Write_Byte(CMD_SPI_MULTI
);
510 Endpoint_Write_Byte(STATUS_CMD_OK
);
512 uint8_t CurrTxPos
= 0;
513 uint8_t CurrRxPos
= 0;
515 /* Write out bytes to transmit until the start of the bytes to receive is met */
516 while (CurrTxPos
< SPI_Multi_Params
.RxStartAddr
)
518 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
519 SPI_SendByte(SPI_Multi_Params
.TxData
[CurrTxPos
]);
526 /* Transmit remaining bytes with padding as needed, read in response bytes */
527 while (CurrRxPos
< SPI_Multi_Params
.RxBytes
)
529 if (CurrTxPos
< SPI_Multi_Params
.TxBytes
)
530 Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params
.TxData
[CurrTxPos
++]));
532 Endpoint_Write_Byte(SPI_ReceiveByte());
534 /* Check to see if we have filled the endpoint bank and need to send the packet */
535 if (!(Endpoint_IsReadWriteAllowed()))
538 Endpoint_WaitUntilReady();
544 Endpoint_Write_Byte(STATUS_CMD_OK
);
546 bool IsEndpointFull
= !(Endpoint_IsReadWriteAllowed());
549 /* Ensure last packet is a short packet to terminate the transfer */
552 Endpoint_WaitUntilReady();
554 Endpoint_WaitUntilReady();
558 /** Blocking delay for a given number of milliseconds.
560 * \param[in] DelayMS Number of milliseconds to delay for
562 void ISPProtocol_DelayMS(uint8_t DelayMS
)
564 while (DelayMS
-- && TimeoutMSRemaining
)
566 if (TimeoutMSRemaining
)
567 TimeoutMSRemaining
--;