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  *  \brief Master include file for the board dataflash IC driver.
  33  *
  34  *  This file is the master dispatch header file for the board-specific dataflash driver, for boards containing
  35  *  dataflash ICs for external non-volatile storage.
  36  *
  37  *  User code should include this file, which will in turn include the correct dataflash driver header file for
  38  *  the currently selected board.
  39  *
  40  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  41  *  directory.
  42  */
  43
  44 /** \ingroup Group_BoardDrivers
  45  *  @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h
  46  *
  47  *  \section Sec_Dependencies Module Source Dependencies
  48  *  The following files must be built with any user project that uses this module:
  49  *    - None
  50  *
  51  *  \section Module Description
  52  *  Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,
  53  *  for the storage of large amounts of data into the Dataflash's non-volatile memory.
  54  *
  55  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project
  56  *  directory. Otherwise, it will include the appropriate built in board driver header file.
  57  *
  58  *  @{
  59  */
  60
  61 #ifndef __DATAFLASH_H__
  62 #define __DATAFLASH_H__
  63
  64         /* Macros: */
  65         #if !defined(__DOXYGEN__)
  66                 #define __INCLUDE_FROM_DATAFLASH_H
  67                 #define INCLUDE_FROM_DATAFLASH_H
  68         #endif
  69
  70         /* Includes: */
  71         #include "../Peripheral/SPI.h"
  72         #include "../../Common/Common.h"
  73
  74         /* Enable C linkage for C++ Compilers: */
  75                 #if defined(__cplusplus)
  76                         extern "C" {
  77                 #endif
  78
  79         /* Public Interface - May be used in end-application: */
  80                 /* Macros: */
  81                         #if !defined(__DOXYGEN__)
  82                                 #define __GET_DATAFLASH_MASK2(x, y) x ## y
  83                                 #define __GET_DATAFLASH_MASK(x)     __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)
  84                         #endif
  85
  86                         /** Retrieves the Dataflash chip select mask for the given Dataflash chip index.
  87                          *
  88                          *  \param[in] index  Index of the dataflash chip mask to retrieve
  89                          *
  90                          *  \return Mask for the given Dataflash chip's /CS pin
  91                          */
  92                         #define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)
  93
  94                 /* Inline Functions: */
  95                         /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
  96                          *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
  97                          */
  98                         static inline void Dataflash_Init(void);
  99
 100                         /** Determines the currently selected dataflash chip.
 101                          *
 102                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 103                          *  or a DATAFLASH_CHIPn mask (where n is the chip number).
 104                          */
 105                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 106
 107                         /** Selects the given dataflash chip.
 108                          *
 109                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 110                          *              the chip number).
 111                          */
 112                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 113
 114                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 115                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 116
 117                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 118                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 119                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 120                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 121                          *  are deselected.
 122                          *
 123                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 124                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 125                          */
 126                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress);
 127
 128                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 129                          *  a new command.
 130                          */
 131                         static inline void Dataflash_ToggleSelectedChipCS(void);
 132
 133                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 134                          *  memory page program or main memory to buffer transfer.
 135                          */
 136                         static inline void Dataflash_WaitWhileBusy(void);
 137
 138                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 139                          *  dataflash commands which require a complete 24-byte address.
 140                          *
 141                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 142                          *  \param[in] BufferByte   Address within the dataflash's buffer
 143                          */
 144                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 145                                                                       const uint16_t BufferByte);
 146
 147                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
 148                          *
 149                          *  \param[in] Byte of data to send to the dataflash
 150                          *
 151                          *  \return Last response byte from the dataflash
 152                          */
 153                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 154                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 155                         {
 156                                 return SPI_TransferByte(Byte);
 157                         }
 158
 159                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 160                          *
 161                          *  \param[in] Byte of data to send to the dataflash
 162                          */
 163                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 164                         static inline void Dataflash_SendByte(const uint8_t Byte)
 165                         {
 166                                 SPI_SendByte(Byte);
 167                         }
 168
 169                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 170                          *
 171                          *  \return Last response byte from the dataflash
 172                          */
 173                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 174                         static inline uint8_t Dataflash_ReceiveByte(void)
 175                         {
 176                                 return SPI_ReceiveByte();
 177                         }
 178
 179                 /* Includes: */
 180                         #if (BOARD == BOARD_NONE)
 181                                 #error The Board Buttons driver cannot be used if the makefile BOARD option is not set.
 182                         #elif (BOARD == BOARD_USBKEY)
 183                                 #include "USBKEY/Dataflash.h"
 184                         #elif (BOARD == BOARD_STK525)
 185                                 #include "STK525/Dataflash.h"
 186                         #elif (BOARD == BOARD_STK526)
 187                                 #include "STK526/Dataflash.h"
 188                         #elif (BOARD == BOARD_XPLAIN)
 189                                 #include "XPLAIN/Dataflash.h"
 190                         #elif (BOARD == BOARD_XPLAIN_REV1)
 191                                 #include "XPLAIN/Dataflash.h"
 192                         #elif (BOARD == BOARD_EVK527)
 193                                 #include "EVK527/Dataflash.h"
 194                         #elif (BOARD == BOARD_USER)
 195                                 #include "Board/Dataflash.h"
 196                         #else
 197                                 #error The selected board does not contain a dataflash IC.
 198                         #endif
 199
 200         /* Disable C linkage for C++ Compilers: */
 201                 #if defined(__cplusplus)
 202                         }
 203                 #endif
 204
 205 #endif
 206
 207 /** @} */