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