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