Add LUFA-side channel open/close routines, add signalling handlers for the creation...
[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / Lib / DataflashManager.h
index 1332fd3..92a0a8a 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
@@ -33,8 +33,8 @@
  *  Header file for DataflashManager.c.\r
  */\r
  \r
  *  Header file for DataflashManager.c.\r
  */\r
  \r
-#ifndef _DATAFLASH_MANAGER_H\r
-#define _DATAFLASH_MANAGER_H\r
+#ifndef _DATAFLASH_MANAGER_H_\r
+#define _DATAFLASH_MANAGER_H_\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
@@ -42,9 +42,9 @@
                #include "MassStorage.h"\r
                #include "Descriptors.h"\r
 \r
                #include "MassStorage.h"\r
                #include "Descriptors.h"\r
 \r
-               #include <LUFA/Common/Common.h>              // Function Attribute, Atomic, Debug and ISR Macros\r
-               #include <LUFA/Drivers/USB/USB.h>            // USB Functionality\r
-               #include <LUFA/Drivers/Board/Dataflash.h>    // Dataflash chip driver\r
+               #include <LUFA/Common/Common.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/Board/Dataflash.h>\r
 \r
        /* Preprocessor Checks: */\r
                #if (DATAFLASH_PAGE_SIZE % 16)\r
 \r
        /* Preprocessor Checks: */\r
                #if (DATAFLASH_PAGE_SIZE % 16)\r
                #define VIRTUAL_MEMORY_BYTES                ((uint32_t)DATAFLASH_PAGES * DATAFLASH_PAGE_SIZE * DATAFLASH_TOTALCHIPS)\r
 \r
                /** Block size of the device. This is kept at 512 to remain compatible with the OS despite the underlying\r
                #define VIRTUAL_MEMORY_BYTES                ((uint32_t)DATAFLASH_PAGES * DATAFLASH_PAGE_SIZE * DATAFLASH_TOTALCHIPS)\r
 \r
                /** Block size of the device. This is kept at 512 to remain compatible with the OS despite the underlying\r
-                *  storage media (Dataflash) using a different native block size.\r
+                *  storage media (Dataflash) using a different native block size. Do not change this value.\r
                 */\r
                #define VIRTUAL_MEMORY_BLOCK_SIZE           512\r
                \r
                 */\r
                #define VIRTUAL_MEMORY_BLOCK_SIZE           512\r
                \r
-               /** Total number of blocks of the virtual memory for reporting to the host as the device's total capacity. */\r
+               /** Total number of blocks of the virtual memory for reporting to the host as the device's total capacity. Do not\r
+                *  change this value; change VIRTUAL_MEMORY_BYTES instead to alter the media size.\r
+                */\r
                #define VIRTUAL_MEMORY_BLOCKS               (VIRTUAL_MEMORY_BYTES / VIRTUAL_MEMORY_BLOCK_SIZE)\r
                \r
        /* Function Prototypes: */\r
                #define VIRTUAL_MEMORY_BLOCKS               (VIRTUAL_MEMORY_BYTES / VIRTUAL_MEMORY_BLOCK_SIZE)\r
                \r
        /* Function Prototypes: */\r
@@ -71,5 +73,6 @@
                void DataflashManager_ReadBlocks_RAM(const uint32_t BlockAddress, uint16_t TotalBlocks,\r
                                                     uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);\r
                void DataflashManager_ResetDataflashProtections(void);\r
                void DataflashManager_ReadBlocks_RAM(const uint32_t BlockAddress, uint16_t TotalBlocks,\r
                                                     uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);\r
                void DataflashManager_ResetDataflashProtections(void);\r
+               bool DataflashManager_CheckDataflashOperation(void);\r
                \r
 #endif\r
                \r
 #endif\r