blob: 689ee1fb702a4351a7fdb2a0e0a400a682eabd4f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Driver for USB Mass Storage compliant devices
2 * SCSI layer glue code
3 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Current development and maintenance by:
5 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
6 *
7 * Developed with the assistance of:
8 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
9 * (c) 2000 Stephen J. Gowdy (SGowdy@lbl.gov)
10 *
11 * Initial work by:
12 * (c) 1999 Michael Gee (michael@linuxspecific.com)
13 *
14 * This driver is based on the 'USB Mass Storage Class' document. This
15 * describes in detail the protocol used to communicate with such
16 * devices. Clearly, the designers had SCSI and ATAPI commands in
17 * mind when they created this document. The commands are all very
18 * similar to commands in the SCSI-II and ATAPI specifications.
19 *
20 * It is important to note that in a number of cases this class
21 * exhibits class-specific exemptions from the USB specification.
22 * Notably the usage of NAK, STALL and ACK differs from the norm, in
23 * that they are used to communicate wait, failed and OK on commands.
24 *
25 * Also, for certain devices, the interrupt endpoint is used to convey
26 * status of a command.
27 *
28 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
29 * information about this driver.
30 *
31 * This program is free software; you can redistribute it and/or modify it
32 * under the terms of the GNU General Public License as published by the
33 * Free Software Foundation; either version 2, or (at your option) any
34 * later version.
35 *
36 * This program is distributed in the hope that it will be useful, but
37 * WITHOUT ANY WARRANTY; without even the implied warranty of
38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
39 * General Public License for more details.
40 *
41 * You should have received a copy of the GNU General Public License along
42 * with this program; if not, write to the Free Software Foundation, Inc.,
43 * 675 Mass Ave, Cambridge, MA 02139, USA.
44 */
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/module.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010047#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#include <scsi/scsi.h>
50#include <scsi/scsi_cmnd.h>
51#include <scsi/scsi_devinfo.h>
52#include <scsi/scsi_device.h>
53#include <scsi/scsi_eh.h>
54
55#include "usb.h"
56#include "scsiglue.h"
57#include "debug.h"
58#include "transport.h"
59#include "protocol.h"
60
Alan Sterna81a81a2008-12-18 16:41:49 -050061/* Vendor IDs for companies that seem to include the READ CAPACITY bug
62 * in all their devices
63 */
64#define VENDOR_ID_NOKIA 0x0421
65#define VENDOR_ID_NIKON 0x04b0
Alan Stern506e9462009-02-04 15:48:03 -050066#define VENDOR_ID_PENTAX 0x0a17
Alan Sterna81a81a2008-12-18 16:41:49 -050067#define VENDOR_ID_MOTOROLA 0x22b8
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/***********************************************************************
70 * Host functions
71 ***********************************************************************/
72
73static const char* host_info(struct Scsi_Host *host)
74{
Matthew Wilcox00fa43e2009-09-24 16:19:11 -060075 struct us_data *us = host_to_us(host);
76 return us->scsi_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077}
78
79static int slave_alloc (struct scsi_device *sdev)
80{
Alan Stern3a3416b2006-08-21 12:00:53 -040081 struct us_data *us = host_to_us(sdev->host);
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 /*
84 * Set the INQUIRY transfer length to 36. We don't use any of
85 * the extra data and many devices choke if asked for more or
86 * less than 36 bytes.
87 */
88 sdev->inquiry_len = 36;
Alan Stern3a3416b2006-08-21 12:00:53 -040089
Alan Sternf756cbd2008-06-30 13:39:59 -040090 /* USB has unusual DMA-alignment requirements: Although the
91 * starting address of each scatter-gather element doesn't matter,
92 * the length of each element except the last must be divisible
93 * by the Bulk maxpacket value. There's currently no way to
94 * express this by block-layer constraints, so we'll cop out
95 * and simply require addresses to be aligned at 512-byte
96 * boundaries. This is okay since most block I/O involves
97 * hardware sectors that are multiples of 512 bytes in length,
98 * and since host controllers up through USB 2.0 have maxpacket
99 * values no larger than 512.
100 *
101 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
102 * values can be as large as 2048. To make that work properly
103 * will require changes to the block layer.
Alan Stern148d9fe2008-03-27 14:52:57 -0400104 */
Alan Sternf756cbd2008-06-30 13:39:59 -0400105 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
James Bottomley465ff312008-01-01 10:00:10 -0600106
Alan Stern3a3416b2006-08-21 12:00:53 -0400107 /*
108 * The UFI spec treates the Peripheral Qualifier bits in an
109 * INQUIRY result as reserved and requires devices to set them
110 * to 0. However the SCSI spec requires these bits to be set
111 * to 3 to indicate when a LUN is not present.
112 *
113 * Let the scanning code know if this target merely sets
114 * Peripheral Device Type to 0x1f to indicate no LUN.
115 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200116 if (us->subclass == USB_SC_UFI)
Alan Stern3a3416b2006-08-21 12:00:53 -0400117 sdev->sdev_target->pdt_1f_for_no_lun = 1;
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return 0;
120}
121
122static int slave_configure(struct scsi_device *sdev)
123{
124 struct us_data *us = host_to_us(sdev->host);
125
Phil Dibowitz883d9892006-06-24 17:27:10 -0700126 /* Many devices have trouble transfering more than 32KB at a time,
127 * while others have trouble with more than 64K. At this time we
128 * are limiting both to 32K (64 sectores).
129 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400130 if (us->fflags & (US_FL_MAX_SECTORS_64 | US_FL_MAX_SECTORS_MIN)) {
Doug Maxey33abc042007-12-05 23:36:45 -0600131 unsigned int max_sectors = 64;
132
Alan Stern7e4d6c32008-05-01 15:35:18 -0400133 if (us->fflags & US_FL_MAX_SECTORS_MIN)
Doug Maxey33abc042007-12-05 23:36:45 -0600134 max_sectors = PAGE_CACHE_SIZE >> 9;
Alan Stern49d62712010-02-26 11:49:39 -0500135 if (queue_max_hw_sectors(sdev->request_queue) > max_sectors)
Martin K. Petersen086fa5f2010-02-26 00:20:38 -0500136 blk_queue_max_hw_sectors(sdev->request_queue,
Doug Maxey33abc042007-12-05 23:36:45 -0600137 max_sectors);
Alan Stern5c160342009-03-23 09:51:02 -0400138 } else if (sdev->type == TYPE_TAPE) {
139 /* Tapes need much higher max_sector limits, so just
140 * raise it to the maximum possible (4 GB / 512) and
141 * let the queue segment size sort out the real limit.
142 */
Martin K. Petersen086fa5f2010-02-26 00:20:38 -0500143 blk_queue_max_hw_sectors(sdev->request_queue, 0x7FFFFF);
Doug Maxey33abc042007-12-05 23:36:45 -0600144 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Alan Stern96983d22008-11-21 11:46:17 -0500146 /* Some USB host controllers can't do DMA; they have to use PIO.
147 * They indicate this by setting their dma_mask to NULL. For
148 * such controllers we need to make sure the block layer sets
149 * up bounce buffers in addressable memory.
150 */
151 if (!us->pusb_dev->bus->controller->dma_mask)
152 blk_queue_bounce_limit(sdev->request_queue, BLK_BOUNCE_HIGH);
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 /* We can't put these settings in slave_alloc() because that gets
155 * called before the device type is known. Consequently these
156 * settings can't be overridden via the scsi devinfo mechanism. */
157 if (sdev->type == TYPE_DISK) {
158
Alan Sterna81a81a2008-12-18 16:41:49 -0500159 /* Some vendors seem to put the READ CAPACITY bug into
160 * all their devices -- primarily makers of cell phones
161 * and digital cameras. Since these devices always use
162 * flash media and can be expected to have an even number
163 * of sectors, we will always enable the CAPACITY_HEURISTICS
164 * flag unless told otherwise. */
165 switch (le16_to_cpu(us->pusb_dev->descriptor.idVendor)) {
166 case VENDOR_ID_NOKIA:
167 case VENDOR_ID_NIKON:
Alan Stern506e9462009-02-04 15:48:03 -0500168 case VENDOR_ID_PENTAX:
Alan Sterna81a81a2008-12-18 16:41:49 -0500169 case VENDOR_ID_MOTOROLA:
170 if (!(us->fflags & (US_FL_FIX_CAPACITY |
171 US_FL_CAPACITY_OK)))
172 us->fflags |= US_FL_CAPACITY_HEURISTICS;
173 break;
174 }
175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 /* Disk-type devices use MODE SENSE(6) if the protocol
177 * (SubClass) is Transparent SCSI, otherwise they use
178 * MODE SENSE(10). */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200179 if (us->subclass != USB_SC_SCSI && us->subclass != USB_SC_CYP_ATACB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 sdev->use_10_for_ms = 1;
181
182 /* Many disks only accept MODE SENSE transfer lengths of
183 * 192 bytes (that's what Windows uses). */
184 sdev->use_192_bytes_for_3f = 1;
185
186 /* Some devices don't like MODE SENSE with page=0x3f,
187 * which is the command used for checking if a device
188 * is write-protected. Now that we tell the sd driver
189 * to do a 192-byte transfer with this command the
190 * majority of devices work fine, but a few still can't
191 * handle it. The sd driver will simply assume those
192 * devices are write-enabled. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400193 if (us->fflags & US_FL_NO_WP_DETECT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 sdev->skip_ms_page_3f = 1;
195
196 /* A number of devices have problems with MODE SENSE for
197 * page x08, so we will skip it. */
198 sdev->skip_ms_page_8 = 1;
199
200 /* Some disks return the total number of blocks in response
201 * to READ CAPACITY rather than the highest block number.
202 * If this device makes that mistake, tell the sd driver. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400203 if (us->fflags & US_FL_FIX_CAPACITY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 sdev->fix_capacity = 1;
Matthew Dharm86dbde92005-06-06 17:22:42 -0700205
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100206 /* A few disks have two indistinguishable version, one of
207 * which reports the correct capacity and the other does not.
208 * The sd driver has to guess which is the case. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400209 if (us->fflags & US_FL_CAPACITY_HEURISTICS)
Oliver Neukum61bf54b2007-02-08 09:04:48 +0100210 sdev->guess_capacity = 1;
211
Hans de Goede00914022010-10-01 14:20:11 -0700212 /* Some devices cannot handle READ_CAPACITY_16 */
213 if (us->fflags & US_FL_NO_READ_CAPACITY_16)
214 sdev->no_read_capacity_16 = 1;
215
Ben Efros1537e0a2008-11-18 13:31:13 -0800216 /* assume SPC3 or latter devices support sense size > 18 */
217 if (sdev->scsi_level > SCSI_SPC_2)
218 us->fflags |= US_FL_SANE_SENSE;
219
Matthew Dharma4e62832005-07-28 14:50:29 -0700220 /* Some devices report a SCSI revision level above 2 but are
221 * unable to handle the REPORT LUNS command (for which
222 * support is mandatory at level 3). Since we already have
223 * a Get-Max-LUN request, we won't lose much by setting the
224 * revision level down to 2. The only devices that would be
225 * affected are those with sparse LUNs. */
Alan Sternf3f49062007-01-08 16:18:05 -0500226 if (sdev->scsi_level > SCSI_2)
227 sdev->sdev_target->scsi_level =
228 sdev->scsi_level = SCSI_2;
Matthew Dharma4e62832005-07-28 14:50:29 -0700229
Matthew Dharm86dbde92005-06-06 17:22:42 -0700230 /* USB-IDE bridges tend to report SK = 0x04 (Non-recoverable
231 * Hardware Error) when any low-level error occurs,
232 * recoverable or not. Setting this flag tells the SCSI
233 * midlayer to retry such commands, which frequently will
234 * succeed and fix the error. The worst this can lead to
235 * is an occasional series of retries that will all fail. */
236 sdev->retry_hwerror = 1;
237
Mauro Carvalho Chehabf09e4952007-10-10 16:29:02 -0400238 /* USB disks should allow restart. Some drives spin down
239 * automatically, requiring a START-STOP UNIT command. */
240 sdev->allow_restart = 1;
241
Hans de Goede23c3e292008-01-20 11:27:29 +0100242 /* Some USB cardreaders have trouble reading an sdcard's last
243 * sector in a larger then 1 sector read, since the performance
244 * impact is negible we set this flag for all USB disks */
245 sdev->last_sector_bug = 1;
Alan Stern25ff1c32008-12-15 12:43:41 -0500246
247 /* Enable last-sector hacks for single-target devices using
248 * the Bulk-only transport, unless we already know the
249 * capacity will be decremented or is correct. */
250 if (!(us->fflags & (US_FL_FIX_CAPACITY | US_FL_CAPACITY_OK |
251 US_FL_SCM_MULT_TARG)) &&
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200252 us->protocol == USB_PR_BULK)
Alan Stern25ff1c32008-12-15 12:43:41 -0500253 us->use_last_sector_hacks = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 } else {
255
256 /* Non-disk-type devices don't need to blacklist any pages
257 * or to force 192-byte transfer lengths for MODE SENSE.
258 * But they do need to use MODE SENSE(10). */
259 sdev->use_10_for_ms = 1;
Hans de Goedeae38c782010-10-01 14:20:10 -0700260
261 /* Some (fake) usb cdrom devices don't like READ_DISC_INFO */
262 if (us->fflags & US_FL_NO_READ_DISC_INFO)
263 sdev->no_read_disc_info = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
265
Alan Sternf3f49062007-01-08 16:18:05 -0500266 /* The CB and CBI transports have no way to pass LUN values
267 * other than the bits in the second byte of a CDB. But those
268 * bits don't get set to the LUN value if the device reports
269 * scsi_level == 0 (UNKNOWN). Hence such devices must necessarily
270 * be single-LUN.
271 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200272 if ((us->protocol == USB_PR_CB || us->protocol == USB_PR_CBI) &&
Alan Sternf3f49062007-01-08 16:18:05 -0500273 sdev->scsi_level == SCSI_UNKNOWN)
274 us->max_lun = 0;
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 /* Some devices choke when they receive a PREVENT-ALLOW MEDIUM
277 * REMOVAL command, so suppress those commands. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400278 if (us->fflags & US_FL_NOT_LOCKABLE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 sdev->lockable = 0;
280
281 /* this is to satisfy the compiler, tho I don't think the
282 * return code is ever checked anywhere. */
283 return 0;
284}
285
286/* queue a command */
287/* This is always called with scsi_lock(host) held */
Jeff Garzikf2812332010-11-16 02:10:29 -0500288static int queuecommand_lck(struct scsi_cmnd *srb,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 void (*done)(struct scsi_cmnd *))
290{
291 struct us_data *us = host_to_us(srb->device->host);
292
Harvey Harrison441b62c2008-03-03 16:08:34 -0800293 US_DEBUGP("%s called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295 /* check for state-transition errors */
296 if (us->srb != NULL) {
297 printk(KERN_ERR USB_STORAGE "Error in %s: us->srb = %p\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800298 __func__, us->srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 return SCSI_MLQUEUE_HOST_BUSY;
300 }
301
302 /* fail the command if we are disconnecting */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400303 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 US_DEBUGP("Fail command during disconnect\n");
305 srb->result = DID_NO_CONNECT << 16;
306 done(srb);
307 return 0;
308 }
309
310 /* enqueue the command and wake up the control thread */
311 srb->scsi_done = done;
312 us->srb = srb;
Alan Stern7119e3c2008-05-01 15:36:13 -0400313 complete(&us->cmnd_ready);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 return 0;
316}
317
Jeff Garzikf2812332010-11-16 02:10:29 -0500318static DEF_SCSI_QCMD(queuecommand)
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/***********************************************************************
321 * Error handling functions
322 ***********************************************************************/
323
324/* Command timeout and abort */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325static int command_abort(struct scsi_cmnd *srb)
326{
327 struct us_data *us = host_to_us(srb->device->host);
328
Harvey Harrison441b62c2008-03-03 16:08:34 -0800329 US_DEBUGP("%s called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Matthew Dharm226173e2005-08-25 20:03:50 -0700331 /* us->srb together with the TIMED_OUT, RESETTING, and ABORTING
332 * bits are protected by the host lock. */
333 scsi_lock(us_to_host(us));
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 /* Is this command still active? */
336 if (us->srb != srb) {
Matthew Dharm226173e2005-08-25 20:03:50 -0700337 scsi_unlock(us_to_host(us));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 US_DEBUGP ("-- nothing to abort\n");
339 return FAILED;
340 }
341
342 /* Set the TIMED_OUT bit. Also set the ABORTING bit, but only if
343 * a device reset isn't already in progress (to avoid interfering
Matthew Dharm226173e2005-08-25 20:03:50 -0700344 * with the reset). Note that we must retain the host lock while
345 * calling usb_stor_stop_transport(); otherwise it might interfere
346 * with an auto-reset that begins as soon as we release the lock. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400347 set_bit(US_FLIDX_TIMED_OUT, &us->dflags);
348 if (!test_bit(US_FLIDX_RESETTING, &us->dflags)) {
349 set_bit(US_FLIDX_ABORTING, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 usb_stor_stop_transport(us);
351 }
Matthew Dharm226173e2005-08-25 20:03:50 -0700352 scsi_unlock(us_to_host(us));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
354 /* Wait for the aborted command to finish */
355 wait_for_completion(&us->notify);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return SUCCESS;
357}
358
359/* This invokes the transport reset mechanism to reset the state of the
360 * device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361static int device_reset(struct scsi_cmnd *srb)
362{
363 struct us_data *us = host_to_us(srb->device->host);
364 int result;
365
Harvey Harrison441b62c2008-03-03 16:08:34 -0800366 US_DEBUGP("%s called\n", __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Greg Kroah-Hartmand5268752007-09-13 06:01:24 -0700368 /* lock the device pointers and do the reset */
369 mutex_lock(&(us->dev_mutex));
370 result = us->transport_reset(us);
371 mutex_unlock(&us->dev_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700373 return result < 0 ? FAILED : SUCCESS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374}
375
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700376/* Simulate a SCSI bus reset by resetting the device's USB port. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377static int bus_reset(struct scsi_cmnd *srb)
378{
379 struct us_data *us = host_to_us(srb->device->host);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700380 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Harvey Harrison441b62c2008-03-03 16:08:34 -0800382 US_DEBUGP("%s called\n", __func__);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700383 result = usb_stor_port_reset(us);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 return result < 0 ? FAILED : SUCCESS;
385}
386
387/* Report a driver-initiated device reset to the SCSI layer.
388 * Calling this for a SCSI-initiated reset is unnecessary but harmless.
389 * The caller must own the SCSI host lock. */
390void usb_stor_report_device_reset(struct us_data *us)
391{
392 int i;
393 struct Scsi_Host *host = us_to_host(us);
394
395 scsi_report_device_reset(host, 0, 0);
Alan Stern7e4d6c32008-05-01 15:35:18 -0400396 if (us->fflags & US_FL_SCM_MULT_TARG) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 for (i = 1; i < host->max_id; ++i)
398 scsi_report_device_reset(host, 0, i);
399 }
400}
401
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700402/* Report a driver-initiated bus reset to the SCSI layer.
403 * Calling this for a SCSI-initiated reset is unnecessary but harmless.
Alan Sternf07600c2007-05-30 15:38:16 -0400404 * The caller must not own the SCSI host lock. */
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700405void usb_stor_report_bus_reset(struct us_data *us)
406{
Alan Sternf07600c2007-05-30 15:38:16 -0400407 struct Scsi_Host *host = us_to_host(us);
408
409 scsi_lock(host);
410 scsi_report_bus_reset(host, 0);
411 scsi_unlock(host);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700412}
413
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414/***********************************************************************
415 * /proc/scsi/ functions
416 ***********************************************************************/
417
418/* we use this macro to help us write into the buffer */
419#undef SPRINTF
420#define SPRINTF(args...) \
421 do { if (pos < buffer+length) pos += sprintf(pos, ## args); } while (0)
422
423static int proc_info (struct Scsi_Host *host, char *buffer,
424 char **start, off_t offset, int length, int inout)
425{
426 struct us_data *us = host_to_us(host);
427 char *pos = buffer;
428 const char *string;
429
430 /* if someone is sending us data, just throw it away */
431 if (inout)
432 return length;
433
434 /* print the controller name */
435 SPRINTF(" Host scsi%d: usb-storage\n", host->host_no);
436
437 /* print product, vendor, and serial number strings */
438 if (us->pusb_dev->manufacturer)
439 string = us->pusb_dev->manufacturer;
440 else if (us->unusual_dev->vendorName)
441 string = us->unusual_dev->vendorName;
442 else
443 string = "Unknown";
444 SPRINTF(" Vendor: %s\n", string);
445 if (us->pusb_dev->product)
446 string = us->pusb_dev->product;
447 else if (us->unusual_dev->productName)
448 string = us->unusual_dev->productName;
449 else
450 string = "Unknown";
451 SPRINTF(" Product: %s\n", string);
452 if (us->pusb_dev->serial)
453 string = us->pusb_dev->serial;
454 else
455 string = "None";
456 SPRINTF("Serial Number: %s\n", string);
457
458 /* show the protocol and transport */
459 SPRINTF(" Protocol: %s\n", us->protocol_name);
460 SPRINTF(" Transport: %s\n", us->transport_name);
461
462 /* show the device flags */
463 if (pos < buffer + length) {
464 pos += sprintf(pos, " Quirks:");
465
466#define US_FLAG(name, value) \
Alan Stern7e4d6c32008-05-01 15:35:18 -0400467 if (us->fflags & value) pos += sprintf(pos, " " #name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468US_DO_ALL_FLAGS
469#undef US_FLAG
470
471 *(pos++) = '\n';
472 }
473
474 /*
475 * Calculate start of next buffer, and return value.
476 */
477 *start = buffer + offset;
478
479 if ((pos - buffer) < offset)
480 return (0);
481 else if ((pos - buffer - offset) < length)
482 return (pos - buffer - offset);
483 else
484 return (length);
485}
486
487/***********************************************************************
488 * Sysfs interface
489 ***********************************************************************/
490
491/* Output routine for the sysfs max_sectors file */
Yani Ioannou060b8842005-05-17 06:44:04 -0400492static ssize_t show_max_sectors(struct device *dev, struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
494 struct scsi_device *sdev = to_scsi_device(dev);
495
Alan Stern49d62712010-02-26 11:49:39 -0500496 return sprintf(buf, "%u\n", queue_max_hw_sectors(sdev->request_queue));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
499/* Input routine for the sysfs max_sectors file */
Yani Ioannou060b8842005-05-17 06:44:04 -0400500static ssize_t store_max_sectors(struct device *dev, struct device_attribute *attr, const char *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 size_t count)
502{
503 struct scsi_device *sdev = to_scsi_device(dev);
504 unsigned short ms;
505
Alan Stern49d62712010-02-26 11:49:39 -0500506 if (sscanf(buf, "%hu", &ms) > 0) {
Martin K. Petersen086fa5f2010-02-26 00:20:38 -0500507 blk_queue_max_hw_sectors(sdev->request_queue, ms);
Alan Stern49d62712010-02-26 11:49:39 -0500508 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
510 return -EINVAL;
511}
512
513static DEVICE_ATTR(max_sectors, S_IRUGO | S_IWUSR, show_max_sectors,
514 store_max_sectors);
515
516static struct device_attribute *sysfs_device_attr_list[] = {
517 &dev_attr_max_sectors,
518 NULL,
519 };
520
521/*
522 * this defines our host template, with which we'll allocate hosts
523 */
524
525struct scsi_host_template usb_stor_host_template = {
526 /* basic userland interface stuff */
527 .name = "usb-storage",
528 .proc_name = "usb-storage",
529 .proc_info = proc_info,
530 .info = host_info,
531
532 /* command interface -- queued only */
533 .queuecommand = queuecommand,
534
535 /* error and abort handlers */
536 .eh_abort_handler = command_abort,
537 .eh_device_reset_handler = device_reset,
538 .eh_bus_reset_handler = bus_reset,
539
540 /* queue commands only, only one command per LUN */
541 .can_queue = 1,
542 .cmd_per_lun = 1,
543
544 /* unknown initiator id */
545 .this_id = -1,
546
547 .slave_alloc = slave_alloc,
548 .slave_configure = slave_configure,
549
550 /* lots of sg segments can be handled */
Alan Stern49d62712010-02-26 11:49:39 -0500551 .sg_tablesize = SCSI_MAX_SG_CHAIN_SEGMENTS,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553 /* limit the total size of a transfer to 120 KB */
554 .max_sectors = 240,
555
556 /* merge commands... this seems to help performance, but
557 * periodically someone should test to see which setting is more
558 * optimal.
559 */
560 .use_clustering = 1,
561
562 /* emulated HBA */
563 .emulated = 1,
564
565 /* we do our own delay after a device or bus reset */
566 .skip_settle_delay = 1,
567
568 /* sysfs device attributes */
569 .sdev_attrs = sysfs_device_attr_list,
570
571 /* module management */
572 .module = THIS_MODULE
573};
574
575/* To Report "Illegal Request: Invalid Field in CDB */
576unsigned char usb_stor_sense_invalidCDB[18] = {
577 [0] = 0x70, /* current error */
578 [2] = ILLEGAL_REQUEST, /* Illegal Request = 0x05 */
579 [7] = 0x0a, /* additional length */
580 [12] = 0x24 /* Invalid Field in CDB */
581};
Alan Sterne6e244b2009-02-12 14:47:44 -0500582EXPORT_SYMBOL_GPL(usb_stor_sense_invalidCDB);