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