tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 disclaims 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  *  <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_A3BU_XPLAINED_H__
  54 #define __DATAFLASH_A3BU_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                DATAFLASH_CHIP1
  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 appropriate SPI interface will be automatically configured.
  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                                 SerialSPI_Init(&USARTD0, (USART_SPI_SCK_LEAD_RISING | USART_SPI_SAMPLE_LEADING | USART_SPI_ORDER_MSB_FIRST), (F_CPU / 2));
 102
 103                                 PORTD.DIRSET   = PIN3_bm | PIN1_bm;
 104                                 PORTD.DIRCLR   = PIN2_bm;
 105                                 PORTC.PIN2CTRL = PORT_OPC_PULLUP_gc;
 106                         }
 107
 108                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 109                          *
 110                          *  \param[in] Byte  Byte of data to send to the dataflash
 111                          *
 112                          *  \return Last response byte from the dataflash
 113                          */
 114                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 115                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 116                         {
 117                                 return SerialSPI_TransferByte(&USARTD0, Byte);
 118                         }
 119
 120                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 121                          *
 122                          *  \param[in] Byte  Byte of data to send to the dataflash
 123                          */
 124                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 125                         static inline void Dataflash_SendByte(const uint8_t Byte)
 126                         {
 127                                 SerialSPI_SendByte(&USARTD0, Byte);
 128                         }
 129
 130                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 131                          *
 132                          *  \return Last response byte from the dataflash
 133                          */
 134                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 135                         static inline uint8_t Dataflash_ReceiveByte(void)
 136                         {
 137                                 return SerialSPI_ReceiveByte(&USARTD0);
 138                         }
 139
 140                         /** Determines the currently selected dataflash chip.
 141                          *
 142                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 143                          *          or a DATAFLASH_CHIPn mask (where n is the chip number).
 144                          */
 145                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 146                         static inline uint8_t Dataflash_GetSelectedChip(void)
 147                         {
 148                                 return (DATAFLASH_CHIPCS_PORT.OUT & DATAFLASH_CHIPCS_MASK);
 149                         }
 150
 151                         /** Selects the given dataflash chip.
 152                          *
 153                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of a \c DATAFLASH_CHIPn mask (where n is
 154                          *              the chip number).
 155                          */
 156                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 157                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 158                         {
 159                                 DATAFLASH_CHIPCS_PORT.OUTCLR = DATAFLASH_CHIPCS_MASK;
 160                                 DATAFLASH_CHIPCS_PORT.OUTSET = ChipMask;
 161                         }
 162
 163                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 164                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 165                         static inline void Dataflash_DeselectChip(void)
 166                         {
 167                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 168                         }
 169
 170                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 171                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 172                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 173                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 174                          *  are deselected.
 175                          *
 176                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 177                          *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 178                          */
 179                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 180                         {
 181                                 Dataflash_DeselectChip();
 182
 183                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 184                                   return;
 185
 186                                 Dataflash_SelectChip(DATAFLASH_CHIP1);
 187                         }
 188
 189                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 190                          *  a new command.
 191                          */
 192                         static inline void Dataflash_ToggleSelectedChipCS(void)
 193                         {
 194                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 195
 196                                 Dataflash_DeselectChip();
 197                                 Dataflash_SelectChip(SelectedChipMask);
 198                         }
 199
 200                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 201                          *  memory page program or main memory to buffer transfer.
 202                          */
 203                         static inline void Dataflash_WaitWhileBusy(void)
 204                         {
 205                                 Dataflash_ToggleSelectedChipCS();
 206                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 207                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 208                                 Dataflash_ToggleSelectedChipCS();
 209                         }
 210
 211                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 212                          *  dataflash commands which require a complete 24-bit address.
 213                          *
 214                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 215                          *  \param[in] BufferByte   Address within the dataflash's buffer
 216                          */
 217                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 218                                                                       const uint16_t BufferByte)
 219                         {
 220                                 Dataflash_SendByte(PageAddress >> 5);
 221                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 222                                 Dataflash_SendByte(BufferByte);
 223                         }
 224
 225 #endif
 226
 227 /** @} */
 228