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