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>
76 * Definitions and constants.
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.
83 unsigned int scsi_logging_level;
84 #if defined(CONFIG_SCSI_LOGGING)
85 EXPORT_SYMBOL(scsi_logging_level);
88 /* sd, scsi core and power management need to coordinate flushing async actions */
89 ASYNC_DOMAIN(scsi_sd_probe_domain);
90 EXPORT_SYMBOL(scsi_sd_probe_domain);
93 * Separate domain (from scsi_sd_probe_domain) to maximize the benefit of
94 * asynchronous system resume operations. It is marked 'exclusive' to avoid
95 * being included in the async_synchronize_full() that is invoked by
98 ASYNC_DOMAIN_EXCLUSIVE(scsi_sd_pm_domain);
99 EXPORT_SYMBOL(scsi_sd_pm_domain);
101 /* NB: These are exposed through /proc/scsi/scsi and form part of the ABI.
102 * You may not alter any existing entry (although adding new ones is
103 * encouraged once assigned by ANSI/INCITS T10
105 static const char *const scsi_device_types[] = {
130 * scsi_device_type - Return 17 char string indicating device type.
131 * @type: type number to look up
134 const char * scsi_device_type(unsigned type)
137 return "Well-known LUN ";
140 if (type >= ARRAY_SIZE(scsi_device_types))
142 return scsi_device_types[type];
145 EXPORT_SYMBOL(scsi_device_type);
147 struct scsi_host_cmd_pool {
148 struct kmem_cache *cmd_slab;
149 struct kmem_cache *sense_slab;
153 unsigned int slab_flags;
157 static struct scsi_host_cmd_pool scsi_cmd_pool = {
158 .cmd_name = "scsi_cmd_cache",
159 .sense_name = "scsi_sense_cache",
160 .slab_flags = SLAB_HWCACHE_ALIGN,
163 static struct scsi_host_cmd_pool scsi_cmd_dma_pool = {
164 .cmd_name = "scsi_cmd_cache(DMA)",
165 .sense_name = "scsi_sense_cache(DMA)",
166 .slab_flags = SLAB_HWCACHE_ALIGN|SLAB_CACHE_DMA,
167 .gfp_mask = __GFP_DMA,
170 static DEFINE_MUTEX(host_cmd_pool_mutex);
173 * scsi_host_free_command - internal function to release a command
174 * @shost: host to free the command for
175 * @cmd: command to release
177 * the command must previously have been allocated by
178 * scsi_host_alloc_command.
181 scsi_host_free_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
183 struct scsi_host_cmd_pool *pool = shost->cmd_pool;
186 kmem_cache_free(scsi_sdb_cache, cmd->prot_sdb);
187 kmem_cache_free(pool->sense_slab, cmd->sense_buffer);
188 kmem_cache_free(pool->cmd_slab, cmd);
192 * scsi_host_alloc_command - internal function to allocate command
193 * @shost: SCSI host whose pool to allocate from
194 * @gfp_mask: mask for the allocation
196 * Returns a fully allocated command with sense buffer and protection
197 * data buffer (where applicable) or NULL on failure
199 static struct scsi_cmnd *
200 scsi_host_alloc_command(struct Scsi_Host *shost, gfp_t gfp_mask)
202 struct scsi_host_cmd_pool *pool = shost->cmd_pool;
203 struct scsi_cmnd *cmd;
205 cmd = kmem_cache_zalloc(pool->cmd_slab, gfp_mask | pool->gfp_mask);
209 cmd->sense_buffer = kmem_cache_alloc(pool->sense_slab,
210 gfp_mask | pool->gfp_mask);
211 if (!cmd->sense_buffer)
214 if (scsi_host_get_prot(shost) >= SHOST_DIX_TYPE0_PROTECTION) {
215 cmd->prot_sdb = kmem_cache_zalloc(scsi_sdb_cache, gfp_mask);
217 goto fail_free_sense;
223 kmem_cache_free(pool->sense_slab, cmd->sense_buffer);
225 kmem_cache_free(pool->cmd_slab, cmd);
231 * __scsi_get_command - Allocate a struct scsi_cmnd
232 * @shost: host to transmit command
233 * @gfp_mask: allocation mask
235 * Description: allocate a struct scsi_cmd from host's slab, recycling from the
236 * host's free_list if necessary.
238 static struct scsi_cmnd *
239 __scsi_get_command(struct Scsi_Host *shost, gfp_t gfp_mask)
241 struct scsi_cmnd *cmd = scsi_host_alloc_command(shost, gfp_mask);
243 if (unlikely(!cmd)) {
246 spin_lock_irqsave(&shost->free_list_lock, flags);
247 if (likely(!list_empty(&shost->free_list))) {
248 cmd = list_entry(shost->free_list.next,
249 struct scsi_cmnd, list);
250 list_del_init(&cmd->list);
252 spin_unlock_irqrestore(&shost->free_list_lock, flags);
257 buf = cmd->sense_buffer;
258 prot = cmd->prot_sdb;
260 memset(cmd, 0, sizeof(*cmd));
262 cmd->sense_buffer = buf;
263 cmd->prot_sdb = prot;
271 * scsi_get_command - Allocate and setup a scsi command block
272 * @dev: parent scsi device
273 * @gfp_mask: allocator flags
275 * Returns: The allocated scsi command structure.
277 struct scsi_cmnd *scsi_get_command(struct scsi_device *dev, gfp_t gfp_mask)
279 struct scsi_cmnd *cmd = __scsi_get_command(dev->host, gfp_mask);
282 if (unlikely(cmd == NULL))
286 INIT_LIST_HEAD(&cmd->list);
287 INIT_DELAYED_WORK(&cmd->abort_work, scmd_eh_abort_handler);
288 spin_lock_irqsave(&dev->list_lock, flags);
289 list_add_tail(&cmd->list, &dev->cmd_list);
290 spin_unlock_irqrestore(&dev->list_lock, flags);
291 cmd->jiffies_at_alloc = jiffies;
296 * __scsi_put_command - Free a struct scsi_cmnd
298 * @cmd: Command to free
300 static void __scsi_put_command(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
304 if (unlikely(list_empty(&shost->free_list))) {
305 spin_lock_irqsave(&shost->free_list_lock, flags);
306 if (list_empty(&shost->free_list)) {
307 list_add(&cmd->list, &shost->free_list);
310 spin_unlock_irqrestore(&shost->free_list_lock, flags);
313 if (likely(cmd != NULL))
314 scsi_host_free_command(shost, cmd);
318 * scsi_put_command - Free a scsi command block
319 * @cmd: command block to free
323 * Notes: The command must not belong to any lists.
325 void scsi_put_command(struct scsi_cmnd *cmd)
329 /* serious error if the command hasn't come from a device list */
330 spin_lock_irqsave(&cmd->device->list_lock, flags);
331 BUG_ON(list_empty(&cmd->list));
332 list_del_init(&cmd->list);
333 spin_unlock_irqrestore(&cmd->device->list_lock, flags);
335 BUG_ON(delayed_work_pending(&cmd->abort_work));
337 __scsi_put_command(cmd->device->host, cmd);
340 static struct scsi_host_cmd_pool *
341 scsi_find_host_cmd_pool(struct Scsi_Host *shost)
343 if (shost->hostt->cmd_size)
344 return shost->hostt->cmd_pool;
345 if (shost->unchecked_isa_dma)
346 return &scsi_cmd_dma_pool;
347 return &scsi_cmd_pool;
351 scsi_free_host_cmd_pool(struct scsi_host_cmd_pool *pool)
353 kfree(pool->sense_name);
354 kfree(pool->cmd_name);
358 static struct scsi_host_cmd_pool *
359 scsi_alloc_host_cmd_pool(struct Scsi_Host *shost)
361 struct scsi_host_template *hostt = shost->hostt;
362 struct scsi_host_cmd_pool *pool;
364 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
368 pool->cmd_name = kasprintf(GFP_KERNEL, "%s_cmd", hostt->proc_name);
369 pool->sense_name = kasprintf(GFP_KERNEL, "%s_sense", hostt->proc_name);
370 if (!pool->cmd_name || !pool->sense_name) {
371 scsi_free_host_cmd_pool(pool);
375 pool->slab_flags = SLAB_HWCACHE_ALIGN;
376 if (shost->unchecked_isa_dma) {
377 pool->slab_flags |= SLAB_CACHE_DMA;
378 pool->gfp_mask = __GFP_DMA;
382 hostt->cmd_pool = pool;
387 static struct scsi_host_cmd_pool *
388 scsi_get_host_cmd_pool(struct Scsi_Host *shost)
390 struct scsi_host_template *hostt = shost->hostt;
391 struct scsi_host_cmd_pool *retval = NULL, *pool;
392 size_t cmd_size = sizeof(struct scsi_cmnd) + hostt->cmd_size;
395 * Select a command slab for this host and create it if not
398 mutex_lock(&host_cmd_pool_mutex);
399 pool = scsi_find_host_cmd_pool(shost);
401 pool = scsi_alloc_host_cmd_pool(shost);
407 pool->cmd_slab = kmem_cache_create(pool->cmd_name, cmd_size, 0,
408 pool->slab_flags, NULL);
412 pool->sense_slab = kmem_cache_create(pool->sense_name,
413 SCSI_SENSE_BUFFERSIZE, 0,
414 pool->slab_flags, NULL);
415 if (!pool->sense_slab)
422 mutex_unlock(&host_cmd_pool_mutex);
426 kmem_cache_destroy(pool->cmd_slab);
428 if (hostt->cmd_size) {
429 scsi_free_host_cmd_pool(pool);
430 hostt->cmd_pool = NULL;
435 static void scsi_put_host_cmd_pool(struct Scsi_Host *shost)
437 struct scsi_host_template *hostt = shost->hostt;
438 struct scsi_host_cmd_pool *pool;
440 mutex_lock(&host_cmd_pool_mutex);
441 pool = scsi_find_host_cmd_pool(shost);
444 * This may happen if a driver has a mismatched get and put
445 * of the command pool; the driver should be implicated in
448 BUG_ON(pool->users == 0);
450 if (!--pool->users) {
451 kmem_cache_destroy(pool->cmd_slab);
452 kmem_cache_destroy(pool->sense_slab);
453 if (hostt->cmd_size) {
454 scsi_free_host_cmd_pool(pool);
455 hostt->cmd_pool = NULL;
458 mutex_unlock(&host_cmd_pool_mutex);
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 const gfp_t gfp_mask = shost->unchecked_isa_dma ? GFP_DMA : GFP_KERNEL;
474 struct scsi_cmnd *cmd;
476 spin_lock_init(&shost->free_list_lock);
477 INIT_LIST_HEAD(&shost->free_list);
479 shost->cmd_pool = scsi_get_host_cmd_pool(shost);
480 if (!shost->cmd_pool)
484 * Get one backup command for this host.
486 cmd = scsi_host_alloc_command(shost, gfp_mask);
488 scsi_put_host_cmd_pool(shost);
489 shost->cmd_pool = NULL;
492 list_add(&cmd->list, &shost->free_list);
497 * scsi_destroy_command_freelist - Release the command freelist for a scsi host.
498 * @shost: host whose freelist is going to be destroyed
500 void scsi_destroy_command_freelist(struct Scsi_Host *shost)
503 * If cmd_pool is NULL the free list was not initialized, so
504 * do not attempt to release resources.
506 if (!shost->cmd_pool)
509 while (!list_empty(&shost->free_list)) {
510 struct scsi_cmnd *cmd;
512 cmd = list_entry(shost->free_list.next, struct scsi_cmnd, list);
513 list_del_init(&cmd->list);
514 scsi_host_free_command(shost, cmd);
516 shost->cmd_pool = NULL;
517 scsi_put_host_cmd_pool(shost);
520 #ifdef CONFIG_SCSI_LOGGING
521 void scsi_log_send(struct scsi_cmnd *cmd)
526 * If ML QUEUE log level is greater than or equal to:
528 * 1: nothing (match completion)
530 * 2: log opcode + command of all commands + cmd address
534 * 4: same as 3 plus dump extra junk
536 if (unlikely(scsi_logging_level)) {
537 level = SCSI_LOG_LEVEL(SCSI_LOG_MLQUEUE_SHIFT,
538 SCSI_LOG_MLQUEUE_BITS);
540 scmd_printk(KERN_INFO, cmd,
541 "Send: scmd 0x%p\n", cmd);
542 scsi_print_command(cmd);
544 printk(KERN_INFO "buffer = 0x%p, bufflen = %d,"
545 " queuecommand 0x%p\n",
546 scsi_sglist(cmd), scsi_bufflen(cmd),
547 cmd->device->host->hostt->queuecommand);
554 void scsi_log_completion(struct scsi_cmnd *cmd, int disposition)
559 * If ML COMPLETE log level is greater than or equal to:
561 * 1: log disposition, result, opcode + command, and conditionally
562 * sense data for failures or non SUCCESS dispositions.
564 * 2: same as 1 but for all command completions.
568 * 4: same as 3 plus dump extra junk
570 if (unlikely(scsi_logging_level)) {
571 level = SCSI_LOG_LEVEL(SCSI_LOG_MLCOMPLETE_SHIFT,
572 SCSI_LOG_MLCOMPLETE_BITS);
573 if (((level > 0) && (cmd->result || disposition != SUCCESS)) ||
575 scsi_print_result(cmd, "Done: ", disposition);
576 scsi_print_command(cmd);
577 if (status_byte(cmd->result) & CHECK_CONDITION)
578 scsi_print_sense(cmd);
580 scmd_printk(KERN_INFO, cmd,
581 "scsi host busy %d failed %d\n",
582 atomic_read(&cmd->device->host->host_busy),
583 cmd->device->host->host_failed);
590 * scsi_cmd_get_serial - Assign a serial number to a command
591 * @host: the scsi host
592 * @cmd: command to assign serial number to
594 * Description: a serial number identifies a request for error recovery
595 * and debugging purposes. Protected by the Host_Lock of host.
597 void scsi_cmd_get_serial(struct Scsi_Host *host, struct scsi_cmnd *cmd)
599 cmd->serial_number = host->cmd_serial_number++;
600 if (cmd->serial_number == 0)
601 cmd->serial_number = host->cmd_serial_number++;
603 EXPORT_SYMBOL(scsi_cmd_get_serial);
606 * scsi_dispatch_command - Dispatch a command to the low-level driver.
607 * @cmd: command block we are dispatching.
609 * Return: nonzero return request was rejected and device's queue needs to be
612 int scsi_dispatch_cmd(struct scsi_cmnd *cmd)
614 struct Scsi_Host *host = cmd->device->host;
617 atomic_inc(&cmd->device->iorequest_cnt);
619 /* check if the device is still usable */
620 if (unlikely(cmd->device->sdev_state == SDEV_DEL)) {
621 /* in SDEV_DEL we error all commands. DID_NO_CONNECT
622 * returns an immediate error upwards, and signals
623 * that the device is no longer present */
624 cmd->result = DID_NO_CONNECT << 16;
628 /* Check to see if the scsi lld made this device blocked. */
629 if (unlikely(scsi_device_blocked(cmd->device))) {
631 * in blocked state, the command is just put back on
632 * the device queue. The suspend state has already
633 * blocked the queue so future requests should not
634 * occur until the device transitions out of the
637 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
638 "queuecommand : device blocked\n"));
639 return SCSI_MLQUEUE_DEVICE_BUSY;
642 /* Store the LUN value in cmnd, if needed. */
643 if (cmd->device->lun_in_cdb)
644 cmd->cmnd[1] = (cmd->cmnd[1] & 0x1f) |
645 (cmd->device->lun << 5 & 0xe0);
650 * Before we queue this command, check if the command
651 * length exceeds what the host adapter can handle.
653 if (cmd->cmd_len > cmd->device->host->max_cmd_len) {
654 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
655 "queuecommand : command too long. "
656 "cdb_size=%d host->max_cmd_len=%d\n",
657 cmd->cmd_len, cmd->device->host->max_cmd_len));
658 cmd->result = (DID_ABORT << 16);
662 if (unlikely(host->shost_state == SHOST_DEL)) {
663 cmd->result = (DID_NO_CONNECT << 16);
668 trace_scsi_dispatch_cmd_start(cmd);
669 rtn = host->hostt->queuecommand(host, cmd);
671 trace_scsi_dispatch_cmd_error(cmd, rtn);
672 if (rtn != SCSI_MLQUEUE_DEVICE_BUSY &&
673 rtn != SCSI_MLQUEUE_TARGET_BUSY)
674 rtn = SCSI_MLQUEUE_HOST_BUSY;
676 SCSI_LOG_MLQUEUE(3, scmd_printk(KERN_INFO, cmd,
677 "queuecommand : request rejected\n"));
687 * scsi_finish_command - cleanup and pass command back to upper layer
690 * Description: Pass command off to upper layer for finishing of I/O
691 * request, waking processes that are waiting on results,
694 void scsi_finish_command(struct scsi_cmnd *cmd)
696 struct scsi_device *sdev = cmd->device;
697 struct scsi_target *starget = scsi_target(sdev);
698 struct Scsi_Host *shost = sdev->host;
699 struct scsi_driver *drv;
700 unsigned int good_bytes;
702 scsi_device_unbusy(sdev);
705 * Clear the flags that say that the device/target/host is no longer
706 * capable of accepting new commands.
708 if (atomic_read(&shost->host_blocked))
709 atomic_set(&shost->host_blocked, 0);
710 if (atomic_read(&starget->target_blocked))
711 atomic_set(&starget->target_blocked, 0);
712 if (atomic_read(&sdev->device_blocked))
713 atomic_set(&sdev->device_blocked, 0);
716 * If we have valid sense information, then some kind of recovery
717 * must have taken place. Make a note of this.
719 if (SCSI_SENSE_VALID(cmd))
720 cmd->result |= (DRIVER_SENSE << 24);
722 SCSI_LOG_MLCOMPLETE(4, sdev_printk(KERN_INFO, sdev,
723 "Notifying upper driver of completion "
724 "(result %x)\n", cmd->result));
726 good_bytes = scsi_bufflen(cmd);
727 if (cmd->request->cmd_type != REQ_TYPE_BLOCK_PC) {
728 int old_good_bytes = good_bytes;
729 drv = scsi_cmd_to_driver(cmd);
731 good_bytes = drv->done(cmd);
733 * USB may not give sense identifying bad sector and
734 * simply return a residue instead, so subtract off the
735 * residue if drv->done() error processing indicates no
736 * change to the completion length.
738 if (good_bytes == old_good_bytes)
739 good_bytes -= scsi_get_resid(cmd);
741 scsi_io_completion(cmd, good_bytes);
745 * scsi_change_queue_depth - change a device's queue depth
746 * @sdev: SCSI Device in question
747 * @depth: number of commands allowed to be queued to the driver
749 * Sets the device queue depth and returns the new value.
751 int scsi_change_queue_depth(struct scsi_device *sdev, int depth)
758 spin_lock_irqsave(sdev->request_queue->queue_lock, flags);
761 * Check to see if the queue is managed by the block layer.
762 * If it is, and we fail to adjust the depth, exit.
764 * Do not resize the tag map if it is a host wide share bqt,
765 * because the size should be the hosts's can_queue. If there
766 * is more IO than the LLD's can_queue (so there are not enuogh
767 * tags) request_fn's host queue ready check will handle it.
769 if (!shost_use_blk_mq(sdev->host) && !sdev->host->bqt) {
770 if (blk_queue_tagged(sdev->request_queue) &&
771 blk_queue_resize_tags(sdev->request_queue, depth) != 0)
775 sdev->queue_depth = depth;
777 spin_unlock_irqrestore(sdev->request_queue->queue_lock, flags);
779 return sdev->queue_depth;
781 EXPORT_SYMBOL(scsi_change_queue_depth);
784 * scsi_track_queue_full - track QUEUE_FULL events to adjust queue depth
785 * @sdev: SCSI Device in question
786 * @depth: Current number of outstanding SCSI commands on this device,
787 * not counting the one returned as QUEUE_FULL.
789 * Description: This function will track successive QUEUE_FULL events on a
790 * specific SCSI device to determine if and when there is a
791 * need to adjust the queue depth on the device.
793 * Returns: 0 - No change needed, >0 - Adjust queue depth to this new depth,
794 * -1 - Drop back to untagged operation using host->cmd_per_lun
795 * as the untagged command depth
797 * Lock Status: None held on entry
799 * Notes: Low level drivers may call this at any time and we will do
800 * "The Right Thing." We are interrupt context safe.
802 int scsi_track_queue_full(struct scsi_device *sdev, int depth)
806 * Don't let QUEUE_FULLs on the same
807 * jiffies count, they could all be from
810 if ((jiffies >> 4) == (sdev->last_queue_full_time >> 4))
813 sdev->last_queue_full_time = jiffies;
814 if (sdev->last_queue_full_depth != depth) {
815 sdev->last_queue_full_count = 1;
816 sdev->last_queue_full_depth = depth;
818 sdev->last_queue_full_count++;
821 if (sdev->last_queue_full_count <= 10)
824 return scsi_change_queue_depth(sdev, depth);
826 EXPORT_SYMBOL(scsi_track_queue_full);
829 * scsi_vpd_inquiry - Request a device provide us with a VPD page
830 * @sdev: The device to ask
831 * @buffer: Where to put the result
832 * @page: Which Vital Product Data to return
833 * @len: The length of the buffer
835 * This is an internal helper function. You probably want to use
836 * scsi_get_vpd_page instead.
838 * Returns size of the vpd page on success or a negative error number.
840 static int scsi_vpd_inquiry(struct scsi_device *sdev, unsigned char *buffer,
841 u8 page, unsigned len)
844 unsigned char cmd[16];
850 cmd[1] = 1; /* EVPD */
854 cmd[5] = 0; /* Control byte */
857 * I'm not convinced we need to try quite this hard to get VPD, but
858 * all the existing users tried this hard.
860 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer,
861 len, NULL, 30 * HZ, 3, NULL);
865 /* Sanity check that we got the page back that we asked for */
866 if (buffer[1] != page)
869 return get_unaligned_be16(&buffer[2]) + 4;
873 * scsi_get_vpd_page - Get Vital Product Data from a SCSI device
874 * @sdev: The device to ask
875 * @page: Which Vital Product Data to return
876 * @buf: where to store the VPD
877 * @buf_len: number of bytes in the VPD buffer area
879 * SCSI devices may optionally supply Vital Product Data. Each 'page'
880 * of VPD is defined in the appropriate SCSI document (eg SPC, SBC).
881 * If the device supports this VPD page, this routine returns a pointer
882 * to a buffer containing the data from that page. The caller is
883 * responsible for calling kfree() on this pointer when it is no longer
884 * needed. If we cannot retrieve the VPD page this routine returns %NULL.
886 int scsi_get_vpd_page(struct scsi_device *sdev, u8 page, unsigned char *buf,
891 if (sdev->skip_vpd_pages)
894 /* Ask for all the pages supported by this device */
895 result = scsi_vpd_inquiry(sdev, buf, 0, buf_len);
899 /* If the user actually wanted this page, we can skip the rest */
903 for (i = 4; i < min(result, buf_len); i++)
907 if (i < result && i >= buf_len)
908 /* ran off the end of the buffer, give us benefit of doubt */
910 /* The device claims it doesn't support the requested page */
914 result = scsi_vpd_inquiry(sdev, buf, page, buf_len);
923 EXPORT_SYMBOL_GPL(scsi_get_vpd_page);
926 * scsi_attach_vpd - Attach Vital Product Data to a SCSI device structure
927 * @sdev: The device to ask
929 * Attach the 'Device Identification' VPD page (0x83) and the
930 * 'Unit Serial Number' VPD page (0x80) to a SCSI device
931 * structure. This information can be used to identify the device
934 void scsi_attach_vpd(struct scsi_device *sdev)
937 int vpd_len = SCSI_VPD_PG_LEN;
938 int pg80_supported = 0;
939 int pg83_supported = 0;
940 unsigned char *vpd_buf;
942 if (sdev->skip_vpd_pages)
945 vpd_buf = kmalloc(vpd_len, GFP_KERNEL);
949 /* Ask for all the pages supported by this device */
950 result = scsi_vpd_inquiry(sdev, vpd_buf, 0, vpd_len);
955 if (result > vpd_len) {
961 for (i = 4; i < result; i++) {
962 if (vpd_buf[i] == 0x80)
964 if (vpd_buf[i] == 0x83)
968 vpd_len = SCSI_VPD_PG_LEN;
970 if (pg80_supported) {
972 vpd_buf = kmalloc(vpd_len, GFP_KERNEL);
976 result = scsi_vpd_inquiry(sdev, vpd_buf, 0x80, vpd_len);
981 if (result > vpd_len) {
986 sdev->vpd_pg80_len = result;
987 sdev->vpd_pg80 = vpd_buf;
988 vpd_len = SCSI_VPD_PG_LEN;
991 if (pg83_supported) {
993 vpd_buf = kmalloc(vpd_len, GFP_KERNEL);
997 result = scsi_vpd_inquiry(sdev, vpd_buf, 0x83, vpd_len);
1002 if (result > vpd_len) {
1007 sdev->vpd_pg83_len = result;
1008 sdev->vpd_pg83 = vpd_buf;
1013 * scsi_report_opcode - Find out if a given command opcode is supported
1014 * @sdev: scsi device to query
1015 * @buffer: scratch buffer (must be at least 20 bytes long)
1016 * @len: length of buffer
1017 * @opcode: opcode for command to look up
1019 * Uses the REPORT SUPPORTED OPERATION CODES to look up the given
1020 * opcode. Returns -EINVAL if RSOC fails, 0 if the command opcode is
1021 * unsupported and 1 if the device claims to support the command.
1023 int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
1024 unsigned int len, unsigned char opcode)
1026 unsigned char cmd[16];
1027 struct scsi_sense_hdr sshdr;
1030 if (sdev->no_report_opcodes || sdev->scsi_level < SCSI_SPC_3)
1034 cmd[0] = MAINTENANCE_IN;
1035 cmd[1] = MI_REPORT_SUPPORTED_OPERATION_CODES;
1036 cmd[2] = 1; /* One command format */
1038 put_unaligned_be32(len, &cmd[6]);
1039 memset(buffer, 0, len);
1041 result = scsi_execute_req(sdev, cmd, DMA_FROM_DEVICE, buffer, len,
1042 &sshdr, 30 * HZ, 3, NULL);
1044 if (result && scsi_sense_valid(&sshdr) &&
1045 sshdr.sense_key == ILLEGAL_REQUEST &&
1046 (sshdr.asc == 0x20 || sshdr.asc == 0x24) && sshdr.ascq == 0x00)
1049 if ((buffer[1] & 3) == 3) /* Command supported */
1054 EXPORT_SYMBOL(scsi_report_opcode);
1057 * scsi_device_get - get an additional reference to a scsi_device
1058 * @sdev: device to get a reference to
1060 * Description: Gets a reference to the scsi_device and increments the use count
1061 * of the underlying LLDD module. You must hold host_lock of the
1062 * parent Scsi_Host or already have a reference when calling this.
1064 int scsi_device_get(struct scsi_device *sdev)
1066 if (sdev->sdev_state == SDEV_DEL)
1068 if (!get_device(&sdev->sdev_gendev))
1070 /* We can fail this if we're doing SCSI operations
1071 * from module exit (like cache flush) */
1072 try_module_get(sdev->host->hostt->module);
1076 EXPORT_SYMBOL(scsi_device_get);
1079 * scsi_device_put - release a reference to a scsi_device
1080 * @sdev: device to release a reference on.
1082 * Description: Release a reference to the scsi_device and decrements the use
1083 * count of the underlying LLDD module. The device is freed once the last
1086 void scsi_device_put(struct scsi_device *sdev)
1088 #ifdef CONFIG_MODULE_UNLOAD
1089 struct module *module = sdev->host->hostt->module;
1091 /* The module refcount will be zero if scsi_device_get()
1092 * was called from a module removal routine */
1093 if (module && module_refcount(module) != 0)
1096 put_device(&sdev->sdev_gendev);
1098 EXPORT_SYMBOL(scsi_device_put);
1100 /* helper for shost_for_each_device, see that for documentation */
1101 struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *shost,
1102 struct scsi_device *prev)
1104 struct list_head *list = (prev ? &prev->siblings : &shost->__devices);
1105 struct scsi_device *next = NULL;
1106 unsigned long flags;
1108 spin_lock_irqsave(shost->host_lock, flags);
1109 while (list->next != &shost->__devices) {
1110 next = list_entry(list->next, struct scsi_device, siblings);
1111 /* skip devices that we can't get a reference to */
1112 if (!scsi_device_get(next))
1117 spin_unlock_irqrestore(shost->host_lock, flags);
1120 scsi_device_put(prev);
1123 EXPORT_SYMBOL(__scsi_iterate_devices);
1126 * starget_for_each_device - helper to walk all devices of a target
1127 * @starget: target whose devices we want to iterate over.
1128 * @data: Opaque passed to each function call.
1129 * @fn: Function to call on each device
1131 * This traverses over each device of @starget. The devices have
1132 * a reference that must be released by scsi_host_put when breaking
1135 void starget_for_each_device(struct scsi_target *starget, void *data,
1136 void (*fn)(struct scsi_device *, void *))
1138 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1139 struct scsi_device *sdev;
1141 shost_for_each_device(sdev, shost) {
1142 if ((sdev->channel == starget->channel) &&
1143 (sdev->id == starget->id))
1147 EXPORT_SYMBOL(starget_for_each_device);
1150 * __starget_for_each_device - helper to walk all devices of a target (UNLOCKED)
1151 * @starget: target whose devices we want to iterate over.
1152 * @data: parameter for callback @fn()
1153 * @fn: callback function that is invoked for each device
1155 * This traverses over each device of @starget. It does _not_
1156 * take a reference on the scsi_device, so the whole loop must be
1157 * protected by shost->host_lock.
1159 * Note: The only reason why drivers would want to use this is because
1160 * they need to access the device list in irq context. Otherwise you
1161 * really want to use starget_for_each_device instead.
1163 void __starget_for_each_device(struct scsi_target *starget, void *data,
1164 void (*fn)(struct scsi_device *, void *))
1166 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1167 struct scsi_device *sdev;
1169 __shost_for_each_device(sdev, shost) {
1170 if ((sdev->channel == starget->channel) &&
1171 (sdev->id == starget->id))
1175 EXPORT_SYMBOL(__starget_for_each_device);
1178 * __scsi_device_lookup_by_target - find a device given the target (UNLOCKED)
1179 * @starget: SCSI target pointer
1180 * @lun: SCSI Logical Unit Number
1182 * Description: Looks up the scsi_device with the specified @lun for a given
1183 * @starget. The returned scsi_device does not have an additional
1184 * reference. You must hold the host's host_lock over this call and
1185 * any access to the returned scsi_device. A scsi_device in state
1186 * SDEV_DEL is skipped.
1188 * Note: The only reason why drivers should use this is because
1189 * they need to access the device list in irq context. Otherwise you
1190 * really want to use scsi_device_lookup_by_target instead.
1192 struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *starget,
1195 struct scsi_device *sdev;
1197 list_for_each_entry(sdev, &starget->devices, same_target_siblings) {
1198 if (sdev->sdev_state == SDEV_DEL)
1200 if (sdev->lun ==lun)
1206 EXPORT_SYMBOL(__scsi_device_lookup_by_target);
1209 * scsi_device_lookup_by_target - find a device given the target
1210 * @starget: SCSI target pointer
1211 * @lun: SCSI Logical Unit Number
1213 * Description: Looks up the scsi_device with the specified @lun for a given
1214 * @starget. The returned scsi_device has an additional reference that
1215 * needs to be released with scsi_device_put once you're done with it.
1217 struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *starget,
1220 struct scsi_device *sdev;
1221 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1222 unsigned long flags;
1224 spin_lock_irqsave(shost->host_lock, flags);
1225 sdev = __scsi_device_lookup_by_target(starget, lun);
1226 if (sdev && scsi_device_get(sdev))
1228 spin_unlock_irqrestore(shost->host_lock, flags);
1232 EXPORT_SYMBOL(scsi_device_lookup_by_target);
1235 * __scsi_device_lookup - find a device given the host (UNLOCKED)
1236 * @shost: SCSI host pointer
1237 * @channel: SCSI channel (zero if only one channel)
1238 * @id: SCSI target number (physical unit number)
1239 * @lun: SCSI Logical Unit Number
1241 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1242 * for a given host. The returned scsi_device does not have an additional
1243 * reference. You must hold the host's host_lock over this call and any access
1244 * to the returned scsi_device.
1246 * Note: The only reason why drivers would want to use this is because
1247 * they need to access the device list in irq context. Otherwise you
1248 * really want to use scsi_device_lookup instead.
1250 struct scsi_device *__scsi_device_lookup(struct Scsi_Host *shost,
1251 uint channel, uint id, u64 lun)
1253 struct scsi_device *sdev;
1255 list_for_each_entry(sdev, &shost->__devices, siblings) {
1256 if (sdev->channel == channel && sdev->id == id &&
1263 EXPORT_SYMBOL(__scsi_device_lookup);
1266 * scsi_device_lookup - find a device given the host
1267 * @shost: SCSI host pointer
1268 * @channel: SCSI channel (zero if only one channel)
1269 * @id: SCSI target number (physical unit number)
1270 * @lun: SCSI Logical Unit Number
1272 * Description: Looks up the scsi_device with the specified @channel, @id, @lun
1273 * for a given host. The returned scsi_device has an additional reference that
1274 * needs to be released with scsi_device_put once you're done with it.
1276 struct scsi_device *scsi_device_lookup(struct Scsi_Host *shost,
1277 uint channel, uint id, u64 lun)
1279 struct scsi_device *sdev;
1280 unsigned long flags;
1282 spin_lock_irqsave(shost->host_lock, flags);
1283 sdev = __scsi_device_lookup(shost, channel, id, lun);
1284 if (sdev && scsi_device_get(sdev))
1286 spin_unlock_irqrestore(shost->host_lock, flags);
1290 EXPORT_SYMBOL(scsi_device_lookup);
1292 MODULE_DESCRIPTION("SCSI core");
1293 MODULE_LICENSE("GPL");
1295 module_param(scsi_logging_level, int, S_IRUGO|S_IWUSR);
1296 MODULE_PARM_DESC(scsi_logging_level, "a bit mask of logging levels");
1298 #ifdef CONFIG_SCSI_MQ_DEFAULT
1299 bool scsi_use_blk_mq = true;
1301 bool scsi_use_blk_mq = false;
1303 module_param_named(use_blk_mq, scsi_use_blk_mq, bool, S_IWUSR | S_IRUGO);
1305 static int __init init_scsi(void)
1309 error = scsi_init_queue();
1312 error = scsi_init_procfs();
1315 error = scsi_init_devinfo();
1317 goto cleanup_procfs;
1318 error = scsi_init_hosts();
1320 goto cleanup_devlist;
1321 error = scsi_init_sysctl();
1324 error = scsi_sysfs_register();
1326 goto cleanup_sysctl;
1328 scsi_netlink_init();
1330 printk(KERN_NOTICE "SCSI subsystem initialized\n");
1338 scsi_exit_devinfo();
1343 printk(KERN_ERR "SCSI subsystem failed to initialize, error = %d\n",
1348 static void __exit exit_scsi(void)
1350 scsi_netlink_exit();
1351 scsi_sysfs_unregister();
1354 scsi_exit_devinfo();
1357 async_unregister_domain(&scsi_sd_probe_domain);
1360 subsys_initcall(init_scsi);
1361 module_exit(exit_scsi);