V2Protocol.c 6.79 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
/** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
54
55
56
 *  This routine decodes the issued command and passes off the handling of the command to the
 *  appropriate function.
 */
57
58
void V2Protocol_ProcessCommand(void)
{
59
	uint8_t V2Command = Endpoint_Read_Byte();
60
	
61
	/* Set total command processing timeout value, enable timeout management interrupt */
62
63
64
	TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
	TIMSK0 |= (1 << OCIE0A);

65
66
67
	switch (V2Command)
	{
		case CMD_SIGN_ON:
68
			V2Protocol_SignOn();
69
70
71
			break;
		case CMD_SET_PARAMETER:
		case CMD_GET_PARAMETER:
72
			V2Protocol_GetSetParam(V2Command);
73
			break;
74
		case CMD_LOAD_ADDRESS:
75
			V2Protocol_LoadAddress();
76
			break;
77
		case CMD_RESET_PROTECTION:
78
			V2Protocol_ResetProtection();
79
			break;
80
#if defined(ENABLE_ISP_PROTOCOL)
81
		case CMD_ENTER_PROGMODE_ISP:
82
			ISPProtocol_EnterISPMode();
83
84
			break;
		case CMD_LEAVE_PROGMODE_ISP:
85
			ISPProtocol_LeaveISPMode();
86
			break;
87
88
		case CMD_PROGRAM_FLASH_ISP:
		case CMD_PROGRAM_EEPROM_ISP:
89
			ISPProtocol_ProgramMemory(V2Command);			
90
91
92
			break;
		case CMD_READ_FLASH_ISP:
		case CMD_READ_EEPROM_ISP:
93
			ISPProtocol_ReadMemory(V2Command);
94
			break;
95
		case CMD_CHIP_ERASE_ISP:
96
			ISPProtocol_ChipErase();
97
98
99
100
101
			break;
		case CMD_READ_FUSE_ISP:
		case CMD_READ_LOCK_ISP:
		case CMD_READ_SIGNATURE_ISP:
		case CMD_READ_OSCCAL_ISP:
102
			ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
103
104
105
			break;
		case CMD_PROGRAM_FUSE_ISP:
		case CMD_PROGRAM_LOCK_ISP:
106
			ISPProtocol_WriteFuseLock(V2Command);
107
			break;
108
		case CMD_SPI_MULTI:
109
			ISPProtocol_SPIMulti();
110
			break;
111
#endif
112
#if defined(ENABLE_XPROG_PROTOCOL)
113
		case CMD_XPROG_SETMODE:
114
			XPROGProtocol_SetMode();
115
116
			break;
		case CMD_XPROG:
117
			XPROGProtocol_Command();
118
119
			break;
#endif
120
		default:
121
			V2Protocol_UnknownCommand(V2Command);
122
			break;
123
	}
124
		
125
	/* Disable timeout management interrupt once processing has completed */
126
127
	TIMSK0 &= ~(1 << OCIE0A);

128
	Endpoint_WaitUntilReady();
129
130
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
}
131

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

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

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

154
/** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
155
static void V2Protocol_SignOn(void)
156
157
158
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
159

160
161
	Endpoint_Write_Byte(CMD_SIGN_ON);
	Endpoint_Write_Byte(STATUS_CMD_OK);
162
163
	Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
	Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1));
164
165
166
	Endpoint_ClearIN();
}

167
168
/** Handler for the CMD_RESET_PROTECTION command, implemented as a dummy ACK function as
 *  no target short-circuit protection is currently implemented.
169
170
171
172
173
174
175
176
177
178
179
180
 */
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();	
}


181
182
183
/** 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.
 *
184
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
185
 */
186
static void V2Protocol_GetSetParam(const uint8_t V2Command)
187
{
188
189
	uint8_t ParamID = Endpoint_Read_Byte();
	uint8_t ParamValue;
190
	
191
192
	if (V2Command == CMD_SET_PARAMETER)
	  ParamValue = Endpoint_Read_Byte();
193
194
195

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
196
	
197
	Endpoint_Write_Byte(V2Command);
198
	
199
	uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
200
	
201
202
203
	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
204
		V2Params_SetParameterValue(ParamID, ParamValue);
205
206
207
208
	}
	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
209
		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
210
	}
211
	else
212
213
214
	{	
		Endpoint_Write_Byte(STATUS_CMD_FAILED);
	}
215

216
	Endpoint_ClearIN();
217
}
218

219
220
221
222
/** 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.
 */
223
static void V2Protocol_LoadAddress(void)
224
{
225
	Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress));
226
227
228

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
229
	
230
	MustSetAddress = true;
231
232
233
234
235

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