scsi.c 22.2 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/*
 *  scsi.c Copyright (C) 1992 Drew Eckhardt
 *         Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
 *         Copyright (C) 2002, 2003 Christoph Hellwig
 *
 *  generic mid-level SCSI driver
 *      Initial versions: Drew Eckhardt
 *      Subsequent revisions: Eric Youngdale
 *
 *  <drew@colorado.edu>
 *
 *  Bug correction thanks go to :
 *      Rik Faith <faith@cs.unc.edu>
 *      Tommy Thorn <tthorn>
 *      Thomas Wuensche <tw@fgb1.fgb.mw.tu-muenchen.de>
 *
 *  Modified by Eric Youngdale eric@andante.org or ericy@gnu.ai.mit.edu to
 *  add scatter-gather, multiple outstanding request, and other
 *  enhancements.
 *
 *  Native multichannel, wide scsi, /proc/scsi and hot plugging
 *  support added by Michael Neuffer <mike@i-connect.net>
 *
 *  Added request_module("scsi_hostadapter") for kerneld:
 *  (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
 *  Bjorn Ekwall  <bj0rn@blox.se>
 *  (changed to kmod)
 *
 *  Major improvements to the timeout, abort, and reset processing,
 *  as well as performance modifications for large queue depths by
 *  Leonard N. Zubkoff <lnz@dandelion.com>
 *
 *  Converted cli() code to spinlocks, Ingo Molnar
 *
 *  Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
 *
 *  out_of_space hacks, D. Gilbert (dpg) 990608
 */

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/kernel.h>
#include <linux/timer.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <linux/init.h>
#include <linux/completion.h>
#include <linux/unistd.h>
#include <linux/spinlock.h>
#include <linux/kmod.h>
#include <linux/interrupt.h>
#include <linux/notifier.h>
#include <linux/cpu.h>
57
#include <linux/mutex.h>
58
#include <linux/async.h>
59
#include <asm/unaligned.h>
Linus Torvalds's avatar
Linus Torvalds committed
60 61 62 63 64

#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_dbg.h>
#include <scsi/scsi_device.h>
65
#include <scsi/scsi_driver.h>
Linus Torvalds's avatar
Linus Torvalds committed
66 67 68 69 70 71 72
#include <scsi/scsi_eh.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_tcq.h>

#include "scsi_priv.h"
#include "scsi_logging.h"

73 74 75
#define CREATE_TRACE_POINTS
#include <trace/events/scsi.h>

Linus Torvalds's avatar
Linus Torvalds committed
76 77 78 79 80 81 82 83 84 85 86 87 88
/*
 * Definitions and constants.
 */

/*
 * Note - the initial logging level can be set here to log events at boot time.
 * After the system is up, you may enable logging via the /proc interface.
 */
unsigned int scsi_logging_level;
#if defined(CONFIG_SCSI_LOGGING)
EXPORT_SYMBOL(scsi_logging_level);
#endif

Dan Williams's avatar
Dan Williams committed
89
/*
90 91 92
 * Domain for asynchronous system resume operations.  It is marked 'exclusive'
 * to avoid being included in the async_synchronize_full() that is invoked by
 * dpm_resume().
Dan Williams's avatar
Dan Williams committed
93 94 95 96
 */
ASYNC_DOMAIN_EXCLUSIVE(scsi_sd_pm_domain);
EXPORT_SYMBOL(scsi_sd_pm_domain);

