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 <linux/async.h>
59 #include <asm/unaligned.h>
61 #include <scsi/scsi.h>
62 #include <scsi/scsi_cmnd.h>
63 #include <scsi/scsi_dbg.h>
64 #include <scsi/scsi_device.h>
65 #include <scsi/scsi_driver.h>
66 #include <scsi/scsi_eh.h>
67 #include <scsi/scsi_host.h>
68 #include <scsi/scsi_tcq.h>
70 #include "scsi_priv.h"
71 #include "scsi_logging.h"
73 #define CREATE_TRACE_POINTS
74 #include <trace/events/scsi.h>
77 * Definitions and constants.
81 * Note - the initial logging level can be set here to log events at boot time.
82 * After the system is up, you may enable logging via the /proc interface.
84 unsigned int scsi_logging_level;
85 #if defined(CONFIG_SCSI_LOGGING)
86 EXPORT_SYMBOL(scsi_logging_level);
89 #ifdef CONFIG_SCSI_LOGGING
90 void scsi_log_send(struct scsi_cmnd *cmd)
95 * If ML QUEUE log level is greater than or equal to:
97 * 1: nothing (match completion)
99 * 2: log opcode + command of all commands + cmd address
105 if (unlikely(scsi_logging_level)) {
106 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
107 SCSI_LOG_MLQUEUE_BITS);
109 scmd_printk(KERN_INFO, cmd,
110 "Send: scmd 0x%p\n", cmd);
111 scsi_print_command(cmd);
116 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
121 * If ML COMPLETE log level is greater than or equal to:
123 * 1: log disposition, result, opcode + command, and conditionally
124 * sense data for failures or non SUCCESS dispositions.
126 * 2: same as 1 but for all command completions.
130 * 4: same as 3 plus dump extra junk
132 if (unlikely(scsi_logging_level)) {
133 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
134 SCSI_LOG_MLCOMPLETE_BITS);
135 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
137 scsi_print_result(cmd, "Done", disposition);
138 scsi_print_command(cmd);
139 if (scsi_status_is_check_condition(cmd->result))
140 scsi_print_sense(cmd);
142 scmd_printk(KERN_INFO, cmd,
143 "scsi host busy %d failed %d\n",
144 scsi_host_busy(cmd->device->host),
145 cmd->device->host->host_failed);
152 * scsi_finish_command - cleanup and pass command back to upper layer
155 * Description: Pass command off to upper layer for finishing of I/O
156 * request, waking processes that are waiting on results,
159 void scsi_finish_command(struct scsi_cmnd *cmd)
161 struct scsi_device *sdev = cmd->device;
162 struct scsi_target *starget = scsi_target(sdev);
163 struct Scsi_Host *shost = sdev->host;
164 struct scsi_driver *drv;
165 unsigned int good_bytes;
167 scsi_device_unbusy(sdev, cmd);
170 * Clear the flags that say that the device/target/host is no longer
171 * capable of accepting new commands.
173 if (atomic_read(&shost->host_blocked))
174 atomic_set(&shost->host_blocked, 0);
175 if (atomic_read(&starget->target_blocked))
176 atomic_set(&starget->target_blocked, 0);
177 if (atomic_read(&sdev->device_blocked))
178 atomic_set(&sdev->device_blocked, 0);
180 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
181 "Notifying upper driver of completion "
182 "(result %x)\n", cmd->result));
184 good_bytes = scsi_bufflen(cmd);
185 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
186 int old_good_bytes = good_bytes;
187 drv = scsi_cmd_to_driver(cmd);
189 good_bytes = drv->done(cmd);
191 * USB may not give sense identifying bad sector and
192 * simply return a residue instead, so subtract off the
193 * residue if drv->done() error processing indicates no
194 * change to the completion length.
196 if (good_bytes == old_good_bytes)
197 good_bytes -= scsi_get_resid(cmd);
199 scsi_io_completion(cmd, good_bytes);
204 * 1024 is big enough for saturating the fast scsi LUN now
206 int scsi_device_max_queue_depth(struct scsi_device *sdev)
208 return max_t(int, sdev->host->can_queue, 1024);
212 * scsi_change_queue_depth - change a device's queue depth
213 * @sdev: SCSI Device in question
214 * @depth: number of commands allowed to be queued to the driver
216 * Sets the device queue depth and returns the new value.
218 int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
220 depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
223 sdev->queue_depth = depth;
227 if (sdev->request_queue)
228 blk_set_queue_depth(sdev->request_queue, depth);
230 sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
232 return sdev->queue_depth;
234 EXPORT_SYMBOL(scsi_change_queue_depth);
237 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
238 * @sdev: SCSI Device in question
239 * @depth: Current number of outstanding SCSI commands on this device,
240 * not counting the one returned as QUEUE_FULL.
242 * Description: This function will track successive QUEUE_FULL events on a
243 * specific SCSI device to determine if and when there is a
244 * need to adjust the queue depth on the device.
246 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
247 * -1 - Drop back to untagged operation using host->cmd_per_lun
248 * as the untagged command depth
250 * Lock Status: None held on entry
252 * Notes: Low level drivers may call this at any time and we will do
253 * "The Right Thing." We are interrupt context safe.
255 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
259 * Don't let QUEUE_FULLs on the same
260 * jiffies count, they could all be from
263 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
266 sdev->last_queue_full_time = jiffies;
267 if (sdev->last_queue_full_depth != depth) {
268 sdev->last_queue_full_count = 1;
269 sdev->last_queue_full_depth = depth;
271 sdev->last_queue_full_count++;
274 if (sdev->last_queue_full_count <= 10)
277 return scsi_change_queue_depth(sdev, depth);
279 EXPORT_SYMBOL(scsi_track_queue_full);
282 * scsi_vpd_inquiry - Request a device provide us with a VPD page
283 * @sdev: The device to ask
284 * @buffer: Where to put the result
285 * @page: Which Vital Product Data to return
286 * @len: The length of the buffer
288 * This is an internal helper function. You probably want to use
289 * scsi_get_vpd_page instead.
291 * Returns size of the vpd page on success or a negative error number.
293 static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
294 u8 page, unsigned len)
297 unsigned char cmd[16];
303 cmd[1] = 1; /* EVPD */
307 cmd[5] = 0; /* Control byte */
310 * I'm not convinced we need to try quite this hard to get VPD, but
311 * all the existing users tried this hard.
313 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
314 len, NULL, 30 * HZ, 3, NULL);
318 /* Sanity check that we got the page back that we asked for */
319 if (buffer[1] != page)
322 return get_unaligned_be16(&buffer[2]) + 4;
326 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
327 * @sdev: The device to ask
328 * @page: Which Vital Product Data to return
329 * @buf: where to store the VPD
330 * @buf_len: number of bytes in the VPD buffer area
332 * SCSI devices may optionally supply Vital Product Data. Each 'page'
333 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
334 * If the device supports this VPD page, this routine returns a pointer
335 * to a buffer containing the data from that page. The caller is
336 * responsible for calling kfree() on this pointer when it is no longer
337 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
339 int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
344 if (sdev->skip_vpd_pages)
347 /* Ask for all the pages supported by this device */
348 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
352 /* If the user actually wanted this page, we can skip the rest */
356 for (i = 4; i < min(result, buf_len); i++)
360 if (i < result && i >= buf_len)
361 /* ran off the end of the buffer, give us benefit of doubt */
363 /* The device claims it doesn't support the requested page */
367 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
376 EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
379 * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
380 * @sdev: The device to ask
381 * @page: Which Vital Product Data to return
383 * Returns %NULL upon failure.
385 static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
387 struct scsi_vpd *vpd_buf;
388 int vpd_len = SCSI_VPD_PG_LEN, result;
391 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
395 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
400 if (result > vpd_len) {
406 vpd_buf->len = result;
411 static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
412 struct scsi_vpd __rcu **sdev_vpd_buf)
414 struct scsi_vpd *vpd_buf;
416 vpd_buf = scsi_get_vpd_buf(sdev, page);
420 mutex_lock(&sdev->inquiry_mutex);
421 vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
422 lockdep_is_held(&sdev->inquiry_mutex));
423 mutex_unlock(&sdev->inquiry_mutex);
426 kfree_rcu(vpd_buf, rcu);
430 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
431 * @sdev: The device to ask
433 * Attach the 'Device Identification' VPD page (0x83) and the
434 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
435 * structure. This information can be used to identify the device
438 void scsi_attach_vpd(struct scsi_device *sdev)
441 struct scsi_vpd *vpd_buf;
443 if (!scsi_device_supports_vpd(sdev))
446 /* Ask for all the pages supported by this device */
447 vpd_buf = scsi_get_vpd_buf(sdev, 0);
451 for (i = 4; i < vpd_buf->len; i++) {
452 if (vpd_buf->data[i] == 0x0)
453 scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
454 if (vpd_buf->data[i] == 0x80)
455 scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
456 if (vpd_buf->data[i] == 0x83)
457 scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
458 if (vpd_buf->data[i] == 0x89)
459 scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
465 * scsi_report_opcode - Find out if a given command opcode is supported
466 * @sdev: scsi device to query
467 * @buffer: scratch buffer (must be at least 20 bytes long)
468 * @len: length of buffer
469 * @opcode: opcode for command to look up
471 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
472 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
473 * unsupported and 1 if the device claims to support the command.
475 int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
476 unsigned int len, unsigned char opcode)
478 unsigned char cmd[16];
479 struct scsi_sense_hdr sshdr;
482 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
486 cmd[0] = MAINTENANCE_IN;
487 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
488 cmd[2] = 1; /* One command format */
490 put_unaligned_be32(len, &cmd[6]);
491 memset(buffer, 0, len);
493 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
494 &sshdr, 30 * HZ, 3, NULL);
498 if (result && scsi_sense_valid(&sshdr) &&
499 sshdr.sense_key == ILLEGAL_REQUEST &&
500 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
503 if ((buffer[1] & 3) == 3) /* Command supported */
508 EXPORT_SYMBOL(scsi_report_opcode);
511 * scsi_device_get - get an additional reference to a scsi_device
512 * @sdev: device to get a reference to
514 * Description: Gets a reference to the scsi_device and increments the use count
515 * of the underlying LLDD module. You must hold host_lock of the
516 * parent Scsi_Host or already have a reference when calling this.
518 * This will fail if a device is deleted or cancelled, or when the LLD module
519 * is in the process of being unloaded.
521 int scsi_device_get(struct scsi_device *sdev)
523 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
525 if (!get_device(&sdev->sdev_gendev))
527 if (!try_module_get(sdev->host->hostt->module))
528 goto fail_put_device;
532 put_device(&sdev->sdev_gendev);
536 EXPORT_SYMBOL(scsi_device_get);
539 * scsi_device_put - release a reference to a scsi_device
540 * @sdev: device to release a reference on.
542 * Description: Release a reference to the scsi_device and decrements the use
543 * count of the underlying LLDD module. The device is freed once the last
546 void scsi_device_put(struct scsi_device *sdev)
548 struct module *mod = sdev->host->hostt->module;
550 put_device(&sdev->sdev_gendev);
553 EXPORT_SYMBOL(scsi_device_put);
555 /* helper for shost_for_each_device, see that for documentation */
556 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
557 struct scsi_device *prev)
559 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
560 struct scsi_device *next = NULL;
563 spin_lock_irqsave(shost->host_lock, flags);
564 while (list->next != &shost->__devices) {
565 next = list_entry(list->next, struct scsi_device, siblings);
566 /* skip devices that we can't get a reference to */
567 if (!scsi_device_get(next))
572 spin_unlock_irqrestore(shost->host_lock, flags);
575 scsi_device_put(prev);
578 EXPORT_SYMBOL(__scsi_iterate_devices);
581 * starget_for_each_device - helper to walk all devices of a target
582 * @starget: target whose devices we want to iterate over.
583 * @data: Opaque passed to each function call.
584 * @fn: Function to call on each device
586 * This traverses over each device of @starget. The devices have
587 * a reference that must be released by scsi_host_put when breaking
590 void starget_for_each_device(struct scsi_target *starget, void *data,
591 void (*fn)(struct scsi_device *, void *))
593 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
594 struct scsi_device *sdev;
596 shost_for_each_device(sdev, shost) {
597 if ((sdev->channel == starget->channel) &&
598 (sdev->id == starget->id))
602 EXPORT_SYMBOL(starget_for_each_device);
605 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
606 * @starget: target whose devices we want to iterate over.
607 * @data: parameter for callback @fn()
608 * @fn: callback function that is invoked for each device
610 * This traverses over each device of @starget. It does _not_
611 * take a reference on the scsi_device, so the whole loop must be
612 * protected by shost->host_lock.
614 * Note: The only reason why drivers would want to use this is because
615 * they need to access the device list in irq context. Otherwise you
616 * really want to use starget_for_each_device instead.
618 void __starget_for_each_device(struct scsi_target *starget, void *data,
619 void (*fn)(struct scsi_device *, void *))
621 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
622 struct scsi_device *sdev;
624 __shost_for_each_device(sdev, shost) {
625 if ((sdev->channel == starget->channel) &&
626 (sdev->id == starget->id))
630 EXPORT_SYMBOL(__starget_for_each_device);
633 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
634 * @starget: SCSI target pointer
635 * @lun: SCSI Logical Unit Number
637 * Description: Looks up the scsi_device with the specified @lun for a given
638 * @starget. The returned scsi_device does not have an additional
639 * reference. You must hold the host's host_lock over this call and
640 * any access to the returned scsi_device. A scsi_device in state
641 * SDEV_DEL is skipped.
643 * Note: The only reason why drivers should use this is because
644 * they need to access the device list in irq context. Otherwise you
645 * really want to use scsi_device_lookup_by_target instead.
647 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
650 struct scsi_device *sdev;
652 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
653 if (sdev->sdev_state == SDEV_DEL)
661 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
664 * scsi_device_lookup_by_target - find a device given the target
665 * @starget: SCSI target pointer
666 * @lun: SCSI Logical Unit Number
668 * Description: Looks up the scsi_device with the specified @lun for a given
669 * @starget. The returned scsi_device has an additional reference that
670 * needs to be released with scsi_device_put once you're done with it.
672 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
675 struct scsi_device *sdev;
676 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
679 spin_lock_irqsave(shost->host_lock, flags);
680 sdev = __scsi_device_lookup_by_target(starget, lun);
681 if (sdev && scsi_device_get(sdev))
683 spin_unlock_irqrestore(shost->host_lock, flags);
687 EXPORT_SYMBOL(scsi_device_lookup_by_target);
690 * __scsi_device_lookup - find a device given the host (UNLOCKED)
691 * @shost: SCSI host pointer
692 * @channel: SCSI channel (zero if only one channel)
693 * @id: SCSI target number (physical unit number)
694 * @lun: SCSI Logical Unit Number
696 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
697 * for a given host. The returned scsi_device does not have an additional
698 * reference. You must hold the host's host_lock over this call and any access
699 * to the returned scsi_device.
701 * Note: The only reason why drivers would want to use this is because
702 * they need to access the device list in irq context. Otherwise you
703 * really want to use scsi_device_lookup instead.
705 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
706 uint channel, uint id, u64 lun)
708 struct scsi_device *sdev;
710 list_for_each_entry(sdev, &shost->__devices, siblings) {
711 if (sdev->sdev_state == SDEV_DEL)
713 if (sdev->channel == channel && sdev->id == id &&
720 EXPORT_SYMBOL(__scsi_device_lookup);
723 * scsi_device_lookup - find a device given the host
724 * @shost: SCSI host pointer
725 * @channel: SCSI channel (zero if only one channel)
726 * @id: SCSI target number (physical unit number)
727 * @lun: SCSI Logical Unit Number
729 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
730 * for a given host. The returned scsi_device has an additional reference that
731 * needs to be released with scsi_device_put once you're done with it.
733 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
734 uint channel, uint id, u64 lun)
736 struct scsi_device *sdev;
739 spin_lock_irqsave(shost->host_lock, flags);
740 sdev = __scsi_device_lookup(shost, channel, id, lun);
741 if (sdev && scsi_device_get(sdev))
743 spin_unlock_irqrestore(shost->host_lock, flags);
747 EXPORT_SYMBOL(scsi_device_lookup);
749 MODULE_DESCRIPTION("SCSI core");
750 MODULE_LICENSE("GPL");
752 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
753 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
755 static int __init init_scsi(void)
759 error = scsi_init_procfs();
762 error = scsi_init_devinfo();
765 error = scsi_init_hosts();
767 goto cleanup_devlist;
768 error = scsi_init_sysctl();
771 error = scsi_sysfs_register();
777 printk(KERN_NOTICE "SCSI subsystem initialized\n");
790 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
795 static void __exit exit_scsi(void)
798 scsi_sysfs_unregister();
806 subsys_initcall(init_scsi);
807 module_exit(exit_scsi);