xref: /openbmc/linux/drivers/scsi/scsi.c (revision 7dfe0b5e)
109c434b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  *  scsi.c Copyright (C) 1992 Drew Eckhardt
41da177e4SLinus Torvalds  *         Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
51da177e4SLinus Torvalds  *         Copyright (C) 2002, 2003 Christoph Hellwig
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *  generic mid-level SCSI driver
81da177e4SLinus Torvalds  *      Initial versions: Drew Eckhardt
91da177e4SLinus Torvalds  *      Subsequent revisions: Eric Youngdale
101da177e4SLinus Torvalds  *
111da177e4SLinus Torvalds  *  <drew@colorado.edu>
121da177e4SLinus Torvalds  *
131da177e4SLinus Torvalds  *  Bug correction thanks go to :
141da177e4SLinus Torvalds  *      Rik Faith <faith@cs.unc.edu>
151da177e4SLinus Torvalds  *      Tommy Thorn <tthorn>
161da177e4SLinus Torvalds  *      Thomas Wuensche <tw@fgb1.fgb.mw.tu-muenchen.de>
171da177e4SLinus Torvalds  *
181da177e4SLinus Torvalds  *  Modified by Eric Youngdale eric@andante.org or ericy@gnu.ai.mit.edu to
191da177e4SLinus Torvalds  *  add scatter-gather, multiple outstanding request, and other
201da177e4SLinus Torvalds  *  enhancements.
211da177e4SLinus Torvalds  *
221da177e4SLinus Torvalds  *  Native multichannel, wide scsi, /proc/scsi and hot plugging
231da177e4SLinus Torvalds  *  support added by Michael Neuffer <mike@i-connect.net>
241da177e4SLinus Torvalds  *
251da177e4SLinus Torvalds  *  Added request_module("scsi_hostadapter") for kerneld:
261da177e4SLinus Torvalds  *  (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
271da177e4SLinus Torvalds  *  Bjorn Ekwall  <bj0rn@blox.se>
281da177e4SLinus Torvalds  *  (changed to kmod)
291da177e4SLinus Torvalds  *
301da177e4SLinus Torvalds  *  Major improvements to the timeout, abort, and reset processing,
311da177e4SLinus Torvalds  *  as well as performance modifications for large queue depths by
321da177e4SLinus Torvalds  *  Leonard N. Zubkoff <lnz@dandelion.com>
331da177e4SLinus Torvalds  *
341da177e4SLinus Torvalds  *  Converted cli() code to spinlocks, Ingo Molnar
351da177e4SLinus Torvalds  *
361da177e4SLinus Torvalds  *  Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
371da177e4SLinus Torvalds  *
381da177e4SLinus Torvalds  *  out_of_space hacks, D. Gilbert (dpg) 990608
391da177e4SLinus Torvalds  */
401da177e4SLinus Torvalds 
411da177e4SLinus Torvalds #include <linux/module.h>
421da177e4SLinus Torvalds #include <linux/moduleparam.h>
431da177e4SLinus Torvalds #include <linux/kernel.h>
441da177e4SLinus Torvalds #include <linux/timer.h>
451da177e4SLinus Torvalds #include <linux/string.h>
461da177e4SLinus Torvalds #include <linux/slab.h>
471da177e4SLinus Torvalds #include <linux/blkdev.h>
481da177e4SLinus Torvalds #include <linux/delay.h>
491da177e4SLinus Torvalds #include <linux/init.h>
501da177e4SLinus Torvalds #include <linux/completion.h>
511da177e4SLinus Torvalds #include <linux/unistd.h>
521da177e4SLinus Torvalds #include <linux/spinlock.h>
531da177e4SLinus Torvalds #include <linux/kmod.h>
541da177e4SLinus Torvalds #include <linux/interrupt.h>
551da177e4SLinus Torvalds #include <linux/notifier.h>
561da177e4SLinus Torvalds #include <linux/cpu.h>
570b950672SArjan van de Ven #include <linux/mutex.h>
583c6bdaeaSMartin K. Petersen #include <asm/unaligned.h>
591da177e4SLinus Torvalds 
601da177e4SLinus Torvalds #include <scsi/scsi.h>
611da177e4SLinus Torvalds #include <scsi/scsi_cmnd.h>
621da177e4SLinus Torvalds #include <scsi/scsi_dbg.h>
631da177e4SLinus Torvalds #include <scsi/scsi_device.h>
647b3d9545SLinus Torvalds #include <scsi/scsi_driver.h>
651da177e4SLinus Torvalds #include <scsi/scsi_eh.h>
661da177e4SLinus Torvalds #include <scsi/scsi_host.h>
671da177e4SLinus Torvalds #include <scsi/scsi_tcq.h>
681da177e4SLinus Torvalds 
691da177e4SLinus Torvalds #include "scsi_priv.h"
701da177e4SLinus Torvalds #include "scsi_logging.h"
711da177e4SLinus Torvalds 
72bf816235SKei Tokunaga #define CREATE_TRACE_POINTS
73bf816235SKei Tokunaga #include <trace/events/scsi.h>
74bf816235SKei Tokunaga 
751da177e4SLinus Torvalds /*
761da177e4SLinus Torvalds  * Definitions and constants.
771da177e4SLinus Torvalds  */
781da177e4SLinus Torvalds 
791da177e4SLinus Torvalds /*
801da177e4SLinus Torvalds  * Note - the initial logging level can be set here to log events at boot time.
811da177e4SLinus Torvalds  * After the system is up, you may enable logging via the /proc interface.
821da177e4SLinus Torvalds  */
831da177e4SLinus Torvalds unsigned int scsi_logging_level;
841da177e4SLinus Torvalds #if defined(CONFIG_SCSI_LOGGING)
851da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_logging_level);
861da177e4SLinus Torvalds #endif
871da177e4SLinus Torvalds 
881da177e4SLinus Torvalds #ifdef CONFIG_SCSI_LOGGING
891da177e4SLinus Torvalds void scsi_log_send(struct scsi_cmnd *cmd)
901da177e4SLinus Torvalds {
911da177e4SLinus Torvalds 	unsigned int level;
921da177e4SLinus Torvalds 
931da177e4SLinus Torvalds 	/*
941da177e4SLinus Torvalds 	 * If ML QUEUE log level is greater than or equal to:
951da177e4SLinus Torvalds 	 *
961da177e4SLinus Torvalds 	 * 1: nothing (match completion)
971da177e4SLinus Torvalds 	 *
98c11c004bSHannes Reinecke 	 * 2: log opcode + command of all commands + cmd address
991da177e4SLinus Torvalds 	 *
100c11c004bSHannes Reinecke 	 * 3: same as 2
1011da177e4SLinus Torvalds 	 *
102a4a6afb4SHannes Reinecke 	 * 4: same as 3
1031da177e4SLinus Torvalds 	 */
1041da177e4SLinus Torvalds 	if (unlikely(scsi_logging_level)) {
1051da177e4SLinus Torvalds 		level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
1061da177e4SLinus Torvalds 				       SCSI_LOG_MLQUEUE_BITS);
1071da177e4SLinus Torvalds 		if (level > 1) {
108c11c004bSHannes Reinecke 			scmd_printk(KERN_INFO, cmd,
109c11c004bSHannes Reinecke 				    "Send: scmd 0x%p\n", cmd);
1101da177e4SLinus Torvalds 			scsi_print_command(cmd);
1111da177e4SLinus Torvalds 		}
1121da177e4SLinus Torvalds 	}
1131da177e4SLinus Torvalds }
1141da177e4SLinus Torvalds 
1151da177e4SLinus Torvalds void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
1161da177e4SLinus Torvalds {
1171da177e4SLinus Torvalds 	unsigned int level;
1181da177e4SLinus Torvalds 
1191da177e4SLinus Torvalds 	/*
1201da177e4SLinus Torvalds 	 * If ML COMPLETE log level is greater than or equal to:
1211da177e4SLinus Torvalds 	 *
1221da177e4SLinus Torvalds 	 * 1: log disposition, result, opcode + command, and conditionally
1231da177e4SLinus Torvalds 	 * sense data for failures or non SUCCESS dispositions.
1241da177e4SLinus Torvalds 	 *
1251da177e4SLinus Torvalds 	 * 2: same as 1 but for all command completions.
1261da177e4SLinus Torvalds 	 *
127c11c004bSHannes Reinecke 	 * 3: same as 2
1281da177e4SLinus Torvalds 	 *
1291da177e4SLinus Torvalds 	 * 4: same as 3 plus dump extra junk
1301da177e4SLinus Torvalds 	 */
1311da177e4SLinus Torvalds 	if (unlikely(scsi_logging_level)) {
1321da177e4SLinus Torvalds 		level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
1331da177e4SLinus Torvalds 				       SCSI_LOG_MLCOMPLETE_BITS);
1341da177e4SLinus Torvalds 		if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
1351da177e4SLinus Torvalds 		    (level > 1)) {
136026f8da8SHannes Reinecke 			scsi_print_result(cmd, "Done", disposition);
1371da177e4SLinus Torvalds 			scsi_print_command(cmd);
138d0672a03SHannes Reinecke 			if (scsi_status_is_check_condition(cmd->result))
139d811b848SHannes Reinecke 				scsi_print_sense(cmd);
140a4d04a4cSMartin K. Petersen 			if (level > 3)
141a4d04a4cSMartin K. Petersen 				scmd_printk(KERN_INFO, cmd,
142a4d04a4cSMartin K. Petersen 					    "scsi host busy %d failed %d\n",
143c84b023aSMing Lei 					    scsi_host_busy(cmd->device->host),
144a4d04a4cSMartin K. Petersen 					    cmd->device->host->host_failed);
1451da177e4SLinus Torvalds 		}
1461da177e4SLinus Torvalds 	}
1471da177e4SLinus Torvalds }
1481da177e4SLinus Torvalds #endif
1491da177e4SLinus Torvalds 
150eb44820cSRob Landley /**
151eb44820cSRob Landley  * scsi_finish_command - cleanup and pass command back to upper layer
152eb44820cSRob Landley  * @cmd: the command
1531da177e4SLinus Torvalds  *
154eb44820cSRob Landley  * Description: Pass command off to upper layer for finishing of I/O
1551da177e4SLinus Torvalds  *              request, waking processes that are waiting on results,
1561da177e4SLinus Torvalds  *              etc.
1571da177e4SLinus Torvalds  */
1581da177e4SLinus Torvalds void scsi_finish_command(struct scsi_cmnd *cmd)
1591da177e4SLinus Torvalds {
1601da177e4SLinus Torvalds 	struct scsi_device *sdev = cmd->device;
161f0c0a376SMike Christie 	struct scsi_target *starget = scsi_target(sdev);
1621da177e4SLinus Torvalds 	struct Scsi_Host *shost = sdev->host;
1637b3d9545SLinus Torvalds 	struct scsi_driver *drv;
1647b3d9545SLinus Torvalds 	unsigned int good_bytes;
1651da177e4SLinus Torvalds 
1666eb045e0SMing Lei 	scsi_device_unbusy(sdev, cmd);
1671da177e4SLinus Torvalds 
1681da177e4SLinus Torvalds 	/*
169cd9070c9SChristoph Hellwig 	 * Clear the flags that say that the device/target/host is no longer
170cd9070c9SChristoph Hellwig 	 * capable of accepting new commands.
1711da177e4SLinus Torvalds 	 */
172cd9070c9SChristoph Hellwig 	if (atomic_read(&shost->host_blocked))
173cd9070c9SChristoph Hellwig 		atomic_set(&shost->host_blocked, 0);
174cd9070c9SChristoph Hellwig 	if (atomic_read(&starget->target_blocked))
175cd9070c9SChristoph Hellwig 		atomic_set(&starget->target_blocked, 0);
176cd9070c9SChristoph Hellwig 	if (atomic_read(&sdev->device_blocked))
177cd9070c9SChristoph Hellwig 		atomic_set(&sdev->device_blocked, 0);
1781da177e4SLinus Torvalds 
1793bf743e7SJeff Garzik 	SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
1803bf743e7SJeff Garzik 				"Notifying upper driver of completion "
1813bf743e7SJeff Garzik 				"(result %x)\n", cmd->result));
1821da177e4SLinus Torvalds 
183f18573abSFUJITA Tomonori 	good_bytes = scsi_bufflen(cmd);
184aa8e25e5SBart Van Assche 	if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
185427e59f0SJames Bottomley 		int old_good_bytes = good_bytes;
1867b3d9545SLinus Torvalds 		drv = scsi_cmd_to_driver(cmd);
1877b3d9545SLinus Torvalds 		if (drv->done)
1887b3d9545SLinus Torvalds 			good_bytes = drv->done(cmd);
189427e59f0SJames Bottomley 		/*
190427e59f0SJames Bottomley 		 * USB may not give sense identifying bad sector and
191427e59f0SJames Bottomley 		 * simply return a residue instead, so subtract off the
192427e59f0SJames Bottomley 		 * residue if drv->done() error processing indicates no
193427e59f0SJames Bottomley 		 * change to the completion length.
194427e59f0SJames Bottomley 		 */
195427e59f0SJames Bottomley 		if (good_bytes == old_good_bytes)
196427e59f0SJames Bottomley 			good_bytes -= scsi_get_resid(cmd);
1977b3d9545SLinus Torvalds 	}
1987b3d9545SLinus Torvalds 	scsi_io_completion(cmd, good_bytes);
1991da177e4SLinus Torvalds }
2001da177e4SLinus Torvalds 
201ca445321SMing Lei 
202ca445321SMing Lei /*
203f9bdac31SSumit Saxena  * 4096 is big enough for saturating fast SCSI LUNs.
204ca445321SMing Lei  */
205020b0f0aSMing Lei int scsi_device_max_queue_depth(struct scsi_device *sdev)
206ca445321SMing Lei {
207f9bdac31SSumit Saxena 	return min_t(int, sdev->host->can_queue, 4096);
208ca445321SMing Lei }
209ca445321SMing Lei 
210eb44820cSRob Landley /**
211db5ed4dfSChristoph Hellwig  * scsi_change_queue_depth - change a device's queue depth
212eb44820cSRob Landley  * @sdev: SCSI Device in question
213db5ed4dfSChristoph Hellwig  * @depth: number of commands allowed to be queued to the driver
2141da177e4SLinus Torvalds  *
215db5ed4dfSChristoph Hellwig  * Sets the device queue depth and returns the new value.
2161da177e4SLinus Torvalds  */
217db5ed4dfSChristoph Hellwig int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
2181da177e4SLinus Torvalds {
219ca445321SMing Lei 	depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
220ca445321SMing Lei 
22164d513acSChristoph Hellwig 	if (depth > 0) {
22264d513acSChristoph Hellwig 		sdev->queue_depth = depth;
22364d513acSChristoph Hellwig 		wmb();
224885ace9eSMike Christie 	}
2251da177e4SLinus Torvalds 
226d278d4a8SJens Axboe 	if (sdev->request_queue)
227d278d4a8SJens Axboe 		blk_set_queue_depth(sdev->request_queue, depth);
228d278d4a8SJens Axboe 
229020b0f0aSMing Lei 	sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
230020b0f0aSMing Lei 
231db5ed4dfSChristoph Hellwig 	return sdev->queue_depth;
2321da177e4SLinus Torvalds }
233db5ed4dfSChristoph Hellwig EXPORT_SYMBOL(scsi_change_queue_depth);
2341da177e4SLinus Torvalds 
235eb44820cSRob Landley /**
236eb44820cSRob Landley  * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
237eb44820cSRob Landley  * @sdev: SCSI Device in question
238eb44820cSRob Landley  * @depth: Current number of outstanding SCSI commands on this device,
239eb44820cSRob Landley  *         not counting the one returned as QUEUE_FULL.
2401da177e4SLinus Torvalds  *
241eb44820cSRob Landley  * Description:	This function will track successive QUEUE_FULL events on a
2421da177e4SLinus Torvalds  * 		specific SCSI device to determine if and when there is a
2431da177e4SLinus Torvalds  * 		need to adjust the queue depth on the device.
2441da177e4SLinus Torvalds  *
245eb44820cSRob Landley  * Returns:	0 - No change needed, >0 - Adjust queue depth to this new depth,
2461da177e4SLinus Torvalds  * 		-1 - Drop back to untagged operation using host->cmd_per_lun
2471da177e4SLinus Torvalds  * 			as the untagged command depth
2481da177e4SLinus Torvalds  *
2491da177e4SLinus Torvalds  * Lock Status:	None held on entry
2501da177e4SLinus Torvalds  *
2511da177e4SLinus Torvalds  * Notes:	Low level drivers may call this at any time and we will do
2521da177e4SLinus Torvalds  * 		"The Right Thing."  We are interrupt context safe.
2531da177e4SLinus Torvalds  */
2541da177e4SLinus Torvalds int scsi_track_queue_full(struct scsi_device *sdev, int depth)
2551da177e4SLinus Torvalds {
2564a84067dSVasu Dev 
2574a84067dSVasu Dev 	/*
2584a84067dSVasu Dev 	 * Don't let QUEUE_FULLs on the same
2594a84067dSVasu Dev 	 * jiffies count, they could all be from
2604a84067dSVasu Dev 	 * same event.
2614a84067dSVasu Dev 	 */
2624a84067dSVasu Dev 	if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
2631da177e4SLinus Torvalds 		return 0;
2641da177e4SLinus Torvalds 
2654a84067dSVasu Dev 	sdev->last_queue_full_time = jiffies;
2661da177e4SLinus Torvalds 	if (sdev->last_queue_full_depth != depth) {
2671da177e4SLinus Torvalds 		sdev->last_queue_full_count = 1;
2681da177e4SLinus Torvalds 		sdev->last_queue_full_depth = depth;
2691da177e4SLinus Torvalds 	} else {
2701da177e4SLinus Torvalds 		sdev->last_queue_full_count++;
2711da177e4SLinus Torvalds 	}
2721da177e4SLinus Torvalds 
2731da177e4SLinus Torvalds 	if (sdev->last_queue_full_count <= 10)
2741da177e4SLinus Torvalds 		return 0;
2751da177e4SLinus Torvalds 
276db5ed4dfSChristoph Hellwig 	return scsi_change_queue_depth(sdev, depth);
2771da177e4SLinus Torvalds }
2781da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_track_queue_full);
2791da177e4SLinus Torvalds 
2801da177e4SLinus Torvalds /**
281881a256dSMatthew Wilcox  * scsi_vpd_inquiry - Request a device provide us with a VPD page
282881a256dSMatthew Wilcox  * @sdev: The device to ask
283881a256dSMatthew Wilcox  * @buffer: Where to put the result
284881a256dSMatthew Wilcox  * @page: Which Vital Product Data to return
285881a256dSMatthew Wilcox  * @len: The length of the buffer
286881a256dSMatthew Wilcox  *
287881a256dSMatthew Wilcox  * This is an internal helper function.  You probably want to use
288881a256dSMatthew Wilcox  * scsi_get_vpd_page instead.
289881a256dSMatthew Wilcox  *
290bc8945dfSHannes Reinecke  * Returns size of the vpd page on success or a negative error number.
291881a256dSMatthew Wilcox  */
292881a256dSMatthew Wilcox static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
293881a256dSMatthew Wilcox 							u8 page, unsigned len)
294881a256dSMatthew Wilcox {
295881a256dSMatthew Wilcox 	int result;
296881a256dSMatthew Wilcox 	unsigned char cmd[16];
297881a256dSMatthew Wilcox 
298bc8945dfSHannes Reinecke 	if (len < 4)
299bc8945dfSHannes Reinecke 		return -EINVAL;
300bc8945dfSHannes Reinecke 
301881a256dSMatthew Wilcox 	cmd[0] = INQUIRY;
302881a256dSMatthew Wilcox 	cmd[1] = 1;		/* EVPD */
303881a256dSMatthew Wilcox 	cmd[2] = page;
304881a256dSMatthew Wilcox 	cmd[3] = len >> 8;
305881a256dSMatthew Wilcox 	cmd[4] = len & 0xff;
306881a256dSMatthew Wilcox 	cmd[5] = 0;		/* Control byte */
307881a256dSMatthew Wilcox 
308881a256dSMatthew Wilcox 	/*
309881a256dSMatthew Wilcox 	 * I'm not convinced we need to try quite this hard to get VPD, but
310881a256dSMatthew Wilcox 	 * all the existing users tried this hard.
311881a256dSMatthew Wilcox 	 */
312*7dfe0b5eSMike Christie 	result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buffer, len,
313*7dfe0b5eSMike Christie 				  30 * HZ, 3, NULL);
314881a256dSMatthew Wilcox 	if (result)
315bc8945dfSHannes Reinecke 		return -EIO;
316881a256dSMatthew Wilcox 
317881a256dSMatthew Wilcox 	/* Sanity check that we got the page back that we asked for */
318881a256dSMatthew Wilcox 	if (buffer[1] != page)
319881a256dSMatthew Wilcox 		return -EIO;
320881a256dSMatthew Wilcox 
321bc8945dfSHannes Reinecke 	return get_unaligned_be16(&buffer[2]) + 4;
322881a256dSMatthew Wilcox }
323881a256dSMatthew Wilcox 
324c92a6b5dSMartin K. Petersen static int scsi_get_vpd_size(struct scsi_device *sdev, u8 page)
325c92a6b5dSMartin K. Petersen {
326c92a6b5dSMartin K. Petersen 	unsigned char vpd_header[SCSI_VPD_HEADER_SIZE] __aligned(4);
327c92a6b5dSMartin K. Petersen 	int result;
328c92a6b5dSMartin K. Petersen 
329c92a6b5dSMartin K. Petersen 	/*
330c92a6b5dSMartin K. Petersen 	 * Fetch the VPD page header to find out how big the page
331c92a6b5dSMartin K. Petersen 	 * is. This is done to prevent problems on legacy devices
332c92a6b5dSMartin K. Petersen 	 * which can not handle allocation lengths as large as
333c92a6b5dSMartin K. Petersen 	 * potentially requested by the caller.
334c92a6b5dSMartin K. Petersen 	 */
335c92a6b5dSMartin K. Petersen 	result = scsi_vpd_inquiry(sdev, vpd_header, page, sizeof(vpd_header));
336c92a6b5dSMartin K. Petersen 	if (result < 0)
337c92a6b5dSMartin K. Petersen 		return 0;
338c92a6b5dSMartin K. Petersen 
339c92a6b5dSMartin K. Petersen 	if (result < SCSI_VPD_HEADER_SIZE) {
340c92a6b5dSMartin K. Petersen 		dev_warn_once(&sdev->sdev_gendev,
341c92a6b5dSMartin K. Petersen 			      "%s: short VPD page 0x%02x length: %d bytes\n",
342c92a6b5dSMartin K. Petersen 			      __func__, page, result);
343c92a6b5dSMartin K. Petersen 		return 0;
344c92a6b5dSMartin K. Petersen 	}
345c92a6b5dSMartin K. Petersen 
346c92a6b5dSMartin K. Petersen 	return result;
347c92a6b5dSMartin K. Petersen }
348c92a6b5dSMartin K. Petersen 
349881a256dSMatthew Wilcox /**
350881a256dSMatthew Wilcox  * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
351881a256dSMatthew Wilcox  * @sdev: The device to ask
352881a256dSMatthew Wilcox  * @page: Which Vital Product Data to return
353786f8ba2SRandy Dunlap  * @buf: where to store the VPD
354786f8ba2SRandy Dunlap  * @buf_len: number of bytes in the VPD buffer area
355881a256dSMatthew Wilcox  *
356881a256dSMatthew Wilcox  * SCSI devices may optionally supply Vital Product Data.  Each 'page'
357881a256dSMatthew Wilcox  * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
358c92a6b5dSMartin K. Petersen  * If the device supports this VPD page, this routine fills @buf
359c92a6b5dSMartin K. Petersen  * with the data from that page and return 0. If the VPD page is not
360c92a6b5dSMartin K. Petersen  * supported or its content cannot be retrieved, -EINVAL is returned.
361881a256dSMatthew Wilcox  */
362e3deec09SJames Bottomley int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
363e3deec09SJames Bottomley 		      int buf_len)
364881a256dSMatthew Wilcox {
365c92a6b5dSMartin K. Petersen 	int result, vpd_len;
366881a256dSMatthew Wilcox 
367c92a6b5dSMartin K. Petersen 	if (!scsi_device_supports_vpd(sdev))
368e3deec09SJames Bottomley 		return -EINVAL;
369c92a6b5dSMartin K. Petersen 
370c92a6b5dSMartin K. Petersen 	vpd_len = scsi_get_vpd_size(sdev, page);
371c92a6b5dSMartin K. Petersen 	if (vpd_len <= 0)
372c92a6b5dSMartin K. Petersen 		return -EINVAL;
373c92a6b5dSMartin K. Petersen 
374c92a6b5dSMartin K. Petersen 	vpd_len = min(vpd_len, buf_len);
375c92a6b5dSMartin K. Petersen 
376c92a6b5dSMartin K. Petersen 	/*
377c92a6b5dSMartin K. Petersen 	 * Fetch the actual page. Since the appropriate size was reported
378c92a6b5dSMartin K. Petersen 	 * by the device it is now safe to ask for something bigger.
379c92a6b5dSMartin K. Petersen 	 */
380c92a6b5dSMartin K. Petersen 	memset(buf, 0, buf_len);
381c92a6b5dSMartin K. Petersen 	result = scsi_vpd_inquiry(sdev, buf, page, vpd_len);
382c92a6b5dSMartin K. Petersen 	if (result < 0)
383c92a6b5dSMartin K. Petersen 		return -EINVAL;
384c92a6b5dSMartin K. Petersen 	else if (result > vpd_len)
385c92a6b5dSMartin K. Petersen 		dev_warn_once(&sdev->sdev_gendev,
386c92a6b5dSMartin K. Petersen 			      "%s: VPD page 0x%02x result %d > %d bytes\n",
387c92a6b5dSMartin K. Petersen 			      __func__, page, result, vpd_len);
388c92a6b5dSMartin K. Petersen 
389c92a6b5dSMartin K. Petersen 	return 0;
390881a256dSMatthew Wilcox }
391881a256dSMatthew Wilcox EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
392881a256dSMatthew Wilcox 
393881a256dSMatthew Wilcox /**
3941e3f720aSBart Van Assche  * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
3951e3f720aSBart Van Assche  * @sdev: The device to ask
3961e3f720aSBart Van Assche  * @page: Which Vital Product Data to return
3971e3f720aSBart Van Assche  *
3981e3f720aSBart Van Assche  * Returns %NULL upon failure.
3991e3f720aSBart Van Assche  */
400ccf1e004SBart Van Assche static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
4011e3f720aSBart Van Assche {
402ccf1e004SBart Van Assche 	struct scsi_vpd *vpd_buf;
403c92a6b5dSMartin K. Petersen 	int vpd_len, result;
404c92a6b5dSMartin K. Petersen 
405c92a6b5dSMartin K. Petersen 	vpd_len = scsi_get_vpd_size(sdev, page);
406c92a6b5dSMartin K. Petersen 	if (vpd_len <= 0)
407c92a6b5dSMartin K. Petersen 		return NULL;
4081e3f720aSBart Van Assche 
4091e3f720aSBart Van Assche retry_pg:
410c92a6b5dSMartin K. Petersen 	/*
411c92a6b5dSMartin K. Petersen 	 * Fetch the actual page. Since the appropriate size was reported
412c92a6b5dSMartin K. Petersen 	 * by the device it is now safe to ask for something bigger.
413c92a6b5dSMartin K. Petersen 	 */
414ccf1e004SBart Van Assche 	vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
4151e3f720aSBart Van Assche 	if (!vpd_buf)
4161e3f720aSBart Van Assche 		return NULL;
4171e3f720aSBart Van Assche 
418ccf1e004SBart Van Assche 	result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
4191e3f720aSBart Van Assche 	if (result < 0) {
4201e3f720aSBart Van Assche 		kfree(vpd_buf);
4211e3f720aSBart Van Assche 		return NULL;
4221e3f720aSBart Van Assche 	}
4231e3f720aSBart Van Assche 	if (result > vpd_len) {
424c92a6b5dSMartin K. Petersen 		dev_warn_once(&sdev->sdev_gendev,
425c92a6b5dSMartin K. Petersen 			      "%s: VPD page 0x%02x result %d > %d bytes\n",
426c92a6b5dSMartin K. Petersen 			      __func__, page, result, vpd_len);
4271e3f720aSBart Van Assche 		vpd_len = result;
4281e3f720aSBart Van Assche 		kfree(vpd_buf);
4291e3f720aSBart Van Assche 		goto retry_pg;
4301e3f720aSBart Van Assche 	}
4311e3f720aSBart Van Assche 
432ccf1e004SBart Van Assche 	vpd_buf->len = result;
4331e3f720aSBart Van Assche 
4341e3f720aSBart Van Assche 	return vpd_buf;
4351e3f720aSBart Van Assche }
4361e3f720aSBart Van Assche 
4371e3f720aSBart Van Assche static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
438ccf1e004SBart Van Assche 				 struct scsi_vpd __rcu **sdev_vpd_buf)
4391e3f720aSBart Van Assche {
440ccf1e004SBart Van Assche 	struct scsi_vpd *vpd_buf;
4411e3f720aSBart Van Assche 
442ccf1e004SBart Van Assche 	vpd_buf = scsi_get_vpd_buf(sdev, page);
4431e3f720aSBart Van Assche 	if (!vpd_buf)
4441e3f720aSBart Van Assche 		return;
4451e3f720aSBart Van Assche 
4461e3f720aSBart Van Assche 	mutex_lock(&sdev->inquiry_mutex);
447c0eaf15cSPaul E. McKenney 	vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
4481e3f720aSBart Van Assche 				      lockdep_is_held(&sdev->inquiry_mutex));
4491e3f720aSBart Van Assche 	mutex_unlock(&sdev->inquiry_mutex);
4501e3f720aSBart Van Assche 
451ccf1e004SBart Van Assche 	if (vpd_buf)
452ccf1e004SBart Van Assche 		kfree_rcu(vpd_buf, rcu);
4531e3f720aSBart Van Assche }
4541e3f720aSBart Van Assche 
4551e3f720aSBart Van Assche /**
456b3ae8780SHannes Reinecke  * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
457b3ae8780SHannes Reinecke  * @sdev: The device to ask
458b3ae8780SHannes Reinecke  *
459b3ae8780SHannes Reinecke  * Attach the 'Device Identification' VPD page (0x83) and the
460b3ae8780SHannes Reinecke  * 'Unit Serial Number' VPD page (0x80) to a SCSI device
461b3ae8780SHannes Reinecke  * structure. This information can be used to identify the device
462b3ae8780SHannes Reinecke  * uniquely.
463b3ae8780SHannes Reinecke  */
464b3ae8780SHannes Reinecke void scsi_attach_vpd(struct scsi_device *sdev)
465b3ae8780SHannes Reinecke {
466ccf1e004SBart Van Assche 	int i;
467ccf1e004SBart Van Assche 	struct scsi_vpd *vpd_buf;
468b3ae8780SHannes Reinecke 
4695ddfe085SHannes Reinecke 	if (!scsi_device_supports_vpd(sdev))
470b3ae8780SHannes Reinecke 		return;
4715ddfe085SHannes Reinecke 
472b3ae8780SHannes Reinecke 	/* Ask for all the pages supported by this device */
473ccf1e004SBart Van Assche 	vpd_buf = scsi_get_vpd_buf(sdev, 0);
4741e3f720aSBart Van Assche 	if (!vpd_buf)
475b3ae8780SHannes Reinecke 		return;
476b3ae8780SHannes Reinecke 
477ccf1e004SBart Van Assche 	for (i = 4; i < vpd_buf->len; i++) {
478d188b067SRyan Attard 		if (vpd_buf->data[i] == 0x0)
479d188b067SRyan Attard 			scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
480ccf1e004SBart Van Assche 		if (vpd_buf->data[i] == 0x80)
481ccf1e004SBart Van Assche 			scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
482ccf1e004SBart Van Assche 		if (vpd_buf->data[i] == 0x83)
483ccf1e004SBart Van Assche 			scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
484d188b067SRyan Attard 		if (vpd_buf->data[i] == 0x89)
485d188b067SRyan Attard 			scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
486e60ac0b9SMartin K. Petersen 		if (vpd_buf->data[i] == 0xb0)
487e60ac0b9SMartin K. Petersen 			scsi_update_vpd_page(sdev, 0xb0, &sdev->vpd_pgb0);
488e60ac0b9SMartin K. Petersen 		if (vpd_buf->data[i] == 0xb1)
489e60ac0b9SMartin K. Petersen 			scsi_update_vpd_page(sdev, 0xb1, &sdev->vpd_pgb1);
490e60ac0b9SMartin K. Petersen 		if (vpd_buf->data[i] == 0xb2)
491e60ac0b9SMartin K. Petersen 			scsi_update_vpd_page(sdev, 0xb2, &sdev->vpd_pgb2);
492b3ae8780SHannes Reinecke 	}
493b3ae8780SHannes Reinecke 	kfree(vpd_buf);
494b3ae8780SHannes Reinecke }
495b3ae8780SHannes Reinecke 
496b3ae8780SHannes Reinecke /**
4973c6bdaeaSMartin K. Petersen  * scsi_report_opcode - Find out if a given command opcode is supported
4983c6bdaeaSMartin K. Petersen  * @sdev:	scsi device to query
4993c6bdaeaSMartin K. Petersen  * @buffer:	scratch buffer (must be at least 20 bytes long)
5003c6bdaeaSMartin K. Petersen  * @len:	length of buffer
5013c6bdaeaSMartin K. Petersen  * @opcode:	opcode for command to look up
5023c6bdaeaSMartin K. Petersen  *
5033c6bdaeaSMartin K. Petersen  * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
50466c28f97SMartin K. Petersen  * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
50566c28f97SMartin K. Petersen  * unsupported and 1 if the device claims to support the command.
5063c6bdaeaSMartin K. Petersen  */
5073c6bdaeaSMartin K. Petersen int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
5083c6bdaeaSMartin K. Petersen 		       unsigned int len, unsigned char opcode)
5093c6bdaeaSMartin K. Petersen {
5103c6bdaeaSMartin K. Petersen 	unsigned char cmd[16];
5113c6bdaeaSMartin K. Petersen 	struct scsi_sense_hdr sshdr;
512e17d6340SMartin K. Petersen 	int result, request_len;
513*7dfe0b5eSMike Christie 	const struct scsi_exec_args exec_args = {
514*7dfe0b5eSMike Christie 		.sshdr = &sshdr,
515*7dfe0b5eSMike Christie 	};
5163c6bdaeaSMartin K. Petersen 
5173c6bdaeaSMartin K. Petersen 	if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
51866c28f97SMartin K. Petersen 		return -EINVAL;
5193c6bdaeaSMartin K. Petersen 
520e17d6340SMartin K. Petersen 	/* RSOC header + size of command we are asking about */
521e17d6340SMartin K. Petersen 	request_len = 4 + COMMAND_SIZE(opcode);
522e17d6340SMartin K. Petersen 	if (request_len > len) {
523e17d6340SMartin K. Petersen 		dev_warn_once(&sdev->sdev_gendev,
524e17d6340SMartin K. Petersen 			      "%s: len %u bytes, opcode 0x%02x needs %u\n",
525e17d6340SMartin K. Petersen 			      __func__, len, opcode, request_len);
526e17d6340SMartin K. Petersen 		return -EINVAL;
527e17d6340SMartin K. Petersen 	}
528e17d6340SMartin K. Petersen 
5293c6bdaeaSMartin K. Petersen 	memset(cmd, 0, 16);
5303c6bdaeaSMartin K. Petersen 	cmd[0] = MAINTENANCE_IN;
5313c6bdaeaSMartin K. Petersen 	cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
5323c6bdaeaSMartin K. Petersen 	cmd[2] = 1;		/* One command format */
5333c6bdaeaSMartin K. Petersen 	cmd[3] = opcode;
534e17d6340SMartin K. Petersen 	put_unaligned_be32(request_len, &cmd[6]);
5353c6bdaeaSMartin K. Petersen 	memset(buffer, 0, len);
5363c6bdaeaSMartin K. Petersen 
537*7dfe0b5eSMike Christie 	result = scsi_execute_cmd(sdev, cmd, REQ_OP_DRV_IN, buffer,
538*7dfe0b5eSMike Christie 				  request_len, 30 * HZ, 3, &exec_args);
539ced202f7SHannes Reinecke 	if (result < 0)
540ced202f7SHannes Reinecke 		return result;
5413c6bdaeaSMartin K. Petersen 	if (result && scsi_sense_valid(&sshdr) &&
5423c6bdaeaSMartin K. Petersen 	    sshdr.sense_key == ILLEGAL_REQUEST &&
5433c6bdaeaSMartin K. Petersen 	    (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
54466c28f97SMartin K. Petersen 		return -EINVAL;
5453c6bdaeaSMartin K. Petersen 
5463c6bdaeaSMartin K. Petersen 	if ((buffer[1] & 3) == 3) /* Command supported */
5473c6bdaeaSMartin K. Petersen 		return 1;
5483c6bdaeaSMartin K. Petersen 
5493c6bdaeaSMartin K. Petersen 	return 0;
5503c6bdaeaSMartin K. Petersen }
5513c6bdaeaSMartin K. Petersen EXPORT_SYMBOL(scsi_report_opcode);
5523c6bdaeaSMartin K. Petersen 
5533c6bdaeaSMartin K. Petersen /**
554eb44820cSRob Landley  * scsi_device_get  -  get an additional reference to a scsi_device
5551da177e4SLinus Torvalds  * @sdev:	device to get a reference to
5561da177e4SLinus Torvalds  *
557eb44820cSRob Landley  * Description: Gets a reference to the scsi_device and increments the use count
5581da177e4SLinus Torvalds  * of the underlying LLDD module.  You must hold host_lock of the
5591da177e4SLinus Torvalds  * parent Scsi_Host or already have a reference when calling this.
560cff549e4SChristoph Hellwig  *
561cff549e4SChristoph Hellwig  * This will fail if a device is deleted or cancelled, or when the LLD module
562cff549e4SChristoph Hellwig  * is in the process of being unloaded.
5631da177e4SLinus Torvalds  */
5641da177e4SLinus Torvalds int scsi_device_get(struct scsi_device *sdev)
5651da177e4SLinus Torvalds {
566cff549e4SChristoph Hellwig 	if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
567cff549e4SChristoph Hellwig 		goto fail;
568cff549e4SChristoph Hellwig 	if (!try_module_get(sdev->host->hostt->module))
569195fae20SBart Van Assche 		goto fail;
570195fae20SBart Van Assche 	if (!get_device(&sdev->sdev_gendev))
571195fae20SBart Van Assche 		goto fail_put_module;
5721da177e4SLinus Torvalds 	return 0;
573cff549e4SChristoph Hellwig 
574195fae20SBart Van Assche fail_put_module:
575195fae20SBart Van Assche 	module_put(sdev->host->hostt->module);
576cff549e4SChristoph Hellwig fail:
577cff549e4SChristoph Hellwig 	return -ENXIO;
5781da177e4SLinus Torvalds }
5791da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_device_get);
5801da177e4SLinus Torvalds 
5811da177e4SLinus Torvalds /**
5821da177e4SLinus Torvalds  * scsi_device_put  -  release a reference to a scsi_device
5831da177e4SLinus Torvalds  * @sdev:	device to release a reference on.
5841da177e4SLinus Torvalds  *
585eb44820cSRob Landley  * Description: Release a reference to the scsi_device and decrements the use
586eb44820cSRob Landley  * count of the underlying LLDD module.  The device is freed once the last
5871da177e4SLinus Torvalds  * user vanishes.
5881da177e4SLinus Torvalds  */
5891da177e4SLinus Torvalds void scsi_device_put(struct scsi_device *sdev)
5901da177e4SLinus Torvalds {
59170e8d057SBart Van Assche 	struct module *mod = sdev->host->hostt->module;
59270e8d057SBart Van Assche 
593f93ed747SBart Van Assche 	might_sleep();
594f93ed747SBart Van Assche 
5951da177e4SLinus Torvalds 	put_device(&sdev->sdev_gendev);
59670e8d057SBart Van Assche 	module_put(mod);
5971da177e4SLinus Torvalds }
5981da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_device_put);
5991da177e4SLinus Torvalds 
600eb44820cSRob Landley /* helper for shost_for_each_device, see that for documentation */
6011da177e4SLinus Torvalds struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
6021da177e4SLinus Torvalds 					   struct scsi_device *prev)
6031da177e4SLinus Torvalds {
6041da177e4SLinus Torvalds 	struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
6051da177e4SLinus Torvalds 	struct scsi_device *next = NULL;
6061da177e4SLinus Torvalds 	unsigned long flags;
6071da177e4SLinus Torvalds 
6081da177e4SLinus Torvalds 	spin_lock_irqsave(shost->host_lock, flags);
6091da177e4SLinus Torvalds 	while (list->next != &shost->__devices) {
6101da177e4SLinus Torvalds 		next = list_entry(list->next, struct scsi_device, siblings);
6111da177e4SLinus Torvalds 		/* skip devices that we can't get a reference to */
6121da177e4SLinus Torvalds 		if (!scsi_device_get(next))
6131da177e4SLinus Torvalds 			break;
6141da177e4SLinus Torvalds 		next = NULL;
6151da177e4SLinus Torvalds 		list = list->next;
6161da177e4SLinus Torvalds 	}
6171da177e4SLinus Torvalds 	spin_unlock_irqrestore(shost->host_lock, flags);
6181da177e4SLinus Torvalds 
6191da177e4SLinus Torvalds 	if (prev)
6201da177e4SLinus Torvalds 		scsi_device_put(prev);
6211da177e4SLinus Torvalds 	return next;
6221da177e4SLinus Torvalds }
6231da177e4SLinus Torvalds EXPORT_SYMBOL(__scsi_iterate_devices);
6241da177e4SLinus Torvalds 
6251da177e4SLinus Torvalds /**
6261da177e4SLinus Torvalds  * starget_for_each_device  -  helper to walk all devices of a target
6271da177e4SLinus Torvalds  * @starget:	target whose devices we want to iterate over.
628eb44820cSRob Landley  * @data:	Opaque passed to each function call.
629eb44820cSRob Landley  * @fn:		Function to call on each device
6301da177e4SLinus Torvalds  *
631522939d4SMaciej W. Rozycki  * This traverses over each device of @starget.  The devices have
6321da177e4SLinus Torvalds  * a reference that must be released by scsi_host_put when breaking
6331da177e4SLinus Torvalds  * out of the loop.
6341da177e4SLinus Torvalds  */
6351da177e4SLinus Torvalds void starget_for_each_device(struct scsi_target *starget, void *data,
6361da177e4SLinus Torvalds 		     void (*fn)(struct scsi_device *, void *))
6371da177e4SLinus Torvalds {
6381da177e4SLinus Torvalds 	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
6391da177e4SLinus Torvalds 	struct scsi_device *sdev;
6401da177e4SLinus Torvalds 
6411da177e4SLinus Torvalds 	shost_for_each_device(sdev, shost) {
6421da177e4SLinus Torvalds 		if ((sdev->channel == starget->channel) &&
6431da177e4SLinus Torvalds 		    (sdev->id == starget->id))
6441da177e4SLinus Torvalds 			fn(sdev, data);
6451da177e4SLinus Torvalds 	}
6461da177e4SLinus Torvalds }
6471da177e4SLinus Torvalds EXPORT_SYMBOL(starget_for_each_device);
6481da177e4SLinus Torvalds 
6491da177e4SLinus Torvalds /**
65014f501a4SRandy Dunlap  * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
651522939d4SMaciej W. Rozycki  * @starget:	target whose devices we want to iterate over.
65214f501a4SRandy Dunlap  * @data:	parameter for callback @fn()
65314f501a4SRandy Dunlap  * @fn:		callback function that is invoked for each device
654522939d4SMaciej W. Rozycki  *
655522939d4SMaciej W. Rozycki  * This traverses over each device of @starget.  It does _not_
656522939d4SMaciej W. Rozycki  * take a reference on the scsi_device, so the whole loop must be
657522939d4SMaciej W. Rozycki  * protected by shost->host_lock.
658522939d4SMaciej W. Rozycki  *
659522939d4SMaciej W. Rozycki  * Note:  The only reason why drivers would want to use this is because
660522939d4SMaciej W. Rozycki  * they need to access the device list in irq context.  Otherwise you
661522939d4SMaciej W. Rozycki  * really want to use starget_for_each_device instead.
662522939d4SMaciej W. Rozycki  **/
663522939d4SMaciej W. Rozycki void __starget_for_each_device(struct scsi_target *starget, void *data,
664522939d4SMaciej W. Rozycki 			       void (*fn)(struct scsi_device *, void *))
665522939d4SMaciej W. Rozycki {
666522939d4SMaciej W. Rozycki 	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
667522939d4SMaciej W. Rozycki 	struct scsi_device *sdev;
668522939d4SMaciej W. Rozycki 
669522939d4SMaciej W. Rozycki 	__shost_for_each_device(sdev, shost) {
670522939d4SMaciej W. Rozycki 		if ((sdev->channel == starget->channel) &&
671522939d4SMaciej W. Rozycki 		    (sdev->id == starget->id))
672522939d4SMaciej W. Rozycki 			fn(sdev, data);
673522939d4SMaciej W. Rozycki 	}
674522939d4SMaciej W. Rozycki }
675522939d4SMaciej W. Rozycki EXPORT_SYMBOL(__starget_for_each_device);
676522939d4SMaciej W. Rozycki 
677522939d4SMaciej W. Rozycki /**
6781da177e4SLinus Torvalds  * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
6791da177e4SLinus Torvalds  * @starget:	SCSI target pointer
6801da177e4SLinus Torvalds  * @lun:	SCSI Logical Unit Number
6811da177e4SLinus Torvalds  *
682eb44820cSRob Landley  * Description: Looks up the scsi_device with the specified @lun for a given
6831da177e4SLinus Torvalds  * @starget.  The returned scsi_device does not have an additional
6841da177e4SLinus Torvalds  * reference.  You must hold the host's host_lock over this call and
68532aeef60SHannes Reinecke  * any access to the returned scsi_device. A scsi_device in state
68632aeef60SHannes Reinecke  * SDEV_DEL is skipped.
6871da177e4SLinus Torvalds  *
688dc8875e1SRandy Dunlap  * Note:  The only reason why drivers should use this is because
689eb44820cSRob Landley  * they need to access the device list in irq context.  Otherwise you
6901da177e4SLinus Torvalds  * really want to use scsi_device_lookup_by_target instead.
6911da177e4SLinus Torvalds  **/
6921da177e4SLinus Torvalds struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
6939cb78c16SHannes Reinecke 						   u64 lun)
6941da177e4SLinus Torvalds {
6951da177e4SLinus Torvalds 	struct scsi_device *sdev;
6961da177e4SLinus Torvalds 
6971da177e4SLinus Torvalds 	list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
69832aeef60SHannes Reinecke 		if (sdev->sdev_state == SDEV_DEL)
69932aeef60SHannes Reinecke 			continue;
7001da177e4SLinus Torvalds 		if (sdev->lun ==lun)
7011da177e4SLinus Torvalds 			return sdev;
7021da177e4SLinus Torvalds 	}
7031da177e4SLinus Torvalds 
7041da177e4SLinus Torvalds 	return NULL;
7051da177e4SLinus Torvalds }
7061da177e4SLinus Torvalds EXPORT_SYMBOL(__scsi_device_lookup_by_target);
7071da177e4SLinus Torvalds 
7081da177e4SLinus Torvalds /**
7091da177e4SLinus Torvalds  * scsi_device_lookup_by_target - find a device given the target
7101da177e4SLinus Torvalds  * @starget:	SCSI target pointer
7111da177e4SLinus Torvalds  * @lun:	SCSI Logical Unit Number
7121da177e4SLinus Torvalds  *
713477e608cSBartlomiej Zolnierkiewicz  * Description: Looks up the scsi_device with the specified @lun for a given
714477e608cSBartlomiej Zolnierkiewicz  * @starget.  The returned scsi_device has an additional reference that
715eb44820cSRob Landley  * needs to be released with scsi_device_put once you're done with it.
7161da177e4SLinus Torvalds  **/
7171da177e4SLinus Torvalds struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
7189cb78c16SHannes Reinecke 						 u64 lun)
7191da177e4SLinus Torvalds {
7201da177e4SLinus Torvalds 	struct scsi_device *sdev;
7211da177e4SLinus Torvalds 	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
7221da177e4SLinus Torvalds 	unsigned long flags;
7231da177e4SLinus Torvalds 
7241da177e4SLinus Torvalds 	spin_lock_irqsave(shost->host_lock, flags);
7251da177e4SLinus Torvalds 	sdev = __scsi_device_lookup_by_target(starget, lun);
7261da177e4SLinus Torvalds 	if (sdev && scsi_device_get(sdev))
7271da177e4SLinus Torvalds 		sdev = NULL;
7281da177e4SLinus Torvalds 	spin_unlock_irqrestore(shost->host_lock, flags);
7291da177e4SLinus Torvalds 
7301da177e4SLinus Torvalds 	return sdev;
7311da177e4SLinus Torvalds }
7321da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_device_lookup_by_target);
7331da177e4SLinus Torvalds 
7341da177e4SLinus Torvalds /**
735eb44820cSRob Landley  * __scsi_device_lookup - find a device given the host (UNLOCKED)
7361da177e4SLinus Torvalds  * @shost:	SCSI host pointer
7371da177e4SLinus Torvalds  * @channel:	SCSI channel (zero if only one channel)
738eb44820cSRob Landley  * @id:		SCSI target number (physical unit number)
7391da177e4SLinus Torvalds  * @lun:	SCSI Logical Unit Number
7401da177e4SLinus Torvalds  *
741eb44820cSRob Landley  * Description: Looks up the scsi_device with the specified @channel, @id, @lun
742eb44820cSRob Landley  * for a given host. The returned scsi_device does not have an additional
743eb44820cSRob Landley  * reference.  You must hold the host's host_lock over this call and any access
744eb44820cSRob Landley  * to the returned scsi_device.
7451da177e4SLinus Torvalds  *
7461da177e4SLinus Torvalds  * Note:  The only reason why drivers would want to use this is because
747eb44820cSRob Landley  * they need to access the device list in irq context.  Otherwise you
7481da177e4SLinus Torvalds  * really want to use scsi_device_lookup instead.
7491da177e4SLinus Torvalds  **/
7501da177e4SLinus Torvalds struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
7519cb78c16SHannes Reinecke 		uint channel, uint id, u64 lun)
7521da177e4SLinus Torvalds {
7531da177e4SLinus Torvalds 	struct scsi_device *sdev;
7541da177e4SLinus Torvalds 
7551da177e4SLinus Torvalds 	list_for_each_entry(sdev, &shost->__devices, siblings) {
7564ff7adc8SZhou Zhengping 		if (sdev->sdev_state == SDEV_DEL)
7574ff7adc8SZhou Zhengping 			continue;
7581da177e4SLinus Torvalds 		if (sdev->channel == channel && sdev->id == id &&
7591da177e4SLinus Torvalds 				sdev->lun ==lun)
7601da177e4SLinus Torvalds 			return sdev;
7611da177e4SLinus Torvalds 	}
7621da177e4SLinus Torvalds 
7631da177e4SLinus Torvalds 	return NULL;
7641da177e4SLinus Torvalds }
7651da177e4SLinus Torvalds EXPORT_SYMBOL(__scsi_device_lookup);
7661da177e4SLinus Torvalds 
7671da177e4SLinus Torvalds /**
7681da177e4SLinus Torvalds  * scsi_device_lookup - find a device given the host
7691da177e4SLinus Torvalds  * @shost:	SCSI host pointer
7701da177e4SLinus Torvalds  * @channel:	SCSI channel (zero if only one channel)
7711da177e4SLinus Torvalds  * @id:		SCSI target number (physical unit number)
7721da177e4SLinus Torvalds  * @lun:	SCSI Logical Unit Number
7731da177e4SLinus Torvalds  *
774eb44820cSRob Landley  * Description: Looks up the scsi_device with the specified @channel, @id, @lun
775eb44820cSRob Landley  * for a given host.  The returned scsi_device has an additional reference that
776eb44820cSRob Landley  * needs to be released with scsi_device_put once you're done with it.
7771da177e4SLinus Torvalds  **/
7781da177e4SLinus Torvalds struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
7799cb78c16SHannes Reinecke 		uint channel, uint id, u64 lun)
7801da177e4SLinus Torvalds {
7811da177e4SLinus Torvalds 	struct scsi_device *sdev;
7821da177e4SLinus Torvalds 	unsigned long flags;
7831da177e4SLinus Torvalds 
7841da177e4SLinus Torvalds 	spin_lock_irqsave(shost->host_lock, flags);
7851da177e4SLinus Torvalds 	sdev = __scsi_device_lookup(shost, channel, id, lun);
7861da177e4SLinus Torvalds 	if (sdev && scsi_device_get(sdev))
7871da177e4SLinus Torvalds 		sdev = NULL;
7881da177e4SLinus Torvalds 	spin_unlock_irqrestore(shost->host_lock, flags);
7891da177e4SLinus Torvalds 
7901da177e4SLinus Torvalds 	return sdev;
7911da177e4SLinus Torvalds }
7921da177e4SLinus Torvalds EXPORT_SYMBOL(scsi_device_lookup);
7931da177e4SLinus Torvalds 
7941da177e4SLinus Torvalds MODULE_DESCRIPTION("SCSI core");
7951da177e4SLinus Torvalds MODULE_LICENSE("GPL");
7961da177e4SLinus Torvalds 
7971da177e4SLinus Torvalds module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
7981da177e4SLinus Torvalds MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
7991da177e4SLinus Torvalds 
8001da177e4SLinus Torvalds static int __init init_scsi(void)
8011da177e4SLinus Torvalds {
8029bf09c23SJens Axboe 	int error;
8031da177e4SLinus Torvalds 
8041da177e4SLinus Torvalds 	error = scsi_init_procfs();
8051da177e4SLinus Torvalds 	if (error)
8061da177e4SLinus Torvalds 		goto cleanup_queue;
8071da177e4SLinus Torvalds 	error = scsi_init_devinfo();
8081da177e4SLinus Torvalds 	if (error)
8091da177e4SLinus Torvalds 		goto cleanup_procfs;
8101da177e4SLinus Torvalds 	error = scsi_init_hosts();
8111da177e4SLinus Torvalds 	if (error)
8121da177e4SLinus Torvalds 		goto cleanup_devlist;
8131da177e4SLinus Torvalds 	error = scsi_init_sysctl();
8141da177e4SLinus Torvalds 	if (error)
8151da177e4SLinus Torvalds 		goto cleanup_hosts;
8161da177e4SLinus Torvalds 	error = scsi_sysfs_register();
8171da177e4SLinus Torvalds 	if (error)
8181da177e4SLinus Torvalds 		goto cleanup_sysctl;
8191da177e4SLinus Torvalds 
82084314fd4SJames Smart 	scsi_netlink_init();
82184314fd4SJames Smart 
8221da177e4SLinus Torvalds 	printk(KERN_NOTICE "SCSI subsystem initialized\n");
8231da177e4SLinus Torvalds 	return 0;
8241da177e4SLinus Torvalds 
8251da177e4SLinus Torvalds cleanup_sysctl:
8261da177e4SLinus Torvalds 	scsi_exit_sysctl();
8271da177e4SLinus Torvalds cleanup_hosts:
8281da177e4SLinus Torvalds 	scsi_exit_hosts();
8291da177e4SLinus Torvalds cleanup_devlist:
8301da177e4SLinus Torvalds 	scsi_exit_devinfo();
8311da177e4SLinus Torvalds cleanup_procfs:
8321da177e4SLinus Torvalds 	scsi_exit_procfs();
8331da177e4SLinus Torvalds cleanup_queue:
8341da177e4SLinus Torvalds 	scsi_exit_queue();
8351da177e4SLinus Torvalds 	printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
8361da177e4SLinus Torvalds 	       -error);
8371da177e4SLinus Torvalds 	return error;
8381da177e4SLinus Torvalds }
8391da177e4SLinus Torvalds 
8401da177e4SLinus Torvalds static void __exit exit_scsi(void)
8411da177e4SLinus Torvalds {
84284314fd4SJames Smart 	scsi_netlink_exit();
8431da177e4SLinus Torvalds 	scsi_sysfs_unregister();
8441da177e4SLinus Torvalds 	scsi_exit_sysctl();
8451da177e4SLinus Torvalds 	scsi_exit_hosts();
8461da177e4SLinus Torvalds 	scsi_exit_devinfo();
8471da177e4SLinus Torvalds 	scsi_exit_procfs();
8481da177e4SLinus Torvalds 	scsi_exit_queue();
8491da177e4SLinus Torvalds }
8501da177e4SLinus Torvalds 
8511da177e4SLinus Torvalds subsys_initcall(init_scsi);
8521da177e4SLinus Torvalds module_exit(exit_scsi);
853