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                         if (IsOddByte 
|| (V2Command 
== CMD_PROGRAM_EEPROM_ISP
)) 
 234                 /* If the current page must be committed, send the PROGRAM PAGE command to the target */ 
 235                 if (Write_Memory_Params
.ProgrammingMode 
& PROG_MODE_COMMIT_PAGE_MASK
) 
 237                         SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[1]); 
 238                         SPI_SendByte(StartAddress 
>> 8); 
 239                         SPI_SendByte(StartAddress 
& 0xFF); 
 242                         /* Check if polling is possible, if not switch to timed delay mode */ 
 245                                 Write_Memory_Params
.ProgrammingMode 
&= ~PROG_MODE_PAGED_VALUE_MASK
; 
 246                                 Write_Memory_Params
.ProgrammingMode 
|=  PROG_MODE_PAGED_TIMEDELAY_MASK
;                          
 249                         ProgrammingStatus 
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
, 
 250                                                                           Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]); 
 255                 /* Word/byte mode memory programming */ 
 256                 for (uint16_t CurrentByte 
= 0; CurrentByte 
< Write_Memory_Params
.BytesToWrite
; CurrentByte
++) 
 258                         bool    IsOddByte   
= (CurrentByte 
& 0x01); 
 259                         uint8_t ByteToWrite 
= *(NextWriteByte
++); 
 261                         SPI_SendByte(Write_Memory_Params
.ProgrammingCommands
[0]); 
 262                         SPI_SendByte(CurrentAddress 
>> 8); 
 263                         SPI_SendByte(CurrentAddress 
& 0xFF); 
 264                         SPI_SendByte(ByteToWrite
); 
 266                         /* AVR FLASH addressing requires us to modify the write command based on if we are writing a high 
 267                          * or low byte at the current word address */ 
 268                         if (V2Command 
== CMD_PROGRAM_FLASH_ISP
) 
 269                           Write_Memory_Params
.ProgrammingCommands
[0] ^= READ_WRITE_HIGH_BYTE_MASK
; 
 271                         if (ByteToWrite 
!= PollValue
) 
 273                                 if (IsOddByte 
&& (V2Command 
== CMD_PROGRAM_FLASH_ISP
)) 
 274                                   Write_Memory_Params
.ProgrammingCommands
[2] |= READ_WRITE_HIGH_BYTE_MASK
; 
 276                                 PollAddress 
= (CurrentAddress 
& 0xFFFF); 
 279                         if (IsOddByte 
|| (V2Command 
== CMD_PROGRAM_EEPROM_ISP
)) 
 282                         ProgrammingStatus 
= ISPTarget_WaitForProgComplete(Write_Memory_Params
.ProgrammingMode
, PollAddress
, PollValue
, 
 283                                                                           Write_Memory_Params
.DelayMS
, Write_Memory_Params
.ProgrammingCommands
[2]); 
 285                         if (ProgrammingStatus 
!= STATUS_CMD_OK
) 
 290         Endpoint_Write_Byte(V2Command
); 
 291         Endpoint_Write_Byte(ProgrammingStatus
); 
 295 /** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes, 
 296  *  words or pages of data from the attached device. 
 298  *  \param[in] V2Command  Issued V2 Protocol command byte from the host 
 300 void ISPProtocol_ReadMemory(uint8_t V2Command
) 
 304                 uint16_t BytesToRead
; 
 305                 uint8_t  ReadMemoryCommand
; 
 306         } Read_Memory_Params
; 
 308         Endpoint_Read_Stream_LE(&Read_Memory_Params
, sizeof(Read_Memory_Params
), NO_STREAM_CALLBACK
); 
 309         Read_Memory_Params
.BytesToRead 
= SwapEndian_16(Read_Memory_Params
.BytesToRead
); 
 312         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
); 
 313         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
); 
 315         Endpoint_Write_Byte(V2Command
); 
 316         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 318         /* Check to see if the host has issued a SET ADDRESS command and we haven't sent a 
 319          * LOAD EXTENDED ADDRESS command (if needed, used when operating beyond the 128KB 
 323                 if (CurrentAddress 
& (1UL << 31)) 
 324                   ISPTarget_LoadExtendedAddress(); 
 326                 MustSetAddress 
= false; 
 329         /* Read each byte from the device and write them to the packet for the host */ 
 330         for (uint16_t CurrentByte 
= 0; CurrentByte 
< Read_Memory_Params
.BytesToRead
; CurrentByte
++) 
 332                 /* Read the next byte from the desired memory space in the device */ 
 333                 SPI_SendByte(Read_Memory_Params
.ReadMemoryCommand
); 
 334                 SPI_SendByte(CurrentAddress 
>> 8); 
 335                 SPI_SendByte(CurrentAddress 
& 0xFF); 
 336                 Endpoint_Write_Byte(SPI_ReceiveByte()); 
 338                 /* Check if the endpoint bank is currently full, if so send the packet */ 
 339                 if (!(Endpoint_IsReadWriteAllowed())) 
 342                         Endpoint_WaitUntilReady(); 
 345                 /* AVR FLASH addressing requires us to modify the read command based on if we are reading a high 
 346                  * or low byte at the current word address */ 
 347                 if (V2Command 
== CMD_READ_FLASH_ISP
) 
 348                   Read_Memory_Params
