Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / MassStorage.h
index 7ebb06d..c08e630 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
-/** \file\r
- *\r
- *  Header file for MassStorage.c.\r
- */\r
-\r
-#ifndef _MASS_STORAGE_H_\r
-#define _MASS_STORAGE_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/wdt.h>\r
-               #include <avr/power.h>\r
-\r
-               #include "Descriptors.h"\r
-\r
-               #include "Lib/SCSI.h"\r
-               #include "Lib/DataflashManager.h"\r
-\r
-               #include <LUFA/Version.h>\r
-               #include <LUFA/Drivers/USB/USB.h>\r
-               #include <LUFA/Drivers/Board/LEDs.h>\r
-               #include <LUFA/Drivers/Board/Dataflash.h>\r
-\r
-       /* Macros: */\r
-               /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */\r
-               #define REQ_MassStorageReset       0xFF\r
-\r
-               /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */\r
-               #define REQ_GetMaxLUN              0xFE\r
-\r
-               /** Maximum length of a SCSI command which can be issued by the device or host in a Mass Storage bulk wrapper. */\r
-               #define MAX_SCSI_COMMAND_LENGTH    16\r
-               \r
-               /** Total number of Logical Units (drives) in the device. The total device capacity is shared equally between\r
-                *  each drive - this can be set to any positive non-zero amount.\r
-                */\r
-               #define TOTAL_LUNS                 1\r
-               \r
-               /** Blocks in each LUN, calculated from the total capacity divided by the total number of Logical Units in the device. */\r
-               #define LUN_MEDIA_BLOCKS           (VIRTUAL_MEMORY_BLOCKS / TOTAL_LUNS)    \r
-               \r
-               /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define CBW_SIGNATURE              0x43425355UL\r
-\r
-               /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
-               #define CSW_SIGNATURE              0x53425355UL\r
-               \r
-               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */\r
-               #define COMMAND_DIRECTION_DATA_OUT (0 << 7)\r
-\r
-               /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */\r
-               #define COMMAND_DIRECTION_DATA_IN  (1 << 7)\r
-\r
-               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
-               #define LEDMASK_USB_NOTREADY      LEDS_LED1\r
-\r
-               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */\r
-               #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)\r
-\r
-               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */\r
-               #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)\r
-\r
-               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
-               #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
-\r
-               /** LED mask for the library LED driver, to indicate that the USB interface is busy. */\r
-               #define LEDMASK_USB_BUSY          LEDS_LED2\r
-               \r
-       /* Type defines: */\r
-               /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
-               typedef struct\r
-               {\r
-                       uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */\r
-                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
-                       uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */\r
-                       uint8_t  Flags; /**< Command block flags, indicating command data direction */\r
-                       uint8_t  LUN; /**< Logical Unit number this command is issued to */\r
-                       uint8_t  SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */\r
-                       uint8_t  SCSICommandData[MAX_SCSI_COMMAND_LENGTH]; /**< Issued SCSI command in the Command Block */\r
-               } CommandBlockWrapper_t;\r
-               \r
-               /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
-               typedef struct\r
-               {\r
-                       uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */\r
-                       uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
-                       uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */\r
-                       uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
-               } CommandStatusWrapper_t;\r
-               \r
-       /* Enums: */\r
-               /** Enum for the possible command status wrapper return status codes. */\r
-               enum MassStorage_CommandStatusCodes_t\r
-               {\r
-                       Command_Pass = 0, /**< Command completed with no error */\r
-                       Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
-                       Phase_Error  = 2  /**< Command failed due to being invalid in the current phase */\r
-               };\r
-               \r
-       /* Global Variables: */\r
-               extern CommandBlockWrapper_t  CommandBlock;\r
-               extern CommandStatusWrapper_t CommandStatus;\r
-               extern volatile bool          IsMassStoreReset;\r
-               \r
-       /* Function Prototypes: */\r
-               void SetupHardware(void);\r
-               void MassStorage_Task(void);\r
-       \r
-               void EVENT_USB_Device_Connect(void);\r
-               void EVENT_USB_Device_Disconnect(void);\r
-               void EVENT_USB_Device_ConfigurationChanged(void);\r
-               void EVENT_USB_Device_UnhandledControlRequest(void);\r
-\r
-               #if defined(INCLUDE_FROM_MASSSTORAGE_C)\r
-                       static bool ReadInCommandBlock(void);\r
-                       static void ReturnCommandStatus(void);\r
-               #endif\r
-\r
-               uint8_t StreamCallback_AbortOnMassStoreReset(void);\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  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.
+*/
+
+/** \file
+ *
+ *  Header file for MassStorage.c.
+ */
+
+#ifndef _MASS_STORAGE_H_
+#define _MASS_STORAGE_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/wdt.h>
+               #include <avr/power.h>
+               #include <avr/interrupt.h>
+
+               #include "Descriptors.h"
+
+               #include "Lib/SCSI.h"
+               #include "Lib/DataflashManager.h"
+
+               #include <LUFA/Version.h>
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Board/LEDs.h>
+               #include <LUFA/Drivers/Board/Dataflash.h>
+
+       /* Macros: */
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
+               #define LEDMASK_USB_NOTREADY       LEDS_LED1
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
+               #define LEDMASK_USB_ENUMERATING   (LEDS_LED2 | LEDS_LED3)
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
+               #define LEDMASK_USB_READY         (LEDS_LED2 | LEDS_LED4)
+
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
+               #define LEDMASK_USB_ERROR         (LEDS_LED1 | LEDS_LED3)
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is busy. */
+               #define LEDMASK_USB_BUSY           LEDS_LED2
+
+               /** Indicates if the disk is write protected or not. */
+               #define DISK_READ_ONLY            false
+
+       /* Global Variables: */
+               extern MS_CommandBlockWrapper_t  CommandBlock;
+               extern MS_CommandStatusWrapper_t CommandStatus;
+               extern volatile bool             IsMassStoreReset;
+
+       /* Function Prototypes: */
+               void SetupHardware(void);
+               void MassStorage_Task(void);
+
+               void EVENT_USB_Device_Connect(void);
+               void EVENT_USB_Device_Disconnect(void);
+               void EVENT_USB_Device_ConfigurationChanged(void);
+               void EVENT_USB_Device_ControlRequest(void);
+
+               #if defined(INCLUDE_FROM_MASSSTORAGE_C)
+                       static bool ReadInCommandBlock(void);
+                       static void ReturnCommandStatus(void);
+               #endif
+
+               uint8_t StreamCallback_AbortOnMassStoreReset(void);
+
+#endif
+