Dataflash.h 8.33 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
41
42
/*
             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
 *
 *  This file is the master dispatch header file for the board-specific dataflash driver, for boards containing
 *  dataflash ICs for external non-volatile storage.
 *
 *  User code should include this file, which will in turn include the correct dataflash driver header file for
 *  the currently selected board.
 *
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory.
 */
 
43
44
45
/** \ingroup Group_BoardDrivers
 *  @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
 *
46
47
48
49
50
 *  \section Sec_Dependencies Module Source Dependencies
 *  The following files must be built with any user project that uses this module:
 *    - None
 *
 *  \section Module Description
Dean Camera's avatar
Dean Camera committed
51
52
 *  Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
 *  for the storage of large amounts of data into the Dataflash's non-volatile memory.
53
 *
54
55
56
 *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
 *  directory. Otherwise, it will include the appropriate built in board driver header file.
 *
57
58
59
 *  @{
 */
 
60
61
62
63
64
65
66
67
68
#ifndef __DATAFLASH_H__
#define __DATAFLASH_H__

	/* Macros: */
	#if !defined(__DOXYGEN__)
		#define INCLUDE_FROM_DATAFLASH_H
	#endif

	/* Includes: */
69
	#include "../Peripheral/SPI.h"
70
	#include "../../Common/Common.h"
71
		
72
73
74
75
76
77
	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Public Interface - May be used in end-application: */
78
79
80
81
82
83
84
85
86
87
88
89
		/* Macros: */
			#if !defined(__DOXYGEN__)
				#define __GET_DATAFLASH_MASK2(x, y) x ## y
				#define __GET_DATAFLASH_MASK(x)     __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)
			#endif
	
			/* Retrieves the Dataflash chip select mask for the given Dataflash chip index.
			 *
			 * \param index  Index of the dataflash chip mask to retrieve
			 */
			#define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)
			
90
		/* Pseudo-Function Macros: */
91
92
93
			#if defined(__DOXYGEN__)
				/** Determines the currently selected dataflash chip.
				 *
94
				 *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
95
96
97
98
99
100
				 *  or a DATAFLASH_CHIPn mask (where n is the chip number).
				 */
				static inline uint8_t Dataflash_GetSelectedChip(void);

				/** Selects the given dataflash chip.
				 *
101
102
				 *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
				 *              the chip number).
103
104
105
106
107
108
109
				 */
				static inline void Dataflash_SelectChip(uint8_t ChipMask);

				/** Deselects the current dataflash chip, so that no dataflash is selected. */
				static inline void Dataflash_DeselectChip(void);
			#else
				#define Dataflash_GetSelectedChip()          (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK)
110

111
112
113
114
115
				#define Dataflash_SelectChip(mask)   MACROS{ DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT \
															 & ~DATAFLASH_CHIPCS_MASK) | mask);              }MACROE
				
				#define Dataflash_DeselectChip()             Dataflash_SelectChip(DATAFLASH_NO_CHIP)
			#endif
116
117
118
119
			
		/* Inline Functions: */
			/** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
			 *
120
			 *  \param[in] Byte of data to send to the dataflash
121
122
123
			 *
			 *  \return Last response byte from the dataflash
			 */
124
			static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
125
126
127
128
129
130
131
			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.
			 *
132
			 *  \param[in] Byte of data to send to the dataflash
133
			 */
134
			static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
135
136
137
138
139
140
141
142
143
			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
			 */
144
			static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
145
146
147
148
			static inline uint8_t Dataflash_ReceiveByte(void)
			{
				return SPI_ReceiveByte();
			}
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

		/* Includes: */
			#if !defined(BOARD)
				#error BOARD must be set in makefile to a value specified in BoardTypes.h.
			#elif (BOARD == BOARD_USBKEY)
				#include "USBKEY/Dataflash.h"
			#elif (BOARD == BOARD_STK525)
				#include "STK525/Dataflash.h"
			#elif (BOARD == BOARD_STK526)
				#include "STK526/Dataflash.h"
			#elif (BOARD == BOARD_USER)
				#include "Board/Dataflash.h"
			#else
				#error The selected board does not contain a dataflash IC.
			#endif
164
		
165
		/* Inline Functions: */
166
167
			/** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
			 *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
168
			 */
169
			static inline void Dataflash_Init(void)
170
171
172
173
			{
				DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
				DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
			}
174
175
176
177
178
179
			
			/** 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)
			{
180
				uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
181
					
182
183
				Dataflash_DeselectChip();
				Dataflash_SelectChip(SelectedChipMask);
184
185
186
187
188
189
190
191
192
193
			}

			/** Spinloops 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));
194
				Dataflash_ToggleSelectedChipCS();				
195
196
197
198
			}

			/** 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
199
200
201
			 *  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.
202
			 *
203
204
			 *  \param[in] PageAddress  Address of the page to manipulate, ranging from
			 *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
205
			 */
206
			static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
207
208
209
210

			/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
			 *  dataflash commands which require a complete 24-byte address.
			 *
211
212
			 *  \param[in] PageAddress  Page address within the selected dataflash IC
			 *  \param[in] BufferByte   Address within the dataflash's buffer
213
			 */
214
			static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte);
215
216
217
218
219
220
221

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
	
#endif
222
223

/** @} */