forked from mfulz_github/qmk_firmware
		
	
		
			
				
	
	
		
			241 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			241 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/*
 | 
						|
             LUFA Library
 | 
						|
     Copyright (C) Dean Camera, 2010.
 | 
						|
              
 | 
						|
  dean [at] fourwalledcubicle [dot] com
 | 
						|
      www.fourwalledcubicle.com
 | 
						|
*/
 | 
						|
 | 
						|
/*
 | 
						|
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 | 
						|
 | 
						|
  Permission to use, copy, modify, distribute, and sell this 
 | 
						|
  software and its documentation for any purpose is hereby granted
 | 
						|
  without fee, provided that the above copyright notice appear in 
 | 
						|
  all copies and that both that the copyright notice and this
 | 
						|
  permission notice and warranty disclaimer appear in supporting 
 | 
						|
  documentation, and that the name of the author not be used in 
 | 
						|
  advertising or publicity pertaining to distribution of the 
 | 
						|
  software without specific, written prior permission.
 | 
						|
 | 
						|
  The author disclaim all warranties with regard to this
 | 
						|
  software, including all implied warranties of merchantability
 | 
						|
  and fitness.  In no event shall the author be liable for any
 | 
						|
  special, indirect or consequential damages or any damages
 | 
						|
  whatsoever resulting from loss of use, data or profits, whether
 | 
						|
  in an action of contract, negligence or other tortious action,
 | 
						|
  arising out of or in connection with the use or performance of
 | 
						|
  this software.
 | 
						|
*/
 | 
						|
 | 
						|
/** \file
 | 
						|
 *
 | 
						|
 *  V2Protocol handler, to process V2 Protocol commands used in Atmel programmer devices.
 | 
						|
 */
 | 
						|
 | 
						|
#define  INCLUDE_FROM_V2PROTOCOL_C
 | 
						|
#include "V2Protocol.h"
 | 
						|
 | 
						|
/** Current memory address for FLASH/EEPROM memory read/write commands */
 | 
						|
uint32_t CurrentAddress;
 | 
						|
 | 
						|
/** Flag to indicate that the next read/write operation must update the device's current address */
 | 
						|
bool MustSetAddress;
 | 
						|
 | 
						|
/** Initializes the hardware and software associated with the V2 protocol command handling. */
 | 
						|
void V2Protocol_Init(void)
 | 
						|
{
 | 
						|
	#if defined(ADC)
 | 
						|
	/* Initialize the ADC converter for VTARGET level detection on supported AVR models */
 | 
						|
	ADC_Init(ADC_FREE_RUNNING | ADC_PRESCALE_128);
 | 
						|
	ADC_SetupChannel(VTARGET_ADC_CHANNEL);
 | 
						|
	ADC_StartReading(VTARGET_ADC_CHANNEL_MASK | ADC_RIGHT_ADJUSTED | ADC_REFERENCE_AVCC);
 | 
						|
	#endif
 | 
						|
	
 | 
						|
	/* Millisecond timer initialization for managing the command timeout counter */
 | 
						|
	OCR0A  = ((F_CPU / 64) / 1000);
 | 
						|
	TCCR0A = (1 << WGM01);
 | 
						|
	TCCR0B = ((1 << CS01) | (1 << CS00));
 | 
						|
	
 | 
						|
	V2Params_LoadNonVolatileParamValues();
 | 
						|
}
 | 
						|
 | 
						|
/** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
 | 
						|
 *  This routine decodes the issued command and passes off the handling of the command to the
 | 
						|
 *  appropriate function.
 | 
						|
 */
 | 
						|
void V2Protocol_ProcessCommand(void)
 | 
						|
{
 | 
						|
	uint8_t V2Command = Endpoint_Read_Byte();
 | 
						|
	
 | 
						|
	TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 | 
						|
	
 | 
						|
	switch (V2Command)
 | 
						|
	{
 | 
						|
		case CMD_SIGN_ON:
 | 
						|
			V2Protocol_SignOn();
 | 
						|
			break;
 | 
						|
		case CMD_SET_PARAMETER:
 | 
						|
		case CMD_GET_PARAMETER:
 | 
						|
			V2Protocol_GetSetParam(V2Command);
 | 
						|
			break;
 | 
						|
		case CMD_LOAD_ADDRESS:
 | 
						|
			V2Protocol_LoadAddress();
 | 
						|
			break;
 | 
						|
		case CMD_RESET_PROTECTION:
 | 
						|
			V2Protocol_ResetProtection();
 | 
						|
			break;
 | 
						|
#if defined(ENABLE_ISP_PROTOCOL)
 | 
						|
		case CMD_ENTER_PROGMODE_ISP:
 | 
						|
			ISPProtocol_EnterISPMode();
 | 
						|
			break;
 | 
						|
		case CMD_LEAVE_PROGMODE_ISP:
 | 
						|
			ISPProtocol_LeaveISPMode();
 | 
						|
			break;
 | 
						|
		case CMD_PROGRAM_FLASH_ISP:
 | 
						|
		case CMD_PROGRAM_EEPROM_ISP:
 | 
						|
			ISPProtocol_ProgramMemory(V2Command);			
 | 
						|
			break;
 | 
						|
		case CMD_READ_FLASH_ISP:
 | 
						|
		case CMD_READ_EEPROM_ISP:
 | 
						|
			ISPProtocol_ReadMemory(V2Command);
 | 
						|
			break;
 | 
						|
		case CMD_CHIP_ERASE_ISP:
 | 
						|
			ISPProtocol_ChipErase();
 | 
						|
			break;
 | 
						|
		case CMD_READ_FUSE_ISP:
 | 
						|
		case CMD_READ_LOCK_ISP:
 | 
						|
		case CMD_READ_SIGNATURE_ISP:
 | 
						|
		case CMD_READ_OSCCAL_ISP:
 | 
						|
			ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
 | 
						|
			break;
 | 
						|
		case CMD_PROGRAM_FUSE_ISP:
 | 
						|
		case CMD_PROGRAM_LOCK_ISP:
 | 
						|
			ISPProtocol_WriteFuseLock(V2Command);
 | 
						|
			break;
 | 
						|
		case CMD_SPI_MULTI:
 | 
						|
			ISPProtocol_SPIMulti();
 | 
						|
			break;
 | 
						|
#endif
 | 
						|
#if defined(ENABLE_XPROG_PROTOCOL)
 | 
						|
		case CMD_XPROG_SETMODE:
 | 
						|
			XPROGProtocol_SetMode();
 | 
						|
			break;
 | 
						|
		case CMD_XPROG:
 | 
						|
			XPROGProtocol_Command();
 | 
						|
			break;
 | 
						|
#endif
 | 
						|
		default:
 | 
						|
			V2Protocol_UnknownCommand(V2Command);
 | 
						|
			break;
 | 
						|
	}
 | 
						|
 | 
						|
	Endpoint_WaitUntilReady();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
 | 
						|
}
 | 
						|
 | 
						|
/** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 | 
						|
 *  STATUS_CMD_UNKNOWN status back to the host.
 | 
						|
 *
 | 
						|
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 | 
						|
 */
 | 
						|
static void V2Protocol_UnknownCommand(const uint8_t V2Command)
 | 
						|
{
 | 
						|
	/* Discard all incoming data */
 | 
						|
	while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
 | 
						|
	{
 | 
						|
		Endpoint_ClearOUT();
 | 
						|
		Endpoint_WaitUntilReady();
 | 
						|
	}
 | 
						|
 | 
						|
	Endpoint_ClearOUT();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 | 
						|
 | 
						|
	Endpoint_Write_Byte(V2Command);
 | 
						|
	Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
 | 
						|
	Endpoint_ClearIN();
 | 
						|
}
 | 
						|
 | 
						|
/** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
 | 
						|
static void V2Protocol_SignOn(void)
 | 
						|
{
 | 
						|
	Endpoint_ClearOUT();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 | 
						|
 | 
						|
	Endpoint_Write_Byte(CMD_SIGN_ON);
 | 
						|
	Endpoint_Write_Byte(STATUS_CMD_OK);
 | 
						|
	Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
 | 
						|
	Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NO_STREAM_CALLBACK);
 | 
						|
	Endpoint_ClearIN();
 | 
						|
}
 | 
						|
 | 
						|
/** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 | 
						|
 *  no target short-circuit protection is currently implemented.
 | 
						|
 */
 | 
						|
static void V2Protocol_ResetProtection(void)
 | 
						|
{
 | 
						|
	Endpoint_ClearOUT();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 | 
						|
	
 | 
						|
	Endpoint_Write_Byte(CMD_RESET_PROTECTION);
 | 
						|
	Endpoint_Write_Byte(STATUS_CMD_OK);
 | 
						|
	Endpoint_ClearIN();	
 | 
						|
}
 | 
						|
 | 
						|
 | 
						|
/** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or
 | 
						|
 *  getting a device parameter's value from the parameter table.
 | 
						|
 *
 | 
						|
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
 | 
						|
 */
 | 
						|
static void V2Protocol_GetSetParam(const uint8_t V2Command)
 | 
						|
{
 | 
						|
	uint8_t ParamID = Endpoint_Read_Byte();
 | 
						|
	uint8_t ParamValue;
 | 
						|
	
 | 
						|
	if (V2Command == CMD_SET_PARAMETER)
 | 
						|
	  ParamValue = Endpoint_Read_Byte();
 | 
						|
 | 
						|
	Endpoint_ClearOUT();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 | 
						|
	
 | 
						|
	Endpoint_Write_Byte(V2Command);
 | 
						|
	
 | 
						|
	uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
 | 
						|
	
 | 
						|
	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
 | 
						|
	{
 | 
						|
		Endpoint_Write_Byte(STATUS_CMD_OK);
 | 
						|
		V2Params_SetParameterValue(ParamID, ParamValue);
 | 
						|
	}
 | 
						|
	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
 | 
						|
	{
 | 
						|
		Endpoint_Write_Byte(STATUS_CMD_OK);
 | 
						|
		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
 | 
						|
	}
 | 
						|
	else
 | 
						|
	{	
 | 
						|
		Endpoint_Write_Byte(STATUS_CMD_FAILED);
 | 
						|
	}
 | 
						|
 | 
						|
	Endpoint_ClearIN();
 | 
						|
}
 | 
						|
 | 
						|
/** Handler for the CMD_LOAD_ADDRESS command, loading the given device address into a
 | 
						|
 *  global storage variable for later use, and issuing LOAD EXTENDED ADDRESS commands
 | 
						|
 *  to the attached device as required.
 | 
						|
 */
 | 
						|
static void V2Protocol_LoadAddress(void)
 | 
						|
{
 | 
						|
	Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NO_STREAM_CALLBACK);
 | 
						|
 | 
						|
	Endpoint_ClearOUT();
 | 
						|
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 | 
						|
	
 | 
						|
	MustSetAddress = true;
 | 
						|
 | 
						|
	Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
 | 
						|
	Endpoint_Write_Byte(STATUS_CMD_OK);
 | 
						|
	Endpoint_ClearIN();
 | 
						|
}
 |