drivers/usb/storage/scsiglue.c

   1 /* Driver for USB Mass Storage compliant devices
   2  * SCSI layer glue code
   3  *
   4  * $Id: scsiglue.c,v 1.26 2002/04/22 03:39:43 mdharm Exp $
   5  *
   6  * Current development and maintenance by:
   7  *   (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
   8  *
   9  * Developed with the assistance of:
  10  *   (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
  11  *   (c) 2000 Stephen J. Gowdy (SGowdy@lbl.gov)
  12  *
  13  * Initial work by:
  14  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
  15  *
  16  * This driver is based on the 'USB Mass Storage Class' document. This
  17  * describes in detail the protocol used to communicate with such
  18  * devices.  Clearly, the designers had SCSI and ATAPI commands in
  19  * mind when they created this document.  The commands are all very
  20  * similar to commands in the SCSI-II and ATAPI specifications.
  21  *
  22  * It is important to note that in a number of cases this class
  23  * exhibits class-specific exemptions from the USB specification.
  24  * Notably the usage of NAK, STALL and ACK differs from the norm, in
  25  * that they are used to communicate wait, failed and OK on commands.
  26  *
  27  * Also, for certain devices, the interrupt endpoint is used to convey
  28  * status of a command.
  29  *
  30  * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
  31  * information about this driver.
  32  *
  33  * This program is free software; you can redistribute it and/or modify it
  34  * under the terms of the GNU General Public License as published by the
  35  * Free Software Foundation; either version 2, or (at your option) any
  36  * later version.
  37  *
  38  * This program is distributed in the hope that it will be useful, but
  39  * WITHOUT ANY WARRANTY; without even the implied warranty of
  40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  41  * General Public License for more details.
  42  *
  43  * You should have received a copy of the GNU General Public License along
  44  * with this program; if not, write to the Free Software Foundation, Inc.,
  45  * 675 Mass Ave, Cambridge, MA 02139, USA.
  46  */
  47
  48 #include <linux/slab.h>
  49 #include <linux/module.h>
  50 #include <linux/mutex.h>
  51
  52 #include <scsi/scsi.h>
  53 #include <scsi/scsi_cmnd.h>
  54 #include <scsi/scsi_devinfo.h>
  55 #include <scsi/scsi_device.h>
  56 #include <scsi/scsi_eh.h>
  57
  58 #include "usb.h"
  59 #include "scsiglue.h"
  60 #include "debug.h"
  61 #include "transport.h"
  62 #include "protocol.h"
  63
  64 /***********************************************************************
  65  * Host functions
  66  ***********************************************************************/
  67
  68 static const char* host_info(struct Scsi_Host *host)
  69 {
  70         return "SCSI emulation for USB Mass Storage devices";
  71 }
  72
  73 static int slave_alloc (struct scsi_device *sdev)
  74 {
  75         struct us_data *us = host_to_us(sdev->host);
  76
  77         /*
  78          * Set the INQUIRY transfer length to 36.  We don't use any of
  79          * the extra data and many devices choke if asked for more or
  80          * less than 36 bytes.
  81          */
  82         sdev->inquiry_len = 36;
  83
  84         /*
  85          * The UFI spec treates the Peripheral Qualifier bits in an
  86          * INQUIRY result as reserved and requires devices to set them
  87          * to 0.  However the SCSI spec requires these bits to be set
  88          * to 3 to indicate when a LUN is not present.
  89          *
  90          * Let the scanning code know if this target merely sets
  91          * Peripheral Device Type to 0x1f to indicate no LUN.
  92          */
  93         if (us->subclass == US_SC_UFI)
  94                 sdev->sdev_target->pdt_1f_for_no_lun = 1;
  95
  96         return 0;
  97 }
  98
  99 static int slave_configure(struct scsi_device *sdev)
 100 {
 101         struct us_data *us = host_to_us(sdev->host);
 102
 103         /* Scatter-gather buffers (all but the last) must have a length
 104          * divisible by the bulk maxpacket size.  Otherwise a data packet
 105          * would end up being short, causing a premature end to the data
 106          * transfer.  Since high-speed bulk pipes have a maxpacket size
 107          * of 512, we'll use that as the scsi device queue's DMA alignment
 108          * mask.  Guaranteeing proper alignment of the first buffer will
 109          * have the desired effect because, except at the beginning and
 110          * the end, scatter-gather buffers follow page boundaries. */
 111         blk_queue_dma_alignment(sdev->request_queue, (512 - 1));
 112
 113         /* Many devices have trouble transfering more than 32KB at a time,
 114          * while others have trouble with more than 64K. At this time we
 115          * are limiting both to 32K (64 sectores).
 116          */
 117         if ((us->flags & US_FL_MAX_SECTORS_64) &&
 118                         sdev->request_queue->max_sectors > 64)
 119                 blk_queue_max_sectors(sdev->request_queue, 64);
 120
 121         /* We can't put these settings in slave_alloc() because that gets
 122          * called before the device type is known.  Consequently these
 123          * settings can't be overridden via the scsi devinfo mechanism. */
 124         if (sdev->type == TYPE_DISK) {
 125
 126                 /* Disk-type devices use MODE SENSE(6) if the protocol
 127                  * (SubClass) is Transparent SCSI, otherwise they use
 128                  * MODE SENSE(10). */
 129                 if (us->subclass != US_SC_SCSI)
 130                         sdev->use_10_for_ms = 1;
 131
 132                 /* Many disks only accept MODE SENSE transfer lengths of
 133                  * 192 bytes (that's what Windows uses). */
 134                 sdev->use_192_bytes_for_3f = 1;
 135
 136                 /* Some devices don't like MODE SENSE with page=0x3f,
 137                  * which is the command used for checking if a device
 138                  * is write-protected.  Now that we tell the sd driver
 139                  * to do a 192-byte transfer with this command the
 140                  * majority of devices work fine, but a few still can't
 141                  * handle it.  The sd driver will simply assume those
 142                  * devices are write-enabled. */
 143                 if (us->flags & US_FL_NO_WP_DETECT)
 144                         sdev->skip_ms_page_3f = 1;
 145
 146                 /* A number of devices have problems with MODE SENSE for
 147                  * page x08, so we will skip it. */
 148                 sdev->skip_ms_page_8 = 1;
 149
 150                 /* Some disks return the total number of blocks in response
 151                  * to READ CAPACITY rather than the highest block number.
 152                  * If this device makes that mistake, tell the sd driver. */
 153                 if (us->flags & US_FL_FIX_CAPACITY)
 154                         sdev->fix_capacity = 1;
 155
 156                 /* Some devices report a SCSI revision level above 2 but are
 157                  * unable to handle the REPORT LUNS command (for which
 158                  * support is mandatory at level 3).  Since we already have
 159                  * a Get-Max-LUN request, we won't lose much by setting the
 160                  * revision level down to 2.  The only devices that would be
 161                  * affected are those with sparse LUNs. */
 162                 if (sdev->scsi_level > SCSI_2)
 163                         sdev->sdev_target->scsi_level =
 164                                         sdev->scsi_level = SCSI_2;
 165
 166                 /* USB-IDE bridges tend to report SK = 0x04 (Non-recoverable
 167                  * Hardware Error) when any low-level error occurs,
 168                  * recoverable or not.  Setting this flag tells the SCSI
 169                  * midlayer to retry such commands, which frequently will
 170                  * succeed and fix the error.  The worst this can lead to
 171                  * is an occasional series of retries that will all fail. */
 172                 sdev->retry_hwerror = 1;
 173
 174         } else {
 175
 176                 /* Non-disk-type devices don't need to blacklist any pages
 177                  * or to force 192-byte transfer lengths for MODE SENSE.
 178                  * But they do need to use MODE SENSE(10). */
 179                 sdev->use_10_for_ms = 1;
 180         }
 181
 182         /* The CB and CBI transports have no way to pass LUN values
 183          * other than the bits in the second byte of a CDB.  But those
 184          * bits don't get set to the LUN value if the device reports
 185          * scsi_level == 0 (UNKNOWN).  Hence such devices must necessarily
 186          * be single-LUN.
 187          */
 188         if ((us->protocol == US_PR_CB || us->protocol == US_PR_CBI) &&
 189                         sdev->scsi_level == SCSI_UNKNOWN)
 190                 us->max_lun = 0;
 191
 192         /* Some devices choke when they receive a PREVENT-ALLOW MEDIUM
 193          * REMOVAL command, so suppress those commands. */
 194         if (us->flags & US_FL_NOT_LOCKABLE)
 195                 sdev->lockable = 0;
 196
 197         /* this is to satisfy the compiler, tho I don't think the
 198          * return code is ever checked anywhere. */
 199         return 0;
 200 }
 201
 202 /* queue a command */
 203 /* This is always called with scsi_lock(host) held */
 204 static int queuecommand(struct scsi_cmnd *srb,
 205                         void (*done)(struct scsi_cmnd *))
 206 {
 207         struct us_data *us = host_to_us(srb->device->host);
 208
 209         US_DEBUGP("%s called\n", __FUNCTION__);
 210
 211         /* check for state-transition errors */
 212         if (us->srb != NULL) {
 213                 printk(KERN_ERR USB_STORAGE "Error in %s: us->srb = %p\n",
 214                         __FUNCTION__, us->srb);
 215                 return SCSI_MLQUEUE_HOST_BUSY;
 216         }
 217
 218         /* fail the command if we are disconnecting */
 219         if (test_bit(US_FLIDX_DISCONNECTING, &us->flags)) {
 220                 US_DEBUGP("Fail command during disconnect\n");
 221                 srb->result = DID_NO_CONNECT << 16;
 222                 done(srb);
 223                 return 0;
 224         }
 225
 226         /* enqueue the command and wake up the control thread */
 227         srb->scsi_done = done;
 228         us->srb = srb;
 229         up(&(us->sema));
 230
 231         return 0;
 232 }
 233
 234 /***********************************************************************
 235  * Error handling functions
 236  ***********************************************************************/
 237
 238 /* Command timeout and abort */
 239 static int command_abort(struct scsi_cmnd *srb)
 240 {
 241         struct us_data *us = host_to_us(srb->device->host);
 242
 243         US_DEBUGP("%s called\n", __FUNCTION__);
 244
 245         /* us->srb together with the TIMED_OUT, RESETTING, and ABORTING
 246          * bits are protected by the host lock. */
 247         scsi_lock(us_to_host(us));
 248
 249         /* Is this command still active? */
 250         if (us->srb != srb) {
 251                 scsi_unlock(us_to_host(us));
 252                 US_DEBUGP ("-- nothing to abort\n");
 253                 return FAILED;
 254         }
 255
 256         /* Set the TIMED_OUT bit.  Also set the ABORTING bit, but only if
 257          * a device reset isn't already in progress (to avoid interfering
 258          * with the reset).  Note that we must retain the host lock while
 259          * calling usb_stor_stop_transport(); otherwise it might interfere
 260          * with an auto-reset that begins as soon as we release the lock. */
 261         set_bit(US_FLIDX_TIMED_OUT, &us->flags);
 262         if (!test_bit(US_FLIDX_RESETTING, &us->flags)) {
 263                 set_bit(US_FLIDX_ABORTING, &us->flags);
 264                 usb_stor_stop_transport(us);
 265         }
 266         scsi_unlock(us_to_host(us));
 267
 268         /* Wait for the aborted command to finish */
 269         wait_for_completion(&us->notify);
 270         return SUCCESS;
 271 }
 272
 273 /* This invokes the transport reset mechanism to reset the state of the
 274  * device */
 275 static int device_reset(struct scsi_cmnd *srb)
 276 {
 277         struct us_data *us = host_to_us(srb->device->host);
 278         int result;
 279
 280         US_DEBUGP("%s called\n", __FUNCTION__);
 281
 282         /* lock the device pointers and do the reset */
 283         mutex_lock(&(us->dev_mutex));
 284         result = us->transport_reset(us);
 285         mutex_unlock(&us->dev_mutex);
 286
 287         return result < 0 ? FAILED : SUCCESS;
 288 }
 289
 290 /* Simulate a SCSI bus reset by resetting the device's USB port. */
 291 static int bus_reset(struct scsi_cmnd *srb)
 292 {
 293         struct us_data *us = host_to_us(srb->device->host);
 294         int result;
 295
 296         US_DEBUGP("%s called\n", __FUNCTION__);
 297         result = usb_stor_port_reset(us);
 298         return result < 0 ? FAILED : SUCCESS;
 299 }
 300
 301 /* Report a driver-initiated device reset to the SCSI layer.
 302  * Calling this for a SCSI-initiated reset is unnecessary but harmless.
 303  * The caller must own the SCSI host lock. */
 304 void usb_stor_report_device_reset(struct us_data *us)
 305 {
 306         int i;
 307         struct Scsi_Host *host = us_to_host(us);
 308
 309         scsi_report_device_reset(host, 0, 0);
 310         if (us->flags & US_FL_SCM_MULT_TARG) {
 311                 for (i = 1; i < host->max_id; ++i)
 312                         scsi_report_device_reset(host, 0, i);
 313         }
 314 }
 315
 316 /* Report a driver-initiated bus reset to the SCSI layer.
 317  * Calling this for a SCSI-initiated reset is unnecessary but harmless.
 318  * The caller must own the SCSI host lock. */
 319 void usb_stor_report_bus_reset(struct us_data *us)
 320 {
 321         scsi_report_bus_reset(us_to_host(us), 0);
 322 }
 323
 324 /***********************************************************************
 325  * /proc/scsi/ functions
 326  ***********************************************************************/
 327
 328 /* we use this macro to help us write into the buffer */
 329 #undef SPRINTF
 330 #define SPRINTF(args...) \
 331         do { if (pos < buffer+length) pos += sprintf(pos, ## args); } while (0)
 332
 333 static int proc_info (struct Scsi_Host *host, char *buffer,
 334                 char **start, off_t offset, int length, int inout)
 335 {
 336         struct us_data *us = host_to_us(host);
 337         char *pos = buffer;
 338         const char *string;
 339
 340         /* if someone is sending us data, just throw it away */
 341         if (inout)
 342                 return length;
 343
 344         /* print the controller name */
 345         SPRINTF("   Host scsi%d: usb-storage\n", host->host_no);
 346
 347         /* print product, vendor, and serial number strings */
 348         if (us->pusb_dev->manufacturer)
 349                 string = us->pusb_dev->manufacturer;
 350         else if (us->unusual_dev->vendorName)
 351                 string = us->unusual_dev->vendorName;
 352         else
 353                 string = "Unknown";
 354         SPRINTF("       Vendor: %s\n", string);
 355         if (us->pusb_dev->product)
 356                 string = us->pusb_dev->product;
 357         else if (us->unusual_dev->productName)
 358                 string = us->unusual_dev->productName;
 359         else
 360                 string = "Unknown";
 361         SPRINTF("      Product: %s\n", string);
 362         if (us->pusb_dev->serial)
 363                 string = us->pusb_dev->serial;
 364         else
 365                 string = "None";
 366         SPRINTF("Serial Number: %s\n", string);
 367
 368         /* show the protocol and transport */
 369         SPRINTF("     Protocol: %s\n", us->protocol_name);
 370         SPRINTF("    Transport: %s\n", us->transport_name);
 371
 372         /* show the device flags */
 373         if (pos < buffer + length) {
 374                 pos += sprintf(pos, "       Quirks:");
 375
 376 #define US_FLAG(name, value) \
 377         if (us->flags & value) pos += sprintf(pos, " " #name);
 378 US_DO_ALL_FLAGS
 379 #undef US_FLAG
 380
 381                 *(pos++) = '\n';
 382         }
 383
 384         /*
 385          * Calculate start of next buffer, and return value.
 386          */
 387         *start = buffer + offset;
 388
 389         if ((pos - buffer) < offset)
 390                 return (0);
 391         else if ((pos - buffer - offset) < length)
 392                 return (pos - buffer - offset);
 393         else
 394                 return (length);
 395 }
 396
 397 /***********************************************************************
 398  * Sysfs interface
 399  ***********************************************************************/
 400
 401 /* Output routine for the sysfs max_sectors file */
 402 static ssize_t show_max_sectors(struct device *dev, struct device_attribute *attr, char *buf)
 403 {
 404         struct scsi_device *sdev = to_scsi_device(dev);
 405
 406         return sprintf(buf, "%u\n", sdev->request_queue->max_sectors);
 407 }
 408
 409 /* Input routine for the sysfs max_sectors file */
 410 static ssize_t store_max_sectors(struct device *dev, struct device_attribute *attr, const char *buf,
 411                 size_t count)
 412 {
 413         struct scsi_device *sdev = to_scsi_device(dev);
 414         unsigned short ms;
 415
 416         if (sscanf(buf, "%hu", &ms) > 0 && ms <= SCSI_DEFAULT_MAX_SECTORS) {
 417                 blk_queue_max_sectors(sdev->request_queue, ms);
 418                 return strlen(buf);
 419         }
 420         return -EINVAL;
 421 }
 422
 423 static DEVICE_ATTR(max_sectors, S_IRUGO | S_IWUSR, show_max_sectors,
 424                 store_max_sectors);
 425
 426 static struct device_attribute *sysfs_device_attr_list[] = {
 427                 &dev_attr_max_sectors,
 428                 NULL,
 429                 };
 430
 431 /*
 432  * this defines our host template, with which we'll allocate hosts
 433  */
 434
 435 struct scsi_host_template usb_stor_host_template = {
 436         /* basic userland interface stuff */
 437         .name =                         "usb-storage",
 438         .proc_name =                    "usb-storage",
 439         .proc_info =                    proc_info,
 440         .info =                         host_info,
 441
 442         /* command interface -- queued only */
 443         .queuecommand =                 queuecommand,
 444
 445         /* error and abort handlers */
 446         .eh_abort_handler =             command_abort,
 447         .eh_device_reset_handler =      device_reset,
 448         .eh_bus_reset_handler =         bus_reset,
 449
 450         /* queue commands only, only one command per LUN */
 451         .can_queue =                    1,
 452         .cmd_per_lun =                  1,
 453
 454         /* unknown initiator id */
 455         .this_id =                      -1,
 456
 457         .slave_alloc =                  slave_alloc,
 458         .slave_configure =              slave_configure,
 459
 460         /* lots of sg segments can be handled */
 461         .sg_tablesize =                 SG_ALL,
 462
 463         /* limit the total size of a transfer to 120 KB */
 464         .max_sectors =                  240,
 465
 466         /* merge commands... this seems to help performance, but
 467          * periodically someone should test to see which setting is more
 468          * optimal.
 469          */
 470         .use_clustering =               1,
 471
 472         /* emulated HBA */
 473         .emulated =                     1,
 474
 475         /* we do our own delay after a device or bus reset */
 476         .skip_settle_delay =            1,
 477
 478         /* sysfs device attributes */
 479         .sdev_attrs =                   sysfs_device_attr_list,
 480
 481         /* module management */
 482         .module =                       THIS_MODULE
 483 };
 484
 485 /* To Report "Illegal Request: Invalid Field in CDB */
 486 unsigned char usb_stor_sense_invalidCDB[18] = {
 487         [0]     = 0x70,                     /* current error */
 488         [2]     = ILLEGAL_REQUEST,          /* Illegal Request = 0x05 */
 489         [7]     = 0x0a,                     /* additional length */
 490         [12]    = 0x24                      /* Invalid Field in CDB */
 491 };
 492