Added start of a port of the core USB driver code to the AVR32 UC3B architecture.
[pub/USBasp.git] / LUFA / Drivers / Board / EVK527 / Dataflash.h
index 4440d76..2f0ad57 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   dean [at] fourwalledcubicle [dot] com
   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
   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
   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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
 */
 
 /** \file
 */
 
 /** \file
- *  \brief Board specific Dataflash driver header for the EVK527.
- *
- *  Board specific Dataflash driver header for the EVK527.
+ *  \brief Board specific Dataflash driver header for the Atmel EVK527.
+ *  \copydetails Group_Dataflash_EVK527
  *
  *  \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
  *
  *  \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_EVK527 EVK527
+ *  \defgroup Group_Dataflash_EVK527 EVK527
+ *  \brief Board specific Dataflash driver header for the Atmel EVK527.
  *
  *
- *  Board specific Dataflash driver header for the EVK527.
- *
- *  \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 EVK527.
  *
  *  @{
  */
  *
  *  @{
  */
@@ -52,7 +49,7 @@
 #define __DATAFLASH_EVK527_H__
 
        /* Includes: */
 #define __DATAFLASH_EVK527_H__
 
        /* Includes: */
-               #include "AT45DB321C.h"         
+               #include "../../Misc/AT45DB321C.h"
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
@@ -77,7 +74,7 @@
 
                        /** Mask for the first dataflash chip selected. */
                        #define DATAFLASH_CHIP1                      0
 
                        /** Mask for the first dataflash chip selected. */
                        #define DATAFLASH_CHIP1                      0
-                       
+
                        /** Internal main memory page size for the board's dataflash IC. */
                        #define DATAFLASH_PAGE_SIZE                  512
 
                        /** Internal main memory page size for the board's dataflash IC. */
                        #define DATAFLASH_PAGE_SIZE                  512
 
 
                /* Inline Functions: */
                        /** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.
 
                /* 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)
                        {
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
                        }
                         */
                        static inline void Dataflash_Init(void)
                        {
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
                        }
-                       
+
                        /** Determines the currently selected dataflash chip.
                         *
                         *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
                        /** Determines the currently selected dataflash chip.
                         *
                         *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
                        static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
                        {
                                Dataflash_DeselectChip();
                        static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
                        {
                                Dataflash_DeselectChip();
-                               
+
                                if (PageAddress >= DATAFLASH_PAGES)
                                  return;
 
                                if (PageAddress >= DATAFLASH_PAGES)
                                  return;
 
                        static inline void Dataflash_ToggleSelectedChipCS(void)
                        {
                                uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
                        static inline void Dataflash_ToggleSelectedChipCS(void)
                        {
                                uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
-                                       
+
                                Dataflash_DeselectChip();
                                Dataflash_SelectChip(SelectedChipMask);
                        }
                                Dataflash_DeselectChip();
                                Dataflash_SelectChip(SelectedChipMask);
                        }
                                Dataflash_ToggleSelectedChipCS();
                                Dataflash_SendByte(DF_CMD_GETSTATUS);
                                while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
                                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
                        }
 
                        /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
                         */
                        static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
                                                                      const uint16_t BufferByte)
                         */
                        static inline void Dataflash_SendAddressBytes(uint16_t PageAddress,
                                                                      const uint16_t BufferByte)
-                       {       
+                       {
                                Dataflash_SendByte(PageAddress >> 5);
                                Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
                                Dataflash_SendByte(BufferByte);
                        }
                                Dataflash_SendByte(PageAddress >> 5);
                                Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
                                Dataflash_SendByte(BufferByte);
                        }
-                       
+
 #endif
 
 /** @} */
 #endif
 
 /** @} */
+