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