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