XMEGANVM.c 13.2 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
	{
		/* 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);
79
80
81
82
83
84
85
86
87
		
		uint8_t StatusRegister = XPROGTarget_ReceiveByte();
		
		/* We might have timed out waiting for the status register read response, check here */
		if (!(TimeoutMSRemaining))
		  return false;
		
		/* Check the status register read response to see if the NVM bus is enabled */
		if (StatusRegister & PDI_STATUS_NVM)
88
89
90
91
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
92
93
94
	}
	
	return false;
95
96
}

97
98
99
100
101
/** 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
 */
102
bool XMEGANVM_WaitWhileNVMControllerBusy(void)
103
104
{
	/* Poll the NVM STATUS register while the NVM controller is busy */
105
	while (TimeoutMSRemaining)
106
	{
107
		/* Send a LDS command to read the NVM STATUS register to check the BUSY flag */
108
		XPROGTarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
109
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_STATUS);
110
		
111
112
113
114
115
116
		uint8_t StatusRegister = XPROGTarget_ReceiveByte();

		/* We might have timed out waiting for the status register read response, check here */
		if (!(TimeoutMSRemaining))
		  return false;

117
		/* Check to see if the BUSY flag is still set */
118
		if (!(StatusRegister & (1 << 7)))
119
120
121
122
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
123
	}
124
125
	
	return false;
126
127
}

128
129
/** Retrieves the CRC value of the given memory space.
 *
130
131
 *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 *  \param[out] CRCDest     CRC Destination when read from the target
132
 *
133
 *  \return Boolean true if the command sequence complete successfully
134
 */
135
bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest)
136
{
137
	/* Wait until the NVM controller is no longer busy */
138
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
139
140
	  return false;
	  
141
	/* Set the NVM command to the correct CRC read command */
142
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
143
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
144
	XPROGTarget_SendByte(CRCCommand);
145
146

	/* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
147
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
148
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
149
	XPROGTarget_SendByte(1 << 0);
150

151
	/* Wait until the NVM bus is ready again */
152
	if (!(XMEGANVM_WaitWhileNVMBusBusy()))
153
154
	  return false;

155
	/* Wait until the NVM controller is no longer busy */
156
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
157
158
	  return false;
	
159
160
	/* Load the PDI pointer register with the DAT0 register start address */
	XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
161
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_DAT0);
162

163
164
165
	/* Send the REPEAT command to grab the CRC bytes */
	XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	XPROGTarget_SendByte(XMEGA_CRC_LENGTH - 1);
166
	
167
168
169
170
	/* 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();
171
	
172
	return (TimeoutMSRemaining != 0);
173
174
}

175
176
177
178
179
/** 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
180
 *
181
 *  \return Boolean true if the command sequence complete successfully
182
 */
183
bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
184
{
185
	/* Wait until the NVM controller is no longer busy */
186
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
187
	  return false;
188
	
189
	/* Send the READNVM command to the NVM controller for reading of an arbitrary location */
190
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
191
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
192
	XPROGTarget_SendByte(XMEGA_NVM_CMD_READNVM);
193

194
	/* Load the PDI pointer register with the start address we want to read from */
195
	XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
196
	XMEGANVM_SendAddress(ReadAddress);
197

198
	/* Send the REPEAT command with the specified number of bytes to read */
199
200
	XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	XPROGTarget_SendByte(ReadSize - 1);
201
		
202
	/* Send a LD command with indirect access and postincrement to read out the bytes */
203
	XPROGTarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
204
	while (ReadSize-- && TimeoutMSRemaining)
205
	  *(ReadBuffer++) = XPROGTarget_ReceiveByte();
206
	
207
	return (TimeoutMSRemaining != 0);
208
209
}

210
211
/** Writes byte addressed memory to the target's memory spaces.
 *
212
 *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
213
214
 *  \param[in]  WriteAddress  Address to write to within the target's address space
 *  \param[in]  Byte          Byte to write to the target
215
 *
216
 *  \return Boolean true if the command sequence complete successfully
217
 */
