TINYNVM.c 8.64 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
33
34
35
36
37
38
  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 TINY target's NVM module.
 */

#define  INCLUDE_FROM_TINYNVM_C
#include "TINYNVM.h"

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

41
/** Sends the given pointer address to the target's TPI pointer register */
42
static void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
43
44
45
46
47
48
49
50
{
	/* Send the given 16-bit address to the target, LSB first */
	XPROGTarget_SendByte(TPI_CMD_SSTPR | 0);
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[0]);
	XPROGTarget_SendByte(TPI_CMD_SSTPR | 1);
	XPROGTarget_SendByte(((uint8_t*)&AbsoluteAddress)[1]);
}

51
52
/** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
 *
53
 *  \param[in] Address  6-bit I/O address to write to in the target's I/O memory space
54
 */
55
static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
56
{
57
	/* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
58
59
60
61
62
63
	 * two bits of the 6-bit address are shifted left once */
	XPROGTarget_SendByte(TPI_CMD_SIN | ((Address & 0x30) << 1) | (Address & 0x0F));
}

/** Sends a SOUT command to the target with the specified I/O address, ready for the data byte to be read.
 *
64
 *  \param[in] Address  6-bit I/O address to read from in the target's I/O memory space
65
 */
66
static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
67
{
68
	/* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
69
70
71
72
	 * two bits of the 6-bit address are shifted left once */
	XPROGTarget_SendByte(TPI_CMD_SOUT | ((Address & 0x30) << 1) | (Address & 0x0F));
}

73
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
74
75
76
 *
 *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 */
77
bool TINYNVM_WaitWhileNVMBusBusy(void)
78
{
79
	/* Poll the STATUS register to check to see if NVM access has been enabled */
80
	while (TimeoutMSRemaining)
81
82
83
	{
		/* Send the SLDCS command to read the TPI STATUS register to see the NVM bus is active */
		XPROGTarget_SendByte(TPI_CMD_SLDCS | TPI_STATUS_REG);
84
85
86
87
88
89
90
91
92

		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 & TPI_STATUS_NVM)
93
94
95
96
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
97
98
99

		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
100
		{
101
102
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
103
		}
104
	}
105

106
107
108
	return false;
}

109
110
111
112
113
114
115
116
117
118
/** 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
 */
bool TINYNVM_WaitWhileNVMControllerBusy(void)
{
	/* Poll the STATUS register to check to see if NVM access has been enabled */
	while (TimeoutMSRemaining)
	{
119
		/* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
120
		TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
121

122
123
124
125
126
127
		uint8_t StatusRegister = XPROGTarget_ReceiveByte();

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

128
		/* Check to see if the BUSY flag is still set */
129
		if (!(StatusRegister & (1 << 7)))
130
131
132
133
		{
			TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
			return true;
		}
134
135
136

		/* Manage software timeout */
		if (TIFR0 & (1 << OCF0A))
137
		{
138
139
			TIFR0 |= (1 << OCF0A);
			TimeoutMSRemaining--;
140
		}
141
	}
142

143
144
145
	return false;
}

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
150
 *  \param[in]  ReadSize     Length of the data to read from the device
151
152
153
 *
 *  \return Boolean true if the command sequence complete successfully
 */
154
bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
155
{
156
157
158
159
160
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
	  return false;

	/* Set the NVM control register to the NO OP command for memory reading */
161
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
162
163
164
165
166
167
168
169
170
171
172
	XPROGTarget_SendByte(TINY_NVM_CMD_NOOP);
	
	/* Send the address of the location to read from */
	TINYNVM_SendPointerAddress(ReadAddress);
	
	while (ReadSize--)
	{
		/* Read the byte of data from the target */
		XPROGTarget_SendByte(TPI_CMD_SLD | TPI_POINTER_INDIRECT_PI);
		*(ReadBuffer++) = XPROGTarget_ReceiveByte();
	}
173
174
175
176
	
	return true;
}

177
/** Writes word addressed memory to the target's memory spaces.
178
 *
179
180
181
 *  \param[in] WriteAddress  Start address to write to within the target's address space
 *  \param[in] WriteBuffer   Buffer to source data from
 *  \param[in] WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
182
 *
183
184
 *  \return Boolean true if the command sequence complete successfully
 */
185
bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteLength)
186
{
187
188
189
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
	  return false;
190
	  
191
	/* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
192
	if (WriteLength & 0x01)
193
	  WriteBuffer[WriteLength++] = 0xFF;
194
195

	/* Set the NVM control register to the WORD WRITE command for memory reading */
196
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
197
198
199
200
201
	XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
	
	/* Send the address of the location to write to */
	TINYNVM_SendPointerAddress(WriteAddress);
	
202
	while (WriteLength)
203
	{
204
205
206
207
		/* Wait until the NVM controller is no longer busy */
		if (!(TINYNVM_WaitWhileNVMControllerBusy()))
		  return false;

208
		/* Write the low byte of data to the target */
209
210
		XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
		XPROGTarget_SendByte(*(WriteBuffer++));
211
212
213
214
215
216
217
		
		/* Write the high byte of data to the target */
		XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
		XPROGTarget_SendByte(*(WriteBuffer++));

		/* Need to decrement the write length twice, since we read out a whole word */
		WriteLength -= 2;
218
	}
219
220
221
222
	
	return true;
}

223
/** Erases the target's memory space.
224
 *
225
226
 *  \param[in] EraseCommand  NVM erase command to send to the device
 *  \param[in] Address       Address inside the memory space to erase
227
228
229
 *
 *  \return Boolean true if the command sequence complete successfully
 */
230
bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
231
{
232
233
234
235
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
	  return false;

236
	/* Set the NVM control register to the target memory erase command */
237
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
238
239
	XPROGTarget_SendByte(EraseCommand);

240
241
	/* Write to a high byte location within the target address space to start the erase process */
	TINYNVM_SendPointerAddress(Address | 0x0001);
242
243
	XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT);
	XPROGTarget_SendByte(0x00);
244

245
246
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
247
	  return false;
248
249
250
	
	return true;
}
251
252

#endif