Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / LUFA / DriverStubs / Dataflash.h
index 10eafa2..d00d3ef 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/*\r
-   This is a stub driver header file, for implementing custom board\r
-   layout hardware with compatible LUFA board specific drivers. If\r
-   the library is configured to use the BOARD_USER board mode, this\r
-   driver file should be completed and copied into the "/Board/" folder\r
-   inside the application's folder.\r
-\r
-   This stub is for the board-specific component of the LUFA Dataflash\r
-   driver.\r
-*/\r
-\r
-#ifndef __DATAFLASH_USER_H__\r
-#define __DATAFLASH_USER_H__\r
-\r
-       /* Includes: */\r
-               // TODO: Add any required includes here\r
-\r
-       /* Preprocessor Checks: */\r
-               #if !defined(__INCLUDE_FROM_DATAFLASH_H)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.\r
-               #endif\r
-               \r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Macros: */\r
-                       #define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all dataflashes\r
-                       #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs\r
-                       #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs\r
-       #endif\r
-       \r
-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       /** Constant indicating the total number of dataflash ICs mounted on the selected board. */\r
-                       #define DATAFLASH_TOTALCHIPS                 // TODO: Replace with the number of dataflashes on the board, max 2\r
-\r
-                       /** Mask for no dataflash chip selected. */\r
-                       #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK\r
-\r
-                       /** Mask for the first dataflash chip selected. */\r
-                       #define DATAFLASH_CHIP1                      // TODO: Replace with mask to select the first Dataflash chip\r
-\r
-                       /** Mask for the second dataflash chip selected. */\r
-                       #define DATAFLASH_CHIP2                      // TODO: Replace with mask to select the second Dataflash chip, if available\r
-                       \r
-                       /** Internal main memory page size for the board's dataflash ICs. */\r
-                       #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs\r
-\r
-                       /** Total number of pages inside each of the board's dataflash ICs. */\r
-                       #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs\r
-\r
-               /* Inline Functions: */\r
-                       /** Selects a dataflash IC from the given page number, which should range from 0 to\r
-                        *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one\r
-                        *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside\r
-                        *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs\r
-                        *  are deselected.\r
-                        *\r
-                        *  \param[in] PageAddress  Address of the page to manipulate, ranging from\r
-                        *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).\r
-                        */\r
-                       static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)\r
-                       {\r
-                               Dataflash_DeselectChip();\r
-                               \r
-                               if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))\r
-                                 return;\r
-\r
-                               // TODO: If more than one dataflash chip, select the correct chip from the page address here\r
-                               Dataflash_SelectChip(DATAFLASH_CHIP1);\r
-                       }\r
-\r
-                       /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with\r
-                        *  dataflash commands which require a complete 24-byte address.\r
-                        *\r
-                        *  \param[in] PageAddress  Page address within the selected dataflash IC\r
-                        *  \param[in] BufferByte   Address within the dataflash's buffer\r
-                        */\r
-                       static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)\r
-                       {       \r
-                               // TODO: If more than one dataflash chip, adjust absolute page address to be correct for the current chip,\r
-                               //       also the shifts may need to be altered to suit the dataflash model being used                          \r
-                               Dataflash_SendByte(PageAddress >> 5);\r
-                               Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));\r
-                               Dataflash_SendByte(BufferByte);\r
-                       }\r
-                       \r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  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 
+  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 
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/*
+   This is a stub driver header file, for implementing custom board
+   layout hardware with compatible LUFA board specific drivers. If
+   the library is configured to use the BOARD_USER board mode, this
+   driver file should be completed and copied into the "/Board/" folder
+   inside the application's folder.
+
+   This stub is for the board-specific component of the LUFA Dataflash
+   driver.
+*/
+
+#ifndef __DATAFLASH_USER_H__
+#define __DATAFLASH_USER_H__
+
+       /* Includes: */
+               // TODO: Add any required includes here
+
+       /* 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: */
+                       #define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all dataflashes
+                       #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. */
+                       #define DATAFLASH_TOTALCHIPS                 // TODO: Replace with the number of dataflashes on the board, max 2
+
+                       /** Mask for no dataflash chip selected. */
+                       #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
+
+                       /** Mask for the first dataflash chip selected. */
+                       #define DATAFLASH_CHIP1                      // TODO: Replace with mask to select the first Dataflash chip
+
+                       /** Mask for the second dataflash chip selected. */
+                       #define DATAFLASH_CHIP2                      // TODO: Replace with mask to select the second Dataflash chip, if available
+                       
+                       /** 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
+
+                       /** Total number of pages inside each of the board's dataflash ICs. */
+                       #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
+
+               /* Inline Functions: */
+                       /** 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
+                        *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
+                        *  are deselected.
+                        *
+                        *  \param[in] PageAddress  Address of the page to manipulate, ranging from
+                        *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
+                        */
+                       static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
+                       {
+                               Dataflash_DeselectChip();
+                               
+                               if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
+                                 return;
+
+                               // TODO: If more than one dataflash chip, select the correct chip from the page address here
+                               Dataflash_SelectChip(DATAFLASH_CHIP1);
+                       }
+
+                       /** 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.
+                        *
+                        *  \param[in] PageAddress  Page address within the selected dataflash IC
+                        *  \param[in] BufferByte   Address within the dataflash's buffer
+                        */
+                       static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
+                       {       
+                               // TODO: If more than one dataflash chip, adjust absolute page address to be correct for the current chip,
+                               //       also the shifts may need to be altered to suit the dataflash model being used                          
+                               Dataflash_SendByte(PageAddress >> 5);
+                               Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
+                               Dataflash_SendByte(BufferByte);
+                       }
+                       
+#endif