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