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                         V2Protocol_XPROG_SetMode();
  89 #endif
  90                 case CMD_READ_FUSE_ISP:
  91                 case CMD_READ_LOCK_ISP:
  92                 case CMD_READ_SIGNATURE_ISP:
  93                 case CMD_READ_OSCCAL_ISP:
  94                         ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
  95                         break;
  96                 case CMD_PROGRAM_FUSE_ISP:
  97                 case CMD_PROGRAM_LOCK_ISP:
  98                         ISPProtocol_WriteFuseLock(V2Command);
  99                         break;
 100                 case CMD_SPI_MULTI:
 101                         ISPProtocol_SPIMulti();
 102                         break;
 103                 default:
 104                         V2Protocol_UnknownCommand(V2Command);
 105                         break;
 106         }
 107
 108         Endpoint_WaitUntilReady();
 109         Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 110 }
 111
 112 /** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 113  *  STATUS_CMD_UNKNOWN status back to the host.
 114  *
 115  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 116  */
 117 static void V2Protocol_UnknownCommand(uint8_t V2Command)
 118 {
 119         /* Discard all incoming data */
 120         while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 121         {
 122                 Endpoint_ClearOUT();
 123                 Endpoint_WaitUntilReady();
 124         }
 125
 126         Endpoint_ClearOUT();
 127         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 128
 129         Endpoint_Write_Byte(V2Command);
 130         Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 131         Endpoint_ClearIN();
 132 }
 133
 134 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 135 static void V2Protocol_SignOn(void)
 136 {
 137         Endpoint_ClearOUT();
 138         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 139
 140         Endpoint_Write_Byte(CMD_SIGN_ON);
 141         Endpoint_Write_Byte(STATUS_CMD_OK);
 142         Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 143         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1));
 144         Endpoint_ClearIN();
 145 }
 146
 147 /** Handler for the CMD_RESET_PROTECTION command, currently implemented as a dummy ACK function
 148  *  as no ISP short-circuit protection is currently implemented.
 149  */
 150 static void V2Protocol_ResetProtection(void)
 151 {
 152         Endpoint_ClearOUT();
 153         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 154
 155         Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 156         Endpoint_Write_Byte(STATUS_CMD_OK);
 157         Endpoint_ClearIN();
 158 }
 159
 160
 161 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 162  *  getting a device parameter's value from the parameter table.
 163  *
 164  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 165  */
 166 static void V2Protocol_GetSetParam(uint8_t V2Command)
 167 {
 168         uint8_t ParamID = Endpoint_Read_Byte();
 169         uint8_t ParamValue;
 170
 171         if (V2Command == CMD_SET_PARAMETER)
 172           ParamValue = Endpoint_Read_Byte();
 173
 174         Endpoint_ClearOUT();
 175         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 176
 177         Endpoint_Write_Byte(V2Command);
 178
 179         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 180
 181         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 182         {
 183                 Endpoint_Write_Byte(STATUS_CMD_OK);
 184                 V2Params_SetParameterValue(ParamID, ParamValue);
 185         }
 186         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 187         {
 188                 Endpoint_Write_Byte(STATUS_CMD_OK);
 189                 Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 190         }
 191         else
 192         {
 193                 Endpoint_Write_Byte(STATUS_CMD_FAILED);
 194         }
 195
 196         Endpoint_ClearIN();
 197 }
 198
 199 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 200  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 201  *  to the attached device as required.
 202  */
 203 static void V2Protocol_LoadAddress(void)
 204 {
 205         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress));
 206
 207         Endpoint_ClearOUT();
 208         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 209
 210         MustSetAddress = true;
 211
 212         Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 213         Endpoint_Write_Byte(STATUS_CMD_OK);
 214         Endpoint_ClearIN();
 215 }