V2Protocol.c 7.37 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  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.
 */

36
#define  INCLUDE_FROM_V2PROTOCOL_C
37
#include "V2Protocol.h"
38

39
40
41
42
43
44
/** 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;

45
46
47
48
49
50
51
/** 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);
52
	ADC_StartReading(VTARGET_ADC_CHANNEL_MASK | ADC_RIGHT_ADJUSTED | ADC_REFERENCE_AVCC);
53
54
55
56
57
58
59
60
61
62
	#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();
}

63
/** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
64
65
66
 *  This routine decodes the issued command and passes off the handling of the command to the
 *  appropriate function.
 */
67
68
void V2Protocol_ProcessCommand(void)
{
69
	uint8_t V2Command = Endpoint_Read_Byte();
70
	
71
	TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
72
	
73
74
75
	switch (V2Command)
	{
		case CMD_SIGN_ON:
76
			V2Protocol_SignOn();
77
78
79
			break;
		case CMD_SET_PARAMETER:
		case CMD_GET_PARAMETER:
80
			V2Protocol_GetSetParam(V2Command);
81
			break;
82
		case CMD_LOAD_ADDRESS:
83
			V2Protocol_LoadAddress();
84
			break;
85
		case CMD_RESET_PROTECTION:
86
			V2Protocol_ResetProtection();
87
			break;
88
#if defined(ENABLE_ISP_PROTOCOL)
89
		case CMD_ENTER_PROGMODE_ISP:
90
			ISPProtocol_EnterISPMode();
91
92
			break;
		case CMD_LEAVE_PROGMODE_ISP:
93
			ISPProtocol_LeaveISPMode();
94
			break;
95
96
		case CMD_PROGRAM_FLASH_ISP:
		case CMD_PROGRAM_EEPROM_ISP:
97
			ISPProtocol_ProgramMemory(V2Command);			
98
99
100
			break;
		case CMD_READ_FLASH_ISP:
		case CMD_READ_EEPROM_ISP:
101
			ISPProtocol_ReadMemory(V2Command);
102
			break;
103
		case CMD_CHIP_ERASE_ISP:
104
			ISPProtocol_ChipErase();
105
106
107
108
109
			break;
		case CMD_READ_FUSE_ISP:
		case CMD_READ_LOCK_ISP:
		case CMD_READ_SIGNATURE_ISP:
		case CMD_READ_OSCCAL_ISP:
110
			ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
111
112
113
			break;
		case CMD_PROGRAM_FUSE_ISP:
		case CMD_PROGRAM_LOCK_ISP:
114
			ISPProtocol_WriteFuseLock(V2Command);
115
			break;
116
		case CMD_SPI_MULTI:
117
			ISPProtocol_SPIMulti();
118
			break;
119
#endif
120
#if defined(ENABLE_XPROG_PROTOCOL)
121
		case CMD_XPROG_SETMODE:
122
			XPROGProtocol_SetMode();
123
124
			break;
		case CMD_XPROG:
125
			XPROGProtocol_Command();
126
127
			break;
#endif
128
		default:
129
			V2Protocol_UnknownCommand(V2Command);
130
			break;
131
	}
132

133
	Endpoint_WaitUntilReady();
134
	Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
135
136
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
}
137

138
139
140
/** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 *  STATUS_CMD_UNKNOWN status back to the host.
 *
141
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
142
 */
143
static void V2Protocol_UnknownCommand(const uint8_t V2Command)
144
{
145
	/* Discard all incoming data */
146
	while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
147
	{
148
		Endpoint_ClearOUT();
149
		Endpoint_WaitUntilReady();
150
	}
151
152

	Endpoint_ClearOUT();
153
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
154
155
156
157
158
159
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

	Endpoint_Write_Byte(V2Command);
	Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
	Endpoint_ClearIN();
}
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_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
166
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
167

168
169
	Endpoint_Write_Byte(CMD_SIGN_ON);
	Endpoint_Write_Byte(STATUS_CMD_OK);
170
	Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
171
	Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NO_STREAM_CALLBACK);
172
173
174
	Endpoint_ClearIN();
}

175
176
/** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 *  no target short-circuit protection is currently implemented.
177
178
179
180
 */
static void V2Protocol_ResetProtection(void)
{
	Endpoint_ClearOUT();
181
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
182
183
184
185
186
187
188
189
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
	
	Endpoint_Write_Byte(CMD_RESET_PROTECTION);
	Endpoint_Write_Byte(STATUS_CMD_OK);
	Endpoint_ClearIN();	
}


190
191
192
/** 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.
 *
193
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
194
 */
195
static void V2Protocol_GetSetParam(const uint8_t V2Command)
196
{
197
198
	uint8_t ParamID = Endpoint_Read_Byte();
	uint8_t ParamValue;
199
	
200
201
	if (V2Command == CMD_SET_PARAMETER)
	  ParamValue = Endpoint_Read_Byte();
202
203

	Endpoint_ClearOUT();
204
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
205
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
206
	
207
	Endpoint_Write_Byte(V2Command);
208
	
209
	uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
210
	
211
212
213
	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
214
		V2Params_SetParameterValue(ParamID, ParamValue);
215
216
217
218
	}
	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
219
		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
220
	}
221
	else
222
223
224
	{	
		Endpoint_Write_Byte(STATUS_CMD_FAILED);
	}
225

226
	Endpoint_ClearIN();
227
}
228

229
230
231
232
/** 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.
 */
233
static void V2Protocol_LoadAddress(void)
234
{
235
	Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NO_STREAM_CALLBACK);
236
237

	Endpoint_ClearOUT();
238
	Endpoint_SelectEndpoint(AVRISP_DATA_IN_EPNUM);
239
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
240
	
241
	MustSetAddress = true;
242
243
244
245
246

	Endpoint_Write_Byte(CMD_LOAD_ADDRESS);
	Endpoint_Write_Byte(STATUS_CMD_OK);
	Endpoint_ClearIN();
}