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 51 #include <scsi/scsi.h> 52 #include <scsi/scsi_cmnd.h> 53 #include <scsi/scsi_devinfo.h> 54 #include <scsi/scsi_device.h> 55 #include <scsi/scsi_eh.h> 56 57 #include "usb.h" 58 #include "scsiglue.h" 59 #include "debug.h" 60 #include "transport.h" 61 #include "protocol.h" 62 63 /*********************************************************************** 64 * Host functions 65 ***********************************************************************/ 66 67 static const char* host_info(struct Scsi_Host *host) 68 { 69 return "SCSI emulation for USB Mass Storage devices"; 70 } 71 72 static int slave_alloc (struct scsi_device *sdev) 73 { 74 /* 75 * Set the INQUIRY transfer length to 36. We don't use any of 76 * the extra data and many devices choke if asked for more or 77 * less than 36 bytes. 78 */ 79 sdev->inquiry_len = 36; 80 return 0; 81 } 82 83 static int slave_configure(struct scsi_device *sdev) 84 { 85 struct us_data *us = host_to_us(sdev->host); 86 87 /* Scatter-gather buffers (all but the last) must have a length 88 * divisible by the bulk maxpacket size. Otherwise a data packet 89 * would end up being short, causing a premature end to the data 90 * transfer. Since high-speed bulk pipes have a maxpacket size 91 * of 512, we'll use that as the scsi device queue's DMA alignment 92 * mask. Guaranteeing proper alignment of the first buffer will 93 * have the desired effect because, except at the beginning and 94 * the end, scatter-gather buffers follow page boundaries. */ 95 blk_queue_dma_alignment(sdev->request_queue, (512 - 1)); 96 97 /* Set the SCSI level to at least 2. We'll leave it at 3 if that's 98 * what is originally reported. We need this to avoid confusing 99 * the SCSI layer with devices that report 0 or 1, but need 10-byte 100 * commands (ala ATAPI devices behind certain bridges, or devices 101 * which simply have broken INQUIRY data). 102 * 103 * NOTE: This means /dev/sg programs (ala cdrecord) will get the 104 * actual information. This seems to be the preference for 105 * programs like that. 106 * 107 * NOTE: This also means that /proc/scsi/scsi and sysfs may report 108 * the actual value or the modified one, depending on where the 109 * data comes from. 110 */ 111 if (sdev->scsi_level < SCSI_2) 112 sdev->scsi_level = SCSI_2; 113 114 /* According to the technical support people at Genesys Logic, 115 * devices using their chips have problems transferring more than 116 * 32 KB at a time. In practice people have found that 64 KB 117 * works okay and that's what Windows does. But we'll be 118 * conservative; people can always use the sysfs interface to 119 * increase max_sectors. */ 120 if (le16_to_cpu(us->pusb_dev->descriptor.idVendor) == USB_VENDOR_ID_GENESYS && 121 sdev->request_queue->max_sectors > 64) 122 blk_queue_max_sectors(sdev->request_queue, 64); 123 124 /* We can't put these settings in slave_alloc() because that gets 125 * called before the device type is known. Consequently these 126 * settings can't be overridden via the scsi devinfo mechanism. */ 127 if (sdev->type == TYPE_DISK) { 128 129 /* Disk-type devices use MODE SENSE(6) if the protocol 130 * (SubClass) is Transparent SCSI, otherwise they use 131 * MODE SENSE(10). */ 132 if (us->subclass != US_SC_SCSI) 133 sdev->use_10_for_ms = 1; 134 135 /* Many disks only accept MODE SENSE transfer lengths of 136 * 192 bytes (that's what Windows uses). */ 137 sdev->use_192_bytes_for_3f = 1; 138 139 /* Some devices don't like MODE SENSE with page=0x3f, 140 * which is the command used for checking if a device 141 * is write-protected. Now that we tell the sd driver 142 * to do a 192-byte transfer with this command the 143 * majority of devices work fine, but a few still can't 144 * handle it. The sd driver will simply assume those 145 * devices are write-enabled. */ 146 if (us->flags & US_FL_NO_WP_DETECT) 147 sdev->skip_ms_page_3f = 1; 148 149 /* A number of devices have problems with MODE SENSE for 150 * page x08, so we will skip it. */ 151 sdev->skip_ms_page_8 = 1; 152 153 /* Some disks return the total number of blocks in response 154 * to READ CAPACITY rather than the highest block number. 155 * If this device makes that mistake, tell the sd driver. */ 156 if (us->flags & US_FL_FIX_CAPACITY) 157 sdev->fix_capacity = 1; 158 159 /* Some devices report a SCSI revision level above 2 but are 160 * unable to handle the REPORT LUNS command (for which 161 * support is mandatory at level 3). Since we already have 162 * a Get-Max-LUN request, we won't lose much by setting the 163 * revision level down to 2. The only devices that would be 164 * affected are those with sparse LUNs. */ 165 sdev->scsi_level = SCSI_2; 166 167 /* USB-IDE bridges tend to report SK = 0x04 (Non-recoverable 168 * Hardware Error) when any low-level error occurs, 169 * recoverable or not. Setting this flag tells the SCSI 170 * midlayer to retry such commands, which frequently will 171 * succeed and fix the error. The worst this can lead to 172 * is an occasional series of retries that will all fail. */ 173 sdev->retry_hwerror = 1; 174 175 } else { 176 177 /* Non-disk-type devices don't need to blacklist any pages 178 * or to force 192-byte transfer lengths for MODE SENSE. 179 * But they do need to use MODE SENSE(10). */ 180 sdev->use_10_for_ms = 1; 181 } 182 183 /* Some devices choke when they receive a PREVENT-ALLOW MEDIUM 184 * REMOVAL command, so suppress those commands. */ 185 if (us->flags & US_FL_NOT_LOCKABLE) 186 sdev->lockable = 0; 187 188 /* this is to satisfy the compiler, tho I don't think the 189 * return code is ever checked anywhere. */ 190 return 0; 191 } 192 193 /* queue a command */ 194 /* This is always called with scsi_lock(host) held */ 195 static int queuecommand(struct scsi_cmnd *srb, 196 void (*done)(struct scsi_cmnd *)) 197 { 198 struct us_data *us = host_to_us(srb->device->host); 199 200 US_DEBUGP("%s called\n", __FUNCTION__); 201 202 /* check for state-transition errors */ 203 if (us->srb != NULL) { 204 printk(KERN_ERR USB_STORAGE "Error in %s: us->srb = %p\n", 205 __FUNCTION__, us->srb); 206 return SCSI_MLQUEUE_HOST_BUSY; 207 } 208 209 /* fail the command if we are disconnecting */ 210 if (test_bit(US_FLIDX_DISCONNECTING, &us->flags)) { 211 US_DEBUGP("Fail command during disconnect\n"); 212 srb->result = DID_NO_CONNECT << 16; 213 done(srb); 214 return 0; 215 } 216 217 /* enqueue the command and wake up the control thread */ 218 srb->scsi_done = done; 219 us->srb = srb; 220 up(&(us->sema)); 221 222 return 0; 223 } 224 225 /*********************************************************************** 226 * Error handling functions 227 ***********************************************************************/ 228 229 /* Command timeout and abort */ 230 /* This is always called with scsi_lock(host) held */ 231 static int command_abort(struct scsi_cmnd *srb) 232 { 233 struct us_data *us = host_to_us(srb->device->host); 234 235 US_DEBUGP("%s called\n", __FUNCTION__); 236 237 /* Is this command still active? */ 238 if (us->srb != srb) { 239 US_DEBUGP ("-- nothing to abort\n"); 240 return FAILED; 241 } 242 243 /* Set the TIMED_OUT bit. Also set the ABORTING bit, but only if 244 * a device reset isn't already in progress (to avoid interfering 245 * with the reset). To prevent races with auto-reset, we must 246 * stop any ongoing USB transfers while still holding the host 247 * lock. */ 248 set_bit(US_FLIDX_TIMED_OUT, &us->flags); 249 if (!test_bit(US_FLIDX_RESETTING, &us->flags)) { 250 set_bit(US_FLIDX_ABORTING, &us->flags); 251 usb_stor_stop_transport(us); 252 } 253 254 /* Wait for the aborted command to finish */ 255 wait_for_completion(&us->notify); 256 257 /* Reacquire the lock and allow USB transfers to resume */ 258 clear_bit(US_FLIDX_ABORTING, &us->flags); 259 clear_bit(US_FLIDX_TIMED_OUT, &us->flags); 260 return SUCCESS; 261 } 262 263 /* This invokes the transport reset mechanism to reset the state of the 264 * device */ 265 /* This is always called with scsi_lock(host) held */ 266 static int device_reset(struct scsi_cmnd *srb) 267 { 268 struct us_data *us = host_to_us(srb->device->host); 269 int result; 270 271 US_DEBUGP("%s called\n", __FUNCTION__); 272 273 /* lock the device pointers and do the reset */ 274 down(&(us->dev_semaphore)); 275 result = us->transport_reset(us); 276 up(&(us->dev_semaphore)); 277 278 return result < 0 ? FAILED : SUCCESS; 279 } 280 281 /* Simulate a SCSI bus reset by resetting the device's USB port. */ 282 /* This is always called with scsi_lock(host) held */ 283 static int bus_reset(struct scsi_cmnd *srb) 284 { 285 struct us_data *us = host_to_us(srb->device->host); 286 int result; 287 288 US_DEBUGP("%s called\n", __FUNCTION__); 289 290 down(&(us->dev_semaphore)); 291 result = usb_stor_port_reset(us); 292 up(&(us->dev_semaphore)); 293 294 /* lock the host for the return */ 295 return result < 0 ? FAILED : SUCCESS; 296 } 297 298 /* Report a driver-initiated device reset to the SCSI layer. 299 * Calling this for a SCSI-initiated reset is unnecessary but harmless. 300 * The caller must own the SCSI host lock. */ 301 void usb_stor_report_device_reset(struct us_data *us) 302 { 303 int i; 304 struct Scsi_Host *host = us_to_host(us); 305 306 scsi_report_device_reset(host, 0, 0); 307 if (us->flags & US_FL_SCM_MULT_TARG) { 308 for (i = 1; i < host->max_id; ++i) 309 scsi_report_device_reset(host, 0, i); 310 } 311 } 312 313 /* Report a driver-initiated bus reset to the SCSI layer. 314 * Calling this for a SCSI-initiated reset is unnecessary but harmless. 315 * The caller must own the SCSI host lock. */ 316 void usb_stor_report_bus_reset(struct us_data *us) 317 { 318 scsi_report_bus_reset(us_to_host(us), 0); 319 } 320 321 /*********************************************************************** 322 * /proc/scsi/ functions 323 ***********************************************************************/ 324 325 /* we use this macro to help us write into the buffer */ 326 #undef SPRINTF 327 #define SPRINTF(args...) \ 328 do { if (pos < buffer+length) pos += sprintf(pos, ## args); } while (0) 329 330 static int proc_info (struct Scsi_Host *host, char *buffer, 331 char **start, off_t offset, int length, int inout) 332 { 333 struct us_data *us = host_to_us(host); 334 char *pos = buffer; 335 const char *string; 336 337 /* if someone is sending us data, just throw it away */ 338 if (inout) 339 return length; 340 341 /* print the controller name */ 342 SPRINTF(" Host scsi%d: usb-storage\n", host->host_no); 343 344 /* print product, vendor, and serial number strings */ 345 if (us->pusb_dev->manufacturer) 346 string = us->pusb_dev->manufacturer; 347 else if (us->unusual_dev->vendorName) 348 string = us->unusual_dev->vendorName; 349 else 350 string = "Unknown"; 351 SPRINTF(" Vendor: %s\n", string); 352 if (us->pusb_dev->product) 353 string = us->pusb_dev->product; 354 else if (us->unusual_dev->productName) 355 string = us->unusual_dev->productName; 356 else 357 string = "Unknown"; 358 SPRINTF(" Product: %s\n", string); 359 if (us->pusb_dev->serial) 360 string = us->pusb_dev->serial; 361 else 362 string = "None"; 363 SPRINTF("Serial Number: %s\n", string); 364 365 /* show the protocol and transport */ 366 SPRINTF(" Protocol: %s\n", us->protocol_name); 367 SPRINTF(" Transport: %s\n", us->transport_name); 368 369 /* show the device flags */ 370 if (pos < buffer + length) { 371 pos += sprintf(pos, " Quirks:"); 372 373 #define US_FLAG(name, value) \ 374 if (us->flags & value) pos += sprintf(pos, " " #name); 375 US_DO_ALL_FLAGS 376 #undef US_FLAG 377 378 *(pos++) = '\n'; 379 } 380 381 /* 382 * Calculate start of next buffer, and return value. 383 */ 384 *start = buffer + offset; 385 386 if ((pos - buffer) < offset) 387 return (0); 388 else if ((pos - buffer - offset) < length) 389 return (pos - buffer - offset); 390 else 391 return (length); 392 } 393 394 /*********************************************************************** 395 * Sysfs interface 396 ***********************************************************************/ 397 398 /* Output routine for the sysfs max_sectors file */ 399 static ssize_t show_max_sectors(struct device *dev, struct device_attribute *attr, char *buf) 400 { 401 struct scsi_device *sdev = to_scsi_device(dev); 402 403 return sprintf(buf, "%u\n", sdev->request_queue->max_sectors); 404 } 405 406 /* Input routine for the sysfs max_sectors file */ 407 static ssize_t store_max_sectors(struct device *dev, struct device_attribute *attr, const char *buf, 408 size_t count) 409 { 410 struct scsi_device *sdev = to_scsi_device(dev); 411 unsigned short ms; 412 413 if (sscanf(buf, "%hu", &ms) > 0 && ms <= SCSI_DEFAULT_MAX_SECTORS) { 414 blk_queue_max_sectors(sdev->request_queue, ms); 415 return strlen(buf); 416 } 417 return -EINVAL; 418 } 419 420 static DEVICE_ATTR(max_sectors, S_IRUGO | S_IWUSR, show_max_sectors, 421 store_max_sectors); 422 423 static struct device_attribute *sysfs_device_attr_list[] = { 424 &dev_attr_max_sectors, 425 NULL, 426 }; 427 428 /* 429 * this defines our host template, with which we'll allocate hosts 430 */ 431 432 struct scsi_host_template usb_stor_host_template = { 433 /* basic userland interface stuff */ 434 .name = "usb-storage", 435 .proc_name = "usb-storage", 436 .proc_info = proc_info, 437 .info = host_info, 438 439 /* command interface -- queued only */ 440 .queuecommand = queuecommand, 441 442 /* error and abort handlers */ 443 .eh_abort_handler = command_abort, 444 .eh_device_reset_handler = device_reset, 445 .eh_bus_reset_handler = bus_reset, 446 447 /* queue commands only, only one command per LUN */ 448 .can_queue = 1, 449 .cmd_per_lun = 1, 450 451 /* unknown initiator id */ 452 .this_id = -1, 453 454 .slave_alloc = slave_alloc, 455 .slave_configure = slave_configure, 456 457 /* lots of sg segments can be handled */ 458 .sg_tablesize = SG_ALL, 459 460 /* limit the total size of a transfer to 120 KB */ 461 .max_sectors = 240, 462 463 /* merge commands... this seems to help performance, but 464 * periodically someone should test to see which setting is more 465 * optimal. 466 */ 467 .use_clustering = 1, 468 469 /* emulated HBA */ 470 .emulated = 1, 471 472 /* we do our own delay after a device or bus reset */ 473 .skip_settle_delay = 1, 474 475 /* sysfs device attributes */ 476 .sdev_attrs = sysfs_device_attr_list, 477 478 /* module management */ 479 .module = THIS_MODULE 480 }; 481 482 /* To Report "Illegal Request: Invalid Field in CDB */ 483 unsigned char usb_stor_sense_invalidCDB[18] = { 484 [0] = 0x70, /* current error */ 485 [2] = ILLEGAL_REQUEST, /* Illegal Request = 0x05 */ 486 [7] = 0x0a, /* additional length */ 487 [12] = 0x24 /* Invalid Field in CDB */ 488 }; 489 490