XMEGANVM.c 12.7 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
  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
 *
33
 *  Target-related functions for the XMEGA target's NVM module.
34
35
 */

36
37
#define  INCLUDE_FROM_XMEGA_NVM_C
#include "XMEGANVM.h"
38

39
#if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
40

41
42
43
44
/** Sends the given 32-bit absolute address to the target.
 *
 *  \param[in] AbsoluteAddress  Absolute address to send to the target
 */
45
static void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress)
46
47
{
	/* Send the given 32-bit address to the target, LSB first */
48
49
50
51
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[2]);
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[3]);
52
53
}

54
55
56
57
58
59
60
61
62
63
64
65
66
/** Sends the given NVM register address to the target.
 *
 *  \param[in] Register  NVM register whose absolute address is to be sent
 */
static void XMEGANVM_SendNVMRegAddress(const uint8_t Register)
{
	/* Determine the absolute register address from the NVM base memory address and the NVM register address */
	uint32_t Address = XPROG_Param_NVMBase | Register;

	/* Send the calculated 32-bit address to the target, LSB first */
	XMEGANVM_SendAddress(Address);
}

67
68
69
70
71
72
73
74
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read or CRC
 *  calculation.
 *
 *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 */
bool XMEGANVM_WaitWhileNVMBusBusy(void)
{
	/* Poll the STATUS register to check to see if NVM access has been enabled */
75
	while (TimeoutMSRemaining)
76
77
78
79
	{
		/* Send the LDCS command to read the PDI STATUS register to see the NVM bus is active */
		XPROGTarget_SendByte(PDI_CMD_LDCS | PDI_STATUS_REG);
		if (XPROGTarget_ReceiveByte() & PDI_STATUS_NVM)
80
81
82
83
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
84
85
86
	}
	
	return false;
87
88
}

89
90
91
92
93
/** Waits while the target's NVM controller is busy performing an operation, exiting if the
 *  timeout period expires.
 *
 *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 */
94
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
95
96
{
	/* Poll the NVM STATUS register while the NVM controller is busy */
97
	while (TimeoutMSRemaining)
98
	{
99
		/* Send a LDS command to read the NVM STATUS register to check the BUSY flag */
100
		XPROGTarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
101
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
102
		
103
		/* Check to see if the BUSY flag is still set */
104
		if (!(XPROGTarget_ReceiveByte() & (1 << 7)))
105
106
107
108
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
109
	}
110
111
	
	return false;
112
113
}

114
115
/** Retrieves the CRC value of the given memory space.
 *
116
117
 *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 *  \param[out] CRCDest     CRC Destination when read from the target
118
 *
119
 *  \return Boolean true if the command sequence complete successfully
120
 */
121
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
122
{
123
	/* Wait until the NVM controller is no longer busy */
124
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
125
126
	  return false;
	  
127
	/* Set the NVM command to the correct CRC read command */
128
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
129
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
130
	XPROGTarget_SendByte(CRCCommand);
131
132

	/* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
133
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
134
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
135
	XPROGTarget_SendByte(1 << 0);
136

137
	/* Wait until the NVM bus is ready again */
138
	if (!(XMEGANVM_WaitWhileNVMBusBusy()))
139
140
	  return false;

141
	/* Wait until the NVM controller is no longer busy */
142
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
143
144
	  return false;
	
145
146
	/* Load the PDI pointer register with the DAT0 register start address */
	XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
147
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
148

149
150
151
	/* Send the REPEAT command to grab the CRC bytes */
	XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	XPROGTarget_SendByte(XMEGA_CRC_LENGTH - 1);
152
	
153
154
155
156
	/* Read in the CRC bytes from the target */
	XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
	for (uint8_t i = 0; i < XMEGA_CRC_LENGTH; i++)
	  ((uint8_t*)CRCDest)[i] = XPROGTarget_ReceiveByte();
157
	
158
	return true;
159
160
}

161
162
163
164
165
/** Reads memory from the target's memory spaces.
 *
 *  \param[in]  ReadAddress  Start address to read from within the target's address space
 *  \param[out] ReadBuffer   Buffer to store read data into
 *  \param[in]  ReadSize     Number of bytes to read
166
 *
167
 *  \return Boolean true if the command sequence complete successfully
168
 */
169
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
170
{
171
	/* Wait until the NVM controller is no longer busy */
172
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
173
	  return false;
174
	
175
	/* Send the READNVM command to the NVM controller for reading of an arbitrary location */
176
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
177
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
178
	XPROGTarget_SendByte(XMEGA_NVM_CMD_READNVM);
179

180
	/* Load the PDI pointer register with the start address we want to read from */
181
	XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
182
	XMEGANVM_SendAddress(ReadAddress);
183

184
	/* Send the REPEAT command with the specified number of bytes to read */
185
186
	XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	XPROGTarget_SendByte(ReadSize - 1);
187
		
188
	/* Send a LD command with indirect access and postincrement to read out the bytes */
189
	XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
190
	while (ReadSize--)
191
	  *(ReadBuffer++) = XPROGTarget_ReceiveByte();
192
193
	
	return true;
194
195
}

