Added new VirtualSerialMassStorage Device Class Driver demo.
[pub/lufa.git] / Demos / Device / ClassDriver / VirtualSerialMassStorage / Lib / SCSI.h
diff --git a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.h
new file mode 100644 (file)
index 0000000..96c8d6a
--- /dev/null
@@ -0,0 +1,88 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2011.\r
+\r
+  dean [at] fourwalledcubicle [dot] com\r
+           www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+  Copyright 2011  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 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/Drivers/USB/USB.h>\r
+\r
+               #include "VirtualSerialMassStorage.h"\r
+               #include "Descriptors.h"\r
+               #include "DataflashManager.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 \ref 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 \ref 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
+       /* Function Prototypes: */\r
+               bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+\r
+               #if defined(INCLUDE_FROM_SCSI_C)\r
+                       static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+                       static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+                       static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+                       static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+                       static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,\r
+                                                             const bool IsDataRead);\r
+                       static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);\r
+               #endif\r
+\r
+#endif\r
+\r