Linus Torvalds's avatar
Linus Torvalds committed
97 98 99 100 101 102 103 104 105 106
#ifdef CONFIG_SCSI_LOGGING
void scsi_log_send(struct scsi_cmnd *cmd)
{
	unsigned int level;

	/*
	 * If ML QUEUE log level is greater than or equal to:
	 *
	 * 1: nothing (match completion)
	 *
107
	 * 2: log opcode + command of all commands + cmd address
Linus Torvalds's avatar
Linus Torvalds committed
108
	 *
109
	 * 3: same as 2
Linus Torvalds's avatar
Linus Torvalds committed
110
	 *
111
	 * 4: same as 3
Linus Torvalds's avatar
Linus Torvalds committed
112 113 114 115 116
	 */
	if (unlikely(scsi_logging_level)) {
		level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
				       SCSI_LOG_MLQUEUE_BITS);
		if (level > 1) {
117 118
			scmd_printk(KERN_INFO, cmd,
				    "Send: scmd 0x%p\n", cmd);
Linus Torvalds's avatar
Linus Torvalds committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
			scsi_print_command(cmd);
		}
	}
}

void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
{
	unsigned int level;

	/*
	 * If ML COMPLETE log level is greater than or equal to:
	 *
	 * 1: log disposition, result, opcode + command, and conditionally
	 * sense data for failures or non SUCCESS dispositions.
	 *
	 * 2: same as 1 but for all command completions.
	 *
136
	 * 3: same as 2
Linus Torvalds's avatar
Linus Torvalds committed
137 138 139 140 141 142 143 144
	 *
	 * 4: same as 3 plus dump extra junk
	 */
	if (unlikely(scsi_logging_level)) {
		level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
				       SCSI_LOG_MLCOMPLETE_BITS);
		if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
		    (level > 1)) {
145
			scsi_print_result(cmd, "Done", disposition);
Linus Torvalds's avatar
Linus Torvalds committed
146
			scsi_print_command(cmd);
147
			if (status_byte(cmd->result) == CHECK_CONDITION)
148
				scsi_print_sense(cmd);
149 150 151
			if (level > 3)
				scmd_printk(KERN_INFO, cmd,
					    "scsi host busy %d failed %d\n",
152
					    scsi_host_busy(cmd->device->host),
153
					    cmd->device->host->host_failed);
Linus Torvalds's avatar
Linus Torvalds committed
154 155 156 157 158
		}
	}
}
#endif

159 160 161
/**
 * scsi_finish_command - cleanup and pass command back to upper layer
 * @cmd: the command
Linus Torvalds's avatar
Linus Torvalds committed
162
 *
163
 * Description: Pass command off to upper layer for finishing of I/O
Linus Torvalds's avatar
Linus Torvalds committed
164 165 166 167 168 169
 *              request, waking processes that are waiting on results,
 *              etc.
 */
void scsi_finish_command(struct scsi_cmnd *cmd)
{
	struct scsi_device *sdev = cmd->device;
170
	struct scsi_target *starget = scsi_target(sdev);
Linus Torvalds's avatar
Linus Torvalds committed
171
	struct Scsi_Host *shost = sdev->host;
172 173
	struct scsi_driver *drv;
	unsigned int good_bytes;
Linus Torvalds's avatar
Linus Torvalds committed
174

175
	scsi_device_unbusy(sdev, cmd);
Linus Torvalds's avatar
Linus Torvalds committed
176

177 178 179 180 181 182 183 184 185 186
	/*
	 * Clear the flags that say that the device/target/host is no longer
	 * capable of accepting new commands.
	 */
	if (atomic_read(&shost->host_blocked))
		atomic_set(&shost->host_blocked, 0);
	if (atomic_read(&starget->target_blocked))
		atomic_set(&starget->target_blocked, 0);
	if (atomic_read(&sdev->device_blocked))
		atomic_set(&sdev->device_blocked, 0);
Linus Torvalds's avatar
Linus Torvalds committed
187 188 189 190 191 192 193 194

	/*
	 * If we have valid sense information, then some kind of recovery
	 * must have taken place.  Make a note of this.
	 */
	if (SCSI_SENSE_VALID(cmd))
		cmd->result |= (DRIVER_SENSE << 24);

195 196 197
	SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
				"Notifying upper driver of completion "
				"(result %x)\n", cmd->result));
