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