1 // SPDX-License-Identifier: GPL-2.0-only
3 * scsi.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 * Copyright (C) 2002, 2003 Christoph Hellwig
7 * generic mid-level SCSI driver
8 * Initial versions: Drew Eckhardt
9 * Subsequent revisions: Eric Youngdale
13 * Bug correction thanks go to :
15 * Tommy Thorn <tthorn>
19 * add scatter-gather, multiple outstanding request, and other
22 * Native multichannel, wide scsi, /proc/scsi and hot plugging
25 * Added request_module("scsi_hostadapter") for kerneld:
26 * (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
30 * Major improvements to the timeout, abort, and reset processing,
31 * as well as performance modifications for large queue depths by
34 * Converted cli() code to spinlocks, Ingo Molnar
36 * Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
38 * out_of_space hacks, D. Gilbert (dpg) 990608
41 #include <linux/module.h>
42 #include <linux/moduleparam.h>
43 #include <linux/kernel.h>
44 #include <linux/timer.h>
45 #include <linux/string.h>
46 #include <linux/slab.h>
47 #include <linux/blkdev.h>
48 #include <linux/delay.h>
49 #include <linux/init.h>
50 #include <linux/completion.h>
51 #include <linux/unistd.h>
52 #include <linux/spinlock.h>
53 #include <linux/kmod.h>
54 #include <linux/interrupt.h>
55 #include <linux/notifier.h>
56 #include <linux/cpu.h>
57 #include <linux/mutex.h>
58 #include <asm/unaligned.h>
60 #include <scsi/scsi.h>
61 #include <scsi/scsi_cmnd.h>
62 #include <scsi/scsi_dbg.h>
63 #include <scsi/scsi_device.h>
64 #include <scsi/scsi_driver.h>
65 #include <scsi/scsi_eh.h>
66 #include <scsi/scsi_host.h>
67 #include <scsi/scsi_tcq.h>
69 #include "scsi_priv.h"
70 #include "scsi_logging.h"
72 #define CREATE_TRACE_POINTS
73 #include <trace/events/scsi.h>
76 * Definitions and constants.
80 * Note - the initial logging level can be set here to log events at boot time.
81 * After the system is up, you may enable logging via the /proc interface.
83 unsigned int scsi_logging_level;
84 #if defined(CONFIG_SCSI_LOGGING)
85 EXPORT_SYMBOL(scsi_logging_level);
88 #ifdef CONFIG_SCSI_LOGGING
89 void scsi_log_send(struct scsi_cmnd *cmd)
94 * If ML QUEUE log level is greater than or equal to:
96 * 1: nothing (match completion)
98 * 2: log opcode + command of all commands + cmd address
104 if (unlikely(scsi_logging_level)) {
105 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
106 SCSI_LOG_MLQUEUE_BITS);
108 scmd_printk(KERN_INFO, cmd,
109 "Send: scmd 0x%p\n", cmd);
110 scsi_print_command(cmd);
115 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
120 * If ML COMPLETE log level is greater than or equal to:
122 * 1: log disposition, result, opcode + command, and conditionally
123 * sense data for failures or non SUCCESS dispositions.
125 * 2: same as 1 but for all command completions.
129 * 4: same as 3 plus dump extra junk
131 if (unlikely(scsi_logging_level)) {
132 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
133 SCSI_LOG_MLCOMPLETE_BITS);
134 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
136 scsi_print_result(cmd, "Done", disposition);
137 scsi_print_command(cmd);
138 if (scsi_status_is_check_condition(cmd->result))
139 scsi_print_sense(cmd);
141 scmd_printk(KERN_INFO, cmd,
142 "scsi host busy %d failed %d\n",
143 scsi_host_busy(cmd->device->host),
144 cmd->device->host->host_failed);
151 * scsi_finish_command - cleanup and pass command back to upper layer
154 * Description: Pass command off to upper layer for finishing of I/O
155 * request, waking processes that are waiting on results,
158 void scsi_finish_command(struct scsi_cmnd *cmd)
160 struct scsi_device *sdev = cmd->device;
161 struct scsi_target *starget = scsi_target(sdev);
162 struct Scsi_Host *shost = sdev->host;
163 struct scsi_driver *drv;
164 unsigned int good_bytes;
166 scsi_device_unbusy(sdev, cmd);
169 * Clear the flags that say that the device/target/host is no longer
170 * capable of accepting new commands.
172 if (atomic_read(&shost->host_blocked))
173 atomic_set(&shost->host_blocked, 0);
174 if (atomic_read(&starget->target_blocked))
175 atomic_set(&starget->target_blocked, 0);
176 if (atomic_read(&sdev->device_blocked))
177 atomic_set(&sdev->device_blocked, 0);
179 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
180 "Notifying upper driver of completion "
181 "(result %x)\n", cmd->result));
183 good_bytes = scsi_bufflen(cmd);
184 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
185 int old_good_bytes = good_bytes;
186 drv = scsi_cmd_to_driver(cmd);
188 good_bytes = drv->done(cmd);
190 * USB may not give sense identifying bad sector and
191 * simply return a residue instead, so subtract off the
192 * residue if drv->done() error processing indicates no
193 * change to the completion length.
195 if (good_bytes == old_good_bytes)
196 good_bytes -= scsi_get_resid(cmd);
198 scsi_io_completion(cmd, good_bytes);
203 * 4096 is big enough for saturating fast SCSI LUNs.
205 int scsi_device_max_queue_depth(struct scsi_device *sdev)
207 return min_t(int, sdev->host->can_queue, 4096);
211 * scsi_change_queue_depth - change a device's queue depth
212 * @sdev: SCSI Device in question
213 * @depth: number of commands allowed to be queued to the driver
215 * Sets the device queue depth and returns the new value.
217 int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
219 depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
222 sdev->queue_depth = depth;
226 if (sdev->request_queue)
227 blk_set_queue_depth(sdev->request_queue, depth);
229 sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
231 return sdev->queue_depth;
233 EXPORT_SYMBOL(scsi_change_queue_depth);
236 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
237 * @sdev: SCSI Device in question
238 * @depth: Current number of outstanding SCSI commands on this device,
239 * not counting the one returned as QUEUE_FULL.
241 * Description: This function will track successive QUEUE_FULL events on a
242 * specific SCSI device to determine if and when there is a
243 * need to adjust the queue depth on the device.
245 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
246 * -1 - Drop back to untagged operation using host->cmd_per_lun
247 * as the untagged command depth
249 * Lock Status: None held on entry
251 * Notes: Low level drivers may call this at any time and we will do
252 * "The Right Thing." We are interrupt context safe.
254 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
258 * Don't let QUEUE_FULLs on the same
259 * jiffies count, they could all be from
262 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
265 sdev->last_queue_full_time = jiffies;
266 if (sdev->last_queue_full_depth != depth) {
267 sdev->last_queue_full_count = 1;
268 sdev->last_queue_full_depth = depth;
270 sdev->last_queue_full_count++;
273 if (sdev->last_queue_full_count <= 10)
276 return scsi_change_queue_depth(sdev, depth);
278 EXPORT_SYMBOL(scsi_track_queue_full);
281 * scsi_vpd_inquiry - Request a device provide us with a VPD page
282 * @sdev: The device to ask
283 * @buffer: Where to put the result
284 * @page: Which Vital Product Data to return
285 * @len: The length of the buffer
287 * This is an internal helper function. You probably want to use
288 * scsi_get_vpd_page instead.
290 * Returns size of the vpd page on success or a negative error number.
292 static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
293 u8 page, unsigned len)
296 unsigned char cmd[16];
302 cmd[1] = 1; /* EVPD */
306 cmd[5] = 0; /* Control byte */
309 * I'm not convinced we need to try quite this hard to get VPD, but
310 * all the existing users tried this hard.
312 result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buffer, len,
317 /* Sanity check that we got the page back that we asked for */
318 if (buffer[1] != page)
321 return get_unaligned_be16(&buffer[2]) + 4;
324 static int scsi_get_vpd_size(struct scsi_device *sdev, u8 page)
326 unsigned char vpd_header[SCSI_VPD_HEADER_SIZE] __aligned(4);
330 * Fetch the VPD page header to find out how big the page
331 * is. This is done to prevent problems on legacy devices
332 * which can not handle allocation lengths as large as
333 * potentially requested by the caller.
335 result = scsi_vpd_inquiry(sdev, vpd_header, page, sizeof(vpd_header));
339 if (result < SCSI_VPD_HEADER_SIZE) {
340 dev_warn_once(&sdev->sdev_gendev,
341 "%s: short VPD page 0x%02x length: %d bytes\n",
342 __func__, page, result);
350 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
351 * @sdev: The device to ask
352 * @page: Which Vital Product Data to return
353 * @buf: where to store the VPD
354 * @buf_len: number of bytes in the VPD buffer area
356 * SCSI devices may optionally supply Vital Product Data. Each 'page'
357 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
358 * If the device supports this VPD page, this routine fills @buf
359 * with the data from that page and return 0. If the VPD page is not
360 * supported or its content cannot be retrieved, -EINVAL is returned.
362 int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
367 if (!scsi_device_supports_vpd(sdev))
370 vpd_len = scsi_get_vpd_size(sdev, page);
374 vpd_len = min(vpd_len, buf_len);
377 * Fetch the actual page. Since the appropriate size was reported
378 * by the device it is now safe to ask for something bigger.
380 memset(buf, 0, buf_len);
381 result = scsi_vpd_inquiry(sdev, buf, page, vpd_len);
384 else if (result > vpd_len)
385 dev_warn_once(&sdev->sdev_gendev,
386 "%s: VPD page 0x%02x result %d > %d bytes\n",
387 __func__, page, result, vpd_len);
391 EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
394 * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
395 * @sdev: The device to ask
396 * @page: Which Vital Product Data to return
398 * Returns %NULL upon failure.
400 static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
402 struct scsi_vpd *vpd_buf;
405 vpd_len = scsi_get_vpd_size(sdev, page);
411 * Fetch the actual page. Since the appropriate size was reported
412 * by the device it is now safe to ask for something bigger.
414 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
418 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
423 if (result > vpd_len) {
424 dev_warn_once(&sdev->sdev_gendev,
425 "%s: VPD page 0x%02x result %d > %d bytes\n",
426 __func__, page, result, vpd_len);
432 vpd_buf->len = result;
437 static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
438 struct scsi_vpd __rcu **sdev_vpd_buf)
440 struct scsi_vpd *vpd_buf;
442 vpd_buf = scsi_get_vpd_buf(sdev, page);
446 mutex_lock(&sdev->inquiry_mutex);
447 vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
448 lockdep_is_held(&sdev->inquiry_mutex));
449 mutex_unlock(&sdev->inquiry_mutex);
452 kfree_rcu(vpd_buf, rcu);
456 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
457 * @sdev: The device to ask
459 * Attach the 'Device Identification' VPD page (0x83) and the
460 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
461 * structure. This information can be used to identify the device
464 void scsi_attach_vpd(struct scsi_device *sdev)
467 struct scsi_vpd *vpd_buf;
469 if (!scsi_device_supports_vpd(sdev))
472 /* Ask for all the pages supported by this device */
473 vpd_buf = scsi_get_vpd_buf(sdev, 0);
477 for (i = 4; i < vpd_buf->len; i++) {
478 if (vpd_buf->data[i] == 0x0)
479 scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
480 if (vpd_buf->data[i] == 0x80)
481 scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
482 if (vpd_buf->data[i] == 0x83)
483 scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
484 if (vpd_buf->data[i] == 0x89)
485 scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
486 if (vpd_buf->data[i] == 0xb0)
487 scsi_update_vpd_page(sdev, 0xb0, &sdev->vpd_pgb0);
488 if (vpd_buf->data[i] == 0xb1)
489 scsi_update_vpd_page(sdev, 0xb1, &sdev->vpd_pgb1);
490 if (vpd_buf->data[i] == 0xb2)
491 scsi_update_vpd_page(sdev, 0xb2, &sdev->vpd_pgb2);
497 * scsi_report_opcode - Find out if a given command opcode is supported
498 * @sdev: scsi device to query
499 * @buffer: scratch buffer (must be at least 20 bytes long)
500 * @len: length of buffer
501 * @opcode: opcode for command to look up
503 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
504 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
505 * unsupported and 1 if the device claims to support the command.
507 int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
508 unsigned int len, unsigned char opcode)
510 unsigned char cmd[16];
511 struct scsi_sense_hdr sshdr;
512 int result, request_len;
513 const struct scsi_exec_args exec_args = {
517 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
520 /* RSOC header + size of command we are asking about */
521 request_len = 4 + COMMAND_SIZE(opcode);
522 if (request_len > len) {
523 dev_warn_once(&sdev->sdev_gendev,
524 "%s: len %u bytes, opcode 0x%02x needs %u\n",
525 __func__, len, opcode, request_len);
530 cmd[0] = MAINTENANCE_IN;
531 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
532 cmd[2] = 1; /* One command format */
534 put_unaligned_be32(request_len, &cmd[6]);
535 memset(buffer, 0, len);
537 result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buffer,
538 request_len, 30 * HZ, 3, &exec_args);
541 if (result && scsi_sense_valid(&sshdr) &&
542 sshdr.sense_key == ILLEGAL_REQUEST &&
543 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
546 if ((buffer[1] & 3) == 3) /* Command supported */
551 EXPORT_SYMBOL(scsi_report_opcode);
554 * scsi_device_get - get an additional reference to a scsi_device
555 * @sdev: device to get a reference to
557 * Description: Gets a reference to the scsi_device and increments the use count
558 * of the underlying LLDD module. You must hold host_lock of the
559 * parent Scsi_Host or already have a reference when calling this.
561 * This will fail if a device is deleted or cancelled, or when the LLD module
562 * is in the process of being unloaded.
564 int scsi_device_get(struct scsi_device *sdev)
566 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
568 if (!try_module_get(sdev->host->hostt->module))
570 if (!get_device(&sdev->sdev_gendev))
571 goto fail_put_module;
575 module_put(sdev->host->hostt->module);
579 EXPORT_SYMBOL(scsi_device_get);
582 * scsi_device_put - release a reference to a scsi_device
583 * @sdev: device to release a reference on.
585 * Description: Release a reference to the scsi_device and decrements the use
586 * count of the underlying LLDD module. The device is freed once the last
589 void scsi_device_put(struct scsi_device *sdev)
591 struct module *mod = sdev->host->hostt->module;
595 put_device(&sdev->sdev_gendev);
598 EXPORT_SYMBOL(scsi_device_put);
600 /* helper for shost_for_each_device, see that for documentation */
601 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
602 struct scsi_device *prev)
604 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
605 struct scsi_device *next = NULL;
608 spin_lock_irqsave(shost->host_lock, flags);
609 while (list->next != &shost->__devices) {
610 next = list_entry(list->next, struct scsi_device, siblings);
611 /* skip devices that we can't get a reference to */
612 if (!scsi_device_get(next))
617 spin_unlock_irqrestore(shost->host_lock, flags);
620 scsi_device_put(prev);
623 EXPORT_SYMBOL(__scsi_iterate_devices);
626 * starget_for_each_device - helper to walk all devices of a target
627 * @starget: target whose devices we want to iterate over.
628 * @data: Opaque passed to each function call.
629 * @fn: Function to call on each device
631 * This traverses over each device of @starget. The devices have
632 * a reference that must be released by scsi_host_put when breaking
635 void starget_for_each_device(struct scsi_target *starget, void *data,
636 void (*fn)(struct scsi_device *, void *))
638 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
639 struct scsi_device *sdev;
641 shost_for_each_device(sdev, shost) {
642 if ((sdev->channel == starget->channel) &&
643 (sdev->id == starget->id))
647 EXPORT_SYMBOL(starget_for_each_device);
650 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
651 * @starget: target whose devices we want to iterate over.
652 * @data: parameter for callback @fn()
653 * @fn: callback function that is invoked for each device
655 * This traverses over each device of @starget. It does _not_
656 * take a reference on the scsi_device, so the whole loop must be
657 * protected by shost->host_lock.
659 * Note: The only reason why drivers would want to use this is because
660 * they need to access the device list in irq context. Otherwise you
661 * really want to use starget_for_each_device instead.
663 void __starget_for_each_device(struct scsi_target *starget, void *data,
664 void (*fn)(struct scsi_device *, void *))
666 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
667 struct scsi_device *sdev;
669 __shost_for_each_device(sdev, shost) {
670 if ((sdev->channel == starget->channel) &&
671 (sdev->id == starget->id))
675 EXPORT_SYMBOL(__starget_for_each_device);
678 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
679 * @starget: SCSI target pointer
680 * @lun: SCSI Logical Unit Number
682 * Description: Looks up the scsi_device with the specified @lun for a given
683 * @starget. The returned scsi_device does not have an additional
684 * reference. You must hold the host's host_lock over this call and
685 * any access to the returned scsi_device. A scsi_device in state
686 * SDEV_DEL is skipped.
688 * Note: The only reason why drivers should use this is because
689 * they need to access the device list in irq context. Otherwise you
690 * really want to use scsi_device_lookup_by_target instead.
692 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
695 struct scsi_device *sdev;
697 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
698 if (sdev->sdev_state == SDEV_DEL)
706 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
709 * scsi_device_lookup_by_target - find a device given the target
710 * @starget: SCSI target pointer
711 * @lun: SCSI Logical Unit Number
713 * Description: Looks up the scsi_device with the specified @lun for a given
714 * @starget. The returned scsi_device has an additional reference that
715 * needs to be released with scsi_device_put once you're done with it.
717 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
720 struct scsi_device *sdev;
721 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
724 spin_lock_irqsave(shost->host_lock, flags);
725 sdev = __scsi_device_lookup_by_target(starget, lun);
726 if (sdev && scsi_device_get(sdev))
728 spin_unlock_irqrestore(shost->host_lock, flags);
732 EXPORT_SYMBOL(scsi_device_lookup_by_target);
735 * __scsi_device_lookup - find a device given the host (UNLOCKED)
736 * @shost: SCSI host pointer
737 * @channel: SCSI channel (zero if only one channel)
738 * @id: SCSI target number (physical unit number)
739 * @lun: SCSI Logical Unit Number
741 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
742 * for a given host. The returned scsi_device does not have an additional
743 * reference. You must hold the host's host_lock over this call and any access
744 * to the returned scsi_device.
746 * Note: The only reason why drivers would want to use this is because
747 * they need to access the device list in irq context. Otherwise you
748 * really want to use scsi_device_lookup instead.
750 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
751 uint channel, uint id, u64 lun)
753 struct scsi_device *sdev;
755 list_for_each_entry(sdev, &shost->__devices, siblings) {
756 if (sdev->sdev_state == SDEV_DEL)
758 if (sdev->channel == channel && sdev->id == id &&
765 EXPORT_SYMBOL(__scsi_device_lookup);
768 * scsi_device_lookup - find a device given the host
769 * @shost: SCSI host pointer
770 * @channel: SCSI channel (zero if only one channel)
771 * @id: SCSI target number (physical unit number)
772 * @lun: SCSI Logical Unit Number
774 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
775 * for a given host. The returned scsi_device has an additional reference that
776 * needs to be released with scsi_device_put once you're done with it.
778 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
779 uint channel, uint id, u64 lun)
781 struct scsi_device *sdev;
784 spin_lock_irqsave(shost->host_lock, flags);
785 sdev = __scsi_device_lookup(shost, channel, id, lun);
786 if (sdev && scsi_device_get(sdev))
788 spin_unlock_irqrestore(shost->host_lock, flags);
792 EXPORT_SYMBOL(scsi_device_lookup);
794 MODULE_DESCRIPTION("SCSI core");
795 MODULE_LICENSE("GPL");
797 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
798 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
800 static int __init init_scsi(void)
804 error = scsi_init_procfs();
807 error = scsi_init_devinfo();
810 error = scsi_init_hosts();
812 goto cleanup_devlist;
813 error = scsi_init_sysctl();
816 error = scsi_sysfs_register();
822 printk(KERN_NOTICE "SCSI subsystem initialized\n");
835 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
840 static void __exit exit_scsi(void)
843 scsi_sysfs_unregister();
851 subsys_initcall(init_scsi);
852 module_exit(exit_scsi);