4 * Copyright (C) 2000 Eric Youngdale,
5 * Copyright (C) 2002 Patrick Mansfield
7 * The general scanning/probing algorithm is as follows, exceptions are
8 * made to it depending on device specific flags, compilation options, and
9 * global variable (boot or module load time) settings.
11 * A specific LUN is scanned via an INQUIRY command; if the LUN has a
12 * device attached, a scsi_device is allocated and setup for it.
14 * For every id of every channel on the given host:
16 * Scan LUN 0; if the target responds to LUN 0 (even if there is no
17 * device or storage attached to LUN 0):
19 * If LUN 0 has a device attached, allocate and setup a
22 * If target is SCSI-3 or up, issue a REPORT LUN, and scan
23 * all of the LUNs returned by the REPORT LUN; else,
24 * sequentially scan LUNs up until some maximum is reached,
25 * or a LUN is seen that cannot have a device attached to it.
28 #include <linux/config.h>
29 #include <linux/module.h>
30 #include <linux/moduleparam.h>
31 #include <linux/init.h>
32 #include <linux/blkdev.h>
33 #include <asm/semaphore.h>
35 #include <scsi/scsi.h>
36 #include <scsi/scsi_device.h>
37 #include <scsi/scsi_driver.h>
38 #include <scsi/scsi_devinfo.h>
39 #include <scsi/scsi_host.h>
40 #include <scsi/scsi_request.h>
41 #include <scsi/scsi_transport.h>
42 #include <scsi/scsi_eh.h>
44 #include "scsi_priv.h"
45 #include "scsi_logging.h"
47 #define ALLOC_FAILURE_MSG KERN_ERR "%s: Allocation failure during" \
48 " SCSI scanning, some SCSI devices might not be configured\n"
53 #define SCSI_TIMEOUT (2*HZ)
56 * Prefix values for the SCSI id's (stored in driverfs name field)
58 #define SCSI_UID_SER_NUM 'S'
59 #define SCSI_UID_UNKNOWN 'Z'
62 * Return values of some of the scanning functions.
64 * SCSI_SCAN_NO_RESPONSE: no valid response received from the target, this
65 * includes allocation or general failures preventing IO from being sent.
67 * SCSI_SCAN_TARGET_PRESENT: target responded, but no device is available
70 * SCSI_SCAN_LUN_PRESENT: target responded, and a device is available on a
73 #define SCSI_SCAN_NO_RESPONSE 0
74 #define SCSI_SCAN_TARGET_PRESENT 1
75 #define SCSI_SCAN_LUN_PRESENT 2
77 static const char *scsi_null_device_strs = "nullnullnullnull";
79 #define MAX_SCSI_LUNS 512
81 #ifdef CONFIG_SCSI_MULTI_LUN
82 static unsigned int max_scsi_luns = MAX_SCSI_LUNS;
84 static unsigned int max_scsi_luns = 1;
87 module_param_named(max_luns, max_scsi_luns, int, S_IRUGO|S_IWUSR);
88 MODULE_PARM_DESC(max_luns,
89 "last scsi LUN (should be between 1 and 2^32-1)");
92 * max_scsi_report_luns: the maximum number of LUNS that will be
93 * returned from the REPORT LUNS command. 8 times this value must
94 * be allocated. In theory this could be up to an 8 byte value, but
95 * in practice, the maximum number of LUNs suppored by any device
98 static unsigned int max_scsi_report_luns = 511;
100 module_param_named(max_report_luns, max_scsi_report_luns, int, S_IRUGO|S_IWUSR);
101 MODULE_PARM_DESC(max_report_luns,
102 "REPORT LUNS maximum number of LUNS received (should be"
103 " between 1 and 16384)");
105 static unsigned int scsi_inq_timeout = SCSI_TIMEOUT/HZ+3;
107 module_param_named(inq_timeout, scsi_inq_timeout, int, S_IRUGO|S_IWUSR);
108 MODULE_PARM_DESC(inq_timeout,
109 "Timeout (in seconds) waiting for devices to answer INQUIRY."
110 " Default is 5. Some non-compliant devices need more.");
113 * scsi_unlock_floptical - unlock device via a special MODE SENSE command
114 * @sdev: scsi device to send command to
115 * @result: area to store the result of the MODE SENSE
118 * Send a vendor specific MODE SENSE (not a MODE SELECT) command.
119 * Called for BLIST_KEY devices.
121 static void scsi_unlock_floptical(struct scsi_device *sdev,
122 unsigned char *result)
124 unsigned char scsi_cmd[MAX_COMMAND_SIZE];
126 printk(KERN_NOTICE "scsi: unlocking floptical drive\n");
127 scsi_cmd[0] = MODE_SENSE;
131 scsi_cmd[4] = 0x2a; /* size */
133 scsi_execute_req(sdev, scsi_cmd, DMA_FROM_DEVICE, result, 0x2a, NULL,
138 * print_inquiry - printk the inquiry information
139 * @inq_result: printk this SCSI INQUIRY
142 * printk the vendor, model, and other information found in the
143 * INQUIRY data in @inq_result.
146 * Remove this, and replace with a hotplug event that logs any
147 * relevant information.
149 static void print_inquiry(unsigned char *inq_result)
153 printk(KERN_NOTICE " Vendor: ");
154 for (i = 8; i < 16; i++)
155 if (inq_result[i] >= 0x20 && i < inq_result[4] + 5)
156 printk("%c", inq_result[i]);
161 for (i = 16; i < 32; i++)
162 if (inq_result[i] >= 0x20 && i < inq_result[4] + 5)
163 printk("%c", inq_result[i]);
168 for (i = 32; i < 36; i++)
169 if (inq_result[i] >= 0x20 && i < inq_result[4] + 5)
170 printk("%c", inq_result[i]);
176 i = inq_result[0] & 0x1f;
178 printk(KERN_NOTICE " Type: %s ",
180 MAX_SCSI_DEVICE_CODE ? scsi_device_types[i] :
182 printk(" ANSI SCSI revision: %02x",
183 inq_result[2] & 0x07);
184 if ((inq_result[2] & 0x07) == 1 && (inq_result[3] & 0x0f) == 1)
191 * scsi_alloc_sdev - allocate and setup a scsi_Device
194 * Allocate, initialize for io, and return a pointer to a scsi_Device.
195 * Stores the @shost, @channel, @id, and @lun in the scsi_Device, and
196 * adds scsi_Device to the appropriate list.
199 * scsi_Device pointer, or NULL on failure.
201 static struct scsi_device *scsi_alloc_sdev(struct scsi_target *starget,
202 unsigned int lun, void *hostdata)
204 struct scsi_device *sdev;
205 int display_failure_msg = 1, ret;
206 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
208 sdev = kzalloc(sizeof(*sdev) + shost->transportt->device_size,
213 sdev->vendor = scsi_null_device_strs;
214 sdev->model = scsi_null_device_strs;
215 sdev->rev = scsi_null_device_strs;
217 sdev->id = starget->id;
219 sdev->channel = starget->channel;
220 sdev->sdev_state = SDEV_CREATED;
221 INIT_LIST_HEAD(&sdev->siblings);
222 INIT_LIST_HEAD(&sdev->same_target_siblings);
223 INIT_LIST_HEAD(&sdev->cmd_list);
224 INIT_LIST_HEAD(&sdev->starved_entry);
225 spin_lock_init(&sdev->list_lock);
227 sdev->sdev_gendev.parent = get_device(&starget->dev);
228 sdev->sdev_target = starget;
230 /* usually NULL and set by ->slave_alloc instead */
231 sdev->hostdata = hostdata;
233 /* if the device needs this changing, it may do so in the
234 * slave_configure function */
235 sdev->max_device_blocked = SCSI_DEFAULT_DEVICE_BLOCKED;
238 * Some low level driver could use device->type
243 * Assume that the device will have handshaking problems,
244 * and then fix this field later if it turns out it
249 sdev->request_queue = scsi_alloc_queue(sdev);
250 if (!sdev->request_queue) {
251 /* release fn is set up in scsi_sysfs_device_initialise, so
252 * have to free and put manually here */
253 put_device(&starget->dev);
258 sdev->request_queue->queuedata = sdev;
259 scsi_adjust_queue_depth(sdev, 0, sdev->host->cmd_per_lun);
261 scsi_sysfs_device_initialize(sdev);
263 if (shost->hostt->slave_alloc) {
264 ret = shost->hostt->slave_alloc(sdev);
267 * if LLDD reports slave not present, don't clutter
268 * console with alloc failure messages
271 display_failure_msg = 0;
272 goto out_device_destroy;
279 transport_destroy_device(&sdev->sdev_gendev);
280 put_device(&sdev->sdev_gendev);
282 if (display_failure_msg)
283 printk(ALLOC_FAILURE_MSG, __FUNCTION__);
287 static void scsi_target_dev_release(struct device *dev)
289 struct device *parent = dev->parent;
290 struct scsi_target *starget = to_scsi_target(dev);
296 int scsi_is_target_device(const struct device *dev)
298 return dev->release == scsi_target_dev_release;
300 EXPORT_SYMBOL(scsi_is_target_device);
302 static struct scsi_target *__scsi_find_target(struct device *parent,
303 int channel, uint id)
305 struct scsi_target *starget, *found_starget = NULL;
306 struct Scsi_Host *shost = dev_to_shost(parent);
308 * Search for an existing target for this sdev.
310 list_for_each_entry(starget, &shost->__targets, siblings) {
311 if (starget->id == id &&
312 starget->channel == channel) {
313 found_starget = starget;
318 get_device(&found_starget->dev);
320 return found_starget;
323 static struct scsi_target *scsi_alloc_target(struct device *parent,
324 int channel, uint id)
326 struct Scsi_Host *shost = dev_to_shost(parent);
327 struct device *dev = NULL;
329 const int size = sizeof(struct scsi_target)
330 + shost->transportt->target_size;
331 struct scsi_target *starget;
332 struct scsi_target *found_target;
335 starget = kzalloc(size, GFP_KERNEL);
337 printk(KERN_ERR "%s: allocation failure\n", __FUNCTION__);
341 device_initialize(dev);
342 starget->reap_ref = 1;
343 dev->parent = get_device(parent);
344 dev->release = scsi_target_dev_release;
345 sprintf(dev->bus_id, "target%d:%d:%d",
346 shost->host_no, channel, id);
348 starget->channel = channel;
349 INIT_LIST_HEAD(&starget->siblings);
350 INIT_LIST_HEAD(&starget->devices);
351 starget->state = STARGET_RUNNING;
353 spin_lock_irqsave(shost->host_lock, flags);
355 found_target = __scsi_find_target(parent, channel, id);
359 list_add_tail(&starget->siblings, &shost->__targets);
360 spin_unlock_irqrestore(shost->host_lock, flags);
361 /* allocate and add */
362 transport_setup_device(dev);
363 error = device_add(dev);
365 dev_err(dev, "target device_add failed, error %d\n", error);
366 spin_lock_irqsave(shost->host_lock, flags);
367 list_del_init(&starget->siblings);
368 spin_unlock_irqrestore(shost->host_lock, flags);
369 transport_destroy_device(dev);
374 transport_add_device(dev);
375 if (shost->hostt->target_alloc) {
376 error = shost->hostt->target_alloc(starget);
379 dev_printk(KERN_ERR, dev, "target allocation failed, error %d\n", error);
380 /* don't want scsi_target_reap to do the final
381 * put because it will be under the host lock */
383 scsi_target_reap(starget);
392 found_target->reap_ref++;
393 spin_unlock_irqrestore(shost->host_lock, flags);
395 if (found_target->state != STARGET_DEL) {
399 /* Unfortunately, we found a dying target; need to
400 * wait until it's dead before we can get a new one */
401 put_device(&found_target->dev);
402 flush_scheduled_work();
406 static void scsi_target_reap_usercontext(void *data)
408 struct scsi_target *starget = data;
409 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
412 transport_remove_device(&starget->dev);
413 device_del(&starget->dev);
414 transport_destroy_device(&starget->dev);
415 spin_lock_irqsave(shost->host_lock, flags);
416 if (shost->hostt->target_destroy)
417 shost->hostt->target_destroy(starget);
418 list_del_init(&starget->siblings);
419 spin_unlock_irqrestore(shost->host_lock, flags);
420 put_device(&starget->dev);
424 * scsi_target_reap - check to see if target is in use and destroy if not
426 * @starget: target to be checked
428 * This is used after removing a LUN or doing a last put of the target
429 * it checks atomically that nothing is using the target and removes
432 void scsi_target_reap(struct scsi_target *starget)
434 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
437 spin_lock_irqsave(shost->host_lock, flags);
439 if (--starget->reap_ref == 0 && list_empty(&starget->devices)) {
440 BUG_ON(starget->state == STARGET_DEL);
441 starget->state = STARGET_DEL;
442 spin_unlock_irqrestore(shost->host_lock, flags);
443 execute_in_process_context(scsi_target_reap_usercontext,
444 starget, &starget->ew);
448 spin_unlock_irqrestore(shost->host_lock, flags);
454 * scsi_probe_lun - probe a single LUN using a SCSI INQUIRY
455 * @sdev: scsi_device to probe
456 * @inq_result: area to store the INQUIRY result
457 * @result_len: len of inq_result
458 * @bflags: store any bflags found here
461 * Probe the lun associated with @req using a standard SCSI INQUIRY;
463 * If the INQUIRY is successful, zero is returned and the
464 * INQUIRY data is in @inq_result; the scsi_level and INQUIRY length
465 * are copied to the scsi_device any flags value is stored in *@bflags.
467 static int scsi_probe_lun(struct scsi_device *sdev, char *inq_result,
468 int result_len, int *bflags)
470 unsigned char scsi_cmd[MAX_COMMAND_SIZE];
471 int first_inquiry_len, try_inquiry_len, next_inquiry_len;
472 int response_len = 0;
473 int pass, count, result;
474 struct scsi_sense_hdr sshdr;
478 /* Perform up to 3 passes. The first pass uses a conservative
479 * transfer length of 36 unless sdev->inquiry_len specifies a
480 * different value. */
481 first_inquiry_len = sdev->inquiry_len ? sdev->inquiry_len : 36;
482 try_inquiry_len = first_inquiry_len;
486 SCSI_LOG_SCAN_BUS(3, sdev_printk(KERN_INFO, sdev,
487 "scsi scan: INQUIRY pass %d length %d\n",
488 pass, try_inquiry_len));
490 /* Each pass gets up to three chances to ignore Unit Attention */
491 for (count = 0; count < 3; ++count) {
492 memset(scsi_cmd, 0, 6);
493 scsi_cmd[0] = INQUIRY;
494 scsi_cmd[4] = (unsigned char) try_inquiry_len;
496 memset(inq_result, 0, try_inquiry_len);
498 result = scsi_execute_req(sdev, scsi_cmd, DMA_FROM_DEVICE,
499 inq_result, try_inquiry_len, &sshdr,
500 HZ / 2 + HZ * scsi_inq_timeout, 3);
502 SCSI_LOG_SCAN_BUS(3, printk(KERN_INFO "scsi scan: INQUIRY %s "
504 result ? "failed" : "successful", result));
508 * not-ready to ready transition [asc/ascq=0x28/0x0]
509 * or power-on, reset [asc/ascq=0x29/0x0], continue.
510 * INQUIRY should not yield UNIT_ATTENTION
511 * but many buggy devices do so anyway.
513 if ((driver_byte(result) & DRIVER_SENSE) &&
514 scsi_sense_valid(&sshdr)) {
515 if ((sshdr.sense_key == UNIT_ATTENTION) &&
516 ((sshdr.asc == 0x28) ||
517 (sshdr.asc == 0x29)) &&
526 response_len = (unsigned char) inq_result[4] + 5;
527 if (response_len > 255)
528 response_len = first_inquiry_len; /* sanity */
531 * Get any flags for this device.
533 * XXX add a bflags to scsi_device, and replace the
534 * corresponding bit fields in scsi_device, so bflags
535 * need not be passed as an argument.
537 *bflags = scsi_get_device_flags(sdev, &inq_result[8],
540 /* When the first pass succeeds we gain information about
541 * what larger transfer lengths might work. */
543 if (BLIST_INQUIRY_36 & *bflags)
544 next_inquiry_len = 36;
545 else if (BLIST_INQUIRY_58 & *bflags)
546 next_inquiry_len = 58;
547 else if (sdev->inquiry_len)
548 next_inquiry_len = sdev->inquiry_len;
550 next_inquiry_len = response_len;
552 /* If more data is available perform the second pass */
553 if (next_inquiry_len > try_inquiry_len) {
554 try_inquiry_len = next_inquiry_len;
560 } else if (pass == 2) {
561 printk(KERN_INFO "scsi scan: %d byte inquiry failed. "
562 "Consider BLIST_INQUIRY_36 for this device\n",
565 /* If this pass failed, the third pass goes back and transfers
566 * the same amount as we successfully got in the first pass. */
567 try_inquiry_len = first_inquiry_len;
572 /* If the last transfer attempt got an error, assume the
573 * peripheral doesn't exist or is dead. */
577 /* Don't report any more data than the device says is valid */
578 sdev->inquiry_len = min(try_inquiry_len, response_len);
581 * XXX Abort if the response length is less than 36? If less than
582 * 32, the lookup of the device flags (above) could be invalid,
583 * and it would be possible to take an incorrect action - we do
584 * not want to hang because of a short INQUIRY. On the flip side,
585 * if the device is spun down or becoming ready (and so it gives a
586 * short INQUIRY), an abort here prevents any further use of the
587 * device, including spin up.
589 * Related to the above issue:
591 * XXX Devices (disk or all?) should be sent a TEST UNIT READY,
592 * and if not ready, sent a START_STOP to start (maybe spin up) and
593 * then send the INQUIRY again, since the INQUIRY can change after
594 * a device is initialized.
596 * Ideally, start a device if explicitly asked to do so. This
597 * assumes that a device is spun up on power on, spun down on
598 * request, and then spun up on request.
602 * The scanning code needs to know the scsi_level, even if no
603 * device is attached at LUN 0 (SCSI_SCAN_TARGET_PRESENT) so
604 * non-zero LUNs can be scanned.
606 sdev->scsi_level = inq_result[2] & 0x07;
607 if (sdev->scsi_level >= 2 ||
608 (sdev->scsi_level == 1 && (inq_result[3] & 0x0f) == 1))
610 sdev->sdev_target->scsi_level = sdev->scsi_level;
616 * scsi_add_lun - allocate and fully initialze a scsi_device
617 * @sdevscan: holds information to be stored in the new scsi_device
618 * @sdevnew: store the address of the newly allocated scsi_device
619 * @inq_result: holds the result of a previous INQUIRY to the LUN
620 * @bflags: black/white list flag
623 * Allocate and initialize a scsi_device matching sdevscan. Optionally
624 * set fields based on values in *@bflags. If @sdevnew is not
625 * NULL, store the address of the new scsi_device in *@sdevnew (needed
626 * when scanning a particular LUN).
629 * SCSI_SCAN_NO_RESPONSE: could not allocate or setup a scsi_device
630 * SCSI_SCAN_LUN_PRESENT: a new scsi_device was allocated and initialized
632 static int scsi_add_lun(struct scsi_device *sdev, char *inq_result, int *bflags)
635 * XXX do not save the inquiry, since it can change underneath us,
636 * save just vendor/model/rev.
638 * Rather than save it and have an ioctl that retrieves the saved
639 * value, have an ioctl that executes the same INQUIRY code used
640 * in scsi_probe_lun, let user level programs doing INQUIRY
641 * scanning run at their own risk, or supply a user level program
642 * that can correctly scan.
644 sdev->inquiry = kmalloc(sdev->inquiry_len, GFP_ATOMIC);
645 if (sdev->inquiry == NULL) {
646 return SCSI_SCAN_NO_RESPONSE;
649 memcpy(sdev->inquiry, inq_result, sdev->inquiry_len);
650 sdev->vendor = (char *) (sdev->inquiry + 8);
651 sdev->model = (char *) (sdev->inquiry + 16);
652 sdev->rev = (char *) (sdev->inquiry + 32);
654 if (*bflags & BLIST_ISROM) {
656 * It would be better to modify sdev->type, and set
657 * sdev->removable, but then the print_inquiry() output
658 * would not show TYPE_ROM; if print_inquiry() is removed
659 * the issue goes away.
661 inq_result[0] = TYPE_ROM;
662 inq_result[1] |= 0x80; /* removable */
663 } else if (*bflags & BLIST_NO_ULD_ATTACH)
664 sdev->no_uld_attach = 1;
666 switch (sdev->type = (inq_result[0] & 0x1f)) {
673 case TYPE_MEDIUM_CHANGER:
684 printk(KERN_INFO "scsi: unknown device type %d\n", sdev->type);
687 print_inquiry(inq_result);
690 * For a peripheral qualifier (PQ) value of 1 (001b), the SCSI
691 * spec says: The device server is capable of supporting the
692 * specified peripheral device type on this logical unit. However,
693 * the physical device is not currently connected to this logical
696 * The above is vague, as it implies that we could treat 001 and
697 * 011 the same. Stay compatible with previous code, and create a
698 * scsi_device for a PQ of 1
700 * Don't set the device offline here; rather let the upper
701 * level drivers eval the PQ to decide whether they should
702 * attach. So remove ((inq_result[0] >> 5) & 7) == 1 check.
705 sdev->inq_periph_qual = (inq_result[0] >> 5) & 7;
706 sdev->removable = (0x80 & inq_result[1]) >> 7;
707 sdev->lockable = sdev->removable;
708 sdev->soft_reset = (inq_result[7] & 1) && ((inq_result[3] & 7) == 2);
710 if (sdev->scsi_level >= SCSI_3 || (sdev->inquiry_len > 56 &&
711 inq_result[56] & 0x04))
713 if (inq_result[7] & 0x60)
715 if (inq_result[7] & 0x10)
722 if ((sdev->scsi_level >= SCSI_2) && (inq_result[7] & 2) &&
723 !(*bflags & BLIST_NOTQ))
724 sdev->tagged_supported = 1;
726 * Some devices (Texel CD ROM drives) have handshaking problems
727 * when used with the Seagate controllers. borken is initialized
728 * to 1, and then set it to 0 here.
730 if ((*bflags & BLIST_BORKEN) == 0)
734 * Apparently some really broken devices (contrary to the SCSI
735 * standards) need to be selected without asserting ATN
737 if (*bflags & BLIST_SELECT_NO_ATN)
738 sdev->select_no_atn = 1;
741 * Some devices may not want to have a start command automatically
742 * issued when a device is added.
744 if (*bflags & BLIST_NOSTARTONADD)
745 sdev->no_start_on_add = 1;
747 if (*bflags & BLIST_SINGLELUN)
748 sdev->single_lun = 1;
751 sdev->use_10_for_rw = 1;
753 if (*bflags & BLIST_MS_SKIP_PAGE_08)
754 sdev->skip_ms_page_8 = 1;
756 if (*bflags & BLIST_MS_SKIP_PAGE_3F)
757 sdev->skip_ms_page_3f = 1;
759 if (*bflags & BLIST_USE_10_BYTE_MS)
760 sdev->use_10_for_ms = 1;
762 /* set the device running here so that slave configure
764 scsi_device_set_state(sdev, SDEV_RUNNING);
766 if (*bflags & BLIST_MS_192_BYTES_FOR_3F)
767 sdev->use_192_bytes_for_3f = 1;
769 if (*bflags & BLIST_NOT_LOCKABLE)
772 if (*bflags & BLIST_RETRY_HWERROR)
773 sdev->retry_hwerror = 1;
775 transport_configure_device(&sdev->sdev_gendev);
777 if (sdev->host->hostt->slave_configure) {
778 int ret = sdev->host->hostt->slave_configure(sdev);
781 * if LLDD reports slave not present, don't clutter
782 * console with alloc failure messages
785 sdev_printk(KERN_ERR, sdev,
786 "failed to configure device\n");
788 return SCSI_SCAN_NO_RESPONSE;
793 * Ok, the device is now all set up, we can
794 * register it and tell the rest of the kernel
797 if (scsi_sysfs_add_sdev(sdev) != 0)
798 return SCSI_SCAN_NO_RESPONSE;
800 return SCSI_SCAN_LUN_PRESENT;
803 static inline void scsi_destroy_sdev(struct scsi_device *sdev)
805 if (sdev->host->hostt->slave_destroy)
806 sdev->host->hostt->slave_destroy(sdev);
807 transport_destroy_device(&sdev->sdev_gendev);
808 put_device(&sdev->sdev_gendev);
813 * scsi_probe_and_add_lun - probe a LUN, if a LUN is found add it
814 * @starget: pointer to target device structure
815 * @lun: LUN of target device
816 * @sdevscan: probe the LUN corresponding to this scsi_device
817 * @sdevnew: store the value of any new scsi_device allocated
818 * @bflagsp: store bflags here if not NULL
821 * Call scsi_probe_lun, if a LUN with an attached device is found,
822 * allocate and set it up by calling scsi_add_lun.
825 * SCSI_SCAN_NO_RESPONSE: could not allocate or setup a scsi_device
826 * SCSI_SCAN_TARGET_PRESENT: target responded, but no device is
827 * attached at the LUN
828 * SCSI_SCAN_LUN_PRESENT: a new scsi_device was allocated and initialized
830 static int scsi_probe_and_add_lun(struct scsi_target *starget,
831 uint lun, int *bflagsp,
832 struct scsi_device **sdevp, int rescan,
835 struct scsi_device *sdev;
836 unsigned char *result;
837 int bflags, res = SCSI_SCAN_NO_RESPONSE, result_len = 256;
838 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
841 * The rescan flag is used as an optimization, the first scan of a
842 * host adapter calls into here with rescan == 0.
844 sdev = scsi_device_lookup_by_target(starget, lun);
846 if (rescan || sdev->sdev_state != SDEV_CREATED) {
847 SCSI_LOG_SCAN_BUS(3, printk(KERN_INFO
848 "scsi scan: device exists on %s\n",
849 sdev->sdev_gendev.bus_id));
853 scsi_device_put(sdev);
856 *bflagsp = scsi_get_device_flags(sdev,
859 return SCSI_SCAN_LUN_PRESENT;
861 scsi_device_put(sdev);
863 sdev = scsi_alloc_sdev(starget, lun, hostdata);
867 result = kmalloc(result_len, GFP_ATOMIC |
868 ((shost->unchecked_isa_dma) ? __GFP_DMA : 0));
872 if (scsi_probe_lun(sdev, result, result_len, &bflags))
873 goto out_free_result;
876 * result contains valid SCSI INQUIRY data.
878 if ((result[0] >> 5) == 3) {
880 * For a Peripheral qualifier 3 (011b), the SCSI
881 * spec says: The device server is not capable of
882 * supporting a physical device on this logical
885 * For disks, this implies that there is no
886 * logical disk configured at sdev->lun, but there
887 * is a target id responding.
889 SCSI_LOG_SCAN_BUS(3, printk(KERN_INFO
890 "scsi scan: peripheral qualifier of 3,"
891 " no device added\n"));
892 res = SCSI_SCAN_TARGET_PRESENT;
893 goto out_free_result;
897 * Non-standard SCSI targets may set the PDT to 0x1f (unknown or
898 * no device type) instead of using the Peripheral Qualifier to
899 * indicate that no LUN is present. For example, USB UFI does this.
901 if (starget->pdt_1f_for_no_lun && (result[0] & 0x1f) == 0x1f) {
902 SCSI_LOG_SCAN_BUS(3, printk(KERN_INFO
903 "scsi scan: peripheral device type"
904 " of 31, no device added\n"));
905 res = SCSI_SCAN_TARGET_PRESENT;
906 goto out_free_result;
909 res = scsi_add_lun(sdev, result, &bflags);
910 if (res == SCSI_SCAN_LUN_PRESENT) {
911 if (bflags & BLIST_KEY) {
913 scsi_unlock_floptical(sdev, result);
922 if (res == SCSI_SCAN_LUN_PRESENT) {
924 if (scsi_device_get(sdev) == 0) {
927 __scsi_remove_device(sdev);
928 res = SCSI_SCAN_NO_RESPONSE;
932 scsi_destroy_sdev(sdev);
938 * scsi_sequential_lun_scan - sequentially scan a SCSI target
939 * @starget: pointer to target structure to scan
940 * @bflags: black/white list flag for LUN 0
941 * @lun0_res: result of scanning LUN 0
944 * Generally, scan from LUN 1 (LUN 0 is assumed to already have been
945 * scanned) to some maximum lun until a LUN is found with no device
946 * attached. Use the bflags to figure out any oddities.
948 * Modifies sdevscan->lun.
950 static void scsi_sequential_lun_scan(struct scsi_target *starget,
951 int bflags, int lun0_res, int scsi_level,
954 unsigned int sparse_lun, lun, max_dev_lun;
955 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
957 SCSI_LOG_SCAN_BUS(3, printk(KERN_INFO "scsi scan: Sequential scan of"
958 "%s\n", starget->dev.bus_id));
960 max_dev_lun = min(max_scsi_luns, shost->max_lun);
962 * If this device is known to support sparse multiple units,
963 * override the other settings, and scan all of them. Normally,
964 * SCSI-3 devices should be scanned via the REPORT LUNS.
966 if (bflags & BLIST_SPARSELUN) {
967 max_dev_lun = shost->max_lun;
973 * If not sparse lun and no device attached at LUN 0 do not scan
976 if (!sparse_lun && (lun0_res != SCSI_SCAN_LUN_PRESENT))
980 * If less than SCSI_1_CSS, and no special lun scaning, stop
981 * scanning; this matches 2.4 behaviour, but could just be a bug
982 * (to continue scanning a SCSI_1_CSS device).
984 * This test is broken. We might not have any device on lun0 for
985 * a sparselun device, and if that's the case then how would we
986 * know the real scsi_level, eh? It might make sense to just not
987 * scan any SCSI_1 device for non-0 luns, but that check would best
988 * go into scsi_alloc_sdev() and just have it return null when asked
989 * to alloc an sdev for lun > 0 on an already found SCSI_1 device.
991 if ((sdevscan->scsi_level < SCSI_1_CCS) &&
992 ((bflags & (BLIST_FORCELUN | BLIST_SPARSELUN | BLIST_MAX5LUN))
997 * If this device is known to support multiple units, override
998 * the other settings, and scan all of them.
1000 if (bflags & BLIST_FORCELUN)
1001 max_dev_lun = shost->max_lun;
1003 * REGAL CDC-4X: avoid hang after LUN 4
1005 if (bflags & BLIST_MAX5LUN)
1006 max_dev_lun = min(5U, max_dev_lun);
1008 * Do not scan SCSI-2 or lower device past LUN 7, unless
1011 if (scsi_level < SCSI_3 && !(bflags & BLIST_LARGELUN))
1012 max_dev_lun = min(8U, max_dev_lun);
1015 * We have already scanned LUN 0, so start at LUN 1. Keep scanning
1016 * until we reach the max, or no LUN is found and we are not
1019 for (lun = 1; lun < max_dev_lun; ++lun)
1020 if ((scsi_probe_and_add_lun(starget, lun, NULL, NULL, rescan,
1021 NULL) != SCSI_SCAN_LUN_PRESENT) &&
1027 * scsilun_to_int: convert a scsi_lun to an int
1028 * @scsilun: struct scsi_lun to be converted.
1031 * Convert @scsilun from a struct scsi_lun to a four byte host byte-ordered
1032 * integer, and return the result. The caller must check for
1033 * truncation before using this function.
1036 * The struct scsi_lun is assumed to be four levels, with each level
1037 * effectively containing a SCSI byte-ordered (big endian) short; the
1038 * addressing bits of each level are ignored (the highest two bits).
1039 * For a description of the LUN format, post SCSI-3 see the SCSI
1040 * Architecture Model, for SCSI-3 see the SCSI Controller Commands.
1042 * Given a struct scsi_lun of: 0a 04 0b 03 00 00 00 00, this function returns
1043 * the integer: 0x0b030a04
1045 static int scsilun_to_int(struct scsi_lun *scsilun)
1051 for (i = 0; i < sizeof(lun); i += 2)
1052 lun = lun | (((scsilun->scsi_lun[i] << 8) |
1053 scsilun->scsi_lun[i + 1]) << (i * 8));
1058 * int_to_scsilun: reverts an int into a scsi_lun
1059 * @int: integer to be reverted
1060 * @scsilun: struct scsi_lun to be set.
1063 * Reverts the functionality of the scsilun_to_int, which packed
1064 * an 8-byte lun value into an int. This routine unpacks the int
1065 * back into the lun value.
1066 * Note: the scsilun_to_int() routine does not truly handle all
1067 * 8bytes of the lun value. This functions restores only as much
1068 * as was set by the routine.
1071 * Given an integer : 0x0b030a04, this function returns a
1072 * scsi_lun of : struct scsi_lun of: 0a 04 0b 03 00 00 00 00
1075 void int_to_scsilun(unsigned int lun, struct scsi_lun *scsilun)
1079 memset(scsilun->scsi_lun, 0, sizeof(scsilun->scsi_lun));
1081 for (i = 0; i < sizeof(lun); i += 2) {
1082 scsilun->scsi_lun[i] = (lun >> 8) & 0xFF;
1083 scsilun->scsi_lun[i+1] = lun & 0xFF;
1087 EXPORT_SYMBOL(int_to_scsilun);
1090 * scsi_report_lun_scan - Scan using SCSI REPORT LUN results
1091 * @sdevscan: scan the host, channel, and id of this scsi_device
1094 * If @sdevscan is for a SCSI-3 or up device, send a REPORT LUN
1095 * command, and scan the resulting list of LUNs by calling
1096 * scsi_probe_and_add_lun.
1098 * Modifies sdevscan->lun.
1101 * 0: scan completed (or no memory, so further scanning is futile)
1102 * 1: no report lun scan, or not configured
1104 static int scsi_report_lun_scan(struct scsi_target *starget, int bflags,
1108 unsigned char scsi_cmd[MAX_COMMAND_SIZE];
1109 unsigned int length;
1111 unsigned int num_luns;
1112 unsigned int retries;
1114 struct scsi_lun *lunp, *lun_data;
1116 struct scsi_sense_hdr sshdr;
1117 struct scsi_device *sdev;
1118 struct Scsi_Host *shost = dev_to_shost(&starget->dev);
1122 * Only support SCSI-3 and up devices if BLIST_NOREPORTLUN is not set.
1123 * Also allow SCSI-2 if BLIST_REPORTLUN2 is set and host adapter does
1124 * support more than 8 LUNs.
1126 if ((bflags & BLIST_NOREPORTLUN) ||
1127 starget->scsi_level < SCSI_2 ||
1128 (starget->scsi_level < SCSI_3 &&
1129 (!(bflags & BLIST_REPORTLUN2) || shost->max_lun <= 8)) )
1131 if (bflags & BLIST_NOLUN)
1134 if (!(sdev = scsi_device_lookup_by_target(starget, 0))) {
1135 sdev = scsi_alloc_sdev(starget, 0, NULL);
1138 if (scsi_device_get(sdev))
1142 sprintf(devname, "host %d channel %d id %d",
1143 shost->host_no, sdev->channel, sdev->id);
1146 * Allocate enough to hold the header (the same size as one scsi_lun)
1147 * plus the max number of luns we are requesting.
1149 * Reallocating and trying again (with the exact amount we need)
1150 * would be nice, but then we need to somehow limit the size
1151 * allocated based on the available memory and the limits of
1152 * kmalloc - we don't want a kmalloc() failure of a huge value to
1153 * prevent us from finding any LUNs on this target.
1155 length = (max_scsi_report_luns + 1) * sizeof(struct scsi_lun);
1156 lun_data = kmalloc(length, GFP_ATOMIC |
1157 (sdev->host->unchecked_isa_dma ? __GFP_DMA : 0));
1159 printk(ALLOC_FAILURE_MSG, __FUNCTION__);
1163 scsi_cmd[0] = REPORT_LUNS;
1166 * bytes 1 - 5: reserved, set to zero.
1168 memset(&scsi_cmd[1], 0, 5);
1171 * bytes 6 - 9: length of the command.
1173 scsi_cmd[6] = (unsigned char) (length >> 24) & 0xff;
1174 scsi_cmd[7] = (unsigned char) (length >> 16) & 0xff;
1175 scsi_cmd[8] = (unsigned char) (length >> 8) & 0xff;
1176 scsi_cmd[9] = (unsigned char) length & 0xff;
1178 scsi_cmd[10] = 0; /* reserved */
1179 scsi_cmd[11] = 0; /* control */
1182 * We can get a UNIT ATTENTION, for example a power on/reset, so
1183 * retry a few times (like sd.c does for TEST UNIT READY).
1184 * Experience shows some combinations of adapter/devices get at
1185 * least two power on/resets.
1187 * Illegal requests (for devices that do not support REPORT LUNS)
1188 * should come through as a check condition, and will not generate
1191 for (retries = 0; retries < 3; retries++) {
1192 SCSI_LOG_SCAN_BUS(3, printk (KERN_INFO "scsi scan: Sending"
1193 " REPORT LUNS to %s (try %d)\n", devname,
1196 result = scsi_execute_req(sdev, scsi_cmd, DMA_FROM_DEVICE,
1197 lun_data, length, &sshdr,
1198 SCSI_TIMEOUT + 4 * HZ, 3);
1200 SCSI_LOG_SCAN_BUS(3, printk (KERN_INFO "scsi scan: REPORT LUNS"
1201 " %s (try %d) result 0x%x\n", result
1202 ? "failed" : "successful", retries, result));
1205 else if (scsi_sense_valid(&sshdr)) {
1206 if (sshdr.sense_key != UNIT_ATTENTION)
1213 * The device probably does not support a REPORT LUN command
1220 * Get the length from the first four bytes of lun_data.
1222 data = (u8 *) lun_data->scsi_lun;
1223 length = ((data[0] << 24) | (data[1] << 16) |
1224 (data[2] << 8) | (data[3] << 0));
1226 num_luns = (length / sizeof(struct scsi_lun));
1227 if (num_luns > max_scsi_report_luns) {
1228 printk(KERN_WARNING "scsi: On %s only %d (max_scsi_report_luns)"
1229 " of %d luns reported, try increasing"
1230 " max_scsi_report_luns.\n", devname,
1231 max_scsi_report_luns, num_luns);
1232 num_luns = max_scsi_report_luns;
1235 SCSI_LOG_SCAN_BUS(3, sdev_printk (KERN_INFO, sdev,
1236 "scsi scan: REPORT LUN scan\n"));
1239 * Scan the luns in lun_data. The entry at offset 0 is really
1240 * the header, so start at 1 and go up to and including num_luns.
1242 for (lunp = &lun_data[1]; lunp <= &lun_data[num_luns]; lunp++) {
1243 lun = scsilun_to_int(lunp);
1246 * Check if the unused part of lunp is non-zero, and so
1247 * does not fit in lun.
1249 if (memcmp(&lunp->scsi_lun[sizeof(lun)], "\0\0\0\0", 4)) {
1253 * Output an error displaying the LUN in byte order,
1254 * this differs from what linux would print for the
1255 * integer LUN value.
1257 printk(KERN_WARNING "scsi: %s lun 0x", devname);
1258 data = (char *)lunp->scsi_lun;
1259 for (i = 0; i < sizeof(struct scsi_lun); i++)
1260 printk("%02x", data[i]);
1261 printk(" has a LUN larger than currently supported.\n");
1262 } else if (lun > sdev->host->max_lun) {
1263 printk(KERN_WARNING "scsi: %s lun%d has a LUN larger"
1264 " than allowed by the host adapter\n",
1269 res = scsi_probe_and_add_lun(starget,
1270 lun, NULL, NULL, rescan, NULL);
1271 if (res == SCSI_SCAN_NO_RESPONSE) {
1273 * Got some results, but now none, abort.
1275 sdev_printk(KERN_ERR, sdev,
1276 "Unexpected response"
1277 " from lun %d while scanning, scan"
1287 scsi_device_put(sdev);
1288 if (sdev->sdev_state == SDEV_CREATED)
1290 * the sdev we used didn't appear in the report luns scan
1292 scsi_destroy_sdev(sdev);
1296 struct scsi_device *__scsi_add_device(struct Scsi_Host *shost, uint channel,
1297 uint id, uint lun, void *hostdata)
1299 struct scsi_device *sdev = ERR_PTR(-ENODEV);
1300 struct device *parent = &shost->shost_gendev;
1301 struct scsi_target *starget;
1303 starget = scsi_alloc_target(parent, channel, id);
1305 return ERR_PTR(-ENOMEM);
1307 get_device(&starget->dev);
1308 mutex_lock(&shost->scan_mutex);
1309 if (scsi_host_scan_allowed(shost))
1310 scsi_probe_and_add_lun(starget, lun, NULL, &sdev, 1, hostdata);
1311 mutex_unlock(&shost->scan_mutex);
1312 scsi_target_reap(starget);
1313 put_device(&starget->dev);
1317 EXPORT_SYMBOL(__scsi_add_device);
1319 int scsi_add_device(struct Scsi_Host *host, uint channel,
1320 uint target, uint lun)
1322 struct scsi_device *sdev =
1323 __scsi_add_device(host, channel, target, lun, NULL);
1325 return PTR_ERR(sdev);
1327 scsi_device_put(sdev);
1330 EXPORT_SYMBOL(scsi_add_device);
1332 void scsi_rescan_device(struct device *dev)
1334 struct scsi_driver *drv;
1339 drv = to_scsi_driver(dev->driver);
1340 if (try_module_get(drv->owner)) {
1343 module_put(drv->owner);
1346 EXPORT_SYMBOL(scsi_rescan_device);
1348 static void __scsi_scan_target(struct device *parent, unsigned int channel,
1349 unsigned int id, unsigned int lun, int rescan)
1351 struct Scsi_Host *shost = dev_to_shost(parent);
1354 struct scsi_target *starget;
1356 if (shost->this_id == id)
1358 * Don't scan the host adapter
1362 starget = scsi_alloc_target(parent, channel, id);
1366 get_device(&starget->dev);
1367 if (lun != SCAN_WILD_CARD) {
1369 * Scan for a specific host/chan/id/lun.
1371 scsi_probe_and_add_lun(starget, lun, NULL, NULL, rescan, NULL);
1376 * Scan LUN 0, if there is some response, scan further. Ideally, we
1377 * would not configure LUN 0 until all LUNs are scanned.
1379 res = scsi_probe_and_add_lun(starget, 0, &bflags, NULL, rescan, NULL);
1380 if (res == SCSI_SCAN_LUN_PRESENT || res == SCSI_SCAN_TARGET_PRESENT) {
1381 if (scsi_report_lun_scan(starget, bflags, rescan) != 0)
1383 * The REPORT LUN did not scan the target,
1384 * do a sequential scan.
1386 scsi_sequential_lun_scan(starget, bflags,
1387 res, starget->scsi_level, rescan);
1391 /* now determine if the target has any children at all
1392 * and if not, nuke it */
1393 scsi_target_reap(starget);
1395 put_device(&starget->dev);
1399 * scsi_scan_target - scan a target id, possibly including all LUNs on the
1401 * @parent: host to scan
1402 * @channel: channel to scan
1403 * @id: target id to scan
1404 * @lun: Specific LUN to scan or SCAN_WILD_CARD
1405 * @rescan: passed to LUN scanning routines
1408 * Scan the target id on @parent, @channel, and @id. Scan at least LUN 0,
1409 * and possibly all LUNs on the target id.
1411 * First try a REPORT LUN scan, if that does not scan the target, do a
1412 * sequential scan of LUNs on the target id.
1414 void scsi_scan_target(struct device *parent, unsigned int channel,
1415 unsigned int id, unsigned int lun, int rescan)
1417 struct Scsi_Host *shost = dev_to_shost(parent);
1419 mutex_lock(&shost->scan_mutex);
1420 if (scsi_host_scan_allowed(shost))
1421 __scsi_scan_target(parent, channel, id, lun, rescan);
1422 mutex_unlock(&shost->scan_mutex);
1424 EXPORT_SYMBOL(scsi_scan_target);
1426 static void scsi_scan_channel(struct Scsi_Host *shost, unsigned int channel,
1427 unsigned int id, unsigned int lun, int rescan)
1431 if (id == SCAN_WILD_CARD)
1432 for (id = 0; id < shost->max_id; ++id) {
1434 * XXX adapter drivers when possible (FCP, iSCSI)
1435 * could modify max_id to match the current max,
1436 * not the absolute max.
1438 * XXX add a shost id iterator, so for example,
1439 * the FC ID can be the same as a target id
1440 * without a huge overhead of sparse id's.
1442 if (shost->reverse_ordering)
1444 * Scan from high to low id.
1446 order_id = shost->max_id - id - 1;
1449 __scsi_scan_target(&shost->shost_gendev, channel,
1450 order_id, lun, rescan);
1453 __scsi_scan_target(&shost->shost_gendev, channel,
1457 int scsi_scan_host_selected(struct Scsi_Host *shost, unsigned int channel,
1458 unsigned int id, unsigned int lun, int rescan)
1460 SCSI_LOG_SCAN_BUS(3, shost_printk (KERN_INFO, shost,
1462 __FUNCTION__, channel, id, lun));
1464 if (((channel != SCAN_WILD_CARD) && (channel > shost->max_channel)) ||
1465 ((id != SCAN_WILD_CARD) && (id > shost->max_id)) ||
1466 ((lun != SCAN_WILD_CARD) && (lun > shost->max_lun)))
1469 mutex_lock(&shost->scan_mutex);
1470 if (scsi_host_scan_allowed(shost)) {
1471 if (channel == SCAN_WILD_CARD)
1472 for (channel = 0; channel <= shost->max_channel;
1474 scsi_scan_channel(shost, channel, id, lun,
1477 scsi_scan_channel(shost, channel, id, lun, rescan);
1479 mutex_unlock(&shost->scan_mutex);
1485 * scsi_scan_host - scan the given adapter
1486 * @shost: adapter to scan
1488 void scsi_scan_host(struct Scsi_Host *shost)
1490 scsi_scan_host_selected(shost, SCAN_WILD_CARD, SCAN_WILD_CARD,
1493 EXPORT_SYMBOL(scsi_scan_host);
1495 void scsi_forget_host(struct Scsi_Host *shost)
1497 struct scsi_device *sdev;
1498 unsigned long flags;
1501 spin_lock_irqsave(shost->host_lock, flags);
1502 list_for_each_entry(sdev, &shost->__devices, siblings) {
1503 if (sdev->sdev_state == SDEV_DEL)
1505 spin_unlock_irqrestore(shost->host_lock, flags);
1506 __scsi_remove_device(sdev);
1509 spin_unlock_irqrestore(shost->host_lock, flags);
1513 * Function: scsi_get_host_dev()
1515 * Purpose: Create a scsi_device that points to the host adapter itself.
1517 * Arguments: SHpnt - Host that needs a scsi_device
1519 * Lock status: None assumed.
1521 * Returns: The scsi_device or NULL
1524 * Attach a single scsi_device to the Scsi_Host - this should
1525 * be made to look like a "pseudo-device" that points to the
1528 * Note - this device is not accessible from any high-level
1529 * drivers (including generics), which is probably not
1530 * optimal. We can add hooks later to attach
1532 struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost)
1534 struct scsi_device *sdev = NULL;
1535 struct scsi_target *starget;
1537 mutex_lock(&shost->scan_mutex);
1538 if (!scsi_host_scan_allowed(shost))
1540 starget = scsi_alloc_target(&shost->shost_gendev, 0, shost->this_id);
1544 sdev = scsi_alloc_sdev(starget, 0, NULL);
1546 sdev->sdev_gendev.parent = get_device(&starget->dev);
1549 put_device(&starget->dev);
1551 mutex_unlock(&shost->scan_mutex);
1554 EXPORT_SYMBOL(scsi_get_host_dev);
1557 * Function: scsi_free_host_dev()
1559 * Purpose: Free a scsi_device that points to the host adapter itself.
1561 * Arguments: SHpnt - Host that needs a scsi_device
1563 * Lock status: None assumed.
1569 void scsi_free_host_dev(struct scsi_device *sdev)
1571 BUG_ON(sdev->id != sdev->host->this_id);
1573 scsi_destroy_sdev(sdev);
1575 EXPORT_SYMBOL(scsi_free_host_dev);