Merge commit '60b30c036397cb5627fa374bb930794b225daa29' as 'lib/lufa'

[qmk_firmware.git] / lib / lufa / Bootloaders / MassStorage / Lib / SCSI.h

diff --git a/lib/lufa/Bootloaders/MassStorage/Lib/SCSI.h b/lib/lufa/Bootloaders/MassStorage/Lib/SCSI.h
new file mode 100644 (file)
index 0000000..4195593
--- /dev/null
+++ b/lib/lufa/Bootloaders/MassStorage/Lib/SCSI.h
@@ -0,0 +1,84 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2017  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 disclaims 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/Drivers/USB/USB.h>
+
+               #include "../BootloaderMassStorage.h"
+               #include "../Descriptors.h"
+               #include "VirtualFAT.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)  do { SenseData.SenseKey                 = (Key);   \
+                                                               SenseData.AdditionalSenseCode      = (Acode); \
+                                                               SenseData.AdditionalSenseQualifier = (Aqual); } while (0)
+
+               /** 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
+
+       /* Function Prototypes: */
+               bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) AUX_BOOT_SECTION;
+
+               #if defined(INCLUDE_FROM_SCSI_C)
+                       static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) AUX_BOOT_SECTION;
+                       static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) AUX_BOOT_SECTION;
+                       static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) AUX_BOOT_SECTION;
+                       static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
+                                                             const bool IsDataRead) AUX_BOOT_SECTION;
+                       static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) AUX_BOOT_SECTION;
+               #endif
+
+#endif
+