Projects/AVRISP-MKII/Lib/V2Protocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 extended FLASH address */
  43 bool MustLoadExtendedAddress;
  44
  45 /** Command timeout expiration flag. */
  46 volatile bool TimeoutExpired;
  47
  48 #if (ARCH == ARCH_AVR8) // TODO: FIXME
  49 /** ISR to manage timeouts whilst processing a V2Protocol command */
  50 ISR(WDT_vect, ISR_BLOCK)
  51 {
  52         TimeoutExpired = true;
  53         wdt_disable();
  54 }
  55 #endif
  56
  57 /** Initialises the hardware and software associated with the V2 protocol command handling. */
  58 void V2Protocol_Init(void)
  59 {
  60         #if defined(ADC)
  61         /* Initialize the ADC converter for VTARGET level detection on supported AVR models */
  62         ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
  63         ADC_SetupChannel(VTARGET_ADC_CHANNEL);
  64         ADC_StartReading(ADC_REFERENCE_AVCC | ADC_RIGHT_ADJUSTED | VTARGET_ADC_CHANNEL_MASK);
  65         #endif
  66
  67         V2Params_LoadNonVolatileParamValues();
  68
  69         #if defined(ENABLE_ISP_PROTOCOL)
  70         ISPTarget_ConfigureRescueClock();
  71         #endif
  72 }
  73
  74 /** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
  75  *  This routine decodes the issued command and passes off the handling of the command to the
  76  *  appropriate function.
  77  */
  78 void V2Protocol_ProcessCommand(void)
  79 {
  80         uint8_t V2Command = Endpoint_Read_8();
  81
  82         #if (ARCH == ARCH_AVR8) // TODO: FIXME
  83         /* Start the watchdog with timeout interrupt enabled to manage the timeout */
  84         TimeoutExpired = false;
  85         wdt_enable(WDTO_1S);
  86         WDTCSR |= (1 << WDIE);
  87         #endif
  88
  89         switch (V2Command)
  90         {
  91                 case CMD_SIGN_ON:
  92                         V2Protocol_SignOn();
  93                         break;
  94                 case CMD_SET_PARAMETER:
  95                 case CMD_GET_PARAMETER:
  96                         V2Protocol_GetSetParam(V2Command);
  97                         break;
  98                 case CMD_LOAD_ADDRESS:
  99                         V2Protocol_LoadAddress();
 100                         break;
 101                 case CMD_RESET_PROTECTION:
 102                         V2Protocol_ResetProtection();
 103                         break;
 104 #if defined(ENABLE_ISP_PROTOCOL)
 105                 case CMD_ENTER_PROGMODE_ISP:
 106                         ISPProtocol_EnterISPMode();
 107                         break;
 108                 case CMD_LEAVE_PROGMODE_ISP:
 109                         ISPProtocol_LeaveISPMode();
 110                         break;
 111                 case CMD_PROGRAM_FLASH_ISP:
 112                 case CMD_PROGRAM_EEPROM_ISP:
 113                         ISPProtocol_ProgramMemory(V2Command);
 114                         break;
 115                 case CMD_READ_FLASH_ISP:
 116                 case CMD_READ_EEPROM_ISP:
 117                         ISPProtocol_ReadMemory(V2Command);
 118                         break;
 119                 case CMD_CHIP_ERASE_ISP:
 120                         ISPProtocol_ChipErase();
 121                         break;
 122                 case CMD_READ_FUSE_ISP:
 123                 case CMD_READ_LOCK_ISP:
 124                 case CMD_READ_SIGNATURE_ISP:
 125                 case CMD_READ_OSCCAL_ISP:
 126                         ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
 127                         break;
 128                 case CMD_PROGRAM_FUSE_ISP:
 129                 case CMD_PROGRAM_LOCK_ISP:
 130                         ISPProtocol_WriteFuseLock(V2Command);
 131                         break;
 132                 case CMD_SPI_MULTI:
 133                         ISPProtocol_SPIMulti();
 134                         break;
 135 #endif
 136 #if defined(ENABLE_XPROG_PROTOCOL)
 137                 case CMD_XPROG_SETMODE:
 138                         XPROGProtocol_SetMode();
 139                         break;
 140                 case CMD_XPROG:
 141                         XPROGProtocol_Command();
 142                         break;
 143 #endif
 144                 default:
 145                         V2Protocol_UnknownCommand(V2Command);
 146                         break;
 147         }
 148
 149         #if (ARCH == ARCH_AVR8) // TODO: FIXME
 150         /* Disable the timeout management watchdog timer */
 151         wdt_disable();
 152         #endif
 153
 154         Endpoint_WaitUntilReady();
 155         Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
 156         Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 157 }
 158
 159 /** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 160  *  STATUS_CMD_UNKNOWN status back to the host.
 161  *
 162  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 163  */
 164 static void V2Protocol_UnknownCommand(const uint8_t V2Command)
 165 {
 166         /* Discard all incoming data */
 167         while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 168         {
 169                 Endpoint_ClearOUT();
 170                 Endpoint_WaitUntilReady();
 171         }
 172
 173         Endpoint_ClearOUT();
 174         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
 175         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 176
 177         Endpoint_Write_8(V2Command);
 178         Endpoint_Write_8(STATUS_CMD_UNKNOWN);
 179         Endpoint_ClearIN();
 180 }
 181
 182 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 183 static void V2Protocol_SignOn(void)
 184 {
 185         Endpoint_ClearOUT();
 186         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
 187         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 188
 189         Endpoint_Write_8(CMD_SIGN_ON);
 190         Endpoint_Write_8(STATUS_CMD_OK);
 191         Endpoint_Write_8(sizeof(PROGRAMMER_ID) - 1);
 192         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NULL);
 193         Endpoint_ClearIN();
 194 }
 195
 196 /** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 197  *  no target short-circuit protection is currently implemented.
 198  */
 199 static void V2Protocol_ResetProtection(void)
 200 {
 201         Endpoint_ClearOUT();
 202         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
 203         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 204
 205         Endpoint_Write_8(CMD_RESET_PROTECTION);
 206         Endpoint_Write_8(STATUS_CMD_OK);
 207         Endpoint_ClearIN();
 208 }
 209
 210
 211 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 212  *  getting a device parameter's value from the parameter table.
 213  *
 214  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 215  */
 216 static void V2Protocol_GetSetParam(const uint8_t V2Command)
 217 {
 218         uint8_t ParamID = Endpoint_Read_8();
 219         uint8_t ParamValue;
 220
 221         if (V2Command == CMD_SET_PARAMETER)
 222           ParamValue = Endpoint_Read_8();
 223
 224         Endpoint_ClearOUT();
 225         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
 226         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 227
 228         Endpoint_Write_8(V2Command);
 229
 230         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 231
 232         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 233         {
 234                 Endpoint_Write_8(STATUS_CMD_OK);
 235                 V2Params_SetParameterValue(ParamID, ParamValue);
 236         }
 237         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 238         {
 239                 Endpoint_Write_8(STATUS_CMD_OK);
 240                 Endpoint_Write_8(V2Params_GetParameterValue(ParamID));
 241         }
 242         else
 243         {
 244                 Endpoint_Write_8(STATUS_CMD_FAILED);
 245         }
 246
 247         Endpoint_ClearIN();
 248 }
 249
 250 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 251  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 252  *  to the attached device as required.
 253  */
 254 static void V2Protocol_LoadAddress(void)
 255 {
 256         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NULL);
 257
 258         Endpoint_ClearOUT();
 259         Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
 260         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 261
 262         if (CurrentAddress & (1UL << 31))
 263           MustLoadExtendedAddress = true;
 264
 265         Endpoint_Write_8(CMD_LOAD_ADDRESS);
 266         Endpoint_Write_8(STATUS_CMD_OK);
 267         Endpoint_ClearIN();
 268 }
 269