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