Fix board name redefinition in BoardTypes.h (thanks to Daniel Czigany).

[pub/USBasp.git] / LUFA / Drivers / Board / USBKEY / Dataflash.h

diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h
index 25d2090..8b01c64 100644 (file)
--- a/LUFA/Drivers/Board/USBKEY/Dataflash.h
+++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h
@@ -29,9 +29,9 @@
 */
 
 /** \file
- *  \brief Board specific Dataflash driver header for the USBKEY.
+ *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
  *
- *  Board specific Dataflash driver header for the USBKEY.
+ *  Board specific Dataflash driver header for the Atmel USBKEY.
  *
  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
@@ -40,7 +40,7 @@
 /** \ingroup Group_Dataflash
  *  @defgroup Group_Dataflash_USBKEY USBKEY
  *
- *  Board specific Dataflash driver header for the USBKEY board.
+ *  Board specific Dataflash driver header for the Atmel USBKEY board.
  *
  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h. 
@@ -88,6 +88,44 @@
                        #define DATAFLASH_PAGES                      8192
                        
                /* Inline Functions: */
+                       /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
+                        *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.
+                        */
+                       static inline void Dataflash_Init(void)
+                       {
+                               DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
+                               DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
+                       }
+
+                       /** Determines the currently selected dataflash chip.
+                        *
+                        *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
+                        *  or a DATAFLASH_CHIPn mask (where n is the chip number).
+                        */
+                       static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
+                       static inline uint8_t Dataflash_GetSelectedChip(void)
+                       {
+                               return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
+                       }
+
+                       /** Selects the given dataflash chip.
+                        *
+                        *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
+                        *              the chip number).
+                        */
+                       static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
+                       static inline void Dataflash_SelectChip(const uint8_t ChipMask)
+                       {
+                               DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
+                       }
+
+                       /** Deselects the current dataflash chip, so that no dataflash is selected. */
+                       static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
+                       static inline void Dataflash_DeselectChip(void)
+                       {
+                               Dataflash_SelectChip(DATAFLASH_NO_CHIP);
+                       }
+                       
                        /** Selects a dataflash IC from the given page number, which should range from 0 to
                         *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
                         *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
@@ -110,13 +148,36 @@
                                  Dataflash_SelectChip(DATAFLASH_CHIP1);
                        }
 
+                       /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
+                        *  a new command.
+                        */
+                       static inline void Dataflash_ToggleSelectedChipCS(void)
+                       {
+                               uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
+                                       
+                               Dataflash_DeselectChip();
+                               Dataflash_SelectChip(SelectedChipMask);
+                       }
+
+                       /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
+                        *  memory page program or main memory to buffer transfer.
+                        */
+                       static inline void Dataflash_WaitWhileBusy(void)
+                       {
+                               Dataflash_ToggleSelectedChipCS();
+                               Dataflash_SendByte(DF_CMD_GETSTATUS);
+                               while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
+                               Dataflash_ToggleSelectedChipCS();                               
+                       }
+
                        /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
                         *  dataflash commands which require a complete 24-byte address.
                         *
                         *  \param[in] PageAddress  Page address within the selected dataflash IC
                         *  \param[in] BufferByte   Address within the dataflash's buffer
                         */
-                       static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
+                       static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
+                                                                     const uint16_t BufferByte)
                        {       
                                PageAddress >>= 1;