blob: e9e2f0e15ac85ece57414fa488b89434fb258120 [file] [log] [blame]
Thomas Gleixner09c434b2019-05-19 13:08:20 +01001// SPDX-License-Identifier: GPL-2.0-only
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#ifdef CONFIG_SCSI_LOGGING
98void scsi_log_send(struct scsi_cmnd *cmd)
99{
100 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 /*
103 * If ML QUEUE log level is greater than or equal to:
104 *
105 * 1: nothing (match completion)
106 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200107 * 2: log opcode + command of all commands + cmd address
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200109 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 *
Hannes Reineckea4a6afb2015-01-08 07:43:49 +0100111 * 4: same as 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 */
113 if (unlikely(scsi_logging_level)) {
114 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
115 SCSI_LOG_MLQUEUE_BITS);
116 if (level > 1) {
Hannes Reineckec11c0042014-10-24 14:27:01 +0200117 scmd_printk(KERN_INFO, cmd,
118 "Send: scmd 0x%p\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 scsi_print_command(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 }
121 }
122}
123
124void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
125{
126 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
128 /*
129 * If ML COMPLETE log level is greater than or equal to:
130 *
131 * 1: log disposition, result, opcode + command, and conditionally
132 * sense data for failures or non SUCCESS dispositions.
133 *
134 * 2: same as 1 but for all command completions.
135 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200136 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 *
138 * 4: same as 3 plus dump extra junk
139 */
140 if (unlikely(scsi_logging_level)) {
141 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
142 SCSI_LOG_MLCOMPLETE_BITS);
143 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
144 (level > 1)) {
Hannes Reinecke026f8da2015-01-08 07:43:47 +0100145 scsi_print_result(cmd, "Done", disposition);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 scsi_print_command(cmd);
Johannes Thumshirnc65be1a2018-06-25 13:20:58 +0200147 if (status_byte(cmd->result) == CHECK_CONDITION)
Hannes Reinecked811b842014-10-24 14:26:45 +0200148 scsi_print_sense(cmd);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500149 if (level > 3)
150 scmd_printk(KERN_INFO, cmd,
151 "scsi host busy %d failed %d\n",
Ming Leic84b0232018-06-24 22:03:26 +0800152 scsi_host_busy(cmd->device->host),
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500153 cmd->device->host->host_failed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 }
155 }
156}
157#endif
158
Rob Landleyeb448202007-11-03 13:30:39 -0500159/**
Rob Landleyeb448202007-11-03 13:30:39 -0500160 * scsi_finish_command - cleanup and pass command back to upper layer
161 * @cmd: the command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 *
Rob Landleyeb448202007-11-03 13:30:39 -0500163 * Description: Pass command off to upper layer for finishing of I/O
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 * request, waking processes that are waiting on results,
165 * etc.
166 */
167void scsi_finish_command(struct scsi_cmnd *cmd)
168{
169 struct scsi_device *sdev = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500170 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 struct Scsi_Host *shost = sdev->host;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800172 struct scsi_driver *drv;
173 unsigned int good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Ming Lei6eb045e2019-10-25 14:58:55 +0800175 scsi_device_unbusy(sdev, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100177 /*
178 * Clear the flags that say that the device/target/host is no longer
179 * capable of accepting new commands.
180 */
181 if (atomic_read(&shost->host_blocked))
182 atomic_set(&shost->host_blocked, 0);
183 if (atomic_read(&starget->target_blocked))
184 atomic_set(&starget->target_blocked, 0);
185 if (atomic_read(&sdev->device_blocked))
186 atomic_set(&sdev->device_blocked, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
188 /*
189 * If we have valid sense information, then some kind of recovery
190 * must have taken place. Make a note of this.
191 */
192 if (SCSI_SENSE_VALID(cmd))
193 cmd->result |= (DRIVER_SENSE << 24);
194
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400195 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
196 "Notifying upper driver of completion "
197 "(result %x)\n", cmd->result));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
FUJITA Tomonorif18573a2008-04-11 12:56:52 +0200199 good_bytes = scsi_bufflen(cmd);
Jianchao Wang8ef7fe42018-02-26 15:59:16 +0800200 if (!blk_rq_is_passthrough(cmd->request)) {
James Bottomley427e59f2008-03-08 18:24:17 -0600201 int old_good_bytes = good_bytes;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800202 drv = scsi_cmd_to_driver(cmd);
203 if (drv->done)
204 good_bytes = drv->done(cmd);
James Bottomley427e59f2008-03-08 18:24:17 -0600205 /*
206 * USB may not give sense identifying bad sector and
207 * simply return a residue instead, so subtract off the
208 * residue if drv->done() error processing indicates no
209 * change to the completion length.
210 */
211 if (good_bytes == old_good_bytes)
212 good_bytes -= scsi_get_resid(cmd);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800213 }
214 scsi_io_completion(cmd, good_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Ming Leica445322021-01-22 10:33:16 +0800217
218/*
219 * 1024 is big enough for saturating the fast scsi LUN now
220 */
Ming Lei020b0f02021-01-22 10:33:17 +0800221int scsi_device_max_queue_depth(struct scsi_device *sdev)
Ming Leica445322021-01-22 10:33:16 +0800222{
223 return max_t(int, sdev->host->can_queue, 1024);
224}
225
Rob Landleyeb448202007-11-03 13:30:39 -0500226/**
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100227 * scsi_change_queue_depth - change a device's queue depth
Rob Landleyeb448202007-11-03 13:30:39 -0500228 * @sdev: SCSI Device in question
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100229 * @depth: number of commands allowed to be queued to the driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 *
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100231 * Sets the device queue depth and returns the new value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 */
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100233int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
Ming Leica445322021-01-22 10:33:16 +0800235 depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
236
Christoph Hellwig64d513a2015-10-08 09:28:04 +0100237 if (depth > 0) {
238 sdev->queue_depth = depth;
239 wmb();
Mike Christie885ace92008-07-11 19:50:32 -0500240 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Jens Axboed278d4a2016-03-30 10:21:08 -0600242 if (sdev->request_queue)
243 blk_set_queue_depth(sdev->request_queue, depth);
244
Ming Lei020b0f02021-01-22 10:33:17 +0800245 sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
246
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100247 return sdev->queue_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248}
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100249EXPORT_SYMBOL(scsi_change_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Rob Landleyeb448202007-11-03 13:30:39 -0500251/**
252 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
253 * @sdev: SCSI Device in question
254 * @depth: Current number of outstanding SCSI commands on this device,
255 * not counting the one returned as QUEUE_FULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 *
Rob Landleyeb448202007-11-03 13:30:39 -0500257 * Description: This function will track successive QUEUE_FULL events on a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 * specific SCSI device to determine if and when there is a
259 * need to adjust the queue depth on the device.
260 *
Rob Landleyeb448202007-11-03 13:30:39 -0500261 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 * -1 - Drop back to untagged operation using host->cmd_per_lun
263 * as the untagged command depth
264 *
265 * Lock Status: None held on entry
266 *
267 * Notes: Low level drivers may call this at any time and we will do
268 * "The Right Thing." We are interrupt context safe.
269 */
270int scsi_track_queue_full(struct scsi_device *sdev, int depth)
271{
Vasu Dev4a840672009-10-22 15:46:33 -0700272
273 /*
274 * Don't let QUEUE_FULLs on the same
275 * jiffies count, they could all be from
276 * same event.
277 */
278 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 return 0;
280
Vasu Dev4a840672009-10-22 15:46:33 -0700281 sdev->last_queue_full_time = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 if (sdev->last_queue_full_depth != depth) {
283 sdev->last_queue_full_count = 1;
284 sdev->last_queue_full_depth = depth;
285 } else {
286 sdev->last_queue_full_count++;
287 }
288
289 if (sdev->last_queue_full_count <= 10)
290 return 0;
Christoph Hellwig609aa222014-10-30 11:54:58 +0100291
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100292 return scsi_change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294EXPORT_SYMBOL(scsi_track_queue_full);
295
296/**
Matthew Wilcox881a2562008-12-31 13:12:46 -0500297 * scsi_vpd_inquiry - Request a device provide us with a VPD page
298 * @sdev: The device to ask
299 * @buffer: Where to put the result
300 * @page: Which Vital Product Data to return
301 * @len: The length of the buffer
302 *
303 * This is an internal helper function. You probably want to use
304 * scsi_get_vpd_page instead.
305 *
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100306 * Returns size of the vpd page on success or a negative error number.
Matthew Wilcox881a2562008-12-31 13:12:46 -0500307 */
308static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
309 u8 page, unsigned len)
310{
311 int result;
312 unsigned char cmd[16];
313
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100314 if (len < 4)
315 return -EINVAL;
316
Matthew Wilcox881a2562008-12-31 13:12:46 -0500317 cmd[0] = INQUIRY;
318 cmd[1] = 1; /* EVPD */
319 cmd[2] = page;
320 cmd[3] = len >> 8;
321 cmd[4] = len & 0xff;
322 cmd[5] = 0; /* Control byte */
323
324 /*
325 * I'm not convinced we need to try quite this hard to get VPD, but
326 * all the existing users tried this hard.
327 */
328 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
James Bottomley95a36392009-08-11 10:59:09 -0500329 len, NULL, 30 * HZ, 3, NULL);
Matthew Wilcox881a2562008-12-31 13:12:46 -0500330 if (result)
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100331 return -EIO;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500332
333 /* Sanity check that we got the page back that we asked for */
334 if (buffer[1] != page)
335 return -EIO;
336
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100337 return get_unaligned_be16(&buffer[2]) + 4;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500338}
339
340/**
341 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
342 * @sdev: The device to ask
343 * @page: Which Vital Product Data to return
Randy Dunlap786f8ba2010-02-28 17:32:45 -0800344 * @buf: where to store the VPD
345 * @buf_len: number of bytes in the VPD buffer area
Matthew Wilcox881a2562008-12-31 13:12:46 -0500346 *
347 * SCSI devices may optionally supply Vital Product Data. Each 'page'
348 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
349 * If the device supports this VPD page, this routine returns a pointer
350 * to a buffer containing the data from that page. The caller is
351 * responsible for calling kfree() on this pointer when it is no longer
352 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
353 */
James Bottomleye3deec02009-11-03 12:33:07 -0600354int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
355 int buf_len)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500356{
357 int i, result;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500358
Martin K. Petersen75625232013-07-30 22:58:34 -0400359 if (sdev->skip_vpd_pages)
360 goto fail;
361
Matthew Wilcox881a2562008-12-31 13:12:46 -0500362 /* Ask for all the pages supported by this device */
James Bottomleye3deec02009-11-03 12:33:07 -0600363 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100364 if (result < 4)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500365 goto fail;
366
367 /* If the user actually wanted this page, we can skip the rest */
368 if (page == 0)
Martin K. Petersen16d3ea22010-09-10 01:20:27 -0400369 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500370
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100371 for (i = 4; i < min(result, buf_len); i++)
372 if (buf[i] == page)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500373 goto found;
James Bottomleye3deec02009-11-03 12:33:07 -0600374
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100375 if (i < result && i >= buf_len)
James Bottomleye3deec02009-11-03 12:33:07 -0600376 /* ran off the end of the buffer, give us benefit of doubt */
377 goto found;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500378 /* The device claims it doesn't support the requested page */
379 goto fail;
380
381 found:
James Bottomleye3deec02009-11-03 12:33:07 -0600382 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100383 if (result < 0)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500384 goto fail;
385
James Bottomleye3deec02009-11-03 12:33:07 -0600386 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500387
388 fail:
James Bottomleye3deec02009-11-03 12:33:07 -0600389 return -EINVAL;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500390}
391EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
392
393/**
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700394 * 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
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700397 *
398 * Returns %NULL upon failure.
399 */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700400static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700401{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700402 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700403 int vpd_len = SCSI_VPD_PG_LEN, result;
404
405retry_pg:
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700406 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700407 if (!vpd_buf)
408 return NULL;
409
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700410 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700411 if (result < 0) {
412 kfree(vpd_buf);
413 return NULL;
414 }
415 if (result > vpd_len) {
416 vpd_len = result;
417 kfree(vpd_buf);
418 goto retry_pg;
419 }
420
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700421 vpd_buf->len = result;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700422
423 return vpd_buf;
424}
425
426static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700427 struct scsi_vpd __rcu **sdev_vpd_buf)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700428{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700429 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700430
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700431 vpd_buf = scsi_get_vpd_buf(sdev, page);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700432 if (!vpd_buf)
433 return;
434
435 mutex_lock(&sdev->inquiry_mutex);
Paul E. McKenneyc0eaf152019-09-23 15:26:28 -0700436 vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
437 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700438 mutex_unlock(&sdev->inquiry_mutex);
439
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700440 if (vpd_buf)
441 kfree_rcu(vpd_buf, rcu);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700442}
443
444/**
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100445 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
446 * @sdev: The device to ask
447 *
448 * Attach the 'Device Identification' VPD page (0x83) and the
449 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
450 * structure. This information can be used to identify the device
451 * uniquely.
452 */
453void scsi_attach_vpd(struct scsi_device *sdev)
454{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700455 int i;
456 struct scsi_vpd *vpd_buf;
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100457
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200458 if (!scsi_device_supports_vpd(sdev))
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100459 return;
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200460
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700461 /* Ask for all the pages supported by this device */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700462 vpd_buf = scsi_get_vpd_buf(sdev, 0);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100463 if (!vpd_buf)
464 return;
465
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700466 for (i = 4; i < vpd_buf->len; i++) {
Ryan Attardd188b062019-09-26 11:22:17 -0500467 if (vpd_buf->data[i] == 0x0)
468 scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700469 if (vpd_buf->data[i] == 0x80)
470 scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
471 if (vpd_buf->data[i] == 0x83)
472 scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
Ryan Attardd188b062019-09-26 11:22:17 -0500473 if (vpd_buf->data[i] == 0x89)
474 scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100475 }
476 kfree(vpd_buf);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100477}
478
479/**
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400480 * scsi_report_opcode - Find out if a given command opcode is supported
481 * @sdev: scsi device to query
482 * @buffer: scratch buffer (must be at least 20 bytes long)
483 * @len: length of buffer
484 * @opcode: opcode for command to look up
485 *
486 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400487 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
488 * unsupported and 1 if the device claims to support the command.
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400489 */
490int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
491 unsigned int len, unsigned char opcode)
492{
493 unsigned char cmd[16];
494 struct scsi_sense_hdr sshdr;
495 int result;
496
497 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400498 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400499
500 memset(cmd, 0, 16);
501 cmd[0] = MAINTENANCE_IN;
502 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
503 cmd[2] = 1; /* One command format */
504 cmd[3] = opcode;
505 put_unaligned_be32(len, &cmd[6]);
506 memset(buffer, 0, len);
507
508 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
509 &sshdr, 30 * HZ, 3, NULL);
510
511 if (result && scsi_sense_valid(&sshdr) &&
512 sshdr.sense_key == ILLEGAL_REQUEST &&
513 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400514 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400515
516 if ((buffer[1] & 3) == 3) /* Command supported */
517 return 1;
518
519 return 0;
520}
521EXPORT_SYMBOL(scsi_report_opcode);
522
523/**
Rob Landleyeb448202007-11-03 13:30:39 -0500524 * scsi_device_get - get an additional reference to a scsi_device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 * @sdev: device to get a reference to
526 *
Rob Landleyeb448202007-11-03 13:30:39 -0500527 * Description: Gets a reference to the scsi_device and increments the use count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 * of the underlying LLDD module. You must hold host_lock of the
529 * parent Scsi_Host or already have a reference when calling this.
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100530 *
531 * This will fail if a device is deleted or cancelled, or when the LLD module
532 * is in the process of being unloaded.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 */
534int scsi_device_get(struct scsi_device *sdev)
535{
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100536 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
537 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 if (!get_device(&sdev->sdev_gendev))
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100539 goto fail;
540 if (!try_module_get(sdev->host->hostt->module))
541 goto fail_put_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 return 0;
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100543
544fail_put_device:
545 put_device(&sdev->sdev_gendev);
546fail:
547 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548}
549EXPORT_SYMBOL(scsi_device_get);
550
551/**
552 * scsi_device_put - release a reference to a scsi_device
553 * @sdev: device to release a reference on.
554 *
Rob Landleyeb448202007-11-03 13:30:39 -0500555 * Description: Release a reference to the scsi_device and decrements the use
556 * count of the underlying LLDD module. The device is freed once the last
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 * user vanishes.
558 */
559void scsi_device_put(struct scsi_device *sdev)
560{
Rusty Russelldc4515e2015-01-23 13:22:47 +1030561 module_put(sdev->host->hostt->module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 put_device(&sdev->sdev_gendev);
563}
564EXPORT_SYMBOL(scsi_device_put);
565
Rob Landleyeb448202007-11-03 13:30:39 -0500566/* helper for shost_for_each_device, see that for documentation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
568 struct scsi_device *prev)
569{
570 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
571 struct scsi_device *next = NULL;
572 unsigned long flags;
573
574 spin_lock_irqsave(shost->host_lock, flags);
575 while (list->next != &shost->__devices) {
576 next = list_entry(list->next, struct scsi_device, siblings);
577 /* skip devices that we can't get a reference to */
578 if (!scsi_device_get(next))
579 break;
580 next = NULL;
581 list = list->next;
582 }
583 spin_unlock_irqrestore(shost->host_lock, flags);
584
585 if (prev)
586 scsi_device_put(prev);
587 return next;
588}
589EXPORT_SYMBOL(__scsi_iterate_devices);
590
591/**
592 * starget_for_each_device - helper to walk all devices of a target
593 * @starget: target whose devices we want to iterate over.
Rob Landleyeb448202007-11-03 13:30:39 -0500594 * @data: Opaque passed to each function call.
595 * @fn: Function to call on each device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 *
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800597 * This traverses over each device of @starget. The devices have
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 * a reference that must be released by scsi_host_put when breaking
599 * out of the loop.
600 */
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800601void starget_for_each_device(struct scsi_target *starget, void *data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 void (*fn)(struct scsi_device *, void *))
603{
604 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
605 struct scsi_device *sdev;
606
607 shost_for_each_device(sdev, shost) {
608 if ((sdev->channel == starget->channel) &&
609 (sdev->id == starget->id))
610 fn(sdev, data);
611 }
612}
613EXPORT_SYMBOL(starget_for_each_device);
614
615/**
Randy Dunlap14f501a2008-02-03 15:06:36 -0800616 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800617 * @starget: target whose devices we want to iterate over.
Randy Dunlap14f501a2008-02-03 15:06:36 -0800618 * @data: parameter for callback @fn()
619 * @fn: callback function that is invoked for each device
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800620 *
621 * This traverses over each device of @starget. It does _not_
622 * take a reference on the scsi_device, so the whole loop must be
623 * protected by shost->host_lock.
624 *
625 * Note: The only reason why drivers would want to use this is because
626 * they need to access the device list in irq context. Otherwise you
627 * really want to use starget_for_each_device instead.
628 **/
629void __starget_for_each_device(struct scsi_target *starget, void *data,
630 void (*fn)(struct scsi_device *, void *))
631{
632 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
633 struct scsi_device *sdev;
634
635 __shost_for_each_device(sdev, shost) {
636 if ((sdev->channel == starget->channel) &&
637 (sdev->id == starget->id))
638 fn(sdev, data);
639 }
640}
641EXPORT_SYMBOL(__starget_for_each_device);
642
643/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
645 * @starget: SCSI target pointer
646 * @lun: SCSI Logical Unit Number
647 *
Rob Landleyeb448202007-11-03 13:30:39 -0500648 * Description: Looks up the scsi_device with the specified @lun for a given
649 * @starget. The returned scsi_device does not have an additional
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 * reference. You must hold the host's host_lock over this call and
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100651 * any access to the returned scsi_device. A scsi_device in state
652 * SDEV_DEL is skipped.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 *
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800654 * Note: The only reason why drivers should use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500655 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 * really want to use scsi_device_lookup_by_target instead.
657 **/
658struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200659 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
661 struct scsi_device *sdev;
662
663 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100664 if (sdev->sdev_state == SDEV_DEL)
665 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 if (sdev->lun ==lun)
667 return sdev;
668 }
669
670 return NULL;
671}
672EXPORT_SYMBOL(__scsi_device_lookup_by_target);
673
674/**
675 * scsi_device_lookup_by_target - find a device given the target
676 * @starget: SCSI target pointer
677 * @lun: SCSI Logical Unit Number
678 *
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200679 * Description: Looks up the scsi_device with the specified @lun for a given
680 * @starget. The returned scsi_device has an additional reference that
Rob Landleyeb448202007-11-03 13:30:39 -0500681 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 **/
683struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200684 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 struct scsi_device *sdev;
687 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
688 unsigned long flags;
689
690 spin_lock_irqsave(shost->host_lock, flags);
691 sdev = __scsi_device_lookup_by_target(starget, lun);
692 if (sdev && scsi_device_get(sdev))
693 sdev = NULL;
694 spin_unlock_irqrestore(shost->host_lock, flags);
695
696 return sdev;
697}
698EXPORT_SYMBOL(scsi_device_lookup_by_target);
699
700/**
Rob Landleyeb448202007-11-03 13:30:39 -0500701 * __scsi_device_lookup - find a device given the host (UNLOCKED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 * @shost: SCSI host pointer
703 * @channel: SCSI channel (zero if only one channel)
Rob Landleyeb448202007-11-03 13:30:39 -0500704 * @id: SCSI target number (physical unit number)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 * @lun: SCSI Logical Unit Number
706 *
Rob Landleyeb448202007-11-03 13:30:39 -0500707 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
708 * for a given host. The returned scsi_device does not have an additional
709 * reference. You must hold the host's host_lock over this call and any access
710 * to the returned scsi_device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 *
712 * Note: The only reason why drivers would want to use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500713 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 * really want to use scsi_device_lookup instead.
715 **/
716struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200717 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718{
719 struct scsi_device *sdev;
720
721 list_for_each_entry(sdev, &shost->__devices, siblings) {
Zhou Zhengping4ff7adc2017-04-28 17:43:04 +0800722 if (sdev->sdev_state == SDEV_DEL)
723 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 if (sdev->channel == channel && sdev->id == id &&
725 sdev->lun ==lun)
726 return sdev;
727 }
728
729 return NULL;
730}
731EXPORT_SYMBOL(__scsi_device_lookup);
732
733/**
734 * scsi_device_lookup - find a device given the host
735 * @shost: SCSI host pointer
736 * @channel: SCSI channel (zero if only one channel)
737 * @id: SCSI target number (physical unit number)
738 * @lun: SCSI Logical Unit Number
739 *
Rob Landleyeb448202007-11-03 13:30:39 -0500740 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
741 * for a given host. The returned scsi_device has an additional reference that
742 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 **/
744struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200745 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746{
747 struct scsi_device *sdev;
748 unsigned long flags;
749
750 spin_lock_irqsave(shost->host_lock, flags);
751 sdev = __scsi_device_lookup(shost, channel, id, lun);
752 if (sdev && scsi_device_get(sdev))
753 sdev = NULL;
754 spin_unlock_irqrestore(shost->host_lock, flags);
755
756 return sdev;
757}
758EXPORT_SYMBOL(scsi_device_lookup);
759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760MODULE_DESCRIPTION("SCSI core");
761MODULE_LICENSE("GPL");
762
763module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
764MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
765
766static int __init init_scsi(void)
767{
Jens Axboe9bf09c232006-09-30 20:31:11 +0200768 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 error = scsi_init_procfs();
771 if (error)
772 goto cleanup_queue;
773 error = scsi_init_devinfo();
774 if (error)
775 goto cleanup_procfs;
776 error = scsi_init_hosts();
777 if (error)
778 goto cleanup_devlist;
779 error = scsi_init_sysctl();
780 if (error)
781 goto cleanup_hosts;
782 error = scsi_sysfs_register();
783 if (error)
784 goto cleanup_sysctl;
785
James Smart84314fd2006-08-18 17:30:09 -0400786 scsi_netlink_init();
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 printk(KERN_NOTICE "SCSI subsystem initialized\n");
789 return 0;
790
791cleanup_sysctl:
792 scsi_exit_sysctl();
793cleanup_hosts:
794 scsi_exit_hosts();
795cleanup_devlist:
796 scsi_exit_devinfo();
797cleanup_procfs:
798 scsi_exit_procfs();
799cleanup_queue:
800 scsi_exit_queue();
801 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
802 -error);
803 return error;
804}
805
806static void __exit exit_scsi(void)
807{
James Smart84314fd2006-08-18 17:30:09 -0400808 scsi_netlink_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 scsi_sysfs_unregister();
810 scsi_exit_sysctl();
811 scsi_exit_hosts();
812 scsi_exit_devinfo();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 scsi_exit_procfs();
814 scsi_exit_queue();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815}
816
817subsys_initcall(init_scsi);
818module_exit(exit_scsi);