LUFA/Drivers/Board/USBKEY/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 HWB driver header for the STK525.
  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 #ifndef __DATAFLASH_USBKEY_H__
  40 #define __DATAFLASH_USBKEY_H__
  41
  42         /* Includes: */
  43                 #include "AT45DB642D.h"
  44
  45         /* Preprocessor Checks: */
  46                 #if !defined(INCLUDE_FROM_DATAFLASH_H)
  47                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  48                 #endif
  49
  50         /* Private Interface - For use in library only: */
  51         #if !defined(__DOXYGEN__)
  52                 /* Macros: */
  53                         #define DATAFLASH_CHIPCS_MASK                ((1 << 1) | (1 << 0))
  54                         #define DATAFLASH_CHIPCS_DDR                 DDRE
  55                         #define DATAFLASH_CHIPCS_PORT                PORTE
  56         #endif
  57
  58         /* Public Interface - May be used in end-application: */
  59                 /* Macros: */
  60                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  61                         #define DATAFLASH_TOTALCHIPS                 2
  62
  63                         /** Mask for no dataflash chip selected. */
  64                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  65
  66                         /** Mask for the first dataflash chip selected. */
  67                         #define DATAFLASH_CHIP1                      (1 << 1)
  68
  69                         /** Mask for the second dataflash chip selected. */
  70                         #define DATAFLASH_CHIP2                      (1 << 0)
  71
  72                         /** Internal main memory page size for the board's dataflash ICs. */
  73                         #define DATAFLASH_PAGE_SIZE                  1024
  74
  75                         /** Total number of pages inside each of the board's dataflash ICs. */
  76                         #define DATAFLASH_PAGES                      8192
  77
  78                 /* Inline Functions: */
  79                         /** Selects a dataflash IC from the given page number, which should range from 0 to
  80                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
  81                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
  82                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
  83                          *  are deselected.
  84                          *
  85                          *  \param PageAddress  Address of the page to manipulate, ranging from
  86                          *                      ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
  87                          */
  88                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
  89                         {
  90                                 Dataflash_DeselectChip();
  91
  92                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
  93                                   return;
  94
  95                                 if (PageAddress & 0x01)
  96                                   Dataflash_SelectChip(DATAFLASH_CHIP2);
  97                                 else
  98                                   Dataflash_SelectChip(DATAFLASH_CHIP1);
  99                         }
 100
 101                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 102                          *  dataflash commands which require a complete 24-byte address.
 103                          *
 104                          *  \param PageAddress  Page address within the selected dataflash IC
 105                          *  \param BufferByte   Address within the dataflash's buffer
 106                          */
 107                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
 108                         {
 109                                 PageAddress >>= 1;
 110
 111                                 Dataflash_SendByte(PageAddress >> 5);
 112                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 113                                 Dataflash_SendByte(BufferByte);
 114                         }
 115
 116 #endif