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