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