Add new tag for the LUFA-120219-BETA release.
[pub/USBasp.git] / LUFA / CodeTemplates / DriverStubs / Dataflash.h
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 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /*
32 This is a stub driver header file, for implementing custom board
33 layout hardware with compatible LUFA board specific drivers. If
34 the library is configured to use the BOARD_USER board mode, this
35 driver file should be completed and copied into the "/Board/" folder
36 inside the application's folder.
37
38 This stub is for the board-specific component of the LUFA Dataflash
39 driver.
40 */
41
42 #ifndef __DATAFLASH_USER_H__
43 #define __DATAFLASH_USER_H__
44
45 /* Includes: */
46 // TODO: Add any required includes here
47
48 /* Preprocessor Checks: */
49 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
50 #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
51 #endif
52
53 /* Private Interface - For use in library only: */
54 #if !defined(__DOXYGEN__)
55 /* Macros: */
56 #define DATAFLASH_CHIPCS_MASK // TODO: Replace this with a mask of all the /CS pins of all Dataflashes
57 #define DATAFLASH_CHIPCS_DDR // TODO: Replace with the DDR register name for the board's Dataflash ICs
58 #define DATAFLASH_CHIPCS_PORT // TODO: Replace with the PORT register name for the board's Dataflash ICs
59 #endif
60
61 /* Public Interface - May be used in end-application: */
62 /* Macros: */
63 /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
64 #define DATAFLASH_TOTALCHIPS 1 // TODO: Replace with the number of Dataflashes on the board, max 2
65
66 /** Mask for no dataflash chip selected. */
67 #define DATAFLASH_NO_CHIP DATAFLASH_CHIPCS_MASK
68
69 /** Mask for the first dataflash chip selected. */
70 #define DATAFLASH_CHIP1 // TODO: Replace with mask to hold /CS of first Dataflash low, and all others high
71
72 /** Mask for the second dataflash chip selected. */
73 #define DATAFLASH_CHIP2 // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high
74
75 /** Internal main memory page size for the board's dataflash ICs. */
76 #define DATAFLASH_PAGE_SIZE // TODO: Replace with the page size for the Dataflash ICs
77
78 /** Total number of pages inside each of the board's dataflash ICs. */
79 #define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs
80
81 /* Inline Functions: */
82 /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
83 * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
84 */
85 static inline void Dataflash_Init(void)
86 {
87 DATAFLASH_CHIPCS_DDR |= DATAFLASH_CHIPCS_MASK;
88 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
89 }
90
91 /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
92 *
93 * \param[in] Byte of data to send to the dataflash
94 *
95 * \return Last response byte from the dataflash
96 */
97 static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
98 static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
99 {
100 return SPI_TransferByte(Byte);
101 }
102
103 /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
104 *
105 * \param[in] Byte of data to send to the dataflash
106 */
107 static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
108 static inline void Dataflash_SendByte(const uint8_t Byte)
109 {
110 SPI_SendByte(Byte);
111 }
112
113 /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
114 *
115 * \return Last response byte from the dataflash
116 */
117 static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
118 static inline uint8_t Dataflash_ReceiveByte(void)
119 {
120 return SPI_ReceiveByte();
121 }
122
123 /** Determines the currently selected dataflash chip.
124 *
125 * \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
126 * or a DATAFLASH_CHIPn mask (where n is the chip number).
127 */
128 static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
129 static inline uint8_t Dataflash_GetSelectedChip(void)
130 {
131 return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
132 }
133
134 /** Selects the given dataflash chip.
135 *
136 * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
137 * the chip number).
138 */
139 static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
140 static inline void Dataflash_SelectChip(const uint8_t ChipMask)
141 {
142 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
143 }
144
145 /** Deselects the current dataflash chip, so that no dataflash is selected. */
146 static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
147 static inline void Dataflash_DeselectChip(void)
148 {
149 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
150 }
151
152 /** Selects a dataflash IC from the given page number, which should range from 0 to
153 * ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
154 * dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
155 * the total number of pages contained in the boards dataflash ICs, all dataflash ICs
156 * are deselected.
157 *
158 * \param[in] PageAddress Address of the page to manipulate, ranging from
159 * 0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
160 */
161 static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
162 {
163 Dataflash_DeselectChip();
164
165 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
166 return;
167
168 #if (DATAFLASH_TOTALCHIPS == 2)
169 if (PageAddress & 0x01)
170 Dataflash_SelectChip(DATAFLASH_CHIP2);
171 else
172 Dataflash_SelectChip(DATAFLASH_CHIP1);
173 #else
174 Dataflash_SelectChip(DATAFLASH_CHIP1);
175 #endif
176 }
177
178 /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
179 * a new command.
180 */
181 static inline void Dataflash_ToggleSelectedChipCS(void)
182 {
183 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
184
185 Dataflash_DeselectChip();
186 Dataflash_SelectChip(SelectedChipMask);
187 }
188
189 /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
190 * memory page program or main memory to buffer transfer.
191 */
192 static inline void Dataflash_WaitWhileBusy(void)
193 {
194 Dataflash_ToggleSelectedChipCS();
195 Dataflash_SendByte(DF_CMD_GETSTATUS);
196 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
197 Dataflash_ToggleSelectedChipCS();
198 }
199
200 /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
201 * dataflash commands which require a complete 24-bit address.
202 *
203 * \param[in] PageAddress Page address within the selected dataflash IC
204 * \param[in] BufferByte Address within the dataflash's buffer
205 */
206 static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
207 {
208 #if (DATAFLASH_TOTALCHIPS == 2)
209 PageAddress >>= 1;
210 #endif
211
212 Dataflash_SendByte(PageAddress >> 5);
213 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
214 Dataflash_SendByte(BufferByte);
215 }
216
217 #endif
218