Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/SCSI.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for SCSI.c.
  34  */
  35
  36 #ifndef _SCSI_H_
  37 #define _SCSI_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/pgmspace.h>
  42
  43                 #include <LUFA/Drivers/USB/USB.h>
  44
  45                 #include "VirtualSerialMassStorage.h"
  46                 #include "Descriptors.h"
  47                 #include "DataflashManager.h"
  48
  49         /* Macros: */
  50                 /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This
  51                  *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about
  52                  *  the last command failure) in a quick and easy manner.
  53                  *
  54                  *  \param[in] Key    New SCSI sense key to set the sense code to
  55                  *  \param[in] Acode  New SCSI additional sense key to set the additional sense code to
  56                  *  \param[in] Aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
  57                  */
  58                 #define SCSI_SET_SENSE(Key, Acode, Aqual)  MACROS{ SenseData.SenseKey                 = (Key);   \
  59                                                                    SenseData.AdditionalSenseCode      = (Acode); \
  60                                                                    SenseData.AdditionalSenseQualifier = (Aqual); }MACROE
  61
  62                 /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
  63                 #define DATA_READ           true
  64
  65                 /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
  66                 #define DATA_WRITE          false
  67
  68                 /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
  69                 #define DEVICE_TYPE_BLOCK   0x00
  70
  71                 /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
  72                 #define DEVICE_TYPE_CDROM   0x05
  73
  74         /* Function Prototypes: */
  75                 bool SCSI_DecodeSCSICommand(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  76
  77                 #if defined(INCLUDE_FROM_SCSI_C)
  78                         static bool SCSI_Command_Inquiry(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  79                         static bool SCSI_Command_Request_Sense(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  80                         static bool SCSI_Command_Read_Capacity_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  81                         static bool SCSI_Command_Send_Diagnostic(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  82                         static bool SCSI_Command_ReadWrite_10(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo,
  83                                                               const bool IsDataRead);
  84                         static bool SCSI_Command_ModeSense_6(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo);
  85                 #endif
  86
  87 #endif
  88