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