Add default project template to the Doxygen manual of the library.

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

diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index 9aa968b..c9f6605 100644 (file)
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -70,44 +70,44 @@
  *      SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING |
  *               SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
  *      Dataflash_Init();
- *
+ *      
  *      uint8_t WriteBuffer[DATAFLASH_PAGE_SIZE];
  *      uint8_t ReadBuffer[DATAFLASH_PAGE_SIZE];
- *
+ *      
  *      // Fill page write buffer with a repeating pattern
  *      for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++)
  *        WriteBuffer[i] = (i & 0xFF);
- *
+ *      
  *      // Must select the chip of interest first before operating on it
  *      Dataflash_SelectChip(DATAFLASH_CHIP1);
- *
+ *      
  *      // Write to the Dataflash's first internal memory buffer
  *      printf("Writing data to first dataflash buffer:\r\n");
  *      Dataflash_SendByte(DF_CMD_BUFF1WRITE);
  *      Dataflash_SendAddressBytes(0, 0);
- *
+ *      
  *      for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++)
  *        Dataflash_SendByte(WriteBuffer[i]);
- *
+ *      
  *      // Commit the Dataflash's first memory buffer to the non-volatile FLASH memory
  *      printf("Committing page to non-volatile memory page index 5:\r\n");
  *      Dataflash_SendByte(DF_CMD_BUFF1TOMAINMEMWITHERASE);
  *      Dataflash_SendAddressBytes(5, 0);
  *      Dataflash_WaitWhileBusy();
- *
+ *      
  *      // Read the page from non-volatile FLASH memory into the Dataflash's second memory buffer
  *      printf("Reading data into second dataflash buffer:\r\n");
  *      Dataflash_SendByte(DF_CMD_MAINMEMTOBUFF2);
  *      Dataflash_SendAddressBytes(5, 0);
  *      Dataflash_WaitWhileBusy();
- *
+ *      
  *      // Read the Dataflash's second internal memory buffer
  *      Dataflash_SendByte(DF_CMD_BUFF2READ);
  *      Dataflash_SendAddressBytes(0, 0);
- *
+ *      
  *      for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++)
  *        ReadBuffer[i] = Dataflash_ReceiveByte();
- *
+ *      
  *      // Deselect the chip after use
  *      Dataflash_DeselectChip();
  *  \endcode
@@ -122,8 +122,7 @@
                #define __INCLUDE_FROM_DATAFLASH_H
 
        /* Includes: */
-       #include "../../Common/Common.h"
-       #include "../Peripheral/SPI.h"
+               #include "../../Common/Common.h"
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
@@ -148,7 +147,9 @@
                /* Inline Functions: */
                        /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
                         *
-                        *  \note The microcontroller's SPI driver must be initialized before any of the dataflash commands are used.
+                        *  \note The microcontroller's physical interface driver connected to the Dataflash IC must be initialized before
+                        *        any of the dataflash commands are used. This is usually a SPI hardware port, but on some devices/boards may
+                        *        be a USART operating in SPI Master mode.
                         */
                        static inline void Dataflash_Init(void);
 
@@ -201,7 +202,7 @@
 
                        /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
                         *
-                        *  \param[in] Byte of data to send to the dataflash
+                        *  \param[in] Byte  Byte of data to send to the dataflash
                         *
                         *  \return Last response byte from the dataflash
                         */
@@ -209,7 +210,7 @@
 
                        /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
                         *
-                        *  \param[in] Byte of data to send to the dataflash
+                        *  \param[in] Byte  Byte of data to send to the dataflash
                         */
                        static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
 
@@ -234,6 +235,8 @@
                                #include "AVR8/EVK527/Dataflash.h"
                        #elif (BOARD == BOARD_A3BU_XPLAINED)
                                #include "XMEGA/A3BU_XPLAINED/Dataflash.h"
+                       #elif (BOARD == BOARD_B1_XPLAINED)
+                               #include "XMEGA/B1_XPLAINED/Dataflash.h"
                        #else
                                #include "Board/Dataflash.h"
                        #endif