Linus Torvalds's avatar
Linus Torvalds committed
198

199
	good_bytes = scsi_bufflen(cmd);
200
	if (!blk_rq_is_passthrough(cmd->request)) {
201
		int old_good_bytes = good_bytes;
202 203 204
		drv = scsi_cmd_to_driver(cmd);
		if (drv->done)
			good_bytes = drv->done(cmd);
205 206 207 208 209 210 211 212
		/*
		 * USB may not give sense identifying bad sector and
		 * simply return a residue instead, so subtract off the
		 * residue if drv->done() error processing indicates no
		 * change to the completion length.
		 */
		if (good_bytes == old_good_bytes)
			good_bytes -= scsi_get_resid(cmd);
213 214
	}
	scsi_io_completion(cmd, good_bytes);
Linus Torvalds's avatar
Linus Torvalds committed
215 216
}

217
/**
218
 * scsi_change_queue_depth - change a device's queue depth
219
 * @sdev: SCSI Device in question
220
 * @depth: number of commands allowed to be queued to the driver
Linus Torvalds's avatar
Linus Torvalds committed
221
 *
222
 * Sets the device queue depth and returns the new value.
Linus Torvalds's avatar
Linus Torvalds committed
223
 */
224
int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
Linus Torvalds's avatar
Linus Torvalds committed
225
{
226 227 228
	if (depth > 0) {
		sdev->queue_depth = depth;
		wmb();
229
	}
Linus Torvalds's avatar
Linus Torvalds committed
230

231 232 233
	if (sdev->request_queue)
		blk_set_queue_depth(sdev->request_queue, depth);

234
	return sdev->queue_depth;
Linus Torvalds's avatar
Linus Torvalds committed
235
}
236
EXPORT_SYMBOL(scsi_change_queue_depth);
Linus Torvalds's avatar
Linus Torvalds committed
237

238 239 240 241 242
/**
 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
 * @sdev: SCSI Device in question
 * @depth: Current number of outstanding SCSI commands on this device,
 *         not counting the one returned as QUEUE_FULL.
Linus Torvalds's avatar
Linus Torvalds committed
243
 *
244
 * Description:	This function will track successive QUEUE_FULL events on a
Linus Torvalds's avatar
Linus Torvalds committed
245 246 247
 * 		specific SCSI device to determine if and when there is a
 * 		need to adjust the queue depth on the device.
 *
248
 * Returns:	0 - No change needed, >0 - Adjust queue depth to this new depth,
Linus Torvalds's avatar
Linus Torvalds committed
249 250 251 252 253 254 255 256 257 258
 * 		-1 - Drop back to untagged operation using host->cmd_per_lun
 * 			as the untagged command depth
 *
 * Lock Status:	None held on entry
 *
 * Notes:	Low level drivers may call this at any time and we will do
 * 		"The Right Thing."  We are interrupt context safe.
 */
int scsi_track_queue_full(struct scsi_device *sdev, int depth)
{
Vasu Dev's avatar
Vasu Dev committed
259 260 261 262 263 264 265

	/*
	 * Don't let QUEUE_FULLs on the same
	 * jiffies count, they could all be from
	 * same event.
	 */
	if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
Linus Torvalds's avatar
Linus Torvalds committed
266 267
		return 0;

Vasu Dev's avatar
Vasu Dev committed
268
	sdev->last_queue_full_time = jiffies;
Linus Torvalds's avatar
Linus Torvalds committed
269 270 271 272 273 274 275 276 277
	if (sdev->last_queue_full_depth != depth) {
		sdev->last_queue_full_count = 1;
		sdev->last_queue_full_depth = depth;
	} else {
		sdev->last_queue_full_count++;
	}

	if (sdev->last_queue_full_count <= 10)
		return 0;
278

279
	return scsi_change_queue_depth(sdev, depth);
Linus Torvalds's avatar
Linus Torvalds committed
280 281 282
}
EXPORT_SYMBOL(scsi_track_queue_full);