.ReadMemoryCommand 
^= READ_WRITE_HIGH_BYTE_MASK
; 
 350                 /* Only increment the current address if we have read both bytes in the current word when in FLASH 
 351                  * read mode, or for each byte when in EEPROM read mode */                
 352                 if (((CurrentByte 
& 0x01) && (V2Command 
== CMD_READ_FLASH_ISP
)) || (V2Command 
== CMD_READ_EEPROM_ISP
)) 
 356         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 358         bool IsEndpointFull 
= !(Endpoint_IsReadWriteAllowed()); 
 361         /* Ensure last packet is a short packet to terminate the transfer */ 
 364                 Endpoint_WaitUntilReady();       
 366                 Endpoint_WaitUntilReady();       
 370 /** Handler for the CMD_CHI_ERASE_ISP command, clearing the target's FLASH memory. */ 
 371 void ISPProtocol_ChipErase(void) 
 375                 uint8_t EraseDelayMS
; 
 377                 uint8_t EraseCommandBytes
[4]; 
 380         Endpoint_Read_Stream_LE(&Erase_Chip_Params
, sizeof(Erase_Chip_Params
), NO_STREAM_CALLBACK
); 
 383         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
); 
 384         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
); 
 386         uint8_t ResponseStatus 
= STATUS_CMD_OK
; 
 388         /* Send the chip erase commands as given by the host to the device */ 
 389         for (uint8_t SByte 
= 0; SByte 
< sizeof(Erase_Chip_Params
.EraseCommandBytes
); SByte
++) 
 390           SPI_SendByte(Erase_Chip_Params
.EraseCommandBytes
[SByte
]); 
 392         /* Use appropriate command completion check as given by the host (delay or busy polling) */ 
 393         if (!(Erase_Chip_Params
.PollMethod
)) 
 394           ISPProtocol_DelayMS(Erase_Chip_Params
.EraseDelayMS
); 
 396           ResponseStatus 
= ISPTarget_WaitWhileTargetBusy(); 
 398         Endpoint_Write_Byte(CMD_CHIP_ERASE_ISP
); 
 399         Endpoint_Write_Byte(ResponseStatus
); 
 403 /** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands, 
 404  *  reading the requested configuration byte from the device. 
 406  *  \param[in] V2Command  Issued V2 Protocol command byte from the host 
 408 void ISPProtocol_ReadFuseLockSigOSCCAL(uint8_t V2Command
) 
 413                 uint8_t ReadCommandBytes
[4]; 
 414         } Read_FuseLockSigOSCCAL_Params
; 
 416         Endpoint_Read_Stream_LE(&Read_FuseLockSigOSCCAL_Params
, sizeof(Read_FuseLockSigOSCCAL_Params
), NO_STREAM_CALLBACK
); 
 419         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
); 
 420         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
); 
 422         uint8_t ResponseBytes
[4]; 
 424         /* Send the Fuse or Lock byte read commands as given by the host to the device, store response */ 
 425         for (uint8_t RByte 
= 0; RByte 
< sizeof(ResponseBytes
); RByte
++) 
 426           ResponseBytes
