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 SCSI_MAX_SG_SEGMENTS 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 * Fill in this function to allow the changing of tag types 282 * (this also allows the enabling/disabling of tag command 283 * queueing). An error should only be returned if something 284 * went wrong in the driver while trying to set the tag type. 285 * If the driver doesn't support the requested tag type, then 286 * it should set the closest type it does support without 287 * returning an error. Returns the actual tag type set. 288 * 289 * Status: OPTIONAL 290 */ 291 int (* change_queue_type)(struct scsi_device *, int); 292 293 /* 294 * This function determines the BIOS parameters for a given 295 * harddisk. These tend to be numbers that are made up by 296 * the host adapter. Parameters: 297 * size, device, list (heads, sectors, cylinders) 298 * 299 * Status: OPTIONAL 300 */ 301 int (* bios_param)(struct scsi_device *, struct block_device *, 302 sector_t, int []); 303 304 /* 305 * This function is called when one or more partitions on the 306 * device reach beyond the end of the device. 307 * 308 * Status: OPTIONAL 309 */ 310 void (*unlock_native_capacity)(struct scsi_device *); 311 312 /* 313 * Can be used to export driver statistics and other infos to the 314 * world outside the kernel ie. userspace and it also provides an 315 * interface to feed the driver with information. 316 * 317 * Status: OBSOLETE 318 */ 319 int (*show_info)(struct seq_file *, struct Scsi_Host *); 320 int (*write_info)(struct Scsi_Host *, char *, int); 321 322 /* 323 * This is an optional routine that allows the transport to become 324 * involved when a scsi io timer fires. The return value tells the 325 * timer routine how to finish the io timeout handling: 326 * EH_HANDLED: I fixed the error, please complete the command 327 * EH_RESET_TIMER: I need more time, reset the timer and 328 * begin counting again 329 * EH_NOT_HANDLED Begin normal error recovery 330 * 331 * Status: OPTIONAL 332 */ 333 enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *); 334 335 /* This is an optional routine that allows transport to initiate 336 * LLD adapter or firmware reset using sysfs attribute. 337 * 338 * Return values: 0 on success, -ve value on failure. 339 * 340 * Status: OPTIONAL 341 */ 342 343 int (*host_reset)(struct Scsi_Host *shost, int reset_type); 344 #define SCSI_ADAPTER_RESET 1 345 #define SCSI_FIRMWARE_RESET 2 346 347 348 /* 349 * Name of proc directory 350 */ 351 const char *proc_name; 352 353 /* 354 * Used to store the procfs directory if a driver implements the 355 * show_info method. 356 */ 357 struct proc_dir_entry *proc_dir; 358 359 /* 360 * This determines if we will use a non-interrupt driven 361 * or an interrupt driven scheme. It is set to the maximum number 362 * of simultaneous commands a given host adapter will accept. 363 */ 364 int can_queue; 365 366 /* 367 * In many instances, especially where disconnect / reconnect are 368 * supported, our host also has an ID on the SCSI bus. If this is 369 * the case, then it must be reserved. Please set this_id to -1 if 370 * your setup is in single initiator mode, and the host lacks an 371 * ID. 372 */ 373 int this_id; 374 375 /* 376 * This determines the degree to which the host adapter is capable 377 * of scatter-gather. 378 */ 379 unsigned short sg_tablesize; 380 unsigned short sg_prot_tablesize; 381 382 /* 383 * Set this if the host adapter has limitations beside segment count. 384 */ 385 unsigned int max_sectors; 386 387 /* 388 * DMA scatter gather segment boundary limit. A segment crossing this 389 * boundary will be split in two. 390 */ 391 unsigned long dma_boundary; 392 393 /* 394 * This specifies "machine infinity" for host templates which don't 395 * limit the transfer size. Note this limit represents an absolute 396 * maximum, and may be over the transfer limits allowed for 397 * individual devices (e.g. 256 for SCSI-1). 398 */ 399 #define SCSI_DEFAULT_MAX_SECTORS 1024 400 401 /* 402 * True if this host adapter can make good use of linked commands. 403 * This will allow more than one command to be queued to a given 404 * unit on a given host. Set this to the maximum number of command 405 * blocks to be provided for each device. Set this to 1 for one 406 * command block per lun, 2 for two, etc. Do not set this to 0. 407 * You should make sure that the host adapter will do the right thing 408 * before you try setting this above 1. 409 */ 410 short cmd_per_lun; 411 412 /* 413 * present contains counter indicating how many boards of this 414 * type were found when we did the scan. 415 */ 416 unsigned char present; 417 418 /* 419 * Let the block layer assigns tags to all commands. 420 */ 421 unsigned use_blk_tags:1; 422 423 /* 424 * Track QUEUE_FULL events and reduce queue depth on demand. 425 */ 426 unsigned track_queue_depth:1; 427 428 /* 429 * This specifies the mode that a LLD supports. 430 */ 431 unsigned supported_mode:2; 432 433 /* 434 * True if this host adapter uses unchecked DMA onto an ISA bus. 435 */ 436 unsigned unchecked_isa_dma:1; 437 438 /* 439 * True if this host adapter can make good use of clustering. 440 * I originally thought that if the tablesize was large that it 441 * was a waste of CPU cycles to prepare a cluster list, but 442 * it works out that the Buslogic is faster if you use a smaller 443 * number of segments (i.e. use clustering). I guess it is 444 * inefficient. 445 */ 446 unsigned use_clustering:1; 447 448 /* 449 * True for emulated SCSI host adapters (e.g. ATAPI). 450 */ 451 unsigned emulated:1; 452 453 /* 454 * True if the low-level driver performs its own reset-settle delays. 455 */ 456 unsigned skip_settle_delay:1; 457 458 /* True if the controller does not support WRITE SAME */ 459 unsigned no_write_same:1; 460 461 /* 462 * True if asynchronous aborts are not supported 463 */ 464 unsigned no_async_abort:1; 465 466 /* 467 * Countdown for host blocking with no commands outstanding. 468 */ 469 unsigned int max_host_blocked; 470 471 /* 472 * Default value for the blocking. If the queue is empty, 473 * host_blocked counts down in the request_fn until it restarts 474 * host operations as zero is reached. 475 * 476 * FIXME: This should probably be a value in the template 477 */ 478 #define SCSI_DEFAULT_HOST_BLOCKED 7 479 480 /* 481 * Pointer to the sysfs class properties for this host, NULL terminated. 482 */ 483 struct device_attribute **shost_attrs; 484 485 /* 486 * Pointer to the SCSI device properties for this host, NULL terminated. 487 */ 488 struct device_attribute **sdev_attrs; 489 490 /* 491 * List of hosts per template. 492 * 493 * This is only for use by scsi_module.c for legacy templates. 494 * For these access to it is synchronized implicitly by 495 * module_init/module_exit. 496 */ 497 struct list_head legacy_hosts; 498 499 /* 500 * Vendor Identifier associated with the host 501 * 502 * Note: When specifying vendor_id, be sure to read the 503 * Vendor Type and ID formatting requirements specified in 504 * scsi_netlink.h 505 */ 506 u64 vendor_id; 507 508 /* 509 * Additional per-command data allocated for the driver. 510 */ 511 unsigned int cmd_size; 512 struct scsi_host_cmd_pool *cmd_pool; 513 514 /* temporary flag to disable blk-mq I/O path */ 515 bool disable_blk_mq; 516 }; 517 518 /* 519 * Temporary #define for host lock push down. Can be removed when all 520 * drivers have been updated to take advantage of unlocked 521 * queuecommand. 522 * 523 */ 524 #define DEF_SCSI_QCMD(func_name) \ 525 int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd) \ 526 { \ 527 unsigned long irq_flags; \ 528 int rc; \ 529 spin_lock_irqsave(shost->host_lock, irq_flags); \ 530 scsi_cmd_get_serial(shost, cmd); \ 531 rc = func_name##_lck (cmd, cmd->scsi_done); \ 532 spin_unlock_irqrestore(shost->host_lock, irq_flags); \ 533 return rc; \ 534 } 535 536 537 /* 538 * shost state: If you alter this, you also need to alter scsi_sysfs.c 539 * (for the ascii descriptions) and the state model enforcer: 540 * scsi_host_set_state() 541 */ 542 enum scsi_host_state { 543 SHOST_CREATED = 1, 544 SHOST_RUNNING, 545 SHOST_CANCEL, 546 SHOST_DEL, 547 SHOST_RECOVERY, 548 SHOST_CANCEL_RECOVERY, 549 SHOST_DEL_RECOVERY, 550 }; 551 552 struct Scsi_Host { 553 /* 554 * __devices is protected by the host_lock, but you should 555 * usually use scsi_device_lookup / shost_for_each_device 556 * to access it and don't care about locking yourself. 557 * In the rare case of being in irq context you can use 558 * their __ prefixed variants with the lock held. NEVER 559 * access this list directly from a driver. 560 */ 561 struct list_head __devices; 562 struct list_head __targets; 563 564 struct scsi_host_cmd_pool *cmd_pool; 565 spinlock_t free_list_lock; 566 struct list_head free_list; /* backup store of cmd structs */ 567 struct list_head starved_list; 568 569 spinlock_t default_lock; 570 spinlock_t *host_lock; 571 572 struct mutex scan_mutex;/* serialize scanning activity */ 573 574 struct list_head eh_cmd_q; 575 struct task_struct * ehandler; /* Error recovery thread. */ 576 struct completion * eh_action; /* Wait for specific actions on the 577 host. */ 578 wait_queue_head_t host_wait; 579 struct scsi_host_template *hostt; 580 struct scsi_transport_template *transportt; 581 582 /* 583 * Area to keep a shared tag map (if needed, will be 584 * NULL if not). 585 */ 586 union { 587 struct blk_queue_tag *bqt; 588 struct blk_mq_tag_set tag_set; 589 }; 590 591 atomic_t host_busy; /* commands actually active on low-level */ 592 atomic_t host_blocked; 593 594 unsigned int host_failed; /* commands that failed. 595 protected by host_lock */ 596 unsigned int host_eh_scheduled; /* EH scheduled without command */ 597 598 unsigned int host_no; /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */ 599 600 /* next two fields are used to bound the time spent in error handling */ 601 int eh_deadline; 602 unsigned long last_reset; 603 604 605 /* 606 * These three parameters can be used to allow for wide scsi, 607 * and for host adapters that support multiple busses 608 * The last two should be set to 1 more than the actual max id 609 * or lun (e.g. 8 for SCSI parallel systems). 610 */ 611 unsigned int max_channel; 612 unsigned int max_id; 613 u64 max_lun; 614 615 /* 616 * This is a unique identifier that must be assigned so that we 617 * have some way of identifying each detected host adapter properly 618 * and uniquely. For hosts that do not support more than one card 619 * in the system at one time, this does not need to be set. It is 620 * initialized to 0 in scsi_register. 621 */ 622 unsigned int unique_id; 623 624 /* 625 * The maximum length of SCSI commands that this host can accept. 626 * Probably 12 for most host adapters, but could be 16 for others. 627 * or 260 if the driver supports variable length cdbs. 628 * For drivers that don't set this field, a value of 12 is 629 * assumed. 630 */ 631 unsigned short max_cmd_len; 632 633 int this_id; 634 int can_queue; 635 short cmd_per_lun; 636 short unsigned int sg_tablesize; 637 short unsigned int sg_prot_tablesize; 638 unsigned int max_sectors; 639 unsigned long dma_boundary; 640 /* 641 * In scsi-mq mode, the number of hardware queues supported by the LLD. 642 * 643 * Note: it is assumed that each hardware queue has a queue depth of 644 * can_queue. In other words, the total queue depth per host 645 * is nr_hw_queues * can_queue. 646 */ 647 unsigned nr_hw_queues; 648 /* 649 * Used to assign serial numbers to the cmds. 650 * Protected by the host lock. 651 */ 652 unsigned long cmd_serial_number; 653 654 unsigned active_mode:2; 655 unsigned unchecked_isa_dma:1; 656 unsigned use_clustering:1; 657 658 /* 659 * Host has requested that no further requests come through for the 660 * time being. 661 */ 662 unsigned host_self_blocked:1; 663 664 /* 665 * Host uses correct SCSI ordering not PC ordering. The bit is 666 * set for the minority of drivers whose authors actually read 667 * the spec ;). 668 */ 669 unsigned reverse_ordering:1; 670 671 /* Task mgmt function in progress */ 672 unsigned tmf_in_progress:1; 673 674 /* Asynchronous scan in progress */ 675 unsigned async_scan:1; 676 677 /* Don't resume host in EH */ 678 unsigned eh_noresume:1; 679 680 /* The controller does not support WRITE SAME */ 681 unsigned no_write_same:1; 682 683 unsigned use_blk_mq:1; 684 unsigned use_cmd_list:1; 685 686 /* 687 * Optional work queue to be utilized by the transport 688 */ 689 char work_q_name[20]; 690 struct workqueue_struct *work_q; 691 692 /* 693 * Task management function work queue 694 */ 695 struct workqueue_struct *tmf_work_q; 696 697 /* The transport requires the LUN bits NOT to be stored in CDB[1] */ 698 unsigned no_scsi2_lun_in_cdb:1; 699 700 /* 701 * Value host_blocked counts down from 702 */ 703 unsigned int max_host_blocked; 704 705 /* Protection Information */ 706 unsigned int prot_capabilities; 707 unsigned char prot_guard_type; 708 709 /* 710 * q used for scsi_tgt msgs, async events or any other requests that 711 * need to be processed in userspace 712 */ 713 struct request_queue *uspace_req_q; 714 715 /* legacy crap */ 716 unsigned long base; 717 unsigned long io_port; 718 unsigned char n_io_port; 719 unsigned char dma_channel; 720 unsigned int irq; 721 722 723 enum scsi_host_state shost_state; 724 725 /* ldm bits */ 726 struct device shost_gendev, shost_dev; 727 728 /* 729 * List of hosts per template. 730 * 731 * This is only for use by scsi_module.c for legacy templates. 732 * For these access to it is synchronized implicitly by 733 * module_init/module_exit. 734 */ 735 struct list_head sht_legacy_list; 736 737 /* 738 * Points to the transport data (if any) which is allocated 739 * separately 740 */ 741 void *shost_data; 742 743 /* 744 * Points to the physical bus device we'd use to do DMA 745 * Needed just in case we have virtual hosts. 746 */ 747 struct device *dma_dev; 748 749 /* 750 * We should ensure that this is aligned, both for better performance 751 * and also because some compilers (m68k) don't automatically force 752 * alignment to a long boundary. 753 */ 754 unsigned long hostdata[0] /* Used for storage of host specific stuff */ 755 __attribute__ ((aligned (sizeof(unsigned long)))); 756 }; 757 758 #define class_to_shost(d) \ 759 container_of(d, struct Scsi_Host, shost_dev) 760 761 #define shost_printk(prefix, shost, fmt, a...) \ 762 dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a) 763 764 static inline void *shost_priv(struct Scsi_Host *shost) 765 { 766 return (void *)shost->hostdata; 767 } 768 769 int scsi_is_host_device(const struct device *); 770 771 static inline struct Scsi_Host *dev_to_shost(struct device *dev) 772 { 773 while (!scsi_is_host_device(dev)) { 774 if (!dev->parent) 775 return NULL; 776 dev = dev->parent; 777 } 778 return container_of(dev, struct Scsi_Host, shost_gendev); 779 } 780 781 static inline int scsi_host_in_recovery(struct Scsi_Host *shost) 782 { 783 return shost->shost_state == SHOST_RECOVERY || 784 shost->shost_state == SHOST_CANCEL_RECOVERY || 785 shost->shost_state == SHOST_DEL_RECOVERY || 786 shost->tmf_in_progress; 787 } 788 789 extern bool scsi_use_blk_mq; 790 791 static inline bool shost_use_blk_mq(struct Scsi_Host *shost) 792 { 793 return shost->use_blk_mq; 794 } 795 796 extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *); 797 extern void scsi_flush_work(struct Scsi_Host *); 798 799 extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int); 800 extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *, 801 struct device *, 802 struct device *); 803 extern void scsi_scan_host(struct Scsi_Host *); 804 extern void scsi_rescan_device(struct device *); 805 extern void scsi_remove_host(struct Scsi_Host *); 806 extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *); 807 extern void scsi_host_put(struct Scsi_Host *t); 808 extern struct Scsi_Host *scsi_host_lookup(unsigned short); 809 extern const char *scsi_host_state_name(enum scsi_host_state); 810 extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *); 811 812 static inline int __must_check scsi_add_host(struct Scsi_Host *host, 813 struct device *dev) 814 { 815 return scsi_add_host_with_dma(host, dev, dev); 816 } 817 818 static inline struct device *scsi_get_device(struct Scsi_Host *shost) 819 { 820 return shost->shost_gendev.parent; 821 } 822 823 /** 824 * scsi_host_scan_allowed - Is scanning of this host allowed 825 * @shost: Pointer to Scsi_Host. 826 **/ 827 static inline int scsi_host_scan_allowed(struct Scsi_Host *shost) 828 { 829 return shost->shost_state == SHOST_RUNNING || 830 shost->shost_state == SHOST_RECOVERY; 831 } 832 833 extern void scsi_unblock_requests(struct Scsi_Host *); 834 extern void scsi_block_requests(struct Scsi_Host *); 835 836 struct class_container; 837 838 extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost, 839 void (*) (struct request_queue *)); 840 /* 841 * These two functions are used to allocate and free a pseudo device 842 * which will connect to the host adapter itself rather than any 843 * physical device. You must deallocate when you are done with the 844 * thing. This physical pseudo-device isn't real and won't be available 845 * from any high-level drivers. 846 */ 847 extern void scsi_free_host_dev(struct scsi_device *); 848 extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *); 849 850 /* 851 * DIF defines the exchange of protection information between 852 * initiator and SBC block device. 853 * 854 * DIX defines the exchange of protection information between OS and 855 * initiator. 856 */ 857 enum scsi_host_prot_capabilities { 858 SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */ 859 SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */ 860 SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */ 861 862 SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */ 863 SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */ 864 SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */ 865 SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */ 866 }; 867 868 /* 869 * SCSI hosts which support the Data Integrity Extensions must 870 * indicate their capabilities by setting the prot_capabilities using 871 * this call. 872 */ 873 static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask) 874 { 875 shost->prot_capabilities = mask; 876 } 877 878 static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost) 879 { 880 return shost->prot_capabilities; 881 } 882 883 static inline int scsi_host_prot_dma(struct Scsi_Host *shost) 884 { 885 return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION; 886 } 887 888 static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type) 889 { 890 static unsigned char cap[] = { 0, 891 SHOST_DIF_TYPE1_PROTECTION, 892 SHOST_DIF_TYPE2_PROTECTION, 893 SHOST_DIF_TYPE3_PROTECTION }; 894 895 if (target_type >= ARRAY_SIZE(cap)) 896 return 0; 897 898 return shost->prot_capabilities & cap[target_type] ? target_type : 0; 899 } 900 901 static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type) 902 { 903 #if defined(CONFIG_BLK_DEV_INTEGRITY) 904 static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION, 905 SHOST_DIX_TYPE1_PROTECTION, 906 SHOST_DIX_TYPE2_PROTECTION, 907 SHOST_DIX_TYPE3_PROTECTION }; 908 909 if (target_type >= ARRAY_SIZE(cap)) 910 return 0; 911 912 return shost->prot_capabilities & cap[target_type]; 913 #endif 914 return 0; 915 } 916 917 /* 918 * All DIX-capable initiators must support the T10-mandated CRC 919 * checksum. Controllers can optionally implement the IP checksum 920 * scheme which has much lower impact on system performance. Note 921 * that the main rationale for the checksum is to match integrity 922 * metadata with data. Detecting bit errors are a job for ECC memory 923 * and buses. 924 */ 925 926 enum scsi_host_guard_type { 927 SHOST_DIX_GUARD_CRC = 1 << 0, 928 SHOST_DIX_GUARD_IP = 1 << 1, 929 }; 930 931 static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type) 932 { 933 shost->prot_guard_type = type; 934 } 935 936 static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost) 937 { 938 return shost->prot_guard_type; 939 } 940 941 /* legacy interfaces */ 942 extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int); 943 extern void scsi_unregister(struct Scsi_Host *); 944 extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state); 945 946 #endif /* _SCSI_SCSI_HOST_H */ 947