projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / LUFA / CodeTemplates / DriverStubs / Dataflash.h
diff --git a/LUFA/CodeTemplates/DriverStubs/Dataflash.h b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
index 31b5fed..5edd26f 100644 (file)
--- a/LUFA/CodeTemplates/DriverStubs/Dataflash.h
+++ b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
@@ -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
@@ -49,7 +49,7 @@
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
                #endif
                #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: */
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Macros: */
@@ -57,7 +57,7 @@
                        #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs
                        #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs
        #endif
                        #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs
                        #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs
        #endif
-       
+
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
@@ -71,7 +71,7 @@
 
                        /** Mask for the second dataflash chip selected. */
                        #define DATAFLASH_CHIP2                      // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high
 
                        /** Mask for the second dataflash chip selected. */
                        #define DATAFLASH_CHIP2                      // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high
-                       
+
                        /** Internal main memory page size for the board's dataflash ICs. */
                        #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs
 
                        /** Internal main memory page size for the board's dataflash ICs. */
                        #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs
 
@@ -79,15 +79,15 @@
                        #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
 
                /* Inline Functions: */
                        #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
 
                /* 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.
+                       /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
+                        *  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
@@ -124,12 +124,12 @@
                         *  are deselected.
                         *
                         *  \param[in] PageAddress  Address of the page to manipulate, ranging from
                         *  are deselected.
                         *
                         *  \param[in] PageAddress  Address of the page to manipulate, ranging from
-                        *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
+                        *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
                         */
                        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 * DATAFLASH_TOTALCHIPS))
                                  return;
 
                                if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
                                  return;
 
@@ -149,11 +149,11 @@
                        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);
                        }
-                       
+
                        /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
                         *  memory page program or main memory to buffer transfer.
                         */
                        /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
                         *  memory page program or main memory to buffer transfer.
                         */
@@ -162,11 +162,11 @@
                                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
-                        *  dataflash commands which require a complete 24-byte address.
+                        *  dataflash commands which require a complete 24-bit address.
                         *
                         *  \param[in] PageAddress  Page address within the selected dataflash IC
                         *  \param[in] BufferByte   Address within the dataflash's buffer
                         *
                         *  \param[in] PageAddress  Page address within the selected dataflash IC
                         *  \param[in] BufferByte   Address within the dataflash's buffer
@@ -176,10 +176,11 @@
                                #if (DATAFLASH_TOTALCHIPS == 2)
                                        PageAddress >>= 1;
                                #endif
                                #if (DATAFLASH_TOTALCHIPS == 2)
                                        PageAddress >>= 1;
                                #endif
-                               
+
                                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
+
USB isp AVR programmer