Demos/MassStorage/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 key    New SCSI sense key to set the sense code to
  58                  *  \param acode  New SCSI additional sense key to set the additional sense code to
  59                  *  \param 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         /* Type Defines: */
  72                 /** Type define for a SCSI response structure to a SCSI INQUIRY command. For details of the
  73                  *  structure contents, refer to the SCSI specifications.
  74                  */
  75                 typedef struct
  76                 {
  77                         unsigned int DeviceType          : 5;
  78                         unsigned int PeripheralQualifier : 3;
  79
  80                         unsigned int _RESERVED1          : 7;
  81                         unsigned int Removable           : 1;
  82
  83                         uint8_t      Version;
  84
  85                         unsigned int ResponseDataFormat  : 4;
  86                         unsigned int _RESERVED2          : 1;
  87                         unsigned int NormACA             : 1;
  88                         unsigned int TrmTsk              : 1;
  89                         unsigned int AERC                : 1;
  90
  91                         uint8_t      AdditionalLength;
  92                         uint8_t      _RESERVED3[2];
  93
  94                         unsigned int SoftReset           : 1;
  95                         unsigned int CmdQue              : 1;
  96                         unsigned int _RESERVED4          : 1;
  97                         unsigned int Linked              : 1;
  98                         unsigned int Sync                : 1;
  99                         unsigned int WideBus16Bit        : 1;
 100                         unsigned int WideBus32Bit        : 1;
 101                         unsigned int RelAddr             : 1;
 102
 103                         uint8_t      VendorID[8];
 104                         uint8_t      ProductID[16];
 105                         uint8_t      RevisionID[4];
 106                 } SCSI_Inquiry_Response_t;
 107
 108                 /** Type define for a SCSI sense structure to a SCSI REQUEST SENSE command. For details of the
 109                  *  structure contents, refer to the SCSI specifications.
 110                  */
 111                 typedef struct
 112                 {
 113                         uint8_t      ResponseCode;
 114
 115                         uint8_t      SegmentNumber;
 116
 117                         unsigned int SenseKey            : 4;
 118                         unsigned int _RESERVED1          : 1;
 119                         unsigned int ILI                 : 1;
 120                         unsigned int EOM                 : 1;
 121                         unsigned int FileMark            : 1;
 122
 123                         uint8_t      Information[4];
 124                         uint8_t      AdditionalLength;
 125                         uint8_t      CmdSpecificInformation[4];
 126                         uint8_t      AdditionalSenseCode;
 127                         uint8_t      AdditionalSenseQualifier;
 128                         uint8_t      FieldReplaceableUnitCode;
 129                         uint8_t      SenseKeySpecific[3];
 130                 } SCSI_Request_Sense_Response_t;
 131
 132         /* Function Prototypes: */
 133                 void SCSI_DecodeSCSICommand(void);
 134
 135                 #if defined(INCLUDE_FROM_SCSI_C)
 136                         static bool SCSI_Command_Inquiry(void);
 137                         static bool SCSI_Command_Request_Sense(void);
 138                         static bool SCSI_Command_Read_Capacity_10(void);
 139                         static bool SCSI_Command_Send_Diagnostic(void);
 140                         static bool SCSI_Command_ReadWrite_10(const bool IsDataRead);
 141                 #endif
 142
 143 #endif