Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / LowLevel / MassStorage / Lib / SCSI.h
index b4b6158..a9d96f4 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
@@ -32,7 +32,7 @@
  *
  *  Header file for SCSI.c.
  */
+
 #ifndef _SCSI_H_
 #define _SCSI_H_
 
                #include "MassStorage.h"
                #include "Descriptors.h"
                #include "DataflashManager.h"
-               #include "SCSI_Codes.h"
-       
+
        /* Macros: */
                /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This
                 *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about
                 *  the last command failure) in a quick and easy manner.
                 *
-                *  \param[in] key    New SCSI sense key to set the sense code to
-                *  \param[in] acode  New SCSI additional sense key to set the additional sense code to
-                *  \param[in] aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
+                *  \param[in] Key    New SCSI sense key to set the sense code to
+                *  \param[in] Acode  New SCSI additional sense key to set the additional sense code to
+                *  \param[in] Aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
                 */
-               #define SCSI_SET_SENSE(key, acode, aqual)  MACROS{ SenseData.SenseKey = (key);              \
-                                                                  SenseData.AdditionalSenseCode = (acode); \
-                                                                  SenseData.AdditionalSenseQualifier = (aqual); }MACROE
+               #define SCSI_SET_SENSE(Key, Acode, Aqual)  MACROS{ SenseData.SenseKey                 = (Key);   \
+                                                                  SenseData.AdditionalSenseCode      = (Acode); \
+                                                                  SenseData.AdditionalSenseQualifier = (Aqual); }MACROE
 
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
+               /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
                #define DATA_READ           true
 
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
+               /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
                #define DATA_WRITE          false
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
                #define DEVICE_TYPE_BLOCK   0x00
-               
+
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
                #define DEVICE_TYPE_CDROM   0x05
 
                 */
                typedef struct
                {
-                       unsigned char DeviceType          : 5;
-                       unsigned char PeripheralQualifier : 3;
-                       
-                       unsigned char _RESERVED1          : 7;
-                       unsigned char Removable           : 1;
-                       
-                       uint8_t       Version;
-                       
-                       unsigned char ResponseDataFormat  : 4;
-                       unsigned char _RESERVED2          : 1;
-                       unsigned char NormACA             : 1;
-                       unsigned char TrmTsk              : 1;
-                       unsigned char AERC                : 1;
-
-                       uint8_t       AdditionalLength;
-                       uint8_t       _RESERVED3[2];
-
-                       unsigned char SoftReset           : 1;
-                       unsigned char CmdQue              : 1;
-                       unsigned char _RESERVED4          : 1;
-                       unsigned char Linked              : 1;
-                       unsigned char Sync                : 1;
-                       unsigned char WideBus16Bit        : 1;
-                       unsigned char WideBus32Bit        : 1;
-                       unsigned char RelAddr             : 1;
-                       
-                       uint8_t       VendorID[8];
-                       uint8_t       ProductID[16];
-                       uint8_t       RevisionID[4];
-               } SCSI_Inquiry_Response_t;
-               
+                       unsigned DeviceType          : 5;
+                       unsigned PeripheralQualifier : 3;
+
+                       unsigned Reserved            : 7;
+                       unsigned Removable           : 1;
+
+                       uint8_t  Version;
+
+                       unsigned ResponseDataFormat  : 4;
+                       unsigned Reserved2           : 1;
+                       unsigned NormACA             : 1;
+                       unsigned TrmTsk              : 1;
+                       unsigned AERC                : 1;
+
+                       uint8_t  AdditionalLength;
+                       uint8_t  Reserved3[2];
+
+                       unsigned SoftReset           : 1;
+                       unsigned CmdQue              : 1;
+                       unsigned Reserved4           : 1;
+                       unsigned Linked              : 1;
+                       unsigned Sync                : 1;
+                       unsigned WideBus16Bit        : 1;
+                       unsigned WideBus32Bit        : 1;
+                       unsigned RelAddr             : 1;
+
+                       uint8_t  VendorID[8];
+                       uint8_t  ProductID[16];
+                       uint8_t  RevisionID[4];
+               } MS_SCSI_Inquiry_Response_t;
+
                /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the
                 *  structure contents, refer to the SCSI specifications.
                 */
                typedef struct
                {
-                       uint8_t       ResponseCode;
-                       
-                       uint8_t       SegmentNumber;
-                       
-                       unsigned char SenseKey            : 4;
-                       unsigned char _RESERVED1          : 1;
-                       unsigned char ILI                 : 1;
-                       unsigned char EOM                 : 1;
-                       unsigned char FileMark            : 1;
-                       
-                       uint8_t       Information[4];
-                       uint8_t       AdditionalLength;
-                       uint8_t       CmdSpecificInformation[4];
-                       uint8_t       AdditionalSenseCode;
-                       uint8_t       AdditionalSenseQualifier;
-                       uint8_t       FieldReplaceableUnitCode;
-                       uint8_t       SenseKeySpecific[3];
-               } SCSI_Request_Sense_Response_t;
-               
+                       uint8_t  ResponseCode;
+
+                       uint8_t  SegmentNumber;
+
+                       unsigned SenseKey            : 4;
+                       unsigned Reserved            : 1;
+                       unsigned ILI                 : 1;
+                       unsigned EOM                 : 1;
+                       unsigned FileMark            : 1;
+
+                       uint8_t  Information[4];
+                       uint8_t  AdditionalLength;
+                       uint8_t  CmdSpecificInformation[4];
+                       uint8_t  AdditionalSenseCode;
+                       uint8_t  AdditionalSenseQualifier;
+                       uint8_t  FieldReplaceableUnitCode;
+                       uint8_t  SenseKeySpecific[3];
+               } MS_SCSI_Request_Sense_Response_t;
+
        /* Function Prototypes: */
                bool SCSI_DecodeSCSICommand(void);
-               
+
                #if defined(INCLUDE_FROM_SCSI_C)
-                       static void SCSI_Command_Inquiry(void);
-                       static void SCSI_Command_Request_Sense(void);
-                       static void SCSI_Command_Read_Capacity_10(void);
-                       static void SCSI_Command_Send_Diagnostic(void);
-                       static void SCSI_Command_ReadWrite_10(const bool IsDataRead);
+                       static bool SCSI_Command_Inquiry(void);
+                       static bool SCSI_Command_Request_Sense(void);
+                       static bool SCSI_Command_Read_Capacity_10(void);
+                       static bool SCSI_Command_Send_Diagnostic(void);
+                       static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);
+                       static bool SCSI_Command_ModeSense_6(void);
                #endif
-               
+
 #endif
+