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

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