196
197
/** Writes byte addressed memory to the target's memory spaces.
 *
198
 *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
199
200
 *  \param[in]  WriteAddress  Address to write to within the target's address space
 *  \param[in]  Byte          Byte to write to the target
201
 *
202
 *  \return Boolean true if the command sequence complete successfully
203
 */
204
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
205
{
206
	/* Wait until the NVM controller is no longer busy */
207
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
208
	  return false;
209

210
	/* Send the memory write command to the target */
211
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
212
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
213
	XPROGTarget_SendByte(WriteCommand);
214
	
215
	/* Send new memory byte to the memory to the target */
216
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
217
	XMEGANVM_SendAddress(WriteAddress);
218
	XPROGTarget_SendByte(Byte);
219
220
221
222
	
	return true;
}

223
224
225
226
227
228
229
230
231
232
/** Writes page addressed memory to the target's memory spaces.
 *
 *  \param[in]  WriteBuffCommand  Command to send to the device to write a byte to the memory page buffer
 *  \param[in]  EraseBuffCommand  Command to send to the device to erase the memory page buffer
 *  \param[in]  WritePageCommand  Command to send to the device to write the page buffer to the destination memory
 *  \param[in]  PageMode          Bitfield indicating what operations need to be executed on the specified page
 *  \param[in]  WriteAddress      Start address to write the page data to within the target's address space
 *  \param[in]  WriteBuffer       Buffer to source data from
 *  \param[in]  WriteSize         Number of bytes to write
 *
233
 *  \return Boolean true if the command sequence complete successfully
234
 */
235
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
236
237
                              const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
                              const uint8_t* WriteBuffer, uint16_t WriteSize)
238
239
240
241
{
	if (PageMode & XPRG_PAGEMODE_ERASE)
	{
		/* Wait until the NVM controller is no longer busy */
242
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
243
244
245
		  return false;

		/* Send the memory buffer erase command to the target */
246
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
247
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
248
		XPROGTarget_SendByte(EraseBuffCommand);
249
250

		/* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
251
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
252
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
253
		XPROGTarget_SendByte(1 << 0);
254
255
256
257
258
	}

	if (WriteSize)
	{
		/* Wait until the NVM controller is no longer busy */
259
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
260
261
262
		  return false;

		/* Send the memory buffer write command to the target */
263
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
264
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
265
		XPROGTarget_SendByte(WriteBuffCommand);
266
267

		/* Load the PDI pointer register with the start address we want to write to */
268
		XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
269
		XMEGANVM_SendAddress(WriteAddress);
270
271

		/* Send the REPEAT command with the specified number of bytes to write */
272
273
		XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
		XPROGTarget_SendByte(WriteSize - 1);
274
275
			
		/* Send a ST command with indirect access and postincrement to write the bytes */
276
		XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
277
		while (WriteSize--)
278
		  XPROGTarget_SendByte(*(WriteBuffer++));
279
280
281
282
283
	}
	
	if (PageMode & XPRG_PAGEMODE_WRITE)
	{
		/* Wait until the NVM controller is no longer busy */
284
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
285
286
287
		  return false;

		/* Send the memory write command to the target */
288
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
289
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
290
		XPROGTarget_SendByte(WritePageCommand);
291
292
		
		/* Send the address of the first page location to write the memory page */
293
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
294
		XMEGANVM_SendAddress(WriteAddress);
295
		XPROGTarget_SendByte(0x00);
296
297
298
299
300
	}

	return true;
}

301
302
303
304
/** Erases a specific memory space of the target.
 *
 *  \param[in] EraseCommand  NVM erase command to send to the device
 *  \param[in] Address  Address inside the memory space to erase
305
 *
306
 *  \return Boolean true if the command sequence complete successfully
307
 */
308
bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
309
{
310
	/* Wait until the NVM controller is no longer busy */
311
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
312
313
314
	  return false;
	  
	/* Send the memory erase command to the target */
315
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
316
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
317
	XPROGTarget_SendByte(EraseCommand);
318
	
319
	/* Chip erase is handled separately, since it's procedure is different to other erase types */
320
	if (EraseCommand == XMEGA_NVM_CMD_CHIPERASE)
321
322
	{
		/* Set CMDEX bit in NVM CTRLA register to start the chip erase */
323
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
324
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
325
		XPROGTarget_SendByte(1 << 0);		
326
327
328
329
	}
	else
	{
		/* Other erase modes just need us to address a byte within the target memory space */
330
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
331
		XMEGANVM_SendAddress(Address);
332
		XPROGTarget_SendByte(0x00);
333
334
	}
	
335
	/* Wait until the NVM bus is ready again */
336
	if (!(XMEGANVM_WaitWhileNVMBusBusy()))
337
338
339
	  return false;
	  
	return true;
340
341
}

342
#endif