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 /** Initializes the hardware and software associated with the V2 protocol command handling. */
  46 void V2Protocol_Init(void)
  47 {
  48         #if defined(ADC)
  49         /* Initialize the ADC converter for VTARGET level detection on supported AVR models */
  50         ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
  51         ADC_SetupChannel(VTARGET_ADC_CHANNEL);
  52         ADC_StartReading(VTARGET_ADC_CHANNEL_MASK | ADC_RIGHT_ADJUSTED | ADC_REFERENCE_AVCC);
  53         #endif
  54
  55         /* Millisecond timer initialization for managing the command timeout counter */
  56         OCR0A  = ((F_CPU / 64) / 1000);
  57         TCCR0A = (1 << WGM01);
  58         TCCR0B = ((1 << CS01) | (1 << CS00));
  59
  60         V2Params_LoadNonVolatileParamValues();
  61 }
  62
  63 /** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
  64  *  This routine decodes the issued command and passes off the handling of the command to the
  65  *  appropriate function.
  66  */
  67 void V2Protocol_ProcessCommand(void)
  68 {
  69         uint8_t V2Command = Endpoint_Read_Byte();
  70
  71         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
  72
  73         switch (V2Command)
  74         {
  75                 case CMD_SIGN_ON:
  76                         V2Protocol_SignOn();
  77                         break;
  78                 case CMD_SET_PARAMETER:
  79                 case CMD_GET_PARAMETER:
  80                         V2Protocol_GetSetParam(V2Command);
  81                         break;
  82                 case CMD_LOAD_ADDRESS:
  83                         V2Protocol_LoadAddress();
  84                         break;
  85                 case CMD_RESET_PROTECTION:
  86                         V2Protocol_ResetProtection();
  87                         break;
  88 #if defined(ENABLE_ISP_PROTOCOL)
  89                 case CMD_ENTER_PROGMODE_ISP:
  90                         ISPProtocol_EnterISPMode();
  91                         break;
  92                 case CMD_LEAVE_PROGMODE_ISP:
  93                         ISPProtocol_LeaveISPMode();
  94                         break;
  95                 case CMD_PROGRAM_FLASH_ISP:
  96                 case CMD_PROGRAM_EEPROM_ISP:
  97                         ISPProtocol_ProgramMemory(V2Command);
  98                         break;
  99                 case CMD_READ_FLASH_ISP:
 100                 case CMD_READ_EEPROM_ISP:
 101                         ISPProtocol_ReadMemory(V2Command);
 102                         break;
 103                 case CMD_CHIP_ERASE_ISP:
 104                         ISPProtocol_ChipErase();
 105                         break;
 106                 case CMD_READ_FUSE_ISP:
 107                 case CMD_READ_LOCK_ISP:
 108                 case CMD_READ_SIGNATURE_ISP:
 109                 case CMD_READ_OSCCAL_ISP:
 110                         ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
 111                         break;
 112                 case CMD_PROGRAM_FUSE_ISP:
 113                 case CMD_PROGRAM_LOCK_ISP:
 114                         ISPProtocol_WriteFuseLock(V2Command);
 115                         break;
 116                 case CMD_SPI_MULTI:
 117                         ISPProtocol_SPIMulti();
 118                         break;
 119 #endif
 120 #if defined(ENABLE_XPROG_PROTOCOL)
 121                 case CMD_XPROG_SETMODE:
 122                         XPROGProtocol_SetMode();
 123                         break;
 124                 case CMD_XPROG:
 125                         XPROGProtocol_Command();
 126                         break;
 127 #endif
 128                 default:
 129                         V2Protocol_UnknownCommand(V2Command);
 130                         break;
 131         }
 132
 133         Endpoint_WaitUntilReady();
 134         Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 135 }
 136
 137 /** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 138  *  STATUS_CMD_UNKNOWN status back to the host.
 139  *
 140  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 141  */
 142 static void V2Protocol_UnknownCommand(const uint8_t V2Command)
 143 {
 144         /* Discard all incoming data */
 145         while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 146         {
 147                 Endpoint_ClearOUT();
 148                 Endpoint_WaitUntilReady();
 149         }
 150
 151         Endpoint_ClearOUT();
 152         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 153
 154         Endpoint_Write_Byte(V2Command);
 155         Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 156         Endpoint_ClearIN();
 157 }
 158
 159 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 160 static void V2Protocol_SignOn(void)
 161 {
 162         Endpoint_ClearOUT();
 163         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 164
 165         Endpoint_Write_Byte(CMD_SIGN_ON);
 166         Endpoint_Write_Byte(STATUS_CMD_OK);
 167         Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 168         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NO_STREAM_CALLBACK);
 169         Endpoint_ClearIN();
 170 }
 171
 172 /** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 173  *  no target short-circuit protection is currently implemented.
 174  */
 175 static void V2Protocol_ResetProtection(void)
 176 {
 177         Endpoint_ClearOUT();
 178         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 179
 180         Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 181         Endpoint_Write_Byte(STATUS_CMD_OK);
 182         Endpoint_ClearIN();
 183 }
 184
 185
 186 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 187  *  getting a device parameter's value from the parameter table.
 188  *
 189  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 190  */
 191 static void V2Protocol_GetSetParam(const uint8_t V2Command)
 192 {
 193         uint8_t ParamID = Endpoint_Read_Byte();
 194         uint8_t ParamValue;
 195
 196         if (V2Command == CMD_SET_PARAMETER)
 197           ParamValue = Endpoint_Read_Byte();
 198
 199         Endpoint_ClearOUT();
 200         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 201
 202         Endpoint_Write_Byte(V2Command);
 203
 204         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 205
 206         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 207         {
 208                 Endpoint_Write_Byte(STATUS_CMD_OK);
 209                 V2Params_SetParameterValue(ParamID, ParamValue);
 210         }
 211         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 212         {
 213                 Endpoint_Write_Byte(STATUS_CMD_OK);
 214                 Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 215         }
 216         else
 217         {
 218                 Endpoint_Write_Byte(STATUS_CMD_FAILED);
 219         }
 220
 221         Endpoint_ClearIN();
 222 }
 223
 224 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 225  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 226  *  to the attached device as required.
 227  */
 228 static void V2Protocol_LoadAddress(void)
 229 {
 230         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NO_STREAM_CALLBACK);
 231
 232         Endpoint_ClearOUT();
 233         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 234
 235         MustSetAddress = true;
 236
 237         Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 238         Endpoint_Write_Byte(STATUS_CMD_OK);
 239         Endpoint_ClearIN();
 240 }