Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / ClassDriver / MassStorageKeyboard / Lib / DataflashManager.h

diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h
index 248fa32..d7f8605 100644 (file)
--- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h
+++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  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


@@ -32,13 +32,13 @@
  *
  *  Header file for DataflashManager.c.
  */
  *
  *  Header file for DataflashManager.c.
  */

- 
+

 #ifndef _DATAFLASH_MANAGER_H_
 #define _DATAFLASH_MANAGER_H_
 
        /* Includes: */
                #include <avr/io.h>
 #ifndef _DATAFLASH_MANAGER_H_
 #define _DATAFLASH_MANAGER_H_
 
        /* Includes: */
                #include <avr/io.h>

-               
+

                #include "MassStorageKeyboard.h"
                #include "Descriptors.h"
 
                #include "MassStorageKeyboard.h"
                #include "Descriptors.h"
 


@@ -52,32 +52,32 @@
                #endif
 
        /* Defines: */
                #endif
 
        /* Defines: */

-               /** Total number of bytes of the storage medium, comprised of one or more dataflash ICs. */
+               /** Total number of bytes of the storage medium, comprised of one or more Dataflash ICs. */

                #define VIRTUAL_MEMORY_BYTES                ((uint32_t)DATAFLASH_PAGES * DATAFLASH_PAGE_SIZE * DATAFLASH_TOTALCHIPS)
 
                /** Block size of the device. This is kept at 512 to remain compatible with the OS despite the underlying
                 *  storage media (Dataflash) using a different native block size.
                 */
                #define VIRTUAL_MEMORY_BLOCK_SIZE           512
                #define VIRTUAL_MEMORY_BYTES                ((uint32_t)DATAFLASH_PAGES * DATAFLASH_PAGE_SIZE * DATAFLASH_TOTALCHIPS)
 
                /** Block size of the device. This is kept at 512 to remain compatible with the OS despite the underlying
                 *  storage media (Dataflash) using a different native block size.
                 */
                #define VIRTUAL_MEMORY_BLOCK_SIZE           512

-               
+

                /** Total number of blocks of the virtual memory for reporting to the host as the device's total capacity. */
                #define VIRTUAL_MEMORY_BLOCKS              (VIRTUAL_MEMORY_BYTES / VIRTUAL_MEMORY_BLOCK_SIZE)
                /** Total number of blocks of the virtual memory for reporting to the host as the device's total capacity. */
                #define VIRTUAL_MEMORY_BLOCKS              (VIRTUAL_MEMORY_BYTES / VIRTUAL_MEMORY_BLOCK_SIZE)

-               
-               /** Total number of logical drives within the device - must be non-zero. */
-               #define TOTAL_LUNS                          1
-               
-               /** Blocks in each LUN, calculated from the total capacity divided by the total number of Logical Units in the device. */
-               #define LUN_MEDIA_BLOCKS                   (VIRTUAL_MEMORY_BLOCKS / TOTAL_LUNS)
-               
+

        /* Function Prototypes: */
        /* Function Prototypes: */

-               void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const uint32_t BlockAddress,
+               void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
+                                                 const uint32_t BlockAddress,

                                                  uint16_t TotalBlocks);
                                                  uint16_t TotalBlocks);

-               void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* MSInterfaceInfo, const uint32_t BlockAddress,
+               void DataflashManager_ReadBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
+                                                const uint32_t BlockAddress,

                                                 uint16_t TotalBlocks);
                                                 uint16_t TotalBlocks);

-               void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, uint16_t TotalBlocks,
+               void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
+                                                     uint16_t TotalBlocks,

                                                      uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);
                                                      uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);

-               void DataflashManager_ReadBlocks_RAM(const uint32_t BlockAddress, uint16_t TotalBlocks,
+               void DataflashManager_ReadBlocks_RAM(const uint32_t BlockAddress,
+                                                    uint16_t TotalBlocks,

                                                     uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);
                void DataflashManager_ResetDataflashProtections(void);
                                                     uint8_t* BufferPtr) ATTR_NON_NULL_PTR_ARG(3);
                void DataflashManager_ResetDataflashProtections(void);

-               
+               bool DataflashManager_CheckDataflashOperation(void);
+

 #endif
 #endif

+