Dataflash.h 7 KB
 Dean Camera committed May 08, 2010 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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 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 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) 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 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 Board specific Dataflash driver header for the USBKEY. * * Board specific Dataflash driver header for the USBKEY. * * \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. */ /** \ingroup Group_Dataflash * @defgroup Group_Dataflash_USBKEY USBKEY * * Board specific Dataflash driver header for the USBKEY board. * * \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. * * @{ */ #ifndef __DATAFLASH_USBKEY_H__ #define __DATAFLASH_USBKEY_H__ /* Includes: */ #include "AT45DB642D.h" /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_DATAFLASH_H) #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead. #endif /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define DATAFLASH_CHIPCS_MASK ((1 << 1) | (1 << 0)) #define DATAFLASH_CHIPCS_DDR DDRE #define DATAFLASH_CHIPCS_PORT PORTE #endif /* 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 2 /** Mask for no dataflash chip selected. */ #define DATAFLASH_NO_CHIP DATAFLASH_CHIPCS_MASK /** Mask for the first dataflash chip selected. */ #define DATAFLASH_CHIP1 (1 << 1) /** Mask for the second dataflash chip selected. */ #define DATAFLASH_CHIP2 (1 << 0) /** 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. */ #define DATAFLASH_PAGES 8192 /* Inline Functions: */  Dean Camera committed Jul 22, 2010 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128  /** 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. */ static inline void Dataflash_Init(void) { DATAFLASH_CHIPCS_DDR |= DATAFLASH_CHIPCS_MASK; DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK; } /** Determines the currently selected dataflash chip. * * \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected * or a DATAFLASH_CHIPn mask (where n is the chip number). */ static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; static inline uint8_t Dataflash_GetSelectedChip(void) { return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK); } /** Selects the given dataflash chip. * * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is * the chip number). */ static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; static inline void Dataflash_SelectChip(const uint8_t ChipMask) { DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask); } /** 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); }  Dean Camera committed May 08, 2010 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150  /** 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 * ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). */ static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress) { Dataflash_DeselectChip(); if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS)) return; if (PageAddress & 0x01) Dataflash_SelectChip(DATAFLASH_CHIP2); else Dataflash_SelectChip(DATAFLASH_CHIP1); }  Dean Camera committed Jul 22, 2010 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172  /** 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(); 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)); Dataflash_ToggleSelectedChipCS(); }  Dean Camera committed May 08, 2010 173 174 175 176 177 178  /** 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 */  Dean Camera committed Jul 21, 2010 179 180  static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)  Dean Camera committed May 08, 2010 181 182 183 184 185 186 187 188 189 190 191  { PageAddress >>= 1; Dataflash_SendByte(PageAddress >> 5); Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8)); Dataflash_SendByte(BufferByte); } #endif /** @} */