LUFA/Drivers/Board/USBKEY/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 USBKEY.
  33  *  \copydetails Group_Dataflash_USBKEY
  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_USBKEY USBKEY
  41  *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
  42  *
  43  *  Board specific Dataflash driver header for the Atmel USBKEY board.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __DATAFLASH_USBKEY_H__
  49 #define __DATAFLASH_USBKEY_H__
  50
  51         /* Includes: */
  52                 #include "../../Misc/AT45DB642D.h"
  53
  54         /* Preprocessor Checks: */
  55                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  56                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  57                 #endif
  58
  59         /* Private Interface - For use in library only: */
  60         #if !defined(__DOXYGEN__)
  61                 /* Macros: */
  62                         #define DATAFLASH_CHIPCS_MASK                ((1 << 1) | (1 << 0))
  63                         #define DATAFLASH_CHIPCS_DDR                 DDRE
  64                         #define DATAFLASH_CHIPCS_PORT                PORTE
  65         #endif
  66
  67         /* Public Interface - May be used in end-application: */
  68                 /* Macros: */
  69                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  70                         #define DATAFLASH_TOTALCHIPS                 2
  71
  72                         /** Mask for no dataflash chip selected. */
  73                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  74
  75                         /** Mask for the first dataflash chip selected. */
  76                         #define DATAFLASH_CHIP1                      (1 << 1)
  77
  78                         /** Mask for the second dataflash chip selected. */
  79                         #define DATAFLASH_CHIP2                      (1 << 0)
  80
  81                         /** Internal main memory page size for the board's dataflash ICs. */
  82                         #define DATAFLASH_PAGE_SIZE                  1024
  83
  84                         /** Total number of pages inside each of the board's dataflash ICs. */
  85                         #define DATAFLASH_PAGES                      8192
  86
  87                 /* Inline Functions: */
  88                         /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
  89                          *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
  90                          */
  91                         static inline void Dataflash_Init(void)
  92                         {
  93                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
  94                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
  95                         }
  96
  97                         /** Determines the currently selected dataflash chip.
  98                          *
  99                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 100                          *  or a DATAFLASH_CHIPn mask (where n is the chip number).
 101                          */
 102                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 103                         static inline uint8_t Dataflash_GetSelectedChip(void)
 104                         {
 105                                 return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 106                         }
 107
 108                         /** Selects the given dataflash chip.
 109                          *
 110                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 111                          *              the chip number).
 112                          */
 113                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 114                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 115                         {
 116                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
 117                         }
 118
 119                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 120                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 121                         static inline void Dataflash_DeselectChip(void)
 122                         {
 123                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 124                         }
 125
 126                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 127                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 128                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 129                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 130                          *  are deselected.
 131                          *
 132                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 133                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 134                          */
 135                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 136                         {
 137                                 Dataflash_DeselectChip();
 138
 139                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 140                                   return;
 141
 142                                 if (PageAddress & 0x01)
 143                                   Dataflash_SelectChip(DATAFLASH_CHIP2);
 144                                 else
 145                                   Dataflash_SelectChip(DATAFLASH_CHIP1);
 146                         }
 147
 148                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 149                          *  a new command.
 150                          */
 151                         static inline void Dataflash_ToggleSelectedChipCS(void)
 152                         {
 153                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 154
 155                                 Dataflash_DeselectChip();
 156                                 Dataflash_SelectChip(SelectedChipMask);
 157                         }
 158
 159                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 160                          *  memory page program or main memory to buffer transfer.
 161                          */
 162                         static inline void Dataflash_WaitWhileBusy(void)
 163                         {
 164                                 Dataflash_ToggleSelectedChipCS();
 165                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 166                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 167                                 Dataflash_ToggleSelectedChipCS();
 168                         }
 169
 170                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 171                          *  dataflash commands which require a complete 24-byte address.
 172                          *
 173                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 174                          *  \param[in] BufferByte   Address within the dataflash's buffer
 175                          */
 176                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 177                                                                       const uint16_t BufferByte)
 178                         {
 179                                 PageAddress >>= 1;
 180
 181                                 Dataflash_SendByte(PageAddress >> 5);
 182                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 183                                 Dataflash_SendByte(BufferByte);
 184                         }
 185
 186 #endif
 187
 188 /** @} */
 189