V2Protocol.c 6.64 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
62
63
	TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
	TIMSK0 |= (1 << OCIE0A);

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

126
	Endpoint_WaitUntilReady();
127
128
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
}
129

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

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

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

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

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

165
166
167
168
169
170
171
172
173
174
175
176
177
178
/** Handler for the CMD_RESET_PROTECTION command, currently implemented as a dummy ACK function
 *  as no ISP 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();	
}


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

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

214
	Endpoint_ClearIN();
215
}
216

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

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
227
	
228
	MustSetAddress = true;
229
230
231
232
233

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