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