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
void NVMTarget_SendNVMRegAddress(const uint8_t Register)
46
{
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
	NVMTarget_SendAddress(Address);
52
53
}

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

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

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

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

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

114
115
116
117
	/* Wait until the NVM bus is ready again */
	if (!(PDITarget_WaitWhileNVMBusBusy()))
	  return false;

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

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

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

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

161
162
	/* 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);
163
164
	NVMTarget_SendAddress(ReadAddress);

165
	/* Send the REPEAT command with the specified number of bytes to read */
166
167
	PDITarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
	PDITarget_SendByte(ReadSize - 1);
168
		
169
170
171
172
	/* 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();
173
174
	
	return true;
175
176
}

177
178
/** Writes byte addressed memory to the target's memory spaces.
 *
179
180
181
 *  \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
182
 *
183
 *  \return Boolean true if the command sequence complete successfully
184
 */
185
bool NVMTarget_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t* WriteBuffer)
186
{
187
188
189
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
190

191
192
193
194
	/* 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);
195
	
196
197
	/* Send new memory byte to the memory to the target */
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
198
	NVMTarget_SendAddress(WriteAddress);
199
	PDITarget_SendByte(*(WriteBuffer++));
200
201
202
203
	
	return true;
}

204
205
206
207
208
209
210
211
212
213
/** 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
 *
214
 *  \return Boolean true if the command sequence complete successfully
215
 */
216
217
218
bool NVMTarget_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
                               const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
                               const uint8_t* WriteBuffer, const uint16_t WriteSize)
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
{
	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 */
253
254
		PDITarget_SendByte(PDI_CMD_REPEAT | PDI_DATSIZE_1BYTE);
		PDITarget_SendByte(WriteSize - 1);
255
256
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
			
		/* 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;
}

282
283
284
285
/** 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
286
 *
287
 *  \return Boolean true if the command sequence complete successfully
288
 */
289
bool NVMTarget_EraseMemory(const uint8_t EraseCommand, const uint32_t Address)
290
{
291
292
293
294
295
	/* Wait until the NVM controller is no longer busy */
	if (!(NVMTarget_WaitWhileNVMControllerBusy()))
	  return false;
	  
	/* Send the memory erase command to the target */
296
297
298
299
	PDITarget_SendByte(PDI_CMD_STS | (PDI_DATSIZE_4BYTES << 2));
	NVMTarget_SendNVMRegAddress(NVM_REG_CMD);
	PDITarget_SendByte(EraseCommand);
	
300
	/* Chip erase is handled separately, since it's procedure is different to other erase types */
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
	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);
	}
	
316
317
318
319
320
	/* Wait until the NVM bus is ready again */
	if (!(PDITarget_WaitWhileNVMBusBusy()))
	  return false;
	  
	return true;
321
322
}

323
#endif