LUFA/Drivers/Board/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *
  33  *  This file is the master dispatch header file for the board-specific dataflash driver, for boards containing
  34  *  dataflash ICs for external non-volatile storage.
  35  *
  36  *  User code should include this file, which will in turn include the correct dataflash driver header file for
  37  *  the currently selected board.
  38  *
  39  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  40  *  directory.
  41  */
  42
  43 /** \ingroup Group_BoardDrivers
  44  *  @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
  45  *
  46  *  \section Sec_Dependencies Module Source Dependencies
  47  *  The following files must be built with any user project that uses this module:
  48  *    - None
  49  *
  50  *  \section Module Description
  51  *  Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
  52  *  for the storage of large amounts of data into the Dataflash's non-volatile memory.
  53  *
  54  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  55  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  56  *
  57  *  @{
  58  */
  59
  60 #ifndef __DATAFLASH_H__
  61 #define __DATAFLASH_H__
  62
  63         /* Macros: */
  64         #if !defined(__DOXYGEN__)
  65                 #define INCLUDE_FROM_DATAFLASH_H
  66         #endif
  67
  68         /* Includes: */
  69         #include "../Peripheral/SPI.h"
  70         #include "../../Common/Common.h"
  71
  72         /* Enable C linkage for C++ Compilers: */
  73                 #if defined(__cplusplus)
  74                         extern "C" {
  75                 #endif
  76
  77         /* Public Interface - May be used in end-application: */
  78                 /* Macros: */
  79                         #if !defined(__DOXYGEN__)
  80                                 #define __GET_DATAFLASH_MASK2(x, y) x ## y
  81                                 #define __GET_DATAFLASH_MASK(x)     __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)
  82                         #endif
  83
  84                         /** Retrieves the Dataflash chip select mask for the given Dataflash chip index.
  85                          *
  86                          *  \param[in] index  Index of the dataflash chip mask to retrieve
  87                          *
  88                          *  \return Mask for the given Dataflash chip's /CS pin
  89                          */
  90                         #define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)
  91
  92                 /* Pseudo-Function Macros: */
  93                         #if defined(__DOXYGEN__)
  94                                 /** Determines the currently selected dataflash chip.
  95                                  *
  96                                  *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
  97                                  *  or a DATAFLASH_CHIPn mask (where n is the chip number).
  98                                  */
  99                                 static inline uint8_t Dataflash_GetSelectedChip(void);
 100
 101                                 /** Selects the given dataflash chip.
 102                                  *
 103                                  *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 104                                  *              the chip number).
 105                                  */
 106                                 static inline void Dataflash_SelectChip(uint8_t ChipMask);
 107
 108                                 /** Deselects the current dataflash chip, so that no dataflash is selected. */
 109                                 static inline void Dataflash_DeselectChip(void);
 110                         #else
 111                                 #define Dataflash_GetSelectedChip()          (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK)
 112
 113                                 #define Dataflash_SelectChip(mask)   MACROS{ DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT \
 114                                                                                                                          & ~DATAFLASH_CHIPCS_MASK) | (mask));            }MACROE
 115
 116                                 #define Dataflash_DeselectChip()             Dataflash_SelectChip(DATAFLASH_NO_CHIP)
 117                         #endif
 118
 119                 /* Inline Functions: */
 120                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 121                          *
 122                          *  \param[in] Byte of data to send to the dataflash
 123                          *
 124                          *  \return Last response byte from the dataflash
 125                          */
 126                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 127                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 128                         {
 129                                 return SPI_TransferByte(Byte);
 130                         }
 131
 132                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 133                          *
 134                          *  \param[in] Byte of data to send to the dataflash
 135                          */
 136                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 137                         static inline void Dataflash_SendByte(const uint8_t Byte)
 138                         {
 139                                 SPI_SendByte(Byte);
 140                         }
 141
 142                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 143                          *
 144                          *  \return Last response byte from the dataflash
 145                          */
 146                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 147                         static inline uint8_t Dataflash_ReceiveByte(void)
 148                         {
 149                                 return SPI_ReceiveByte();
 150                         }
 151
 152                 /* Includes: */
 153                         #if !defined(BOARD)
 154                                 #error BOARD must be set in makefile to a value specified in BoardTypes.h.
 155                         #elif (BOARD == BOARD_USBKEY)
 156                                 #include "USBKEY/Dataflash.h"
 157                         #elif (BOARD == BOARD_STK525)
 158                                 #include "STK525/Dataflash.h"
 159                         #elif (BOARD == BOARD_STK526)
 160                                 #include "STK526/Dataflash.h"
 161                         #elif (BOARD == BOARD_XPLAIN)
 162                                 #include "XPLAIN/Dataflash.h"
 163                         #elif (BOARD == BOARD_XPLAIN_REV1)
 164                                 #include "XPLAIN/Dataflash.h"
 165                         #elif (BOARD == BOARD_EVK527)
 166                                 #include "EVK527/Dataflash.h"
 167                         #elif (BOARD == BOARD_USER)
 168                                 #include "Board/Dataflash.h"
 169                         #else
 170                                 #error The selected board does not contain a dataflash IC.
 171                         #endif
 172
 173                 /* Inline Functions: */
 174                         /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
 175                          *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
 176                          */
 177                         static inline void Dataflash_Init(void)
 178                         {
 179                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
 180                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
 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                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 206                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 207                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 208                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 209                          *  are deselected.
 210                          *
 211                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 212                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 213                          */
 214                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
 215
 216                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 217                          *  dataflash commands which require a complete 24-byte address.
 218                          *
 219                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 220                          *  \param[in] BufferByte   Address within the dataflash's buffer
 221                          */
 222                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte);
 223
 224         /* Disable C linkage for C++ Compilers: */
 225                 #if defined(__cplusplus)
 226                         }
 227                 #endif
 228
 229 #endif
 230
 231 /** @} */