lib/lufa/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 disclaims 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/Common/Common.h>
  44                 #include <LUFA/Drivers/USB/USB.h>
  45                 #include <LUFA/Drivers/Board/LEDs.h>
  46
  47                 #include "../MassStorage.h"
  48                 #include "../Descriptors.h"
  49                 #include "DataflashManager.h"
  50
  51         /* Macros: */
  52                 /** Macro to set the current SCSI sense data to the given key, additional sense code and additional sense qualifier. This
  53                  *  is for convenience, as it allows for all three sense values (returned upon request to the host to give information about
  54                  *  the last command failure) in a quick and easy manner.
  55                  *
  56                  *  \param[in] Key    New SCSI sense key to set the sense code to
  57                  *  \param[in] Acode  New SCSI additional sense key to set the additional sense code to
  58                  *  \param[in] Aqual  New SCSI additional sense key qualifier to set the additional sense qualifier code to
  59                  */
  60                 #define SCSI_SET_SENSE(Key, Acode, Aqual)  do { SenseData.SenseKey                 = (Key);   \
  61                                                                 SenseData.AdditionalSenseCode      = (Acode); \
  62                                                                 SenseData.AdditionalSenseQualifier = (Aqual); } while (0)
  63
  64                 /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */
  65                 #define DATA_READ           true
  66
  67                 /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */
  68                 #define DATA_WRITE          false
  69
  70                 /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
  71                 #define DEVICE_TYPE_BLOCK   0x00
  72
  73                 /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a CD-ROM device. */
  74                 #define DEVICE_TYPE_CDROM   0x05
  75
  76         /* Type Defines: */
  77                 /** Type define for a SCSI response structure to a SCSI INQUIRY command. For details of the
  78                  *  structure contents, refer to the SCSI specifications.
  79                  */
  80                 typedef struct
  81                 {
  82                         unsigned DeviceType          : 5;
  83                         unsigned PeripheralQualifier : 3;
  84
  85                         unsigned Reserved            : 7;
  86                         unsigned Removable           : 1;
  87
  88                         uint8_t  Version;
  89
  90                         unsigned ResponseDataFormat  : 4;
  91                         unsigned Reserved2           : 1;
  92                         unsigned NormACA             : 1;
  93                         unsigned TrmTsk              : 1;
  94                         unsigned AERC                : 1;
  95
  96                         uint8_t  AdditionalLength;
  97                         uint8_t  Reserved3[2];
  98
  99                         unsigned SoftReset           : 1;
 100                         unsigned CmdQue              : 1;
 101                         unsigned Reserved4           : 1;
 102                         unsigned Linked              : 1;
 103                         unsigned Sync                : 1;
 104                         unsigned WideBus16Bit        : 1;
 105                         unsigned WideBus32Bit        : 1;
 106                         unsigned RelAddr             : 1;
 107
 108                         uint8_t  VendorID[8];
 109                         uint8_t  ProductID[16];
 110                         uint8_t  RevisionID[4];
 111                 } MS_SCSI_Inquiry_Response_t;
 112
 113                 /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the
 114                  *  structure contents, refer to the SCSI specifications.
 115                  */
 116                 typedef struct
 117                 {
 118                         uint8_t  ResponseCode;
 119
 120                         uint8_t  SegmentNumber;
 121
 122                         unsigned SenseKey            : 4;
 123                         unsigned Reserved            : 1;
 124                         unsigned ILI                 : 1;
 125                         unsigned EOM                 : 1;
 126                         unsigned FileMark            : 1;
 127
 128                         uint8_t  Information[4];
 129                         uint8_t  AdditionalLength;
 130                         uint8_t  CmdSpecificInformation[4];
 131                         uint8_t  AdditionalSenseCode;
 132                         uint8_t  AdditionalSenseQualifier;
 133                         uint8_t  FieldReplaceableUnitCode;
 134                         uint8_t  SenseKeySpecific[3];
 135                 } MS_SCSI_Request_Sense_Response_t;
 136
 137         /* Function Prototypes: */
 138                 bool SCSI_DecodeSCSICommand(void);
 139
 140                 #if defined(INCLUDE_FROM_SCSI_C)
 141                         static bool SCSI_Command_Inquiry(void);
 142                         static bool SCSI_Command_Request_Sense(void);
 143                         static bool SCSI_Command_Read_Capacity_10(void);
 144                         static bool SCSI_Command_Send_Diagnostic(void);
 145                         static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);
 146                         static bool SCSI_Command_ModeSense_6(void);
 147                 #endif
 148
 149 #endif
 150