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 for the management of the command execution timeout counter */
  47 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
  48 {
  49         if (TimeoutMSRemaining)
  50           TimeoutMSRemaining--;
  51 }
  52
  53 /** Initializes 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         /* Millisecond timer initialization for managing the command timeout counter */
  64         OCR0A  = ((F_CPU / 64) / 1000);
  65         TCCR0A = (1 << WGM01);
  66         TCCR0B = ((1 << CS01) | (1 << CS00));
  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         /* Set total command processing timeout value, enable timeout management interrupt */
  80         TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
  81         TIMSK0 |= (1 << OCIE0A);
  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 timeout management interrupt once processing has completed */
 144         TIMSK0 &= ~(1 << OCIE0A);
 145
 146         Endpoint_WaitUntilReady();
 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_SetEndpointDirection(ENDPOINT_DIR_IN);
 166
 167         Endpoint_Write_Byte(V2Command);
 168         Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 169         Endpoint_ClearIN();
 170 }
 171
 172 /** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 173 static void V2Protocol_SignOn(void)
 174 {
 175         Endpoint_ClearOUT();
 176         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 177
 178         Endpoint_Write_Byte(CMD_SIGN_ON);
 179         Endpoint_Write_Byte(STATUS_CMD_OK);
 180         Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 181         Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NO_STREAM_CALLBACK);
 182         Endpoint_ClearIN();
 183 }
 184
 185 /** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 186  *  no target short-circuit protection is currently implemented.
 187  */
 188 static void V2Protocol_ResetProtection(void)
 189 {
 190         Endpoint_ClearOUT();
 191         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 192
 193         Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 194         Endpoint_Write_Byte(STATUS_CMD_OK);
 195         Endpoint_ClearIN();
 196 }
 197
 198
 199 /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 200  *  getting a device parameter's value from the parameter table.
 201  *
 202  *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 203  */
 204 static void V2Protocol_GetSetParam(const uint8_t V2Command)
 205 {
 206         uint8_t ParamID = Endpoint_Read_Byte();
 207         uint8_t ParamValue;
 208
 209         if (V2Command == CMD_SET_PARAMETER)
 210           ParamValue = Endpoint_Read_Byte();
 211
 212         Endpoint_ClearOUT();
 213         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 214
 215         Endpoint_Write_Byte(V2Command);
 216
 217         uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 218
 219         if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 220         {
 221                 Endpoint_Write_Byte(STATUS_CMD_OK);
 222                 V2Params_SetParameterValue(ParamID, ParamValue);
 223         }
 224         else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 225         {
 226                 Endpoint_Write_Byte(STATUS_CMD_OK);
 227                 Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 228         }
 229         else
 230         {
 231                 Endpoint_Write_Byte(STATUS_CMD_FAILED);
 232         }
 233
 234         Endpoint_ClearIN();
 235 }
 236
 237 /** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 238  *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 239  *  to the attached device as required.
 240  */
 241 static void V2Protocol_LoadAddress(void)
 242 {
 243         Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NO_STREAM_CALLBACK);
 244
 245         Endpoint_ClearOUT();
 246         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 247
 248         MustSetAddress = true;
 249
 250         Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 251         Endpoint_Write_Byte(STATUS_CMD_OK);
 252         Endpoint_ClearIN();
 253 }