LUFA/Drivers/Board/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 index  Index of the dataflash chip mask to retrieve
  87                          */
  88                         #define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)
  89
  90                 /* Pseudo-Function Macros: */
  91                         #if defined(__DOXYGEN__)
  92                                 /** Determines the currently selected dataflash chip.
  93                                  *
  94                                  *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
  95                                  *  or a DATAFLASH_CHIPn mask (where n is the chip number).
  96                                  */
  97                                 static inline uint8_t Dataflash_GetSelectedChip(void);
  98
  99                                 /** Selects the given dataflash chip.
 100                                  *
 101                                  *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 102                                  *              the chip number).
 103                                  */
 104                                 static inline void Dataflash_SelectChip(uint8_t ChipMask);
 105
 106                                 /** Deselects the current dataflash chip, so that no dataflash is selected. */
 107                                 static inline void Dataflash_DeselectChip(void);
 108                         #else
 109                                 #define Dataflash_GetSelectedChip()          (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK)
 110
 111                                 #define Dataflash_SelectChip(mask)   MACROS{ DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT \
 112                                                                                                                          & ~DATAFLASH_CHIPCS_MASK) | mask);              }MACROE
 113
 114                                 #define Dataflash_DeselectChip()             Dataflash_SelectChip(DATAFLASH_NO_CHIP)
 115                         #endif
 116
 117                 /* Inline Functions: */
 118                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 119                          *
 120                          *  \param[in] Byte of data to send to the dataflash
 121                          *
 122                          *  \return Last response byte from the dataflash
 123                          */
 124                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 125                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 126                         {
 127                                 return SPI_TransferByte(Byte);
 128                         }
 129
 130                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 131                          *
 132                          *  \param[in] Byte of data to send to the dataflash
 133                          */
 134                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 135                         static inline void Dataflash_SendByte(const uint8_t Byte)
 136                         {
 137                                 SPI_SendByte(Byte);
 138                         }
 139
 140                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 141                          *
 142                          *  \return Last response byte from the dataflash
 143                          */
 144                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 145                         static inline uint8_t Dataflash_ReceiveByte(void)
 146                         {
 147                                 return SPI_ReceiveByte();
 148                         }
 149
 150                 /* Includes: */
 151                         #if !defined(BOARD)
 152                                 #error BOARD must be set in makefile to a value specified in BoardTypes.h.
 153                         #elif (BOARD == BOARD_USBKEY)
 154                                 #include "USBKEY/Dataflash.h"
 155                         #elif (BOARD == BOARD_STK525)
 156                                 #include "STK525/Dataflash.h"
 157                         #elif (BOARD == BOARD_STK526)
 158                                 #include "STK526/Dataflash.h"
 159                         #elif (BOARD == BOARD_USER)
 160                                 #include "Board/Dataflash.h"
 161                         #else
 162                                 #error The selected board does not contain a dataflash IC.
 163                         #endif
 164
 165                 /* Inline Functions: */
 166                         /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
 167                          *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
 168                          */
 169                         static inline void Dataflash_Init(void)
 170                         {
 171                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
 172                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
 173                         }
 174
 175                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 176                          *  a new command.
 177                          */
 178                         static inline void Dataflash_ToggleSelectedChipCS(void)
 179                         {
 180                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 181
 182                                 Dataflash_DeselectChip();
 183                                 Dataflash_SelectChip(SelectedChipMask);
 184                         }
 185
 186                         /** Spinloops while the currently selected dataflash is busy executing a command, such as a main
 187                          *  memory page program or main memory to buffer transfer.
 188                          */
 189                         static inline void Dataflash_WaitWhileBusy(void)
 190                         {
 191                                 Dataflash_ToggleSelectedChipCS();
 192                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 193                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 194                                 Dataflash_ToggleSelectedChipCS();
 195                         }
 196
 197                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 198                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 199                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 200                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 201                          *  are deselected.
 202                          *
 203                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 204                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 205                          */
 206                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
 207
 208                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 209                          *  dataflash commands which require a complete 24-byte address.
 210                          *
 211                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 212                          *  \param[in] BufferByte   Address within the dataflash's buffer
 213                          */
 214                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte);
 215
 216         /* Disable C linkage for C++ Compilers: */
 217                 #if defined(__cplusplus)
 218                         }
 219                 #endif
 220
 221 #endif
 222
 223 /** @} */