Changeset f7a55f9 in mainline

Timestamp:

2011-07-05T10:43:21Z (13 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

5e2aa83, bee37cf

Parents:

b5085a7

Message:

Implement Read and Request Sense commands for USB mass storage. In bulk-only
transport fix case when less data is returned by padding + residue. Add note
for case when less data is returned by stalling the pipe.

Location:

uspace

Files:

• drv/bus/usb/usbmast/main.c (modified) (1 diff)
• drv/bus/usb/usbmast/mast.c (modified) (4 diffs)
• drv/bus/usb/usbmast/scsi_ms.c (modified) (3 diffs)
• drv/bus/usb/usbmast/scsi_ms.h (modified) (1 diff)
• lib/scsi/include/scsi/spc.h (modified) (3 diffs)

uspace/drv/bus/usb/usbmast/main.c

@@ -138 +138 @@
             "block_size=%" PRIu32 "\n", nblocks, block_size);
 
+        usb_log_info("Doing test read of block 0.\n");
+        static uint8_t bdata[512];
+
+        rc = usbmast_read(dev, 0, 1, 512, &bdata);
+        if (rc != EOK) {
+                usb_log_warning("Failed to read block 0, device `%s': %s.\n",
+                    dev->ddf_dev->name, str_error(rc));
+                return EOK;
+        }
+
+        usb_log_info("Requesting sense data.\n");
+        static scsi_sense_data_t sdata;
+
+        rc = usbmast_request_sense(dev, &sdata, sizeof(sdata));
+        if (rc != EOK) {
+                usb_log_warning("Failed to get sense data, device `%s': %s.\n",
+                    dev->ddf_dev->name, str_error(rc));
+                return EOK;
+        }
+
         return EOK;
 }

uspace/drv/bus/usb/usbmast/mast.c

@@ -92 +92 @@
             str_error(rc));
         if (rc != EOK) {
+                /*
+                 * XXX If the pipe is stalled, we should clear it
+                 * and read CSW.
+                 */
                 return rc;
         }
@@ -103 +107 @@
             str_error(rc));
         if (rc != EOK) {
-                return rc;
-        }
+                MASTLOG("rc != EOK\n");
+                return rc;
+        }
+
         if (csw_size != sizeof(csw)) {
+                MASTLOG("csw_size != sizeof(csw)\n");
                 return ERANGE;
         }
 
         if (csw.dCSWTag != tag) {
+                MASTLOG("csw.dCSWTag != tag\n");
                 return EBADCHECKSUM;
         }
@@ -117 +125 @@
          */
         if (csw.dCSWStatus != 0) {
+                MASTLOG("csw.dCSWStatus != 0\n");
                 // FIXME: better error code
                 // FIXME: distinguish 0x01 and 0x02
@@ -124 +133 @@
         size_t residue = (size_t) uint32_usb2host(csw.dCSWDataResidue);
         if (residue > in_buffer_size) {
+                MASTLOG("residue > in_buffer_size\n");
                 return ERANGE;
         }
-        if (act_size != in_buffer_size - residue) {
-                return ERANGE;
-        }
+
+        /*
+         * When the device has less data to send than requested, it can
+         * either stall the pipe or send garbage and indicate that via
+         * the residue field in CSW. That means in_buffer_size - residue
+         * is the authoritative size of data received.
+         */
+
         if (received_size != NULL) {
                 *received_size = in_buffer_size - residue;

uspace/drv/bus/usb/usbmast/scsi_ms.c

@@ -38 +38 @@
 #include <byteorder.h>
 #include <inttypes.h>
+#include <macros.h>
 #include <usb/dev/driver.h>
 #include <usb/debug.h>
@@ -115 +116 @@
 }
 
+/** Perform SCSI Request Sense command on USB mass storage device.
+ *
+ * @param dev           USB device
+ * @param buf           Destination buffer
+ * @param size          Size of @a buf
+ *
+ * @return              Error code.
+ */
+int usbmast_request_sense(usb_device_t *dev, void *buf, size_t size)
+{
+        scsi_cdb_request_sense_t cdb;
+        size_t data_len;
+        int rc;
+
+        memset(&cdb, 0, sizeof(cdb));
+        cdb.op_code = SCSI_CMD_REQUEST_SENSE;
+        cdb.alloc_len = min(size, SCSI_SENSE_DATA_MAX_SIZE);
+
+        rc = usb_massstor_data_in(dev, 0xDEADBEEF, 0, (uint8_t *) &cdb,
+            sizeof(cdb), buf, size, &data_len);
+
+        if (rc != EOK) {
+                usb_log_error("Request Sense failed, device %s: %s.\n",
+                   dev->ddf_dev->name, str_error(rc));
+                return rc;
+        }
+
+        if (data_len < SCSI_SENSE_DATA_MIN_SIZE) {
+                /* The missing bytes should be considered to be zeroes. */
+                memset((uint8_t *)buf + data_len, 0,
+                    SCSI_SENSE_DATA_MIN_SIZE - data_len);
+        }
+
+        return EOK;
+}
+
 /** Perform SCSI Read Capacity command on USB mass storage device.
  *
@@ -155 +192 @@
 }
 
+/** Perform SCSI Read command on USB mass storage device.
+ *
+ * @param dev           USB device.
+ * @param ba            Address of first block.
+ * @param nblocks       Number of blocks to read.
+ * @param bsize         Block size.
+ *
+ * @return              Error code.
+ */
+int usbmast_read(usb_device_t *dev, uint64_t ba, size_t nblocks, size_t bsize,
+    void *buf)
+{
+        scsi_cdb_read_12_t cdb;
+        size_t data_len;
+        int rc;
+
+        /* XXX Need softstate to store block size. */
+
+        if (ba > UINT32_MAX)
+                return ELIMIT;
+
+        if ((uint64_t)nblocks * bsize > UINT32_MAX)
+                return ELIMIT;
+
+        memset(&cdb, 0, sizeof(cdb));
+        cdb.op_code = SCSI_CMD_READ_12;
+        cdb.lba = host2uint32_t_be(ba);
+        cdb.xfer_len = host2uint32_t_be(nblocks);
+
+        rc = usb_massstor_data_in(dev, 0xDEADBEEF, 0, (uint8_t *) &cdb,
+            sizeof(cdb), buf, nblocks * bsize, &data_len);
+
+        if (rc != EOK) {
+                usb_log_error("Read (12) failed, device %s: %s.\n",
+                   dev->ddf_dev->name, str_error(rc));
+                return rc;
+        }
+
+        if (data_len < nblocks * bsize) {
+                usb_log_error("SCSI Read response too short (%zu).\n",
+                    data_len);
+                return EIO;
+        }
+
+        return EOK;
+}
+
 /**
  * @}

uspace/drv/bus/usb/usbmast/scsi_ms.h

@@ -60 +60 @@
 
 extern int usbmast_inquiry(usb_device_t *, usbmast_inquiry_data_t *);
-extern int usbmast_read_capacity(usb_device_t *dev, uint32_t *, uint32_t *);
+extern int usbmast_request_sense(usb_device_t *, void *, size_t);
+extern int usbmast_read_capacity(usb_device_t *, uint32_t *, uint32_t *);
+extern int usbmast_read(usb_device_t *, uint64_t, size_t, size_t, void *);
 extern const char *usbmast_scsi_dev_type_str(unsigned);
 

uspace/lib/scsi/include/scsi/spc.h

@@ -42 +42 @@
 /** SCSI command codes defined in SCSI-SPC */
 enum scsi_cmd_spc {
-        SCSI_CMD_INQUIRY        = 0x12
+        SCSI_CMD_INQUIRY        = 0x12,
+        SCSI_CMD_REQUEST_SENSE  = 0x03
 };
 
 /** SCSI Inquiry command */
 typedef struct {
-        /** Operation code (12h, SCSI_CMD_INQUIRY) */
+        /** Operation code (SCSI_CMD_INQUIRY) */
         uint8_t op_code;
         /** Reserved:7-2, obsolete:1, evpd:0 */
@@ -92 +93 @@
 
         /* End of required data */
-} scsi_std_inquiry_data_t;
+} __attribute__((packed)) scsi_std_inquiry_data_t;
 
 /** Size of struct or union member. */
