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