2 * hosts.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995 Eric Youngdale
4 * Copyright (C) 2002-2003 Christoph Hellwig
6 * mid to lowlevel SCSI driver interface
7 * Initial versions: Drew Eckhardt
8 * Subsequent revisions: Eric Youngdale
12 * Jiffies wrap fixes (host->resetting), 3 Dec 1998 Andrea Arcangeli
13 * Added QLOGIC QLA1280 SCSI controller kernel host support.
14 * August 4, 1999 Fred Lewis, Intel DuPont
16 * Updated to reflect the new initialization scheme for the higher
17 * level of scsi drivers (sd/sr/st)
18 * September 17, 2000 Torben Mathiasen <tmm@image.dk>
20 * Restructured scsi_host lists and associated functions.
21 * September 04, 2002 Mike Anderson (andmike@us.ibm.com)
24 #include <linux/module.h>
25 #include <linux/blkdev.h>
26 #include <linux/kernel.h>
27 #include <linux/slab.h>
28 #include <linux/kthread.h>
29 #include <linux/string.h>
31 #include <linux/init.h>
32 #include <linux/completion.h>
33 #include <linux/transport_class.h>
34 #include <linux/platform_device.h>
35 #include <linux/pm_runtime.h>
36 #include <linux/idr.h>
37 #include <scsi/scsi_device.h>
38 #include <scsi/scsi_host.h>
39 #include <scsi/scsi_transport.h>
41 #include "scsi_priv.h"
42 #include "scsi_logging.h"
45 static DEFINE_IDA(host_index_ida);
48 static void scsi_host_cls_release(struct device *dev)
50 put_device(&class_to_shost(dev)->shost_gendev);
53 static struct class shost_class = {
55 .dev_release = scsi_host_cls_release,
59 * scsi_host_set_state - Take the given host through the host state model.
60 * @shost: scsi host to change the state of.
61 * @state: state to change to.
63 * Returns zero if unsuccessful or an error if the requested
64 * transition is illegal.
66 int scsi_host_set_state(struct Scsi_Host *shost, enum scsi_host_state state)
68 enum scsi_host_state oldstate = shost->shost_state;
70 if (state == oldstate)
75 /* There are no legal states that come back to
76 * created. This is the manually initialised start
103 case SHOST_CANCEL_RECOVERY:
113 case SHOST_DEL_RECOVERY:
120 case SHOST_CANCEL_RECOVERY:
130 case SHOST_DEL_RECOVERY:
132 case SHOST_CANCEL_RECOVERY:
139 shost->shost_state = state;
143 SCSI_LOG_ERROR_RECOVERY(1,
144 shost_printk(KERN_ERR, shost,
145 "Illegal host state transition"
147 scsi_host_state_name(oldstate),
148 scsi_host_state_name(state)));
151 EXPORT_SYMBOL(scsi_host_set_state);
154 * scsi_remove_host - remove a scsi host
155 * @shost: a pointer to a scsi host to remove
157 void scsi_remove_host(struct Scsi_Host *shost)
161 mutex_lock(&shost->scan_mutex);
162 spin_lock_irqsave(shost->host_lock, flags);
163 if (scsi_host_set_state(shost, SHOST_CANCEL))
164 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY)) {
165 spin_unlock_irqrestore(shost->host_lock, flags);
166 mutex_unlock(&shost->scan_mutex);
169 spin_unlock_irqrestore(shost->host_lock, flags);
171 scsi_autopm_get_host(shost);
172 flush_workqueue(shost->tmf_work_q);
173 scsi_forget_host(shost);
174 mutex_unlock(&shost->scan_mutex);
175 scsi_proc_host_rm(shost);
177 spin_lock_irqsave(shost->host_lock, flags);
178 if (scsi_host_set_state(shost, SHOST_DEL))
179 BUG_ON(scsi_host_set_state(shost, SHOST_DEL_RECOVERY));
180 spin_unlock_irqrestore(shost->host_lock, flags);
182 transport_unregister_device(&shost->shost_gendev);
183 device_unregister(&shost->shost_dev);
184 device_del(&shost->shost_gendev);
186 EXPORT_SYMBOL(scsi_remove_host);
189 * scsi_add_host_with_dma - add a scsi host with dma device
190 * @shost: scsi host pointer to add
191 * @dev: a struct device of type scsi class
192 * @dma_dev: dma device for the host
194 * Note: You rarely need to worry about this unless you're in a
195 * virtualised host environments, so use the simpler scsi_add_host()
199 * 0 on success / != 0 for error
201 int scsi_add_host_with_dma(struct Scsi_Host *shost, struct device *dev,
202 struct device *dma_dev)
204 struct scsi_host_template *sht = shost->hostt;
207 shost_printk(KERN_INFO, shost, "%s\n",
208 sht->info ? sht->info(shost) : sht->name);
210 if (!shost->can_queue) {
211 shost_printk(KERN_ERR, shost,
212 "can_queue = 0 no longer supported\n");
216 shost->cmd_per_lun = min_t(short, shost->cmd_per_lun,
219 error = scsi_init_sense_cache(shost);
223 if (shost_use_blk_mq(shost)) {
224 error = scsi_mq_setup_tags(shost);
228 shost->bqt = blk_init_tags(shost->can_queue,
229 shost->hostt->tag_alloc_policy);
236 if (!shost->shost_gendev.parent)
237 shost->shost_gendev.parent = dev ? dev : &platform_bus;
239 dma_dev = shost->shost_gendev.parent;
241 shost->dma_dev = dma_dev;
244 * Increase usage count temporarily here so that calling
245 * scsi_autopm_put_host() will trigger runtime idle if there is
246 * nothing else preventing suspending the device.
248 pm_runtime_get_noresume(&shost->shost_gendev);
249 pm_runtime_set_active(&shost->shost_gendev);
250 pm_runtime_enable(&shost->shost_gendev);
251 device_enable_async_suspend(&shost->shost_gendev);
253 error = device_add(&shost->shost_gendev);
255 goto out_disable_runtime_pm;
257 scsi_host_set_state(shost, SHOST_RUNNING);
258 get_device(shost->shost_gendev.parent);
260 device_enable_async_suspend(&shost->shost_dev);
262 get_device(&shost->shost_gendev);
263 error = device_add(&shost->shost_dev);
267 if (shost->transportt->host_size) {
268 shost->shost_data = kzalloc(shost->transportt->host_size,
270 if (shost->shost_data == NULL) {
276 if (shost->transportt->create_work_queue) {
277 snprintf(shost->work_q_name, sizeof(shost->work_q_name),
278 "scsi_wq_%d", shost->host_no);
279 shost->work_q = create_singlethread_workqueue(
281 if (!shost->work_q) {
283 goto out_free_shost_data;
287 error = scsi_sysfs_add_host(shost);
289 goto out_destroy_host;
291 scsi_proc_host_add(shost);
292 scsi_autopm_put_host(shost);
297 destroy_workqueue(shost->work_q);
299 kfree(shost->shost_data);
301 device_del(&shost->shost_dev);
304 * Host state is SHOST_RUNNING so we have to explicitly release
307 put_device(&shost->shost_dev);
308 device_del(&shost->shost_gendev);
309 out_disable_runtime_pm:
310 device_disable_async_suspend(&shost->shost_gendev);
311 pm_runtime_disable(&shost->shost_gendev);
312 pm_runtime_set_suspended(&shost->shost_gendev);
313 pm_runtime_put_noidle(&shost->shost_gendev);
314 if (shost_use_blk_mq(shost))
315 scsi_mq_destroy_tags(shost);
319 EXPORT_SYMBOL(scsi_add_host_with_dma);
321 static void scsi_host_dev_release(struct device *dev)
323 struct Scsi_Host *shost = dev_to_shost(dev);
324 struct device *parent = dev->parent;
326 scsi_proc_hostdir_rm(shost->hostt);
328 /* Wait for functions invoked through call_rcu(&shost->rcu, ...) */
331 if (shost->tmf_work_q)
332 destroy_workqueue(shost->tmf_work_q);
334 kthread_stop(shost->ehandler);
336 destroy_workqueue(shost->work_q);
338 if (shost->shost_state == SHOST_CREATED) {
340 * Free the shost_dev device name here if scsi_host_alloc()
341 * and scsi_host_put() have been called but neither
342 * scsi_host_add() nor scsi_host_remove() has been called.
343 * This avoids that the memory allocated for the shost_dev
346 kfree(dev_name(&shost->shost_dev));
349 if (shost_use_blk_mq(shost)) {
350 if (shost->tag_set.tags)
351 scsi_mq_destroy_tags(shost);
354 blk_free_tags(shost->bqt);
357 kfree(shost->shost_data);
359 ida_simple_remove(&host_index_ida, shost->host_no);
361 if (shost->shost_state != SHOST_CREATED)
366 static int shost_eh_deadline = -1;
368 module_param_named(eh_deadline, shost_eh_deadline, int, S_IRUGO|S_IWUSR);
369 MODULE_PARM_DESC(eh_deadline,
370 "SCSI EH timeout in seconds (should be between 0 and 2^31-1)");
372 static struct device_type scsi_host_type = {
374 .release = scsi_host_dev_release,
378 * scsi_host_alloc - register a scsi host adapter instance.
379 * @sht: pointer to scsi host template
380 * @privsize: extra bytes to allocate for driver
383 * Allocate a new Scsi_Host and perform basic initialization.
384 * The host is not published to the scsi midlayer until scsi_add_host
388 * Pointer to a new Scsi_Host
390 struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *sht, int privsize)
392 struct Scsi_Host *shost;
393 gfp_t gfp_mask = GFP_KERNEL;
396 if (sht->unchecked_isa_dma && privsize)
397 gfp_mask |= __GFP_DMA;
399 shost = kzalloc(sizeof(struct Scsi_Host) + privsize, gfp_mask);
403 shost->host_lock = &shost->default_lock;
404 spin_lock_init(shost->host_lock);
405 shost->shost_state = SHOST_CREATED;
406 INIT_LIST_HEAD(&shost->__devices);
407 INIT_LIST_HEAD(&shost->__targets);
408 INIT_LIST_HEAD(&shost->eh_cmd_q);
409 INIT_LIST_HEAD(&shost->starved_list);
410 init_waitqueue_head(&shost->host_wait);
411 mutex_init(&shost->scan_mutex);
413 index = ida_simple_get(&host_index_ida, 0, 0, GFP_KERNEL);
418 shost->host_no = index;
420 shost->dma_channel = 0xff;
422 /* These three are default values which can be overridden */
423 shost->max_channel = 0;
427 /* Give each shost a default transportt */
428 shost->transportt = &blank_transport_template;
431 * All drivers right now should be able to handle 12 byte
432 * commands. Every so often there are requests for 16 byte
433 * commands, but individual low-level drivers need to certify that
434 * they actually do something sensible with such commands.
436 shost->max_cmd_len = 12;
438 shost->this_id = sht->this_id;
439 shost->can_queue = sht->can_queue;
440 shost->sg_tablesize = sht->sg_tablesize;
441 shost->sg_prot_tablesize = sht->sg_prot_tablesize;
442 shost->cmd_per_lun = sht->cmd_per_lun;
443 shost->unchecked_isa_dma = sht->unchecked_isa_dma;
444 shost->use_clustering = sht->use_clustering;
445 shost->no_write_same = sht->no_write_same;
447 if (shost_eh_deadline == -1 || !sht->eh_host_reset_handler)
448 shost->eh_deadline = -1;
449 else if ((ulong) shost_eh_deadline * HZ > INT_MAX) {
450 shost_printk(KERN_WARNING, shost,
451 "eh_deadline %u too large, setting to %u\n",
452 shost_eh_deadline, INT_MAX / HZ);
453 shost->eh_deadline = INT_MAX;
455 shost->eh_deadline = shost_eh_deadline * HZ;
457 if (sht->supported_mode == MODE_UNKNOWN)
458 /* means we didn't set it ... default to INITIATOR */
459 shost->active_mode = MODE_INITIATOR;
461 shost->active_mode = sht->supported_mode;
463 if (sht->max_host_blocked)
464 shost->max_host_blocked = sht->max_host_blocked;
466 shost->max_host_blocked = SCSI_DEFAULT_HOST_BLOCKED;
469 * If the driver imposes no hard sector transfer limit, start at
470 * machine infinity initially.
472 if (sht->max_sectors)
473 shost->max_sectors = sht->max_sectors;
475 shost->max_sectors = SCSI_DEFAULT_MAX_SECTORS;
478 * assume a 4GB boundary, if not set
480 if (sht->dma_boundary)
481 shost->dma_boundary = sht->dma_boundary;
483 shost->dma_boundary = 0xffffffff;
485 shost->use_blk_mq = scsi_use_blk_mq;
486 shost->use_blk_mq = scsi_use_blk_mq || shost->hostt->force_blk_mq;
488 device_initialize(&shost->shost_gendev);
489 dev_set_name(&shost->shost_gendev, "host%d", shost->host_no);
490 shost->shost_gendev.bus = &scsi_bus_type;
491 shost->shost_gendev.type = &scsi_host_type;
493 device_initialize(&shost->shost_dev);
494 shost->shost_dev.parent = &shost->shost_gendev;
495 shost->shost_dev.class = &shost_class;
496 dev_set_name(&shost->shost_dev, "host%d", shost->host_no);
497 shost->shost_dev.groups = scsi_sysfs_shost_attr_groups;
499 shost->ehandler = kthread_run(scsi_error_handler, shost,
500 "scsi_eh_%d", shost->host_no);
501 if (IS_ERR(shost->ehandler)) {
502 shost_printk(KERN_WARNING, shost,
503 "error handler thread failed to spawn, error = %ld\n",
504 PTR_ERR(shost->ehandler));
505 shost->ehandler = NULL;
509 shost->tmf_work_q = alloc_workqueue("scsi_tmf_%d",
510 WQ_UNBOUND | WQ_MEM_RECLAIM,
512 if (!shost->tmf_work_q) {
513 shost_printk(KERN_WARNING, shost,
514 "failed to create tmf workq\n");
517 scsi_proc_hostdir_add(shost->hostt);
521 * Host state is still SHOST_CREATED and that is enough to release
522 * ->shost_gendev. scsi_host_dev_release() will free
523 * dev_name(&shost->shost_dev).
525 put_device(&shost->shost_gendev);
529 EXPORT_SYMBOL(scsi_host_alloc);
531 struct Scsi_Host *scsi_register(struct scsi_host_template *sht, int privsize)
533 struct Scsi_Host *shost = scsi_host_alloc(sht, privsize);
536 printk(KERN_WARNING "scsi_register() called on new-style "
537 "template for driver %s\n", sht->name);
542 list_add_tail(&shost->sht_legacy_list, &sht->legacy_hosts);
545 EXPORT_SYMBOL(scsi_register);
547 void scsi_unregister(struct Scsi_Host *shost)
549 list_del(&shost->sht_legacy_list);
550 scsi_host_put(shost);
552 EXPORT_SYMBOL(scsi_unregister);
554 static int __scsi_host_match(struct device *dev, const void *data)
557 const unsigned short *hostnum = data;
559 p = class_to_shost(dev);
560 return p->host_no == *hostnum;
564 * scsi_host_lookup - get a reference to a Scsi_Host by host no
565 * @hostnum: host number to locate
568 * A pointer to located Scsi_Host or NULL.
570 * The caller must do a scsi_host_put() to drop the reference
571 * that scsi_host_get() took. The put_device() below dropped
572 * the reference from class_find_device().
574 struct Scsi_Host *scsi_host_lookup(unsigned short hostnum)
577 struct Scsi_Host *shost = NULL;
579 cdev = class_find_device(&shost_class, NULL, &hostnum,
582 shost = scsi_host_get(class_to_shost(cdev));
587 EXPORT_SYMBOL(scsi_host_lookup);
590 * scsi_host_get - inc a Scsi_Host ref count
591 * @shost: Pointer to Scsi_Host to inc.
593 struct Scsi_Host *scsi_host_get(struct Scsi_Host *shost)
595 if ((shost->shost_state == SHOST_DEL) ||
596 !get_device(&shost->shost_gendev))
600 EXPORT_SYMBOL(scsi_host_get);
603 * scsi_host_put - dec a Scsi_Host ref count
604 * @shost: Pointer to Scsi_Host to dec.
606 void scsi_host_put(struct Scsi_Host *shost)
608 put_device(&shost->shost_gendev);
610 EXPORT_SYMBOL(scsi_host_put);
612 int scsi_init_hosts(void)
614 return class_register(&shost_class);
617 void scsi_exit_hosts(void)
619 class_unregister(&shost_class);
620 ida_destroy(&host_index_ida);
623 int scsi_is_host_device(const struct device *dev)
625 return dev->type == &scsi_host_type;
627 EXPORT_SYMBOL(scsi_is_host_device);
630 * scsi_queue_work - Queue work to the Scsi_Host workqueue.
631 * @shost: Pointer to Scsi_Host.
632 * @work: Work to queue for execution.
635 * 1 - work queued for execution
636 * 0 - work is already queued
637 * -EINVAL - work queue doesn't exist
639 int scsi_queue_work(struct Scsi_Host *shost, struct work_struct *work)
641 if (unlikely(!shost->work_q)) {
642 shost_printk(KERN_ERR, shost,
643 "ERROR: Scsi host '%s' attempted to queue scsi-work, "
644 "when no workqueue created.\n", shost->hostt->name);
650 return queue_work(shost->work_q, work);
652 EXPORT_SYMBOL_GPL(scsi_queue_work);
655 * scsi_flush_work - Flush a Scsi_Host's workqueue.
656 * @shost: Pointer to Scsi_Host.
658 void scsi_flush_work(struct Scsi_Host *shost)
660 if (!shost->work_q) {
661 shost_printk(KERN_ERR, shost,
662 "ERROR: Scsi host '%s' attempted to flush scsi-work, "
663 "when no workqueue created.\n", shost->hostt->name);
668 flush_workqueue(shost->work_q);
670 EXPORT_SYMBOL_GPL(scsi_flush_work);