/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting \r
+ documentation, and that the name of the author not be used in \r
+ advertising or publicity pertaining to distribution of the \r
software without specific, written prior permission.\r
\r
The author disclaim all warranties with regard to this\r
*/\r
\r
/** \ingroup Group_USBClassMS\r
+ * @defgroup Group_USBClassMSCommon Common Class Definitions\r
+ *\r
+ * \section Module Description\r
+ * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
+ * Mass Storage Class.\r
+ *\r
* @{\r
*/\r
\r
/** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */\r
#define MS_COMMAND_DIR_DATA_IN (1 << 7)\r
\r
+ /** SCSI Command Code for an INQUIRY command. */\r
+ #define SCSI_CMD_INQUIRY 0x12\r
+\r
+ /** SCSI Command Code for a REQUEST SENSE command. */\r
+ #define SCSI_CMD_REQUEST_SENSE 0x03\r
+\r
+ /** SCSI Command Code for a TEST UNIT READY command. */\r
+ #define SCSI_CMD_TEST_UNIT_READY 0x00\r
+\r
+ /** SCSI Command Code for a READ CAPACITY (10) command. */\r
+ #define SCSI_CMD_READ_CAPACITY_10 0x25\r
+\r
+ /** SCSI Command Code for a SEND DIAGNOSTIC command. */\r
+ #define SCSI_CMD_SEND_DIAGNOSTIC 0x1D\r
+\r
+ /** SCSI Command Code for a PREVENT ALLOW MEDIUM REMOVAL command. */\r
+ #define SCSI_CMD_PREVENT_ALLOW_MEDIUM_REMOVAL 0x1E\r
+\r
+ /** SCSI Command Code for a WRITE (10) command. */\r
+ #define SCSI_CMD_WRITE_10 0x2A\r
+\r
+ /** SCSI Command Code for a READ (10) command. */\r
+ #define SCSI_CMD_READ_10 0x28\r
+\r
+ /** SCSI Command Code for a WRITE (6) command. */\r
+ #define SCSI_CMD_WRITE_6 0x0A\r
+\r
+ /** SCSI Command Code for a READ (6) command. */\r
+ #define SCSI_CMD_READ_6 0x08\r
+\r
+ /** SCSI Command Code for a VERIFY (10) command. */\r
+ #define SCSI_CMD_VERIFY_10 0x2F\r
+\r
+ /** SCSI Command Code for a MODE SENSE (6) command. */\r
+ #define SCSI_CMD_MODE_SENSE_6 0x1A\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 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_RECOVERED_ERROR 0x01\r
+\r
+ /** SCSI Sense Code to indicate that the device is not ready for a new command. */\r
+ #define SCSI_SENSE_KEY_NOT_READY 0x02\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 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_ILLEGAL_REQUEST 0x05\r
+\r
+ /** SCSI Sense Code to indicate that the unit requires attention from the host to indicate\r
+ * a reset event, medium removal or other condition.\r
+ */\r
+ #define SCSI_SENSE_KEY_UNIT_ATTENTION 0x06\r
+\r
+ /** SCSI Sense Code to indicate that a write attempt on a protected block has been made. */\r
+ #define SCSI_SENSE_KEY_DATA_PROTECT 0x07\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 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_COPY_ABORTED 0x0A\r
+\r
+ /** SCSI Sense Code to indicate that the device has aborted the issued command. */\r
+ #define SCSI_SENSE_KEY_ABORTED_COMMAND 0x0B\r
+\r
+ /** SCSI Sense Code to indicate an attempt to write past the end of a partition has been made. */\r
+ #define SCSI_SENSE_KEY_VOLUME_OVERFLOW 0x0D\r
+\r
+ /** SCSI Sense Code to indicate that the source data did not match the data read from the medium. */\r
+ #define SCSI_SENSE_KEY_MISCOMPARE 0x0E\r
+\r
+ /** SCSI Additional Sense Code to indicate no additional sense information is available. */\r
+ #define SCSI_ASENSE_NO_ADDITIONAL_INFORMATION 0x00\r
+\r
+ /** SCSI Additional Sense Code to indicate that the logical unit (LUN) addressed is not ready. */\r
+ #define SCSI_ASENSE_LOGICAL_UNIT_NOT_READY 0x04\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 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_FORMAT_ERROR 0x31\r
+\r
+ /** SCSI Additional Sense Code to indicate an invalid command was issued. */\r
+ #define SCSI_ASENSE_INVALID_COMMAND 0x20\r
+\r
+ /** SCSI Additional Sense Code to indicate a write to a block out outside of the medium's range was issued. */\r
+ #define SCSI_ASENSE_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE 0x21\r
+\r
+ /** SCSI Additional Sense Code to indicate that no removable medium is inserted into the device. */\r
+ #define SCSI_ASENSE_MEDIUM_NOT_PRESENT 0x3A\r
+\r
+ /** SCSI Additional Sense Qualifier Code to indicate no additional sense qualifier information is available. */\r
+ #define SCSI_ASENSEQ_NO_QUALIFIER 0x00\r
+\r
+ /** SCSI Additional Sense Qualifier Code to indicate that a medium format command failed to complete. */\r
+ #define SCSI_ASENSEQ_FORMAT_COMMAND_FAILED 0x01\r
+\r
+ /** SCSI Additional Sense Qualifier Code to indicate that an initializing command must be issued before the issued\r
+ * command can be executed.\r
+ */\r
+ #define SCSI_ASENSEQ_INITIALIZING_COMMAND_REQUIRED 0x02\r
+\r
+ /** SCSI Additional Sense Qualifier Code to indicate that an operation is currently in progress. */\r
+ #define SCSI_ASENSEQ_OPERATION_IN_PROGRESS 0x07\r
+ \r
/* Type defines: */\r
/** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
typedef struct\r
uint8_t LUN; /**< Logical Unit number this command is issued to */\r
uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */\r
uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block */\r
- } CommandBlockWrapper_t;\r
+ } MS_CommandBlockWrapper_t;\r
\r
/** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
typedef struct\r
uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */\r
uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
- } CommandStatusWrapper_t;\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
projects / pub / USBasp.git / blobdiff