Matthew Wilcox's avatar
Matthew Wilcox committed
283 284 285 286 287 288 289 290 291 292
/**
 * scsi_vpd_inquiry - Request a device provide us with a VPD page
 * @sdev: The device to ask
 * @buffer: Where to put the result
 * @page: Which Vital Product Data to return
 * @len: The length of the buffer
 *
 * This is an internal helper function.  You probably want to use
 * scsi_get_vpd_page instead.
 *
293
 * Returns size of the vpd page on success or a negative error number.
Matthew Wilcox's avatar
Matthew Wilcox committed
294 295 296 297 298 299 300
 */
static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
							u8 page, unsigned len)
{
	int result;
	unsigned char cmd[16];

301 302 303
	if (len < 4)
		return -EINVAL;

Matthew Wilcox's avatar
Matthew Wilcox committed
304 305 306 307 308 309 310 311 312 313 314 315
	cmd[0] = INQUIRY;
	cmd[1] = 1;		/* EVPD */
	cmd[2] = page;
	cmd[3] = len >> 8;
	cmd[4] = len & 0xff;
	cmd[5] = 0;		/* Control byte */

	/*
	 * I'm not convinced we need to try quite this hard to get VPD, but
	 * all the existing users tried this hard.
	 */
	result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
316
				  len, NULL, 30 * HZ, 3, NULL);
Matthew Wilcox's avatar
Matthew Wilcox committed
317
	if (result)
318
		return -EIO;
Matthew Wilcox's avatar
Matthew Wilcox committed
319 320 321 322 323

	/* Sanity check that we got the page back that we asked for */
	if (buffer[1] != page)
		return -EIO;

324
	return get_unaligned_be16(&buffer[2]) + 4;
Matthew Wilcox's avatar
Matthew Wilcox committed
325 326 327 328 329 330
}

/**
 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
 * @sdev: The device to ask
 * @page: Which Vital Product Data to return
331 332
 * @buf: where to store the VPD
 * @buf_len: number of bytes in the VPD buffer area
Matthew Wilcox's avatar
Matthew Wilcox committed
333 334 335 336 337 338 339 340
 *
 * SCSI devices may optionally supply Vital Product Data.  Each 'page'
 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
 * If the device supports this VPD page, this routine returns a pointer
 * to a buffer containing the data from that page.  The caller is
 * responsible for calling kfree() on this pointer when it is no longer
 * needed.  If we cannot retrieve the VPD page this routine returns %NULL.
 */
341 342
int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
		      int buf_len)
Matthew Wilcox's avatar
Matthew Wilcox committed
343 344 345
{
	int i, result;

346 347 348
	if (sdev->skip_vpd_pages)
		goto fail;

Matthew Wilcox's avatar
Matthew Wilcox committed
349
	/* Ask for all the pages supported by this device */
350
	result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
351
	if (result < 4)
Matthew Wilcox's avatar
Matthew Wilcox committed
352 353 354 355
		goto fail;

	/* If the user actually wanted this page, we can skip the rest */
	if (page == 0)
356
		return 0;
Matthew Wilcox's avatar
Matthew Wilcox committed
357

358 359
	for (i = 4; i < min(result, buf_len); i++)
		if (buf[i] == page)
Matthew Wilcox's avatar
Matthew Wilcox committed
360
			goto found;
361

362
	if (i < result && i >= buf_len)
363 364
		/* ran off the end of the buffer, give us benefit of doubt */
		goto found;
Matthew Wilcox's avatar
Matthew Wilcox committed
365 366 367 368
	/* The device claims it doesn't support the requested page */
	goto fail;

 found:
369
	result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
370
	if (result < 0)
Matthew Wilcox's avatar
Matthew Wilcox committed
371 372
		goto fail;

373
	return 0;
Matthew Wilcox's avatar
Matthew Wilcox committed
374 375

 fail:
376
	return -EINVAL;
Matthew Wilcox's avatar
Matthew Wilcox committed
377 378 379
}
EXPORT_SYMBOL_GPL(scsi_get_vpd_page);

