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 USBKEY.
  33  *
  34  *  Board specific Dataflash driver header for the 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 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                         /** Selects a dataflash IC from the given page number, which should range from 0 to
  92                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
  93                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
  94                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
  95                          *  are deselected.
  96                          *
  97                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
  98                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
  99                          */
 100                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 101                         {
 102                                 Dataflash_DeselectChip();
 103
 104                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 105                                   return;
 106
 107                                 if (PageAddress & 0x01)
 108                                   Dataflash_SelectChip(DATAFLASH_CHIP2);
 109                                 else
 110                                   Dataflash_SelectChip(DATAFLASH_CHIP1);
 111                         }
 112
 113                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 114                          *  dataflash commands which require a complete 24-byte address.
 115                          *
 116                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 117                          *  \param[in] BufferByte   Address within the dataflash's buffer
 118                          */
 119                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
 120                         {
 121                                 PageAddress >>= 1;
 122
 123                                 Dataflash_SendByte(PageAddress >> 5);
 124                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 125                                 Dataflash_SendByte(BufferByte);
 126                         }
 127
 128 #endif
 129
 130 /** @} */