Projects/AVRISP/Lib/V2Protocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  V2Protocol handler, to process V2 Protocol commands used in Atmel programmer devices.
  34  */
  35
  36 #define  INCLUDE_FROM_V2PROTOCOL_C
  37 #include "V2Protocol.h"
  38
  39 /** Current memory address for FLASH/EEPROM memory read/write commands */
  40 uint32_t CurrentAddress;
  41
  42 /** Flag to indicate that the next read/write operation must update the device's current address */
  43 bool MustSetAddress;
  44
  45
  46 /** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
  47  *  This routine decodes the issued command and passes off the handling of the command to the
  48  *  appropriate function.
  49  */
  50 void V2Protocol_ProcessCommand(void)
  51 {
  52         uint8_t V2Command = Endpoint_Read_Byte();
  53
  54         switch (V2Command)
  55         {
  56                 case CMD_SIGN_ON:
  57                         V2Protocol_SignOn();
  58                         break;
  59                 case CMD_SET_PARAMETER:
  60                 case CMD_GET_PARAMETER:
  61                         V2Protocol_GetSetParam(V2Command);
  62                         break;
  63                 case CMD_LOAD_ADDRESS:
  64                         V2Protocol_LoadAddress();
  65                         break;
  66                 case CMD_RESET_PROTECTION:
  67                         V2Protocol_ResetProtection();
  68                         break;
  69                 case CMD_ENTER_PROGMODE_ISP:
  70                         ISPProtocol_EnterISPMode();
  71                         break;
  72                 case CMD_LEAVE_PROGMODE_ISP:
  73                         ISPProtocol_LeaveISPMode();
  74                         break;
  75                 case CMD_PROGRAM_FLASH_ISP:
  76                 case CMD_PROGRAM_EEPROM_ISP:
  77                         ISPProtocol_ProgramMemory(V2Command);
  78                         break;
  79                 case CMD_READ_FLASH_ISP:
  80                 case CMD_READ_EEPROM_ISP:
  81                         ISPProtocol_ReadMemory(V2Command);
  82                         break;
  83                 case CMD_CHIP_ERASE_ISP:
  84                         ISPProtocol_ChipErase();
  85                         break;
  86 #if defined(ENABLE_XPROG_PROTOCOL)
  87                 case CMD_XPROG_SETMODE:
  88                         PDIProtocol_XPROG_SetMode();
  89                         break;
  90                 case CMD_XPROG:
  91                         PDIProtocol_XPROG_Command();
  92                         break;
  93 #endif
  94                 case CMD_READ_FUSE_ISP:
  95                 case CMD_READ_LOCK_ISP:
  96                 case CMD_READ_SIGNATURE_ISP:
  97                 case CMD_READ_OSCCAL_ISP:
  98                         ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
  99                         break;
 100                 case CMD_PROGRAM_FUSE_ISP:
 101                 case CMD_PROGRAM_LOCK_ISP:
 102                         ISPProtocol_WriteFuseLock(V2Command);
 103                         break;
 104                 case CMD_SPI_MULTI:
 105                         ISPProtocol_SPIMulti();
 106                         break;
 107                 default:
 108                         V2Protocol_UnknownCommand(V2Command);
 109                         break;
 110         }
 111
 112         Endpoint_WaitUntilReady();
 113         Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 114 }
 115
 116 /** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 117  *  STATUS_CMD_UNKNOWN status back to the host.
 118  *
 119  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 120  */
 121 static void V2Protocol_UnknownCommand(uint8_t V2Command)
 122 {
 123         /* Discard all incoming data */
 124         while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 125         {
 126                 Endpoint_ClearOUT();
 127                 Endpoint_WaitUntilReady();
 128         }
 129
 130         Endpoint_ClearOUT();
 131         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 132
 133         Endpoint_Write_Byte(V2Command);
 134         Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 135         Endpoint_ClearIN();
 136 }
 137
 138 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 139 static void V2Protocol_SignOn(void)
 140 {
 141         Endpoint_ClearOUT();
 142         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 143
 144         Endpoint_Write_Byte(CMD_SIGN_ON);
 145         Endpoint_Write_Byte(STATUS_CMD_OK);
 146         Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 147         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1));
 148         Endpoint_ClearIN();
 149 }
 150
 151 /** Handler for the CMD_RESET_PROTECTION command, currently implemented as a dummy ACK function
 152  *  as no ISP short-circuit protection is currently implemented.
 153  */
 154 static void V2Protocol_ResetProtection(void)
 155 {
 156         Endpoint_ClearOUT();
 157         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 158
 159         Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 160         Endpoint_Write_Byte(STATUS_CMD_OK);
 161         Endpoint_ClearIN();
 162 }
 163
 164
 165 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 166  *  getting a device parameter's value from the parameter table.
 167  *
 168  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 169  */
 170 static void V2Protocol_GetSetParam(uint8_t V2Command)
 171 {
 172         uint8_t ParamID = Endpoint_Read_Byte();
 173         uint8_t ParamValue;
 174
 175         if (V2Command == CMD_SET_PARAMETER)
 176           ParamValue = Endpoint_Read_Byte();
 177
 178         Endpoint_ClearOUT();
 179         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 180
 181         Endpoint_Write_Byte(V2Command);
 182
 183         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 184
 185         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 186         {
 187                 Endpoint_Write_Byte(STATUS_CMD_OK);
 188                 V2Params_SetParameterValue(ParamID, ParamValue);
 189         }
 190         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 191         {
 192                 Endpoint_Write_Byte(STATUS_CMD_OK);
 193                 Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 194         }
 195         else
 196         {
 197                 Endpoint_Write_Byte(STATUS_CMD_FAILED);
 198         }
 199
 200         Endpoint_ClearIN();
 201 }
 202
 203 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 204  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 205  *  to the attached device as required.
 206  */
 207 static void V2Protocol_LoadAddress(void)
 208 {
 209         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress));
 210
 211         Endpoint_ClearOUT();
 212         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 213
 214         MustSetAddress = true;
 215
 216         Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 217         Endpoint_Write_Byte(STATUS_CMD_OK);
 218         Endpoint_ClearIN();
 219 }