380 381 382 383 384 385 386
/**
 * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
 * @sdev: The device to ask
 * @page: Which Vital Product Data to return
 *
 * Returns %NULL upon failure.
 */
387
static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
388
{
389
	struct scsi_vpd *vpd_buf;
390 391 392
	int vpd_len = SCSI_VPD_PG_LEN, result;

retry_pg:
393
	vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
394 395 396
	if (!vpd_buf)
		return NULL;

397
	result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
398 399 400 401 402 403 404 405 406 407
	if (result < 0) {
		kfree(vpd_buf);
		return NULL;
	}
	if (result > vpd_len) {
		vpd_len = result;
		kfree(vpd_buf);
		goto retry_pg;
	}

408
	vpd_buf->len = result;
409 410 411 412 413

	return vpd_buf;
}

static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
414
				 struct scsi_vpd __rcu **sdev_vpd_buf)
415
{
416
	struct scsi_vpd *vpd_buf;
417

418
	vpd_buf = scsi_get_vpd_buf(sdev, page);
419 420 421 422
	if (!vpd_buf)
		return;

	mutex_lock(&sdev->inquiry_mutex);
423 424
	vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
				      lockdep_is_held(&sdev->inquiry_mutex));
425 426
	mutex_unlock(&sdev->inquiry_mutex);

427 428
	if (vpd_buf)
		kfree_rcu(vpd_buf, rcu);
429 430
}

431 432 433 434 435 436 437 438 439 440 441
/**
 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
 * @sdev: The device to ask
 *
 * Attach the 'Device Identification' VPD page (0x83) and the
 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
 * structure. This information can be used to identify the device
 * uniquely.
 */
void scsi_attach_vpd(struct scsi_device *sdev)
{
442 443
	int i;
	struct scsi_vpd *vpd_buf;
444

445
	if (!scsi_device_supports_vpd(sdev))
446
		return;
447

448
	/* Ask for all the pages supported by this device */
449
	vpd_buf = scsi_get_vpd_buf(sdev, 0);
450
	if (!vpd_buf)
451 452
		return;

453
	for (i = 4; i < vpd_buf->len; i++) {
454 455
		if (vpd_buf->data[i] == 0x0)
			scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
456 457 458 459
		if (vpd_buf->data[i] == 0x80)
			scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
		if (vpd_buf->data[i] == 0x83)
			scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
460 461
		if (vpd_buf->data[i] == 0x89)
			scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
462 463 464 465
	}
	kfree(vpd_buf);
}

466 467 468 469 470 471 472 473
/**
 * scsi_report_opcode - Find out if a given command opcode is supported
 * @sdev:	scsi device to query
 * @buffer:	scratch buffer (must be at least 20 bytes long)
 * @len:	length of buffer
 * @opcode:	opcode for command to look up
 *
 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
474 475
 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
 * unsupported and 1 if the device claims to support the command.
476 477 478 479 480 481 482 483 484
 */
