X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/7dc3d3a68f889efeca5af51b22bd043eff8e0926..16f09ab50a6a931f0d8ec22a191288641e937eb1:/LUFA/Drivers/Board/Dataflash.h?ds=sidebyside diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 27be323ef..cb5b7fccc 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -30,9 +30,10 @@ /** \file * \brief Master include file for the board dataflash IC driver. + * \brief Atmel Dataflash storage IC board hardware driver. * - * This file is the master dispatch header file for the board-specific dataflash driver, for boards containing - * dataflash ICs for external non-volatile storage. + * This file is the master dispatch header file for the board-specific Atmel dataflash driver, for boards containing + * Atmel Dataflash ICs for external non-volatile storage. * * User code should include this file, which will in turn include the correct dataflash driver header file for * the currently selected board. @@ -44,7 +45,8 @@ */ /** \ingroup Group_BoardDrivers - * @defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h + * \defgroup Group_Dataflash Dataflash Driver - LUFA/Drivers/Board/Dataflash.h + * \brief Atmel Dataflash storage IC board hardware driver. * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: @@ -87,13 +89,13 @@ * for (uint16_t i = 0; i < DATAFLASH_PAGE_SIZE; i++) * Dataflash_SendByte(WriteBuffer[i]); * - * // Commit the Dataflash's first memory buffer to the non-voltatile FLASH memory + * // 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-voltatile FLASH memory into the Dataflash's second memory buffer + * // 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); @@ -117,14 +119,11 @@ #define __DATAFLASH_H__ /* Macros: */ - #if !defined(__DOXYGEN__) #define __INCLUDE_FROM_DATAFLASH_H - #define INCLUDE_FROM_DATAFLASH_H - #endif /* Includes: */ - #include "../Peripheral/SPI.h" #include "../../Common/Common.h" + #include "../Peripheral/SPI.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) @@ -149,7 +148,7 @@ /* Inline Functions: */ /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC. * - * \note The AVR's SPI driver must be initialized before any of the dataflash commands are used. + * \note The microcontroller's SPI driver must be initialized before any of the dataflash commands are used. */ static inline void Dataflash_Init(void); @@ -234,7 +233,7 @@ /* Includes: */ #if (BOARD == BOARD_NONE) - #error The Board Buttons driver cannot be used if the makefile BOARD option is not set. + #error The Board Dataflash driver cannot be used if the makefile BOARD option is not set. #elif (BOARD == BOARD_USBKEY) #include "USBKEY/Dataflash.h" #elif (BOARD == BOARD_STK525) @@ -247,10 +246,8 @@ #include "XPLAIN/Dataflash.h" #elif (BOARD == BOARD_EVK527) #include "EVK527/Dataflash.h" - #elif (BOARD == BOARD_USER) - #include "Board/Dataflash.h" #else - #error The selected board does not contain a dataflash IC. + #include "Board/Dataflash.h" #endif /* Disable C linkage for C++ Compilers: */