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