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