Moved all source to the trunk directory.

[pub/lufa.git] / LUFA / DriverStubs / Dataflash.h

diff --git a/LUFA/DriverStubs/Dataflash.h b/LUFA/DriverStubs/Dataflash.h
new file mode 100644 (file)
index 0000000..0bef94e
--- /dev/null
+++ b/LUFA/DriverStubs/Dataflash.h
@@ -0,0 +1,81 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  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
+#endif\r