Moved out each demos' functionality library files (e.g. Ring Buffer library) to ...
[pub/lufa.git] / Demos / Device / MassStorage / Lib / SCSI.h
diff --git a/Demos/Device/MassStorage/Lib/SCSI.h b/Demos/Device/MassStorage/Lib/SCSI.h
new file mode 100644 (file)
index 0000000..d7693ca
--- /dev/null
@@ -0,0 +1,149 @@
+/*\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 key    New SCSI sense key to set the sense code to\r
+                *  \param acode  New SCSI additional sense key to set the additional sense code to\r
+                *  \param 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
+               void SCSI_DecodeSCSICommand(void);\r
+               \r
+               #if defined(INCLUDE_FROM_SCSI_C)\r
+                       static bool SCSI_Command_Inquiry(void);\r
+                       static bool SCSI_Command_Request_Sense(void);\r
+                       static bool SCSI_Command_Read_Capacity_10(void);\r
+                       static bool SCSI_Command_Send_Diagnostic(void);\r
+                       static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);\r
+               #endif\r
+               \r
+#endif\r