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