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