LUFA/Drivers/Board/STK526/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 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 "../../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 << 2)
  63                         #define DATAFLASH_CHIPCS_DDR                 DDRC
  64                         #define DATAFLASH_CHIPCS_PORT                PORTC
  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                 1
  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                      0
  77
  78                         /** Internal main memory page size for the board's dataflash IC. */
  79                         #define DATAFLASH_PAGE_SIZE                  1024
  80
  81                         /** Total number of pages inside the board's dataflash IC. */
  82                         #define DATAFLASH_PAGES                      8192
  83
  84                 /* Inline Functions: */
  85                         /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
  86                          *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
  87                          */
  88                         static inline void Dataflash_Init(void)
  89                         {
  90                                 DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
  91                                 DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
  92                         }
  93
  94                         /** Determines the currently selected dataflash chip.
  95                          *
  96                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
  97                          *  or a DATAFLASH_CHIPn mask (where n is the chip number).
  98                          */
  99                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 100                         static inline uint8_t Dataflash_GetSelectedChip(void)
 101                         {
 102                                 return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 103                         }
 104
 105                         /** Selects the given dataflash chip.
 106                          *
 107                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
 108                          *              the chip number).
 109                          */
 110                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 111                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 112                         {
 113                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
 114                         }
 115
 116                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 117                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 118                         static inline void Dataflash_DeselectChip(void)
 119                         {
 120                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 121                         }
 122
 123                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 124                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 125                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 126                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 127                          *  are deselected.
 128                          *
 129                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 130                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 131                          */
 132                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 133                         {
 134                                 Dataflash_DeselectChip();
 135
 136                                 if (PageAddress >= DATAFLASH_PAGES)
 137                                   return;
 138
 139                                 Dataflash_SelectChip(DATAFLASH_CHIP1);
 140                         }
 141
 142                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 143                          *  a new command.
 144                          */
 145                         static inline void Dataflash_ToggleSelectedChipCS(void)
 146                         {
 147                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 148
 149                                 Dataflash_DeselectChip();
 150                                 Dataflash_SelectChip(SelectedChipMask);
 151                         }
 152
 153                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 154                          *  memory page program or main memory to buffer transfer.
 155                          */
 156                         static inline void Dataflash_WaitWhileBusy(void)
 157                         {
 158                                 Dataflash_ToggleSelectedChipCS();
 159                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 160                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 161                                 Dataflash_ToggleSelectedChipCS();
 162                         }
 163
 164                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 165                          *  dataflash commands which require a complete 24-byte address.
 166                          *
 167                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 168                          *  \param[in] BufferByte   Address within the dataflash's buffer
 169                          */
 170                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 171                                                                       const uint16_t BufferByte)
 172                         {
 173                                 Dataflash_SendByte(PageAddress >> 5);
 174                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 175                                 Dataflash_SendByte(BufferByte);
 176                         }
 177
 178 #endif
 179
 180 /** @} */
 181