include/scsi/scsi_host.h

   1 #ifndef _SCSI_SCSI_HOST_H
   2 #define _SCSI_SCSI_HOST_H
   3
   4 #include <linux/device.h>
   5 #include <linux/list.h>
   6 #include <linux/types.h>
   7 #include <linux/workqueue.h>
   8 #include <linux/mutex.h>
   9 #include <linux/seq_file.h>
  10 #include <linux/blk-mq.h>
  11 #include <scsi/scsi.h>
  12
  13 struct request_queue;
  14 struct block_device;
  15 struct completion;
  16 struct module;
  17 struct scsi_cmnd;
  18 struct scsi_device;
  19 struct scsi_host_cmd_pool;
  20 struct scsi_target;
  21 struct Scsi_Host;
  22 struct scsi_host_cmd_pool;
  23 struct scsi_transport_template;
  24 struct blk_queue_tags;
  25
  26
  27 /*
  28  * The various choices mean:
  29  * NONE: Self evident.  Host adapter is not capable of scatter-gather.
  30  * ALL:  Means that the host adapter module can do scatter-gather,
  31  *       and that there is no limit to the size of the table to which
  32  *       we scatter/gather data.  The value we set here is the maximum
  33  *       single element sglist.  To use chained sglists, the adapter
  34  *       has to set a value beyond ALL (and correctly use the chain
  35  *       handling API.
  36  * Anything else:  Indicates the maximum number of chains that can be
  37  *       used in one scatter-gather request.
  38  */
  39 #define SG_NONE 0
  40 #define SG_ALL  SG_CHUNK_SIZE
  41
  42 #define MODE_UNKNOWN 0x00
  43 #define MODE_INITIATOR 0x01
  44 #define MODE_TARGET 0x02
  45
  46 #define DISABLE_CLUSTERING 0
  47 #define ENABLE_CLUSTERING 1
  48
  49 struct scsi_host_template {
  50         struct module *module;
  51         const char *name;
  52
  53         /*
  54          * Used to initialize old-style drivers.  For new-style drivers
  55          * just perform all work in your module initialization function.
  56          *
  57          * Status:  OBSOLETE
  58          */
  59         int (* detect)(struct scsi_host_template *);
  60
  61         /*
  62          * Used as unload callback for hosts with old-style drivers.
  63          *
  64          * Status: OBSOLETE
  65          */
  66         int (* release)(struct Scsi_Host *);
  67
  68         /*
  69          * The info function will return whatever useful information the
  70          * developer sees fit.  If not provided, then the name field will
  71          * be used instead.
  72          *
  73          * Status: OPTIONAL
  74          */
  75         const char *(* info)(struct Scsi_Host *);
  76
  77         /*
  78          * Ioctl interface
  79          *
  80          * Status: OPTIONAL
  81          */
  82         int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
  83
  84
  85 #ifdef CONFIG_COMPAT
  86         /*
  87          * Compat handler. Handle 32bit ABI.
  88          * When unknown ioctl is passed return -ENOIOCTLCMD.
  89          *
  90          * Status: OPTIONAL
  91          */
  92         int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
  93 #endif
  94
  95         /*
  96          * The queuecommand function is used to queue up a scsi
  97          * command block to the LLDD.  When the driver finished
  98          * processing the command the done callback is invoked.
  99          *
 100          * If queuecommand returns 0, then the HBA has accepted the
 101          * command.  The done() function must be called on the command
 102          * when the driver has finished with it. (you may call done on the
 103          * command before queuecommand returns, but in this case you
 104          * *must* return 0 from queuecommand).
 105          *
 106          * Queuecommand may also reject the command, in which case it may
 107          * not touch the command and must not call done() for it.
 108          *
 109          * There are two possible rejection returns:
 110          *
 111          *   SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
 112          *   allow commands to other devices serviced by this host.
 113          *
 114          *   SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
 115          *   host temporarily.
 116          *
 117          * For compatibility, any other non-zero return is treated the
 118          * same as SCSI_MLQUEUE_HOST_BUSY.
 119          *
 120          * NOTE: "temporarily" means either until the next command for#
 121          * this device/host completes, or a period of time determined by
 122          * I/O pressure in the system if there are no other outstanding
 123          * commands.
 124          *
 125          * STATUS: REQUIRED
 126          */
 127         int (* queuecommand)(struct Scsi_Host *, struct scsi_cmnd *);
 128
 129         /*
 130          * This is an error handling strategy routine.  You don't need to
 131          * define one of these if you don't want to - there is a default
 132          * routine that is present that should work in most cases.  For those
 133          * driver authors that have the inclination and ability to write their
 134          * own strategy routine, this is where it is specified.  Note - the
 135          * strategy routine is *ALWAYS* run in the context of the kernel eh
 136          * thread.  Thus you are guaranteed to *NOT* be in an interrupt
 137          * handler when you execute this, and you are also guaranteed to
 138          * *NOT* have any other commands being queued while you are in the
 139          * strategy routine. When you return from this function, operations
 140          * return to normal.
 141          *
 142          * See scsi_error.c scsi_unjam_host for additional comments about
 143          * what this function should and should not be attempting to do.
 144          *
 145          * Status: REQUIRED     (at least one of them)
 146          */
 147         int (* eh_abort_handler)(struct scsi_cmnd *);
 148         int (* eh_device_reset_handler)(struct scsi_cmnd *);
 149         int (* eh_target_reset_handler)(struct scsi_cmnd *);
 150         int (* eh_bus_reset_handler)(struct scsi_cmnd *);
 151         int (* eh_host_reset_handler)(struct scsi_cmnd *);
 152
 153         /*
 154          * Before the mid layer attempts to scan for a new device where none
 155          * currently exists, it will call this entry in your driver.  Should
 156          * your driver need to allocate any structs or perform any other init
 157          * items in order to send commands to a currently unused target/lun
 158          * combo, then this is where you can perform those allocations.  This
 159          * is specifically so that drivers won't have to perform any kind of
 160          * "is this a new device" checks in their queuecommand routine,
 161          * thereby making the hot path a bit quicker.
 162          *
 163          * Return values: 0 on success, non-0 on failure
 164          *
 165          * Deallocation:  If we didn't find any devices at this ID, you will
 166          * get an immediate call to slave_destroy().  If we find something
 167          * here then you will get a call to slave_configure(), then the
 168          * device will be used for however long it is kept around, then when
 169          * the device is removed from the system (or * possibly at reboot
 170          * time), you will then get a call to slave_destroy().  This is
 171          * assuming you implement slave_configure and slave_destroy.
 172          * However, if you allocate memory and hang it off the device struct,
 173          * then you must implement the slave_destroy() routine at a minimum
 174          * in order to avoid leaking memory
 175          * each time a device is tore down.
 176          *
 177          * Status: OPTIONAL
 178          */
 179         int (* slave_alloc)(struct scsi_device *);
 180
 181         /*
 182          * Once the device has responded to an INQUIRY and we know the
 183          * device is online, we call into the low level driver with the
 184          * struct scsi_device *.  If the low level device driver implements
 185          * this function, it *must* perform the task of setting the queue
 186          * depth on the device.  All other tasks are optional and depend
 187          * on what the driver supports and various implementation details.
 188          *
 189          * Things currently recommended to be handled at this time include:
 190          *
 191          * 1.  Setting the device queue depth.  Proper setting of this is
 192          *     described in the comments for scsi_change_queue_depth.
 193          * 2.  Determining if the device supports the various synchronous
 194          *     negotiation protocols.  The device struct will already have
 195          *     responded to INQUIRY and the results of the standard items
 196          *     will have been shoved into the various device flag bits, eg.
 197          *     device->sdtr will be true if the device supports SDTR messages.
 198          * 3.  Allocating command structs that the device will need.
 199          * 4.  Setting the default timeout on this device (if needed).
 200          * 5.  Anything else the low level driver might want to do on a device
 201          *     specific setup basis...
 202          * 6.  Return 0 on success, non-0 on error.  The device will be marked
 203          *     as offline on error so that no access will occur.  If you return
 204          *     non-0, your slave_destroy routine will never get called for this
 205          *     device, so don't leave any loose memory hanging around, clean
 206          *     up after yourself before returning non-0
 207          *
 208          * Status: OPTIONAL
 209          */
 210         int (* slave_configure)(struct scsi_device *);
 211
 212         /*
 213          * Immediately prior to deallocating the device and after all activity
 214          * has ceased the mid layer calls this point so that the low level
 215          * driver may completely detach itself from the scsi device and vice
 216          * versa.  The low level driver is responsible for freeing any memory
 217          * it allocated in the slave_alloc or slave_configure calls.
 218          *
 219          * Status: OPTIONAL
 220          */
 221         void (* slave_destroy)(struct scsi_device *);
 222
 223         /*
 224          * Before the mid layer attempts to scan for a new device attached
 225          * to a target where no target currently exists, it will call this
 226          * entry in your driver.  Should your driver need to allocate any
 227          * structs or perform any other init items in order to send commands
 228          * to a currently unused target, then this is where you can perform
 229          * those allocations.
 230          *
 231          * Return values: 0 on success, non-0 on failure
 232          *
 233          * Status: OPTIONAL
 234          */
 235         int (* target_alloc)(struct scsi_target *);
 236
 237         /*
 238          * Immediately prior to deallocating the target structure, and
 239          * after all activity to attached scsi devices has ceased, the
 240          * midlayer calls this point so that the driver may deallocate
 241          * and terminate any references to the target.
 242          *
 243          * Status: OPTIONAL
 244          */
 245         void (* target_destroy)(struct scsi_target *);
 246
 247         /*
 248          * If a host has the ability to discover targets on its own instead
 249          * of scanning the entire bus, it can fill in this function and
 250          * call scsi_scan_host().  This function will be called periodically
 251          * until it returns 1 with the scsi_host and the elapsed time of
 252          * the scan in jiffies.
 253          *
 254          * Status: OPTIONAL
 255          */
 256         int (* scan_finished)(struct Scsi_Host *, unsigned long);
 257
 258         /*
 259          * If the host wants to be called before the scan starts, but
 260          * after the midlayer has set up ready for the scan, it can fill
 261          * in this function.
 262          *
 263          * Status: OPTIONAL
 264          */
 265         void (* scan_start)(struct Scsi_Host *);
 266
 267         /*
 268          * Fill in this function to allow the queue depth of this host
 269          * to be changeable (on a per device basis).  Returns either
 270          * the current queue depth setting (may be different from what
 271          * was passed in) or an error.  An error should only be
 272          * returned if the requested depth is legal but the driver was
 273          * unable to set it.  If the requested depth is illegal, the
 274          * driver should set and return the closest legal queue depth.
 275          *
 276          * Status: OPTIONAL
 277          */
 278         int (* change_queue_depth)(struct scsi_device *, int);
 279
 280         /*
 281          * This function determines the BIOS parameters for a given
 282          * harddisk.  These tend to be numbers that are made up by
 283          * the host adapter.  Parameters:
 284          * size, device, list (heads, sectors, cylinders)
 285          *
 286          * Status: OPTIONAL
 287          */
 288         int (* bios_param)(struct scsi_device *, struct block_device *,
 289                         sector_t, int []);
 290
 291         /*
 292          * This function is called when one or more partitions on the
 293          * device reach beyond the end of the device.
 294          *
 295          * Status: OPTIONAL
 296          */
 297         void (*unlock_native_capacity)(struct scsi_device *);
 298
 299         /*
 300          * Can be used to export driver statistics and other infos to the
 301          * world outside the kernel ie. userspace and it also provides an
 302          * interface to feed the driver with information.
 303          *
 304          * Status: OBSOLETE
 305          */
 306         int (*show_info)(struct seq_file *, struct Scsi_Host *);
 307         int (*write_info)(struct Scsi_Host *, char *, int);
 308
 309         /*
 310          * This is an optional routine that allows the transport to become
 311          * involved when a scsi io timer fires. The return value tells the
 312          * timer routine how to finish the io timeout handling:
 313          * EH_HANDLED:          I fixed the error, please complete the command
 314          * EH_RESET_TIMER:      I need more time, reset the timer and
 315          *                      begin counting again
 316          * EH_NOT_HANDLED       Begin normal error recovery
 317          *
 318          * Status: OPTIONAL
 319          */
 320         enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
 321
 322         /* This is an optional routine that allows transport to initiate
 323          * LLD adapter or firmware reset using sysfs attribute.
 324          *
 325          * Return values: 0 on success, -ve value on failure.
 326          *
 327          * Status: OPTIONAL
 328          */
 329
 330         int (*host_reset)(struct Scsi_Host *shost, int reset_type);
 331 #define SCSI_ADAPTER_RESET      1
 332 #define SCSI_FIRMWARE_RESET     2
 333
 334
 335         /*
 336          * Name of proc directory
 337          */
 338         const char *proc_name;
 339
 340         /*
 341          * Used to store the procfs directory if a driver implements the
 342          * show_info method.
 343          */
 344         struct proc_dir_entry *proc_dir;
 345
 346         /*
 347          * This determines if we will use a non-interrupt driven
 348          * or an interrupt driven scheme.  It is set to the maximum number
 349          * of simultaneous commands a given host adapter will accept.
 350          */
 351         int can_queue;
 352
 353         /*
 354          * In many instances, especially where disconnect / reconnect are
 355          * supported, our host also has an ID on the SCSI bus.  If this is
 356          * the case, then it must be reserved.  Please set this_id to -1 if
 357          * your setup is in single initiator mode, and the host lacks an
 358          * ID.
 359          */
 360         int this_id;
 361
 362         /*
 363          * This determines the degree to which the host adapter is capable
 364          * of scatter-gather.
 365          */
 366         unsigned short sg_tablesize;
 367         unsigned short sg_prot_tablesize;
 368
 369         /*
 370          * Set this if the host adapter has limitations beside segment count.
 371          */
 372         unsigned int max_sectors;
 373
 374         /*
 375          * DMA scatter gather segment boundary limit. A segment crossing this
 376          * boundary will be split in two.
 377          */
 378         unsigned long dma_boundary;
 379
 380         /*
 381          * This specifies "machine infinity" for host templates which don't
 382          * limit the transfer size.  Note this limit represents an absolute
 383          * maximum, and may be over the transfer limits allowed for
 384          * individual devices (e.g. 256 for SCSI-1).
 385          */
 386 #define SCSI_DEFAULT_MAX_SECTORS        1024
 387
 388         /*
 389          * True if this host adapter can make good use of linked commands.
 390          * This will allow more than one command to be queued to a given
 391          * unit on a given host.  Set this to the maximum number of command
 392          * blocks to be provided for each device.  Set this to 1 for one
 393          * command block per lun, 2 for two, etc.  Do not set this to 0.
 394          * You should make sure that the host adapter will do the right thing
 395          * before you try setting this above 1.
 396          */
 397         short cmd_per_lun;
 398
 399         /*
 400          * present contains counter indicating how many boards of this
 401          * type were found when we did the scan.
 402          */
 403         unsigned char present;
 404
 405         /* If use block layer to manage tags, this is tag allocation policy */
 406         int tag_alloc_policy;
 407
 408         /*
 409          * Track QUEUE_FULL events and reduce queue depth on demand.
 410          */
 411         unsigned track_queue_depth:1;
 412
 413         /*
 414          * This specifies the mode that a LLD supports.
 415          */
 416         unsigned supported_mode:2;
 417
 418         /*
 419          * True if this host adapter uses unchecked DMA onto an ISA bus.
 420          */
 421         unsigned unchecked_isa_dma:1;
 422
 423         /*
 424          * True if this host adapter can make good use of clustering.
 425          * I originally thought that if the tablesize was large that it
 426          * was a waste of CPU cycles to prepare a cluster list, but
 427          * it works out that the Buslogic is faster if you use a smaller
 428          * number of segments (i.e. use clustering).  I guess it is
 429          * inefficient.
 430          */
 431         unsigned use_clustering:1;
 432
 433         /*
 434          * True for emulated SCSI host adapters (e.g. ATAPI).
 435          */
 436         unsigned emulated:1;
 437
 438         /*
 439          * True if the low-level driver performs its own reset-settle delays.
 440          */
 441         unsigned skip_settle_delay:1;
 442
 443         /* True if the controller does not support WRITE SAME */
 444         unsigned no_write_same:1;
 445
 446         /*
 447          * True if asynchronous aborts are not supported
 448          */
 449         unsigned no_async_abort:1;
 450
 451         /*
 452          * Countdown for host blocking with no commands outstanding.
 453          */
 454         unsigned int max_host_blocked;
 455
 456         /*
 457          * Default value for the blocking.  If the queue is empty,
 458          * host_blocked counts down in the request_fn until it restarts
 459          * host operations as zero is reached.
 460          *
 461          * FIXME: This should probably be a value in the template
 462          */
 463 #define SCSI_DEFAULT_HOST_BLOCKED       7
 464
 465         /*
 466          * Pointer to the sysfs class properties for this host, NULL terminated.
 467          */
 468         struct device_attribute **shost_attrs;
 469
 470         /*
 471          * Pointer to the SCSI device properties for this host, NULL terminated.
 472          */
 473         struct device_attribute **sdev_attrs;
 474
 475         /*
 476          * List of hosts per template.
 477          *
 478          * This is only for use by scsi_module.c for legacy templates.
 479          * For these access to it is synchronized implicitly by
 480          * module_init/module_exit.
 481          */
 482         struct list_head legacy_hosts;
 483
 484         /*
 485          * Vendor Identifier associated with the host
 486          *
 487          * Note: When specifying vendor_id, be sure to read the
 488          *   Vendor Type and ID formatting requirements specified in
 489          *   scsi_netlink.h
 490          */
 491         u64 vendor_id;
 492
 493         /*
 494          * Additional per-command data allocated for the driver.
 495          */
 496         unsigned int cmd_size;
 497         struct scsi_host_cmd_pool *cmd_pool;
 498 };
 499
 500 /*
 501  * Temporary #define for host lock push down. Can be removed when all
 502  * drivers have been updated to take advantage of unlocked
 503  * queuecommand.
 504  *
 505  */
 506 #define DEF_SCSI_QCMD(func_name) \
 507         int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd)   \
 508         {                                                               \
 509                 unsigned long irq_flags;                                \
 510                 int rc;                                                 \
 511                 spin_lock_irqsave(shost->host_lock, irq_flags);         \
 512                 scsi_cmd_get_serial(shost, cmd);                        \
 513                 rc = func_name##_lck (cmd, cmd->scsi_done);                     \
 514                 spin_unlock_irqrestore(shost->host_lock, irq_flags);    \
 515                 return rc;                                              \
 516         }
 517
 518
 519 /*
 520  * shost state: If you alter this, you also need to alter scsi_sysfs.c
 521  * (for the ascii descriptions) and the state model enforcer:
 522  * scsi_host_set_state()
 523  */
 524 enum scsi_host_state {
 525         SHOST_CREATED = 1,
 526         SHOST_RUNNING,
 527         SHOST_CANCEL,
 528         SHOST_DEL,
 529         SHOST_RECOVERY,
 530         SHOST_CANCEL_RECOVERY,
 531         SHOST_DEL_RECOVERY,
 532 };
 533
 534 struct Scsi_Host {
 535         /*
 536          * __devices is protected by the host_lock, but you should
 537          * usually use scsi_device_lookup / shost_for_each_device
 538          * to access it and don't care about locking yourself.
 539          * In the rare case of being in irq context you can use
 540          * their __ prefixed variants with the lock held. NEVER
 541          * access this list directly from a driver.
 542          */
 543         struct list_head        __devices;
 544         struct list_head        __targets;
 545
 546         struct scsi_host_cmd_pool *cmd_pool;
 547         spinlock_t              free_list_lock;
 548         struct list_head        free_list; /* backup store of cmd structs */
 549         struct list_head        starved_list;
 550
 551         spinlock_t              default_lock;
 552         spinlock_t              *host_lock;
 553
 554         struct mutex            scan_mutex;/* serialize scanning activity */
 555
 556         struct list_head        eh_cmd_q;
 557         struct task_struct    * ehandler;  /* Error recovery thread. */
 558         struct completion     * eh_action; /* Wait for specific actions on the
 559                                               host. */
 560         wait_queue_head_t       host_wait;
 561         struct scsi_host_template *hostt;
 562         struct scsi_transport_template *transportt;
 563
 564         /*
 565          * Area to keep a shared tag map (if needed, will be
 566          * NULL if not).
 567          */
 568         union {
 569                 struct blk_queue_tag    *bqt;
 570                 struct blk_mq_tag_set   tag_set;
 571         };
 572
 573         atomic_t host_busy;                /* commands actually active on low-level */
 574         atomic_t host_blocked;
 575
 576         unsigned int host_failed;          /* commands that failed.
 577                                               protected by host_lock */
 578         unsigned int host_eh_scheduled;    /* EH scheduled without command */
 579
 580         unsigned int host_no;  /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
 581
 582         /* next two fields are used to bound the time spent in error handling */
 583         int eh_deadline;
 584         unsigned long last_reset;
 585
 586
 587         /*
 588          * These three parameters can be used to allow for wide scsi,
 589          * and for host adapters that support multiple busses
 590          * The last two should be set to 1 more than the actual max id
 591          * or lun (e.g. 8 for SCSI parallel systems).
 592          */
 593         unsigned int max_channel;
 594         unsigned int max_id;
 595         u64 max_lun;
 596
 597         /*
 598          * This is a unique identifier that must be assigned so that we
 599          * have some way of identifying each detected host adapter properly
 600          * and uniquely.  For hosts that do not support more than one card
 601          * in the system at one time, this does not need to be set.  It is
 602          * initialized to 0 in scsi_register.
 603          */
 604         unsigned int unique_id;
 605
 606         /*
 607          * The maximum length of SCSI commands that this host can accept.
 608          * Probably 12 for most host adapters, but could be 16 for others.
 609          * or 260 if the driver supports variable length cdbs.
 610          * For drivers that don't set this field, a value of 12 is
 611          * assumed.
 612          */
 613         unsigned short max_cmd_len;
 614
 615         int this_id;
 616         int can_queue;
 617         short cmd_per_lun;
 618         short unsigned int sg_tablesize;
 619         short unsigned int sg_prot_tablesize;
 620         unsigned int max_sectors;
 621         unsigned long dma_boundary;
 622         /*
 623          * In scsi-mq mode, the number of hardware queues supported by the LLD.
 624          *
 625          * Note: it is assumed that each hardware queue has a queue depth of
 626          * can_queue. In other words, the total queue depth per host
 627          * is nr_hw_queues * can_queue.
 628          */
 629         unsigned nr_hw_queues;
 630         /*
 631          * Used to assign serial numbers to the cmds.
 632          * Protected by the host lock.
 633          */
 634         unsigned long cmd_serial_number;
 635
 636         unsigned active_mode:2;
 637         unsigned unchecked_isa_dma:1;
 638         unsigned use_clustering:1;
 639
 640         /*
 641          * Host has requested that no further requests come through for the
 642          * time being.
 643          */
 644         unsigned host_self_blocked:1;
 645
 646         /*
 647          * Host uses correct SCSI ordering not PC ordering. The bit is
 648          * set for the minority of drivers whose authors actually read
 649          * the spec ;).
 650          */
 651         unsigned reverse_ordering:1;
 652
 653         /* Task mgmt function in progress */
 654         unsigned tmf_in_progress:1;
 655
 656         /* Asynchronous scan in progress */
 657         unsigned async_scan:1;
 658
 659         /* Don't resume host in EH */
 660         unsigned eh_noresume:1;
 661
 662         /* The controller does not support WRITE SAME */
 663         unsigned no_write_same:1;
 664
 665         unsigned use_blk_mq:1;
 666         unsigned use_cmd_list:1;
 667
 668         /* Host responded with short (<36 bytes) INQUIRY result */
 669         unsigned short_inquiry:1;
 670
 671         /*
 672          * Optional work queue to be utilized by the transport
 673          */
 674         char work_q_name[20];
 675         struct workqueue_struct *work_q;
 676
 677         /*
 678          * Task management function work queue
 679          */
 680         struct workqueue_struct *tmf_work_q;
 681
 682         /* The transport requires the LUN bits NOT to be stored in CDB[1] */
 683         unsigned no_scsi2_lun_in_cdb:1;
 684
 685         /*
 686          * Value host_blocked counts down from
 687          */
 688         unsigned int max_host_blocked;
 689
 690         /* Protection Information */
 691         unsigned int prot_capabilities;
 692         unsigned char prot_guard_type;
 693
 694         /*
 695          * q used for scsi_tgt msgs, async events or any other requests that
 696          * need to be processed in userspace
 697          */
 698         struct request_queue *uspace_req_q;
 699
 700         /* legacy crap */
 701         unsigned long base;
 702         unsigned long io_port;
 703         unsigned char n_io_port;
 704         unsigned char dma_channel;
 705         unsigned int  irq;
 706
 707
 708         enum scsi_host_state shost_state;
 709
 710         /* ldm bits */
 711         struct device           shost_gendev, shost_dev;
 712
 713         /*
 714          * List of hosts per template.
 715          *
 716          * This is only for use by scsi_module.c for legacy templates.
 717          * For these access to it is synchronized implicitly by
 718          * module_init/module_exit.
 719          */
 720         struct list_head sht_legacy_list;
 721
 722         /*
 723          * Points to the transport data (if any) which is allocated
 724          * separately
 725          */
 726         void *shost_data;
 727
 728         /*
 729          * Points to the physical bus device we'd use to do DMA
 730          * Needed just in case we have virtual hosts.
 731          */
 732         struct device *dma_dev;
 733
 734         /*
 735          * We should ensure that this is aligned, both for better performance
 736          * and also because some compilers (m68k) don't automatically force
 737          * alignment to a long boundary.
 738          */
 739         unsigned long hostdata[0]  /* Used for storage of host specific stuff */
 740                 __attribute__ ((aligned (sizeof(unsigned long))));
 741 };
 742
 743 #define         class_to_shost(d)       \
 744         container_of(d, struct Scsi_Host, shost_dev)
 745
 746 #define shost_printk(prefix, shost, fmt, a...)  \
 747         dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)
 748
 749 static inline void *shost_priv(struct Scsi_Host *shost)
 750 {
 751         return (void *)shost->hostdata;
 752 }
 753
 754 int scsi_is_host_device(const struct device *);
 755
 756 static inline struct Scsi_Host *dev_to_shost(struct device *dev)
 757 {
 758         while (!scsi_is_host_device(dev)) {
 759                 if (!dev->parent)
 760                         return NULL;
 761                 dev = dev->parent;
 762         }
 763         return container_of(dev, struct Scsi_Host, shost_gendev);
 764 }
 765
 766 static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
 767 {
 768         return shost->shost_state == SHOST_RECOVERY ||
 769                 shost->shost_state == SHOST_CANCEL_RECOVERY ||
 770                 shost->shost_state == SHOST_DEL_RECOVERY ||
 771                 shost->tmf_in_progress;
 772 }
 773
 774 extern bool scsi_use_blk_mq;
 775
 776 static inline bool shost_use_blk_mq(struct Scsi_Host *shost)
 777 {
 778         return scsi_use_blk_mq;
 779
 780 }
 781
 782 extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
 783 extern void scsi_flush_work(struct Scsi_Host *);
 784
 785 extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
 786 extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *,
 787                                                struct device *,
 788                                                struct device *);
 789 extern void scsi_scan_host(struct Scsi_Host *);
 790 extern void scsi_rescan_device(struct device *);
 791 extern void scsi_remove_host(struct Scsi_Host *);
 792 extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
 793 extern void scsi_host_put(struct Scsi_Host *t);
 794 extern struct Scsi_Host *scsi_host_lookup(unsigned short);
 795 extern const char *scsi_host_state_name(enum scsi_host_state);
 796 extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *);
 797
 798 static inline int __must_check scsi_add_host(struct Scsi_Host *host,
 799                                              struct device *dev)
 800 {
 801         return scsi_add_host_with_dma(host, dev, dev);
 802 }
 803
 804 static inline struct device *scsi_get_device(struct Scsi_Host *shost)
 805 {
 806         return shost->shost_gendev.parent;
 807 }
 808
 809 /**
 810  * scsi_host_scan_allowed - Is scanning of this host allowed
 811  * @shost:      Pointer to Scsi_Host.
 812  **/
 813 static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
 814 {
 815         return shost->shost_state == SHOST_RUNNING ||
 816                shost->shost_state == SHOST_RECOVERY;
 817 }
 818
 819 extern void scsi_unblock_requests(struct Scsi_Host *);
 820 extern void scsi_block_requests(struct Scsi_Host *);
 821
 822 struct class_container;
 823
 824 extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
 825                                                 void (*) (struct request_queue *));
 826 /*
 827  * These two functions are used to allocate and free a pseudo device
 828  * which will connect to the host adapter itself rather than any
 829  * physical device.  You must deallocate when you are done with the
 830  * thing.  This physical pseudo-device isn't real and won't be available
 831  * from any high-level drivers.
 832  */
 833 extern void scsi_free_host_dev(struct scsi_device *);
 834 extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
 835
 836 /*
 837  * DIF defines the exchange of protection information between
 838  * initiator and SBC block device.
 839  *
 840  * DIX defines the exchange of protection information between OS and
 841  * initiator.
 842  */
 843 enum scsi_host_prot_capabilities {
 844         SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
 845         SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
 846         SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */
 847
 848         SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
 849         SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
 850         SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
 851         SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
 852 };
 853
 854 /*
 855  * SCSI hosts which support the Data Integrity Extensions must
 856  * indicate their capabilities by setting the prot_capabilities using
 857  * this call.
 858  */
 859 static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
 860 {
 861         shost->prot_capabilities = mask;
 862 }
 863
 864 static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
 865 {
 866         return shost->prot_capabilities;
 867 }
 868
 869 static inline int scsi_host_prot_dma(struct Scsi_Host *shost)
 870 {
 871         return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION;
 872 }
 873
 874 static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
 875 {
 876         static unsigned char cap[] = { 0,
 877                                        SHOST_DIF_TYPE1_PROTECTION,
 878                                        SHOST_DIF_TYPE2_PROTECTION,
 879                                        SHOST_DIF_TYPE3_PROTECTION };
 880
 881         if (target_type >= ARRAY_SIZE(cap))
 882                 return 0;
 883
 884         return shost->prot_capabilities & cap[target_type] ? target_type : 0;
 885 }
 886
 887 static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
 888 {
 889 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 890         static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
 891                                        SHOST_DIX_TYPE1_PROTECTION,
 892                                        SHOST_DIX_TYPE2_PROTECTION,
 893                                        SHOST_DIX_TYPE3_PROTECTION };
 894
 895         if (target_type >= ARRAY_SIZE(cap))
 896                 return 0;
 897
 898         return shost->prot_capabilities & cap[target_type];
 899 #endif
 900         return 0;
 901 }
 902
 903 /*
 904  * All DIX-capable initiators must support the T10-mandated CRC
 905  * checksum.  Controllers can optionally implement the IP checksum
 906  * scheme which has much lower impact on system performance.  Note
 907  * that the main rationale for the checksum is to match integrity
 908  * metadata with data.  Detecting bit errors are a job for ECC memory
 909  * and buses.
 910  */
 911
 912 enum scsi_host_guard_type {
 913         SHOST_DIX_GUARD_CRC = 1 << 0,
 914         SHOST_DIX_GUARD_IP  = 1 << 1,
 915 };
 916
 917 static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
 918 {
 919         shost->prot_guard_type = type;
 920 }
 921
 922 static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
 923 {
 924         return shost->prot_guard_type;
 925 }
 926
 927 /* legacy interfaces */
 928 extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
 929 extern void scsi_unregister(struct Scsi_Host *);
 930 extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
 931
 932 #endif /* _SCSI_SCSI_HOST_H */