X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/1d433d4506113c95285f633e3553ff62d4cfd05d..16f09ab50a6a931f0d8ec22a191288641e937eb1:/LUFA/Drivers/Board/Dataflash.h diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index d8da7543e..cb5b7fccc 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -30,21 +30,23 @@ /** \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. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * directory. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. */ /** \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: @@ -54,10 +56,10 @@ * Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards, * for the storage of large amounts of data into the Dataflash's non-volatile memory. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * directory. Otherwise, it will include the appropriate built in board driver header file. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. * * \section Sec_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical @@ -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,20 +148,20 @@ /* 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); /** 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). + * or a \c DATAFLASH_CHIPn mask (where n is the chip number). */ static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; /** 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 + * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of \c DATAFLASH_CHIPn mask (where n is * the chip number). */ static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; @@ -172,7 +171,7 @@ /** 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 + * dataflash IC, this will select \ref DATAFLASH_CHIP1. If the given page number is outside * the total number of pages contained in the boards dataflash ICs, all dataflash ICs * are deselected. * @@ -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: */