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