tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Board/AVR8/USBKEY/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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                (DATAFLASH_CHIP1 | DATAFLASH_CHIP2)
  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                    0
  82
  83                         /** Mask for the first dataflash chip selected. */
  84                         #define DATAFLASH_CHIP1                      (1 << 0)
  85
  86                         /** Mask for the second dataflash chip selected. */
  87                         #define DATAFLASH_CHIP2                      (1 << 1)
  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 appropriate SPI interface will be automatically configured.
  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                                 SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 105                         }
 106
 107                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 108                          *
 109                          *  \param[in] Byte  Byte of data to send to the dataflash
 110                          *
 111                          *  \return Last response byte from the dataflash
 112                          */
 113                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 114                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 115                         {
 116                                 return SPI_TransferByte(Byte);
 117                         }
 118
 119                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 120                          *
 121                          *  \param[in] Byte  Byte of data to send to the dataflash
 122                          */
 123                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 124                         static inline void Dataflash_SendByte(const uint8_t Byte)
 125                         {
 126                                 SPI_SendByte(Byte);
 127                         }
 128
 129                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 130                          *
 131                          *  \return Last response byte from the dataflash
 132                          */
 133                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 134                         static inline uint8_t Dataflash_ReceiveByte(void)
 135                         {
 136                                 return SPI_ReceiveByte();
 137                         }
 138
 139                         /** Determines the currently selected dataflash chip.
 140                          *
 141                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 142                          *          or a DATAFLASH_CHIPn mask (where n is the chip number).
 143                          */
 144                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 145                         static inline uint8_t Dataflash_GetSelectedChip(void)
 146                         {
 147                                 return (~DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 148                         }
 149
 150                         /** Selects the given dataflash chip.
 151                          *
 152                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of a \c DATAFLASH_CHIPn mask (where n is
 153                          *              the chip number).
 154                          */
 155                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 156                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 157                         {
 158                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT | DATAFLASH_CHIPCS_MASK) & ~ChipMask);
 159                         }
 160
 161                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 162                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 163                         static inline void Dataflash_DeselectChip(void)
 164                         {
 165                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 166                         }
 167
 168                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 169                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 170                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 171                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 172                          *  are deselected.
 173                          *
 174                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 175                          *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 176                          */
 177                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 178                         {
 179                                 Dataflash_DeselectChip();
 180
 181                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 182                                   return;
 183
 184                                 #if (DATAFLASH_TOTALCHIPS == 2)
 185                                         if (PageAddress & 0x01)
 186                                           Dataflash_SelectChip(DATAFLASH_CHIP2);
 187                                         else
 188                                           Dataflash_SelectChip(DATAFLASH_CHIP1);
 189                                 #else
 190                                         Dataflash_SelectChip(DATAFLASH_CHIP1);
 191                                 #endif
 192                         }
 193
 194                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 195                          *  a new command.
 196                          */
 197                         static inline void Dataflash_ToggleSelectedChipCS(void)
 198                         {
 199                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 200
 201                                 Dataflash_DeselectChip();
 202                                 Dataflash_SelectChip(SelectedChipMask);
 203                         }
 204
 205                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 206                          *  memory page program or main memory to buffer transfer.
 207                          */
 208                         static inline void Dataflash_WaitWhileBusy(void)
 209                         {
 210                                 Dataflash_ToggleSelectedChipCS();
 211                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 212                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 213                                 Dataflash_ToggleSelectedChipCS();
 214                         }
 215
 216                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 217                          *  dataflash commands which require a complete 24-bit address.
 218                          *
 219                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 220                          *  \param[in] BufferByte   Address within the dataflash's buffer
 221                          */
 222                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 223                                                                       const uint16_t BufferByte)
 224                         {
 225                                 #if (DATAFLASH_TOTALCHIPS == 2)
 226                                         PageAddress >>= 1;
 227                                 #endif
 228
 229                                 Dataflash_SendByte(PageAddress >> 5);
 230                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 231                                 Dataflash_SendByte(BufferByte);
 232                         }
 233
 234 #endif
 235
 236 /** @} */
 237