Dataflash.h 9.92 KB
 Dean Camera committed May 08, 2010 1 2 /* LUFA Library  Dean Camera committed Jan 01, 2011 3  Copyright (C) Dean Camera, 2011.  4   Dean Camera committed May 08, 2010 5  dean [at] fourwalledcubicle [dot] com  Dean Camera committed Oct 28, 2010 6  www.lufa-lib.org  Dean Camera committed May 08, 2010 7 8 9 */ /*  Dean Camera committed Jan 01, 2011 10  Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)  Dean Camera committed May 08, 2010 11   12  Permission to use, copy, modify, distribute, and sell this  Dean Camera committed May 08, 2010 13  software and its documentation for any purpose is hereby granted  14  without fee, provided that the above copyright notice appear in  Dean Camera committed May 08, 2010 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  Dean Camera committed May 08, 2010 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39  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 * \brief Master include file for the board dataflash IC driver. * * 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. *  Dean Camera committed Jan 08, 2011 40  * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project  Dean Camera committed May 08, 2010 41  * directory.  Dean Camera committed Sep 03, 2010 42  *  Dean Camera committed Jan 08, 2011 43  * For possible \c BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed May 08, 2010 44  */  45   Dean Camera committed May 08, 2010 46 47 48 49 50 51 52 /** \ingroup Group_BoardDrivers * @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - None *  Dean Camera committed Dec 26, 2010 53  * \section Sec_ModDescription Module Description  Dean Camera committed May 08, 2010 54 55 56  * 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. *  Dean Camera committed Jan 08, 2011 57  * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project  Dean Camera committed May 08, 2010 58 59  * directory. Otherwise, it will include the appropriate built in board driver header file. *  Dean Camera committed Jan 08, 2011 60  * For possible \c BOARD makefile values, see \ref Group_BoardTypes.  Dean Camera committed Sep 03, 2010 61  *  Dean Camera committed Dec 26, 2010 62 63 64 65  * \section Sec_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical * application. *  Dean Camera committed Dec 26, 2010 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112  * \code * // Initialise the SPI and board Dataflash drivers before first use * SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | * SPI_SAMPLE_TRAILING | SPI_MODE_MASTER); * Dataflash_Init(); * * uint8_t WriteBuffer[DATAFLASH_PAGE_SIZE]; * uint8_t ReadBuffer[DATAFLASH_PAGE_SIZE]; * * // Fill page write buffer with a repeating pattern * for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++) * WriteBuffer[i] = (i & 0xFF); * * // Must select the chip of interest first before operating on it * Dataflash_SelectChip(DATAFLASH_CHIP1); * * // Write to the Dataflash's first internal memory buffer * printf("Writing data to first dataflash buffer:\r\n"); * Dataflash_SendByte(DF_CMD_BUFF1WRITE); * Dataflash_SendAddressBytes(0, 0); * * for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++) * Dataflash_SendByte(WriteBuffer[i]); * * // Commit the Dataflash's first memory buffer to the non-voltatile FLASH memory * printf("Committing page to non-volatile memory page index 5:\r\n"); * Dataflash_SendByte(DF_CMD_BUFF1TOMAINMEMWITHERASE); * Dataflash_SendAddressBytes(5, 0); * Dataflash_WaitWhileBusy(); * * // Read the page from non-voltatile FLASH memory into the Dataflash's second memory buffer * printf("Reading data into second dataflash buffer:\r\n"); * Dataflash_SendByte(DF_CMD_MAINMEMTOBUFF2); * Dataflash_SendAddressBytes(5, 0); * Dataflash_WaitWhileBusy(); * * // Read the Dataflash's second internal memory buffer * Dataflash_SendByte(DF_CMD_BUFF2READ); * Dataflash_SendAddressBytes(0, 0); * * for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++) * ReadBuffer[i] = Dataflash_ReceiveByte(); * * // Deselect the chip after use * Dataflash_DeselectChip(); * \endcode *  Dean Camera committed May 08, 2010 113 114  * @{ */  115   Dean Camera committed May 08, 2010 116 117 118 119 120 121 122 123 124 125 126 127 #ifndef __DATAFLASH_H__ #define __DATAFLASH_H__ /* Macros: */ #if !defined(__DOXYGEN__) #define __INCLUDE_FROM_DATAFLASH_H #define INCLUDE_FROM_DATAFLASH_H #endif /* Includes: */ #include "../Peripheral/SPI.h" #include "../../Common/Common.h"  Dean Camera committed Jul 22, 2010 128   Dean Camera committed May 08, 2010 129 130 131 132 133 134 135 136 137 138 139  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Public Interface - May be used in end-application: */ /* Macros: */ #if !defined(__DOXYGEN__) #define __GET_DATAFLASH_MASK2(x, y) x ## y #define __GET_DATAFLASH_MASK(x) __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x) #endif  140   Dean Camera committed May 08, 2010 141 142 143 144 145 146 147  /** Retrieves the Dataflash chip select mask for the given Dataflash chip index. * * \param[in] index Index of the dataflash chip mask to retrieve * * \return Mask for the given Dataflash chip's /CS pin */ #define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index)  148   Dean Camera committed Jul 22, 2010 149  /* Inline Functions: */  Dean Camera committed Jul 30, 2010 150  /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.  Dean Camera committed Dec 26, 2010 151 152  * * \note The AVR's SPI driver must be initialized before any of the dataflash commands are used.  Dean Camera committed Jul 22, 2010 153 154  */ static inline void Dataflash_Init(void);  Dean Camera committed May 08, 2010 155   Dean Camera committed Jul 22, 2010 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  Dean Camera committed Jan 08, 2011 159  * or a \c DATAFLASH_CHIPn mask (where n is the chip number).  Dean Camera committed Jul 22, 2010 160 161 162 163 164  */ static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; /** Selects the given dataflash chip. *  Dean Camera committed Jan 08, 2011 165  * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of \c DATAFLASH_CHIPn mask (where n is  Dean Camera committed Jul 22, 2010 166 167 168 169 170 171 172 173 174  * the chip number). */ static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; /** Deselects the current dataflash chip, so that no dataflash is selected. */ static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE; /** 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  Dean Camera committed Jan 08, 2011 175  * dataflash IC, this will select \ref DATAFLASH_CHIP1. If the given page number is outside  Dean Camera committed Jul 22, 2010 176 177 178 179 180 181 182  * 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 * ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). */ static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);  183   Dean Camera committed Jul 22, 2010 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202  /** 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); /** 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); /** 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. * * \param[in] PageAddress Page address within the selected dataflash IC * \param[in] BufferByte Address within the dataflash's buffer */ static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte);  Dean Camera committed May 08, 2010 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223  /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash. * * \param[in] Byte of data to send to the dataflash * * \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. * * \param[in] Byte of data to send to the dataflash */ static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE; static inline void Dataflash_SendByte(const uint8_t Byte) { SPI_SendByte(Byte); }  224   Dean Camera committed May 08, 2010 225 226 227 228 229 230 231 232 233 234 235 236  /** 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(); } /* Includes: */ #if (BOARD == BOARD_NONE)  Dean Camera committed Jan 10, 2011 237  #error The Board Dataflash driver cannot be used if the makefile BOARD option is not set.  Dean Camera committed May 08, 2010 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259  #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_XPLAIN) #include "XPLAIN/Dataflash.h" #elif (BOARD == BOARD_XPLAIN_REV1) #include "XPLAIN/Dataflash.h" #elif (BOARD == BOARD_EVK527) #include "EVK527/Dataflash.h" #elif (BOARD == BOARD_USER) #include "Board/Dataflash.h" #else #error The selected board does not contain a dataflash IC. #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  260   Dean Camera committed May 08, 2010 261 262 263 #endif /** @} */  264