LUFA/Drivers/Board/AVR8/STK526/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_STK526
  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_STK526 STK526
  41  *  \brief Board specific Dataflash driver header for the Atmel STK525.
  42  *
  43  *  Board specific Dataflash driver header for the Atmel STK525.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __DATAFLASH_STK526_H__
  49 #define __DATAFLASH_STK526_H__
  50
  51         /* Includes: */
  52                 #include "../../../../Common/Common.h"
  53                 #include "../../../Misc/AT45DB642D.h"
  54
  55         /* Preprocessor Checks: */
  56                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  57                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  58                 #endif
  59
  60         /* Private Interface - For use in library only: */
  61         #if !defined(__DOXYGEN__)
  62                 /* Macros: */
  63                         #define DATAFLASH_CHIPCS_MASK                (1 << 2)
  64                         #define DATAFLASH_CHIPCS_DDR                 DDRC
  65                         #define DATAFLASH_CHIPCS_PORT                PORTC
  66         #endif
  67
  68         /* Public Interface - May be used in end-application: */
  69                 /* Macros: */
  70                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  71                         #define DATAFLASH_TOTALCHIPS                 1
  72
  73                         /** Mask for no dataflash chip selected. */
  74                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  75
  76                         /** Mask for the first dataflash chip selected. */
  77                         #define DATAFLASH_CHIP1                      0
  78
  79                         /** Internal main memory page size for the board's dataflash IC. */
  80                         #define DATAFLASH_PAGE_SIZE                  1024
  81
  82                         /** Total number of pages inside the board's dataflash IC. */
  83                         #define DATAFLASH_PAGES                      8192
  84
  85                 /* Inline Functions: */
  86                         /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
  87                          *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
  88                          */
  89                         static inline void Dataflash_Init(void)
  90                         {
  91                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
  92                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
  93                         }
  94
  95                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
  96                          *
  97                          *  \param[in] Byte of data to send to the dataflash
  98                          *
  99                          *  \return Last response byte from the dataflash
 100                          */
 101                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 102                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 103                         {
 104                                 return SPI_TransferByte(Byte);
 105                         }
 106
 107                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 108                          *
 109                          *  \param[in] Byte of data to send to the dataflash
 110                          */
 111                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 112                         static inline void Dataflash_SendByte(const uint8_t Byte)
 113                         {
 114                                 SPI_SendByte(Byte);
 115                         }
 116
 117                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 118                          *
 119                          *  \return Last response byte from the dataflash
 120                          */
 121                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 122                         static inline uint8_t Dataflash_ReceiveByte(void)
 123                         {
 124                                 return SPI_ReceiveByte();
 125                         }
 126
 127                         /** Determines the currently selected dataflash chip.
 128                          *
 129                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 130                          *  or a DATAFLASH_CHIPn mask (where n is the chip number).
 131                          */
 132                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 133                         static inline uint8_t Dataflash_GetSelectedChip(void)
 134                         {
 135                                 return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 136                         }
 137
 138                         /** Selects the given dataflash chip.
 139                          *
 140                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 141                          *              the chip number).
 142                          */
 143                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 144                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 145                         {
 146                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
 147                         }
 148
 149                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 150                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 151                         static inline void Dataflash_DeselectChip(void)
 152                         {
 153                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 154                         }
 155
 156                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 157                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 158                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 159                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 160                          *  are deselected.
 161                          *
 162                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 163                          *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 164                          */
 165                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 166                         {
 167                                 Dataflash_DeselectChip();
 168
 169                                 if (PageAddress >= DATAFLASH_PAGES)
 170                                   return;
 171
 172                                 Dataflash_SelectChip(DATAFLASH_CHIP1);
 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                         /** Spin-loops 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                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 198                          *  dataflash commands which require a complete 24-bit address.
 199                          *
 200                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 201                          *  \param[in] BufferByte   Address within the dataflash's buffer
 202                          */
 203                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 204                                                                       const uint16_t BufferByte)
 205                         {
 206                                 Dataflash_SendByte(PageAddress >> 5);
 207                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 208                                 Dataflash_SendByte(BufferByte);
 209                         }
 210
 211 #endif
 212
 213 /** @} */
 214