2 * scsi.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
4 * Copyright (C) 2002, 2003 Christoph Hellwig
6 * generic mid-level SCSI driver
7 * Initial versions: Drew Eckhardt
8 * Subsequent revisions: Eric Youngdale
12 * Bug correction thanks go to :
13 * Rik Faith <faith@cs.unc.edu>
14 * Tommy Thorn <tthorn>
15 * Thomas Wuensche <tw@fgb1.fgb.mw.tu-muenchen.de>
17 * Modified by Eric Youngdale eric@andante.org or ericy@gnu.ai.mit.edu to
18 * add scatter-gather, multiple outstanding request, and other
21 * Native multichannel, wide scsi, /proc/scsi and hot plugging
22 * support added by Michael Neuffer <mike@i-connect.net>
24 * Added request_module("scsi_hostadapter") for kerneld:
25 * (Put an "alias scsi_hostadapter your_hostadapter" in /etc/modprobe.conf)
26 * Bjorn Ekwall <bj0rn@blox.se>
29 * Major improvements to the timeout, abort, and reset processing,
30 * as well as performance modifications for large queue depths by
31 * Leonard N. Zubkoff <lnz@dandelion.com>
33 * Converted cli() code to spinlocks, Ingo Molnar
35 * Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
37 * out_of_space hacks, D. Gilbert (dpg) 990608
40 #include <linux/module.h>
41 #include <linux/moduleparam.h>
42 #include <linux/kernel.h>
43 #include <linux/timer.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/blkdev.h>
47 #include <linux/delay.h>
48 #include <linux/init.h>
49 #include <linux/completion.h>
50 #include <linux/unistd.h>
51 #include <linux/spinlock.h>
52 #include <linux/kmod.h>
53 #include <linux/interrupt.h>
54 #include <linux/notifier.h>
55 #include <linux/cpu.h>
56 #include <linux/mutex.h>
57 #include <linux/async.h>
58 #include <asm/unaligned.h>
60 #include <scsi/scsi.h>
61 #include <scsi/scsi_cmnd.h>
62 #include <scsi/scsi_dbg.h>
63 #include <scsi/scsi_device.h>
64 #include <scsi/scsi_driver.h>
65 #include <scsi/scsi_eh.h>
66 #include <scsi/scsi_host.h>
67 #include <scsi/scsi_tcq.h>
69 #include "scsi_priv.h"
70 #include "scsi_logging.h"
72 #define CREATE_TRACE_POINTS
73 #include <trace/events/scsi.h>
75 static void scsi_done(struct scsi_cmnd
*cmd
);
78 * Definitions and constants.
82 * Note - the initial logging level can be set here to log events at boot time.
83 * After the system is up, you may enable logging via the /proc interface.
85 unsigned int scsi_logging_level
;
86 #if defined(CONFIG_SCSI_LOGGING)
87 EXPORT_SYMBOL(scsi_logging_level
);
90 /* sd, scsi core and power management need to coordinate flushing async actions */
91 ASYNC_DOMAIN(scsi_sd_probe_domain
);
92 EXPORT_SYMBOL(scsi_sd_probe_domain
);
94 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
95 * You may not alter any existing entry (although adding new ones is
96 * encouraged once assigned by ANSI/INCITS T10
98 static const char *const scsi_device_types
[] = {
121 * scsi_device_type - Return 17 char string indicating device type.
122 * @type: type number to look up
125 const char * scsi_device_type(unsigned type
)
128 return "Well-known LUN ";
131 if (type
>= ARRAY_SIZE(scsi_device_types
))
133 return scsi_device_types
[type
];
136 EXPORT_SYMBOL(scsi_device_type
);
138 struct scsi_host_cmd_pool
{
139 struct kmem_cache
*cmd_slab
;
140 struct kmem_cache
*sense_slab
;
144 unsigned int slab_flags
;
148 static struct scsi_host_cmd_pool scsi_cmd_pool
= {
149 .cmd_name
= "scsi_cmd_cache",
150 .sense_name
= "scsi_sense_cache",
151 .slab_flags
= SLAB_HWCACHE_ALIGN
,
154 static struct scsi_host_cmd_pool scsi_cmd_dma_pool
= {
155 .cmd_name
= "scsi_cmd_cache(DMA)",
156 .sense_name
= "scsi_sense_cache(DMA)",
157 .slab_flags
= SLAB_HWCACHE_ALIGN
|SLAB_CACHE_DMA
,
158 .gfp_mask
= __GFP_DMA
,
161 static DEFINE_MUTEX(host_cmd_pool_mutex
);
164 * scsi_pool_alloc_command - internal function to get a fully allocated command
165 * @pool: slab pool to allocate the command from
166 * @gfp_mask: mask for the allocation
168 * Returns a fully allocated command (with the allied sense buffer) or
171 static struct scsi_cmnd
*
172 scsi_pool_alloc_command(struct scsi_host_cmd_pool
*pool
, gfp_t gfp_mask
)
174 struct scsi_cmnd
*cmd
;
176 cmd
= kmem_cache_zalloc(pool
->cmd_slab
, gfp_mask
| pool
->gfp_mask
);
180 cmd
->sense_buffer
= kmem_cache_alloc(pool
->sense_slab
,
181 gfp_mask
| pool
->gfp_mask
);
182 if (!cmd
->sense_buffer
) {
183 kmem_cache_free(pool
->cmd_slab
, cmd
);
191 * scsi_pool_free_command - internal function to release a command
192 * @pool: slab pool to allocate the command from
193 * @cmd: command to release
195 * the command must previously have been allocated by
196 * scsi_pool_alloc_command.
199 scsi_pool_free_command(struct scsi_host_cmd_pool
*pool
,
200 struct scsi_cmnd
*cmd
)
203 kmem_cache_free(scsi_sdb_cache
, cmd
->prot_sdb
);
205 kmem_cache_free(pool
->sense_slab
, cmd
->sense_buffer
);
206 kmem_cache_free(pool
->cmd_slab
, cmd
);
210 * scsi_host_alloc_command - internal function to allocate command
211 * @shost: SCSI host whose pool to allocate from
212 * @gfp_mask: mask for the allocation
214 * Returns a fully allocated command with sense buffer and protection
215 * data buffer (where applicable) or NULL on failure
217 static struct scsi_cmnd
*
218 scsi_host_alloc_command(struct Scsi_Host
*shost
, gfp_t gfp_mask
)
220 struct scsi_cmnd
*cmd
;
222 cmd
= scsi_pool_alloc_command(shost
->cmd_pool
, gfp_mask
);
226 if (scsi_host_get_prot(shost
) >= SHOST_DIX_TYPE0_PROTECTION
) {
227 cmd
->prot_sdb
= kmem_cache_zalloc(scsi_sdb_cache
, gfp_mask
);
229 if (!cmd
->prot_sdb
) {
230 scsi_pool_free_command(shost
->cmd_pool
, cmd
);
239 * __scsi_get_command - Allocate a struct scsi_cmnd
240 * @shost: host to transmit command
241 * @gfp_mask: allocation mask
243 * Description: allocate a struct scsi_cmd from host's slab, recycling from the
244 * host's free_list if necessary.
246 struct scsi_cmnd
*__scsi_get_command(struct Scsi_Host
*shost
, gfp_t gfp_mask
)
248 struct scsi_cmnd
*cmd
= scsi_host_alloc_command(shost
, gfp_mask
);
250 if (unlikely(!cmd
)) {
253 spin_lock_irqsave(&shost
->free_list_lock
, flags
);
254 if (likely(!list_empty(&shost
->free_list
))) {
255 cmd
= list_entry(shost
->free_list
.next
,
256 struct scsi_cmnd
, list
);
257 list_del_init(&cmd
->list
);
259 spin_unlock_irqrestore(&shost
->free_list_lock
, flags
);
264 buf
= cmd
->sense_buffer
;
265 prot
= cmd
->prot_sdb
;
267 memset(cmd
, 0, sizeof(*cmd
));
269 cmd
->sense_buffer
= buf
;
270 cmd
->prot_sdb
= prot
;
276 EXPORT_SYMBOL_GPL(__scsi_get_command
);
279 * scsi_get_command - Allocate and setup a scsi command block
280 * @dev: parent scsi device
281 * @gfp_mask: allocator flags
283 * Returns: The allocated scsi command structure.
285 struct scsi_cmnd
*scsi_get_command(struct scsi_device
*dev
, gfp_t gfp_mask
)
287 struct scsi_cmnd
*cmd
= __scsi_get_command(dev
->host
, gfp_mask
);
290 if (unlikely(cmd
== NULL
))
294 INIT_LIST_HEAD(&cmd
->list
);
295 INIT_DELAYED_WORK(&cmd
->abort_work
, scmd_eh_abort_handler
);
296 spin_lock_irqsave(&dev
->list_lock
, flags
);
297 list_add_tail(&cmd
->list
, &dev
->cmd_list
);
298 spin_unlock_irqrestore(&dev
->list_lock
, flags
);
299 cmd
->jiffies_at_alloc
= jiffies
;
302 EXPORT_SYMBOL(scsi_get_command
);
305 * __scsi_put_command - Free a struct scsi_cmnd
307 * @cmd: Command to free
309 void __scsi_put_command(struct Scsi_Host
*shost
, struct scsi_cmnd
*cmd
)
313 if (unlikely(list_empty(&shost
->free_list
))) {
314 spin_lock_irqsave(&shost
->free_list_lock
, flags
);
315 if (list_empty(&shost
->free_list
)) {
316 list_add(&cmd
->list
, &shost
->free_list
);
319 spin_unlock_irqrestore(&shost
->free_list_lock
, flags
);
322 if (likely(cmd
!= NULL
))
323 scsi_pool_free_command(shost
->cmd_pool
, cmd
);
325 EXPORT_SYMBOL(__scsi_put_command
);
328 * scsi_put_command - Free a scsi command block
329 * @cmd: command block to free
333 * Notes: The command must not belong to any lists.
335 void scsi_put_command(struct scsi_cmnd
*cmd
)
339 /* serious error if the command hasn't come from a device list */
340 spin_lock_irqsave(&cmd
->device
->list_lock
, flags
);
341 BUG_ON(list_empty(&cmd
->list
));
342 list_del_init(&cmd
->list
);
343 spin_unlock_irqrestore(&cmd
->device
->list_lock
, flags
);
345 cancel_delayed_work(&cmd
->abort_work
);
347 __scsi_put_command(cmd
->device
->host
, cmd
);
349 EXPORT_SYMBOL(scsi_put_command
);
351 static struct scsi_host_cmd_pool
*scsi_get_host_cmd_pool(gfp_t gfp_mask
)
353 struct scsi_host_cmd_pool
*retval
= NULL
, *pool
;
355 * Select a command slab for this host and create it if not
358 mutex_lock(&host_cmd_pool_mutex
);
359 pool
= (gfp_mask
& __GFP_DMA
) ? &scsi_cmd_dma_pool
:
362 pool
->cmd_slab
= kmem_cache_create(pool
->cmd_name
,
363 sizeof(struct scsi_cmnd
), 0,
364 pool
->slab_flags
, NULL
);
368 pool
->sense_slab
= kmem_cache_create(pool
->sense_name
,
369 SCSI_SENSE_BUFFERSIZE
, 0,
370 pool
->slab_flags
, NULL
);
371 if (!pool
->sense_slab
) {
372 kmem_cache_destroy(pool
->cmd_slab
);
380 mutex_unlock(&host_cmd_pool_mutex
);
384 static void scsi_put_host_cmd_pool(gfp_t gfp_mask
)
386 struct scsi_host_cmd_pool
*pool
;
388 mutex_lock(&host_cmd_pool_mutex
);
389 pool
= (gfp_mask
& __GFP_DMA
) ? &scsi_cmd_dma_pool
:
392 * This may happen if a driver has a mismatched get and put
393 * of the command pool; the driver should be implicated in
396 BUG_ON(pool
->users
== 0);
398 if (!--pool
->users
) {
399 kmem_cache_destroy(pool
->cmd_slab
);
400 kmem_cache_destroy(pool
->sense_slab
);
402 mutex_unlock(&host_cmd_pool_mutex
);
406 * scsi_allocate_command - get a fully allocated SCSI command
407 * @gfp_mask: allocation mask
409 * This function is for use outside of the normal host based pools.
410 * It allocates the relevant command and takes an additional reference
411 * on the pool it used. This function *must* be paired with
412 * scsi_free_command which also has the identical mask, otherwise the
413 * free pool counts will eventually go wrong and you'll trigger a bug.
415 * This function should *only* be used by drivers that need a static
416 * command allocation at start of day for internal functions.
418 struct scsi_cmnd
*scsi_allocate_command(gfp_t gfp_mask
)
420 struct scsi_host_cmd_pool
*pool
= scsi_get_host_cmd_pool(gfp_mask
);
425 return scsi_pool_alloc_command(pool
, gfp_mask
);
427 EXPORT_SYMBOL(scsi_allocate_command
);
430 * scsi_free_command - free a command allocated by scsi_allocate_command
431 * @gfp_mask: mask used in the original allocation
432 * @cmd: command to free
434 * Note: using the original allocation mask is vital because that's
435 * what determines which command pool we use to free the command. Any
436 * mismatch will cause the system to BUG eventually.
438 void scsi_free_command(gfp_t gfp_mask
, struct scsi_cmnd
*cmd
)
440 struct scsi_host_cmd_pool
*pool
= scsi_get_host_cmd_pool(gfp_mask
);
443 * this could trigger if the mask to scsi_allocate_command
444 * doesn't match this mask. Otherwise we're guaranteed that this
445 * succeeds because scsi_allocate_command must have taken a reference
450 scsi_pool_free_command(pool
, cmd
);
452 * scsi_put_host_cmd_pool is called twice; once to release the
453 * reference we took above, and once to release the reference
454 * originally taken by scsi_allocate_command
456 scsi_put_host_cmd_pool(gfp_mask
);
457 scsi_put_host_cmd_pool(gfp_mask
);
459 EXPORT_SYMBOL(scsi_free_command
);
462 * scsi_setup_command_freelist - Setup the command freelist for a scsi host.
463 * @shost: host to allocate the freelist for.
465 * Description: The command freelist protects against system-wide out of memory
466 * deadlock by preallocating one SCSI command structure for each host, so the
467 * system can always write to a swap file on a device associated with that host.
471 int scsi_setup_command_freelist(struct Scsi_Host
*shost
)
473 struct scsi_cmnd
*cmd
;
474 const gfp_t gfp_mask
= shost
->unchecked_isa_dma
? GFP_DMA
: GFP_KERNEL
;
476 spin_lock_init(&shost
->free_list_lock
);
477 INIT_LIST_HEAD(&shost
->free_list
);
479 shost
->cmd_pool
= scsi_get_host_cmd_pool(gfp_mask
);
481 if (!shost
->cmd_pool
)
485 * Get one backup command for this host.
487 cmd
= scsi_host_alloc_command(shost
, gfp_mask
);
489 scsi_put_host_cmd_pool(gfp_mask
);
490 shost
->cmd_pool
= NULL
;
493 list_add(&cmd
->list
, &shost
->free_list
);
498 * scsi_destroy_command_freelist - Release the command freelist for a scsi host.
499 * @shost: host whose freelist is going to be destroyed
501 void scsi_destroy_command_freelist(struct Scsi_Host
*shost
)
504 * If cmd_pool is NULL the free list was not initialized, so
505 * do not attempt to release resources.
507 if (!shost
->cmd_pool
)
510 while (!list_empty(&shost
->free_list
)) {
511 struct scsi_cmnd
*cmd
;
513 cmd
= list_entry(shost
->free_list
.next
, struct scsi_cmnd
, list
);
514 list_del_init(&cmd
->list
);
515 scsi_pool_free_command(shost
->cmd_pool
, cmd
);
517 shost
->cmd_pool
= NULL
;
518 scsi_put_host_cmd_pool(shost
->unchecked_isa_dma
? GFP_DMA
: GFP_KERNEL
);
521 #ifdef CONFIG_SCSI_LOGGING
522 void scsi_log_send(struct scsi_cmnd
*cmd
)
527 * If ML QUEUE log level is greater than or equal to:
529 * 1: nothing (match completion)
531 * 2: log opcode + command of all commands
533 * 3: same as 2 plus dump cmd address
535 * 4: same as 3 plus dump extra junk
537 if (unlikely(scsi_logging_level
)) {
538 level
= SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT
,
539 SCSI_LOG_MLQUEUE_BITS
);
541 scmd_printk(KERN_INFO
, cmd
, "Send: ");
543 printk("0x%p ", cmd
);
545 scsi_print_command(cmd
);
547 printk(KERN_INFO
"buffer = 0x%p, bufflen = %d,"
548 " queuecommand 0x%p\n",
549 scsi_sglist(cmd
), scsi_bufflen(cmd
),
550 cmd
->device
->host
->hostt
->queuecommand
);
557 void scsi_log_completion(struct scsi_cmnd
*cmd
, int disposition
)
562 * If ML COMPLETE log level is greater than or equal to:
564 * 1: log disposition, result, opcode + command, and conditionally
565 * sense data for failures or non SUCCESS dispositions.
567 * 2: same as 1 but for all command completions.
569 * 3: same as 2 plus dump cmd address
571 * 4: same as 3 plus dump extra junk
573 if (unlikely(scsi_logging_level
)) {
574 level
= SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT
,
575 SCSI_LOG_MLCOMPLETE_BITS
);
576 if (((level
> 0) && (cmd
->result
|| disposition
!= SUCCESS
)) ||
578 scmd_printk(KERN_INFO
, cmd
, "Done: ");
580 printk("0x%p ", cmd
);
582 * Dump truncated values, so we usually fit within
585 switch (disposition
) {
600 * If called via scsi_times_out.
607 scsi_print_result(cmd
);
608 scsi_print_command(cmd
);
609 if (status_byte(cmd
->result
) & CHECK_CONDITION
)
610 scsi_print_sense("", cmd
);
612 scmd_printk(KERN_INFO
, cmd
,
613 "scsi host busy %d failed %d\n",
614 cmd
->device
->host
->host_busy
,
615 cmd
->device
->host
->host_failed
);
622 * scsi_cmd_get_serial - Assign a serial number to a command
623 * @host: the scsi host
624 * @cmd: command to assign serial number to
626 * Description: a serial number identifies a request for error recovery
627 * and debugging purposes. Protected by the Host_Lock of host.
629 void scsi_cmd_get_serial(struct Scsi_Host
*host
, struct scsi_cmnd
*cmd
)
631 cmd
->serial_number
= host
->cmd_serial_number
++;
632 if (cmd
->serial_number
== 0)
633 cmd
->serial_number
= host
->cmd_serial_number
++;
635 EXPORT_SYMBOL(scsi_cmd_get_serial
);
638 * scsi_dispatch_command - Dispatch a command to the low-level driver.
639 * @cmd: command block we are dispatching.
641 * Return: nonzero return request was rejected and device's queue needs to be
644 int scsi_dispatch_cmd(struct scsi_cmnd
*cmd
)
646 struct Scsi_Host
*host
= cmd
->device
->host
;
649 atomic_inc(&cmd
->device
->iorequest_cnt
);
651 /* check if the device is still usable */
652 if (unlikely(cmd
->device
->sdev_state
== SDEV_DEL
)) {
653 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
654 * returns an immediate error upwards, and signals
655 * that the device is no longer present */
656 cmd
->result
= DID_NO_CONNECT
<< 16;
658 /* return 0 (because the command has been processed) */
662 /* Check to see if the scsi lld made this device blocked. */
663 if (unlikely(scsi_device_blocked(cmd
->device
))) {
665 * in blocked state, the command is just put back on
666 * the device queue. The suspend state has already
667 * blocked the queue so future requests should not
668 * occur until the device transitions out of the
672 scsi_queue_insert(cmd
, SCSI_MLQUEUE_DEVICE_BUSY
);
674 SCSI_LOG_MLQUEUE(3, printk("queuecommand : device blocked \n"));
677 * NOTE: rtn is still zero here because we don't need the
678 * queue to be plugged on return (it's already stopped)
684 * If SCSI-2 or lower, store the LUN value in cmnd.
686 if (cmd
->device
->scsi_level
<= SCSI_2
&&
687 cmd
->device
->scsi_level
!= SCSI_UNKNOWN
) {
688 cmd
->cmnd
[1] = (cmd
->cmnd
[1] & 0x1f) |
689 (cmd
->device
->lun
<< 5 & 0xe0);
695 * Before we queue this command, check if the command
696 * length exceeds what the host adapter can handle.
698 if (cmd
->cmd_len
> cmd
->device
->host
->max_cmd_len
) {
700 printk("queuecommand : command too long. "
701 "cdb_size=%d host->max_cmd_len=%d\n",
702 cmd
->cmd_len
, cmd
->device
->host
->max_cmd_len
));
703 cmd
->result
= (DID_ABORT
<< 16);
709 if (unlikely(host
->shost_state
== SHOST_DEL
)) {
710 cmd
->result
= (DID_NO_CONNECT
<< 16);
713 trace_scsi_dispatch_cmd_start(cmd
);
714 cmd
->scsi_done
= scsi_done
;
715 rtn
= host
->hostt
->queuecommand(host
, cmd
);
719 trace_scsi_dispatch_cmd_error(cmd
, rtn
);
720 if (rtn
!= SCSI_MLQUEUE_DEVICE_BUSY
&&
721 rtn
!= SCSI_MLQUEUE_TARGET_BUSY
)
722 rtn
= SCSI_MLQUEUE_HOST_BUSY
;
724 scsi_queue_insert(cmd
, rtn
);
727 printk("queuecommand : request rejected\n"));
731 SCSI_LOG_MLQUEUE(3, printk("leaving scsi_dispatch_cmnd()\n"));
736 * scsi_done - Invoke completion on finished SCSI command.
737 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
738 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
740 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
741 * which regains ownership of the SCSI command (de facto) from a LLDD, and
742 * calls blk_complete_request() for further processing.
744 * This function is interrupt context safe.
746 static void scsi_done(struct scsi_cmnd
*cmd
)
748 trace_scsi_dispatch_cmd_done(cmd
);
749 blk_complete_request(cmd
->request
);
753 * scsi_finish_command - cleanup and pass command back to upper layer
756 * Description: Pass command off to upper layer for finishing of I/O
757 * request, waking processes that are waiting on results,
760 void scsi_finish_command(struct scsi_cmnd
*cmd
)
762 struct scsi_device
*sdev
= cmd
->device
;
763 struct scsi_target
*starget
= scsi_target(sdev
);
764 struct Scsi_Host
*shost
= sdev
->host
;
765 struct scsi_driver
*drv
;
766 unsigned int good_bytes
;
768 scsi_device_unbusy(sdev
);
771 * Clear the flags which say that the device/host is no longer
772 * capable of accepting new commands. These are set in scsi_queue.c
773 * for both the queue full condition on a device, and for a
774 * host full condition on the host.
776 * XXX(hch): What about locking?
778 shost
->host_blocked
= 0;
779 starget
->target_blocked
= 0;
780 sdev
->device_blocked
= 0;
783 * If we have valid sense information, then some kind of recovery
784 * must have taken place. Make a note of this.
786 if (SCSI_SENSE_VALID(cmd
))
787 cmd
->result
|= (DRIVER_SENSE
<< 24);
789 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO
, sdev
,
790 "Notifying upper driver of completion "
791 "(result %x)\n", cmd
->result
));
793 good_bytes
= scsi_bufflen(cmd
);
794 if (cmd
->request
->cmd_type
!= REQ_TYPE_BLOCK_PC
) {
795 int old_good_bytes
= good_bytes
;
796 drv
= scsi_cmd_to_driver(cmd
);
798 good_bytes
= drv
->done(cmd
);
800 * USB may not give sense identifying bad sector and
801 * simply return a residue instead, so subtract off the
802 * residue if drv->done() error processing indicates no
803 * change to the completion length.
805 if (good_bytes
== old_good_bytes
)
806 good_bytes
-= scsi_get_resid(cmd
);
808 scsi_io_completion(cmd
, good_bytes
);
810 EXPORT_SYMBOL(scsi_finish_command
);
813 * scsi_adjust_queue_depth - Let low level drivers change a device's queue depth
814 * @sdev: SCSI Device in question
815 * @tagged: Do we use tagged queueing (non-0) or do we treat
816 * this device as an untagged device (0)
817 * @tags: Number of tags allowed if tagged queueing enabled,
818 * or number of commands the low level driver can
819 * queue up in non-tagged mode (as per cmd_per_lun).
823 * Lock Status: None held on entry
825 * Notes: Low level drivers may call this at any time and we will do
826 * the right thing depending on whether or not the device is
827 * currently active and whether or not it even has the
828 * command blocks built yet.
830 void scsi_adjust_queue_depth(struct scsi_device
*sdev
, int tagged
, int tags
)
835 * refuse to set tagged depth to an unworkable size
840 spin_lock_irqsave(sdev
->request_queue
->queue_lock
, flags
);
843 * Check to see if the queue is managed by the block layer.
844 * If it is, and we fail to adjust the depth, exit.
846 * Do not resize the tag map if it is a host wide share bqt,
847 * because the size should be the hosts's can_queue. If there
848 * is more IO than the LLD's can_queue (so there are not enuogh
849 * tags) request_fn's host queue ready check will handle it.
851 if (!sdev
->host
->bqt
) {
852 if (blk_queue_tagged(sdev
->request_queue
) &&
853 blk_queue_resize_tags(sdev
->request_queue
, tags
) != 0)
857 sdev
->queue_depth
= tags
;
859 case MSG_ORDERED_TAG
:
860 sdev
->ordered_tags
= 1;
861 sdev
->simple_tags
= 1;
864 sdev
->ordered_tags
= 0;
865 sdev
->simple_tags
= 1;
868 sdev_printk(KERN_WARNING
, sdev
,
869 "scsi_adjust_queue_depth, bad queue type, "
872 sdev
->ordered_tags
= sdev
->simple_tags
= 0;
873 sdev
->queue_depth
= tags
;
877 spin_unlock_irqrestore(sdev
->request_queue
->queue_lock
, flags
);
879 EXPORT_SYMBOL(scsi_adjust_queue_depth
);
882 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
883 * @sdev: SCSI Device in question
884 * @depth: Current number of outstanding SCSI commands on this device,
885 * not counting the one returned as QUEUE_FULL.
887 * Description: This function will track successive QUEUE_FULL events on a
888 * specific SCSI device to determine if and when there is a
889 * need to adjust the queue depth on the device.
891 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
892 * -1 - Drop back to untagged operation using host->cmd_per_lun
893 * as the untagged command depth
895 * Lock Status: None held on entry
897 * Notes: Low level drivers may call this at any time and we will do
898 * "The Right Thing." We are interrupt context safe.
900 int scsi_track_queue_full(struct scsi_device
*sdev
, int depth
)
904 * Don't let QUEUE_FULLs on the same
905 * jiffies count, they could all be from
908 if ((jiffies
>> 4) == (sdev
->last_queue_full_time
>> 4))
911 sdev
->last_queue_full_time
= jiffies
;
912 if (sdev
->last_queue_full_depth
!= depth
) {
913 sdev
->last_queue_full_count
= 1;
914 sdev
->last_queue_full_depth
= depth
;
916 sdev
->last_queue_full_count
++;
919 if (sdev
->last_queue_full_count
<= 10)
921 if (sdev
->last_queue_full_depth
< 8) {
922 /* Drop back to untagged */
923 scsi_adjust_queue_depth(sdev
, 0, sdev
->host
->cmd_per_lun
);
927 if (sdev
->ordered_tags
)
928 scsi_adjust_queue_depth(sdev
, MSG_ORDERED_TAG
, depth
);
930 scsi_adjust_queue_depth(sdev
, MSG_SIMPLE_TAG
, depth
);
933 EXPORT_SYMBOL(scsi_track_queue_full
);
936 * scsi_vpd_inquiry - Request a device provide us with a VPD page
937 * @sdev: The device to ask
938 * @buffer: Where to put the result
939 * @page: Which Vital Product Data to return
940 * @len: The length of the buffer
942 * This is an internal helper function. You probably want to use
943 * scsi_get_vpd_page instead.
945 * Returns size of the vpd page on success or a negative error number.
947 static int scsi_vpd_inquiry(struct scsi_device
*sdev
, unsigned char *buffer
,
948 u8 page
, unsigned len
)
951 unsigned char cmd
[16];
957 cmd
[1] = 1; /* EVPD */
961 cmd
[5] = 0; /* Control byte */
964 * I'm not convinced we need to try quite this hard to get VPD, but
965 * all the existing users tried this hard.
967 result
= scsi_execute_req(sdev
, cmd
, DMA_FROM_DEVICE
, buffer
,
968 len
, NULL
, 30 * HZ
, 3, NULL
);
972 /* Sanity check that we got the page back that we asked for */
973 if (buffer
[1] != page
)
976 return get_unaligned_be16(&buffer
[2]) + 4;
980 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
981 * @sdev: The device to ask
982 * @page: Which Vital Product Data to return
983 * @buf: where to store the VPD
984 * @buf_len: number of bytes in the VPD buffer area
986 * SCSI devices may optionally supply Vital Product Data. Each 'page'
987 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
988 * If the device supports this VPD page, this routine returns a pointer
989 * to a buffer containing the data from that page. The caller is
990 * responsible for calling kfree() on this pointer when it is no longer
991 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
993 int scsi_get_vpd_page(struct scsi_device
*sdev
, u8 page
, unsigned char *buf
,
998 if (sdev
->skip_vpd_pages
)
1001 /* Ask for all the pages supported by this device */
1002 result
= scsi_vpd_inquiry(sdev
, buf
, 0, buf_len
);
1006 /* If the user actually wanted this page, we can skip the rest */
1010 for (i
= 4; i
< min(result
, buf_len
); i
++)
1014 if (i
< result
&& i
>= buf_len
)
1015 /* ran off the end of the buffer, give us benefit of doubt */
1017 /* The device claims it doesn't support the requested page */
1021 result
= scsi_vpd_inquiry(sdev
, buf
, page
, buf_len
);
1030 EXPORT_SYMBOL_GPL(scsi_get_vpd_page
);
1033 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
1034 * @sdev: The device to ask
1036 * Attach the 'Device Identification' VPD page (0x83) and the
1037 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
1038 * structure. This information can be used to identify the device
1041 void scsi_attach_vpd(struct scsi_device
*sdev
)
1044 int vpd_len
= SCSI_VPD_PG_LEN
;
1045 int pg80_supported
= 0;
1046 int pg83_supported
= 0;
1047 unsigned char *vpd_buf
;
1049 if (sdev
->skip_vpd_pages
)
1052 vpd_buf
= kmalloc(vpd_len
, GFP_KERNEL
);
1056 /* Ask for all the pages supported by this device */
1057 result
= scsi_vpd_inquiry(sdev
, vpd_buf
, 0, vpd_len
);
1062 if (result
> vpd_len
) {
1068 for (i
= 4; i
< result
; i
++) {
1069 if (vpd_buf
[i
] == 0x80)
1071 if (vpd_buf
[i
] == 0x83)
1075 vpd_len
= SCSI_VPD_PG_LEN
;
1077 if (pg80_supported
) {
1079 vpd_buf
= kmalloc(vpd_len
, GFP_KERNEL
);
1083 result
= scsi_vpd_inquiry(sdev
, vpd_buf
, 0x80, vpd_len
);
1088 if (result
> vpd_len
) {
1093 sdev
->vpd_pg80_len
= result
;
1094 sdev
->vpd_pg80
= vpd_buf
;
1095 vpd_len
= SCSI_VPD_PG_LEN
;
1098 if (pg83_supported
) {
1100 vpd_buf
= kmalloc(vpd_len
, GFP_KERNEL
);
1104 result
= scsi_vpd_inquiry(sdev
, vpd_buf
, 0x83, vpd_len
);
1109 if (result
> vpd_len
) {
1114 sdev
->vpd_pg83_len
= result
;
1115 sdev
->vpd_pg83
= vpd_buf
;
1120 * scsi_report_opcode - Find out if a given command opcode is supported
1121 * @sdev: scsi device to query
1122 * @buffer: scratch buffer (must be at least 20 bytes long)
1123 * @len: length of buffer
1124 * @opcode: opcode for command to look up
1126 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
1127 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
1128 * unsupported and 1 if the device claims to support the command.
1130 int scsi_report_opcode(struct scsi_device
*sdev
, unsigned char *buffer
,
1131 unsigned int len
, unsigned char opcode
)
1133 unsigned char cmd
[16];
1134 struct scsi_sense_hdr sshdr
;
1137 if (sdev
->no_report_opcodes
|| sdev
->scsi_level
< SCSI_SPC_3
)
1141 cmd
[0] = MAINTENANCE_IN
;
1142 cmd
[1] = MI_REPORT_SUPPORTED_OPERATION_CODES
;
1143 cmd
[2] = 1; /* One command format */
1145 put_unaligned_be32(len
, &cmd
[6]);
1146 memset(buffer
, 0, len
);
1148 result
= scsi_execute_req(sdev
, cmd
, DMA_FROM_DEVICE
, buffer
, len
,
1149 &sshdr
, 30 * HZ
, 3, NULL
);
1151 if (result
&& scsi_sense_valid(&sshdr
) &&
1152 sshdr
.sense_key
== ILLEGAL_REQUEST
&&
1153 (sshdr
.asc
== 0x20 || sshdr
.asc
== 0x24) && sshdr
.ascq
== 0x00)
1156 if ((buffer
[1] & 3) == 3) /* Command supported */
1161 EXPORT_SYMBOL(scsi_report_opcode
);
1164 * scsi_device_get - get an additional reference to a scsi_device
1165 * @sdev: device to get a reference to
1167 * Description: Gets a reference to the scsi_device and increments the use count
1168 * of the underlying LLDD module. You must hold host_lock of the
1169 * parent Scsi_Host or already have a reference when calling this.
1171 int scsi_device_get(struct scsi_device
*sdev
)
1173 if (sdev
->sdev_state
== SDEV_DEL
)
1175 if (!get_device(&sdev
->sdev_gendev
))
1177 /* We can fail this if we're doing SCSI operations
1178 * from module exit (like cache flush) */
1179 try_module_get(sdev
->host
->hostt
->module
);
1183 EXPORT_SYMBOL(scsi_device_get
);
1186 * scsi_device_put - release a reference to a scsi_device
1187 * @sdev: device to release a reference on.
1189 * Description: Release a reference to the scsi_device and decrements the use
1190 * count of the underlying LLDD module. The device is freed once the last
1193 void scsi_device_put(struct scsi_device
*sdev
)
1195 #ifdef CONFIG_MODULE_UNLOAD
1196 struct module
*module
= sdev
->host
->hostt
->module
;
1198 /* The module refcount will be zero if scsi_device_get()
1199 * was called from a module removal routine */
1200 if (module
&& module_refcount(module
) != 0)
1203 put_device(&sdev
->sdev_gendev
);
1205 EXPORT_SYMBOL(scsi_device_put
);
1207 /* helper for shost_for_each_device, see that for documentation */
1208 struct scsi_device
*__scsi_iterate_devices(struct Scsi_Host
*shost
,
1209 struct scsi_device
*prev
)
1211 struct list_head
*list
= (prev
? &prev
->siblings
: &shost
->__devices
);
1212 struct scsi_device
*next
= NULL
;
1213 unsigned long flags
;
1215 spin_lock_irqsave(shost
->host_lock
, flags
);
1216 while (list
->next
!= &shost
->__devices
) {
1217 next
= list_entry(list
->next
, struct scsi_device
, siblings
);
1218 /* skip devices that we can't get a reference to */
1219 if (!scsi_device_get(next
))
1224 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1227 scsi_device_put(prev
);
1230 EXPORT_SYMBOL(__scsi_iterate_devices
);
1233 * starget_for_each_device - helper to walk all devices of a target
1234 * @starget: target whose devices we want to iterate over.
1235 * @data: Opaque passed to each function call.
1236 * @fn: Function to call on each device
1238 * This traverses over each device of @starget. The devices have
1239 * a reference that must be released by scsi_host_put when breaking
1242 void starget_for_each_device(struct scsi_target
*starget
, void *data
,
1243 void (*fn
)(struct scsi_device
*, void *))
1245 struct Scsi_Host
*shost
= dev_to_shost(starget
->dev
.parent
);
1246 struct scsi_device
*sdev
;
1248 shost_for_each_device(sdev
, shost
) {
1249 if ((sdev
->channel
== starget
->channel
) &&
1250 (sdev
->id
== starget
->id
))
1254 EXPORT_SYMBOL(starget_for_each_device
);
1257 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
1258 * @starget: target whose devices we want to iterate over.
1259 * @data: parameter for callback @fn()
1260 * @fn: callback function that is invoked for each device
1262 * This traverses over each device of @starget. It does _not_
1263 * take a reference on the scsi_device, so the whole loop must be
1264 * protected by shost->host_lock.
1266 * Note: The only reason why drivers would want to use this is because
1267 * they need to access the device list in irq context. Otherwise you
1268 * really want to use starget_for_each_device instead.
1270 void __starget_for_each_device(struct scsi_target
*starget
, void *data
,
1271 void (*fn
)(struct scsi_device
*, void *))
1273 struct Scsi_Host
*shost
= dev_to_shost(starget
->dev
.parent
);
1274 struct scsi_device
*sdev
;
1276 __shost_for_each_device(sdev
, shost
) {
1277 if ((sdev
->channel
== starget
->channel
) &&
1278 (sdev
->id
== starget
->id
))
1282 EXPORT_SYMBOL(__starget_for_each_device
);
1285 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
1286 * @starget: SCSI target pointer
1287 * @lun: SCSI Logical Unit Number
1289 * Description: Looks up the scsi_device with the specified @lun for a given
1290 * @starget. The returned scsi_device does not have an additional
1291 * reference. You must hold the host's host_lock over this call and
1292 * any access to the returned scsi_device. A scsi_device in state
1293 * SDEV_DEL is skipped.
1295 * Note: The only reason why drivers should use this is because
1296 * they need to access the device list in irq context. Otherwise you
1297 * really want to use scsi_device_lookup_by_target instead.
1299 struct scsi_device
*__scsi_device_lookup_by_target(struct scsi_target
*starget
,
1302 struct scsi_device
*sdev
;
1304 list_for_each_entry(sdev
, &starget
->devices
, same_target_siblings
) {
1305 if (sdev
->sdev_state
== SDEV_DEL
)
1307 if (sdev
->lun
==lun
)
1313 EXPORT_SYMBOL(__scsi_device_lookup_by_target
);
1316 * scsi_device_lookup_by_target - find a device given the target
1317 * @starget: SCSI target pointer
1318 * @lun: SCSI Logical Unit Number
1320 * Description: Looks up the scsi_device with the specified @lun for a given
1321 * @starget. The returned scsi_device has an additional reference that
1322 * needs to be released with scsi_device_put once you're done with it.
1324 struct scsi_device
*scsi_device_lookup_by_target(struct scsi_target
*starget
,
1327 struct scsi_device
*sdev
;
1328 struct Scsi_Host
*shost
= dev_to_shost(starget
->dev
.parent
);
1329 unsigned long flags
;
1331 spin_lock_irqsave(shost
->host_lock
, flags
);
1332 sdev
= __scsi_device_lookup_by_target(starget
, lun
);
1333 if (sdev
&& scsi_device_get(sdev
))
1335 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1339 EXPORT_SYMBOL(scsi_device_lookup_by_target
);
1342 * __scsi_device_lookup - find a device given the host (UNLOCKED)
1343 * @shost: SCSI host pointer
1344 * @channel: SCSI channel (zero if only one channel)
1345 * @id: SCSI target number (physical unit number)
1346 * @lun: SCSI Logical Unit Number
1348 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1349 * for a given host. The returned scsi_device does not have an additional
1350 * reference. You must hold the host's host_lock over this call and any access
1351 * to the returned scsi_device.
1353 * Note: The only reason why drivers would want to use this is because
1354 * they need to access the device list in irq context. Otherwise you
1355 * really want to use scsi_device_lookup instead.
1357 struct scsi_device
*__scsi_device_lookup(struct Scsi_Host
*shost
,
1358 uint channel
, uint id
, uint lun
)
1360 struct scsi_device
*sdev
;
1362 list_for_each_entry(sdev
, &shost
->__devices
, siblings
) {
1363 if (sdev
->channel
== channel
&& sdev
->id
== id
&&
1370 EXPORT_SYMBOL(__scsi_device_lookup
);
1373 * scsi_device_lookup - find a device given the host
1374 * @shost: SCSI host pointer
1375 * @channel: SCSI channel (zero if only one channel)
1376 * @id: SCSI target number (physical unit number)
1377 * @lun: SCSI Logical Unit Number
1379 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1380 * for a given host. The returned scsi_device has an additional reference that
1381 * needs to be released with scsi_device_put once you're done with it.
1383 struct scsi_device
*scsi_device_lookup(struct Scsi_Host
*shost
,
1384 uint channel
, uint id
, uint lun
)
1386 struct scsi_device
*sdev
;
1387 unsigned long flags
;
1389 spin_lock_irqsave(shost
->host_lock
, flags
);
1390 sdev
= __scsi_device_lookup(shost
, channel
, id
, lun
);
1391 if (sdev
&& scsi_device_get(sdev
))
1393 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1397 EXPORT_SYMBOL(scsi_device_lookup
);
1399 MODULE_DESCRIPTION("SCSI core");
1400 MODULE_LICENSE("GPL");
1402 module_param(scsi_logging_level
, int, S_IRUGO
|S_IWUSR
);
1403 MODULE_PARM_DESC(scsi_logging_level
, "a bit mask of logging levels");
1405 static int __init
init_scsi(void)
1409 error
= scsi_init_queue();
1412 error
= scsi_init_procfs();
1415 error
= scsi_init_devinfo();
1417 goto cleanup_procfs
;
1418 error
= scsi_init_hosts();
1420 goto cleanup_devlist
;
1421 error
= scsi_init_sysctl();
1424 error
= scsi_sysfs_register();
1426 goto cleanup_sysctl
;
1428 scsi_netlink_init();
1430 printk(KERN_NOTICE
"SCSI subsystem initialized\n");
1438 scsi_exit_devinfo();
1443 printk(KERN_ERR
"SCSI subsystem failed to initialize, error = %d\n",
1448 static void __exit
exit_scsi(void)
1450 scsi_netlink_exit();
1451 scsi_sysfs_unregister();
1454 scsi_exit_devinfo();
1457 async_unregister_domain(&scsi_sd_probe_domain
);
1460 subsys_initcall(init_scsi
);
1461 module_exit(exit_scsi
);