xref: /openbmc/linux/include/scsi/scsi_host.h (revision f42b3800)
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 
11 struct request_queue;
12 struct block_device;
13 struct completion;
14 struct module;
15 struct scsi_cmnd;
16 struct scsi_device;
17 struct scsi_target;
18 struct Scsi_Host;
19 struct scsi_host_cmd_pool;
20 struct scsi_transport_template;
21 struct 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 
46 enum scsi_eh_timer_return {
47 	EH_NOT_HANDLED,
48 	EH_HANDLED,
49 	EH_RESET_TIMER,
50 };
51 
52 
53 struct scsi_host_template {
54 	struct module *module;
55 	const char *name;
56 
57 	/*
58 	 * Used to initialize old-style drivers.  For new-style drivers
59 	 * just perform all work in your module initialization function.
60 	 *
61 	 * Status:  OBSOLETE
62 	 */
63 	int (* detect)(struct scsi_host_template *);
64 
65 	/*
66 	 * Used as unload callback for hosts with old-style drivers.
67 	 *
68 	 * Status: OBSOLETE
69 	 */
70 	int (* release)(struct Scsi_Host *);
71 
72 	/*
73 	 * The info function will return whatever useful information the
74 	 * developer sees fit.  If not provided, then the name field will
75 	 * be used instead.
76 	 *
77 	 * Status: OPTIONAL
78 	 */
79 	const char *(* info)(struct Scsi_Host *);
80 
81 	/*
82 	 * Ioctl interface
83 	 *
84 	 * Status: OPTIONAL
85 	 */
86 	int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
87 
88 
89 #ifdef CONFIG_COMPAT
90 	/*
91 	 * Compat handler. Handle 32bit ABI.
92 	 * When unknown ioctl is passed return -ENOIOCTLCMD.
93 	 *
94 	 * Status: OPTIONAL
95 	 */
96 	int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
97 #endif
98 
99 	/*
100 	 * The queuecommand function is used to queue up a scsi
101 	 * command block to the LLDD.  When the driver finished
102 	 * processing the command the done callback is invoked.
103 	 *
104 	 * If queuecommand returns 0, then the HBA has accepted the
105 	 * command.  The done() function must be called on the command
106 	 * when the driver has finished with it. (you may call done on the
107 	 * command before queuecommand returns, but in this case you
108 	 * *must* return 0 from queuecommand).
109 	 *
110 	 * Queuecommand may also reject the command, in which case it may
111 	 * not touch the command and must not call done() for it.
112 	 *
113 	 * There are two possible rejection returns:
114 	 *
115 	 *   SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
116 	 *   allow commands to other devices serviced by this host.
117 	 *
118 	 *   SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
119 	 *   host temporarily.
120 	 *
121          * For compatibility, any other non-zero return is treated the
122          * same as SCSI_MLQUEUE_HOST_BUSY.
123 	 *
124 	 * NOTE: "temporarily" means either until the next command for#
125 	 * this device/host completes, or a period of time determined by
126 	 * I/O pressure in the system if there are no other outstanding
127 	 * commands.
128 	 *
129 	 * STATUS: REQUIRED
130 	 */
131 	int (* queuecommand)(struct scsi_cmnd *,
132 			     void (*done)(struct scsi_cmnd *));
133 
134 	/*
135 	 * The transfer functions are used to queue a scsi command to
136 	 * the LLD. When the driver is finished processing the command
137 	 * the done callback is invoked.
138 	 *
139 	 * This is called to inform the LLD to transfer
140 	 * scsi_bufflen(cmd) bytes. scsi_sg_count(cmd) speciefies the
141 	 * number of scatterlist entried in the command and
142 	 * scsi_sglist(cmd) returns the scatterlist.
143 	 *
144 	 * return values: see queuecommand
145 	 *
146 	 * If the LLD accepts the cmd, it should set the result to an
147 	 * appropriate value when completed before calling the done function.
148 	 *
149 	 * STATUS: REQUIRED FOR TARGET DRIVERS
150 	 */
151 	/* TODO: rename */
152 	int (* transfer_response)(struct scsi_cmnd *,
153 				  void (*done)(struct scsi_cmnd *));
154 
155 	/*
156 	 * This is an error handling strategy routine.  You don't need to
157 	 * define one of these if you don't want to - there is a default
158 	 * routine that is present that should work in most cases.  For those
159 	 * driver authors that have the inclination and ability to write their
160 	 * own strategy routine, this is where it is specified.  Note - the
161 	 * strategy routine is *ALWAYS* run in the context of the kernel eh
162 	 * thread.  Thus you are guaranteed to *NOT* be in an interrupt
163 	 * handler when you execute this, and you are also guaranteed to
164 	 * *NOT* have any other commands being queued while you are in the
165 	 * strategy routine. When you return from this function, operations
166 	 * return to normal.
167 	 *
168 	 * See scsi_error.c scsi_unjam_host for additional comments about
169 	 * what this function should and should not be attempting to do.
170 	 *
171 	 * Status: REQUIRED	(at least one of them)
172 	 */
173 	int (* eh_abort_handler)(struct scsi_cmnd *);
174 	int (* eh_device_reset_handler)(struct scsi_cmnd *);
175 	int (* eh_target_reset_handler)(struct scsi_cmnd *);
176 	int (* eh_bus_reset_handler)(struct scsi_cmnd *);
177 	int (* eh_host_reset_handler)(struct scsi_cmnd *);
178 
179 	/*
180 	 * Before the mid layer attempts to scan for a new device where none
181 	 * currently exists, it will call this entry in your driver.  Should
182 	 * your driver need to allocate any structs or perform any other init
183 	 * items in order to send commands to a currently unused target/lun
184 	 * combo, then this is where you can perform those allocations.  This
185 	 * is specifically so that drivers won't have to perform any kind of
186 	 * "is this a new device" checks in their queuecommand routine,
187 	 * thereby making the hot path a bit quicker.
188 	 *
189 	 * Return values: 0 on success, non-0 on failure
190 	 *
191 	 * Deallocation:  If we didn't find any devices at this ID, you will
192 	 * get an immediate call to slave_destroy().  If we find something
193 	 * here then you will get a call to slave_configure(), then the
194 	 * device will be used for however long it is kept around, then when
195 	 * the device is removed from the system (or * possibly at reboot
196 	 * time), you will then get a call to slave_destroy().  This is
197 	 * assuming you implement slave_configure and slave_destroy.
198 	 * However, if you allocate memory and hang it off the device struct,
199 	 * then you must implement the slave_destroy() routine at a minimum
200 	 * in order to avoid leaking memory
201 	 * each time a device is tore down.
202 	 *
203 	 * Status: OPTIONAL
204 	 */
205 	int (* slave_alloc)(struct scsi_device *);
206 
207 	/*
208 	 * Once the device has responded to an INQUIRY and we know the
209 	 * device is online, we call into the low level driver with the
210 	 * struct scsi_device *.  If the low level device driver implements
211 	 * this function, it *must* perform the task of setting the queue
212 	 * depth on the device.  All other tasks are optional and depend
213 	 * on what the driver supports and various implementation details.
214 	 *
215 	 * Things currently recommended to be handled at this time include:
216 	 *
217 	 * 1.  Setting the device queue depth.  Proper setting of this is
218 	 *     described in the comments for scsi_adjust_queue_depth.
219 	 * 2.  Determining if the device supports the various synchronous
220 	 *     negotiation protocols.  The device struct will already have
221 	 *     responded to INQUIRY and the results of the standard items
222 	 *     will have been shoved into the various device flag bits, eg.
223 	 *     device->sdtr will be true if the device supports SDTR messages.
224 	 * 3.  Allocating command structs that the device will need.
225 	 * 4.  Setting the default timeout on this device (if needed).
226 	 * 5.  Anything else the low level driver might want to do on a device
227 	 *     specific setup basis...
228 	 * 6.  Return 0 on success, non-0 on error.  The device will be marked
229 	 *     as offline on error so that no access will occur.  If you return
230 	 *     non-0, your slave_destroy routine will never get called for this
231 	 *     device, so don't leave any loose memory hanging around, clean
232 	 *     up after yourself before returning non-0
233 	 *
234 	 * Status: OPTIONAL
235 	 */
236 	int (* slave_configure)(struct scsi_device *);
237 
238 	/*
239 	 * Immediately prior to deallocating the device and after all activity
240 	 * has ceased the mid layer calls this point so that the low level
241 	 * driver may completely detach itself from the scsi device and vice
242 	 * versa.  The low level driver is responsible for freeing any memory
243 	 * it allocated in the slave_alloc or slave_configure calls.
244 	 *
245 	 * Status: OPTIONAL
246 	 */
247 	void (* slave_destroy)(struct scsi_device *);
248 
249 	/*
250 	 * Before the mid layer attempts to scan for a new device attached
251 	 * to a target where no target currently exists, it will call this
252 	 * entry in your driver.  Should your driver need to allocate any
253 	 * structs or perform any other init items in order to send commands
254 	 * to a currently unused target, then this is where you can perform
255 	 * those allocations.
256 	 *
257 	 * Return values: 0 on success, non-0 on failure
258 	 *
259 	 * Status: OPTIONAL
260 	 */
261 	int (* target_alloc)(struct scsi_target *);
262 
263 	/*
264 	 * Immediately prior to deallocating the target structure, and
265 	 * after all activity to attached scsi devices has ceased, the
266 	 * midlayer calls this point so that the driver may deallocate
267 	 * and terminate any references to the target.
268 	 *
269 	 * Status: OPTIONAL
270 	 */
271 	void (* target_destroy)(struct scsi_target *);
272 
273 	/*
274 	 * If a host has the ability to discover targets on its own instead
275 	 * of scanning the entire bus, it can fill in this function and
276 	 * call scsi_scan_host().  This function will be called periodically
277 	 * until it returns 1 with the scsi_host and the elapsed time of
278 	 * the scan in jiffies.
279 	 *
280 	 * Status: OPTIONAL
281 	 */
282 	int (* scan_finished)(struct Scsi_Host *, unsigned long);
283 
284 	/*
285 	 * If the host wants to be called before the scan starts, but
286 	 * after the midlayer has set up ready for the scan, it can fill
287 	 * in this function.
288 	 *
289 	 * Status: OPTIONAL
290 	 */
291 	void (* scan_start)(struct Scsi_Host *);
292 
293 	/*
294 	 * Fill in this function to allow the queue depth of this host
295 	 * to be changeable (on a per device basis).  Returns either
296 	 * the current queue depth setting (may be different from what
297 	 * was passed in) or an error.  An error should only be
298 	 * returned if the requested depth is legal but the driver was
299 	 * unable to set it.  If the requested depth is illegal, the
300 	 * driver should set and return the closest legal queue depth.
301 	 *
302 	 * Status: OPTIONAL
303 	 */
304 	int (* change_queue_depth)(struct scsi_device *, int);
305 
306 	/*
307 	 * Fill in this function to allow the changing of tag types
308 	 * (this also allows the enabling/disabling of tag command
309 	 * queueing).  An error should only be returned if something
310 	 * went wrong in the driver while trying to set the tag type.
311 	 * If the driver doesn't support the requested tag type, then
312 	 * it should set the closest type it does support without
313 	 * returning an error.  Returns the actual tag type set.
314 	 *
315 	 * Status: OPTIONAL
316 	 */
317 	int (* change_queue_type)(struct scsi_device *, int);
318 
319 	/*
320 	 * This function determines the BIOS parameters for a given
321 	 * harddisk.  These tend to be numbers that are made up by
322 	 * the host adapter.  Parameters:
323 	 * size, device, list (heads, sectors, cylinders)
324 	 *
325 	 * Status: OPTIONAL
326 	 */
327 	int (* bios_param)(struct scsi_device *, struct block_device *,
328 			sector_t, int []);
329 
330 	/*
331 	 * Can be used to export driver statistics and other infos to the
332 	 * world outside the kernel ie. userspace and it also provides an
333 	 * interface to feed the driver with information.
334 	 *
335 	 * Status: OBSOLETE
336 	 */
337 	int (*proc_info)(struct Scsi_Host *, char *, char **, off_t, int, int);
338 
339 	/*
340 	 * This is an optional routine that allows the transport to become
341 	 * involved when a scsi io timer fires. The return value tells the
342 	 * timer routine how to finish the io timeout handling:
343 	 * EH_HANDLED:		I fixed the error, please complete the command
344 	 * EH_RESET_TIMER:	I need more time, reset the timer and
345 	 *			begin counting again
346 	 * EH_NOT_HANDLED	Begin normal error recovery
347 	 *
348 	 * Status: OPTIONAL
349 	 */
350 	enum scsi_eh_timer_return (* eh_timed_out)(struct scsi_cmnd *);
351 
352 	/*
353 	 * Name of proc directory
354 	 */
355 	const char *proc_name;
356 
357 	/*
358 	 * Used to store the procfs directory if a driver implements the
359 	 * proc_info method.
360 	 */
361 	struct proc_dir_entry *proc_dir;
362 
363 	/*
364 	 * This determines if we will use a non-interrupt driven
365 	 * or an interrupt driven scheme.  It is set to the maximum number
366 	 * of simultaneous commands a given host adapter will accept.
367 	 */
368 	int can_queue;
369 
370 	/*
371 	 * In many instances, especially where disconnect / reconnect are
372 	 * supported, our host also has an ID on the SCSI bus.  If this is
373 	 * the case, then it must be reserved.  Please set this_id to -1 if
374 	 * your setup is in single initiator mode, and the host lacks an
375 	 * ID.
376 	 */
377 	int this_id;
378 
379 	/*
380 	 * This determines the degree to which the host adapter is capable
381 	 * of scatter-gather.
382 	 */
383 	unsigned short sg_tablesize;
384 
385 	/*
386 	 * Set this if the host adapter has limitations beside segment count.
387 	 */
388 	unsigned short max_sectors;
389 
390 	/*
391 	 * DMA scatter gather segment boundary limit. A segment crossing this
392 	 * boundary will be split in two.
393 	 */
394 	unsigned long dma_boundary;
395 
396 	/*
397 	 * This specifies "machine infinity" for host templates which don't
398 	 * limit the transfer size.  Note this limit represents an absolute
399 	 * maximum, and may be over the transfer limits allowed for
400 	 * individual devices (e.g. 256 for SCSI-1).
401 	 */
402 #define SCSI_DEFAULT_MAX_SECTORS	1024
403 
404 	/*
405 	 * True if this host adapter can make good use of linked commands.
406 	 * This will allow more than one command to be queued to a given
407 	 * unit on a given host.  Set this to the maximum number of command
408 	 * blocks to be provided for each device.  Set this to 1 for one
409 	 * command block per lun, 2 for two, etc.  Do not set this to 0.
410 	 * You should make sure that the host adapter will do the right thing
411 	 * before you try setting this above 1.
412 	 */
413 	short cmd_per_lun;
414 
415 	/*
416 	 * present contains counter indicating how many boards of this
417 	 * type were found when we did the scan.
418 	 */
419 	unsigned char present;
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 	/*
452 	 * True if we are using ordered write support.
453 	 */
454 	unsigned ordered_tag:1;
455 
456 	/*
457 	 * Countdown for host blocking with no commands outstanding.
458 	 */
459 	unsigned int max_host_blocked;
460 
461 	/*
462 	 * Default value for the blocking.  If the queue is empty,
463 	 * host_blocked counts down in the request_fn until it restarts
464 	 * host operations as zero is reached.
465 	 *
466 	 * FIXME: This should probably be a value in the template
467 	 */
468 #define SCSI_DEFAULT_HOST_BLOCKED	7
469 
470 	/*
471 	 * Pointer to the sysfs class properties for this host, NULL terminated.
472 	 */
473 	struct class_device_attribute **shost_attrs;
474 
475 	/*
476 	 * Pointer to the SCSI device properties for this host, NULL terminated.
477 	 */
478 	struct device_attribute **sdev_attrs;
479 
480 	/*
481 	 * List of hosts per template.
482 	 *
483 	 * This is only for use by scsi_module.c for legacy templates.
484 	 * For these access to it is synchronized implicitly by
485 	 * module_init/module_exit.
486 	 */
487 	struct list_head legacy_hosts;
488 };
489 
490 /*
491  * shost state: If you alter this, you also need to alter scsi_sysfs.c
492  * (for the ascii descriptions) and the state model enforcer:
493  * scsi_host_set_state()
494  */
495 enum scsi_host_state {
496 	SHOST_CREATED = 1,
497 	SHOST_RUNNING,
498 	SHOST_CANCEL,
499 	SHOST_DEL,
500 	SHOST_RECOVERY,
501 	SHOST_CANCEL_RECOVERY,
502 	SHOST_DEL_RECOVERY,
503 };
504 
505 struct Scsi_Host {
506 	/*
507 	 * __devices is protected by the host_lock, but you should
508 	 * usually use scsi_device_lookup / shost_for_each_device
509 	 * to access it and don't care about locking yourself.
510 	 * In the rare case of beeing in irq context you can use
511 	 * their __ prefixed variants with the lock held. NEVER
512 	 * access this list directly from a driver.
513 	 */
514 	struct list_head	__devices;
515 	struct list_head	__targets;
516 
517 	struct scsi_host_cmd_pool *cmd_pool;
518 	spinlock_t		free_list_lock;
519 	struct list_head	free_list; /* backup store of cmd structs */
520 	struct list_head	starved_list;
521 
522 	spinlock_t		default_lock;
523 	spinlock_t		*host_lock;
524 
525 	struct mutex		scan_mutex;/* serialize scanning activity */
526 
527 	struct list_head	eh_cmd_q;
528 	struct task_struct    * ehandler;  /* Error recovery thread. */
529 	struct completion     * eh_action; /* Wait for specific actions on the
530 					      host. */
531 	wait_queue_head_t       host_wait;
532 	struct scsi_host_template *hostt;
533 	struct scsi_transport_template *transportt;
534 
535 	/*
536 	 * Area to keep a shared tag map (if needed, will be
537 	 * NULL if not).
538 	 */
539 	struct blk_queue_tag	*bqt;
540 
541 	/*
542 	 * The following two fields are protected with host_lock;
543 	 * however, eh routines can safely access during eh processing
544 	 * without acquiring the lock.
545 	 */
546 	unsigned int host_busy;		   /* commands actually active on low-level */
547 	unsigned int host_failed;	   /* commands that failed. */
548 	unsigned int host_eh_scheduled;    /* EH scheduled without command */
549 
550 	unsigned short host_no;  /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
551 	int resetting; /* if set, it means that last_reset is a valid value */
552 	unsigned long last_reset;
553 
554 	/*
555 	 * These three parameters can be used to allow for wide scsi,
556 	 * and for host adapters that support multiple busses
557 	 * The first two should be set to 1 more than the actual max id
558 	 * or lun (i.e. 8 for normal systems).
559 	 */
560 	unsigned int max_id;
561 	unsigned int max_lun;
562 	unsigned int max_channel;
563 
564 	/*
565 	 * This is a unique identifier that must be assigned so that we
566 	 * have some way of identifying each detected host adapter properly
567 	 * and uniquely.  For hosts that do not support more than one card
568 	 * in the system at one time, this does not need to be set.  It is
569 	 * initialized to 0 in scsi_register.
570 	 */
571 	unsigned int unique_id;
572 
573 	/*
574 	 * The maximum length of SCSI commands that this host can accept.
575 	 * Probably 12 for most host adapters, but could be 16 for others.
576 	 * For drivers that don't set this field, a value of 12 is
577 	 * assumed.  I am leaving this as a number rather than a bit
578 	 * because you never know what subsequent SCSI standards might do
579 	 * (i.e. could there be a 20 byte or a 24-byte command a few years
580 	 * down the road?).
581 	 */
582 	unsigned char max_cmd_len;
583 
584 	int this_id;
585 	int can_queue;
586 	short cmd_per_lun;
587 	short unsigned int sg_tablesize;
588 	short unsigned int max_sectors;
589 	unsigned long dma_boundary;
590 	/*
591 	 * Used to assign serial numbers to the cmds.
592 	 * Protected by the host lock.
593 	 */
594 	unsigned long cmd_serial_number;
595 
596 	unsigned active_mode:2;
597 	unsigned unchecked_isa_dma:1;
598 	unsigned use_clustering:1;
599 	unsigned use_blk_tcq:1;
600 
601 	/*
602 	 * Host has requested that no further requests come through for the
603 	 * time being.
604 	 */
605 	unsigned host_self_blocked:1;
606 
607 	/*
608 	 * Host uses correct SCSI ordering not PC ordering. The bit is
609 	 * set for the minority of drivers whose authors actually read
610 	 * the spec ;).
611 	 */
612 	unsigned reverse_ordering:1;
613 
614 	/*
615 	 * Ordered write support
616 	 */
617 	unsigned ordered_tag:1;
618 
619 	/* Task mgmt function in progress */
620 	unsigned tmf_in_progress:1;
621 
622 	/* Asynchronous scan in progress */
623 	unsigned async_scan:1;
624 
625 	/*
626 	 * Optional work queue to be utilized by the transport
627 	 */
628 	char work_q_name[KOBJ_NAME_LEN];
629 	struct workqueue_struct *work_q;
630 
631 	/*
632 	 * Host has rejected a command because it was busy.
633 	 */
634 	unsigned int host_blocked;
635 
636 	/*
637 	 * Value host_blocked counts down from
638 	 */
639 	unsigned int max_host_blocked;
640 
641 	/*
642 	 * q used for scsi_tgt msgs, async events or any other requests that
643 	 * need to be processed in userspace
644 	 */
645 	struct request_queue *uspace_req_q;
646 
647 	/* legacy crap */
648 	unsigned long base;
649 	unsigned long io_port;
650 	unsigned char n_io_port;
651 	unsigned char dma_channel;
652 	unsigned int  irq;
653 
654 
655 	enum scsi_host_state shost_state;
656 
657 	/* ldm bits */
658 	struct device		shost_gendev;
659 	struct class_device	shost_classdev;
660 
661 	/*
662 	 * List of hosts per template.
663 	 *
664 	 * This is only for use by scsi_module.c for legacy templates.
665 	 * For these access to it is synchronized implicitly by
666 	 * module_init/module_exit.
667 	 */
668 	struct list_head sht_legacy_list;
669 
670 	/*
671 	 * Points to the transport data (if any) which is allocated
672 	 * separately
673 	 */
674 	void *shost_data;
675 
676 	/*
677 	 * We should ensure that this is aligned, both for better performance
678 	 * and also because some compilers (m68k) don't automatically force
679 	 * alignment to a long boundary.
680 	 */
681 	unsigned long hostdata[0]  /* Used for storage of host specific stuff */
682 		__attribute__ ((aligned (sizeof(unsigned long))));
683 };
684 
685 #define		class_to_shost(d)	\
686 	container_of(d, struct Scsi_Host, shost_classdev)
687 
688 #define shost_printk(prefix, shost, fmt, a...)	\
689 	dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)
690 
691 static inline void *shost_priv(struct Scsi_Host *shost)
692 {
693 	return (void *)shost->hostdata;
694 }
695 
696 int scsi_is_host_device(const struct device *);
697 
698 static inline struct Scsi_Host *dev_to_shost(struct device *dev)
699 {
700 	while (!scsi_is_host_device(dev)) {
701 		if (!dev->parent)
702 			return NULL;
703 		dev = dev->parent;
704 	}
705 	return container_of(dev, struct Scsi_Host, shost_gendev);
706 }
707 
708 static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
709 {
710 	return shost->shost_state == SHOST_RECOVERY ||
711 		shost->shost_state == SHOST_CANCEL_RECOVERY ||
712 		shost->shost_state == SHOST_DEL_RECOVERY ||
713 		shost->tmf_in_progress;
714 }
715 
716 extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
717 extern void scsi_flush_work(struct Scsi_Host *);
718 
719 extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
720 extern int __must_check scsi_add_host(struct Scsi_Host *, struct device *);
721 extern void scsi_scan_host(struct Scsi_Host *);
722 extern void scsi_rescan_device(struct device *);
723 extern void scsi_remove_host(struct Scsi_Host *);
724 extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
725 extern void scsi_host_put(struct Scsi_Host *t);
726 extern struct Scsi_Host *scsi_host_lookup(unsigned short);
727 extern const char *scsi_host_state_name(enum scsi_host_state);
728 
729 extern u64 scsi_calculate_bounce_limit(struct Scsi_Host *);
730 
731 static inline struct device *scsi_get_device(struct Scsi_Host *shost)
732 {
733         return shost->shost_gendev.parent;
734 }
735 
736 /**
737  * scsi_host_scan_allowed - Is scanning of this host allowed
738  * @shost:	Pointer to Scsi_Host.
739  **/
740 static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
741 {
742 	return shost->shost_state == SHOST_RUNNING;
743 }
744 
745 extern void scsi_unblock_requests(struct Scsi_Host *);
746 extern void scsi_block_requests(struct Scsi_Host *);
747 
748 struct class_container;
749 
750 extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
751 						void (*) (struct request_queue *));
752 /*
753  * These two functions are used to allocate and free a pseudo device
754  * which will connect to the host adapter itself rather than any
755  * physical device.  You must deallocate when you are done with the
756  * thing.  This physical pseudo-device isn't real and won't be available
757  * from any high-level drivers.
758  */
759 extern void scsi_free_host_dev(struct scsi_device *);
760 extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
761 
762 /* legacy interfaces */
763 extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
764 extern void scsi_unregister(struct Scsi_Host *);
765 extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
766 
767 #endif /* _SCSI_SCSI_HOST_H */
768