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 functions lets the driver expose the queue mapping
 282          * to the block layer.
 283          *
 284          * Status: OPTIONAL
 285          */
 286         int (* map_queues)(struct Scsi_Host *shost);
 287
 288         /*
 289          * This function determines the BIOS parameters for a given
 290          * harddisk.  These tend to be numbers that are made up by
 291          * the host adapter.  Parameters:
 292          * size, device, list (heads, sectors, cylinders)
 293          *
 294          * Status: OPTIONAL
 295          */
 296         int (* bios_param)(struct scsi_device *, struct block_device *,
 297                         sector_t, int []);
 298
 299         /*
 300          * This function is called when one or more partitions on the
 301          * device reach beyond the end of the device.
 302          *
 303          * Status: OPTIONAL
 304          */
 305         void (*unlock_native_capacity)(struct scsi_device *);
 306
 307         /*
 308          * Can be used to export driver statistics and other infos to the
 309          * world outside the kernel ie. userspace and it also provides an
 310          * interface to feed the driver with information.
 311          *
 312          * Status: OBSOLETE
 313          */
 314         int (*show_info)(struct seq_file *, struct Scsi_Host *);
 315         int (*write_info)(struct Scsi_Host *, char *, int);
 316
 317         /*
 318          * This is an optional routine that allows the transport to become
 319          * involved when a scsi io timer fires. The return value tells the
 320          * timer routine how to finish the io timeout handling:
 321          * EH_HANDLED:          I fixed the error, please complete the command
 322          * EH_RESET_TIMER:      I need more time, reset the timer and
 323          *                      begin counting again
 324          * EH_NOT_HANDLED       Begin normal error recovery
 325          *
 326          * Status: OPTIONAL
 327          */
 328         enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
 329
 330         /* This is an optional routine that allows transport to initiate
 331          * LLD adapter or firmware reset using sysfs attribute.
 332          *
 333          * Return values: 0 on success, -ve value on failure.
 334          *
 335          * Status: OPTIONAL
 336          */
 337
 338         int (*host_reset)(struct Scsi_Host *shost, int reset_type);
 339 #define SCSI_ADAPTER_RESET      1
 340 #define SCSI_FIRMWARE_RESET     2
 341
 342
 343         /*
 344          * Name of proc directory
 345          */
 346         const char *proc_name;
 347
 348         /*
 349          * Used to store the procfs directory if a driver implements the
 350          * show_info method.
 351          */
 352         struct proc_dir_entry *proc_dir;
 353
 354         /*
 355          * This determines if we will use a non-interrupt driven
 356          * or an interrupt driven scheme.  It is set to the maximum number
 357          * of simultaneous commands a given host adapter will accept.
 358          */
 359         int can_queue;
 360
 361         /*
 362          * In many instances, especially where disconnect / reconnect are
 363          * supported, our host also has an ID on the SCSI bus.  If this is
 364          * the case, then it must be reserved.  Please set this_id to -1 if
 365          * your setup is in single initiator mode, and the host lacks an
 366          * ID.
 367          */
 368         int this_id;
 369
 370         /*
 371          * This determines the degree to which the host adapter is capable
 372          * of scatter-gather.
 373          */
 374         unsigned short sg_tablesize;
 375         unsigned short sg_prot_tablesize;
 376
 377         /*
 378          * Set this if the host adapter has limitations beside segment count.
 379          */
 380         unsigned int max_sectors;
 381
 382         /*
 383          * DMA scatter gather segment boundary limit. A segment crossing this
 384          * boundary will be split in two.
 385          */
 386         unsigned long dma_boundary;
 387
 388         /*
 389          * This specifies "machine infinity" for host templates which don't
 390          * limit the transfer size.  Note this limit represents an absolute
 391          * maximum, and may be over the transfer limits allowed for
 392          * individual devices (e.g. 256 for SCSI-1).
 393          */
 394 #define SCSI_DEFAULT_MAX_SECTORS        1024
 395
 396         /*
 397          * True if this host adapter can make good use of linked commands.
 398          * This will allow more than one command to be queued to a given
 399          * unit on a given host.  Set this to the maximum number of command
 400          * blocks to be provided for each device.  Set this to 1 for one
 401          * command block per lun, 2 for two, etc.  Do not set this to 0.
 402          * You should make sure that the host adapter will do the right thing
 403          * before you try setting this above 1.
 404          */
 405         short cmd_per_lun;
 406
 407         /*
 408          * present contains counter indicating how many boards of this
 409          * type were found when we did the scan.
 410          */
 411         unsigned char present;
 412
 413         /* If use block layer to manage tags, this is tag allocation policy */
 414         int tag_alloc_policy;
 415
 416         /*
 417          * Track QUEUE_FULL events and reduce queue depth on demand.
 418          */
 419         unsigned track_queue_depth:1;
 420
 421         /*
 422          * This specifies the mode that a LLD supports.
 423          */
 424         unsigned supported_mode:2;
 425
 426         /*
 427          * True if this host adapter uses unchecked DMA onto an ISA bus.
 428          */
 429         unsigned unchecked_isa_dma:1;
 430
 431         /*
 432          * True if this host adapter can make good use of clustering.
 433          * I originally thought that if the tablesize was large that it
 434          * was a waste of CPU cycles to prepare a cluster list, but
 435          * it works out that the Buslogic is faster if you use a smaller
 436          * number of segments (i.e. use clustering).  I guess it is
 437          * inefficient.
 438          */
 439         unsigned use_clustering:1;
 440
 441         /*
 442          * True for emulated SCSI host adapters (e.g. ATAPI).
 443          */
 444         unsigned emulated:1;
 445
 446         /*
 447          * True if the low-level driver performs its own reset-settle delays.
 448          */
 449         unsigned skip_settle_delay:1;
 450
 451         /* True if the controller does not support WRITE SAME */
 452         unsigned no_write_same:1;
 453
 454         /*
 455          * Countdown for host blocking with no commands outstanding.
 456          */
 457         unsigned int max_host_blocked;
 458
 459         /*
 460          * Default value for the blocking.  If the queue is empty,
 461          * host_blocked counts down in the request_fn until it restarts
 462          * host operations as zero is reached.
 463          *
 464          * FIXME: This should probably be a value in the template
 465          */
 466 #define SCSI_DEFAULT_HOST_BLOCKED       7
 467
 468         /*
 469          * Pointer to the sysfs class properties for this host, NULL terminated.
 470          */
 471         struct device_attribute **shost_attrs;
 472
 473         /*
 474          * Pointer to the SCSI device properties for this host, NULL terminated.
 475          */
 476         struct device_attribute **sdev_attrs;
 477
 478         /*
 479          * List of hosts per template.
 480          *
 481          * This is only for use by scsi_module.c for legacy templates.
 482          * For these access to it is synchronized implicitly by
 483          * module_init/module_exit.
 484          */
 485         struct list_head legacy_hosts;
 486
 487         /*
 488          * Vendor Identifier associated with the host
 489          *
 490          * Note: When specifying vendor_id, be sure to read the
 491          *   Vendor Type and ID formatting requirements specified in
 492          *   scsi_netlink.h
 493          */
 494         u64 vendor_id;
 495
 496         /*
 497          * Additional per-command data allocated for the driver.
 498          */
 499         unsigned int cmd_size;
 500         struct scsi_host_cmd_pool *cmd_pool;
 501 };
 502
 503 /*
 504  * Temporary #define for host lock push down. Can be removed when all
 505  * drivers have been updated to take advantage of unlocked
 506  * queuecommand.
 507  *
 508  */
 509 #define DEF_SCSI_QCMD(func_name) \
 510         int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd)   \
 511         {                                                               \
 512                 unsigned long irq_flags;                                \
 513                 int rc;                                                 \
 514                 spin_lock_irqsave(shost->host_lock, irq_flags);         \
 515                 scsi_cmd_get_serial(shost, cmd);                        \
 516                 rc = func_name##_lck (cmd, cmd->scsi_done);                     \
 517                 spin_unlock_irqrestore(shost->host_lock, irq_flags);    \
 518                 return rc;                                              \
 519         }
 520
 521
 522 /*
 523  * shost state: If you alter this, you also need to alter scsi_sysfs.c
 524  * (for the ascii descriptions) and the state model enforcer:
 525  * scsi_host_set_state()
 526  */
 527 enum scsi_host_state {
 528         SHOST_CREATED = 1,
 529         SHOST_RUNNING,
 530         SHOST_CANCEL,
 531         SHOST_DEL,
 532         SHOST_RECOVERY,
 533         SHOST_CANCEL_RECOVERY,
 534         SHOST_DEL_RECOVERY,
 535 };
 536
 537 struct Scsi_Host {
 538         /*
 539          * __devices is protected by the host_lock, but you should
 540          * usually use scsi_device_lookup / shost_for_each_device
 541          * to access it and don't care about locking yourself.
 542          * In the rare case of being in irq context you can use
 543          * their __ prefixed variants with the lock held. NEVER
 544          * access this list directly from a driver.
 545          */
 546         struct list_head        __devices;
 547         struct list_head        __targets;
 548
 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 static inline bool shost_use_blk_mq(struct Scsi_Host *shost)
 775 {
 776         return shost->use_blk_mq;
 777 }
 778
 779 extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
 780 extern void scsi_flush_work(struct Scsi_Host *);
 781
 782 extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
 783 extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *,
 784                                                struct device *,
 785                                                struct device *);
 786 extern void scsi_scan_host(struct Scsi_Host *);
 787 extern void scsi_rescan_device(struct device *);
 788 extern void scsi_remove_host(struct Scsi_Host *);
 789 extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
 790 extern void scsi_host_put(struct Scsi_Host *t);
 791 extern struct Scsi_Host *scsi_host_lookup(unsigned short);
 792 extern const char *scsi_host_state_name(enum scsi_host_state);
 793 extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *);
 794
 795 static inline int __must_check scsi_add_host(struct Scsi_Host *host,
 796                                              struct device *dev)
 797 {
 798         return scsi_add_host_with_dma(host, dev, dev);
 799 }
 800
 801 static inline struct device *scsi_get_device(struct Scsi_Host *shost)
 802 {
 803         return shost->shost_gendev.parent;
 804 }
 805
 806 /**
 807  * scsi_host_scan_allowed - Is scanning of this host allowed
 808  * @shost:      Pointer to Scsi_Host.
 809  **/
 810 static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
 811 {
 812         return shost->shost_state == SHOST_RUNNING ||
 813                shost->shost_state == SHOST_RECOVERY;
 814 }
 815
 816 extern void scsi_unblock_requests(struct Scsi_Host *);
 817 extern void scsi_block_requests(struct Scsi_Host *);
 818
 819 struct class_container;
 820
 821 /*
 822  * These two functions are used to allocate and free a pseudo device
 823  * which will connect to the host adapter itself rather than any
 824  * physical device.  You must deallocate when you are done with the
 825  * thing.  This physical pseudo-device isn't real and won't be available
 826  * from any high-level drivers.
 827  */
 828 extern void scsi_free_host_dev(struct scsi_device *);
 829 extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
 830
 831 /*
 832  * DIF defines the exchange of protection information between
 833  * initiator and SBC block device.
 834  *
 835  * DIX defines the exchange of protection information between OS and
 836  * initiator.
 837  */
 838 enum scsi_host_prot_capabilities {
 839         SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
 840         SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
 841         SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */
 842
 843         SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
 844         SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
 845         SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
 846         SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
 847 };
 848
 849 /*
 850  * SCSI hosts which support the Data Integrity Extensions must
 851  * indicate their capabilities by setting the prot_capabilities using
 852  * this call.
 853  */
 854 static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
 855 {
 856         shost->prot_capabilities = mask;
 857 }
 858
 859 static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
 860 {
 861         return shost->prot_capabilities;
 862 }
 863
 864 static inline int scsi_host_prot_dma(struct Scsi_Host *shost)
 865 {
 866         return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION;
 867 }
 868
 869 static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
 870 {
 871         static unsigned char cap[] = { 0,
 872                                        SHOST_DIF_TYPE1_PROTECTION,
 873                                        SHOST_DIF_TYPE2_PROTECTION,
 874                                        SHOST_DIF_TYPE3_PROTECTION };
 875
 876         if (target_type >= ARRAY_SIZE(cap))
 877                 return 0;
 878
 879         return shost->prot_capabilities & cap[target_type] ? target_type : 0;
 880 }
 881
 882 static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
 883 {
 884 #if defined(CONFIG_BLK_DEV_INTEGRITY)
 885         static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
 886                                        SHOST_DIX_TYPE1_PROTECTION,
 887                                        SHOST_DIX_TYPE2_PROTECTION,
 888                                        SHOST_DIX_TYPE3_PROTECTION };
 889
 890         if (target_type >= ARRAY_SIZE(cap))
 891                 return 0;
 892
 893         return shost->prot_capabilities & cap[target_type];
 894 #endif
 895         return 0;
 896 }
 897
 898 /*
 899  * All DIX-capable initiators must support the T10-mandated CRC
 900  * checksum.  Controllers can optionally implement the IP checksum
 901  * scheme which has much lower impact on system performance.  Note
 902  * that the main rationale for the checksum is to match integrity
 903  * metadata with data.  Detecting bit errors are a job for ECC memory
 904  * and buses.
 905  */
 906
 907 enum scsi_host_guard_type {
 908         SHOST_DIX_GUARD_CRC = 1 << 0,
 909         SHOST_DIX_GUARD_IP  = 1 << 1,
 910 };
 911
 912 static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
 913 {
 914         shost->prot_guard_type = type;
 915 }
 916
 917 static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
 918 {
 919         return shost->prot_guard_type;
 920 }
 921
 922 /* legacy interfaces */
 923 extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
 924 extern void scsi_unregister(struct Scsi_Host *);
 925 extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
 926
 927 #endif /* _SCSI_SCSI_HOST_H */