V2Protocol.c 6.32 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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.
 */

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
/** Master V2 Protocol packet handler, for received V2 Protocol packets from a connected host.
47
48
49
 *  This routine decodes the issued command and passes off the handling of the command to the
 *  appropriate function.
 */
50
51
void V2Protocol_ProcessCommand(void)
{
52
	uint8_t V2Command = Endpoint_Read_Byte();
53
		  
54
55
56
	switch (V2Command)
	{
		case CMD_SIGN_ON:
57
			V2Protocol_SignOn();
58
59
60
			break;
		case CMD_SET_PARAMETER:
		case CMD_GET_PARAMETER:
61
			V2Protocol_GetSetParam(V2Command);
62
			break;
63
		case CMD_LOAD_ADDRESS:
64
			V2Protocol_LoadAddress();
65
			break;
66
		case CMD_RESET_PROTECTION:
67
			V2Protocol_ResetProtection();
68
			break;
69
		case CMD_ENTER_PROGMODE_ISP:
70
			ISPProtocol_EnterISPMode();
71
72
			break;
		case CMD_LEAVE_PROGMODE_ISP:
73
			ISPProtocol_LeaveISPMode();
74
			break;
75
76
		case CMD_PROGRAM_FLASH_ISP:
		case CMD_PROGRAM_EEPROM_ISP:
77
			ISPProtocol_ProgramMemory(V2Command);			
78
79
80
			break;
		case CMD_READ_FLASH_ISP:
		case CMD_READ_EEPROM_ISP:
81
			ISPProtocol_ReadMemory(V2Command);
82
			break;
83
		case CMD_CHIP_ERASE_ISP:
84
			ISPProtocol_ChipErase();
85
			break;
86
87
#if defined(ENABLE_XPROG_PROTOCOL)
		case CMD_XPROG_SETMODE:
88
89
90
91
92
			PDIProtocol_XPROG_SetMode();
			break;
		case CMD_XPROG:
			PDIProtocol_XPROG_Command();
			break;
93
#endif
94
95
96
97
		case CMD_READ_FUSE_ISP:
		case CMD_READ_LOCK_ISP:
		case CMD_READ_SIGNATURE_ISP:
		case CMD_READ_OSCCAL_ISP:
98
			ISPProtocol_ReadFuseLockSigOSCCAL(V2Command);
99
100
101
			break;
		case CMD_PROGRAM_FUSE_ISP:
		case CMD_PROGRAM_LOCK_ISP:
102
			ISPProtocol_WriteFuseLock(V2Command);
103
			break;
104
		case CMD_SPI_MULTI:
105
			ISPProtocol_SPIMulti();
106
			break;
107
		default:
108
			V2Protocol_UnknownCommand(V2Command);
109
			break;
110
111
	}
	
112
	Endpoint_WaitUntilReady();
113
114
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_OUT);
}
115

116
117
118
/** Handler for unknown V2 protocol commands. This discards all sent data and returns a
 *  STATUS_CMD_UNKNOWN status back to the host.
 *
119
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
120
 */
121
static void V2Protocol_UnknownCommand(uint8_t V2Command)
122
{
123
	/* Discard all incoming data */
124
	while (Endpoint_BytesInEndpoint() == AVRISP_DATA_EPSIZE)
125
	{
126
		Endpoint_ClearOUT();
127
		Endpoint_WaitUntilReady();
128
	}
129
130
131
132
133
134
135
136

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

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

138
/** Handler for the CMD_SIGN_ON command, returning the programmer ID string to the host. */
139
static void V2Protocol_SignOn(void)
140
141
142
{
	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
143

144
145
	Endpoint_Write_Byte(CMD_SIGN_ON);
	Endpoint_Write_Byte(STATUS_CMD_OK);
146
147
	Endpoint_Write_Byte(sizeof(PROGRAMMER_ID) - 1);
	Endpoint_Write_Stream_LE(PROGRAMMER_ID, (sizeof(PROGRAMMER_ID) - 1));
148
149
150
	Endpoint_ClearIN();
}

151
152
153
154
155
156
157
158
159
160
161
162
163
164
/** 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();	
}


165
166
167
/** 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.
 *
168
 *  \param[in] V2Command  Issued V2 Protocol command byte from the host
169
 */
170
static void V2Protocol_GetSetParam(uint8_t V2Command)
171
{
172
173
	uint8_t ParamID = Endpoint_Read_Byte();
	uint8_t ParamValue;
174
	
175
176
	if (V2Command == CMD_SET_PARAMETER)
	  ParamValue = Endpoint_Read_Byte();
177
178
179

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
180
	
181
	Endpoint_Write_Byte(V2Command);
182
	
183
	uint8_t ParamPrivs = V2Params_GetParameterPrivileges(ParamID);
184
	
185
186
187
	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
188
		V2Params_SetParameterValue(ParamID, ParamValue);
189
190
191
192
	}
	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))
	{
		Endpoint_Write_Byte(STATUS_CMD_OK);
193
		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));
194
	}
195
	else
196
197
198
	{	
		Endpoint_Write_Byte(STATUS_CMD_FAILED);
	}
199

200
	Endpoint_ClearIN();
201
}
202

203
204
205
206
/** 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.
 */
207
static void V2Protocol_LoadAddress(void)
208
{
209
	Endpoint_Read_Stream_BE(&CurrentAddress, sizeof(CurrentAddress));
210
211
212

	Endpoint_ClearOUT();
	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
213
	
214
	MustSetAddress = true;
215
216
217
218
219

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