blob: 47941fc5aba753e2de036f8fb79f06588f73c9ff [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Arjan van de Ven0b950672006-01-11 13:16:10 +01008#include <linux/mutex.h>
James Bottomley4660c8e2008-02-10 09:42:46 -06009#include <scsi/scsi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
FUJITA Tomonorib58d9152006-11-16 19:24:10 +090011struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct block_device;
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +010013struct completion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070014struct module;
15struct scsi_cmnd;
16struct scsi_device;
James Bottomleya283bd32005-05-24 12:06:38 -050017struct scsi_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -070018struct Scsi_Host;
19struct scsi_host_cmd_pool;
20struct scsi_transport_template;
James Bottomley86e33a22006-08-30 09:45:51 -040021struct blk_queue_tags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
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
James Bottomley4660c8e2008-02-10 09:42:46 -060029 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 * Anything else: Indicates the maximum number of chains that can be
34 * used in one scatter-gather request.
35 */
36#define SG_NONE 0
James Bottomley4660c8e2008-02-10 09:42:46 -060037#define SG_ALL SCSI_MAX_SG_SEGMENTS
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +090039#define MODE_UNKNOWN 0x00
40#define MODE_INITIATOR 0x01
41#define MODE_TARGET 0x02
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
43#define DISABLE_CLUSTERING 0
44#define ENABLE_CLUSTERING 1
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046struct scsi_host_template {
47 struct module *module;
48 const char *name;
49
50 /*
51 * Used to initialize old-style drivers. For new-style drivers
52 * just perform all work in your module initialization function.
53 *
54 * Status: OBSOLETE
55 */
56 int (* detect)(struct scsi_host_template *);
57
58 /*
59 * Used as unload callback for hosts with old-style drivers.
60 *
61 * Status: OBSOLETE
62 */
63 int (* release)(struct Scsi_Host *);
64
65 /*
66 * The info function will return whatever useful information the
67 * developer sees fit. If not provided, then the name field will
68 * be used instead.
69 *
70 * Status: OPTIONAL
71 */
72 const char *(* info)(struct Scsi_Host *);
73
74 /*
75 * Ioctl interface
76 *
77 * Status: OPTIONAL
78 */
79 int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
80
81
82#ifdef CONFIG_COMPAT
83 /*
84 * Compat handler. Handle 32bit ABI.
85 * When unknown ioctl is passed return -ENOIOCTLCMD.
86 *
87 * Status: OPTIONAL
88 */
89 int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
90#endif
91
92 /*
93 * The queuecommand function is used to queue up a scsi
94 * command block to the LLDD. When the driver finished
95 * processing the command the done callback is invoked.
96 *
97 * If queuecommand returns 0, then the HBA has accepted the
98 * command. The done() function must be called on the command
99 * when the driver has finished with it. (you may call done on the
100 * command before queuecommand returns, but in this case you
101 * *must* return 0 from queuecommand).
102 *
103 * Queuecommand may also reject the command, in which case it may
104 * not touch the command and must not call done() for it.
105 *
106 * There are two possible rejection returns:
107 *
108 * SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
109 * allow commands to other devices serviced by this host.
110 *
111 * SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
112 * host temporarily.
113 *
114 * For compatibility, any other non-zero return is treated the
115 * same as SCSI_MLQUEUE_HOST_BUSY.
116 *
117 * NOTE: "temporarily" means either until the next command for#
118 * this device/host completes, or a period of time determined by
119 * I/O pressure in the system if there are no other outstanding
120 * commands.
121 *
122 * STATUS: REQUIRED
123 */
124 int (* queuecommand)(struct scsi_cmnd *,
125 void (*done)(struct scsi_cmnd *));
126
127 /*
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900128 * The transfer functions are used to queue a scsi command to
129 * the LLD. When the driver is finished processing the command
130 * the done callback is invoked.
131 *
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900132 * This is called to inform the LLD to transfer
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200133 * scsi_bufflen(cmd) bytes. scsi_sg_count(cmd) speciefies the
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900134 * number of scatterlist entried in the command and
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200135 * scsi_sglist(cmd) returns the scatterlist.
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900136 *
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900137 * return values: see queuecommand
138 *
139 * If the LLD accepts the cmd, it should set the result to an
140 * appropriate value when completed before calling the done function.
141 *
142 * STATUS: REQUIRED FOR TARGET DRIVERS
143 */
144 /* TODO: rename */
145 int (* transfer_response)(struct scsi_cmnd *,
146 void (*done)(struct scsi_cmnd *));
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900147
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900148 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 * This is an error handling strategy routine. You don't need to
150 * define one of these if you don't want to - there is a default
151 * routine that is present that should work in most cases. For those
152 * driver authors that have the inclination and ability to write their
153 * own strategy routine, this is where it is specified. Note - the
154 * strategy routine is *ALWAYS* run in the context of the kernel eh
155 * thread. Thus you are guaranteed to *NOT* be in an interrupt
156 * handler when you execute this, and you are also guaranteed to
157 * *NOT* have any other commands being queued while you are in the
158 * strategy routine. When you return from this function, operations
159 * return to normal.
160 *
161 * See scsi_error.c scsi_unjam_host for additional comments about
162 * what this function should and should not be attempting to do.
163 *
164 * Status: REQUIRED (at least one of them)
165 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 int (* eh_abort_handler)(struct scsi_cmnd *);
167 int (* eh_device_reset_handler)(struct scsi_cmnd *);
Mike Christie30bd7df2008-02-29 18:25:19 -0600168 int (* eh_target_reset_handler)(struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 int (* eh_bus_reset_handler)(struct scsi_cmnd *);
170 int (* eh_host_reset_handler)(struct scsi_cmnd *);
171
172 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 * Before the mid layer attempts to scan for a new device where none
174 * currently exists, it will call this entry in your driver. Should
175 * your driver need to allocate any structs or perform any other init
176 * items in order to send commands to a currently unused target/lun
177 * combo, then this is where you can perform those allocations. This
178 * is specifically so that drivers won't have to perform any kind of
179 * "is this a new device" checks in their queuecommand routine,
180 * thereby making the hot path a bit quicker.
181 *
182 * Return values: 0 on success, non-0 on failure
183 *
184 * Deallocation: If we didn't find any devices at this ID, you will
185 * get an immediate call to slave_destroy(). If we find something
186 * here then you will get a call to slave_configure(), then the
187 * device will be used for however long it is kept around, then when
188 * the device is removed from the system (or * possibly at reboot
189 * time), you will then get a call to slave_destroy(). This is
190 * assuming you implement slave_configure and slave_destroy.
191 * However, if you allocate memory and hang it off the device struct,
192 * then you must implement the slave_destroy() routine at a minimum
193 * in order to avoid leaking memory
194 * each time a device is tore down.
195 *
196 * Status: OPTIONAL
197 */
198 int (* slave_alloc)(struct scsi_device *);
199
200 /*
201 * Once the device has responded to an INQUIRY and we know the
202 * device is online, we call into the low level driver with the
203 * struct scsi_device *. If the low level device driver implements
204 * this function, it *must* perform the task of setting the queue
205 * depth on the device. All other tasks are optional and depend
206 * on what the driver supports and various implementation details.
207 *
208 * Things currently recommended to be handled at this time include:
209 *
210 * 1. Setting the device queue depth. Proper setting of this is
211 * described in the comments for scsi_adjust_queue_depth.
212 * 2. Determining if the device supports the various synchronous
213 * negotiation protocols. The device struct will already have
214 * responded to INQUIRY and the results of the standard items
215 * will have been shoved into the various device flag bits, eg.
216 * device->sdtr will be true if the device supports SDTR messages.
217 * 3. Allocating command structs that the device will need.
218 * 4. Setting the default timeout on this device (if needed).
219 * 5. Anything else the low level driver might want to do on a device
220 * specific setup basis...
221 * 6. Return 0 on success, non-0 on error. The device will be marked
222 * as offline on error so that no access will occur. If you return
223 * non-0, your slave_destroy routine will never get called for this
224 * device, so don't leave any loose memory hanging around, clean
225 * up after yourself before returning non-0
226 *
227 * Status: OPTIONAL
228 */
229 int (* slave_configure)(struct scsi_device *);
230
231 /*
232 * Immediately prior to deallocating the device and after all activity
233 * has ceased the mid layer calls this point so that the low level
234 * driver may completely detach itself from the scsi device and vice
235 * versa. The low level driver is responsible for freeing any memory
236 * it allocated in the slave_alloc or slave_configure calls.
237 *
238 * Status: OPTIONAL
239 */
240 void (* slave_destroy)(struct scsi_device *);
241
242 /*
James Bottomleya283bd32005-05-24 12:06:38 -0500243 * Before the mid layer attempts to scan for a new device attached
244 * to a target where no target currently exists, it will call this
245 * entry in your driver. Should your driver need to allocate any
246 * structs or perform any other init items in order to send commands
247 * to a currently unused target, then this is where you can perform
248 * those allocations.
249 *
250 * Return values: 0 on success, non-0 on failure
251 *
252 * Status: OPTIONAL
253 */
254 int (* target_alloc)(struct scsi_target *);
255
256 /*
257 * Immediately prior to deallocating the target structure, and
258 * after all activity to attached scsi devices has ceased, the
259 * midlayer calls this point so that the driver may deallocate
260 * and terminate any references to the target.
261 *
262 * Status: OPTIONAL
263 */
264 void (* target_destroy)(struct scsi_target *);
265
266 /*
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700267 * If a host has the ability to discover targets on its own instead
268 * of scanning the entire bus, it can fill in this function and
269 * call scsi_scan_host(). This function will be called periodically
270 * until it returns 1 with the scsi_host and the elapsed time of
271 * the scan in jiffies.
272 *
273 * Status: OPTIONAL
274 */
275 int (* scan_finished)(struct Scsi_Host *, unsigned long);
276
277 /*
278 * If the host wants to be called before the scan starts, but
279 * after the midlayer has set up ready for the scan, it can fill
280 * in this function.
Pavel Machekd850bd32008-02-04 23:53:24 -0800281 *
282 * Status: OPTIONAL
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700283 */
284 void (* scan_start)(struct Scsi_Host *);
285
286 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800287 * Fill in this function to allow the queue depth of this host
288 * to be changeable (on a per device basis). Returns either
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 * the current queue depth setting (may be different from what
290 * was passed in) or an error. An error should only be
291 * returned if the requested depth is legal but the driver was
292 * unable to set it. If the requested depth is illegal, the
293 * driver should set and return the closest legal queue depth.
294 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800295 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 */
297 int (* change_queue_depth)(struct scsi_device *, int);
298
299 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800300 * Fill in this function to allow the changing of tag types
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 * (this also allows the enabling/disabling of tag command
302 * queueing). An error should only be returned if something
303 * went wrong in the driver while trying to set the tag type.
304 * If the driver doesn't support the requested tag type, then
305 * it should set the closest type it does support without
306 * returning an error. Returns the actual tag type set.
Pavel Machekd850bd32008-02-04 23:53:24 -0800307 *
308 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 */
310 int (* change_queue_type)(struct scsi_device *, int);
311
312 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800313 * This function determines the BIOS parameters for a given
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 * harddisk. These tend to be numbers that are made up by
315 * the host adapter. Parameters:
316 * size, device, list (heads, sectors, cylinders)
317 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800318 * Status: OPTIONAL
319 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 int (* bios_param)(struct scsi_device *, struct block_device *,
321 sector_t, int []);
322
323 /*
324 * Can be used to export driver statistics and other infos to the
325 * world outside the kernel ie. userspace and it also provides an
326 * interface to feed the driver with information.
327 *
328 * Status: OBSOLETE
329 */
330 int (*proc_info)(struct Scsi_Host *, char *, char **, off_t, int, int);
331
332 /*
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500333 * This is an optional routine that allows the transport to become
334 * involved when a scsi io timer fires. The return value tells the
335 * timer routine how to finish the io timeout handling:
336 * EH_HANDLED: I fixed the error, please complete the command
337 * EH_RESET_TIMER: I need more time, reset the timer and
338 * begin counting again
339 * EH_NOT_HANDLED Begin normal error recovery
340 *
341 * Status: OPTIONAL
342 */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700343 enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500344
345 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 * Name of proc directory
347 */
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -0400348 const char *proc_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
350 /*
351 * Used to store the procfs directory if a driver implements the
352 * proc_info method.
353 */
354 struct proc_dir_entry *proc_dir;
355
356 /*
357 * This determines if we will use a non-interrupt driven
Pavel Machekd850bd32008-02-04 23:53:24 -0800358 * or an interrupt driven scheme. It is set to the maximum number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 * of simultaneous commands a given host adapter will accept.
360 */
361 int can_queue;
362
363 /*
364 * In many instances, especially where disconnect / reconnect are
365 * supported, our host also has an ID on the SCSI bus. If this is
366 * the case, then it must be reserved. Please set this_id to -1 if
367 * your setup is in single initiator mode, and the host lacks an
368 * ID.
369 */
370 int this_id;
371
372 /*
373 * This determines the degree to which the host adapter is capable
374 * of scatter-gather.
375 */
376 unsigned short sg_tablesize;
377
378 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800379 * Set this if the host adapter has limitations beside segment count.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 */
381 unsigned short max_sectors;
382
383 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800384 * DMA scatter gather segment boundary limit. A segment crossing this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 * boundary will be split in two.
386 */
387 unsigned long dma_boundary;
388
389 /*
390 * This specifies "machine infinity" for host templates which don't
391 * limit the transfer size. Note this limit represents an absolute
392 * maximum, and may be over the transfer limits allowed for
Pavel Machekd850bd32008-02-04 23:53:24 -0800393 * individual devices (e.g. 256 for SCSI-1).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 */
395#define SCSI_DEFAULT_MAX_SECTORS 1024
396
397 /*
398 * True if this host adapter can make good use of linked commands.
399 * This will allow more than one command to be queued to a given
400 * unit on a given host. Set this to the maximum number of command
401 * blocks to be provided for each device. Set this to 1 for one
402 * command block per lun, 2 for two, etc. Do not set this to 0.
403 * You should make sure that the host adapter will do the right thing
404 * before you try setting this above 1.
405 */
406 short cmd_per_lun;
407
408 /*
409 * present contains counter indicating how many boards of this
410 * type were found when we did the scan.
411 */
412 unsigned char present;
413
414 /*
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900415 * This specifies the mode that a LLD supports.
416 */
417 unsigned supported_mode:2;
418
419 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800420 * True if this host adapter uses unchecked DMA onto an ISA bus.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 */
422 unsigned unchecked_isa_dma:1;
423
424 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800425 * True if this host adapter can make good use of clustering.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 * I originally thought that if the tablesize was large that it
427 * was a waste of CPU cycles to prepare a cluster list, but
428 * it works out that the Buslogic is faster if you use a smaller
429 * number of segments (i.e. use clustering). I guess it is
430 * inefficient.
431 */
432 unsigned use_clustering:1;
433
434 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800435 * True for emulated SCSI host adapters (e.g. ATAPI).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 */
437 unsigned emulated:1;
438
439 /*
440 * True if the low-level driver performs its own reset-settle delays.
441 */
442 unsigned skip_settle_delay:1;
443
444 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800445 * True if we are using ordered write support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 unsigned ordered_tag:1;
448
449 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800450 * Countdown for host blocking with no commands outstanding.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 */
452 unsigned int max_host_blocked;
453
454 /*
455 * Default value for the blocking. If the queue is empty,
456 * host_blocked counts down in the request_fn until it restarts
457 * host operations as zero is reached.
458 *
459 * FIXME: This should probably be a value in the template
460 */
461#define SCSI_DEFAULT_HOST_BLOCKED 7
462
463 /*
464 * Pointer to the sysfs class properties for this host, NULL terminated.
465 */
Tony Jonesee959b02008-02-22 00:13:36 +0100466 struct device_attribute **shost_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468 /*
469 * Pointer to the SCSI device properties for this host, NULL terminated.
470 */
471 struct device_attribute **sdev_attrs;
472
473 /*
474 * List of hosts per template.
475 *
476 * This is only for use by scsi_module.c for legacy templates.
477 * For these access to it is synchronized implicitly by
478 * module_init/module_exit.
479 */
480 struct list_head legacy_hosts;
James Smart9e4f5e22009-03-26 13:33:19 -0400481
482 /*
483 * Vendor Identifier associated with the host
484 *
485 * Note: When specifying vendor_id, be sure to read the
486 * Vendor Type and ID formatting requirements specified in
487 * scsi_netlink.h
488 */
489 u64 vendor_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490};
491
492/*
Mike Andersond3301872005-06-16 11:12:38 -0700493 * shost state: If you alter this, you also need to alter scsi_sysfs.c
494 * (for the ascii descriptions) and the state model enforcer:
495 * scsi_host_set_state()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 */
Mike Andersond3301872005-06-16 11:12:38 -0700497enum scsi_host_state {
498 SHOST_CREATED = 1,
499 SHOST_RUNNING,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 SHOST_CANCEL,
Mike Andersond3301872005-06-16 11:12:38 -0700501 SHOST_DEL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 SHOST_RECOVERY,
James Bottomley939647e2005-09-18 15:05:20 -0500503 SHOST_CANCEL_RECOVERY,
504 SHOST_DEL_RECOVERY,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505};
506
507struct Scsi_Host {
508 /*
509 * __devices is protected by the host_lock, but you should
510 * usually use scsi_device_lookup / shost_for_each_device
511 * to access it and don't care about locking yourself.
512 * In the rare case of beeing in irq context you can use
513 * their __ prefixed variants with the lock held. NEVER
514 * access this list directly from a driver.
515 */
516 struct list_head __devices;
517 struct list_head __targets;
518
519 struct scsi_host_cmd_pool *cmd_pool;
520 spinlock_t free_list_lock;
521 struct list_head free_list; /* backup store of cmd structs */
522 struct list_head starved_list;
523
524 spinlock_t default_lock;
525 spinlock_t *host_lock;
526
Arjan van de Ven0b950672006-01-11 13:16:10 +0100527 struct mutex scan_mutex;/* serialize scanning activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 struct list_head eh_cmd_q;
530 struct task_struct * ehandler; /* Error recovery thread. */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100531 struct completion * eh_action; /* Wait for specific actions on the
532 host. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 wait_queue_head_t host_wait;
534 struct scsi_host_template *hostt;
535 struct scsi_transport_template *transportt;
06f81ea2005-04-17 14:57:29 -0500536
537 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800538 * Area to keep a shared tag map (if needed, will be
539 * NULL if not).
James Bottomley86e33a22006-08-30 09:45:51 -0400540 */
541 struct blk_queue_tag *bqt;
542
543 /*
06f81ea2005-04-17 14:57:29 -0500544 * The following two fields are protected with host_lock;
545 * however, eh routines can safely access during eh processing
546 * without acquiring the lock.
547 */
548 unsigned int host_busy; /* commands actually active on low-level */
549 unsigned int host_failed; /* commands that failed. */
Tejun Heoee7863b2006-05-15 20:57:20 +0900550 unsigned int host_eh_scheduled; /* EH scheduled without command */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Matthew Wilcox6d49f632008-07-15 14:54:16 -0600552 unsigned int host_no; /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 int resetting; /* if set, it means that last_reset is a valid value */
554 unsigned long last_reset;
555
556 /*
557 * These three parameters can be used to allow for wide scsi,
558 * and for host adapters that support multiple busses
559 * The first two should be set to 1 more than the actual max id
560 * or lun (i.e. 8 for normal systems).
561 */
562 unsigned int max_id;
563 unsigned int max_lun;
564 unsigned int max_channel;
565
566 /*
567 * This is a unique identifier that must be assigned so that we
568 * have some way of identifying each detected host adapter properly
569 * and uniquely. For hosts that do not support more than one card
570 * in the system at one time, this does not need to be set. It is
571 * initialized to 0 in scsi_register.
572 */
573 unsigned int unique_id;
574
575 /*
576 * The maximum length of SCSI commands that this host can accept.
577 * Probably 12 for most host adapters, but could be 16 for others.
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300578 * or 260 if the driver supports variable length cdbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 * For drivers that don't set this field, a value of 12 is
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300580 * assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300582 unsigned short max_cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
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 */
Matthew Wilcox12a44162007-09-18 19:54:43 -0600594 unsigned long cmd_serial_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900596 unsigned active_mode:2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 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
Pavel Machekd850bd32008-02-04 23:53:24 -0800610 * the spec ;).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 */
612 unsigned reverse_ordering:1;
613
614 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800615 * Ordered write support
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 unsigned ordered_tag:1;
618
Pavel Machekd850bd32008-02-04 23:53:24 -0800619 /* Task mgmt function in progress */
James Smartd7a1bb02006-03-08 14:50:12 -0500620 unsigned tmf_in_progress:1;
621
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600622 /* Asynchronous scan in progress */
623 unsigned async_scan:1;
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 /*
626 * Optional work queue to be utilized by the transport
627 */
Kay Sieversaab0de22008-05-02 06:02:41 +0200628 char work_q_name[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 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
Martin K. Petersen4469f982008-07-17 04:28:30 -0400641 /* Protection Information */
642 unsigned int prot_capabilities;
643 unsigned char prot_guard_type;
644
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900645 /*
646 * q used for scsi_tgt msgs, async events or any other requests that
647 * need to be processed in userspace
648 */
649 struct request_queue *uspace_req_q;
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 /* legacy crap */
652 unsigned long base;
653 unsigned long io_port;
654 unsigned char n_io_port;
655 unsigned char dma_channel;
656 unsigned int irq;
657
658
Mike Andersond3301872005-06-16 11:12:38 -0700659 enum scsi_host_state shost_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 /* ldm bits */
Tony Jonesee959b02008-02-22 00:13:36 +0100662 struct device shost_gendev, shost_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
664 /*
665 * List of hosts per template.
666 *
667 * This is only for use by scsi_module.c for legacy templates.
668 * For these access to it is synchronized implicitly by
669 * module_init/module_exit.
670 */
671 struct list_head sht_legacy_list;
672
673 /*
674 * Points to the transport data (if any) which is allocated
675 * separately
676 */
677 void *shost_data;
678
679 /*
680 * We should ensure that this is aligned, both for better performance
681 * and also because some compilers (m68k) don't automatically force
682 * alignment to a long boundary.
683 */
684 unsigned long hostdata[0] /* Used for storage of host specific stuff */
685 __attribute__ ((aligned (sizeof(unsigned long))));
686};
687
688#define class_to_shost(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100689 container_of(d, struct Scsi_Host, shost_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
James Bottomley9ccfc752005-10-02 11:45:08 -0500691#define shost_printk(prefix, shost, fmt, a...) \
692 dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)
693
Christoph Hellwigbcd92c92007-05-31 20:12:26 +0200694static inline void *shost_priv(struct Scsi_Host *shost)
695{
696 return (void *)shost->hostdata;
697}
James Bottomley9ccfc752005-10-02 11:45:08 -0500698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699int scsi_is_host_device(const struct device *);
700
701static inline struct Scsi_Host *dev_to_shost(struct device *dev)
702{
703 while (!scsi_is_host_device(dev)) {
704 if (!dev->parent)
705 return NULL;
706 dev = dev->parent;
707 }
708 return container_of(dev, struct Scsi_Host, shost_gendev);
709}
710
James Bottomley939647e2005-09-18 15:05:20 -0500711static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
712{
713 return shost->shost_state == SHOST_RECOVERY ||
714 shost->shost_state == SHOST_CANCEL_RECOVERY ||
James Smartd7a1bb02006-03-08 14:50:12 -0500715 shost->shost_state == SHOST_DEL_RECOVERY ||
716 shost->tmf_in_progress;
James Bottomley939647e2005-09-18 15:05:20 -0500717}
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
720extern void scsi_flush_work(struct Scsi_Host *);
721
722extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
723extern int __must_check scsi_add_host(struct Scsi_Host *, struct device *);
724extern void scsi_scan_host(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725extern void scsi_rescan_device(struct device *);
726extern void scsi_remove_host(struct Scsi_Host *);
727extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
728extern void scsi_host_put(struct Scsi_Host *t);
729extern struct Scsi_Host *scsi_host_lookup(unsigned short);
Mike Andersond3301872005-06-16 11:12:38 -0700730extern const char *scsi_host_state_name(enum scsi_host_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
732extern u64 scsi_calculate_bounce_limit(struct Scsi_Host *);
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734static inline struct device *scsi_get_device(struct Scsi_Host *shost)
735{
736 return shost->shost_gendev.parent;
737}
738
Mike Anderson82f29462005-06-16 11:14:33 -0700739/**
740 * scsi_host_scan_allowed - Is scanning of this host allowed
741 * @shost: Pointer to Scsi_Host.
742 **/
743static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
744{
745 return shost->shost_state == SHOST_RUNNING;
746}
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748extern void scsi_unblock_requests(struct Scsi_Host *);
749extern void scsi_block_requests(struct Scsi_Host *);
750
751struct class_container;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900752
753extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
754 void (*) (struct request_queue *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755/*
756 * These two functions are used to allocate and free a pseudo device
757 * which will connect to the host adapter itself rather than any
758 * physical device. You must deallocate when you are done with the
759 * thing. This physical pseudo-device isn't real and won't be available
760 * from any high-level drivers.
761 */
762extern void scsi_free_host_dev(struct scsi_device *);
763extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
764
Martin K. Petersen4469f982008-07-17 04:28:30 -0400765/*
766 * DIF defines the exchange of protection information between
767 * initiator and SBC block device.
768 *
769 * DIX defines the exchange of protection information between OS and
770 * initiator.
771 */
772enum scsi_host_prot_capabilities {
773 SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
774 SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
775 SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */
776
777 SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
778 SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
779 SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
780 SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
781};
782
783/*
784 * SCSI hosts which support the Data Integrity Extensions must
785 * indicate their capabilities by setting the prot_capabilities using
786 * this call.
787 */
788static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
789{
790 shost->prot_capabilities = mask;
791}
792
793static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
794{
795 return shost->prot_capabilities;
796}
797
798static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
799{
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400800 static unsigned char cap[] = { 0,
801 SHOST_DIF_TYPE1_PROTECTION,
802 SHOST_DIF_TYPE2_PROTECTION,
803 SHOST_DIF_TYPE3_PROTECTION };
Martin K. Petersen4469f982008-07-17 04:28:30 -0400804
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400805 return shost->prot_capabilities & cap[target_type] ? target_type : 0;
Martin K. Petersen4469f982008-07-17 04:28:30 -0400806}
807
808static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
809{
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400810#if defined(CONFIG_BLK_DEV_INTEGRITY)
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400811 static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
812 SHOST_DIX_TYPE1_PROTECTION,
813 SHOST_DIX_TYPE2_PROTECTION,
814 SHOST_DIX_TYPE3_PROTECTION };
815
816 return shost->prot_capabilities & cap[target_type];
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400817#endif
Martin K. Petersen4469f982008-07-17 04:28:30 -0400818 return 0;
819}
820
821/*
822 * All DIX-capable initiators must support the T10-mandated CRC
823 * checksum. Controllers can optionally implement the IP checksum
824 * scheme which has much lower impact on system performance. Note
825 * that the main rationale for the checksum is to match integrity
826 * metadata with data. Detecting bit errors are a job for ECC memory
827 * and buses.
828 */
829
830enum scsi_host_guard_type {
831 SHOST_DIX_GUARD_CRC = 1 << 0,
832 SHOST_DIX_GUARD_IP = 1 << 1,
833};
834
835static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
836{
837 shost->prot_guard_type = type;
838}
839
840static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
841{
842 return shost->prot_guard_type;
843}
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845/* legacy interfaces */
846extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
847extern void scsi_unregister(struct Scsi_Host *);
James Bottomley47ba39e2005-07-30 11:39:53 -0500848extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
850#endif /* _SCSI_SCSI_HOST_H */