blob: f6af1562cba49d2b155b187fabfecbf36ed9f3ee [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#ifdef CONFIG_SCSI_LOGGING
90void scsi_log_send(struct scsi_cmnd *cmd)
91{
92 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94 /*
95 * If ML QUEUE log level is greater than or equal to:
96 *
97 * 1: nothing (match completion)
98 *
Hannes Reineckec11c0042014-10-24 14:27:01 +020099 * 2: log opcode + command of all commands + cmd address
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200101 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 *
Hannes Reineckea4a6afb2015-01-08 07:43:49 +0100103 * 4: same as 3
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 */
105 if (unlikely(scsi_logging_level)) {
106 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
107 SCSI_LOG_MLQUEUE_BITS);
108 if (level > 1) {
Hannes Reineckec11c0042014-10-24 14:27:01 +0200109 scmd_printk(KERN_INFO, cmd,
110 "Send: scmd 0x%p\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 scsi_print_command(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 }
113 }
114}
115
116void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
117{
118 unsigned int level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 /*
121 * If ML COMPLETE log level is greater than or equal to:
122 *
123 * 1: log disposition, result, opcode + command, and conditionally
124 * sense data for failures or non SUCCESS dispositions.
125 *
126 * 2: same as 1 but for all command completions.
127 *
Hannes Reineckec11c0042014-10-24 14:27:01 +0200128 * 3: same as 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 *
130 * 4: same as 3 plus dump extra junk
131 */
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)) ||
136 (level > 1)) {
Hannes Reinecke026f8da2015-01-08 07:43:47 +0100137 scsi_print_result(cmd, "Done", disposition);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 scsi_print_command(cmd);
Hannes Reinecked0672a02021-04-27 10:30:14 +0200139 if (scsi_status_is_check_condition(cmd->result))
Hannes Reinecked811b842014-10-24 14:26:45 +0200140 scsi_print_sense(cmd);
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500141 if (level > 3)
142 scmd_printk(KERN_INFO, cmd,
143 "scsi host busy %d failed %d\n",
Ming Leic84b0232018-06-24 22:03:26 +0800144 scsi_host_busy(cmd->device->host),
Martin K. Petersena4d04a42007-02-27 22:40:27 -0500145 cmd->device->host->host_failed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 }
147 }
148}
149#endif
150
Rob Landleyeb448202007-11-03 13:30:39 -0500151/**
Rob Landleyeb448202007-11-03 13:30:39 -0500152 * scsi_finish_command - cleanup and pass command back to upper layer
153 * @cmd: the command
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 *
Rob Landleyeb448202007-11-03 13:30:39 -0500155 * Description: Pass command off to upper layer for finishing of I/O
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 * request, waking processes that are waiting on results,
157 * etc.
158 */
159void scsi_finish_command(struct scsi_cmnd *cmd)
160{
161 struct scsi_device *sdev = cmd->device;
Mike Christief0c0a372008-08-17 15:24:38 -0500162 struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 struct Scsi_Host *shost = sdev->host;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800164 struct scsi_driver *drv;
165 unsigned int good_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Ming Lei6eb045e2019-10-25 14:58:55 +0800167 scsi_device_unbusy(sdev, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Christoph Hellwigcd9070c2014-01-23 12:07:41 +0100169 /*
170 * Clear the flags that say that the device/target/host is no longer
171 * capable of accepting new commands.
172 */
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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Jeff Garzik3bf743e2005-10-24 18:04:06 -0400180 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
181 "Notifying upper driver of completion "
182 "(result %x)\n", cmd->result));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
FUJITA Tomonorif18573a2008-04-11 12:56:52 +0200184 good_bytes = scsi_bufflen(cmd);
Bart Van Asscheaa8e25e2021-08-09 16:03:05 -0700185 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
James Bottomley427e59f2008-03-08 18:24:17 -0600186 int old_good_bytes = good_bytes;
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800187 drv = scsi_cmd_to_driver(cmd);
188 if (drv->done)
189 good_bytes = drv->done(cmd);
James Bottomley427e59f2008-03-08 18:24:17 -0600190 /*
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.
195 */
196 if (good_bytes == old_good_bytes)
197 good_bytes -= scsi_get_resid(cmd);
Linus Torvalds7b3d9542008-01-06 10:17:12 -0800198 }
199 scsi_io_completion(cmd, good_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Ming Leica445322021-01-22 10:33:16 +0800202
203/*
204 * 1024 is big enough for saturating the fast scsi LUN now
205 */
Ming Lei020b0f02021-01-22 10:33:17 +0800206int scsi_device_max_queue_depth(struct scsi_device *sdev)
Ming Leica445322021-01-22 10:33:16 +0800207{
208 return max_t(int, sdev->host->can_queue, 1024);
209}
210
Rob Landleyeb448202007-11-03 13:30:39 -0500211/**
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100212 * scsi_change_queue_depth - change a device's queue depth
Rob Landleyeb448202007-11-03 13:30:39 -0500213 * @sdev: SCSI Device in question
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100214 * @depth: number of commands allowed to be queued to the driver
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 *
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100216 * Sets the device queue depth and returns the new value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 */
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100218int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219{
Ming Leica445322021-01-22 10:33:16 +0800220 depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
221
Christoph Hellwig64d513a2015-10-08 09:28:04 +0100222 if (depth > 0) {
223 sdev->queue_depth = depth;
224 wmb();
Mike Christie885ace92008-07-11 19:50:32 -0500225 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Jens Axboed278d4a2016-03-30 10:21:08 -0600227 if (sdev->request_queue)
228 blk_set_queue_depth(sdev->request_queue, depth);
229
Ming Lei020b0f02021-01-22 10:33:17 +0800230 sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
231
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100232 return sdev->queue_depth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233}
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100234EXPORT_SYMBOL(scsi_change_queue_depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Rob Landleyeb448202007-11-03 13:30:39 -0500236/**
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 *
Rob Landleyeb448202007-11-03 13:30:39 -0500242 * Description: This function will track successive QUEUE_FULL events on a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 * specific SCSI device to determine if and when there is a
244 * need to adjust the queue depth on the device.
245 *
Rob Landleyeb448202007-11-03 13:30:39 -0500246 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 * -1 - Drop back to untagged operation using host->cmd_per_lun
248 * as the untagged command depth
249 *
250 * Lock Status: None held on entry
251 *
252 * Notes: Low level drivers may call this at any time and we will do
253 * "The Right Thing." We are interrupt context safe.
254 */
255int scsi_track_queue_full(struct scsi_device *sdev, int depth)
256{
Vasu Dev4a840672009-10-22 15:46:33 -0700257
258 /*
259 * Don't let QUEUE_FULLs on the same
260 * jiffies count, they could all be from
261 * same event.
262 */
263 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 return 0;
265
Vasu Dev4a840672009-10-22 15:46:33 -0700266 sdev->last_queue_full_time = jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 if (sdev->last_queue_full_depth != depth) {
268 sdev->last_queue_full_count = 1;
269 sdev->last_queue_full_depth = depth;
270 } else {
271 sdev->last_queue_full_count++;
272 }
273
274 if (sdev->last_queue_full_count <= 10)
275 return 0;
Christoph Hellwig609aa222014-10-30 11:54:58 +0100276
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100277 return scsi_change_queue_depth(sdev, depth);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279EXPORT_SYMBOL(scsi_track_queue_full);
280
281/**
Matthew Wilcox881a2562008-12-31 13:12:46 -0500282 * 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
287 *
288 * This is an internal helper function. You probably want to use
289 * scsi_get_vpd_page instead.
290 *
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100291 * Returns size of the vpd page on success or a negative error number.
Matthew Wilcox881a2562008-12-31 13:12:46 -0500292 */
293static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
294 u8 page, unsigned len)
295{
296 int result;
297 unsigned char cmd[16];
298
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100299 if (len < 4)
300 return -EINVAL;
301
Matthew Wilcox881a2562008-12-31 13:12:46 -0500302 cmd[0] = INQUIRY;
303 cmd[1] = 1; /* EVPD */
304 cmd[2] = page;
305 cmd[3] = len >> 8;
306 cmd[4] = len & 0xff;
307 cmd[5] = 0; /* Control byte */
308
309 /*
310 * I'm not convinced we need to try quite this hard to get VPD, but
311 * all the existing users tried this hard.
312 */
313 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
James Bottomley95a36392009-08-11 10:59:09 -0500314 len, NULL, 30 * HZ, 3, NULL);
Matthew Wilcox881a2562008-12-31 13:12:46 -0500315 if (result)
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100316 return -EIO;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500317
318 /* Sanity check that we got the page back that we asked for */
319 if (buffer[1] != page)
320 return -EIO;
321
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100322 return get_unaligned_be16(&buffer[2]) + 4;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500323}
324
325/**
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
Randy Dunlap786f8ba2010-02-28 17:32:45 -0800329 * @buf: where to store the VPD
330 * @buf_len: number of bytes in the VPD buffer area
Matthew Wilcox881a2562008-12-31 13:12:46 -0500331 *
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.
338 */
James Bottomleye3deec02009-11-03 12:33:07 -0600339int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
340 int buf_len)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500341{
342 int i, result;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500343
Martin K. Petersen75625232013-07-30 22:58:34 -0400344 if (sdev->skip_vpd_pages)
345 goto fail;
346
Matthew Wilcox881a2562008-12-31 13:12:46 -0500347 /* Ask for all the pages supported by this device */
James Bottomleye3deec02009-11-03 12:33:07 -0600348 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100349 if (result < 4)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500350 goto fail;
351
352 /* If the user actually wanted this page, we can skip the rest */
353 if (page == 0)
Martin K. Petersen16d3ea22010-09-10 01:20:27 -0400354 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500355
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100356 for (i = 4; i < min(result, buf_len); i++)
357 if (buf[i] == page)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500358 goto found;
James Bottomleye3deec02009-11-03 12:33:07 -0600359
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100360 if (i < result && i >= buf_len)
James Bottomleye3deec02009-11-03 12:33:07 -0600361 /* ran off the end of the buffer, give us benefit of doubt */
362 goto found;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500363 /* The device claims it doesn't support the requested page */
364 goto fail;
365
366 found:
James Bottomleye3deec02009-11-03 12:33:07 -0600367 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
Hannes Reineckebc8945d2014-03-15 09:51:48 +0100368 if (result < 0)
Matthew Wilcox881a2562008-12-31 13:12:46 -0500369 goto fail;
370
James Bottomleye3deec02009-11-03 12:33:07 -0600371 return 0;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500372
373 fail:
James Bottomleye3deec02009-11-03 12:33:07 -0600374 return -EINVAL;
Matthew Wilcox881a2562008-12-31 13:12:46 -0500375}
376EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
377
378/**
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700379 * 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
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700382 *
383 * Returns %NULL upon failure.
384 */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700385static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700386{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700387 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700388 int vpd_len = SCSI_VPD_PG_LEN, result;
389
390retry_pg:
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700391 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700392 if (!vpd_buf)
393 return NULL;
394
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700395 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700396 if (result < 0) {
397 kfree(vpd_buf);
398 return NULL;
399 }
400 if (result > vpd_len) {
401 vpd_len = result;
402 kfree(vpd_buf);
403 goto retry_pg;
404 }
405
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700406 vpd_buf->len = result;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700407
408 return vpd_buf;
409}
410
411static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700412 struct scsi_vpd __rcu **sdev_vpd_buf)
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700413{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700414 struct scsi_vpd *vpd_buf;
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700415
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700416 vpd_buf = scsi_get_vpd_buf(sdev, page);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700417 if (!vpd_buf)
418 return;
419
420 mutex_lock(&sdev->inquiry_mutex);
Paul E. McKenneyc0eaf152019-09-23 15:26:28 -0700421 vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
422 lockdep_is_held(&sdev->inquiry_mutex));
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700423 mutex_unlock(&sdev->inquiry_mutex);
424
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700425 if (vpd_buf)
426 kfree_rcu(vpd_buf, rcu);
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700427}
428
429/**
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100430 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
431 * @sdev: The device to ask
432 *
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
436 * uniquely.
437 */
438void scsi_attach_vpd(struct scsi_device *sdev)
439{
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700440 int i;
441 struct scsi_vpd *vpd_buf;
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100442
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200443 if (!scsi_device_supports_vpd(sdev))
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100444 return;
Hannes Reinecke5ddfe082016-04-01 08:57:36 +0200445
Bart Van Assche1e3f7202017-08-29 08:50:12 -0700446 /* Ask for all the pages supported by this device */
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700447 vpd_buf = scsi_get_vpd_buf(sdev, 0);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100448 if (!vpd_buf)
449 return;
450
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700451 for (i = 4; i < vpd_buf->len; i++) {
Ryan Attardd188b062019-09-26 11:22:17 -0500452 if (vpd_buf->data[i] == 0x0)
453 scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
Bart Van Asscheccf1e002017-08-29 08:50:13 -0700454 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);
Ryan Attardd188b062019-09-26 11:22:17 -0500458 if (vpd_buf->data[i] == 0x89)
459 scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100460 }
461 kfree(vpd_buf);
Hannes Reineckeb3ae8782014-03-15 09:51:49 +0100462}
463
464/**
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400465 * 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
470 *
471 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400472 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
473 * unsupported and 1 if the device claims to support the command.
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400474 */
475int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
476 unsigned int len, unsigned char opcode)
477{
478 unsigned char cmd[16];
479 struct scsi_sense_hdr sshdr;
480 int result;
481
482 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400483 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400484
485 memset(cmd, 0, 16);
486 cmd[0] = MAINTENANCE_IN;
487 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
488 cmd[2] = 1; /* One command format */
489 cmd[3] = opcode;
490 put_unaligned_be32(len, &cmd[6]);
491 memset(buffer, 0, len);
492
493 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
494 &sshdr, 30 * HZ, 3, NULL);
495
Hannes Reineckeced202f72021-04-27 10:30:12 +0200496 if (result < 0)
497 return result;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400498 if (result && scsi_sense_valid(&sshdr) &&
499 sshdr.sense_key == ILLEGAL_REQUEST &&
500 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400501 return -EINVAL;
Martin K. Petersen3c6bdae2012-09-18 12:19:30 -0400502
503 if ((buffer[1] & 3) == 3) /* Command supported */
504 return 1;
505
506 return 0;
507}
508EXPORT_SYMBOL(scsi_report_opcode);
509
510/**
Rob Landleyeb448202007-11-03 13:30:39 -0500511 * scsi_device_get - get an additional reference to a scsi_device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 * @sdev: device to get a reference to
513 *
Rob Landleyeb448202007-11-03 13:30:39 -0500514 * Description: Gets a reference to the scsi_device and increments the use count
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 * of the underlying LLDD module. You must hold host_lock of the
516 * parent Scsi_Host or already have a reference when calling this.
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100517 *
518 * This will fail if a device is deleted or cancelled, or when the LLD module
519 * is in the process of being unloaded.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 */
521int scsi_device_get(struct scsi_device *sdev)
522{
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100523 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
524 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 if (!get_device(&sdev->sdev_gendev))
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100526 goto fail;
527 if (!try_module_get(sdev->host->hostt->module))
528 goto fail_put_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 return 0;
Christoph Hellwigcff549e2015-02-02 14:01:26 +0100530
531fail_put_device:
532 put_device(&sdev->sdev_gendev);
533fail:
534 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536EXPORT_SYMBOL(scsi_device_get);
537
538/**
539 * scsi_device_put - release a reference to a scsi_device
540 * @sdev: device to release a reference on.
541 *
Rob Landleyeb448202007-11-03 13:30:39 -0500542 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 * user vanishes.
545 */
546void scsi_device_put(struct scsi_device *sdev)
547{
Ming Leif2b85042021-10-08 13:01:18 +0800548 struct module *mod = sdev->host->hostt->module;
549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 put_device(&sdev->sdev_gendev);
Ming Leif2b85042021-10-08 13:01:18 +0800551 module_put(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
553EXPORT_SYMBOL(scsi_device_put);
554
Rob Landleyeb448202007-11-03 13:30:39 -0500555/* helper for shost_for_each_device, see that for documentation */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
557 struct scsi_device *prev)
558{
559 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
560 struct scsi_device *next = NULL;
561 unsigned long flags;
562
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))
568 break;
569 next = NULL;
570 list = list->next;
571 }
572 spin_unlock_irqrestore(shost->host_lock, flags);
573
574 if (prev)
575 scsi_device_put(prev);
576 return next;
577}
578EXPORT_SYMBOL(__scsi_iterate_devices);
579
580/**
581 * starget_for_each_device - helper to walk all devices of a target
582 * @starget: target whose devices we want to iterate over.
Rob Landleyeb448202007-11-03 13:30:39 -0500583 * @data: Opaque passed to each function call.
584 * @fn: Function to call on each device
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 *
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800586 * This traverses over each device of @starget. The devices have
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 * a reference that must be released by scsi_host_put when breaking
588 * out of the loop.
589 */
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800590void starget_for_each_device(struct scsi_target *starget, void *data,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 void (*fn)(struct scsi_device *, void *))
592{
593 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
594 struct scsi_device *sdev;
595
596 shost_for_each_device(sdev, shost) {
597 if ((sdev->channel == starget->channel) &&
598 (sdev->id == starget->id))
599 fn(sdev, data);
600 }
601}
602EXPORT_SYMBOL(starget_for_each_device);
603
604/**
Randy Dunlap14f501a2008-02-03 15:06:36 -0800605 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800606 * @starget: target whose devices we want to iterate over.
Randy Dunlap14f501a2008-02-03 15:06:36 -0800607 * @data: parameter for callback @fn()
608 * @fn: callback function that is invoked for each device
Maciej W. Rozycki522939d2007-12-10 15:49:31 -0800609 *
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.
613 *
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.
617 **/
618void __starget_for_each_device(struct scsi_target *starget, void *data,
619 void (*fn)(struct scsi_device *, void *))
620{
621 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
622 struct scsi_device *sdev;
623
624 __shost_for_each_device(sdev, shost) {
625 if ((sdev->channel == starget->channel) &&
626 (sdev->id == starget->id))
627 fn(sdev, data);
628 }
629}
630EXPORT_SYMBOL(__starget_for_each_device);
631
632/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
634 * @starget: SCSI target pointer
635 * @lun: SCSI Logical Unit Number
636 *
Rob Landleyeb448202007-11-03 13:30:39 -0500637 * Description: Looks up the scsi_device with the specified @lun for a given
638 * @starget. The returned scsi_device does not have an additional
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 * reference. You must hold the host's host_lock over this call and
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100640 * any access to the returned scsi_device. A scsi_device in state
641 * SDEV_DEL is skipped.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 *
Randy Dunlapdc8875e2007-11-15 15:42:30 -0800643 * Note: The only reason why drivers should use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500644 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 * really want to use scsi_device_lookup_by_target instead.
646 **/
647struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200648 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
650 struct scsi_device *sdev;
651
652 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
Hannes Reinecke32aeef62009-01-13 16:50:37 +0100653 if (sdev->sdev_state == SDEV_DEL)
654 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (sdev->lun ==lun)
656 return sdev;
657 }
658
659 return NULL;
660}
661EXPORT_SYMBOL(__scsi_device_lookup_by_target);
662
663/**
664 * scsi_device_lookup_by_target - find a device given the target
665 * @starget: SCSI target pointer
666 * @lun: SCSI Logical Unit Number
667 *
Bartlomiej Zolnierkiewicz477e6082009-04-27 20:54:22 +0200668 * Description: Looks up the scsi_device with the specified @lun for a given
669 * @starget. The returned scsi_device has an additional reference that
Rob Landleyeb448202007-11-03 13:30:39 -0500670 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 **/
672struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200673 u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
675 struct scsi_device *sdev;
676 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
677 unsigned long flags;
678
679 spin_lock_irqsave(shost->host_lock, flags);
680 sdev = __scsi_device_lookup_by_target(starget, lun);
681 if (sdev && scsi_device_get(sdev))
682 sdev = NULL;
683 spin_unlock_irqrestore(shost->host_lock, flags);
684
685 return sdev;
686}
687EXPORT_SYMBOL(scsi_device_lookup_by_target);
688
689/**
Rob Landleyeb448202007-11-03 13:30:39 -0500690 * __scsi_device_lookup - find a device given the host (UNLOCKED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 * @shost: SCSI host pointer
692 * @channel: SCSI channel (zero if only one channel)
Rob Landleyeb448202007-11-03 13:30:39 -0500693 * @id: SCSI target number (physical unit number)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 * @lun: SCSI Logical Unit Number
695 *
Rob Landleyeb448202007-11-03 13:30:39 -0500696 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 *
701 * Note: The only reason why drivers would want to use this is because
Rob Landleyeb448202007-11-03 13:30:39 -0500702 * they need to access the device list in irq context. Otherwise you
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 * really want to use scsi_device_lookup instead.
704 **/
705struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200706 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
708 struct scsi_device *sdev;
709
710 list_for_each_entry(sdev, &shost->__devices, siblings) {
Zhou Zhengping4ff7adc2017-04-28 17:43:04 +0800711 if (sdev->sdev_state == SDEV_DEL)
712 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 if (sdev->channel == channel && sdev->id == id &&
714 sdev->lun ==lun)
715 return sdev;
716 }
717
718 return NULL;
719}
720EXPORT_SYMBOL(__scsi_device_lookup);
721
722/**
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
728 *
Rob Landleyeb448202007-11-03 13:30:39 -0500729 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 **/
733struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200734 uint channel, uint id, u64 lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
736 struct scsi_device *sdev;
737 unsigned long flags;
738
739 spin_lock_irqsave(shost->host_lock, flags);
740 sdev = __scsi_device_lookup(shost, channel, id, lun);
741 if (sdev && scsi_device_get(sdev))
742 sdev = NULL;
743 spin_unlock_irqrestore(shost->host_lock, flags);
744
745 return sdev;
746}
747EXPORT_SYMBOL(scsi_device_lookup);
748
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749MODULE_DESCRIPTION("SCSI core");
750MODULE_LICENSE("GPL");
751
752module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
753MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
754
755static int __init init_scsi(void)
756{
Jens Axboe9bf09c232006-09-30 20:31:11 +0200757 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 error = scsi_init_procfs();
760 if (error)
761 goto cleanup_queue;
762 error = scsi_init_devinfo();
763 if (error)
764 goto cleanup_procfs;
765 error = scsi_init_hosts();
766 if (error)
767 goto cleanup_devlist;
768 error = scsi_init_sysctl();
769 if (error)
770 goto cleanup_hosts;
771 error = scsi_sysfs_register();
772 if (error)
773 goto cleanup_sysctl;
774
James Smart84314fd2006-08-18 17:30:09 -0400775 scsi_netlink_init();
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 printk(KERN_NOTICE "SCSI subsystem initialized\n");
778 return 0;
779
780cleanup_sysctl:
781 scsi_exit_sysctl();
782cleanup_hosts:
783 scsi_exit_hosts();
784cleanup_devlist:
785 scsi_exit_devinfo();
786cleanup_procfs:
787 scsi_exit_procfs();
788cleanup_queue:
789 scsi_exit_queue();
790 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
791 -error);
792 return error;
793}
794
795static void __exit exit_scsi(void)
796{
James Smart84314fd2006-08-18 17:30:09 -0400797 scsi_netlink_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 scsi_sysfs_unregister();
799 scsi_exit_sysctl();
800 scsi_exit_hosts();
801 scsi_exit_devinfo();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 scsi_exit_procfs();
803 scsi_exit_queue();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
806subsys_initcall(init_scsi);
807module_exit(exit_scsi);