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