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  *
  33  *  Board specific Dataflash driver header for the 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  *
  42  *  Board specific Dataflash driver header for the USBKEY board.
  43  *
  44  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
  45  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef __DATAFLASH_USBKEY_H__
  51 #define __DATAFLASH_USBKEY_H__
  52
  53         /* Includes: */
  54                 #include "AT45DB642D.h"
  55
  56         /* Preprocessor Checks: */
  57                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  58                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  59                 #endif
  60
  61         /* Private Interface - For use in library only: */
  62         #if !defined(__DOXYGEN__)
  63                 /* Macros: */
  64                         #define DATAFLASH_CHIPCS_MASK                ((1 << 1) | (1 << 0))
  65                         #define DATAFLASH_CHIPCS_DDR                 DDRE
  66                         #define DATAFLASH_CHIPCS_PORT                PORTE
  67         #endif
  68
  69         /* Public Interface - May be used in end-application: */
  70                 /* Macros: */
  71                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  72                         #define DATAFLASH_TOTALCHIPS                 2
  73
  74                         /** Mask for no dataflash chip selected. */
  75                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  76
  77                         /** Mask for the first dataflash chip selected. */
  78                         #define DATAFLASH_CHIP1                      (1 << 1)
  79
  80                         /** Mask for the second dataflash chip selected. */
  81                         #define DATAFLASH_CHIP2                      (1 << 0)
  82
  83                         /** Internal main memory page size for the board's dataflash ICs. */
  84                         #define DATAFLASH_PAGE_SIZE                  1024
  85
  86                         /** Total number of pages inside each of the board's dataflash ICs. */
  87                         #define DATAFLASH_PAGES                      8192
  88
  89                 /* Inline Functions: */
  90                         /** Selects a dataflash IC from the given page number, which should range from 0 to
  91                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
  92                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
  93                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
  94                          *  are deselected.
  95                          *
  96                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
  97                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
  98                          */
  99                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 100                         {
 101                                 Dataflash_DeselectChip();
 102
 103                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 104                                   return;
 105
 106                                 if (PageAddress & 0x01)
 107                                   Dataflash_SelectChip(DATAFLASH_CHIP2);
 108                                 else
 109                                   Dataflash_SelectChip(DATAFLASH_CHIP1);
 110                         }
 111
 112                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 113                          *  dataflash commands which require a complete 24-byte address.
 114                          *
 115                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 116                          *  \param[in] BufferByte   Address within the dataflash's buffer
 117                          */
 118                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
 119                         {
 120                                 PageAddress >>= 1;
 121
 122                                 Dataflash_SendByte(PageAddress >> 5);
 123                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 124                                 Dataflash_SendByte(BufferByte);
 125                         }
 126
 127 #endif
 128
 129 /** @} */