[RByte
] = SPI_TransferByte(Read_FuseLockSigOSCCAL_Params
.ReadCommandBytes
[RByte
]); 
 428         Endpoint_Write_Byte(V2Command
); 
 429         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 430         Endpoint_Write_Byte(ResponseBytes
[Read_FuseLockSigOSCCAL_Params
.RetByte 
- 1]); 
 431         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 435 /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration 
 436  *  byte to the device. 
 438  *  \param[in] V2Command  Issued V2 Protocol command byte from the host 
 440 void ISPProtocol_WriteFuseLock(uint8_t V2Command
) 
 444                 uint8_t WriteCommandBytes
[4]; 
 445         } Write_FuseLockSig_Params
; 
 447         Endpoint_Read_Stream_LE(&Write_FuseLockSig_Params
, sizeof(Write_FuseLockSig_Params
), NO_STREAM_CALLBACK
); 
 450         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
); 
 451         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
); 
 453         /* Send the Fuse or Lock byte program commands as given by the host to the device */ 
 454         for (uint8_t SByte 
= 0; SByte 
< sizeof(Write_FuseLockSig_Params
.WriteCommandBytes
); SByte
++) 
 455           SPI_SendByte(Write_FuseLockSig_Params
.WriteCommandBytes
[SByte
]); 
 457         Endpoint_Write_Byte(V2Command
); 
 458         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 459         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 463 /** Handler for the CMD_SPI_MULTI command, writing and reading arbitrary SPI data to and from the attached device. */ 
 464 void ISPProtocol_SPIMulti(void) 
 474         Endpoint_Read_Stream_LE(&SPI_Multi_Params
, (sizeof(SPI_Multi_Params
) - sizeof(SPI_Multi_Params
.TxData
)), NO_STREAM_CALLBACK
); 
 475         Endpoint_Read_Stream_LE(&SPI_Multi_Params
.TxData
, SPI_Multi_Params
.TxBytes
, NO_STREAM_CALLBACK
); 
 478         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM
); 
 479         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN
); 
 481         Endpoint_Write_Byte(CMD_SPI_MULTI
); 
 482         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 484         uint8_t CurrTxPos 
= 0; 
 485         uint8_t CurrRxPos 
= 0; 
 487         /* Write out bytes to transmit until the start of the bytes to receive is met */ 
 488         while (CurrTxPos 
< SPI_Multi_Params
.RxStartAddr
) 
 490                 if (CurrTxPos 
< SPI_Multi_Params
.TxBytes
) 
 491                   SPI_SendByte(SPI_Multi_Params
.TxData
[CurrTxPos
]); 
 498         /* Transmit remaining bytes with padding as needed, read in response bytes */ 
 499         while (CurrRxPos 
< SPI_Multi_Params
.RxBytes
) 
 501                 if (CurrTxPos 
< SPI_Multi_Params
.TxBytes
) 
 502                   Endpoint_Write_Byte(SPI_TransferByte(SPI_Multi_Params
.TxData
[CurrTxPos
++])); 
 504                   Endpoint_Write_Byte(SPI_ReceiveByte()); 
 506                 /* Check to see if we have filled the endpoint bank and need to send the packet */ 
 507                 if (!(Endpoint_IsReadWriteAllowed())) 
 510                         Endpoint_WaitUntilReady(); 
 516         Endpoint_Write_Byte(STATUS_CMD_OK
); 
 518         bool IsEndpointFull 
= !(Endpoint_IsReadWriteAllowed()); 
 521         /* Ensure last packet is a short packet to terminate the transfer */ 
 524                 Endpoint_WaitUntilReady();       
 526                 Endpoint_WaitUntilReady();       
 530 /** Blocking delay for a given number of milliseconds. 
 532  *  \param[in] DelayMS  Number of milliseconds to delay for 
 534 void ISPProtocol_DelayMS(uint8_t DelayMS
) 
 536         while (DelayMS
-- && TimeoutMSRemaining
) 
 538                 if (TimeoutMSRemaining
) 
 539                   TimeoutMSRemaining
--;