LUFA/Drivers/Board/AVR8/XPLAIN/Dataflash.h

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