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 f642deb..a9d96f4 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-\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
-  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 SCSI.c.\r
- */\r
\r
-#ifndef _SCSI_H_\r
-#define _SCSI_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/pgmspace.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/LEDs.h>         // LEDs driver\r
-\r
-               #include "MassStorage.h"\r
-               #include "Descriptors.h"\r
-               #include "DataflashManager.h"\r
-               #include "SCSI_Codes.h"\r
-       \r
-       /* Macros: */\r
-               /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This\r
-                *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about\r
-                *  the last command failure) in a quick and easy manner.\r
-                *\r
-                *  \param[in] key    New SCSI sense key to set the sense code to\r
-                *  \param[in] acode  New SCSI additional sense key to set the additional sense code to\r
-                *  \param[in] aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to\r
-                */\r
-               #define SCSI_SET_SENSE(key, acode, aqual)  MACROS{ SenseData.SenseKey = key;              \\r
-                                                                  SenseData.AdditionalSenseCode = acode; \\r
-                                                                  SenseData.AdditionalSenseQualifier = aqual; }MACROE\r
-\r
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */\r
-               #define DATA_READ         true\r
-\r
-               /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */\r
-               #define DATA_WRITE        false\r
-\r
-               /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */\r
-               #define DEVICE_TYPE_BLOCK 0x00\r
-               \r
-               /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */\r
-               #define DEVICE_TYPE_CDROM 0x05\r
-\r
-       /* Type Defines: */\r
-               /** Type define for a SCSI response structure to a SCSI INQUIRY command. For details of the\r
-                *  structure contents, refer to the SCSI specifications.\r
-                */\r
-               typedef struct\r
-               {\r
-                       unsigned char DeviceType          : 5;\r
-                       unsigned char PeripheralQualifier : 3;\r
-                       \r
-                       unsigned char _RESERVED1          : 7;\r
-                       unsigned char Removable           : 1;\r
-                       \r
-                       uint8_t      Version;\r
-                       \r
-                       unsigned char ResponseDataFormat  : 4;\r
-                       unsigned char _RESERVED2          : 1;\r
-                       unsigned char NormACA             : 1;\r
-                       unsigned char TrmTsk              : 1;\r
-                       unsigned char AERC                : 1;\r
-\r
-                       uint8_t      AdditionalLength;\r
-                       uint8_t      _RESERVED3[2];\r
-\r
-                       unsigned char SoftReset           : 1;\r
-                       unsigned char CmdQue              : 1;\r
-                       unsigned char _RESERVED4          : 1;\r
-                       unsigned char Linked              : 1;\r
-                       unsigned char Sync                : 1;\r
-                       unsigned char WideBus16Bit        : 1;\r
-                       unsigned char WideBus32Bit        : 1;\r
-                       unsigned char RelAddr             : 1;\r
-                       \r
-                       uint8_t      VendorID[8];\r
-                       uint8_t      ProductID[16];\r
-                       uint8_t      RevisionID[4];\r
-               } SCSI_Inquiry_Response_t;\r
-               \r
-               /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the\r
-                *  structure contents, refer to the SCSI specifications.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t       ResponseCode;\r
-                       \r
-                       uint8_t       SegmentNumber;\r
-                       \r
-                       unsigned char SenseKey            : 4;\r
-                       unsigned char _RESERVED1          : 1;\r
-                       unsigned char ILI                 : 1;\r
-                       unsigned char EOM                 : 1;\r
-                       unsigned char FileMark            : 1;\r
-                       \r
-                       uint8_t      Information[4];\r
-                       uint8_t      AdditionalLength;\r
-                       uint8_t      CmdSpecificInformation[4];\r
-                       uint8_t      AdditionalSenseCode;\r
-                       uint8_t      AdditionalSenseQualifier;\r
-                       uint8_t      FieldReplaceableUnitCode;\r
-                       uint8_t      SenseKeySpecific[3];\r
-               } SCSI_Request_Sense_Response_t;\r
-               \r
-       /* Function Prototypes: */\r
-               bool SCSI_DecodeSCSICommand(void);\r
-               \r
-               #if defined(INCLUDE_FROM_SCSI_C)\r
-                       static void SCSI_Command_Inquiry(void);\r
-                       static void SCSI_Command_Request_Sense(void);\r
-                       static void SCSI_Command_Read_Capacity_10(void);\r
-                       static void SCSI_Command_Send_Diagnostic(void);\r
-                       static void SCSI_Command_ReadWrite_10(const bool IsDataRead);\r
-               #endif\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 SCSI.c.
+ */
+
+#ifndef _SCSI_H_
+#define _SCSI_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/pgmspace.h>
+
+               #include <LUFA/Common/Common.h>
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Board/LEDs.h>
+
+               #include "MassStorage.h"
+               #include "Descriptors.h"
+               #include "DataflashManager.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
+                */
+               #define SCSI_SET_SENSE(Key, Acode, Aqual)  MACROS{ SenseData.SenseKey                 = (Key);   \
+                                                                  SenseData.AdditionalSenseCode      = (Acode); \
+                                                                  SenseData.AdditionalSenseQualifier = (Aqual); }MACROE
+
+               /** 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 \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
+
+       /* Type Defines: */
+               /** Type define for a SCSI response structure to a SCSI INQUIRY command. For details of the
+                *  structure contents, refer to the SCSI specifications.
+                */
+               typedef struct
+               {
+                       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 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 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
+