LUFA/DriverStubs/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 /*
  32    This is a stub driver header file, for implementing custom board
  33    layout hardware with compatible LUFA board specific drivers. If
  34    the library is configured to use the BOARD_USER board mode, this
  35    driver file should be completed and copied into the "/Board/" folder
  36    inside the application's folder.
  37
  38    This stub is for the board-specific component of the LUFA Dataflash
  39    driver.
  40 */
  41
  42 #ifndef __DATAFLASH_USER_H__
  43 #define __DATAFLASH_USER_H__
  44
  45         /* Includes: */
  46                 // TODO: Add any required includes here
  47
  48         /* Preprocessor Checks: */
  49                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  50                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  51                 #endif
  52
  53         /* Private Interface - For use in library only: */
  54         #if !defined(__DOXYGEN__)
  55                 /* Macros: */
  56                         #define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all dataflashes
  57                         #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs
  58                         #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs
  59         #endif
  60
  61         /* Public Interface - May be used in end-application: */
  62                 /* Macros: */
  63                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  64                         #define DATAFLASH_TOTALCHIPS                 // TODO: Replace with the number of dataflashes on the board, max 2
  65
  66                         /** Mask for no dataflash chip selected. */
  67                         #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
  68
  69                         /** Mask for the first dataflash chip selected. */
  70                         #define DATAFLASH_CHIP1                      // TODO: Replace with mask to select the first Dataflash chip
  71
  72                         /** Mask for the second dataflash chip selected. */
  73                         #define DATAFLASH_CHIP2                      // TODO: Replace with mask to select the second Dataflash chip, if available
  74
  75                         /** Internal main memory page size for the board's dataflash ICs. */
  76                         #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs
  77
  78                         /** Total number of pages inside each of the board's dataflash ICs. */
  79                         #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
  80
  81                 /* Inline Functions: */
  82                         /** Selects a dataflash IC from the given page number, which should range from 0 to
  83                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
  84                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
  85                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
  86                          *  are deselected.
  87                          *
  88                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
  89                          *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
  90                          */
  91                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
  92                         {
  93                                 Dataflash_DeselectChip();
  94
  95                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
  96                                   return;
  97
  98                                 // TODO: If more than one dataflash chip, select the correct chip from the page address here
  99                                 Dataflash_SelectChip(DATAFLASH_CHIP1);
 100                         }
 101
 102                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 103                          *  dataflash commands which require a complete 24-byte address.
 104                          *
 105                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 106                          *  \param[in] BufferByte   Address within the dataflash's buffer
 107                          */
 108                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
 109                         {
 110                                 // TODO: If more than one dataflash chip, adjust absolute page address to be correct for the current chip,
 111                                 //       also the shifts may need to be altered to suit the dataflash model being used
 112                                 Dataflash_SendByte(PageAddress >> 5);
 113                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 114                                 Dataflash_SendByte(BufferByte);
 115                         }
 116
 117 #endif