Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / MassStorage.h
index 6f5dd89..49a1866 100644 (file)
                /** SCSI Command Code for a MODE SENSE (10) command. */\r
                #define SCSI_CMD_MODE_SENSE_10                         0x5A\r
 \r
                /** SCSI Command Code for a MODE SENSE (10) command. */\r
                #define SCSI_CMD_MODE_SENSE_10                         0x5A\r
 \r
-               /** SCSI Sense Code to indicate no error has ocurred. */\r
+               /** SCSI Sense Code to indicate no error has occurred. */\r
                #define SCSI_SENSE_KEY_GOOD                            0x00\r
 \r
                /** SCSI Sense Code to indicate that the device has recovered from an error. */\r
                #define SCSI_SENSE_KEY_GOOD                            0x00\r
 \r
                /** SCSI Sense Code to indicate that the device has recovered from an error. */\r
                /** SCSI Sense Code to indicate an error whilst accessing the medium. */\r
                #define SCSI_SENSE_KEY_MEDIUM_ERROR                    0x03\r
 \r
                /** SCSI Sense Code to indicate an error whilst accessing the medium. */\r
                #define SCSI_SENSE_KEY_MEDIUM_ERROR                    0x03\r
 \r
-               /** SCSI Sense Code to indicate a hardware has ocurred. */\r
+               /** SCSI Sense Code to indicate a hardware has occurred. */\r
                #define SCSI_SENSE_KEY_HARDWARE_ERROR                  0x04\r
 \r
                /** SCSI Sense Code to indicate that an illegal request has been issued. */\r
                #define SCSI_SENSE_KEY_HARDWARE_ERROR                  0x04\r
 \r
                /** SCSI Sense Code to indicate that an illegal request has been issued. */\r
                /** SCSI Sense Code to indicate an error while trying to write to a write-once medium. */\r
                #define SCSI_SENSE_KEY_BLANK_CHECK                     0x08\r
 \r
                /** SCSI Sense Code to indicate an error while trying to write to a write-once medium. */\r
                #define SCSI_SENSE_KEY_BLANK_CHECK                     0x08\r
 \r
-               /** SCSI Sense Code to indicate a vendor specific error has ocurred. */\r
+               /** SCSI Sense Code to indicate a vendor specific error has occurred. */\r
                #define SCSI_SENSE_KEY_VENDOR_SPECIFIC                 0x09\r
 \r
                /** SCSI Sense Code to indicate that an EXTENDED COPY command has aborted due to an error. */\r
                #define SCSI_SENSE_KEY_VENDOR_SPECIFIC                 0x09\r
 \r
                /** SCSI Sense Code to indicate that an EXTENDED COPY command has aborted due to an error. */\r
                /** SCSI Additional Sense Code to indicate an invalid field was encountered while processing the issued command. */\r
                #define SCSI_ASENSE_INVALID_FIELD_IN_CDB               0x24\r
 \r
                /** SCSI Additional Sense Code to indicate an invalid field was encountered while processing the issued command. */\r
                #define SCSI_ASENSE_INVALID_FIELD_IN_CDB               0x24\r
 \r
-               /** SCSI Additional Sense Code to indicate that an attemp to write to a protected area was made. */\r
+               /** SCSI Additional Sense Code to indicate that an attempt to write to a protected area was made. */\r
                #define SCSI_ASENSE_WRITE_PROTECTED                    0x27\r
 \r
                /** SCSI Additional Sense Code to indicate an error whilst formatting the device medium. */\r
                #define SCSI_ASENSE_WRITE_PROTECTED                    0x27\r
 \r
                /** SCSI Additional Sense Code to indicate an error whilst formatting the device medium. */\r
                        uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
                } MS_CommandStatusWrapper_t;\r
                \r
                        uint8_t  Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
                } MS_CommandStatusWrapper_t;\r
                \r
+               /** Type define for a SCSI Sense structure. Structures of this type are filled out by the\r
+                *  device via the MassStore_RequestSense() function, indicating the current sense data of the\r
+                *  device (giving explicit error codes for the last issued command). For details of the\r
+                *  structure contents, refer to the SCSI specifications.\r
+                */\r
+               typedef struct\r
+               {\r
+                       uint8_t       ResponseCode;\r
+\r
+                       uint8_t       SegmentNumber;\r
+                       \r
+                       unsigned char SenseKey            : 4;\r
+                       unsigned char _RESERVED1          : 1;\r
+                       unsigned char ILI                 : 1;\r
+                       unsigned char EOM                 : 1;\r
+                       unsigned char FileMark            : 1;\r
+                       \r
+                       uint8_t      Information[4];\r
+                       uint8_t      AdditionalLength;\r
+                       uint8_t      CmdSpecificInformation[4];\r
+                       uint8_t      AdditionalSenseCode;\r
+                       uint8_t      AdditionalSenseQualifier;\r
+                       uint8_t      FieldReplaceableUnitCode;\r
+                       uint8_t      SenseKeySpecific[3];\r
+               } SCSI_Request_Sense_Response_t;\r
+\r
+               /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the\r
+                *  device via the MassStore_Inquiry() function, retrieving the attached device's information.\r
+                *  For details of the structure contents, refer to the SCSI specifications.\r
+                */\r
+               typedef struct\r
+               {\r
+                       unsigned char DeviceType          : 5;\r
+                       unsigned char PeripheralQualifier : 3;\r
+                       \r
+                       unsigned char _RESERVED1          : 7;\r
+                       unsigned char Removable           : 1;\r
+                       \r
+                       uint8_t      Version;\r
+                       \r
+                       unsigned char ResponseDataFormat  : 4;\r
+                       unsigned char _RESERVED2          : 1;\r
+                       unsigned char NormACA             : 1;\r
+                       unsigned char TrmTsk              : 1;\r
+                       unsigned char AERC                : 1;\r
+\r
+                       uint8_t      AdditionalLength;\r
+                       uint8_t      _RESERVED3[2];\r
+\r
+                       unsigned char SoftReset           : 1;\r
+                       unsigned char CmdQue              : 1;\r
+                       unsigned char _RESERVED4          : 1;\r
+                       unsigned char Linked              : 1;\r
+                       unsigned char Sync                : 1;\r
+                       unsigned char WideBus16Bit        : 1;\r
+                       unsigned char WideBus32Bit        : 1;\r
+                       unsigned char RelAddr             : 1;\r
+                       \r
+                       uint8_t      VendorID[8];\r
+                       uint8_t      ProductID[16];\r
+                       uint8_t      RevisionID[4];\r
+               } SCSI_Inquiry_Response_t;\r
+\r
        /* Enums: */\r
                /** Enum for the possible command status wrapper return status codes. */\r
                enum MassStorage_CommandStatusCodes_t\r
        /* Enums: */\r
                /** Enum for the possible command status wrapper return status codes. */\r
                enum MassStorage_CommandStatusCodes_t\r