Added stdio.h stream examples for the virtual CDC UART in the CDC host demos.

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

diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h
index e58828c..63aca2d 100644 (file)
--- a/LUFA/Drivers/Board/Dataflash.h
+++ b/LUFA/Drivers/Board/Dataflash.h
@@ -48,7 +48,8 @@
  *    - None\r
  *\r
  *  \section Module Description\r
  *    - None\r
  *\r
  *  \section Module Description\r

- *  Functions, macros, variables, enums and types related to the control of board Dataflash ICs.\r
+ *  Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards,\r
+ *  for the storage of large amounts of data into the Dataflash's non-volatile memory.\r

  *\r
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
  *  directory. Otherwise, it will include the appropriate built in board driver header file.\r
  *\r
  *  If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project\r
  *  directory. Otherwise, it will include the appropriate built in board driver header file.\r


@@ -62,7 +63,6 @@
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r
                #define INCLUDE_FROM_DATAFLASH_H\r
        /* Macros: */\r
        #if !defined(__DOXYGEN__)\r
                #define INCLUDE_FROM_DATAFLASH_H\r

-               #define INCLUDE_FROM_BOARD_DRIVER\r

        #endif\r
 \r
        /* Includes: */\r
        #endif\r
 \r
        /* Includes: */\r


@@ -81,9 +81,11 @@
                                #define __GET_DATAFLASH_MASK(x)     __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)\r
                        #endif\r
        \r
                                #define __GET_DATAFLASH_MASK(x)     __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)\r
                        #endif\r
        \r

-                       /* Retrieves the Dataflash chip select mask for the given Dataflash chip index.\r
+                       /** Retrieves the Dataflash chip select mask for the given Dataflash chip index.\r

                         *\r
                         *\r

-                        * \param index  Index of the dataflash chip mask to retrieve\r
+                        *  \param[in] index  Index of the dataflash chip mask to retrieve\r
+                        *\r
+                        *  \return Mask for the given Dataflash chip's /CS pin\r

                         */\r
                        #define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)\r
                        \r
                         */\r
                        #define DATAFLASH_CHIP_MASK(index)      __GET_DATAFLASH_MASK(index)\r
                        \r


@@ -163,17 +165,13 @@
                        #endif\r
                \r
                /* Inline Functions: */\r
                        #endif\r
                \r
                /* Inline Functions: */\r

-                       /** Initializes the dataflash driver (including the SPI driver) so that commands and data may be\r
-                        *  sent to an attached dataflash IC.\r
-                        *\r
-                        *  \param[in] PrescalerMask  SPI prescaler mask, see SPI.h documentation\r
+                       /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.\r
+                        *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.\r

                         */\r
                         */\r

-                       static inline void Dataflash_Init(const uint8_t PrescalerMask)\r
+                       static inline void Dataflash_Init(void)\r

                        {\r
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;\r
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;\r
                        {\r
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;\r
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;\r

-\r
-                               SPI_Init(PrescalerMask, true);\r

                        }\r
                        \r
                        /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive\r
                        }\r
                        \r
                        /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive\r