LUFA/CodeTemplates/DriverStubs/Dataflash.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2021.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2021  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 disclaims 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 LUFA Custom Board Dataflash Hardware Driver (Template)
  33  *
  34  *  This is a stub driver header file, for implementing custom board
  35  *  layout hardware with compatible LUFA board specific drivers. If
  36  *  the library is configured to use the BOARD_USER board mode, this
  37  *  driver file should be completed and copied into the "/Board/" folder
  38  *  inside the application's folder.
  39  *
  40  *  This stub is for the board-specific component of the LUFA Dataflash
  41  *  driver.
  42 */
  43
  44 #ifndef __DATAFLASH_USER_H__
  45 #define __DATAFLASH_USER_H__
  46
  47         /* Includes: */
  48                 // TODO: Add any required includes here
  49
  50         /* Preprocessor Checks: */
  51                 #if !defined(__INCLUDE_FROM_DATAFLASH_H)
  52                         #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
  53                 #endif
  54
  55         /* Private Interface - For use in library only: */
  56         #if !defined(__DOXYGEN__)
  57                 /* Macros: */
  58                         #define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all Dataflashes
  59                         #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs
  60                         #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs
  61         #endif
  62
  63         /* Public Interface - May be used in end-application: */
  64                 /* Macros: */
  65                         /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
  66                         #define DATAFLASH_TOTALCHIPS                 1 // TODO: Replace with the number of Dataflashes on the board, max 2
  67
  68                         /** Mask for no dataflash chip selected. */
  69                         #define DATAFLASH_NO_CHIP                    0
  70
  71                         /** Mask for the first dataflash chip selected. */
  72                         #define DATAFLASH_CHIP1                      // TODO: Replace with mask with the pin attached to the first Dataflash /CS set
  73
  74                         /** Mask for the second dataflash chip selected. */
  75                         #define DATAFLASH_CHIP2                      // TODO: Replace with mask with the pin attached to the second Dataflash /CS set
  76
  77                         /** Internal main memory page size for the board's dataflash ICs. */
  78                         #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs
  79
  80                         /** Total number of pages inside each of the board's dataflash ICs. */
  81                         #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
  82
  83                 /* Inline Functions: */
  84                 #if !defined(__DOXYGEN__)
  85                         /** Initializes 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                         /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
  95                          *
  96                          *  \param[in] Byte  Byte of data to send to the dataflash
  97                          *
  98                          *  \return Last response byte from the dataflash
  99                          */
 100                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 101                         static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)
 102                         {
 103                                 // TODO
 104                         }
 105
 106                         /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
 107                          *
 108                          *  \param[in] Byte  Byte of data to send to the dataflash
 109                          */
 110                         static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 111                         static inline void Dataflash_SendByte(const uint8_t Byte)
 112                         {
 113                                 // TODO
 114                         }
 115
 116                         /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.
 117                          *
 118                          *  \return Last response byte from the dataflash
 119                          */
 120                         static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 121                         static inline uint8_t Dataflash_ReceiveByte(void)
 122                         {
 123                                 // TODO
 124                         }
 125
 126                         /** Determines the currently selected dataflash chip.
 127                          *
 128                          *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
 129                          *          or a DATAFLASH_CHIPn mask (where n is the chip number).
 130                          */
 131                         static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
 132                         static inline uint8_t Dataflash_GetSelectedChip(void)
 133                         {
 134                                 return (~DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
 135                         }
 136
 137                         /** Selects the given dataflash chip.
 138                          *
 139                          *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of a \c DATAFLASH_CHIPn mask (where n is
 140                          *              the chip number).
 141                          */
 142                         static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
 143                         static inline void Dataflash_SelectChip(const uint8_t ChipMask)
 144                         {
 145                                 DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT | DATAFLASH_CHIPCS_MASK) & ~ChipMask);
 146                         }
 147
 148                         /** Deselects the current dataflash chip, so that no dataflash is selected. */
 149                         static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
 150                         static inline void Dataflash_DeselectChip(void)
 151                         {
 152                                 Dataflash_SelectChip(DATAFLASH_NO_CHIP);
 153                         }
 154
 155                         /** Selects a dataflash IC from the given page number, which should range from 0 to
 156                          *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
 157                          *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
 158                          *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
 159                          *  are deselected.
 160                          *
 161                          *  \param[in] PageAddress  Address of the page to manipulate, ranging from
 162                          *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
 163                          */
 164                         static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
 165                         {
 166                                 Dataflash_DeselectChip();
 167
 168                                 if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
 169                                   return;
 170
 171                                 #if (DATAFLASH_TOTALCHIPS == 2)
 172                                         if (PageAddress & 0x01)
 173                                           Dataflash_SelectChip(DATAFLASH_CHIP2);
 174                                         else
 175                                           Dataflash_SelectChip(DATAFLASH_CHIP1);
 176                                 #else
 177                                         Dataflash_SelectChip(DATAFLASH_CHIP1);
 178                                 #endif
 179                         }
 180
 181                         /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
 182                          *  a new command.
 183                          */
 184                         static inline void Dataflash_ToggleSelectedChipCS(void)
 185                         {
 186                                 uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
 187
 188                                 Dataflash_DeselectChip();
 189                                 Dataflash_SelectChip(SelectedChipMask);
 190                         }
 191
 192                         /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
 193                          *  memory page program or main memory to buffer transfer.
 194                          */
 195                         static inline void Dataflash_WaitWhileBusy(void)
 196                         {
 197                                 Dataflash_ToggleSelectedChipCS();
 198                                 Dataflash_SendByte(DF_CMD_GETSTATUS);
 199                                 while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
 200                                 Dataflash_ToggleSelectedChipCS();
 201                         }
 202
 203                         /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
 204                          *  dataflash commands which require a complete 24-bit address.
 205                          *
 206                          *  \param[in] PageAddress  Page address within the selected dataflash IC
 207                          *  \param[in] BufferByte   Address within the dataflash's buffer
 208                          */
 209                         static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
 210                                                                       const uint16_t BufferByte)
 211                         {
 212                                 #if (DATAFLASH_TOTALCHIPS == 2)
 213                                         PageAddress >>= 1;
 214                                 #endif
 215
 216                                 Dataflash_SendByte(PageAddress >> 5);
 217                                 Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
 218                                 Dataflash_SendByte(BufferByte);
 219                         }
 220                 #endif
 221
 222 #endif
 223