TINYNVM.c 7.82 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
#warning TPI Protocol support is currently incomplete and is not suitable for general use.
41

42
/** Sends the given pointer address to the target's TPI pointer register */
43
static void TINYNVM_SendPointerAddress(const uint16_t AbsoluteAddress)
44
45
46
47
48
49
50
51
{
	/* 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]);
}

52
53
/** Sends a SIN command to the target with the specified I/O address, ready for the data byte to be written.
 *
54
 *  \param[in] Address  6-bit I/O address to write to in the target's I/O memory space
55
 */
56
static void TINYNVM_SendReadNVMRegister(const uint8_t Address)
57
{
58
	/* The TPI command for reading from the I/O space uses strange addressing, where the I/O address's upper
59
60
61
62
63
64
	 * 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.
 *
65
 *  \param[in] Address  6-bit I/O address to read from in the target's I/O memory space
66
 */
67
static void TINYNVM_SendWriteNVMRegister(const uint8_t Address)
68
69
70
71
72
73
{
	/* The TPI command for writing to the I/O space uses wierd addressing, where the I/O address's upper
	 * two bits of the 6-bit address are shifted left once */
	XPROGTarget_SendByte(TPI_CMD_SOUT | ((Address & 0x30) << 1) | (Address & 0x0F));
}

74
/** Busy-waits while the NVM controller is busy performing a NVM operation, such as a FLASH page read.
75
76
77
 *
 *  \return Boolean true if the NVM controller became ready within the timeout period, false otherwise
 */
78
bool TINYNVM_WaitWhileNVMBusBusy(void)
79
{
80
	/* Poll the STATUS register to check to see if NVM access has been enabled */
81
	while (TimeoutMSRemaining)
82
83
84
85
86
87
	{
		/* 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);
		if (XPROGTarget_ReceiveByte() & TPI_STATUS_NVM)
		  return true;
	}
88
89
90
91
	
	return false;
}

92
93
94
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
 */
bool TINYNVM_WaitWhileNVMControllerBusy(void)
{
	/* Poll the STATUS register to check to see if NVM access has been enabled */
	while (TimeoutMSRemaining)
	{
102
		/* Send the SIN command to read the TPI STATUS register to see the NVM bus is busy */
103
		TINYNVM_SendReadNVMRegister(XPROG_Param_NVMCSRRegAddr);
104
105
106

		/* Check to see if the BUSY flag is still set */
		if (!(XPROGTarget_ReceiveByte() & (1 << 7)))
107
108
109
110
111
112
		  return true;
	}
	
	return false;
}

113
114
115
116
/** 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
117
 *  \param[in]  ReadSize     Length of the data to read from the device
118
119
120
 *
 *  \return Boolean true if the command sequence complete successfully
 */
121
bool TINYNVM_ReadMemory(const uint16_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize)
122
{
123
124
125
126
127
	/* 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 */
128
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
129
130
131
132
133
134
135
136
137
138
139
	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();
	}
140
141
142
143
	
	return true;
}

144
/** Writes word addressed memory to the target's memory spaces.
145
146
147
 *
 *  \param[in]  WriteAddress  Start address to write to within the target's address space
 *  \param[in]  WriteBuffer   Buffer to source data from
148
 *  \param[in]  WriteLength   Total number of bytes to write to the device (must be an integer multiple of 2)
149
 *
150
151
 *  \return Boolean true if the command sequence complete successfully
 */
152
bool TINYNVM_WriteMemory(const uint16_t WriteAddress, uint8_t* WriteBuffer, uint16_t WriteLength)
153
{
154
155
156
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
	  return false;
157
	  
158
	/* Must have an integer number of words to write - if extra byte, word-align via a dummy high byte */
159
	if (WriteLength & 0x01)
160
	  WriteBuffer[WriteLength++] = 0xFF;
161
162

	/* Set the NVM control register to the WORD WRITE command for memory reading */
163
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
164
165
166
167
168
	XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
	
	/* Send the address of the location to write to */
	TINYNVM_SendPointerAddress(WriteAddress);
	
169
	while (WriteLength)
170
	{
171
172
173
174
175
		/* Wait until the NVM controller is no longer busy */
		if (!(TINYNVM_WaitWhileNVMControllerBusy()))
		  return false;

		/* Write the low byte of data to the target */
176
177
		XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
		XPROGTarget_SendByte(*(WriteBuffer++));
178
179
180
181
182
183
184
		
		/* 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;
185
	}
186
187
188
189
	
	return true;
}

190
/** Erases the target's memory space.
191
192
 *
 *  \param[in] Address  Address inside the memory space to erase
193
194
195
 *
 *  \return Boolean true if the command sequence complete successfully
 */
196
bool TINYNVM_EraseMemory(const uint8_t EraseCommand, const uint16_t Address)
197
{
198
199
200
201
	/* Wait until the NVM controller is no longer busy */
	if (!(TINYNVM_WaitWhileNVMControllerBusy()))
	  return false;

202
	/* Set the NVM control register to the target memory erase command */
203
	TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
204
205
206
207
208
209
	XPROGTarget_SendByte(EraseCommand);

	/* Write to a location within the target address space to start the erase process */
	TINYNVM_SendPointerAddress(Address);
	XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT);
	XPROGTarget_SendByte(0x00);
210
211
212
213

	/* Wait until the NVM bus is ready again */
	if (!(TINYNVM_WaitWhileNVMBusBusy()))
	  return false;
214
215
216
	
	return true;
}
217
218

#endif