blob: 8128165a46fab658532e0b100e852939dad20555 [file] [log] [blame]
Christoph Hellwig026104b2019-05-01 12:13:54 -04001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * scsi.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
5 * Copyright (C) 2002, 2003 Christoph Hellwig
6 *
7 * generic mid-level SCSI driver
8 * Initial versions: Drew Eckhardt
9 * Subsequent revisions: Eric Youngdale
10 *
11 * <drew@colorado.edu>
12 *
13 * Bug correction thanks go to :
14 * Rik Faith <faith@cs.unc.edu>
15 * Tommy Thorn <tthorn>
16 * Thomas Wuensche <tw@fgb1.fgb.mw.tu-muenchen.de>
17 *
18 * Modified by Eric Youngdale eric@andante.org or ericy@gnu.ai.mit.edu to
19 * add scatter-gather, multiple outstanding request, and other
20 * enhancements.
21 *
22 * Native multichannel, wide scsi, /proc/scsi and hot plugging
23 * support added by Michael Neuffer <mike@i-connect.net>
24 *
25 * Added request_module("scsi_hostadapter") for kerneld:
26 * (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
27 * Bjorn Ekwall <bj0rn@blox.se>
28 * (changed to kmod)
29 *
30 * Major improvements to the timeout, abort, and reset processing,
31 * as well as performance modifications for large queue depths by
32 * Leonard N. Zubkoff <lnz@dandelion.com>
33 *
34 * Converted cli() code to spinlocks, Ingo Molnar
35 *
36 * Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
37 *
38 * out_of_space hacks, D. Gilbert (dpg) 990608
39 */
40
41#include <linux/module.h>
42#include <linux/moduleparam.h>
43#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#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>
Arjan van de Ven0b950672006-01-11 13:16:10 +010057#include <linux/mutex.h>
Dan Williams2955b472012-07-09 19:33:25 -070058#include <linux/async.h>
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -040059#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#include <scsi/scsi.h>
62#include <scsi/scsi_cmnd.h>
63#include <scsi/scsi_dbg.h>
64#include <scsi/scsi_device.h>
Linus Torvalds7b3d9542008-01-06 10:17:12 -080065#include <scsi/scsi_driver.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#include <scsi/scsi_eh.h>
67#include <scsi/scsi_host.h>
68#include <scsi/scsi_tcq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70#include "scsi_priv.h"
71#include "scsi_logging.h"
72
Kei Tokunagabf816232010-04-01 20:41:40 +090073#define CREATE_TRACE_POINTS
74#include <trace/events/scsi.h>
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/*
77 * Definitions and constants.
78 */
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * 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.
83 */
84unsigned int scsi_logging_level;
85#if defined(CONFIG_SCSI_LOGGING)
86EXPORT_SYMBOL(scsi_logging_level);
87#endif
88
Dan Williams3c31b522014-04-10 15:30:35 -070089/*
Bart Van Asschef049cf12019-04-30 14:39:18 -070090 * Domain for asynchronous system resume operations. It is marked 'exclusive'
91 * to avoid being included in the async_synchronize_full() that is invoked by
92 * dpm_resume().
Dan Williams3c31b522014-04-10 15:30:35 -070093 */
94ASYNC_DOMAIN_EXCLUSIVE(scsi_sd_pm_domain);
95EXPORT_SYMBOL(scsi_sd_pm_domain);
96
Rob Landleyeb448202007-11-03 13:30:39 -050097/**
98 * scsi_put_command - Free a scsi command block
99 * @cmd: command block to free
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
101 * Returns: Nothing.
102 *
103 * Notes: The command must not belong to any lists.
104 */
105void scsi_put_command(struct scsi_cmnd *cmd)
106{
Bart Van Assche2dd6fb52017-06-02 14:21:58 -0700107 scsi_del_cmd_from_list(cmd);
Bart Van Asschefcc95a72014-06-02 11:50:52 +0200108 BUG_ON(delayed_work_pending(&cmd->abort_work));
FUJITA Tomonoride25deb2008-01-16 13:32:17 +0900109}
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#ifdef CONFIG_SCSI_LOGGING
112void scsi_log_send(struct scsi_cmnd *cmd)
113{
114 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116 /*
117 * If ML QUEUE log level is greater than or equal to:
118 *
119 * 1: nothing (match completion)
120 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200121 * 2: log opcode + command of all commands + cmd address
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200123 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 *
Hannes Reineckea4a6afb2015-01-08 07:43:49 +0100125 * 4: same as 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 */
127 if (unlikely(scsi_logging_level)) {
128 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
129 SCSI_LOG_MLQUEUE_BITS);
130 if (level > 1) {
Hannes Reineckec11c0042014-10-24 14:27:01 +0200131 scmd_printk(KERN_INFO, cmd,
132 "Send: scmd 0x%p\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 scsi_print_command(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 }
135 }
136}
137
138void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
139{
140 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 /*
143 * If ML COMPLETE log level is greater than or equal to:
144 *
145 * 1: log disposition, result, opcode + command, and conditionally
146 * sense data for failures or non SUCCESS dispositions.
147 *
148 * 2: same as 1 but for all command completions.
149 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200150 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 *
152 * 4: same as 3 plus dump extra junk
153 */
154 if (unlikely(scsi_logging_level)) {
155 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
156 SCSI_LOG_MLCOMPLETE_BITS);
157 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
158 (level > 1)) {
Hannes Reinecke026f8da2015-01-08 07:43:47 +0100159 scsi_print_result(cmd, "Done", disposition);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 scsi_print_command(cmd);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200161 if (status_byte(cmd->result) == CHECK_CONDITION)
Hannes Reinecked811b842014-10-24 14:26:45 +0200162 scsi_print_sense(cmd);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500163 if (level > 3)
164 scmd_printk(KERN_INFO, cmd,
165 "scsi host busy %d failed %d\n",
Ming Leic84b0232018-06-24 22:03:26 +0800166 scsi_host_busy(cmd->device->host),
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500167 cmd->device->host->host_failed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 }
169 }
170}
171#endif
172
Rob Landleyeb448202007-11-03 13:30:39 -0500173/**
Rob Landleyeb448202007-11-03 13:30:39 -0500174 * scsi_finish_command - cleanup and pass command back to upper layer
175 * @cmd: the command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 *
Rob Landleyeb448202007-11-03 13:30:39 -0500177 * Description: Pass command off to upper layer for finishing of I/O
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * request, waking processes that are waiting on results,
179 * etc.
180 */
181void scsi_finish_command(struct scsi_cmnd *cmd)
182{
183 struct scsi_device *sdev = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500184 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 struct Scsi_Host *shost = sdev->host;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800186 struct scsi_driver *drv;
187 unsigned int good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
189 scsi_device_unbusy(sdev);
190
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100191 /*
192 * Clear the flags that say that the device/target/host is no longer
193 * capable of accepting new commands.
194 */
195 if (atomic_read(&shost->host_blocked))
196 atomic_set(&shost->host_blocked, 0);
197 if (atomic_read(&starget->target_blocked))
198 atomic_set(&starget->target_blocked, 0);
199 if (atomic_read(&sdev->device_blocked))
200 atomic_set(&sdev->device_blocked, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202 /*
203 * If we have valid sense information, then some kind of recovery
204 * must have taken place. Make a note of this.
205 */
206 if (SCSI_SENSE_VALID(cmd))
207 cmd->result |= (DRIVER_SENSE << 24);
208
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400209 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
210 "Notifying upper driver of completion "
211 "(result %x)\n", cmd->result));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
FUJITA Tomonorif18573a2008-04-11 12:56:52 +0200213 good_bytes = scsi_bufflen(cmd);
Jianchao Wang8ef7fe42018-02-26 15:59:16 +0800214 if (!blk_rq_is_passthrough(cmd->request)) {
James Bottomley427e59f2008-03-08 18:24:17 -0600215 int old_good_bytes = good_bytes;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800216 drv = scsi_cmd_to_driver(cmd);
217 if (drv->done)
218 good_bytes = drv->done(cmd);
James Bottomley427e59f2008-03-08 18:24:17 -0600219 /*
220 * USB may not give sense identifying bad sector and
221 * simply return a residue instead, so subtract off the
222 * residue if drv->done() error processing indicates no
223 * change to the completion length.
224 */
225 if (good_bytes == old_good_bytes)
226 good_bytes -= scsi_get_resid(cmd);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800227 }
228 scsi_io_completion(cmd, good_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Rob Landleyeb448202007-11-03 13:30:39 -0500231/**
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100232 * scsi_change_queue_depth - change a device's queue depth
Rob Landleyeb448202007-11-03 13:30:39 -0500233 * @sdev: SCSI Device in question
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100234 * @depth: number of commands allowed to be queued to the driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 *
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100236 * Sets the device queue depth and returns the new value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100238int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Christoph Hellwig64d513a2015-10-08 09:28:04 +0100240 if (depth > 0) {
241 sdev->queue_depth = depth;
242 wmb();
Mike Christie885ace92008-07-11 19:50:32 -0500243 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Jens Axboed278d4a2016-03-30 10:21:08 -0600245 if (sdev->request_queue)
246 blk_set_queue_depth(sdev->request_queue, depth);
247
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100248 return sdev->queue_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249}
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100250EXPORT_SYMBOL(scsi_change_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Rob Landleyeb448202007-11-03 13:30:39 -0500252/**
253 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
254 * @sdev: SCSI Device in question
255 * @depth: Current number of outstanding SCSI commands on this device,
256 * not counting the one returned as QUEUE_FULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 *
Rob Landleyeb448202007-11-03 13:30:39 -0500258 * Description: This function will track successive QUEUE_FULL events on a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 * specific SCSI device to determine if and when there is a
260 * need to adjust the queue depth on the device.
261 *
Rob Landleyeb448202007-11-03 13:30:39 -0500262 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 * -1 - Drop back to untagged operation using host->cmd_per_lun
264 * as the untagged command depth
265 *
266 * Lock Status: None held on entry
267 *
268 * Notes: Low level drivers may call this at any time and we will do
269 * "The Right Thing." We are interrupt context safe.
270 */
271int scsi_track_queue_full(struct scsi_device *sdev, int depth)
272{
Vasu Dev4a840672009-10-22 15:46:33 -0700273
274 /*
275 * Don't let QUEUE_FULLs on the same
276 * jiffies count, they could all be from
277 * same event.
278 */
279 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 return 0;
281
Vasu Dev4a840672009-10-22 15:46:33 -0700282 sdev->last_queue_full_time = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 if (sdev->last_queue_full_depth != depth) {
284 sdev->last_queue_full_count = 1;
285 sdev->last_queue_full_depth = depth;
286 } else {
287 sdev->last_queue_full_count++;
288 }
289
290 if (sdev->last_queue_full_count <= 10)
291 return 0;
Christoph Hellwig609aa222014-10-30 11:54:58 +0100292
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100293 return scsi_change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294}
295EXPORT_SYMBOL(scsi_track_queue_full);
296
297/**
Matthew Wilcox881a2562008-12-31 13:12:46 -0500298 * scsi_vpd_inquiry - Request a device provide us with a VPD page
299 * @sdev: The device to ask
300 * @buffer: Where to put the result
301 * @page: Which Vital Product Data to return
302 * @len: The length of the buffer
303 *
304 * This is an internal helper function. You probably want to use
305 * scsi_get_vpd_page instead.
306 *
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100307 * Returns size of the vpd page on success or a negative error number.
Matthew Wilcox881a2562008-12-31 13:12:46 -0500308 */
309static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
310 u8 page, unsigned len)
311{
312 int result;
313 unsigned char cmd[16];
314
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100315 if (len < 4)
316 return -EINVAL;
317
Matthew Wilcox881a2562008-12-31 13:12:46 -0500318 cmd[0] = INQUIRY;
319 cmd[1] = 1; /* EVPD */
320 cmd[2] = page;
321 cmd[3] = len >> 8;
322 cmd[4] = len & 0xff;
323 cmd[5] = 0; /* Control byte */
324
325 /*
326 * I'm not convinced we need to try quite this hard to get VPD, but
327 * all the existing users tried this hard.
328 */
329 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
James Bottomley95a36392009-08-11 10:59:09 -0500330 len, NULL, 30 * HZ, 3, NULL);
Matthew Wilcox881a2562008-12-31 13:12:46 -0500331 if (result)
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100332 return -EIO;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500333
334 /* Sanity check that we got the page back that we asked for */
335 if (buffer[1] != page)
336 return -EIO;
337
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100338 return get_unaligned_be16(&buffer[2]) + 4;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500339}
340
341/**
342 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
343 * @sdev: The device to ask
344 * @page: Which Vital Product Data to return
Randy Dunlap786f8ba2010-02-28 17:32:45 -0800345 * @buf: where to store the VPD
346 * @buf_len: number of bytes in the VPD buffer area
Matthew Wilcox881a2562008-12-31 13:12:46 -0500347 *
348 * SCSI devices may optionally supply Vital Product Data. Each 'page'
349 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
350 * If the device supports this VPD page, this routine returns a pointer
351 * to a buffer containing the data from that page. The caller is
352 * responsible for calling kfree() on this pointer when it is no longer
353 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
354 */
James Bottomleye3deec02009-11-03 12:33:07 -0600355int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
356 int buf_len)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500357{
358 int i, result;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500359
Martin K. Petersen75625232013-07-30 22:58:34 -0400360 if (sdev->skip_vpd_pages)
361 goto fail;
362
Matthew Wilcox881a2562008-12-31 13:12:46 -0500363 /* Ask for all the pages supported by this device */
James Bottomleye3deec02009-11-03 12:33:07 -0600364 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100365 if (result < 4)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500366 goto fail;
367
368 /* If the user actually wanted this page, we can skip the rest */
369 if (page == 0)
Martin K. Petersen16d3ea22010-09-10 01:20:27 -0400370 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500371
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100372 for (i = 4; i < min(result, buf_len); i++)
373 if (buf[i] == page)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500374 goto found;
James Bottomleye3deec02009-11-03 12:33:07 -0600375
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100376 if (i < result && i >= buf_len)
James Bottomleye3deec02009-11-03 12:33:07 -0600377 /* ran off the end of the buffer, give us benefit of doubt */
378 goto found;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500379 /* The device claims it doesn't support the requested page */
380 goto fail;
381
382 found:
James Bottomleye3deec02009-11-03 12:33:07 -0600383 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100384 if (result < 0)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500385 goto fail;
386
James Bottomleye3deec02009-11-03 12:33:07 -0600387 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500388
389 fail:
James Bottomleye3deec02009-11-03 12:33:07 -0600390 return -EINVAL;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500391}
392EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
393
394/**
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700395 * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
396 * @sdev: The device to ask
397 * @page: Which Vital Product Data to return
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700398 *
399 * Returns %NULL upon failure.
400 */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700401static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700402{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700403 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700404 int vpd_len = SCSI_VPD_PG_LEN, result;
405
406retry_pg:
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700407 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700408 if (!vpd_buf)
409 return NULL;
410
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700411 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700412 if (result < 0) {
413 kfree(vpd_buf);
414 return NULL;
415 }
416 if (result > vpd_len) {
417 vpd_len = result;
418 kfree(vpd_buf);
419 goto retry_pg;
420 }
421
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700422 vpd_buf->len = result;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700423
424 return vpd_buf;
425}
426
427static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700428 struct scsi_vpd __rcu **sdev_vpd_buf)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700429{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700430 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700431
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700432 vpd_buf = scsi_get_vpd_buf(sdev, page);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700433 if (!vpd_buf)
434 return;
435
436 mutex_lock(&sdev->inquiry_mutex);
437 rcu_swap_protected(*sdev_vpd_buf, vpd_buf,
438 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700439 mutex_unlock(&sdev->inquiry_mutex);
440
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700441 if (vpd_buf)
442 kfree_rcu(vpd_buf, rcu);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700443}
444
445/**
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100446 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
447 * @sdev: The device to ask
448 *
449 * Attach the 'Device Identification' VPD page (0x83) and the
450 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
451 * structure. This information can be used to identify the device
452 * uniquely.
453 */
454void scsi_attach_vpd(struct scsi_device *sdev)
455{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700456 int i;
457 struct scsi_vpd *vpd_buf;
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100458
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200459 if (!scsi_device_supports_vpd(sdev))
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100460 return;
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200461
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700462 /* Ask for all the pages supported by this device */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700463 vpd_buf = scsi_get_vpd_buf(sdev, 0);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100464 if (!vpd_buf)
465 return;
466
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700467 for (i = 4; i < vpd_buf->len; i++) {
468 if (vpd_buf->data[i] == 0x80)
469 scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
470 if (vpd_buf->data[i] == 0x83)
471 scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100472 }
473 kfree(vpd_buf);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100474}
475
476/**
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400477 * scsi_report_opcode - Find out if a given command opcode is supported
478 * @sdev: scsi device to query
479 * @buffer: scratch buffer (must be at least 20 bytes long)
480 * @len: length of buffer
481 * @opcode: opcode for command to look up
482 *
483 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400484 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
485 * unsupported and 1 if the device claims to support the command.
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400486 */
487int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
488 unsigned int len, unsigned char opcode)
489{
490 unsigned char cmd[16];
491 struct scsi_sense_hdr sshdr;
492 int result;
493
494 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400495 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400496
497 memset(cmd, 0, 16);
498 cmd[0] = MAINTENANCE_IN;
499 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
500 cmd[2] = 1; /* One command format */
501 cmd[3] = opcode;
502 put_unaligned_be32(len, &cmd[6]);
503 memset(buffer, 0, len);
504
505 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
506 &sshdr, 30 * HZ, 3, NULL);
507
508 if (result && scsi_sense_valid(&sshdr) &&
509 sshdr.sense_key == ILLEGAL_REQUEST &&
510 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400511 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400512
513 if ((buffer[1] & 3) == 3) /* Command supported */
514 return 1;
515
516 return 0;
517}
518EXPORT_SYMBOL(scsi_report_opcode);
519
520/**
Rob Landleyeb448202007-11-03 13:30:39 -0500521 * scsi_device_get - get an additional reference to a scsi_device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 * @sdev: device to get a reference to
523 *
Rob Landleyeb448202007-11-03 13:30:39 -0500524 * Description: Gets a reference to the scsi_device and increments the use count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * of the underlying LLDD module. You must hold host_lock of the
526 * parent Scsi_Host or already have a reference when calling this.
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100527 *
528 * This will fail if a device is deleted or cancelled, or when the LLD module
529 * is in the process of being unloaded.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 */
531int scsi_device_get(struct scsi_device *sdev)
532{
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100533 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
534 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 if (!get_device(&sdev->sdev_gendev))
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100536 goto fail;
537 if (!try_module_get(sdev->host->hostt->module))
538 goto fail_put_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 return 0;
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100540
541fail_put_device:
542 put_device(&sdev->sdev_gendev);
543fail:
544 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
546EXPORT_SYMBOL(scsi_device_get);
547
548/**
549 * scsi_device_put - release a reference to a scsi_device
550 * @sdev: device to release a reference on.
551 *
Rob Landleyeb448202007-11-03 13:30:39 -0500552 * Description: Release a reference to the scsi_device and decrements the use
553 * count of the underlying LLDD module. The device is freed once the last
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 * user vanishes.
555 */
556void scsi_device_put(struct scsi_device *sdev)
557{
Rusty Russelldc4515e2015-01-23 13:22:47 +1030558 module_put(sdev->host->hostt->module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 put_device(&sdev->sdev_gendev);
560}
561EXPORT_SYMBOL(scsi_device_put);
562
Rob Landleyeb448202007-11-03 13:30:39 -0500563/* helper for shost_for_each_device, see that for documentation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
565 struct scsi_device *prev)
566{
567 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
568 struct scsi_device *next = NULL;
569 unsigned long flags;
570
571 spin_lock_irqsave(shost->host_lock, flags);
572 while (list->next != &shost->__devices) {
573 next = list_entry(list->next, struct scsi_device, siblings);
574 /* skip devices that we can't get a reference to */
575 if (!scsi_device_get(next))
576 break;
577 next = NULL;
578 list = list->next;
579 }
580 spin_unlock_irqrestore(shost->host_lock, flags);
581
582 if (prev)
583 scsi_device_put(prev);
584 return next;
585}
586EXPORT_SYMBOL(__scsi_iterate_devices);
587
588/**
589 * starget_for_each_device - helper to walk all devices of a target
590 * @starget: target whose devices we want to iterate over.
Rob Landleyeb448202007-11-03 13:30:39 -0500591 * @data: Opaque passed to each function call.
592 * @fn: Function to call on each device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 *
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800594 * This traverses over each device of @starget. The devices have
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 * a reference that must be released by scsi_host_put when breaking
596 * out of the loop.
597 */
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800598void starget_for_each_device(struct scsi_target *starget, void *data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 void (*fn)(struct scsi_device *, void *))
600{
601 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
602 struct scsi_device *sdev;
603
604 shost_for_each_device(sdev, shost) {
605 if ((sdev->channel == starget->channel) &&
606 (sdev->id == starget->id))
607 fn(sdev, data);
608 }
609}
610EXPORT_SYMBOL(starget_for_each_device);
611
612/**
Randy Dunlap14f501a2008-02-03 15:06:36 -0800613 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800614 * @starget: target whose devices we want to iterate over.
Randy Dunlap14f501a2008-02-03 15:06:36 -0800615 * @data: parameter for callback @fn()
616 * @fn: callback function that is invoked for each device
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800617 *
618 * This traverses over each device of @starget. It does _not_
619 * take a reference on the scsi_device, so the whole loop must be
620 * protected by shost->host_lock.
621 *
622 * Note: The only reason why drivers would want to use this is because
623 * they need to access the device list in irq context. Otherwise you
624 * really want to use starget_for_each_device instead.
625 **/
626void __starget_for_each_device(struct scsi_target *starget, void *data,
627 void (*fn)(struct scsi_device *, void *))
628{
629 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
630 struct scsi_device *sdev;
631
632 __shost_for_each_device(sdev, shost) {
633 if ((sdev->channel == starget->channel) &&
634 (sdev->id == starget->id))
635 fn(sdev, data);
636 }
637}
638EXPORT_SYMBOL(__starget_for_each_device);
639
640/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
642 * @starget: SCSI target pointer
643 * @lun: SCSI Logical Unit Number
644 *
Rob Landleyeb448202007-11-03 13:30:39 -0500645 * Description: Looks up the scsi_device with the specified @lun for a given
646 * @starget. The returned scsi_device does not have an additional
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 * reference. You must hold the host's host_lock over this call and
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100648 * any access to the returned scsi_device. A scsi_device in state
649 * SDEV_DEL is skipped.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 *
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800651 * Note: The only reason why drivers should use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500652 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 * really want to use scsi_device_lookup_by_target instead.
654 **/
655struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200656 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
658 struct scsi_device *sdev;
659
660 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100661 if (sdev->sdev_state == SDEV_DEL)
662 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 if (sdev->lun ==lun)
664 return sdev;
665 }
666
667 return NULL;
668}
669EXPORT_SYMBOL(__scsi_device_lookup_by_target);
670
671/**
672 * scsi_device_lookup_by_target - find a device given the target
673 * @starget: SCSI target pointer
674 * @lun: SCSI Logical Unit Number
675 *
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200676 * Description: Looks up the scsi_device with the specified @lun for a given
677 * @starget. The returned scsi_device has an additional reference that
Rob Landleyeb448202007-11-03 13:30:39 -0500678 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 **/
680struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200681 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
683 struct scsi_device *sdev;
684 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
685 unsigned long flags;
686
687 spin_lock_irqsave(shost->host_lock, flags);
688 sdev = __scsi_device_lookup_by_target(starget, lun);
689 if (sdev && scsi_device_get(sdev))
690 sdev = NULL;
691 spin_unlock_irqrestore(shost->host_lock, flags);
692
693 return sdev;
694}
695EXPORT_SYMBOL(scsi_device_lookup_by_target);
696
697/**
Rob Landleyeb448202007-11-03 13:30:39 -0500698 * __scsi_device_lookup - find a device given the host (UNLOCKED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 * @shost: SCSI host pointer
700 * @channel: SCSI channel (zero if only one channel)
Rob Landleyeb448202007-11-03 13:30:39 -0500701 * @id: SCSI target number (physical unit number)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 * @lun: SCSI Logical Unit Number
703 *
Rob Landleyeb448202007-11-03 13:30:39 -0500704 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
705 * for a given host. The returned scsi_device does not have an additional
706 * reference. You must hold the host's host_lock over this call and any access
707 * to the returned scsi_device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 *
709 * Note: The only reason why drivers would want to use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500710 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 * really want to use scsi_device_lookup instead.
712 **/
713struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200714 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
716 struct scsi_device *sdev;
717
718 list_for_each_entry(sdev, &shost->__devices, siblings) {
Zhou Zhengping4ff7adc2017-04-28 17:43:04 +0800719 if (sdev->sdev_state == SDEV_DEL)
720 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 if (sdev->channel == channel && sdev->id == id &&
722 sdev->lun ==lun)
723 return sdev;
724 }
725
726 return NULL;
727}
728EXPORT_SYMBOL(__scsi_device_lookup);
729
730/**
731 * scsi_device_lookup - find a device given the host
732 * @shost: SCSI host pointer
733 * @channel: SCSI channel (zero if only one channel)
734 * @id: SCSI target number (physical unit number)
735 * @lun: SCSI Logical Unit Number
736 *
Rob Landleyeb448202007-11-03 13:30:39 -0500737 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
738 * for a given host. The returned scsi_device has an additional reference that
739 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 **/
741struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200742 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
744 struct scsi_device *sdev;
745 unsigned long flags;
746
747 spin_lock_irqsave(shost->host_lock, flags);
748 sdev = __scsi_device_lookup(shost, channel, id, lun);
749 if (sdev && scsi_device_get(sdev))
750 sdev = NULL;
751 spin_unlock_irqrestore(shost->host_lock, flags);
752
753 return sdev;
754}
755EXPORT_SYMBOL(scsi_device_lookup);
756
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757MODULE_DESCRIPTION("SCSI core");
758MODULE_LICENSE("GPL");
759
760module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
761MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
762
Jens Axboef664a3c2018-11-01 16:36:27 -0600763/* This should go away in the future, it doesn't do anything anymore */
Christoph Hellwig24c20f12014-09-30 16:43:46 +0200764bool scsi_use_blk_mq = true;
Christoph Hellwigd2852032014-01-17 12:06:53 +0100765module_param_named(use_blk_mq, scsi_use_blk_mq, bool, S_IWUSR | S_IRUGO);
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767static int __init init_scsi(void)
768{
Jens Axboe9bf09c232006-09-30 20:31:11 +0200769 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
771 error = scsi_init_queue();
772 if (error)
773 return error;
774 error = scsi_init_procfs();
775 if (error)
776 goto cleanup_queue;
777 error = scsi_init_devinfo();
778 if (error)
779 goto cleanup_procfs;
780 error = scsi_init_hosts();
781 if (error)
782 goto cleanup_devlist;
783 error = scsi_init_sysctl();
784 if (error)
785 goto cleanup_hosts;
786 error = scsi_sysfs_register();
787 if (error)
788 goto cleanup_sysctl;
789
James Smart84314fd2006-08-18 17:30:09 -0400790 scsi_netlink_init();
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 printk(KERN_NOTICE "SCSI subsystem initialized\n");
793 return 0;
794
795cleanup_sysctl:
796 scsi_exit_sysctl();
797cleanup_hosts:
798 scsi_exit_hosts();
799cleanup_devlist:
800 scsi_exit_devinfo();
801cleanup_procfs:
802 scsi_exit_procfs();
803cleanup_queue:
804 scsi_exit_queue();
805 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
806 -error);
807 return error;
808}
809
810static void __exit exit_scsi(void)
811{
James Smart84314fd2006-08-18 17:30:09 -0400812 scsi_netlink_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 scsi_sysfs_unregister();
814 scsi_exit_sysctl();
815 scsi_exit_hosts();
816 scsi_exit_devinfo();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 scsi_exit_procfs();
818 scsi_exit_queue();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
820
821subsys_initcall(init_scsi);
822module_exit(exit_scsi);