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/kthread.h>
28 #include <linux/string.h>
30 #include <linux/init.h>
31 #include <linux/completion.h>
32 #include <linux/transport_class.h>
33 #include <linux/platform_device.h>
35 #include <scsi/scsi_device.h>
36 #include <scsi/scsi_host.h>
37 #include <scsi/scsi_transport.h>
39 #include "scsi_priv.h"
40 #include "scsi_logging.h"
43 static int scsi_host_next_hn
; /* host_no for next new host */
46 static void scsi_host_cls_release(struct class_device
*class_dev
)
48 put_device(&class_to_shost(class_dev
)->shost_gendev
);
51 static struct class shost_class
= {
53 .release
= scsi_host_cls_release
,
57 * scsi_host_set_state - Take the given host through the host
59 * @shost: scsi host to change the state of.
60 * @state: state to change to.
62 * Returns zero if unsuccessful or an error if the requested
63 * transition is illegal.
65 int scsi_host_set_state(struct Scsi_Host
*shost
, enum scsi_host_state state
)
67 enum scsi_host_state oldstate
= shost
->shost_state
;
69 if (state
== oldstate
)
74 /* There are no legal states that come back to
75 * created. This is the manually initialised start
102 case SHOST_CANCEL_RECOVERY
:
112 case SHOST_DEL_RECOVERY
:
119 case SHOST_CANCEL_RECOVERY
:
129 case SHOST_DEL_RECOVERY
:
131 case SHOST_CANCEL_RECOVERY
:
138 shost
->shost_state
= state
;
142 SCSI_LOG_ERROR_RECOVERY(1,
143 shost_printk(KERN_ERR
, shost
,
144 "Illegal host state transition"
146 scsi_host_state_name(oldstate
),
147 scsi_host_state_name(state
)));
150 EXPORT_SYMBOL(scsi_host_set_state
);
153 * scsi_remove_host - remove a scsi host
154 * @shost: a pointer to a scsi host to remove
156 void scsi_remove_host(struct Scsi_Host
*shost
)
159 mutex_lock(&shost
->scan_mutex
);
160 spin_lock_irqsave(shost
->host_lock
, flags
);
161 if (scsi_host_set_state(shost
, SHOST_CANCEL
))
162 if (scsi_host_set_state(shost
, SHOST_CANCEL_RECOVERY
)) {
163 spin_unlock_irqrestore(shost
->host_lock
, flags
);
164 mutex_unlock(&shost
->scan_mutex
);
167 spin_unlock_irqrestore(shost
->host_lock
, flags
);
168 mutex_unlock(&shost
->scan_mutex
);
169 scsi_forget_host(shost
);
170 scsi_proc_host_rm(shost
);
172 spin_lock_irqsave(shost
->host_lock
, flags
);
173 if (scsi_host_set_state(shost
, SHOST_DEL
))
174 BUG_ON(scsi_host_set_state(shost
, SHOST_DEL_RECOVERY
));
175 spin_unlock_irqrestore(shost
->host_lock
, flags
);
177 transport_unregister_device(&shost
->shost_gendev
);
178 class_device_unregister(&shost
->shost_classdev
);
179 device_del(&shost
->shost_gendev
);
180 scsi_proc_hostdir_rm(shost
->hostt
);
182 EXPORT_SYMBOL(scsi_remove_host
);
185 * scsi_add_host - add a scsi host
186 * @shost: scsi host pointer to add
187 * @dev: a struct device of type scsi class
190 * 0 on success / != 0 for error
192 int scsi_add_host(struct Scsi_Host
*shost
, struct device
*dev
)
194 struct scsi_host_template
*sht
= shost
->hostt
;
197 printk(KERN_INFO
"scsi%d : %s\n", shost
->host_no
,
198 sht
->info
? sht
->info(shost
) : sht
->name
);
200 if (!shost
->can_queue
) {
201 printk(KERN_ERR
"%s: can_queue = 0 no longer supported\n",
206 if (!shost
->shost_gendev
.parent
)
207 shost
->shost_gendev
.parent
= dev
? dev
: &platform_bus
;
209 error
= device_add(&shost
->shost_gendev
);
213 scsi_host_set_state(shost
, SHOST_RUNNING
);
214 get_device(shost
->shost_gendev
.parent
);
216 error
= class_device_add(&shost
->shost_classdev
);
220 get_device(&shost
->shost_gendev
);
222 if (shost
->transportt
->host_size
&&
223 (shost
->shost_data
= kmalloc(shost
->transportt
->host_size
,
224 GFP_KERNEL
)) == NULL
)
225 goto out_del_classdev
;
227 if (shost
->transportt
->create_work_queue
) {
228 snprintf(shost
->work_q_name
, KOBJ_NAME_LEN
, "scsi_wq_%d",
230 shost
->work_q
= create_singlethread_workqueue(
233 goto out_free_shost_data
;
236 error
= scsi_sysfs_add_host(shost
);
238 goto out_destroy_host
;
240 scsi_proc_host_add(shost
);
245 destroy_workqueue(shost
->work_q
);
247 kfree(shost
->shost_data
);
249 class_device_del(&shost
->shost_classdev
);
251 device_del(&shost
->shost_gendev
);
255 EXPORT_SYMBOL(scsi_add_host
);
257 static void scsi_host_dev_release(struct device
*dev
)
259 struct Scsi_Host
*shost
= dev_to_shost(dev
);
260 struct device
*parent
= dev
->parent
;
263 kthread_stop(shost
->ehandler
);
265 destroy_workqueue(shost
->work_q
);
267 scsi_destroy_command_freelist(shost
);
269 blk_free_tags(shost
->bqt
);
271 kfree(shost
->shost_data
);
279 * scsi_host_alloc - register a scsi host adapter instance.
280 * @sht: pointer to scsi host template
281 * @privsize: extra bytes to allocate for driver
284 * Allocate a new Scsi_Host and perform basic initialization.
285 * The host is not published to the scsi midlayer until scsi_add_host
289 * Pointer to a new Scsi_Host
291 struct Scsi_Host
*scsi_host_alloc(struct scsi_host_template
*sht
, int privsize
)
293 struct Scsi_Host
*shost
;
294 gfp_t gfp_mask
= GFP_KERNEL
;
297 if (sht
->unchecked_isa_dma
&& privsize
)
298 gfp_mask
|= __GFP_DMA
;
300 shost
= kzalloc(sizeof(struct Scsi_Host
) + privsize
, gfp_mask
);
304 spin_lock_init(&shost
->default_lock
);
305 scsi_assign_lock(shost
, &shost
->default_lock
);
306 shost
->shost_state
= SHOST_CREATED
;
307 INIT_LIST_HEAD(&shost
->__devices
);
308 INIT_LIST_HEAD(&shost
->__targets
);
309 INIT_LIST_HEAD(&shost
->eh_cmd_q
);
310 INIT_LIST_HEAD(&shost
->starved_list
);
311 init_waitqueue_head(&shost
->host_wait
);
313 mutex_init(&shost
->scan_mutex
);
315 shost
->host_no
= scsi_host_next_hn
++; /* XXX(hch): still racy */
316 shost
->dma_channel
= 0xff;
318 /* These three are default values which can be overridden */
319 shost
->max_channel
= 0;
323 /* Give each shost a default transportt */
324 shost
->transportt
= &blank_transport_template
;
327 * All drivers right now should be able to handle 12 byte
328 * commands. Every so often there are requests for 16 byte
329 * commands, but individual low-level drivers need to certify that
330 * they actually do something sensible with such commands.
332 shost
->max_cmd_len
= 12;
334 shost
->this_id
= sht
->this_id
;
335 shost
->can_queue
= sht
->can_queue
;
336 shost
->sg_tablesize
= sht
->sg_tablesize
;
337 shost
->cmd_per_lun
= sht
->cmd_per_lun
;
338 shost
->unchecked_isa_dma
= sht
->unchecked_isa_dma
;
339 shost
->use_clustering
= sht
->use_clustering
;
340 shost
->ordered_tag
= sht
->ordered_tag
;
342 if (sht
->max_host_blocked
)
343 shost
->max_host_blocked
= sht
->max_host_blocked
;
345 shost
->max_host_blocked
= SCSI_DEFAULT_HOST_BLOCKED
;
348 * If the driver imposes no hard sector transfer limit, start at
349 * machine infinity initially.
351 if (sht
->max_sectors
)
352 shost
->max_sectors
= sht
->max_sectors
;
354 shost
->max_sectors
= SCSI_DEFAULT_MAX_SECTORS
;
357 * assume a 4GB boundary, if not set
359 if (sht
->dma_boundary
)
360 shost
->dma_boundary
= sht
->dma_boundary
;
362 shost
->dma_boundary
= 0xffffffff;
364 rval
= scsi_setup_command_freelist(shost
);
368 device_initialize(&shost
->shost_gendev
);
369 snprintf(shost
->shost_gendev
.bus_id
, BUS_ID_SIZE
, "host%d",
371 shost
->shost_gendev
.release
= scsi_host_dev_release
;
373 class_device_initialize(&shost
->shost_classdev
);
374 shost
->shost_classdev
.dev
= &shost
->shost_gendev
;
375 shost
->shost_classdev
.class = &shost_class
;
376 snprintf(shost
->shost_classdev
.class_id
, BUS_ID_SIZE
, "host%d",
379 shost
->ehandler
= kthread_run(scsi_error_handler
, shost
,
380 "scsi_eh_%d", shost
->host_no
);
381 if (IS_ERR(shost
->ehandler
)) {
382 rval
= PTR_ERR(shost
->ehandler
);
383 goto fail_destroy_freelist
;
386 scsi_proc_hostdir_add(shost
->hostt
);
389 fail_destroy_freelist
:
390 scsi_destroy_command_freelist(shost
);
395 EXPORT_SYMBOL(scsi_host_alloc
);
397 struct Scsi_Host
*scsi_register(struct scsi_host_template
*sht
, int privsize
)
399 struct Scsi_Host
*shost
= scsi_host_alloc(sht
, privsize
);
402 printk(KERN_WARNING
"scsi_register() called on new-style "
403 "template for driver %s\n", sht
->name
);
408 list_add_tail(&shost
->sht_legacy_list
, &sht
->legacy_hosts
);
411 EXPORT_SYMBOL(scsi_register
);
413 void scsi_unregister(struct Scsi_Host
*shost
)
415 list_del(&shost
->sht_legacy_list
);
416 scsi_host_put(shost
);
418 EXPORT_SYMBOL(scsi_unregister
);
421 * scsi_host_lookup - get a reference to a Scsi_Host by host no
423 * @hostnum: host number to locate
426 * A pointer to located Scsi_Host or NULL.
428 struct Scsi_Host
*scsi_host_lookup(unsigned short hostnum
)
430 struct class *class = &shost_class
;
431 struct class_device
*cdev
;
432 struct Scsi_Host
*shost
= ERR_PTR(-ENXIO
), *p
;
434 down_read(&class->subsys
.rwsem
);
435 list_for_each_entry(cdev
, &class->children
, node
) {
436 p
= class_to_shost(cdev
);
437 if (p
->host_no
== hostnum
) {
438 shost
= scsi_host_get(p
);
442 up_read(&class->subsys
.rwsem
);
446 EXPORT_SYMBOL(scsi_host_lookup
);
449 * scsi_host_get - inc a Scsi_Host ref count
450 * @shost: Pointer to Scsi_Host to inc.
452 struct Scsi_Host
*scsi_host_get(struct Scsi_Host
*shost
)
454 if ((shost
->shost_state
== SHOST_DEL
) ||
455 !get_device(&shost
->shost_gendev
))
459 EXPORT_SYMBOL(scsi_host_get
);
462 * scsi_host_put - dec a Scsi_Host ref count
463 * @shost: Pointer to Scsi_Host to dec.
465 void scsi_host_put(struct Scsi_Host
*shost
)
467 put_device(&shost
->shost_gendev
);
469 EXPORT_SYMBOL(scsi_host_put
);
471 int scsi_init_hosts(void)
473 return class_register(&shost_class
);
476 void scsi_exit_hosts(void)
478 class_unregister(&shost_class
);
481 int scsi_is_host_device(const struct device
*dev
)
483 return dev
->release
== scsi_host_dev_release
;
485 EXPORT_SYMBOL(scsi_is_host_device
);
488 * scsi_queue_work - Queue work to the Scsi_Host workqueue.
489 * @shost: Pointer to Scsi_Host.
490 * @work: Work to queue for execution.
493 * 1 - work queued for execution
494 * 0 - work is already queued
495 * -EINVAL - work queue doesn't exist
497 int scsi_queue_work(struct Scsi_Host
*shost
, struct work_struct
*work
)
499 if (unlikely(!shost
->work_q
)) {
501 "ERROR: Scsi host '%s' attempted to queue scsi-work, "
502 "when no workqueue created.\n", shost
->hostt
->name
);
508 return queue_work(shost
->work_q
, work
);
510 EXPORT_SYMBOL_GPL(scsi_queue_work
);
513 * scsi_flush_work - Flush a Scsi_Host's workqueue.
514 * @shost: Pointer to Scsi_Host.
516 void scsi_flush_work(struct Scsi_Host
*shost
)
518 if (!shost
->work_q
) {
520 "ERROR: Scsi host '%s' attempted to flush scsi-work, "
521 "when no workqueue created.\n", shost
->hostt
->name
);
526 flush_workqueue(shost
->work_q
);
528 EXPORT_SYMBOL_GPL(scsi_flush_work
);