scsi: core: Simplify LLD module reference counting
[linux-block.git] / drivers / scsi / scsi.c
CommitLineData
09c434b8 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
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>
1da177e4
LT
44#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>
1da177e4
LT
51#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>
0b950672 57#include <linux/mutex.h>
3c6bdaea 58#include <asm/unaligned.h>
1da177e4
LT
59
60#include <scsi/scsi.h>
61#include <scsi/scsi_cmnd.h>
62#include <scsi/scsi_dbg.h>
63#include <scsi/scsi_device.h>
7b3d9545 64#include <scsi/scsi_driver.h>
1da177e4
LT
65#include <scsi/scsi_eh.h>
66#include <scsi/scsi_host.h>
67#include <scsi/scsi_tcq.h>
1da177e4
LT
68
69#include "scsi_priv.h"
70#include "scsi_logging.h"
71
bf816235
KT
72#define CREATE_TRACE_POINTS
73#include <trace/events/scsi.h>
74
1da177e4
LT
75/*
76 * Definitions and constants.
77 */
78
1da177e4
LT
79/*
80 * Note - the initial logging level can be set here to log events at boot time.
81 * After the system is up, you may enable logging via the /proc interface.
82 */
83unsigned int scsi_logging_level;
84#if defined(CONFIG_SCSI_LOGGING)
85EXPORT_SYMBOL(scsi_logging_level);
86#endif
87
1da177e4
LT
88#ifdef CONFIG_SCSI_LOGGING
89void scsi_log_send(struct scsi_cmnd *cmd)
90{
91 unsigned int level;
1da177e4
LT
92
93 /*
94 * If ML QUEUE log level is greater than or equal to:
95 *
96 * 1: nothing (match completion)
97 *
c11c004b 98 * 2: log opcode + command of all commands + cmd address
1da177e4 99 *
c11c004b 100 * 3: same as 2
1da177e4 101 *
a4a6afb4 102 * 4: same as 3
1da177e4
LT
103 */
104 if (unlikely(scsi_logging_level)) {
105 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
106 SCSI_LOG_MLQUEUE_BITS);
107 if (level > 1) {
c11c004b
HR
108 scmd_printk(KERN_INFO, cmd,
109 "Send: scmd 0x%p\n", cmd);
1da177e4 110 scsi_print_command(cmd);
1da177e4
LT
111 }
112 }
113}
114
115void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
116{
117 unsigned int level;
1da177e4
LT
118
119 /*
120 * If ML COMPLETE log level is greater than or equal to:
121 *
122 * 1: log disposition, result, opcode + command, and conditionally
123 * sense data for failures or non SUCCESS dispositions.
124 *
125 * 2: same as 1 but for all command completions.
126 *
c11c004b 127 * 3: same as 2
1da177e4
LT
128 *
129 * 4: same as 3 plus dump extra junk
130 */
131 if (unlikely(scsi_logging_level)) {
132 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
133 SCSI_LOG_MLCOMPLETE_BITS);
134 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
135 (level > 1)) {
026f8da8 136 scsi_print_result(cmd, "Done", disposition);
1da177e4 137 scsi_print_command(cmd);
d0672a03 138 if (scsi_status_is_check_condition(cmd->result))
d811b848 139 scsi_print_sense(cmd);
a4d04a4c
MP
140 if (level > 3)
141 scmd_printk(KERN_INFO, cmd,
142 "scsi host busy %d failed %d\n",
c84b023a 143 scsi_host_busy(cmd->device->host),
a4d04a4c 144 cmd->device->host->host_failed);
1da177e4
LT
145 }
146 }
147}
148#endif
149
eb44820c
RL
150/**
151 * scsi_finish_command - cleanup and pass command back to upper layer
152 * @cmd: the command
1da177e4 153 *
eb44820c 154 * Description: Pass command off to upper layer for finishing of I/O
1da177e4
LT
155 * request, waking processes that are waiting on results,
156 * etc.
157 */
158void scsi_finish_command(struct scsi_cmnd *cmd)
159{
160 struct scsi_device *sdev = cmd->device;
f0c0a376 161 struct scsi_target *starget = scsi_target(sdev);
1da177e4 162 struct Scsi_Host *shost = sdev->host;
7b3d9545
LT
163 struct scsi_driver *drv;
164 unsigned int good_bytes;
1da177e4 165
6eb045e0 166 scsi_device_unbusy(sdev, cmd);
1da177e4 167
cd9070c9
CH
168 /*
169 * Clear the flags that say that the device/target/host is no longer
170 * capable of accepting new commands.
171 */
172 if (atomic_read(&shost->host_blocked))
173 atomic_set(&shost->host_blocked, 0);
174 if (atomic_read(&starget->target_blocked))
175 atomic_set(&starget->target_blocked, 0);
176 if (atomic_read(&sdev->device_blocked))
177 atomic_set(&sdev->device_blocked, 0);
1da177e4 178
3bf743e7
JG
179 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
180 "Notifying upper driver of completion "
181 "(result %x)\n", cmd->result));
1da177e4 182
f18573ab 183 good_bytes = scsi_bufflen(cmd);
aa8e25e5 184 if (!blk_rq_is_passthrough(scsi_cmd_to_rq(cmd))) {
427e59f0 185 int old_good_bytes = good_bytes;
7b3d9545
LT
186 drv = scsi_cmd_to_driver(cmd);
187 if (drv->done)
188 good_bytes = drv->done(cmd);
427e59f0
JB
189 /*
190 * USB may not give sense identifying bad sector and
191 * simply return a residue instead, so subtract off the
192 * residue if drv->done() error processing indicates no
193 * change to the completion length.
194 */
195 if (good_bytes == old_good_bytes)
196 good_bytes -= scsi_get_resid(cmd);
7b3d9545
LT
197 }
198 scsi_io_completion(cmd, good_bytes);
1da177e4 199}
1da177e4 200
ca445321
ML
201
202/*
f9bdac31 203 * 4096 is big enough for saturating fast SCSI LUNs.
ca445321 204 */
020b0f0a 205int scsi_device_max_queue_depth(struct scsi_device *sdev)
ca445321 206{
f9bdac31 207 return min_t(int, sdev->host->can_queue, 4096);
ca445321
ML
208}
209
eb44820c 210/**
db5ed4df 211 * scsi_change_queue_depth - change a device's queue depth
eb44820c 212 * @sdev: SCSI Device in question
db5ed4df 213 * @depth: number of commands allowed to be queued to the driver
1da177e4 214 *
db5ed4df 215 * Sets the device queue depth and returns the new value.
1da177e4 216 */
db5ed4df 217int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
1da177e4 218{
ca445321
ML
219 depth = min_t(int, depth, scsi_device_max_queue_depth(sdev));
220
64d513ac
CH
221 if (depth > 0) {
222 sdev->queue_depth = depth;
223 wmb();
885ace9e 224 }
1da177e4 225
d278d4a8
JA
226 if (sdev->request_queue)
227 blk_set_queue_depth(sdev->request_queue, depth);
228
020b0f0a
ML
229 sbitmap_resize(&sdev->budget_map, sdev->queue_depth);
230
db5ed4df 231 return sdev->queue_depth;
1da177e4 232}
db5ed4df 233EXPORT_SYMBOL(scsi_change_queue_depth);
1da177e4 234
eb44820c
RL
235/**
236 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
237 * @sdev: SCSI Device in question
238 * @depth: Current number of outstanding SCSI commands on this device,
239 * not counting the one returned as QUEUE_FULL.
1da177e4 240 *
eb44820c 241 * Description: This function will track successive QUEUE_FULL events on a
1da177e4
LT
242 * specific SCSI device to determine if and when there is a
243 * need to adjust the queue depth on the device.
244 *
eb44820c 245 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
1da177e4
LT
246 * -1 - Drop back to untagged operation using host->cmd_per_lun
247 * as the untagged command depth
248 *
249 * Lock Status: None held on entry
250 *
251 * Notes: Low level drivers may call this at any time and we will do
252 * "The Right Thing." We are interrupt context safe.
253 */
254int scsi_track_queue_full(struct scsi_device *sdev, int depth)
255{
4a84067d
VD
256
257 /*
258 * Don't let QUEUE_FULLs on the same
259 * jiffies count, they could all be from
260 * same event.
261 */
262 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
1da177e4
LT
263 return 0;
264
4a84067d 265 sdev->last_queue_full_time = jiffies;
1da177e4
LT
266 if (sdev->last_queue_full_depth != depth) {
267 sdev->last_queue_full_count = 1;
268 sdev->last_queue_full_depth = depth;
269 } else {
270 sdev->last_queue_full_count++;
271 }
272
273 if (sdev->last_queue_full_count <= 10)
274 return 0;
609aa22f 275
db5ed4df 276 return scsi_change_queue_depth(sdev, depth);
1da177e4
LT
277}
278EXPORT_SYMBOL(scsi_track_queue_full);
279
881a256d
MW
280/**
281 * scsi_vpd_inquiry - Request a device provide us with a VPD page
282 * @sdev: The device to ask
283 * @buffer: Where to put the result
284 * @page: Which Vital Product Data to return
285 * @len: The length of the buffer
286 *
287 * This is an internal helper function. You probably want to use
288 * scsi_get_vpd_page instead.
289 *
bc8945df 290 * Returns size of the vpd page on success or a negative error number.
881a256d
MW
291 */
292static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
293 u8 page, unsigned len)
294{
295 int result;
296 unsigned char cmd[16];
297
bc8945df
HR
298 if (len < 4)
299 return -EINVAL;
300
881a256d
MW
301 cmd[0] = INQUIRY;
302 cmd[1] = 1; /* EVPD */
303 cmd[2] = page;
304 cmd[3] = len >> 8;
305 cmd[4] = len & 0xff;
306 cmd[5] = 0; /* Control byte */
307
308 /*
309 * I'm not convinced we need to try quite this hard to get VPD, but
310 * all the existing users tried this hard.
311 */
312 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
95a3639e 313 len, NULL, 30 * HZ, 3, NULL);
881a256d 314 if (result)
bc8945df 315 return -EIO;
881a256d
MW
316
317 /* Sanity check that we got the page back that we asked for */
318 if (buffer[1] != page)
319 return -EIO;
320
bc8945df 321 return get_unaligned_be16(&buffer[2]) + 4;
881a256d
MW
322}
323
c92a6b5d
MP
324static int scsi_get_vpd_size(struct scsi_device *sdev, u8 page)
325{
326 unsigned char vpd_header[SCSI_VPD_HEADER_SIZE] __aligned(4);
327 int result;
328
329 /*
330 * Fetch the VPD page header to find out how big the page
331 * is. This is done to prevent problems on legacy devices
332 * which can not handle allocation lengths as large as
333 * potentially requested by the caller.
334 */
335 result = scsi_vpd_inquiry(sdev, vpd_header, page, sizeof(vpd_header));
336 if (result < 0)
337 return 0;
338
339 if (result < SCSI_VPD_HEADER_SIZE) {
340 dev_warn_once(&sdev->sdev_gendev,
341 "%s: short VPD page 0x%02x length: %d bytes\n",
342 __func__, page, result);
343 return 0;
344 }
345
346 return result;
347}
348
881a256d
MW
349/**
350 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
351 * @sdev: The device to ask
352 * @page: Which Vital Product Data to return
786f8ba2
RD
353 * @buf: where to store the VPD
354 * @buf_len: number of bytes in the VPD buffer area
881a256d
MW
355 *
356 * SCSI devices may optionally supply Vital Product Data. Each 'page'
357 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
c92a6b5d
MP
358 * If the device supports this VPD page, this routine fills @buf
359 * with the data from that page and return 0. If the VPD page is not
360 * supported or its content cannot be retrieved, -EINVAL is returned.
881a256d 361 */
e3deec09
JB
362int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
363 int buf_len)
881a256d 364{
c92a6b5d 365 int result, vpd_len;
881a256d 366
c92a6b5d
MP
367 if (!scsi_device_supports_vpd(sdev))
368 return -EINVAL;
881a256d 369
c92a6b5d
MP
370 vpd_len = scsi_get_vpd_size(sdev, page);
371 if (vpd_len <= 0)
372 return -EINVAL;
e3deec09 373
c92a6b5d 374 vpd_len = min(vpd_len, buf_len);
881a256d 375
c92a6b5d
MP
376 /*
377 * Fetch the actual page. Since the appropriate size was reported
378 * by the device it is now safe to ask for something bigger.
379 */
380 memset(buf, 0, buf_len);
381 result = scsi_vpd_inquiry(sdev, buf, page, vpd_len);
bc8945df 382 if (result < 0)
c92a6b5d
MP
383 return -EINVAL;
384 else if (result > vpd_len)
385 dev_warn_once(&sdev->sdev_gendev,
386 "%s: VPD page 0x%02x result %d > %d bytes\n",
387 __func__, page, result, vpd_len);
881a256d 388
e3deec09 389 return 0;
881a256d
MW
390}
391EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
392
1e3f720a
BVA
393/**
394 * scsi_get_vpd_buf - Get Vital Product Data from a SCSI device
395 * @sdev: The device to ask
396 * @page: Which Vital Product Data to return
1e3f720a
BVA
397 *
398 * Returns %NULL upon failure.
399 */
ccf1e004 400static struct scsi_vpd *scsi_get_vpd_buf(struct scsi_device *sdev, u8 page)
1e3f720a 401{
ccf1e004 402 struct scsi_vpd *vpd_buf;
c92a6b5d
MP
403 int vpd_len, result;
404
405 vpd_len = scsi_get_vpd_size(sdev, page);
406 if (vpd_len <= 0)
407 return NULL;
1e3f720a
BVA
408
409retry_pg:
c92a6b5d
MP
410 /*
411 * Fetch the actual page. Since the appropriate size was reported
412 * by the device it is now safe to ask for something bigger.
413 */
ccf1e004 414 vpd_buf = kmalloc(sizeof(*vpd_buf) + vpd_len, GFP_KERNEL);
1e3f720a
BVA
415 if (!vpd_buf)
416 return NULL;
417
ccf1e004 418 result = scsi_vpd_inquiry(sdev, vpd_buf->data, page, vpd_len);
1e3f720a
BVA
419 if (result < 0) {
420 kfree(vpd_buf);
421 return NULL;
422 }
423 if (result > vpd_len) {
c92a6b5d
MP
424 dev_warn_once(&sdev->sdev_gendev,
425 "%s: VPD page 0x%02x result %d > %d bytes\n",
426 __func__, page, result, vpd_len);
1e3f720a
BVA
427 vpd_len = result;
428 kfree(vpd_buf);
429 goto retry_pg;
430 }
431
ccf1e004 432 vpd_buf->len = result;
1e3f720a
BVA
433
434 return vpd_buf;
435}
436
437static void scsi_update_vpd_page(struct scsi_device *sdev, u8 page,
ccf1e004 438 struct scsi_vpd __rcu **sdev_vpd_buf)
1e3f720a 439{
ccf1e004 440 struct scsi_vpd *vpd_buf;
1e3f720a 441
ccf1e004 442 vpd_buf = scsi_get_vpd_buf(sdev, page);
1e3f720a
BVA
443 if (!vpd_buf)
444 return;
445
446 mutex_lock(&sdev->inquiry_mutex);
c0eaf15c
PM
447 vpd_buf = rcu_replace_pointer(*sdev_vpd_buf, vpd_buf,
448 lockdep_is_held(&sdev->inquiry_mutex));
1e3f720a
BVA
449 mutex_unlock(&sdev->inquiry_mutex);
450
ccf1e004
BVA
451 if (vpd_buf)
452 kfree_rcu(vpd_buf, rcu);
1e3f720a
BVA
453}
454
b3ae8780
HR
455/**
456 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
457 * @sdev: The device to ask
458 *
459 * Attach the 'Device Identification' VPD page (0x83) and the
460 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
461 * structure. This information can be used to identify the device
462 * uniquely.
463 */
464void scsi_attach_vpd(struct scsi_device *sdev)
465{
ccf1e004
BVA
466 int i;
467 struct scsi_vpd *vpd_buf;
b3ae8780 468
5ddfe085 469 if (!scsi_device_supports_vpd(sdev))
b3ae8780 470 return;
5ddfe085 471
b3ae8780 472 /* Ask for all the pages supported by this device */
ccf1e004 473 vpd_buf = scsi_get_vpd_buf(sdev, 0);
1e3f720a 474 if (!vpd_buf)
b3ae8780 475 return;
b3ae8780 476
ccf1e004 477 for (i = 4; i < vpd_buf->len; i++) {
d188b067
RA
478 if (vpd_buf->data[i] == 0x0)
479 scsi_update_vpd_page(sdev, 0x0, &sdev->vpd_pg0);
ccf1e004
BVA
480 if (vpd_buf->data[i] == 0x80)
481 scsi_update_vpd_page(sdev, 0x80, &sdev->vpd_pg80);
482 if (vpd_buf->data[i] == 0x83)
483 scsi_update_vpd_page(sdev, 0x83, &sdev->vpd_pg83);
d188b067
RA
484 if (vpd_buf->data[i] == 0x89)
485 scsi_update_vpd_page(sdev, 0x89, &sdev->vpd_pg89);
e60ac0b9
MP
486 if (vpd_buf->data[i] == 0xb0)
487 scsi_update_vpd_page(sdev, 0xb0, &sdev->vpd_pgb0);
488 if (vpd_buf->data[i] == 0xb1)
489 scsi_update_vpd_page(sdev, 0xb1, &sdev->vpd_pgb1);
490 if (vpd_buf->data[i] == 0xb2)
491 scsi_update_vpd_page(sdev, 0xb2, &sdev->vpd_pgb2);
b3ae8780
HR
492 }
493 kfree(vpd_buf);
b3ae8780
HR
494}
495
3c6bdaea
MP
496/**
497 * scsi_report_opcode - Find out if a given command opcode is supported
498 * @sdev: scsi device to query
499 * @buffer: scratch buffer (must be at least 20 bytes long)
500 * @len: length of buffer
501 * @opcode: opcode for command to look up
502 *
503 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
66c28f97
MP
504 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
505 * unsupported and 1 if the device claims to support the command.
3c6bdaea
MP
506 */
507int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
508 unsigned int len, unsigned char opcode)
509{
510 unsigned char cmd[16];
511 struct scsi_sense_hdr sshdr;
e17d6340 512 int result, request_len;
3c6bdaea
MP
513
514 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
66c28f97 515 return -EINVAL;
3c6bdaea 516
e17d6340
MP
517 /* RSOC header + size of command we are asking about */
518 request_len = 4 + COMMAND_SIZE(opcode);
519 if (request_len > len) {
520 dev_warn_once(&sdev->sdev_gendev,
521 "%s: len %u bytes, opcode 0x%02x needs %u\n",
522 __func__, len, opcode, request_len);
523 return -EINVAL;
524 }
525
3c6bdaea
MP
526 memset(cmd, 0, 16);
527 cmd[0] = MAINTENANCE_IN;
528 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
529 cmd[2] = 1; /* One command format */
530 cmd[3] = opcode;
e17d6340 531 put_unaligned_be32(request_len, &cmd[6]);
3c6bdaea
MP
532 memset(buffer, 0, len);
533
e17d6340
MP
534 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
535 request_len, &sshdr, 30 * HZ, 3, NULL);
3c6bdaea 536
ced202f7
HR
537 if (result < 0)
538 return result;
3c6bdaea
MP
539 if (result && scsi_sense_valid(&sshdr) &&
540 sshdr.sense_key == ILLEGAL_REQUEST &&
541 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
66c28f97 542 return -EINVAL;
3c6bdaea
MP
543
544 if ((buffer[1] & 3) == 3) /* Command supported */
545 return 1;
546
547 return 0;
548}
549EXPORT_SYMBOL(scsi_report_opcode);
550
1da177e4 551/**
eb44820c 552 * scsi_device_get - get an additional reference to a scsi_device
1da177e4
LT
553 * @sdev: device to get a reference to
554 *
eb44820c 555 * Description: Gets a reference to the scsi_device and increments the use count
1da177e4
LT
556 * of the underlying LLDD module. You must hold host_lock of the
557 * parent Scsi_Host or already have a reference when calling this.
cff549e4
CH
558 *
559 * This will fail if a device is deleted or cancelled, or when the LLD module
560 * is in the process of being unloaded.
1da177e4
LT
561 */
562int scsi_device_get(struct scsi_device *sdev)
563{
cff549e4
CH
564 if (sdev->sdev_state == SDEV_DEL || sdev->sdev_state == SDEV_CANCEL)
565 goto fail;
1da177e4 566 if (!get_device(&sdev->sdev_gendev))
cff549e4
CH
567 goto fail;
568 if (!try_module_get(sdev->host->hostt->module))
569 goto fail_put_device;
1da177e4 570 return 0;
cff549e4
CH
571
572fail_put_device:
573 put_device(&sdev->sdev_gendev);
574fail:
575 return -ENXIO;
1da177e4
LT
576}
577EXPORT_SYMBOL(scsi_device_get);
578
579/**
580 * scsi_device_put - release a reference to a scsi_device
581 * @sdev: device to release a reference on.
582 *
eb44820c
RL
583 * Description: Release a reference to the scsi_device and decrements the use
584 * count of the underlying LLDD module. The device is freed once the last
1da177e4
LT
585 * user vanishes.
586 */
587void scsi_device_put(struct scsi_device *sdev)
588{
1a928378
ML
589 /*
590 * Decreasing the module reference count before the device reference
591 * count is safe since scsi_remove_host() only returns after all
592 * devices have been removed.
593 */
594 module_put(sdev->host->hostt->module);
1da177e4
LT
595 put_device(&sdev->sdev_gendev);
596}
597EXPORT_SYMBOL(scsi_device_put);
598
eb44820c 599/* helper for shost_for_each_device, see that for documentation */
1da177e4
LT
600struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
601 struct scsi_device *prev)
602{
603 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
604 struct scsi_device *next = NULL;
605 unsigned long flags;
606
607 spin_lock_irqsave(shost->host_lock, flags);
608 while (list->next != &shost->__devices) {
609 next = list_entry(list->next, struct scsi_device, siblings);
610 /* skip devices that we can't get a reference to */
611 if (!scsi_device_get(next))
612 break;
613 next = NULL;
614 list = list->next;
615 }
616 spin_unlock_irqrestore(shost->host_lock, flags);
617
618 if (prev)
619 scsi_device_put(prev);
620 return next;
621}
622EXPORT_SYMBOL(__scsi_iterate_devices);
623
624/**
625 * starget_for_each_device - helper to walk all devices of a target
626 * @starget: target whose devices we want to iterate over.
eb44820c
RL
627 * @data: Opaque passed to each function call.
628 * @fn: Function to call on each device
1da177e4 629 *
522939d4 630 * This traverses over each device of @starget. The devices have
1da177e4
LT
631 * a reference that must be released by scsi_host_put when breaking
632 * out of the loop.
633 */
522939d4 634void starget_for_each_device(struct scsi_target *starget, void *data,
1da177e4
LT
635 void (*fn)(struct scsi_device *, void *))
636{
637 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
638 struct scsi_device *sdev;
639
640 shost_for_each_device(sdev, shost) {
641 if ((sdev->channel == starget->channel) &&
642 (sdev->id == starget->id))
643 fn(sdev, data);
644 }
645}
646EXPORT_SYMBOL(starget_for_each_device);
647
522939d4 648/**
14f501a4 649 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
522939d4 650 * @starget: target whose devices we want to iterate over.
14f501a4
RD
651 * @data: parameter for callback @fn()
652 * @fn: callback function that is invoked for each device
522939d4
MR
653 *
654 * This traverses over each device of @starget. It does _not_
655 * take a reference on the scsi_device, so the whole loop must be
656 * protected by shost->host_lock.
657 *
658 * Note: The only reason why drivers would want to use this is because
659 * they need to access the device list in irq context. Otherwise you
660 * really want to use starget_for_each_device instead.
661 **/
662void __starget_for_each_device(struct scsi_target *starget, void *data,
663 void (*fn)(struct scsi_device *, void *))
664{
665 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
666 struct scsi_device *sdev;
667
668 __shost_for_each_device(sdev, shost) {
669 if ((sdev->channel == starget->channel) &&
670 (sdev->id == starget->id))
671 fn(sdev, data);
672 }
673}
674EXPORT_SYMBOL(__starget_for_each_device);
675
1da177e4
LT
676/**
677 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
678 * @starget: SCSI target pointer
679 * @lun: SCSI Logical Unit Number
680 *
eb44820c
RL
681 * Description: Looks up the scsi_device with the specified @lun for a given
682 * @starget. The returned scsi_device does not have an additional
1da177e4 683 * reference. You must hold the host's host_lock over this call and
32aeef60
HR
684 * any access to the returned scsi_device. A scsi_device in state
685 * SDEV_DEL is skipped.
1da177e4 686 *
dc8875e1 687 * Note: The only reason why drivers should use this is because
eb44820c 688 * they need to access the device list in irq context. Otherwise you
1da177e4
LT
689 * really want to use scsi_device_lookup_by_target instead.
690 **/
691struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
9cb78c16 692 u64 lun)
1da177e4
LT
693{
694 struct scsi_device *sdev;
695
696 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
32aeef60
HR
697 if (sdev->sdev_state == SDEV_DEL)
698 continue;
1da177e4
LT
699 if (sdev->lun ==lun)
700 return sdev;
701 }
702
703 return NULL;
704}
705EXPORT_SYMBOL(__scsi_device_lookup_by_target);
706
707/**
708 * scsi_device_lookup_by_target - find a device given the target
709 * @starget: SCSI target pointer
710 * @lun: SCSI Logical Unit Number
711 *
477e608c
BZ
712 * Description: Looks up the scsi_device with the specified @lun for a given
713 * @starget. The returned scsi_device has an additional reference that
eb44820c 714 * needs to be released with scsi_device_put once you're done with it.
1da177e4
LT
715 **/
716struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
9cb78c16 717 u64 lun)
1da177e4
LT
718{
719 struct scsi_device *sdev;
720 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
721 unsigned long flags;
722
723 spin_lock_irqsave(shost->host_lock, flags);
724 sdev = __scsi_device_lookup_by_target(starget, lun);
725 if (sdev && scsi_device_get(sdev))
726 sdev = NULL;
727 spin_unlock_irqrestore(shost->host_lock, flags);
728
729 return sdev;
730}
731EXPORT_SYMBOL(scsi_device_lookup_by_target);
732
733/**
eb44820c 734 * __scsi_device_lookup - find a device given the host (UNLOCKED)
1da177e4
LT
735 * @shost: SCSI host pointer
736 * @channel: SCSI channel (zero if only one channel)
eb44820c 737 * @id: SCSI target number (physical unit number)
1da177e4
LT
738 * @lun: SCSI Logical Unit Number
739 *
eb44820c
RL
740 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
741 * for a given host. The returned scsi_device does not have an additional
742 * reference. You must hold the host's host_lock over this call and any access
743 * to the returned scsi_device.
1da177e4
LT
744 *
745 * Note: The only reason why drivers would want to use this is because
eb44820c 746 * they need to access the device list in irq context. Otherwise you
1da177e4
LT
747 * really want to use scsi_device_lookup instead.
748 **/
749struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
9cb78c16 750 uint channel, uint id, u64 lun)
1da177e4
LT
751{
752 struct scsi_device *sdev;
753
754 list_for_each_entry(sdev, &shost->__devices, siblings) {
4ff7adc8
ZZ
755 if (sdev->sdev_state == SDEV_DEL)
756 continue;
1da177e4
LT
757 if (sdev->channel == channel && sdev->id == id &&
758 sdev->lun ==lun)
759 return sdev;
760 }
761
762 return NULL;
763}
764EXPORT_SYMBOL(__scsi_device_lookup);
765
766/**
767 * scsi_device_lookup - find a device given the host
768 * @shost: SCSI host pointer
769 * @channel: SCSI channel (zero if only one channel)
770 * @id: SCSI target number (physical unit number)
771 * @lun: SCSI Logical Unit Number
772 *
eb44820c
RL
773 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
774 * for a given host. The returned scsi_device has an additional reference that
775 * needs to be released with scsi_device_put once you're done with it.
1da177e4
LT
776 **/
777struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
9cb78c16 778 uint channel, uint id, u64 lun)
1da177e4
LT
779{
780 struct scsi_device *sdev;
781 unsigned long flags;
782
783 spin_lock_irqsave(shost->host_lock, flags);
784 sdev = __scsi_device_lookup(shost, channel, id, lun);
785 if (sdev && scsi_device_get(sdev))
786 sdev = NULL;
787 spin_unlock_irqrestore(shost->host_lock, flags);
788
789 return sdev;
790}
791EXPORT_SYMBOL(scsi_device_lookup);
792
1da177e4
LT
793MODULE_DESCRIPTION("SCSI core");
794MODULE_LICENSE("GPL");
795
796module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
797MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
798
799static int __init init_scsi(void)
800{
9bf09c23 801 int error;
1da177e4 802
1da177e4
LT
803 error = scsi_init_procfs();
804 if (error)
805 goto cleanup_queue;
806 error = scsi_init_devinfo();
807 if (error)
808 goto cleanup_procfs;
809 error = scsi_init_hosts();
810 if (error)
811 goto cleanup_devlist;
812 error = scsi_init_sysctl();
813 if (error)
814 goto cleanup_hosts;
815 error = scsi_sysfs_register();
816 if (error)
817 goto cleanup_sysctl;
818
84314fd4
JS
819 scsi_netlink_init();
820
1da177e4
LT
821 printk(KERN_NOTICE "SCSI subsystem initialized\n");
822 return 0;
823
824cleanup_sysctl:
825 scsi_exit_sysctl();
826cleanup_hosts:
827 scsi_exit_hosts();
828cleanup_devlist:
829 scsi_exit_devinfo();
830cleanup_procfs:
831 scsi_exit_procfs();
832cleanup_queue:
833 scsi_exit_queue();
834 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
835 -error);
836 return error;
837}
838
839static void __exit exit_scsi(void)
840{
84314fd4 841 scsi_netlink_exit();
1da177e4
LT
842 scsi_sysfs_unregister();
843 scsi_exit_sysctl();
844 scsi_exit_hosts();
845 scsi_exit_devinfo();
1da177e4
LT
846 scsi_exit_procfs();
847 scsi_exit_queue();
1da177e4
LT
848}
849
850subsys_initcall(init_scsi);
851module_exit(exit_scsi);