@@ -138 +139 @@
 };
 
+/** SCSI Request Sense command */
+typedef struct {
+        /** Operation code (SCSI_CMD_REQUEST_SENSE) */
+        uint8_t op_code;
+        /** Reserved, Desc */
+        uint8_t desc;
+        /* Reserved */
+        uint16_t res_2;
+        /* Allocation Length */
+        uint8_t alloc_len;
+        /* Control */
+        uint8_t control;
+} __attribute__((packed)) scsi_cdb_request_sense_t;
+
+/** Minimum size of sense data.
+ *
+ * If the target returns less data, the missing bytes should be considered
+ * zero.
+ */
+#define SCSI_SENSE_DATA_MIN_SIZE 18
+
+/** Maximum size of sense data */
+#define SCSI_SENSE_DATA_MAX_SIZE 252
+
+/** Fixed-format sense data.
+ *
+ * Returned for Request Sense command with Desc bit cleared.
+ */
+typedef struct {
+        /** Valid, Response Code */
+        uint8_t valid_rcode;
+        /** Peripheral qualifier, Peripheral device type */
+        uint8_t obsolete_1;
+        /** Filemark, EOM, ILI, Reserved, Sense Key */
+        uint8_t flags_key;
+        /** Information */
+        uint32_t info;
+        /** Additional Sense Length */
+        uint8_t additional_len;
+        /** Command-specific Information */
+        uint8_t cmd_spec;
+        /** Additional Sense Code */
+        uint8_t additional_code;
+        /** Additional Sense Code Qualifier */
+        uint8_t additional_cqual;
+        /** Field-replaceable Unit Code */
+        uint8_t fru_code;
+        /** SKSV, Sense-key specific */
+        uint8_t key_spec[3];
+} __attribute__((packed)) scsi_sense_data_t;
+
+/** Sense key */
+enum scsi_sense_key {
+        SCSI_SK_NO_SENSE        = 0x0,
+        SCSI_SK_RECOVERED_ERROR = 0x1,
+        SCSI_SK_NOT_READY       = 0x2,
+        SCSI_SK_MEDIUM_ERROR    = 0x3,
+        SCSI_SK_HARDWARE_ERROR  = 0x4,
+        SCSI_SK_ILLEGAL_REQUEST = 0x5,
+        SCSI_SK_UNIT_ATTENTION  = 0x6,
+        SCSI_SK_DATA_PROTECT    = 0x7,
+        SCSI_SK_BLANK_CHECK     = 0x8,
+        SCSI_SK_VENDOR_SPECIFIC = 0x9,
+        SCSI_SK_COPY_ABORTED    = 0xa,
+        SCSI_SK_ABORTED_COMMAND = 0xb,
+        SCSI_SK_VOLUME_OVERFLOW = 0xd,
+        SCSI_SK_MISCOMPARE      = 0xe
+};
+
 extern const char *scsi_dev_type_str[SCSI_DEV_LIMIT];
 extern const char *scsi_get_dev_type_str(unsigned);