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>
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_dbg.h>
61 #include <scsi/scsi_device.h>
62 #include <scsi/scsi_driver.h>
63 #include <scsi/scsi_eh.h>
64 #include <scsi/scsi_host.h>
65 #include <scsi/scsi_tcq.h>
67 #include "scsi_priv.h"
68 #include "scsi_logging.h"
70 #define CREATE_TRACE_POINTS
71 #include <trace/events/scsi.h>
73 static void scsi_done(struct scsi_cmnd *cmd);
76 * Definitions and constants.
79 #define MIN_RESET_DELAY (2*HZ)
81 /* Do not call reset on error if we just did a reset within 15 sec. */
82 #define MIN_RESET_PERIOD (15*HZ)
85 * Note - the initial logging level can be set here to log events at boot time.
86 * After the system is up, you may enable logging via the /proc interface.
88 unsigned int scsi_logging_level;
89 #if defined(CONFIG_SCSI_LOGGING)
90 EXPORT_SYMBOL(scsi_logging_level);
93 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
94 * You may not alter any existing entry (although adding new ones is
95 * encouraged once assigned by ANSI/INCITS T10
97 static const char *const scsi_device_types[] = {
120 * scsi_device_type - Return 17 char string indicating device type.
121 * @type: type number to look up
124 const char * scsi_device_type(unsigned type)
127 return "Well-known LUN ";
130 if (type >= ARRAY_SIZE(scsi_device_types))
132 return scsi_device_types[type];
135 EXPORT_SYMBOL(scsi_device_type);
137 struct scsi_host_cmd_pool {
138 struct kmem_cache *cmd_slab;
139 struct kmem_cache *sense_slab;
143 unsigned int slab_flags;
147 static struct scsi_host_cmd_pool scsi_cmd_pool = {
148 .cmd_name = "scsi_cmd_cache",
149 .sense_name = "scsi_sense_cache",
150 .slab_flags = SLAB_HWCACHE_ALIGN,
153 static struct scsi_host_cmd_pool scsi_cmd_dma_pool = {
154 .cmd_name = "scsi_cmd_cache(DMA)",
155 .sense_name = "scsi_sense_cache(DMA)",
156 .slab_flags = SLAB_HWCACHE_ALIGN|SLAB_CACHE_DMA,
157 .gfp_mask = __GFP_DMA,
160 static DEFINE_MUTEX(host_cmd_pool_mutex);
163 * scsi_pool_alloc_command - internal function to get a fully allocated command
164 * @pool: slab pool to allocate the command from
165 * @gfp_mask: mask for the allocation
167 * Returns a fully allocated command (with the allied sense buffer) or
170 static struct scsi_cmnd *
171 scsi_pool_alloc_command(struct scsi_host_cmd_pool *pool, gfp_t gfp_mask)
173 struct scsi_cmnd *cmd;
175 cmd = kmem_cache_zalloc(pool->cmd_slab, gfp_mask | pool->gfp_mask);
179 cmd->sense_buffer = kmem_cache_alloc(pool->sense_slab,
180 gfp_mask | pool->gfp_mask);
181 if (!cmd->sense_buffer) {
182 kmem_cache_free(pool->cmd_slab, cmd);
190 * scsi_pool_free_command - internal function to release a command
191 * @pool: slab pool to allocate the command from
192 * @cmd: command to release
194 * the command must previously have been allocated by
195 * scsi_pool_alloc_command.
198 scsi_pool_free_command(struct scsi_host_cmd_pool *pool,
199 struct scsi_cmnd *cmd)
202 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
204 kmem_cache_free(pool->sense_slab, cmd->sense_buffer);
205 kmem_cache_free(pool->cmd_slab, cmd);
209 * scsi_host_alloc_command - internal function to allocate command
210 * @shost: SCSI host whose pool to allocate from
211 * @gfp_mask: mask for the allocation
213 * Returns a fully allocated command with sense buffer and protection
214 * data buffer (where applicable) or NULL on failure
216 static struct scsi_cmnd *
217 scsi_host_alloc_command(struct Scsi_Host *shost, gfp_t gfp_mask)
219 struct scsi_cmnd *cmd;
221 cmd = scsi_pool_alloc_command(shost->cmd_pool, gfp_mask);
225 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
226 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp_mask);
228 if (!cmd->prot_sdb) {
229 scsi_pool_free_command(shost->cmd_pool, cmd);
238 * __scsi_get_command - Allocate a struct scsi_cmnd
239 * @shost: host to transmit command
240 * @gfp_mask: allocation mask
242 * Description: allocate a struct scsi_cmd from host's slab, recycling from the
243 * host's free_list if necessary.
245 struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *shost, gfp_t gfp_mask)
247 struct scsi_cmnd *cmd = scsi_host_alloc_command(shost, gfp_mask);
249 if (unlikely(!cmd)) {
252 spin_lock_irqsave(&shost->free_list_lock, flags);
253 if (likely(!list_empty(&shost->free_list))) {
254 cmd = list_entry(shost->free_list.next,
255 struct scsi_cmnd, list);
256 list_del_init(&cmd->list);
258 spin_unlock_irqrestore(&shost->free_list_lock, flags);
263 buf = cmd->sense_buffer;
264 prot = cmd->prot_sdb;
266 memset(cmd, 0, sizeof(*cmd));
268 cmd->sense_buffer = buf;
269 cmd->prot_sdb = prot;
275 EXPORT_SYMBOL_GPL(__scsi_get_command);
278 * scsi_get_command - Allocate and setup a scsi command block
279 * @dev: parent scsi device
280 * @gfp_mask: allocator flags
282 * Returns: The allocated scsi command structure.
284 struct scsi_cmnd *scsi_get_command(struct scsi_device *dev, gfp_t gfp_mask)
286 struct scsi_cmnd *cmd;
288 /* Bail if we can't get a reference to the device */
289 if (!get_device(&dev->sdev_gendev))
292 cmd = __scsi_get_command(dev->host, gfp_mask);
294 if (likely(cmd != NULL)) {
298 INIT_LIST_HEAD(&cmd->list);
299 spin_lock_irqsave(&dev->list_lock, flags);
300 list_add_tail(&cmd->list, &dev->cmd_list);
301 spin_unlock_irqrestore(&dev->list_lock, flags);
302 cmd->jiffies_at_alloc = jiffies;
304 put_device(&dev->sdev_gendev);
308 EXPORT_SYMBOL(scsi_get_command);
311 * __scsi_put_command - Free a struct scsi_cmnd
313 * @cmd: Command to free
314 * @dev: parent scsi device
316 void __scsi_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd,
321 /* changing locks here, don't need to restore the irq state */
322 spin_lock_irqsave(&shost->free_list_lock, flags);
323 if (unlikely(list_empty(&shost->free_list))) {
324 list_add(&cmd->list, &shost->free_list);
327 spin_unlock_irqrestore(&shost->free_list_lock, flags);
329 if (likely(cmd != NULL))
330 scsi_pool_free_command(shost->cmd_pool, cmd);
334 EXPORT_SYMBOL(__scsi_put_command);
337 * scsi_put_command - Free a scsi command block
338 * @cmd: command block to free
342 * Notes: The command must not belong to any lists.
344 void scsi_put_command(struct scsi_cmnd *cmd)
346 struct scsi_device *sdev = cmd->device;
349 /* serious error if the command hasn't come from a device list */
350 spin_lock_irqsave(&cmd->device->list_lock, flags);
351 BUG_ON(list_empty(&cmd->list));
352 list_del_init(&cmd->list);
353 spin_unlock_irqrestore(&cmd->device->list_lock, flags);
355 __scsi_put_command(cmd->device->host, cmd, &sdev->sdev_gendev);
357 EXPORT_SYMBOL(scsi_put_command);
359 static struct scsi_host_cmd_pool *scsi_get_host_cmd_pool(gfp_t gfp_mask)
361 struct scsi_host_cmd_pool *retval = NULL, *pool;
363 * Select a command slab for this host and create it if not
366 mutex_lock(&host_cmd_pool_mutex);
367 pool = (gfp_mask & __GFP_DMA) ? &scsi_cmd_dma_pool :
370 pool->cmd_slab = kmem_cache_create(pool->cmd_name,
371 sizeof(struct scsi_cmnd), 0,
372 pool->slab_flags, NULL);
376 pool->sense_slab = kmem_cache_create(pool->sense_name,
377 SCSI_SENSE_BUFFERSIZE, 0,
378 pool->slab_flags, NULL);
379 if (!pool->sense_slab) {
380 kmem_cache_destroy(pool->cmd_slab);
388 mutex_unlock(&host_cmd_pool_mutex);
392 static void scsi_put_host_cmd_pool(gfp_t gfp_mask)
394 struct scsi_host_cmd_pool *pool;
396 mutex_lock(&host_cmd_pool_mutex);
397 pool = (gfp_mask & __GFP_DMA) ? &scsi_cmd_dma_pool :
400 * This may happen if a driver has a mismatched get and put
401 * of the command pool; the driver should be implicated in
404 BUG_ON(pool->users == 0);
406 if (!--pool->users) {
407 kmem_cache_destroy(pool->cmd_slab);
408 kmem_cache_destroy(pool->sense_slab);
410 mutex_unlock(&host_cmd_pool_mutex);
414 * scsi_allocate_command - get a fully allocated SCSI command
415 * @gfp_mask: allocation mask
417 * This function is for use outside of the normal host based pools.
418 * It allocates the relevant command and takes an additional reference
419 * on the pool it used. This function *must* be paired with
420 * scsi_free_command which also has the identical mask, otherwise the
421 * free pool counts will eventually go wrong and you'll trigger a bug.
423 * This function should *only* be used by drivers that need a static
424 * command allocation at start of day for internal functions.
426 struct scsi_cmnd *scsi_allocate_command(gfp_t gfp_mask)
428 struct scsi_host_cmd_pool *pool = scsi_get_host_cmd_pool(gfp_mask);
433 return scsi_pool_alloc_command(pool, gfp_mask);
435 EXPORT_SYMBOL(scsi_allocate_command);
438 * scsi_free_command - free a command allocated by scsi_allocate_command
439 * @gfp_mask: mask used in the original allocation
440 * @cmd: command to free
442 * Note: using the original allocation mask is vital because that's
443 * what determines which command pool we use to free the command. Any
444 * mismatch will cause the system to BUG eventually.
446 void scsi_free_command(gfp_t gfp_mask, struct scsi_cmnd *cmd)
448 struct scsi_host_cmd_pool *pool = scsi_get_host_cmd_pool(gfp_mask);
451 * this could trigger if the mask to scsi_allocate_command
452 * doesn't match this mask. Otherwise we're guaranteed that this
453 * succeeds because scsi_allocate_command must have taken a reference
458 scsi_pool_free_command(pool, cmd);
460 * scsi_put_host_cmd_pool is called twice; once to release the
461 * reference we took above, and once to release the reference
462 * originally taken by scsi_allocate_command
464 scsi_put_host_cmd_pool(gfp_mask);
465 scsi_put_host_cmd_pool(gfp_mask);
467 EXPORT_SYMBOL(scsi_free_command);
470 * scsi_setup_command_freelist - Setup the command freelist for a scsi host.
471 * @shost: host to allocate the freelist for.
473 * Description: The command freelist protects against system-wide out of memory
474 * deadlock by preallocating one SCSI command structure for each host, so the
475 * system can always write to a swap file on a device associated with that host.
479 int scsi_setup_command_freelist(struct Scsi_Host *shost)
481 struct scsi_cmnd *cmd;
482 const gfp_t gfp_mask = shost->unchecked_isa_dma ? GFP_DMA : GFP_KERNEL;
484 spin_lock_init(&shost->free_list_lock);
485 INIT_LIST_HEAD(&shost->free_list);
487 shost->cmd_pool = scsi_get_host_cmd_pool(gfp_mask);
489 if (!shost->cmd_pool)
493 * Get one backup command for this host.
495 cmd = scsi_host_alloc_command(shost, gfp_mask);
497 scsi_put_host_cmd_pool(gfp_mask);
498 shost->cmd_pool = NULL;
501 list_add(&cmd->list, &shost->free_list);
506 * scsi_destroy_command_freelist - Release the command freelist for a scsi host.
507 * @shost: host whose freelist is going to be destroyed
509 void scsi_destroy_command_freelist(struct Scsi_Host *shost)
512 * If cmd_pool is NULL the free list was not initialized, so
513 * do not attempt to release resources.
515 if (!shost->cmd_pool)
518 while (!list_empty(&shost->free_list)) {
519 struct scsi_cmnd *cmd;
521 cmd = list_entry(shost->free_list.next, struct scsi_cmnd, list);
522 list_del_init(&cmd->list);
523 scsi_pool_free_command(shost->cmd_pool, cmd);
525 shost->cmd_pool = NULL;
526 scsi_put_host_cmd_pool(shost->unchecked_isa_dma ? GFP_DMA : GFP_KERNEL);
529 #ifdef CONFIG_SCSI_LOGGING
530 void scsi_log_send(struct scsi_cmnd *cmd)
535 * If ML QUEUE log level is greater than or equal to:
537 * 1: nothing (match completion)
539 * 2: log opcode + command of all commands
541 * 3: same as 2 plus dump cmd address
543 * 4: same as 3 plus dump extra junk
545 if (unlikely(scsi_logging_level)) {
546 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
547 SCSI_LOG_MLQUEUE_BITS);
549 scmd_printk(KERN_INFO, cmd, "Send: ");
551 printk("0x%p ", cmd);
553 scsi_print_command(cmd);
555 printk(KERN_INFO "buffer = 0x%p, bufflen = %d,"
556 " queuecommand 0x%p\n",
557 scsi_sglist(cmd), scsi_bufflen(cmd),
558 cmd->device->host->hostt->queuecommand);
565 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
570 * If ML COMPLETE log level is greater than or equal to:
572 * 1: log disposition, result, opcode + command, and conditionally
573 * sense data for failures or non SUCCESS dispositions.
575 * 2: same as 1 but for all command completions.
577 * 3: same as 2 plus dump cmd address
579 * 4: same as 3 plus dump extra junk
581 if (unlikely(scsi_logging_level)) {
582 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
583 SCSI_LOG_MLCOMPLETE_BITS);
584 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
586 scmd_printk(KERN_INFO, cmd, "Done: ");
588 printk("0x%p ", cmd);
590 * Dump truncated values, so we usually fit within
593 switch (disposition) {
608 * If called via scsi_times_out.
615 scsi_print_result(cmd);
616 scsi_print_command(cmd);
617 if (status_byte(cmd->result) & CHECK_CONDITION)
618 scsi_print_sense("", cmd);
620 scmd_printk(KERN_INFO, cmd,
621 "scsi host busy %d failed %d\n",
622 cmd->device->host->host_busy,
623 cmd->device->host->host_failed);
630 * scsi_cmd_get_serial - Assign a serial number to a command
631 * @host: the scsi host
632 * @cmd: command to assign serial number to
634 * Description: a serial number identifies a request for error recovery
635 * and debugging purposes. Protected by the Host_Lock of host.
637 static inline void scsi_cmd_get_serial(struct Scsi_Host *host, struct scsi_cmnd *cmd)
639 cmd->serial_number = host->cmd_serial_number++;
640 if (cmd->serial_number == 0)
641 cmd->serial_number = host->cmd_serial_number++;
645 * scsi_dispatch_command - Dispatch a command to the low-level driver.
646 * @cmd: command block we are dispatching.
648 * Return: nonzero return request was rejected and device's queue needs to be
651 int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
653 struct Scsi_Host *host = cmd->device->host;
654 unsigned long flags = 0;
655 unsigned long timeout;
658 atomic_inc(&cmd->device->iorequest_cnt);
660 /* check if the device is still usable */
661 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
662 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
663 * returns an immediate error upwards, and signals
664 * that the device is no longer present */
665 cmd->result = DID_NO_CONNECT << 16;
667 /* return 0 (because the command has been processed) */
671 /* Check to see if the scsi lld made this device blocked. */
672 if (unlikely(scsi_device_blocked(cmd->device))) {
674 * in blocked state, the command is just put back on
675 * the device queue. The suspend state has already
676 * blocked the queue so future requests should not
677 * occur until the device transitions out of the
681 scsi_queue_insert(cmd, SCSI_MLQUEUE_DEVICE_BUSY);
683 SCSI_LOG_MLQUEUE(3, printk("queuecommand : device blocked \n"));
686 * NOTE: rtn is still zero here because we don't need the
687 * queue to be plugged on return (it's already stopped)
693 * If SCSI-2 or lower, store the LUN value in cmnd.
695 if (cmd->device->scsi_level <= SCSI_2 &&
696 cmd->device->scsi_level != SCSI_UNKNOWN) {
697 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
698 (cmd->device->lun << 5 & 0xe0);
702 * We will wait MIN_RESET_DELAY clock ticks after the last reset so
703 * we can avoid the drive not being ready.
705 timeout = host->last_reset + MIN_RESET_DELAY;
707 if (host->resetting && time_before(jiffies, timeout)) {
708 int ticks_remaining = timeout - jiffies;
710 * NOTE: This may be executed from within an interrupt
711 * handler! This is bad, but for now, it'll do. The irq
712 * level of the interrupt handler has been masked out by the
713 * platform dependent interrupt handling code already, so the
714 * sti() here will not cause another call to the SCSI host's
715 * interrupt handler (assuming there is one irq-level per
718 while (--ticks_remaining >= 0)
719 mdelay(1 + 999 / HZ);
726 * Before we queue this command, check if the command
727 * length exceeds what the host adapter can handle.
729 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
731 printk("queuecommand : command too long. "
732 "cdb_size=%d host->max_cmd_len=%d\n",
733 cmd->cmd_len, cmd->device->host->max_cmd_len));
734 cmd->result = (DID_ABORT << 16);
740 spin_lock_irqsave(host->host_lock, flags);
742 * AK: unlikely race here: for some reason the timer could
743 * expire before the serial number is set up below.
745 * TODO: kill serial or move to blk layer
747 scsi_cmd_get_serial(host, cmd);
749 if (unlikely(host->shost_state == SHOST_DEL)) {
750 cmd->result = (DID_NO_CONNECT << 16);
753 trace_scsi_dispatch_cmd_start(cmd);
754 rtn = host->hostt->queuecommand(cmd, scsi_done);
756 spin_unlock_irqrestore(host->host_lock, flags);
758 trace_scsi_dispatch_cmd_error(cmd, rtn);
759 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
760 rtn != SCSI_MLQUEUE_TARGET_BUSY)
761 rtn = SCSI_MLQUEUE_HOST_BUSY;
763 scsi_queue_insert(cmd, rtn);
766 printk("queuecommand : request rejected\n"));
770 SCSI_LOG_MLQUEUE(3, printk("leaving scsi_dispatch_cmnd()\n"));
775 * scsi_done - Enqueue the finished SCSI command into the done queue.
776 * @cmd: The SCSI Command for which a low-level device driver (LLDD) gives
777 * ownership back to SCSI Core -- i.e. the LLDD has finished with it.
779 * Description: This function is the mid-level's (SCSI Core) interrupt routine,
780 * which regains ownership of the SCSI command (de facto) from a LLDD, and
781 * enqueues the command to the done queue for further processing.
783 * This is the producer of the done queue who enqueues at the tail.
785 * This function is interrupt context safe.
787 static void scsi_done(struct scsi_cmnd *cmd)
789 trace_scsi_dispatch_cmd_done(cmd);
790 blk_complete_request(cmd->request);
793 /* Move this to a header if it becomes more generally useful */
794 static struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
796 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
800 * scsi_finish_command - cleanup and pass command back to upper layer
803 * Description: Pass command off to upper layer for finishing of I/O
804 * request, waking processes that are waiting on results,
807 void scsi_finish_command(struct scsi_cmnd *cmd)
809 struct scsi_device *sdev = cmd->device;
810 struct scsi_target *starget = scsi_target(sdev);
811 struct Scsi_Host *shost = sdev->host;
812 struct scsi_driver *drv;
813 unsigned int good_bytes;
815 scsi_device_unbusy(sdev);
818 * Clear the flags which say that the device/host is no longer
819 * capable of accepting new commands. These are set in scsi_queue.c
820 * for both the queue full condition on a device, and for a
821 * host full condition on the host.
823 * XXX(hch): What about locking?
825 shost->host_blocked = 0;
826 starget->target_blocked = 0;
827 sdev->device_blocked = 0;
830 * If we have valid sense information, then some kind of recovery
831 * must have taken place. Make a note of this.
833 if (SCSI_SENSE_VALID(cmd))
834 cmd->result |= (DRIVER_SENSE << 24);
836 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
837 "Notifying upper driver of completion "
838 "(result %x)\n", cmd->result));
840 good_bytes = scsi_bufflen(cmd);
841 if (cmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
842 int old_good_bytes = good_bytes;
843 drv = scsi_cmd_to_driver(cmd);
845 good_bytes = drv->done(cmd);
847 * USB may not give sense identifying bad sector and
848 * simply return a residue instead, so subtract off the
849 * residue if drv->done() error processing indicates no
850 * change to the completion length.
852 if (good_bytes == old_good_bytes)
853 good_bytes -= scsi_get_resid(cmd);
855 scsi_io_completion(cmd, good_bytes);
857 EXPORT_SYMBOL(scsi_finish_command);
860 * scsi_adjust_queue_depth - Let low level drivers change a device's queue depth
861 * @sdev: SCSI Device in question
862 * @tagged: Do we use tagged queueing (non-0) or do we treat
863 * this device as an untagged device (0)
864 * @tags: Number of tags allowed if tagged queueing enabled,
865 * or number of commands the low level driver can
866 * queue up in non-tagged mode (as per cmd_per_lun).
870 * Lock Status: None held on entry
872 * Notes: Low level drivers may call this at any time and we will do
873 * the right thing depending on whether or not the device is
874 * currently active and whether or not it even has the
875 * command blocks built yet.
877 void scsi_adjust_queue_depth(struct scsi_device *sdev, int tagged, int tags)
882 * refuse to set tagged depth to an unworkable size
887 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
890 * Check to see if the queue is managed by the block layer.
891 * If it is, and we fail to adjust the depth, exit.
893 * Do not resize the tag map if it is a host wide share bqt,
894 * because the size should be the hosts's can_queue. If there
895 * is more IO than the LLD's can_queue (so there are not enuogh
896 * tags) request_fn's host queue ready check will handle it.
898 if (!sdev->host->bqt) {
899 if (blk_queue_tagged(sdev->request_queue) &&
900 blk_queue_resize_tags(sdev->request_queue, tags) != 0)
904 sdev->queue_depth = tags;
906 case MSG_ORDERED_TAG:
907 sdev->ordered_tags = 1;
908 sdev->simple_tags = 1;
911 sdev->ordered_tags = 0;
912 sdev->simple_tags = 1;
915 sdev_printk(KERN_WARNING, sdev,
916 "scsi_adjust_queue_depth, bad queue type, "
919 sdev->ordered_tags = sdev->simple_tags = 0;
920 sdev->queue_depth = tags;
924 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
926 EXPORT_SYMBOL(scsi_adjust_queue_depth);
929 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
930 * @sdev: SCSI Device in question
931 * @depth: Current number of outstanding SCSI commands on this device,
932 * not counting the one returned as QUEUE_FULL.
934 * Description: This function will track successive QUEUE_FULL events on a
935 * specific SCSI device to determine if and when there is a
936 * need to adjust the queue depth on the device.
938 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
939 * -1 - Drop back to untagged operation using host->cmd_per_lun
940 * as the untagged command depth
942 * Lock Status: None held on entry
944 * Notes: Low level drivers may call this at any time and we will do
945 * "The Right Thing." We are interrupt context safe.
947 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
951 * Don't let QUEUE_FULLs on the same
952 * jiffies count, they could all be from
955 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
958 sdev->last_queue_full_time = jiffies;
959 if (sdev->last_queue_full_depth != depth) {
960 sdev->last_queue_full_count = 1;
961 sdev->last_queue_full_depth = depth;
963 sdev->last_queue_full_count++;
966 if (sdev->last_queue_full_count <= 10)
968 if (sdev->last_queue_full_depth < 8) {
969 /* Drop back to untagged */
970 scsi_adjust_queue_depth(sdev, 0, sdev->host->cmd_per_lun);
974 if (sdev->ordered_tags)
975 scsi_adjust_queue_depth(sdev, MSG_ORDERED_TAG, depth);
977 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
980 EXPORT_SYMBOL(scsi_track_queue_full);
983 * scsi_vpd_inquiry - Request a device provide us with a VPD page
984 * @sdev: The device to ask
985 * @buffer: Where to put the result
986 * @page: Which Vital Product Data to return
987 * @len: The length of the buffer
989 * This is an internal helper function. You probably want to use
990 * scsi_get_vpd_page instead.
992 * Returns 0 on success or a negative error number.
994 static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
995 u8 page, unsigned len)
998 unsigned char cmd[16];
1001 cmd[1] = 1; /* EVPD */
1004 cmd[4] = len & 0xff;
1005 cmd[5] = 0; /* Control byte */
1008 * I'm not convinced we need to try quite this hard to get VPD, but
1009 * all the existing users tried this hard.
1011 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
1012 len, NULL, 30 * HZ, 3, NULL);
1016 /* Sanity check that we got the page back that we asked for */
1017 if (buffer[1] != page)
1024 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
1025 * @sdev: The device to ask
1026 * @page: Which Vital Product Data to return
1027 * @buf: where to store the VPD
1028 * @buf_len: number of bytes in the VPD buffer area
1030 * SCSI devices may optionally supply Vital Product Data. Each 'page'
1031 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
1032 * If the device supports this VPD page, this routine returns a pointer
1033 * to a buffer containing the data from that page. The caller is
1034 * responsible for calling kfree() on this pointer when it is no longer
1035 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
1037 int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
1042 /* Ask for all the pages supported by this device */
1043 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
1047 /* If the user actually wanted this page, we can skip the rest */
1051 for (i = 0; i < min((int)buf[3], buf_len - 4); i++)
1052 if (buf[i + 4] == page)
1055 if (i < buf[3] && i > buf_len)
1056 /* ran off the end of the buffer, give us benefit of doubt */
1058 /* The device claims it doesn't support the requested page */
1062 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
1071 EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
1074 * scsi_device_get - get an additional reference to a scsi_device
1075 * @sdev: device to get a reference to
1077 * Description: Gets a reference to the scsi_device and increments the use count
1078 * of the underlying LLDD module. You must hold host_lock of the
1079 * parent Scsi_Host or already have a reference when calling this.
1081 int scsi_device_get(struct scsi_device *sdev)
1083 if (sdev->sdev_state == SDEV_DEL)
1085 if (!get_device(&sdev->sdev_gendev))
1087 /* We can fail this if we're doing SCSI operations
1088 * from module exit (like cache flush) */
1089 try_module_get(sdev->host->hostt->module);
1093 EXPORT_SYMBOL(scsi_device_get);
1096 * scsi_device_put - release a reference to a scsi_device
1097 * @sdev: device to release a reference on.
1099 * Description: Release a reference to the scsi_device and decrements the use
1100 * count of the underlying LLDD module. The device is freed once the last
1103 void scsi_device_put(struct scsi_device *sdev)
1105 #ifdef CONFIG_MODULE_UNLOAD
1106 struct module *module = sdev->host->hostt->module;
1108 /* The module refcount will be zero if scsi_device_get()
1109 * was called from a module removal routine */
1110 if (module && module_refcount(module) != 0)
1113 put_device(&sdev->sdev_gendev);
1115 EXPORT_SYMBOL(scsi_device_put);
1117 /* helper for shost_for_each_device, see that for documentation */
1118 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
1119 struct scsi_device *prev)
1121 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
1122 struct scsi_device *next = NULL;
1123 unsigned long flags;
1125 spin_lock_irqsave(shost->host_lock, flags);
1126 while (list->next != &shost->__devices) {
1127 next = list_entry(list->next, struct scsi_device, siblings);
1128 /* skip devices that we can't get a reference to */
1129 if (!scsi_device_get(next))
1134 spin_unlock_irqrestore(shost->host_lock, flags);
1137 scsi_device_put(prev);
1140 EXPORT_SYMBOL(__scsi_iterate_devices);
1143 * starget_for_each_device - helper to walk all devices of a target
1144 * @starget: target whose devices we want to iterate over.
1145 * @data: Opaque passed to each function call.
1146 * @fn: Function to call on each device
1148 * This traverses over each device of @starget. The devices have
1149 * a reference that must be released by scsi_host_put when breaking
1152 void starget_for_each_device(struct scsi_target *starget, void *data,
1153 void (*fn)(struct scsi_device *, void *))
1155 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1156 struct scsi_device *sdev;
1158 shost_for_each_device(sdev, shost) {
1159 if ((sdev->channel == starget->channel) &&
1160 (sdev->id == starget->id))
1164 EXPORT_SYMBOL(starget_for_each_device);
1167 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
1168 * @starget: target whose devices we want to iterate over.
1169 * @data: parameter for callback @fn()
1170 * @fn: callback function that is invoked for each device
1172 * This traverses over each device of @starget. It does _not_
1173 * take a reference on the scsi_device, so the whole loop must be
1174 * protected by shost->host_lock.
1176 * Note: The only reason why drivers would want to use this is because
1177 * they need to access the device list in irq context. Otherwise you
1178 * really want to use starget_for_each_device instead.
1180 void __starget_for_each_device(struct scsi_target *starget, void *data,
1181 void (*fn)(struct scsi_device *, void *))
1183 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1184 struct scsi_device *sdev;
1186 __shost_for_each_device(sdev, shost) {
1187 if ((sdev->channel == starget->channel) &&
1188 (sdev->id == starget->id))
1192 EXPORT_SYMBOL(__starget_for_each_device);
1195 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
1196 * @starget: SCSI target pointer
1197 * @lun: SCSI Logical Unit Number
1199 * Description: Looks up the scsi_device with the specified @lun for a given
1200 * @starget. The returned scsi_device does not have an additional
1201 * reference. You must hold the host's host_lock over this call and
1202 * any access to the returned scsi_device. A scsi_device in state
1203 * SDEV_DEL is skipped.
1205 * Note: The only reason why drivers should use this is because
1206 * they need to access the device list in irq context. Otherwise you
1207 * really want to use scsi_device_lookup_by_target instead.
1209 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
1212 struct scsi_device *sdev;
1214 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
1215 if (sdev->sdev_state == SDEV_DEL)
1217 if (sdev->lun ==lun)
1223 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
1226 * scsi_device_lookup_by_target - find a device given the target
1227 * @starget: SCSI target pointer
1228 * @lun: SCSI Logical Unit Number
1230 * Description: Looks up the scsi_device with the specified @lun for a given
1231 * @starget. The returned scsi_device has an additional reference that
1232 * needs to be released with scsi_device_put once you're done with it.
1234 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
1237 struct scsi_device *sdev;
1238 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1239 unsigned long flags;
1241 spin_lock_irqsave(shost->host_lock, flags);
1242 sdev = __scsi_device_lookup_by_target(starget, lun);
1243 if (sdev && scsi_device_get(sdev))
1245 spin_unlock_irqrestore(shost->host_lock, flags);
1249 EXPORT_SYMBOL(scsi_device_lookup_by_target);
1252 * __scsi_device_lookup - find a device given the host (UNLOCKED)
1253 * @shost: SCSI host pointer
1254 * @channel: SCSI channel (zero if only one channel)
1255 * @id: SCSI target number (physical unit number)
1256 * @lun: SCSI Logical Unit Number
1258 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1259 * for a given host. The returned scsi_device does not have an additional
1260 * reference. You must hold the host's host_lock over this call and any access
1261 * to the returned scsi_device.
1263 * Note: The only reason why drivers would want to use this is because
1264 * they need to access the device list in irq context. Otherwise you
1265 * really want to use scsi_device_lookup instead.
1267 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
1268 uint channel, uint id, uint lun)
1270 struct scsi_device *sdev;
1272 list_for_each_entry(sdev, &shost->__devices, siblings) {
1273 if (sdev->channel == channel && sdev->id == id &&
1280 EXPORT_SYMBOL(__scsi_device_lookup);
1283 * scsi_device_lookup - find a device given the host
1284 * @shost: SCSI host pointer
1285 * @channel: SCSI channel (zero if only one channel)
1286 * @id: SCSI target number (physical unit number)
1287 * @lun: SCSI Logical Unit Number
1289 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1290 * for a given host. The returned scsi_device has an additional reference that
1291 * needs to be released with scsi_device_put once you're done with it.
1293 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
1294 uint channel, uint id, uint lun)
1296 struct scsi_device *sdev;
1297 unsigned long flags;
1299 spin_lock_irqsave(shost->host_lock, flags);
1300 sdev = __scsi_device_lookup(shost, channel, id, lun);
1301 if (sdev && scsi_device_get(sdev))
1303 spin_unlock_irqrestore(shost->host_lock, flags);
1307 EXPORT_SYMBOL(scsi_device_lookup);
1309 MODULE_DESCRIPTION("SCSI core");
1310 MODULE_LICENSE("GPL");
1312 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
1313 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
1315 static int __init init_scsi(void)
1319 error = scsi_init_queue();
1322 error = scsi_init_procfs();
1325 error = scsi_init_devinfo();
1327 goto cleanup_procfs;
1328 error = scsi_init_hosts();
1330 goto cleanup_devlist;
1331 error = scsi_init_sysctl();
1334 error = scsi_sysfs_register();
1336 goto cleanup_sysctl;
1338 scsi_netlink_init();
1340 printk(KERN_NOTICE "SCSI subsystem initialized\n");
1348 scsi_exit_devinfo();
1353 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
1358 static void __exit exit_scsi(void)
1360 scsi_netlink_exit();
1361 scsi_sysfs_unregister();
1364 scsi_exit_devinfo();
1369 subsys_initcall(init_scsi);
1370 module_exit(exit_scsi);