int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
		       unsigned int len, unsigned char opcode)
{
	unsigned char cmd[16];
	struct scsi_sense_hdr sshdr;
	int result;

	if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
485
		return -EINVAL;
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

	memset(cmd, 0, 16);
	cmd[0] = MAINTENANCE_IN;
	cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
	cmd[2] = 1;		/* One command format */
	cmd[3] = opcode;
	put_unaligned_be32(len, &cmd[6]);
	memset(buffer, 0, len);

	result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
				  &sshdr, 30 * HZ, 3, NULL);

	if (result && scsi_sense_valid(&sshdr) &&
	    sshdr.sense_key == ILLEGAL_REQUEST &&
	    (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
501
		return -EINVAL;
502 503 504 505 506 507 508 509

	if ((buffer[1] & 3) == 3) /* Command supported */
		return 1;

	return 0;
}
EXPORT_SYMBOL(scsi_report_opcode);

Linus Torvalds's avatar
Linus Torvalds committed
510
/**
511
 * scsi_device_get  -  get an additional reference to a scsi_device
Linus Torvalds's avatar
Linus Torvalds committed
512 513
 * @sdev:	device to get a reference to
 *
514
 * Description: Gets a reference to the scsi_device and increments the use count
Linus Torvalds's avatar
Linus Torvalds committed
515 516
 * of the underlying LLDD module.  You must hold host_lock of the
 * parent Scsi_Host or already have a reference when calling this.
517 518 519
 *
 * This will fail if a device is deleted or cancelled, or when the LLD module
 * is in the process of being unloaded.
Linus Torvalds's avatar
Linus Torvalds committed
520 521 522
 */
int scsi_device_get(struct scsi_device *sdev)
{
523 524
	if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
		goto fail;
Linus Torvalds's avatar
Linus Torvalds committed
525
	if (!get_device(&sdev->sdev_gendev))
526 527 528
		goto fail;
	if (!try_module_get(sdev->host->hostt->module))
		goto fail_put_device;
Linus Torvalds's avatar
Linus Torvalds committed
529
	return 0;
530 531 532 533 534

fail_put_device:
	put_device(&sdev->sdev_gendev);
fail:
	return -ENXIO;
Linus Torvalds's avatar
Linus Torvalds committed
535 536 537 538 539 540 541
}
EXPORT_SYMBOL(scsi_device_get);

/**
 * scsi_device_put  -  release a reference to a scsi_device
 * @sdev:	device to release a reference on.
 *
542 543
 * Description: Release a reference to the scsi_device and decrements the use
 * count of the underlying LLDD module.  The device is freed once the last
Linus Torvalds's avatar
Linus Torvalds committed
544 545 546 547
 * user vanishes.
 */
void scsi_device_put(struct scsi_device *sdev)
{
548
	module_put(sdev->host->hostt->module);
Linus Torvalds's avatar
Linus Torvalds committed
549 550 551 552
	put_device(&sdev->sdev_gendev);
}
EXPORT_SYMBOL(scsi_device_put);

553
/* helper for shost_for_each_device, see that for documentation */
Linus Torvalds's avatar
Linus Torvalds committed
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
					   struct scsi_device *prev)
{
	struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
	struct scsi_device *next = NULL;
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
	while (list->next != &shost->__devices) {
		next = list_entry(list->next, struct scsi_device, siblings);
		/* skip devices that we can't get a reference to */
		if (!scsi_device_get(next))
			break;
		next = NULL;
		list = list->next;
	}
	spin_unlock_irqrestore(shost->host_lock, flags);

	if (prev)
		scsi_device_put(prev);
	return next;
}
EXPORT_SYMBOL(__scsi_iterate_devices);

/**
 * starget_for_each_device  -  helper to walk all devices of a target
 * @starget:	target whose devices we want to iterate over.
581 582
 * @data:	Opaque passed to each function call.
 * @fn:		Function to call on each device
Linus Torvalds's avatar
Linus Torvalds committed
583
 *
584
 * This traverses over each device of @starget.  The devices have
Linus Torvalds's avatar
Linus Torvalds committed
585 586 587
 * a reference that must be released by scsi_host_put when breaking
 * out of the loop.
 */
588
void starget_for_each_device(struct scsi_target *starget, void *data,
Linus Torvalds's avatar
Linus Torvalds committed
589 590 591 592 593 594 595 596 597 598 599 600 601
		     void (*fn)(struct scsi_device *, void *))
{
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	struct scsi_device *sdev;

	shost_for_each_device(sdev, shost) {
		if ((sdev->channel == starget->channel) &&
		    (sdev->id == starget->id))
			fn(sdev, data);
	}
}
EXPORT_SYMBOL(starget_for_each_device);

