Projects/AVRISP-MKII/Lib/V2Protocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  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.
  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 /** ISR for the management of the command execution timeout counter */
  47 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
  48 {
  49         if (TimeoutMSRemaining)
  50           TimeoutMSRemaining--;
  51 }
  52
  53 /** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
  54  *  This routine decodes the issued command and passes off the handling of the command to the
  55  *  appropriate function.
  56  */
  57 void V2Protocol_ProcessCommand(void)
  58 {
  59         uint8_t V2Command = Endpoint_Read_Byte();
  60
  61         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
  62         TIMSK0 |= (1 << OCIE0A);
  63
  64         switch (V2Command)
  65         {
  66                 case CMD_SIGN_ON:
  67                         V2Protocol_SignOn();
  68                         break;
  69                 case CMD_SET_PARAMETER:
  70                 case CMD_GET_PARAMETER:
  71                         V2Protocol_GetSetParam(V2Command);
  72                         break;
  73                 case CMD_LOAD_ADDRESS:
  74                         V2Protocol_LoadAddress();
  75                         break;
  76                 case CMD_RESET_PROTECTION:
  77                         V2Protocol_ResetProtection();
  78                         break;
  79 #if defined(ENABLE_ISP_PROTOCOL)
  80                 case CMD_ENTER_PROGMODE_ISP:
  81                         ISPProtocol_EnterISPMode();
  82                         break;
  83                 case CMD_LEAVE_PROGMODE_ISP:
  84                         ISPProtocol_LeaveISPMode();
  85                         break;
  86                 case CMD_PROGRAM_FLASH_ISP:
  87                 case CMD_PROGRAM_EEPROM_ISP:
  88                         ISPProtocol_ProgramMemory(V2Command);
  89                         break;
  90                 case CMD_READ_FLASH_ISP:
  91                 case CMD_READ_EEPROM_ISP:
  92                         ISPProtocol_ReadMemory(V2Command);
  93                         break;
  94                 case CMD_CHIP_ERASE_ISP:
  95                         ISPProtocol_ChipErase();
  96                         break;
  97                 case CMD_READ_FUSE_ISP:
  98                 case CMD_READ_LOCK_ISP:
  99                 case CMD_READ_SIGNATURE_ISP:
 100                 case CMD_READ_OSCCAL_ISP:
 101                         ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
 102                         break;
 103                 case CMD_PROGRAM_FUSE_ISP:
 104                 case CMD_PROGRAM_LOCK_ISP:
 105                         ISPProtocol_WriteFuseLock(V2Command);
 106                         break;
 107                 case CMD_SPI_MULTI:
 108                         ISPProtocol_SPIMulti();
 109                         break;
 110 #endif
 111 #if defined(ENABLE_XPROG_PROTOCOL)
 112                 case CMD_XPROG_SETMODE:
 113                         XPROGProtocol_SetMode();
 114                         break;
 115                 case CMD_XPROG:
 116                         XPROGProtocol_Command();
 117                         break;
 118 #endif
 119                 default:
 120                         V2Protocol_UnknownCommand(V2Command);
 121                         break;
 122         }
 123
 124         TIMSK0 &= ~(1 << OCIE0A);
 125
 126         Endpoint_WaitUntilReady();
 127         Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 128 }
 129
 130 /** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 131  *  STATUS_CMD_UNKNOWN status back to the host.
 132  *
 133  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 134  */
 135 static void V2Protocol_UnknownCommand(const uint8_t V2Command)
 136 {
 137         /* Discard all incoming data */
 138         while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 139         {
 140                 Endpoint_ClearOUT();
 141                 Endpoint_WaitUntilReady();
 142         }
 143
 144         Endpoint_ClearOUT();
 145         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 146
 147         Endpoint_Write_Byte(V2Command);
 148         Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 149         Endpoint_ClearIN();
 150 }
 151
 152 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 153 static void V2Protocol_SignOn(void)
 154 {
 155         Endpoint_ClearOUT();
 156         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 157
 158         Endpoint_Write_Byte(CMD_SIGN_ON);
 159         Endpoint_Write_Byte(STATUS_CMD_OK);
 160         Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 161         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1));
 162         Endpoint_ClearIN();
 163 }
 164
 165 /** Handler for the CMD_RESET_PROTECTION command, currently implemented as a dummy ACK function
 166  *  as no ISP short-circuit protection is currently implemented.
 167  */
 168 static void V2Protocol_ResetProtection(void)
 169 {
 170         Endpoint_ClearOUT();
 171         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 172
 173         Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 174         Endpoint_Write_Byte(STATUS_CMD_OK);
 175         Endpoint_ClearIN();
 176 }
 177
 178
 179 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 180  *  getting a device parameter's value from the parameter table.
 181  *
 182  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 183  */
 184 static void V2Protocol_GetSetParam(const uint8_t V2Command)
 185 {
 186         uint8_t ParamID = Endpoint_Read_Byte();
 187         uint8_t ParamValue;
 188
 189         if (V2Command == CMD_SET_PARAMETER)
 190           ParamValue = Endpoint_Read_Byte();
 191
 192         Endpoint_ClearOUT();
 193         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 194
 195         Endpoint_Write_Byte(V2Command);
 196
 197         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 198
 199         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 200         {
 201                 Endpoint_Write_Byte(STATUS_CMD_OK);
 202                 V2Params_SetParameterValue(ParamID, ParamValue);
 203         }
 204         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 205         {
 206                 Endpoint_Write_Byte(STATUS_CMD_OK);
 207                 Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 208         }
 209         else
 210         {
 211                 Endpoint_Write_Byte(STATUS_CMD_FAILED);
 212         }
 213
 214         Endpoint_ClearIN();
 215 }
 216
 217 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 218  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 219  *  to the attached device as required.
 220  */
 221 static void V2Protocol_LoadAddress(void)
 222 {
 223         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress));
 224
 225         Endpoint_ClearOUT();
 226         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 227
 228         MustSetAddress = true;
 229
 230         Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 231         Endpoint_Write_Byte(STATUS_CMD_OK);
 232         Endpoint_ClearIN();
 233 }