Simplify the internal serial extraction routines for each architecture.

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

diff --git a/LUFA/Drivers/Board/XPLAIN/Dataflash.h b/LUFA/Drivers/Board/XPLAIN/Dataflash.h
index c1b8cd6..ed4ab6a 100644 (file)
--- a/LUFA/Drivers/Board/XPLAIN/Dataflash.h
+++ b/LUFA/Drivers/Board/XPLAIN/Dataflash.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -29,21 +29,18 @@
 */
 
 /** \file
- *  \brief Board specific Dataflash driver header for the XPLAIN.
- *
- *  Board specific Dataflash driver header for the XPLAIN.
+ *  \brief Board specific Dataflash driver header for the Atmel XPLAIN.
+ *  \copydetails Group_Dataflash_XPLAIN
  *
  *  \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.
  */
 
 /** \ingroup Group_Dataflash
- *  @defgroup Group_Dataflash_XPLAIN XPLAIN
+ *  \defgroup Group_Dataflash_XPLAIN XPLAIN
+ *  \brief Board specific Dataflash driver header for the Atmel XPLAIN.
  *
- *  Board specific Dataflash driver header for the XPLAIN.
- *
- *  \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.
+ *  Board specific Dataflash driver header for the Atmel XPLAIN.
  *
  *  @{
  */
@@ -52,13 +49,13 @@
 #define __DATAFLASH_XPLAIN_H__
 
        /* Includes: */
-               #include "AT45DB642D.h"
+               #include "../../Misc/AT45DB642D.h"
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
                #endif
-               
+
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Macros: */
@@ -66,7 +63,7 @@
                        #define DATAFLASH_CHIPCS_DDR                 DDRB
                        #define DATAFLASH_CHIPCS_PORT                PORTB
        #endif
-       
+
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
@@ -81,18 +78,18 @@
                        #if (BOARD == BOARD_XPLAIN_REV1)
                                #define DATAFLASH_PAGE_SIZE              256
 
-                               #define DATAFLASH_PAGES                  2048                                                   
+                               #define DATAFLASH_PAGES                  2048
                        #else
                                /** Internal main memory page size for the board's dataflash ICs. */
                                #define DATAFLASH_PAGE_SIZE              1024
 
                                /** Total number of pages inside each of the board's dataflash ICs. */
-                               #define DATAFLASH_PAGES                  8192                   
+                               #define DATAFLASH_PAGES                  8192
                        #endif
-                       
+
                /* 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.
+                        *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
                         */
                        static inline void Dataflash_Init(void)
                        {
@@ -141,20 +138,20 @@
                        static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
                        {
                                Dataflash_DeselectChip();
-                               
+
                                if (PageAddress >= DATAFLASH_PAGES)
                                  return;
 
                                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);
                        }
@@ -167,7 +164,7 @@
                                Dataflash_ToggleSelectedChipCS();
                                Dataflash_SendByte(DF_CMD_GETSTATUS);
                                while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
-                               Dataflash_ToggleSelectedChipCS();                               
+                               Dataflash_ToggleSelectedChipCS();
                        }
 
                        /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
@@ -182,8 +179,9 @@
                                Dataflash_SendByte(PageAddress >> 5);
                                Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
                                Dataflash_SendByte(BufferByte);
-                       }               
+                       }
 
 #endif
 
 /** @} */
+