602
/**
603
 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
604
 * @starget:	target whose devices we want to iterate over.
605 606
 * @data:	parameter for callback @fn()
 * @fn:		callback function that is invoked for each device
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
 *
 * This traverses over each device of @starget.  It does _not_
 * take a reference on the scsi_device, so the whole loop must be
 * protected by shost->host_lock.
 *
 * Note:  The only reason why drivers would want to use this is because
 * they need to access the device list in irq context.  Otherwise you
 * really want to use starget_for_each_device instead.
 **/
void __starget_for_each_device(struct scsi_target *starget, void *data,
			       void (*fn)(struct scsi_device *, void *))
{
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	struct scsi_device *sdev;

	__shost_for_each_device(sdev, shost) {
		if ((sdev->channel == starget->channel) &&
		    (sdev->id == starget->id))
			fn(sdev, data);
	}
}
EXPORT_SYMBOL(__starget_for_each_device);

Linus Torvalds's avatar
Linus Torvalds committed
630 631 632 633 634
/**
 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
 * @starget:	SCSI target pointer
 * @lun:	SCSI Logical Unit Number
 *
635 636
 * Description: Looks up the scsi_device with the specified @lun for a given
 * @starget.  The returned scsi_device does not have an additional
Linus Torvalds's avatar
Linus Torvalds committed
637
 * reference.  You must hold the host's host_lock over this call and
638 639
 * any access to the returned scsi_device. A scsi_device in state
 * SDEV_DEL is skipped.
Linus Torvalds's avatar
Linus Torvalds committed
640
 *
641
 * Note:  The only reason why drivers should use this is because
642
 * they need to access the device list in irq context.  Otherwise you
Linus Torvalds's avatar
Linus Torvalds committed
643 644 645
 * really want to use scsi_device_lookup_by_target instead.
 **/
struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke's avatar
Hannes Reinecke committed
646
						   u64 lun)
Linus Torvalds's avatar
Linus Torvalds committed
647 648 649 650
{
	struct scsi_device *sdev;

	list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
651 652
		if (sdev->sdev_state == SDEV_DEL)
			continue;
Linus Torvalds's avatar
Linus Torvalds committed
653 654 655 656 657 658 659 660 661 662 663 664 665
		if (sdev->lun ==lun)
			return sdev;
	}

	return NULL;
}
EXPORT_SYMBOL(__scsi_device_lookup_by_target);

/**
 * scsi_device_lookup_by_target - find a device given the target
 * @starget:	SCSI target pointer
 * @lun:	SCSI Logical Unit Number
 *
666 667
 * Description: Looks up the scsi_device with the specified @lun for a given
 * @starget.  The returned scsi_device has an additional reference that
668
 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds's avatar
Linus Torvalds committed
669 670
 **/
struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
Hannes Reinecke's avatar
Hannes Reinecke committed
671
						 u64 lun)
Linus Torvalds's avatar
Linus Torvalds committed
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
{
	struct scsi_device *sdev;
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
	sdev = __scsi_device_lookup_by_target(starget, lun);
	if (sdev && scsi_device_get(sdev))
		sdev = NULL;
	spin_unlock_irqrestore(shost->host_lock, flags);

	return sdev;
}
EXPORT_SYMBOL(scsi_device_lookup_by_target);

/**
688
 * __scsi_device_lookup - find a device given the host (UNLOCKED)
Linus Torvalds's avatar
Linus Torvalds committed
689 690
 * @shost:	SCSI host pointer
 * @channel:	SCSI channel (zero if only one channel)
691
 * @id:		SCSI target number (physical unit number)
Linus Torvalds's avatar
Linus Torvalds committed
692 693
 * @lun:	SCSI Logical Unit Number
 *
694 695 696 697
 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
 * for a given host. The returned scsi_device does not have an additional
 * reference.  You must hold the host's host_lock over this call and any access
 * to the returned scsi_device.
Linus Torvalds's avatar
Linus Torvalds committed
698 699
 *
 * Note:  The only reason why drivers would want to use this is because
700
 * they need to access the device list in irq context.  Otherwise you
Linus Torvalds's avatar
Linus Torvalds committed
701 702 703
 * really want to use scsi_device_lookup instead.
 **/
struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke's avatar
Hannes Reinecke committed
704
		uint channel, uint id, u64 lun)
Linus Torvalds's avatar
Linus Torvalds committed
705 706 707 708
{
	struct scsi_device *sdev;

	list_for_each_entry(sdev, &shost->__devices, siblings) {
709 710
		if (sdev->sdev_state == SDEV_DEL)
			continue;
Linus Torvalds's avatar
Linus Torvalds committed
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
		if (sdev->channel == channel && sdev->id == id &&
				sdev->lun ==lun)
			return sdev;
	}

	return NULL;
}
EXPORT_SYMBOL(__scsi_device_lookup);

/**
 * scsi_device_lookup - find a device given the host
 * @shost:	SCSI host pointer
 * @channel:	SCSI channel (zero if only one channel)
 * @id:		SCSI target number (physical unit number)
 * @lun:	SCSI Logical Unit Number
 *
727 728 729
 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
 * for a given host.  The returned scsi_device has an additional reference that
 * needs to be released with scsi_device_put once you're done with it.
Linus Torvalds's avatar
Linus Torvalds committed
730 731
 **/
struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
Hannes Reinecke's avatar
Hannes Reinecke committed
732
		uint channel, uint id, u64 lun)
Linus Torvalds's avatar
Linus Torvalds committed
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
{
	struct scsi_device *sdev;
	unsigned long flags;

	spin_lock_irqsave(shost->host_lock, flags);
	sdev = __scsi_device_lookup(shost, channel, id, lun);
	if (sdev && scsi_device_get(sdev))
		sdev = NULL;
	spin_unlock_irqrestore(shost->host_lock, flags);

	return sdev;
}
EXPORT_SYMBOL(scsi_device_lookup);

MODULE_DESCRIPTION("SCSI core");
MODULE_LICENSE("GPL");

module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");

static int __init init_scsi(void)
{
755
	int error;
Linus Torvalds's avatar
Linus Torvalds committed
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775

	error = scsi_init_queue();
	if (error)
		return error;
	error = scsi_init_procfs();
	if (error)
		goto cleanup_queue;
	error = scsi_init_devinfo();
	if (error)
		goto cleanup_procfs;
	error = scsi_init_hosts();
	if (error)
		goto cleanup_devlist;
	error = scsi_init_sysctl();
	if (error)
		goto cleanup_hosts;
	error = scsi_sysfs_register();
	if (error)
		goto cleanup_sysctl;

776 777
	scsi_netlink_init();

Linus Torvalds's avatar
Linus Torvalds committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
	printk(KERN_NOTICE "SCSI subsystem initialized\n");
	return 0;

cleanup_sysctl:
	scsi_exit_sysctl();
cleanup_hosts:
	scsi_exit_hosts();
cleanup_devlist:
	scsi_exit_devinfo();
cleanup_procfs:
	scsi_exit_procfs();
cleanup_queue:
	scsi_exit_queue();
	printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
	       -error);
	return error;
}

static void __exit exit_scsi(void)
{
798
	scsi_netlink_exit();
Linus Torvalds's avatar
Linus Torvalds committed
799 800 801 802 803 804 805 806 807 808
	scsi_sysfs_unregister();
	scsi_exit_sysctl();
	scsi_exit_hosts();
	scsi_exit_devinfo();
	scsi_exit_procfs();
	scsi_exit_queue();
}

subsys_initcall(init_scsi);
module_exit(exit_scsi);