LUFA/Drivers/Board/AVR8/USBKEY/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 /** \file
  32  *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
  33  *  \copydetails Group_Dataflash_USBKEY
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
  36  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
  37  */
  38
  39 /** \ingroup Group_Dataflash
  40  *  \defgroup Group_Dataflash_USBKEY USBKEY
  41  *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
  42  *
  43  *  Board specific Dataflash driver header for the Atmel USBKEY board.
  44  *
  45  *  <table>
  46  *    <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr>
  47  *    <tr><td>DATAFLASH_CHIP1</td><td>AT45DB642D (8MB)</td><td>PORTE.0</td><td>SPI0</td></tr>
  48  *    <tr><td>DATAFLASH_CHIP2</td><td>AT45DB642D (8MB)</td><td>PORTE.1</td><td>SPI0</td></tr>
  49  *  </table>
  50  *
  51  *  @{
  52  */
  53
  54 #ifndef __DATAFLASH_USBKEY_H__
  55 #define __DATAFLASH_USBKEY_H__
  56
  57         /* Includes: */
  58                 #include "../../../../Common/Common.h"
  59                 #include "../../../Misc/AT45DB642D.h"
  60                 #include "../../../Peripheral/SPI.h"
  61
  62         /* Preprocessor Checks: */
  63                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  64                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  65                 #endif
  66
  67         /* Private Interface - For use in library only: */
  68         #if !defined(__DOXYGEN__)
  69                 /* Macros: */
  70                         #define DATAFLASH_CHIPCS_MASK                ((1 << 1) | (1 << 0))
  71                         #define DATAFLASH_CHIPCS_DDR                 DDRE
  72                         #define DATAFLASH_CHIPCS_PORT                PORTE
  73         #endif
  74
  75         /* Public Interface - May be used in end-application: */
  76                 /* Macros: */
  77                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  78                         #define DATAFLASH_TOTALCHIPS                 2
  79
  80                         /** Mask for no dataflash chip selected. */
  81                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  82
  83                         /** Mask for the first dataflash chip selected. */
  84                         #define DATAFLASH_CHIP1                      (1 << 1)
  85
  86                         /** Mask for the second dataflash chip selected. */
  87                         #define DATAFLASH_CHIP2                      (1 << 0)
  88
  89                         /** Internal main memory page size for the board's dataflash ICs. */
  90                         #define DATAFLASH_PAGE_SIZE                  1024
  91
  92                         /** Total number of pages inside each of the board's dataflash ICs. */
  93                         #define DATAFLASH_PAGES                      8192
  94
  95                 /* Inline Functions: */
  96                         /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
  97                          *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
  98                          */
  99                         static inline void Dataflash_Init(void)
 100                         {
 101                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
 102                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
 103                         }
 104
 105                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 106                          *
 107                          *  \param[in] Byte  Byte of data to send to the dataflash
 108                          *
 109                          *  \return Last response byte from the dataflash
 110                          */
 111                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 112                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 113                         {
 114                                 return SPI_TransferByte(Byte);
 115                         }
 116
 117                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 118                          *
 119                          *  \param[in] Byte  Byte of data to send to the dataflash
 120                          */
 121                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 122                         static inline void Dataflash_SendByte(const uint8_t Byte)
 123                         {
 124                                 SPI_SendByte(Byte);
 125                         }
 126
 127                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 128                          *
 129                          *  \return Last response byte from the dataflash
 130                          */
 131                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 132                         static inline uint8_t Dataflash_ReceiveByte(void)
 133                         {
 134                                 return SPI_ReceiveByte();
 135                         }
 136
 137                         /** Determines the currently selected dataflash chip.
 138                          *
 139                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 140                          *  or a DATAFLASH_CHIPn mask (where n is the chip number).
 141                          */
 142                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 143                         static inline uint8_t Dataflash_GetSelectedChip(void)
 144                         {
 145                                 return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 146                         }
 147
 148                         /** Selects the given dataflash chip.
 149                          *
 150                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 151                          *              the chip number).
 152                          */
 153                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 154                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 155                         {
 156                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
 157                         }
 158
 159                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 160                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 161                         static inline void Dataflash_DeselectChip(void)
 162                         {
 163                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 164                         }
 165
 166                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 167                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 168                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 169                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 170                          *  are deselected.
 171                          *
 172                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 173                          *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 174                          */
 175                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 176                         {
 177                                 Dataflash_DeselectChip();
 178
 179                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 180                                   return;
 181
 182                                 if (PageAddress & 0x01)
 183                                   Dataflash_SelectChip(DATAFLASH_CHIP2);
 184                                 else
 185                                   Dataflash_SelectChip(DATAFLASH_CHIP1);
 186                         }
 187
 188                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 189                          *  a new command.
 190                          */
 191                         static inline void Dataflash_ToggleSelectedChipCS(void)
 192                         {
 193                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 194
 195                                 Dataflash_DeselectChip();
 196                                 Dataflash_SelectChip(SelectedChipMask);
 197                         }
 198
 199                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 200                          *  memory page program or main memory to buffer transfer.
 201                          */
 202                         static inline void Dataflash_WaitWhileBusy(void)
 203                         {
 204                                 Dataflash_ToggleSelectedChipCS();
 205                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 206                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 207                                 Dataflash_ToggleSelectedChipCS();
 208                         }
 209
 210                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 211                          *  dataflash commands which require a complete 24-bit address.
 212                          *
 213                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 214                          *  \param[in] BufferByte   Address within the dataflash's buffer
 215                          */
 216                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 217                                                                       const uint16_t BufferByte)
 218                         {
 219                                 PageAddress >>= 1;
 220
 221                                 Dataflash_SendByte(PageAddress >> 5);
 222                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 223                                 Dataflash_SendByte(BufferByte);
 224                         }
 225
 226 #endif
 227
 228 /** @} */
 229