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