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