drivers/scsi/hosts.c

   1 /*
   2  *  hosts.c Copyright (C) 1992 Drew Eckhardt
   3  *          Copyright (C) 1993, 1994, 1995 Eric Youngdale
   4  *          Copyright (C) 2002-2003 Christoph Hellwig
   5  *
   6  *  mid to lowlevel SCSI driver interface
   7  *      Initial versions: Drew Eckhardt
   8  *      Subsequent revisions: Eric Youngdale
   9  *
  10  *  <drew@colorado.edu>
  11  *
  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
  15  *
  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>
  19  *
  20  *  Restructured scsi_host lists and associated functions.
  21  *  September 04, 2002 Mike Anderson (andmike@us.ibm.com)
  22  */
  23
  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>
  29 #include <linux/mm.h>
  30 #include <linux/init.h>
  31 #include <linux/completion.h>
  32 #include <linux/transport_class.h>
  33 #include <linux/platform_device.h>
  34
  35 #include <scsi/scsi_device.h>
  36 #include <scsi/scsi_host.h>
  37 #include <scsi/scsi_transport.h>
  38
  39 #include "scsi_priv.h"
  40 #include "scsi_logging.h"
  41
  42
  43 static atomic_t scsi_host_next_hn;      /* host_no for next new host */
  44
  45
  46 static void scsi_host_cls_release(struct device *dev)
  47 {
  48         put_device(&class_to_shost(dev)->shost_gendev);
  49 }
  50
  51 static struct class shost_class = {
  52         .name           = "scsi_host",
  53         .dev_release    = scsi_host_cls_release,
  54 };
  55
  56 /**
  57  *      scsi_host_set_state - Take the given host through the host state model.
  58  *      @shost: scsi host to change the state of.
  59  *      @state: state to change to.
  60  *
  61  *      Returns zero if unsuccessful or an error if the requested
  62  *      transition is illegal.
  63  **/
  64 int scsi_host_set_state(struct Scsi_Host *shost, enum scsi_host_state state)
  65 {
  66         enum scsi_host_state oldstate = shost->shost_state;
  67
  68         if (state == oldstate)
  69                 return 0;
  70
  71         switch (state) {
  72         case SHOST_CREATED:
  73                 /* There are no legal states that come back to
  74                  * created.  This is the manually initialised start
  75                  * state */
  76                 goto illegal;
  77
  78         case SHOST_RUNNING:
  79                 switch (oldstate) {
  80                 case SHOST_CREATED:
  81                 case SHOST_RECOVERY:
  82                         break;
  83                 default:
  84                         goto illegal;
  85                 }
  86                 break;
  87
  88         case SHOST_RECOVERY:
  89                 switch (oldstate) {
  90                 case SHOST_RUNNING:
  91                         break;
  92                 default:
  93                         goto illegal;
  94                 }
  95                 break;
  96
  97         case SHOST_CANCEL:
  98                 switch (oldstate) {
  99                 case SHOST_CREATED:
 100                 case SHOST_RUNNING:
 101                 case SHOST_CANCEL_RECOVERY:
 102                         break;
 103                 default:
 104                         goto illegal;
 105                 }
 106                 break;
 107
 108         case SHOST_DEL:
 109                 switch (oldstate) {
 110                 case SHOST_CANCEL:
 111                 case SHOST_DEL_RECOVERY:
 112                         break;
 113                 default:
 114                         goto illegal;
 115                 }
 116                 break;
 117
 118         case SHOST_CANCEL_RECOVERY:
 119                 switch (oldstate) {
 120                 case SHOST_CANCEL:
 121                 case SHOST_RECOVERY:
 122                         break;
 123                 default:
 124                         goto illegal;
 125                 }
 126                 break;
 127
 128         case SHOST_DEL_RECOVERY:
 129                 switch (oldstate) {
 130                 case SHOST_CANCEL_RECOVERY:
 131                         break;
 132                 default:
 133                         goto illegal;
 134                 }
 135                 break;
 136         }
 137         shost->shost_state = state;
 138         return 0;
 139
 140  illegal:
 141         SCSI_LOG_ERROR_RECOVERY(1,
 142                                 shost_printk(KERN_ERR, shost,
 143                                              "Illegal host state transition"
 144                                              "%s->%s\n",
 145                                              scsi_host_state_name(oldstate),
 146                                              scsi_host_state_name(state)));
 147         return -EINVAL;
 148 }
 149 EXPORT_SYMBOL(scsi_host_set_state);
 150
 151 /**
 152  * scsi_remove_host - remove a scsi host
 153  * @shost:      a pointer to a scsi host to remove
 154  **/
 155 void scsi_remove_host(struct Scsi_Host *shost)
 156 {
 157         unsigned long flags;
 158         mutex_lock(&shost->scan_mutex);
 159         spin_lock_irqsave(shost->host_lock, flags);
 160         if (scsi_host_set_state(shost, SHOST_CANCEL))
 161                 if (scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY)) {
 162                         spin_unlock_irqrestore(shost->host_lock, flags);
 163                         mutex_unlock(&shost->scan_mutex);
 164                         return;
 165                 }
 166         spin_unlock_irqrestore(shost->host_lock, flags);
 167         scsi_forget_host(shost);
 168         mutex_unlock(&shost->scan_mutex);
 169         scsi_proc_host_rm(shost);
 170
 171         spin_lock_irqsave(shost->host_lock, flags);
 172         if (scsi_host_set_state(shost, SHOST_DEL))
 173                 BUG_ON(scsi_host_set_state(shost, SHOST_DEL_RECOVERY));
 174         spin_unlock_irqrestore(shost->host_lock, flags);
 175
 176         transport_unregister_device(&shost->shost_gendev);
 177         device_unregister(&shost->shost_dev);
 178         device_del(&shost->shost_gendev);
 179 }
 180 EXPORT_SYMBOL(scsi_remove_host);
 181
 182 /**
 183  * scsi_add_host_with_dma - add a scsi host with dma device
 184  * @shost:      scsi host pointer to add
 185  * @dev:        a struct device of type scsi class
 186  * @dma_dev:    dma device for the host
 187  *
 188  * Note: You rarely need to worry about this unless you're in a
 189  * virtualised host environments, so use the simpler scsi_add_host()
 190  * function instead.
 191  *
 192  * Return value:
 193  *      0 on success / != 0 for error
 194  **/
 195 int scsi_add_host_with_dma(struct Scsi_Host *shost, struct device *dev,
 196                            struct device *dma_dev)
 197 {
 198         struct scsi_host_template *sht = shost->hostt;
 199         int error = -EINVAL;
 200
 201         printk(KERN_INFO "scsi%d : %s\n", shost->host_no,
 202                         sht->info ? sht->info(shost) : sht->name);
 203
 204         if (!shost->can_queue) {
 205                 printk(KERN_ERR "%s: can_queue = 0 no longer supported\n",
 206                                 sht->name);
 207                 goto fail;
 208         }
 209
 210         error = scsi_setup_command_freelist(shost);
 211         if (error)
 212                 goto fail;
 213
 214         if (!shost->shost_gendev.parent)
 215                 shost->shost_gendev.parent = dev ? dev : &platform_bus;
 216         shost->dma_dev = dma_dev;
 217
 218         error = device_add(&shost->shost_gendev);
 219         if (error)
 220                 goto out;
 221
 222         scsi_host_set_state(shost, SHOST_RUNNING);
 223         get_device(shost->shost_gendev.parent);
 224
 225         error = device_add(&shost->shost_dev);
 226         if (error)
 227                 goto out_del_gendev;
 228
 229         get_device(&shost->shost_gendev);
 230
 231         if (shost->transportt->host_size) {
 232                 shost->shost_data = kzalloc(shost->transportt->host_size,
 233                                          GFP_KERNEL);
 234                 if (shost->shost_data == NULL) {
 235                         error = -ENOMEM;
 236                         goto out_del_dev;
 237                 }
 238         }
 239
 240         if (shost->transportt->create_work_queue) {
 241                 snprintf(shost->work_q_name, sizeof(shost->work_q_name),
 242                          "scsi_wq_%d", shost->host_no);
 243                 shost->work_q = create_singlethread_workqueue(
 244                                         shost->work_q_name);
 245                 if (!shost->work_q) {
 246                         error = -EINVAL;
 247                         goto out_free_shost_data;
 248                 }
 249         }
 250
 251         error = scsi_sysfs_add_host(shost);
 252         if (error)
 253                 goto out_destroy_host;
 254
 255         scsi_proc_host_add(shost);
 256         return error;
 257
 258  out_destroy_host:
 259         if (shost->work_q)
 260                 destroy_workqueue(shost->work_q);
 261  out_free_shost_data:
 262         kfree(shost->shost_data);
 263  out_del_dev:
 264         device_del(&shost->shost_dev);
 265  out_del_gendev:
 266         device_del(&shost->shost_gendev);
 267  out:
 268         scsi_destroy_command_freelist(shost);
 269  fail:
 270         return error;
 271 }
 272 EXPORT_SYMBOL(scsi_add_host_with_dma);
 273
 274 static void scsi_host_dev_release(struct device *dev)
 275 {
 276         struct Scsi_Host *shost = dev_to_shost(dev);
 277         struct device *parent = dev->parent;
 278         struct request_queue *q;
 279
 280         scsi_proc_hostdir_rm(shost->hostt);
 281
 282         if (shost->ehandler)
 283                 kthread_stop(shost->ehandler);
 284         if (shost->work_q)
 285                 destroy_workqueue(shost->work_q);
 286         q = shost->uspace_req_q;
 287         if (q) {
 288                 kfree(q->queuedata);
 289                 q->queuedata = NULL;
 290                 scsi_free_queue(q);
 291         }
 292
 293         scsi_destroy_command_freelist(shost);
 294         if (shost->bqt)
 295                 blk_free_tags(shost->bqt);
 296
 297         kfree(shost->shost_data);
 298
 299         if (parent)
 300                 put_device(parent);
 301         kfree(shost);
 302 }
 303
 304 static struct device_type scsi_host_type = {
 305         .name =         "scsi_host",
 306         .release =      scsi_host_dev_release,
 307 };
 308
 309 /**
 310  * scsi_host_alloc - register a scsi host adapter instance.
 311  * @sht:        pointer to scsi host template
 312  * @privsize:   extra bytes to allocate for driver
 313  *
 314  * Note:
 315  *      Allocate a new Scsi_Host and perform basic initialization.
 316  *      The host is not published to the scsi midlayer until scsi_add_host
 317  *      is called.
 318  *
 319  * Return value:
 320  *      Pointer to a new Scsi_Host
 321  **/
 322 struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *sht, int privsize)
 323 {
 324         struct Scsi_Host *shost;
 325         gfp_t gfp_mask = GFP_KERNEL;
 326         int rval;
 327
 328         if (sht->unchecked_isa_dma && privsize)
 329                 gfp_mask |= __GFP_DMA;
 330
 331         shost = kzalloc(sizeof(struct Scsi_Host) + privsize, gfp_mask);
 332         if (!shost)
 333                 return NULL;
 334
 335         shost->host_lock = &shost->default_lock;
 336         spin_lock_init(shost->host_lock);
 337         shost->shost_state = SHOST_CREATED;
 338         INIT_LIST_HEAD(&shost->__devices);
 339         INIT_LIST_HEAD(&shost->__targets);
 340         INIT_LIST_HEAD(&shost->eh_cmd_q);
 341         INIT_LIST_HEAD(&shost->starved_list);
 342         init_waitqueue_head(&shost->host_wait);
 343
 344         mutex_init(&shost->scan_mutex);
 345
 346         /*
 347          * subtract one because we increment first then return, but we need to
 348          * know what the next host number was before increment
 349          */
 350         shost->host_no = atomic_inc_return(&scsi_host_next_hn) - 1;
 351         shost->dma_channel = 0xff;
 352
 353         /* These three are default values which can be overridden */
 354         shost->max_channel = 0;
 355         shost->max_id = 8;
 356         shost->max_lun = 8;
 357
 358         /* Give each shost a default transportt */
 359         shost->transportt = &blank_transport_template;
 360
 361         /*
 362          * All drivers right now should be able to handle 12 byte
 363          * commands.  Every so often there are requests for 16 byte
 364          * commands, but individual low-level drivers need to certify that
 365          * they actually do something sensible with such commands.
 366          */
 367         shost->max_cmd_len = 12;
 368         shost->hostt = sht;
 369         shost->this_id = sht->this_id;
 370         shost->can_queue = sht->can_queue;
 371         shost->sg_tablesize = sht->sg_tablesize;
 372         shost->cmd_per_lun = sht->cmd_per_lun;
 373         shost->unchecked_isa_dma = sht->unchecked_isa_dma;
 374         shost->use_clustering = sht->use_clustering;
 375         shost->ordered_tag = sht->ordered_tag;
 376
 377         if (sht->supported_mode == MODE_UNKNOWN)
 378                 /* means we didn't set it ... default to INITIATOR */
 379                 shost->active_mode = MODE_INITIATOR;
 380         else
 381                 shost->active_mode = sht->supported_mode;
 382
 383         if (sht->max_host_blocked)
 384                 shost->max_host_blocked = sht->max_host_blocked;
 385         else
 386                 shost->max_host_blocked = SCSI_DEFAULT_HOST_BLOCKED;
 387
 388         /*
 389          * If the driver imposes no hard sector transfer limit, start at
 390          * machine infinity initially.
 391          */
 392         if (sht->max_sectors)
 393                 shost->max_sectors = sht->max_sectors;
 394         else
 395                 shost->max_sectors = SCSI_DEFAULT_MAX_SECTORS;
 396
 397         /*
 398          * assume a 4GB boundary, if not set
 399          */
 400         if (sht->dma_boundary)
 401                 shost->dma_boundary = sht->dma_boundary;
 402         else
 403                 shost->dma_boundary = 0xffffffff;
 404
 405         device_initialize(&shost->shost_gendev);
 406         dev_set_name(&shost->shost_gendev, "host%d", shost->host_no);
 407 #ifndef CONFIG_SYSFS_DEPRECATED
 408         shost->shost_gendev.bus = &scsi_bus_type;
 409 #endif
 410         shost->shost_gendev.type = &scsi_host_type;
 411
 412         device_initialize(&shost->shost_dev);
 413         shost->shost_dev.parent = &shost->shost_gendev;
 414         shost->shost_dev.class = &shost_class;
 415         dev_set_name(&shost->shost_dev, "host%d", shost->host_no);
 416         shost->shost_dev.groups = scsi_sysfs_shost_attr_groups;
 417
 418         shost->ehandler = kthread_run(scsi_error_handler, shost,
 419                         "scsi_eh_%d", shost->host_no);
 420         if (IS_ERR(shost->ehandler)) {
 421                 rval = PTR_ERR(shost->ehandler);
 422                 goto fail_kfree;
 423         }
 424
 425         scsi_proc_hostdir_add(shost->hostt);
 426         return shost;
 427
 428  fail_kfree:
 429         kfree(shost);
 430         return NULL;
 431 }
 432 EXPORT_SYMBOL(scsi_host_alloc);
 433
 434 struct Scsi_Host *scsi_register(struct scsi_host_template *sht, int privsize)
 435 {
 436         struct Scsi_Host *shost = scsi_host_alloc(sht, privsize);
 437
 438         if (!sht->detect) {
 439                 printk(KERN_WARNING "scsi_register() called on new-style "
 440                                     "template for driver %s\n", sht->name);
 441                 dump_stack();
 442         }
 443
 444         if (shost)
 445                 list_add_tail(&shost->sht_legacy_list, &sht->legacy_hosts);
 446         return shost;
 447 }
 448 EXPORT_SYMBOL(scsi_register);
 449
 450 void scsi_unregister(struct Scsi_Host *shost)
 451 {
 452         list_del(&shost->sht_legacy_list);
 453         scsi_host_put(shost);
 454 }
 455 EXPORT_SYMBOL(scsi_unregister);
 456
 457 static int __scsi_host_match(struct device *dev, void *data)
 458 {
 459         struct Scsi_Host *p;
 460         unsigned short *hostnum = (unsigned short *)data;
 461
 462         p = class_to_shost(dev);
 463         return p->host_no == *hostnum;
 464 }
 465
 466 /**
 467  * scsi_host_lookup - get a reference to a Scsi_Host by host no
 468  * @hostnum:    host number to locate
 469  *
 470  * Return value:
 471  *      A pointer to located Scsi_Host or NULL.
 472  *
 473  *      The caller must do a scsi_host_put() to drop the reference
 474  *      that scsi_host_get() took. The put_device() below dropped
 475  *      the reference from class_find_device().
 476  **/
 477 struct Scsi_Host *scsi_host_lookup(unsigned short hostnum)
 478 {
 479         struct device *cdev;
 480         struct Scsi_Host *shost = NULL;
 481
 482         cdev = class_find_device(&shost_class, NULL, &hostnum,
 483                                  __scsi_host_match);
 484         if (cdev) {
 485                 shost = scsi_host_get(class_to_shost(cdev));
 486                 put_device(cdev);
 487         }
 488         return shost;
 489 }
 490 EXPORT_SYMBOL(scsi_host_lookup);
 491
 492 /**
 493  * scsi_host_get - inc a Scsi_Host ref count
 494  * @shost:      Pointer to Scsi_Host to inc.
 495  **/
 496 struct Scsi_Host *scsi_host_get(struct Scsi_Host *shost)
 497 {
 498         if ((shost->shost_state == SHOST_DEL) ||
 499                 !get_device(&shost->shost_gendev))
 500                 return NULL;
 501         return shost;
 502 }
 503 EXPORT_SYMBOL(scsi_host_get);
 504
 505 /**
 506  * scsi_host_put - dec a Scsi_Host ref count
 507  * @shost:      Pointer to Scsi_Host to dec.
 508  **/
 509 void scsi_host_put(struct Scsi_Host *shost)
 510 {
 511         put_device(&shost->shost_gendev);
 512 }
 513 EXPORT_SYMBOL(scsi_host_put);
 514
 515 int scsi_init_hosts(void)
 516 {
 517         return class_register(&shost_class);
 518 }
 519
 520 void scsi_exit_hosts(void)
 521 {
 522         class_unregister(&shost_class);
 523 }
 524
 525 int scsi_is_host_device(const struct device *dev)
 526 {
 527         return dev->type == &scsi_host_type;
 528 }
 529 EXPORT_SYMBOL(scsi_is_host_device);
 530
 531 /**
 532  * scsi_queue_work - Queue work to the Scsi_Host workqueue.
 533  * @shost:      Pointer to Scsi_Host.
 534  * @work:       Work to queue for execution.
 535  *
 536  * Return value:
 537  *      1 - work queued for execution
 538  *      0 - work is already queued
 539  *      -EINVAL - work queue doesn't exist
 540  **/
 541 int scsi_queue_work(struct Scsi_Host *shost, struct work_struct *work)
 542 {
 543         if (unlikely(!shost->work_q)) {
 544                 printk(KERN_ERR
 545                         "ERROR: Scsi host '%s' attempted to queue scsi-work, "
 546                         "when no workqueue created.\n", shost->hostt->name);
 547                 dump_stack();
 548
 549                 return -EINVAL;
 550         }
 551
 552         return queue_work(shost->work_q, work);
 553 }
 554 EXPORT_SYMBOL_GPL(scsi_queue_work);
 555
 556 /**
 557  * scsi_flush_work - Flush a Scsi_Host's workqueue.
 558  * @shost:      Pointer to Scsi_Host.
 559  **/
 560 void scsi_flush_work(struct Scsi_Host *shost)
 561 {
 562         if (!shost->work_q) {
 563                 printk(KERN_ERR
 564                         "ERROR: Scsi host '%s' attempted to flush scsi-work, "
 565                         "when no workqueue created.\n", shost->hostt->name);
 566                 dump_stack();
 567                 return;
 568         }
 569
 570         flush_workqueue(shost->work_q);
 571 }
 572 EXPORT_SYMBOL_GPL(scsi_flush_work);