NVMTarget.c 11.9 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
36
37
38
39
40
/*
             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
 *
 *  Target-related functions for the target's NVM module.
 */

#define  INCLUDE_FROM_NVMTARGET_C
#include "NVMTarget.h"

#if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)

41
42
43
44
/** Sends the given NVM register address to the target.
 *
 *  \param[in] Register  NVM register whose absolute address is to be sent
 */
45
46
void NVMTarget_SendNVMRegAddress(uint8_t Register)
{
47
	/* Determine the absolute register address from the NVM base memory address and the NVM register address */
48
49
	uint32_t Address = XPROG_Param_NVMBase | Register;

50
	/* Send the calculated 32-bit address to the target, LSB first */
51
	PDITarget_SendByte(Address &  0xFF);
52
53
54
55
56
	PDITarget_SendByte(Address >> 8);
	PDITarget_SendByte(Address >> 16);
	PDITarget_SendByte(Address >> 24);
}

57
58
59
60
/** Sends the given 32-bit absolute address to the target.
 *
 *  \param[in] AbsoluteAddress  Absolute address to send to the target
 */
61
62
void NVMTarget_SendAddress(uint32_t AbsoluteAddress)
{
63
	/* Send the given 32-bit address to the target, LSB first */
64
65
66
67
	PDITarget_SendByte(AbsoluteAddress &  0xFF);
	PDITarget_SendByte(AbsoluteAddress >> 8);
	PDITarget_SendByte(AbsoluteAddress >> 16);
	PDITarget_SendByte(AbsoluteAddress >> 24);
68
69
}

70
71
72
73
74
/** 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
 */
75
bool NVMTarget_WaitWhileNVMControllerBusy(void)
76
{
77
	TCNT0 = 0;
78
79

	/* Poll the NVM STATUS register while the NVM controller is busy */
80
	while (TCNT0 < NVM_BUSY_TIMEOUT_MS)
81
	{
82
		/* Send a LDS command to read the NVM STATUS register to check the BUSY flag */
83
		PDITarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
84
85
		NVMTarget_SendNVMRegAddress(NVM_REG_STATUS);
		
86
		/* Check to see if the BUSY flag is still set */
87
		if (!(PDITarget_ReceiveByte() & (1 << 7)))
88
		  return true;
89
	}
90
91
	
	return false;
92
93
}

94
95
/** Retrieves the CRC value of the given memory space.
 *
96
97
 *  \param[in]  CRCCommand  NVM CRC command to issue to the target
 *  \param[out] CRCDest     CRC Destination when read from the target
98
 *
99
 *  \return Boolean true if the command sequence complete successfully
100
 */
101
bool NVMTarget_GetMemoryCRC(uint8_t CRCCommand, uint32_t* CRCDest)
102
{
103
104
105
106
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
	  
107
	/* Set the NVM command to the correct CRC read command */
108
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
109
	NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
110
	PDITarget_SendByte(CRCCommand);
111
112

	/* Set CMDEX bit in NVM CTRLA register to start the CRC generation */
113
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
114
115
116
	NVMTarget_SendNVMRegAddress(NVM_REG_CTRLA);
	PDITarget_SendByte(1 << 0);

117
118
119
120
	/* Wait until the NVM bus is ready again */
	if (!(PDITarget_WaitWhileNVMBusBusy()))
	  return false;

121
122
123
124
125
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
	
	*CRCDest = 0;
126
	
127
	/* Read the first generated CRC byte value */
128
	PDITarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
129
	NVMTarget_SendNVMRegAddress(NVM_REG_DAT0);
130
	*CRCDest  = PDITarget_ReceiveByte();
131

132
	/* Read the second generated CRC byte value */
133
134
	PDITarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_DAT1);
135
	*CRCDest |= ((uint16_t)PDITarget_ReceiveByte() << 8);
136

137
	/* Read the third generated CRC byte value */
138
139
	PDITarget_SendByte(PDI_CMD_LDS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_DAT2);
140
	*CRCDest |= ((uint32_t)PDITarget_ReceiveByte() << 16);
141
	
142
	return true;
143
144
}

145
146
147
148
149
/** 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
150
 *
151
 *  \return Boolean true if the command sequence complete successfully
152
 */
