Dataflash.h 8.79 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
17
18
  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
  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
32
 *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN.
33
 *  \copydetails Group_Dataflash_XPLAIN
34
35
36
37
 *
 *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
 *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
 */
38

39
40
41
42
43
44
/** \ingroup Group_Dataflash
 *  \defgroup Group_Dataflash_XPLAIN_REV1 XPLAIN_REV1
 *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN, revision 1.
 *
 *  See \ref Group_Dataflash_XPLAIN for more details.
 */
45
46

/** \ingroup Group_Dataflash
47
 *  \defgroup Group_Dataflash_XPLAIN XPLAIN
48
49
50
 *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN.
 *
 *  \note For the first revision XPLAIN board, compile with <code>BOARD = BOARD_XPLAIN_REV1</code>.
51
 *
52
 *  Board specific Dataflash driver header for the Atmel XPLAIN.
53
 *
54
55
56
57
58
59
60
61
62
63
64
65
 *  <b>Revision 1 Boards</b>:
 *  <table>
 *    <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr>
 *    <tr><td>DATAFLASH_CHIP1</td><td>AT45DB041D (512KB)</td><td>PORTB.5</td><td>SPI0</td></tr>
 *  </table>
 *
 *  <b>Other Board Revisions</b>:
 *  <table>
 *    <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr>
 *    <tr><td>DATAFLASH_CHIP1</td><td>AT45DB642D (8MB)</td><td>PORTB.5</td><td>SPI0</td></tr>
 *  </table>
 *
66
67
68
69
70
71
72
 *  @{
 */

#ifndef __DATAFLASH_XPLAIN_H__
#define __DATAFLASH_XPLAIN_H__

	/* Includes: */
73
		#include "../../../../Common/Common.h"
74
		
75
		#include "../../../Misc/AT45DB642D.h"
76
		#include "../../../Peripheral/SPI.h"
77
78
79
80
81

	/* Preprocessor Checks: */
		#if !defined(__INCLUDE_FROM_DATAFLASH_H)
			#error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
		#endif
82

83
84
85
	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
86
			#define DATAFLASH_CHIPCS_MASK                DATAFLASH_CHIP1
87
88
89
			#define DATAFLASH_CHIPCS_DDR                 DDRB
			#define DATAFLASH_CHIPCS_PORT                PORTB
	#endif
90

91
92
93
94
95
96
	/* Public Interface - May be used in end-application: */
		/* Macros: */
			/** Constant indicating the total number of dataflash ICs mounted on the selected board. */
			#define DATAFLASH_TOTALCHIPS                 1

			/** Mask for no dataflash chip selected. */
97
			#define DATAFLASH_NO_CHIP                    0
98
99

			/** Mask for the first dataflash chip selected. */
100
			#define DATAFLASH_CHIP1                      (1 << 5)
101

102
			#if ((BOARD != BOARD_XPLAIN_REV1) || defined(__DOXYGEN__))
103
104
105
106
				/** Internal main memory page size for the board's dataflash ICs. */
				#define DATAFLASH_PAGE_SIZE              1024

				/** Total number of pages inside each of the board's dataflash ICs. */
107
				#define DATAFLASH_PAGES                  8192
108
109
110
111
			#else
				#define DATAFLASH_PAGE_SIZE              256

				#define DATAFLASH_PAGES                  2048
112
			#endif
113

114
		/* Inline Functions: */
115
			/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
116
			 *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
117
118
119
120
121
122
123
			 */
			static inline void Dataflash_Init(void)
			{
				DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
				DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
			}

124
125
			/** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
			 *
126
			 *  \param[in] Byte  Byte of data to send to the dataflash
127
128
129
130
131
132
133
134
135
136
137
			 *
			 *  \return Last response byte from the dataflash
			 */
			static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
			static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
			{
				return SPI_TransferByte(Byte);
			}

			/** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
			 *
138
			 *  \param[in] Byte  Byte of data to send to the dataflash
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
			 */
			static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
			static inline void Dataflash_SendByte(const uint8_t Byte)
			{
				SPI_SendByte(Byte);
			}

			/** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
			 *
			 *  \return Last response byte from the dataflash
			 */
			static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
			static inline uint8_t Dataflash_ReceiveByte(void)
			{
				return SPI_ReceiveByte();
			}

156
157
158
			/** Determines the currently selected dataflash chip.
			 *
			 *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
159
			 *          or a DATAFLASH_CHIPn mask (where n is the chip number).
160
161
162
163
			 */
			static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
			static inline uint8_t Dataflash_GetSelectedChip(void)
			{
164
				return (~DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
165
166
167
168
			}

			/** Selects the given dataflash chip.
			 *
Dean Camera's avatar
Dean Camera committed
169
			 *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of a \c DATAFLASH_CHIPn mask (where n is
170
171
172
173
174
			 *              the chip number).
			 */
			static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
			static inline void Dataflash_SelectChip(const uint8_t ChipMask)
			{
175
				DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT | DATAFLASH_CHIPCS_MASK) & ~ChipMask);
176
177
178
179
180
181
182
183
184
			}

			/** Deselects the current dataflash chip, so that no dataflash is selected. */
			static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
			static inline void Dataflash_DeselectChip(void)
			{
				Dataflash_SelectChip(DATAFLASH_NO_CHIP);
			}

185
186
187
188
189
190
191
			/** Selects a dataflash IC from the given page number, which should range from 0 to
			 *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
			 *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
			 *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
			 *  are deselected.
			 *
			 *  \param[in] PageAddress  Address of the page to manipulate, ranging from
192
			 *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
193
194
195
196
			 */
			static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
			{
				Dataflash_DeselectChip();
197

198
199
200
201
202
				if (PageAddress >= DATAFLASH_PAGES)
				  return;

				Dataflash_SelectChip(DATAFLASH_CHIP1);
			}
203

204
205
206
207
208
209
			/** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
			 *  a new command.
			 */
			static inline void Dataflash_ToggleSelectedChipCS(void)
			{
				uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
210

211
212
213
214
215
216
217
218
219
220
221
222
				Dataflash_DeselectChip();
				Dataflash_SelectChip(SelectedChipMask);
			}

			/** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
			 *  memory page program or main memory to buffer transfer.
			 */
			static inline void Dataflash_WaitWhileBusy(void)
			{
				Dataflash_ToggleSelectedChipCS();
				Dataflash_SendByte(DF_CMD_GETSTATUS);
				while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
223
				Dataflash_ToggleSelectedChipCS();
224
			}
225
226

			/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
227
			 *  dataflash commands which require a complete 24-bit address.
228
229
230
231
			 *
			 *  \param[in] PageAddress  Page address within the selected dataflash IC
			 *  \param[in] BufferByte   Address within the dataflash's buffer
			 */
232
233
			static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
			                                              const uint16_t BufferByte)
234
235
236
237
			{
				Dataflash_SendByte(PageAddress >> 5);
				Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
				Dataflash_SendByte(BufferByte);
238
			}
239
240
241
242

#endif

/** @} */
243