218
bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte)
219
{
220
	/* Wait until the NVM controller is no longer busy */
221
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
222
	  return false;
223

224
	/* Send the memory write command to the target */
225
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
226
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
227
	XPROGTarget_SendByte(WriteCommand);
228
	
229
	/* Send new memory byte to the memory to the target */
230
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
231
	XMEGANVM_SendAddress(WriteAddress);
232
	XPROGTarget_SendByte(Byte);
233
234
235
236
	
	return true;
}

237
238
239
240
241
242
243
244
245
246
/** 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
 *
247
 *  \return Boolean true if the command sequence complete successfully
248
 */
249
bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
250
251
                              const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
                              const uint8_t* WriteBuffer, uint16_t WriteSize)
252
253
254
255
{
	if (PageMode & XPRG_PAGEMODE_ERASE)
	{
		/* Wait until the NVM controller is no longer busy */
256
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
257
258
259
		  return false;

		/* Send the memory buffer erase command to the target */
260
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
261
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
262
		XPROGTarget_SendByte(EraseBuffCommand);
263
264

		/* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
265
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
266
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
267
		XPROGTarget_SendByte(1 << 0);
268
269
270
271
272
	}

	if (WriteSize)
	{
		/* Wait until the NVM controller is no longer busy */
273
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
274
275
276
		  return false;

		/* Send the memory buffer write command to the target */
277
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
278
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
279
		XPROGTarget_SendByte(WriteBuffCommand);
280
281

		/* Load the PDI pointer register with the start address we want to write to */
282
		XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
283
		XMEGANVM_SendAddress(WriteAddress);
284
285

		/* Send the REPEAT command with the specified number of bytes to write */
286
287
		XPROGTarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
		XPROGTarget_SendByte(WriteSize - 1);
288
289
			
		/* Send a ST command with indirect access and postincrement to write the bytes */
290
		XPROGTarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
291
		while (WriteSize--)
292
		  XPROGTarget_SendByte(*(WriteBuffer++));
293
294
295
296
297
	}
	
	if (PageMode & XPRG_PAGEMODE_WRITE)
	{
		/* Wait until the NVM controller is no longer busy */
298
		if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
299
300
301
		  return false;

		/* Send the memory write command to the target */
302
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
303
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
304
		XPROGTarget_SendByte(WritePageCommand);
305
306
		
		/* Send the address of the first page location to write the memory page */
307
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
308
		XMEGANVM_SendAddress(WriteAddress);
309
		XPROGTarget_SendByte(0x00);
310
311
312
313
314
	}

	return true;
}

315
316
317
318
/** 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
319
 *
320
 *  \return Boolean true if the command sequence complete successfully
321
 */
322
bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
323
{
324
	/* Wait until the NVM controller is no longer busy */
325
	if (!(XMEGANVM_WaitWhileNVMControllerBusy()))
326
327
328
	  return false;
	  
	/* Send the memory erase command to the target */
329
	XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
330
	XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CMD);
331
	XPROGTarget_SendByte(EraseCommand);
332
	
333
	/* Chip erase is handled separately, since it's procedure is different to other erase types */
334
	if (EraseCommand == XMEGA_NVM_CMD_CHIPERASE)
335
336
	{
		/* Set CMDEX bit in NVM CTRLA register to start the chip erase */
337
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
338
		XMEGANVM_SendNVMRegAddress(XMEGA_NVM_REG_CTRLA);
339
		XPROGTarget_SendByte(1 << 0);		
340
341
342
343
	}
	else
	{
		/* Other erase modes just need us to address a byte within the target memory space */
344
		XPROGTarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
345
		XMEGANVM_SendAddress(Address);
346
		XPROGTarget_SendByte(0x00);
347
348
	}
	
349
	/* Wait until the NVM bus is ready again */
350
	if (!(XMEGANVM_WaitWhileNVMBusBusy()))
351
352
353
	  return false;
	  
	return true;
354
355
}

356
#endif