V2Protocol.c 7.47 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
45
/** 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;


46
47
48
49
50
51
52
/** ISR for the management of the command execution timeout counter */
ISR(TIMER0_COMPA_vect, ISR_BLOCK)
{
	if (TimeoutMSRemaining)
	  TimeoutMSRemaining--;
}

53
54
55
56
57
58
59
/** 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);
60
	ADC_StartReading(VTARGET_ADC_CHANNEL_MASK | ADC_RIGHT_ADJUSTED | ADC_REFERENCE_AVCC);
61
62
63
64
65
66
67
68
69
70
	#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();
}

71
/** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
72
73
74
 *  This routine decodes the issued command and passes off the handling of the command to the
 *  appropriate function.
 */
75
76
void V2Protocol_ProcessCommand(void)
{
77
	uint8_t V2Command = Endpoint_Read_Byte();
78
	
79
	/* Set total command processing timeout value, enable timeout management interrupt */
80
81
82
	TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
	TIMSK0 |= (1 << OCIE0A);

83
84
85
	switch (V2Command)
	{
		case CMD_SIGN_ON:
86
			V2Protocol_SignOn();
87
88
89
			break;
		case CMD_SET_PARAMETER:
		case CMD_GET_PARAMETER:
90
			V2Protocol_GetSetParam(V2Command);
91
			break;
92
		case CMD_LOAD_ADDRESS:
93
			V2Protocol_LoadAddress();
94
			break;
95
		case CMD_RESET_PROTECTION:
96
			V2Protocol_ResetProtection();
97
			break;
98
#if defined(ENABLE_ISP_PROTOCOL)
99
		case CMD_ENTER_PROGMODE_ISP:
100
			ISPProtocol_EnterISPMode();
101
102
			break;
		case CMD_LEAVE_PROGMODE_ISP:
103
			ISPProtocol_LeaveISPMode();
104
			break;
105
106
		case CMD_PROGRAM_FLASH_ISP:
		case CMD_PROGRAM_EEPROM_ISP:
107
			ISPProtocol_ProgramMemory(V2Command);			
108
109
110
			break;
		case CMD_READ_FLASH_ISP:
		case CMD_READ_EEPROM_ISP:
111
			ISPProtocol_ReadMemory(V2Command);
112
			break;
113
		case CMD_CHIP_ERASE_ISP:
114
			ISPProtocol_ChipErase();
115
116
117
118
119
			break;
		case CMD_READ_FUSE_ISP:
		case CMD_READ_LOCK_ISP:
		case CMD_READ_SIGNATURE_ISP:
		case CMD_READ_OSCCAL_ISP:
120
			ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
121
122
123
			break;
		case CMD_PROGRAM_FUSE_ISP:
		case CMD_PROGRAM_LOCK_ISP:
124
			ISPProtocol_WriteFuseLock(V2Command);
125
			break;
126
		case CMD_SPI_MULTI:
127
			ISPProtocol_SPIMulti();
128
			break;
129
#endif
130
#if defined(ENABLE_XPROG_PROTOCOL)
131
		case CMD_XPROG_SETMODE:
132
			XPROGProtocol_SetMode();
133
134
			break;
		case CMD_XPROG:
135
			XPROGProtocol_Command();
136
137
			break;
#endif
138
		default:
139
			V2Protocol_UnknownCommand(V2Command);
140
			break;
141
	}
142
		
143
	/* Disable timeout management interrupt once processing has completed */
144
145
	TIMSK0 &= ~(1 << OCIE0A);

146
	Endpoint_WaitUntilReady();
147
148
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
}
149

150
151
152
/** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 *  STATUS_CMD_UNKNOWN status back to the host.
 *
153
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
154
 */
155
static void V2Protocol_UnknownCommand(const uint8_t V2Command)
156
{
157
	/* Discard all incoming data */
158
	while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
159
	{
160
		Endpoint_ClearOUT();
161
		Endpoint_WaitUntilReady();
162
	}
163
164
165
166
167
168
169
170

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

	Endpoint_Write_Byte(V2Command);
	Endpoint_Write_Byte(STATUS_CMD_UNKNOWN);
	Endpoint_ClearIN();
}
171

172
/** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
173
static void V2Protocol_SignOn(void)
174
175
176
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
177

178
179
	Endpoint_Write_Byte(CMD_SIGN_ON);
	Endpoint_Write_Byte(STATUS_CMD_OK);
180
	Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
181
	Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1), NO_STREAM_CALLBACK);
182
183
184
	Endpoint_ClearIN();
}

185
186
/** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 *  no target short-circuit protection is currently implemented.
187
188
189
190
191
192
193
194
195
196
197
198
 */
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();	
}


199
200
201
/** 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.
 *
202
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
203
 */
204
static void V2Protocol_GetSetParam(const uint8_t V2Command)
205
{
206
207
	uint8_t ParamID = Endpoint_Read_Byte();
	uint8_t ParamValue;
208
	
209
210
	if (V2Command == CMD_SET_PARAMETER)
	  ParamValue = Endpoint_Read_Byte();
211
212
213

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
214
	
215
	Endpoint_Write_Byte(V2Command);
216
	
217
	uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
218
	
219
220
221
	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
222
		V2Params_SetParameterValue(ParamID, ParamValue);
223
224
225
226
	}
	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
227
		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
228
	}
229
	else
230
231
232
	{	
		Endpoint_Write_Byte(STATUS_CMD_FAILED);
	}
233

234
	Endpoint_ClearIN();
235
}
236

237
238
239
240
/** 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.
 */
241
static void V2Protocol_LoadAddress(void)
242
{
243
	Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress), NO_STREAM_CALLBACK);
244
245
246

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
247
	
248
	MustSetAddress = true;
249
250
251
252
253

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