153
bool NVMTarget_ReadMemory(uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
154
{
155
156
157
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
158
	
159
	/* Send the READNVM command to the NVM controller for reading of an arbitrary location */
160
161
162
163
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
	PDITarget_SendByte(NVM_CMD_READNVM);

164
165
	/* Load the PDI pointer register with the start address we want to read from */
	PDITarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
166
167
	NVMTarget_SendAddress(ReadAddress);

168
	/* Send the REPEAT command with the specified number of bytes to read */
169
170
	PDITarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	PDITarget_SendByte(ReadSize - 1);
171
		
172
173
174
175
	/* Send a LD command with indirect access and postincrement to read out the bytes */
	PDITarget_SendByte(PDI_CMD_LD | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
	for (uint16_t i = 0; i < ReadSize; i++)
	  *(ReadBuffer++) = PDITarget_ReceiveByte();
176
177
	
	return true;
178
179
}

180
181
/** Writes byte addressed memory to the target's memory spaces.
 *
182
183
184
 *  \param[in]  WriteCommand  Command to send to the device to write each memory byte
 *  \param[in]  WriteAddress  Start address to write to within the target's address space
 *  \param[in]  WriteBuffer   Buffer to source data from
185
 *
186
 *  \return Boolean true if the command sequence complete successfully
187
 */
188
bool NVMTarget_WriteByteMemory(uint8_t WriteCommand, uint32_t WriteAddress, uint8_t* WriteBuffer)
189
{
190
191
192
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
193

194
195
196
197
	/* Send the memory write command to the target */
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
	PDITarget_SendByte(WriteCommand);
198
	
199
200
201
202
	/* Send new memory byte to the memory to the target */
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendAddress(WriteAddress++);
	PDITarget_SendByte(*(WriteBuffer++));
203
204
205
206
	
	return true;
}

207
208
209
210
211
212
213
214
215
216
/** 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
 *
217
 *  \return Boolean true if the command sequence complete successfully
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 */
bool NVMTarget_WritePageMemory(uint8_t WriteBuffCommand, uint8_t EraseBuffCommand, uint8_t WritePageCommand,
                               uint8_t PageMode, uint32_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteSize)
{
	if (PageMode & XPRG_PAGEMODE_ERASE)
	{
		/* Wait until the NVM controller is no longer busy */
		if (!(NVMTarget_WaitWhileNVMControllerBusy()))
		  return false;

		/* Send the memory buffer erase command to the target */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
		PDITarget_SendByte(EraseBuffCommand);

		/* Set CMDEX bit in NVM CTRLA register to start the buffer erase */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendNVMRegAddress(NVM_REG_CTRLA);
		PDITarget_SendByte(1 << 0);
	}

	if (WriteSize)
	{
		/* Wait until the NVM controller is no longer busy */
		if (!(NVMTarget_WaitWhileNVMControllerBusy()))
		  return false;

		/* Send the memory buffer write command to the target */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
		PDITarget_SendByte(WriteBuffCommand);

		/* Load the PDI pointer register with the start address we want to write to */
		PDITarget_SendByte(PDI_CMD_ST | (PDI_POINTER_DIRECT << 2) | PDI_DATSIZE_4BYTES);
		NVMTarget_SendAddress(WriteAddress);

		/* Send the REPEAT command with the specified number of bytes to write */
255
256
		PDITarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
		PDITarget_SendByte(WriteSize - 1);
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
			
		/* Send a ST command with indirect access and postincrement to write the bytes */
		PDITarget_SendByte(PDI_CMD_ST | (PDI_POINTER_INDIRECT_PI << 2) | PDI_DATSIZE_1BYTE);
		for (uint16_t i = 0; i < WriteSize; i++)
		  PDITarget_SendByte(*(WriteBuffer++));
	}
	
	if (PageMode & XPRG_PAGEMODE_WRITE)
	{
		/* Wait until the NVM controller is no longer busy */
		if (!(NVMTarget_WaitWhileNVMControllerBusy()))
		  return false;

		/* Send the memory write command to the target */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
		PDITarget_SendByte(WritePageCommand);
		
		/* Send the address of the first page location to write the memory page */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendAddress(WriteAddress);
		PDITarget_SendByte(0x00);
	}

	return true;
}

284
285
286
287
/** 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
288
 *
289
 *  \return Boolean true if the command sequence complete successfully
290
 */
291
bool NVMTarget_EraseMemory(uint8_t EraseCommand, uint32_t Address)
292
{
293
294
295
296
297
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
	  
	/* Send the memory erase command to the target */
298
299
300
301
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
	PDITarget_SendByte(EraseCommand);
	
302
	/* Chip erase is handled separately, since it's procedure is different to other erase types */
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
	if (EraseCommand == NVM_CMD_CHIPERASE)
	{
		/* Set CMDEX bit in NVM CTRLA register to start the chip erase */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendNVMRegAddress(NVM_REG_CTRLA);
		PDITarget_SendByte(1 << 0);		
	}
	else
	{
		/* Other erase modes just need us to address a byte within the target memory space */
		PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
		NVMTarget_SendAddress(Address);	
		PDITarget_SendByte(0x00);
	}
	
318
319
320
321
322
	/* Wait until the NVM bus is ready again */
	if (!(PDITarget_WaitWhileNVMBusBusy()))
	  return false;
	  
	return true;
323
324
}

325
#endif