blob: 50266c9405fced26eb7a48f386d1889c1f3a6253 [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
Mike Christiee881a172009-10-15 17:46:39 -070046enum {
47 SCSI_QDEPTH_DEFAULT, /* default requested change, e.g. from sysfs */
48 SCSI_QDEPTH_QFULL, /* scsi-ml requested due to queue full */
Lucas De Marchi25985ed2011-03-30 22:57:33 -030049 SCSI_QDEPTH_RAMP_UP, /* scsi-ml requested due to threshold event */
Mike Christiee881a172009-10-15 17:46:39 -070050};
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct scsi_host_template {
53 struct module *module;
54 const char *name;
55
56 /*
57 * Used to initialize old-style drivers. For new-style drivers
58 * just perform all work in your module initialization function.
59 *
60 * Status: OBSOLETE
61 */
62 int (* detect)(struct scsi_host_template *);
63
64 /*
65 * Used as unload callback for hosts with old-style drivers.
66 *
67 * Status: OBSOLETE
68 */
69 int (* release)(struct Scsi_Host *);
70
71 /*
72 * The info function will return whatever useful information the
73 * developer sees fit. If not provided, then the name field will
74 * be used instead.
75 *
76 * Status: OPTIONAL
77 */
78 const char *(* info)(struct Scsi_Host *);
79
80 /*
81 * Ioctl interface
82 *
83 * Status: OPTIONAL
84 */
85 int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
86
87
88#ifdef CONFIG_COMPAT
89 /*
90 * Compat handler. Handle 32bit ABI.
91 * When unknown ioctl is passed return -ENOIOCTLCMD.
92 *
93 * Status: OPTIONAL
94 */
95 int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
96#endif
97
98 /*
99 * The queuecommand function is used to queue up a scsi
100 * command block to the LLDD. When the driver finished
101 * processing the command the done callback is invoked.
102 *
103 * If queuecommand returns 0, then the HBA has accepted the
104 * command. The done() function must be called on the command
105 * when the driver has finished with it. (you may call done on the
106 * command before queuecommand returns, but in this case you
107 * *must* return 0 from queuecommand).
108 *
109 * Queuecommand may also reject the command, in which case it may
110 * not touch the command and must not call done() for it.
111 *
112 * There are two possible rejection returns:
113 *
114 * SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
115 * allow commands to other devices serviced by this host.
116 *
117 * SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
118 * host temporarily.
119 *
120 * For compatibility, any other non-zero return is treated the
121 * same as SCSI_MLQUEUE_HOST_BUSY.
122 *
123 * NOTE: "temporarily" means either until the next command for#
124 * this device/host completes, or a period of time determined by
125 * I/O pressure in the system if there are no other outstanding
126 * commands.
127 *
128 * STATUS: REQUIRED
129 */
Jeff Garzikf2812332010-11-16 02:10:29 -0500130 int (* queuecommand)(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132 /*
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900133 * The transfer functions are used to queue a scsi command to
134 * the LLD. When the driver is finished processing the command
135 * the done callback is invoked.
136 *
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900137 * This is called to inform the LLD to transfer
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200138 * scsi_bufflen(cmd) bytes. scsi_sg_count(cmd) speciefies the
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900139 * number of scatterlist entried in the command and
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200140 * scsi_sglist(cmd) returns the scatterlist.
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900141 *
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900142 * return values: see queuecommand
143 *
144 * If the LLD accepts the cmd, it should set the result to an
145 * appropriate value when completed before calling the done function.
146 *
147 * STATUS: REQUIRED FOR TARGET DRIVERS
148 */
149 /* TODO: rename */
150 int (* transfer_response)(struct scsi_cmnd *,
151 void (*done)(struct scsi_cmnd *));
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900152
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900153 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 * This is an error handling strategy routine. You don't need to
155 * define one of these if you don't want to - there is a default
156 * routine that is present that should work in most cases. For those
157 * driver authors that have the inclination and ability to write their
158 * own strategy routine, this is where it is specified. Note - the
159 * strategy routine is *ALWAYS* run in the context of the kernel eh
160 * thread. Thus you are guaranteed to *NOT* be in an interrupt
161 * handler when you execute this, and you are also guaranteed to
162 * *NOT* have any other commands being queued while you are in the
163 * strategy routine. When you return from this function, operations
164 * return to normal.
165 *
166 * See scsi_error.c scsi_unjam_host for additional comments about
167 * what this function should and should not be attempting to do.
168 *
169 * Status: REQUIRED (at least one of them)
170 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 int (* eh_abort_handler)(struct scsi_cmnd *);
172 int (* eh_device_reset_handler)(struct scsi_cmnd *);
Mike Christie30bd7df2008-02-29 18:25:19 -0600173 int (* eh_target_reset_handler)(struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 int (* eh_bus_reset_handler)(struct scsi_cmnd *);
175 int (* eh_host_reset_handler)(struct scsi_cmnd *);
176
177 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 * Before the mid layer attempts to scan for a new device where none
179 * currently exists, it will call this entry in your driver. Should
180 * your driver need to allocate any structs or perform any other init
181 * items in order to send commands to a currently unused target/lun
182 * combo, then this is where you can perform those allocations. This
183 * is specifically so that drivers won't have to perform any kind of
184 * "is this a new device" checks in their queuecommand routine,
185 * thereby making the hot path a bit quicker.
186 *
187 * Return values: 0 on success, non-0 on failure
188 *
189 * Deallocation: If we didn't find any devices at this ID, you will
190 * get an immediate call to slave_destroy(). If we find something
191 * here then you will get a call to slave_configure(), then the
192 * device will be used for however long it is kept around, then when
193 * the device is removed from the system (or * possibly at reboot
194 * time), you will then get a call to slave_destroy(). This is
195 * assuming you implement slave_configure and slave_destroy.
196 * However, if you allocate memory and hang it off the device struct,
197 * then you must implement the slave_destroy() routine at a minimum
198 * in order to avoid leaking memory
199 * each time a device is tore down.
200 *
201 * Status: OPTIONAL
202 */
203 int (* slave_alloc)(struct scsi_device *);
204
205 /*
206 * Once the device has responded to an INQUIRY and we know the
207 * device is online, we call into the low level driver with the
208 * struct scsi_device *. If the low level device driver implements
209 * this function, it *must* perform the task of setting the queue
210 * depth on the device. All other tasks are optional and depend
211 * on what the driver supports and various implementation details.
212 *
213 * Things currently recommended to be handled at this time include:
214 *
215 * 1. Setting the device queue depth. Proper setting of this is
216 * described in the comments for scsi_adjust_queue_depth.
217 * 2. Determining if the device supports the various synchronous
218 * negotiation protocols. The device struct will already have
219 * responded to INQUIRY and the results of the standard items
220 * will have been shoved into the various device flag bits, eg.
221 * device->sdtr will be true if the device supports SDTR messages.
222 * 3. Allocating command structs that the device will need.
223 * 4. Setting the default timeout on this device (if needed).
224 * 5. Anything else the low level driver might want to do on a device
225 * specific setup basis...
226 * 6. Return 0 on success, non-0 on error. The device will be marked
227 * as offline on error so that no access will occur. If you return
228 * non-0, your slave_destroy routine will never get called for this
229 * device, so don't leave any loose memory hanging around, clean
230 * up after yourself before returning non-0
231 *
232 * Status: OPTIONAL
233 */
234 int (* slave_configure)(struct scsi_device *);
235
236 /*
237 * Immediately prior to deallocating the device and after all activity
238 * has ceased the mid layer calls this point so that the low level
239 * driver may completely detach itself from the scsi device and vice
240 * versa. The low level driver is responsible for freeing any memory
241 * it allocated in the slave_alloc or slave_configure calls.
242 *
243 * Status: OPTIONAL
244 */
245 void (* slave_destroy)(struct scsi_device *);
246
247 /*
James Bottomleya283bd32005-05-24 12:06:38 -0500248 * Before the mid layer attempts to scan for a new device attached
249 * to a target where no target currently exists, it will call this
250 * entry in your driver. Should your driver need to allocate any
251 * structs or perform any other init items in order to send commands
252 * to a currently unused target, then this is where you can perform
253 * those allocations.
254 *
255 * Return values: 0 on success, non-0 on failure
256 *
257 * Status: OPTIONAL
258 */
259 int (* target_alloc)(struct scsi_target *);
260
261 /*
262 * Immediately prior to deallocating the target structure, and
263 * after all activity to attached scsi devices has ceased, the
264 * midlayer calls this point so that the driver may deallocate
265 * and terminate any references to the target.
266 *
267 * Status: OPTIONAL
268 */
269 void (* target_destroy)(struct scsi_target *);
270
271 /*
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700272 * If a host has the ability to discover targets on its own instead
273 * of scanning the entire bus, it can fill in this function and
274 * call scsi_scan_host(). This function will be called periodically
275 * until it returns 1 with the scsi_host and the elapsed time of
276 * the scan in jiffies.
277 *
278 * Status: OPTIONAL
279 */
280 int (* scan_finished)(struct Scsi_Host *, unsigned long);
281
282 /*
283 * If the host wants to be called before the scan starts, but
284 * after the midlayer has set up ready for the scan, it can fill
285 * in this function.
Pavel Machekd850bd32008-02-04 23:53:24 -0800286 *
287 * Status: OPTIONAL
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700288 */
289 void (* scan_start)(struct Scsi_Host *);
290
291 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800292 * Fill in this function to allow the queue depth of this host
293 * to be changeable (on a per device basis). Returns either
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 * the current queue depth setting (may be different from what
295 * was passed in) or an error. An error should only be
296 * returned if the requested depth is legal but the driver was
297 * unable to set it. If the requested depth is illegal, the
298 * driver should set and return the closest legal queue depth.
299 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800300 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 */
Mike Christiee881a172009-10-15 17:46:39 -0700302 int (* change_queue_depth)(struct scsi_device *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800305 * Fill in this function to allow the changing of tag types
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 * (this also allows the enabling/disabling of tag command
307 * queueing). An error should only be returned if something
308 * went wrong in the driver while trying to set the tag type.
309 * If the driver doesn't support the requested tag type, then
310 * it should set the closest type it does support without
311 * returning an error. Returns the actual tag type set.
Pavel Machekd850bd32008-02-04 23:53:24 -0800312 *
313 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 */
315 int (* change_queue_type)(struct scsi_device *, int);
316
317 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800318 * This function determines the BIOS parameters for a given
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * harddisk. These tend to be numbers that are made up by
320 * the host adapter. Parameters:
321 * size, device, list (heads, sectors, cylinders)
322 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800323 * Status: OPTIONAL
324 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 int (* bios_param)(struct scsi_device *, struct block_device *,
326 sector_t, int []);
327
328 /*
Tejun Heo72ec24b2010-05-15 20:09:32 +0200329 * This function is called when one or more partitions on the
330 * device reach beyond the end of the device.
331 *
332 * Status: OPTIONAL
333 */
334 void (*unlock_native_capacity)(struct scsi_device *);
335
336 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 * Can be used to export driver statistics and other infos to the
338 * world outside the kernel ie. userspace and it also provides an
339 * interface to feed the driver with information.
340 *
341 * Status: OBSOLETE
342 */
343 int (*proc_info)(struct Scsi_Host *, char *, char **, off_t, int, int);
344
345 /*
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500346 * This is an optional routine that allows the transport to become
347 * involved when a scsi io timer fires. The return value tells the
348 * timer routine how to finish the io timeout handling:
349 * EH_HANDLED: I fixed the error, please complete the command
350 * EH_RESET_TIMER: I need more time, reset the timer and
351 * begin counting again
352 * EH_NOT_HANDLED Begin normal error recovery
353 *
354 * Status: OPTIONAL
355 */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700356 enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500357
Vikas Chaudhary29443692011-08-12 02:51:28 -0700358 /* This is an optional routine that allows transport to initiate
359 * LLD adapter or firmware reset using sysfs attribute.
360 *
361 * Return values: 0 on success, -ve value on failure.
362 *
363 * Status: OPTIONAL
364 */
365
366 int (*host_reset)(struct Scsi_Host *shost, int reset_type);
367#define SCSI_ADAPTER_RESET 1
368#define SCSI_FIRMWARE_RESET 2
369
370
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500371 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 * Name of proc directory
373 */
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -0400374 const char *proc_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 /*
377 * Used to store the procfs directory if a driver implements the
378 * proc_info method.
379 */
380 struct proc_dir_entry *proc_dir;
381
382 /*
383 * This determines if we will use a non-interrupt driven
Pavel Machekd850bd32008-02-04 23:53:24 -0800384 * or an interrupt driven scheme. It is set to the maximum number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 * of simultaneous commands a given host adapter will accept.
386 */
387 int can_queue;
388
389 /*
390 * In many instances, especially where disconnect / reconnect are
391 * supported, our host also has an ID on the SCSI bus. If this is
392 * the case, then it must be reserved. Please set this_id to -1 if
393 * your setup is in single initiator mode, and the host lacks an
394 * ID.
395 */
396 int this_id;
397
398 /*
399 * This determines the degree to which the host adapter is capable
400 * of scatter-gather.
401 */
402 unsigned short sg_tablesize;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200403 unsigned short sg_prot_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800406 * Set this if the host adapter has limitations beside segment count.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 */
408 unsigned short max_sectors;
409
410 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800411 * DMA scatter gather segment boundary limit. A segment crossing this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 * boundary will be split in two.
413 */
414 unsigned long dma_boundary;
415
416 /*
417 * This specifies "machine infinity" for host templates which don't
418 * limit the transfer size. Note this limit represents an absolute
419 * maximum, and may be over the transfer limits allowed for
Pavel Machekd850bd32008-02-04 23:53:24 -0800420 * individual devices (e.g. 256 for SCSI-1).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 */
422#define SCSI_DEFAULT_MAX_SECTORS 1024
423
424 /*
425 * True if this host adapter can make good use of linked commands.
426 * This will allow more than one command to be queued to a given
427 * unit on a given host. Set this to the maximum number of command
428 * blocks to be provided for each device. Set this to 1 for one
429 * command block per lun, 2 for two, etc. Do not set this to 0.
430 * You should make sure that the host adapter will do the right thing
431 * before you try setting this above 1.
432 */
433 short cmd_per_lun;
434
435 /*
436 * present contains counter indicating how many boards of this
437 * type were found when we did the scan.
438 */
439 unsigned char present;
440
441 /*
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900442 * This specifies the mode that a LLD supports.
443 */
444 unsigned supported_mode:2;
445
446 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800447 * True if this host adapter uses unchecked DMA onto an ISA bus.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 */
449 unsigned unchecked_isa_dma:1;
450
451 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800452 * True if this host adapter can make good use of clustering.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 * I originally thought that if the tablesize was large that it
454 * was a waste of CPU cycles to prepare a cluster list, but
455 * it works out that the Buslogic is faster if you use a smaller
456 * number of segments (i.e. use clustering). I guess it is
457 * inefficient.
458 */
459 unsigned use_clustering:1;
460
461 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800462 * True for emulated SCSI host adapters (e.g. ATAPI).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 */
464 unsigned emulated:1;
465
466 /*
467 * True if the low-level driver performs its own reset-settle delays.
468 */
469 unsigned skip_settle_delay:1;
470
471 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800472 * True if we are using ordered write support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 unsigned ordered_tag:1;
475
476 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800477 * Countdown for host blocking with no commands outstanding.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 */
479 unsigned int max_host_blocked;
480
481 /*
482 * Default value for the blocking. If the queue is empty,
483 * host_blocked counts down in the request_fn until it restarts
484 * host operations as zero is reached.
485 *
486 * FIXME: This should probably be a value in the template
487 */
488#define SCSI_DEFAULT_HOST_BLOCKED 7
489
490 /*
491 * Pointer to the sysfs class properties for this host, NULL terminated.
492 */
Tony Jonesee959b02008-02-22 00:13:36 +0100493 struct device_attribute **shost_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495 /*
496 * Pointer to the SCSI device properties for this host, NULL terminated.
497 */
498 struct device_attribute **sdev_attrs;
499
500 /*
501 * List of hosts per template.
502 *
503 * This is only for use by scsi_module.c for legacy templates.
504 * For these access to it is synchronized implicitly by
505 * module_init/module_exit.
506 */
507 struct list_head legacy_hosts;
James Smart9e4f5e22009-03-26 13:33:19 -0400508
509 /*
510 * Vendor Identifier associated with the host
511 *
512 * Note: When specifying vendor_id, be sure to read the
513 * Vendor Type and ID formatting requirements specified in
514 * scsi_netlink.h
515 */
516 u64 vendor_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517};
518
519/*
Jeff Garzikf2812332010-11-16 02:10:29 -0500520 * Temporary #define for host lock push down. Can be removed when all
521 * drivers have been updated to take advantage of unlocked
522 * queuecommand.
523 *
524 */
525#define DEF_SCSI_QCMD(func_name) \
526 int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd) \
527 { \
528 unsigned long irq_flags; \
529 int rc; \
530 spin_lock_irqsave(shost->host_lock, irq_flags); \
531 scsi_cmd_get_serial(shost, cmd); \
532 rc = func_name##_lck (cmd, cmd->scsi_done); \
533 spin_unlock_irqrestore(shost->host_lock, irq_flags); \
534 return rc; \
535 }
536
537
538/*
Mike Andersond3301872005-06-16 11:12:38 -0700539 * shost state: If you alter this, you also need to alter scsi_sysfs.c
540 * (for the ascii descriptions) and the state model enforcer:
541 * scsi_host_set_state()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 */
Mike Andersond3301872005-06-16 11:12:38 -0700543enum scsi_host_state {
544 SHOST_CREATED = 1,
545 SHOST_RUNNING,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 SHOST_CANCEL,
Mike Andersond3301872005-06-16 11:12:38 -0700547 SHOST_DEL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 SHOST_RECOVERY,
James Bottomley939647e2005-09-18 15:05:20 -0500549 SHOST_CANCEL_RECOVERY,
550 SHOST_DEL_RECOVERY,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551};
552
553struct Scsi_Host {
554 /*
555 * __devices is protected by the host_lock, but you should
556 * usually use scsi_device_lookup / shost_for_each_device
557 * to access it and don't care about locking yourself.
558 * In the rare case of beeing in irq context you can use
559 * their __ prefixed variants with the lock held. NEVER
560 * access this list directly from a driver.
561 */
562 struct list_head __devices;
563 struct list_head __targets;
564
565 struct scsi_host_cmd_pool *cmd_pool;
566 spinlock_t free_list_lock;
567 struct list_head free_list; /* backup store of cmd structs */
568 struct list_head starved_list;
569
570 spinlock_t default_lock;
571 spinlock_t *host_lock;
572
Arjan van de Ven0b950672006-01-11 13:16:10 +0100573 struct mutex scan_mutex;/* serialize scanning activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
575 struct list_head eh_cmd_q;
576 struct task_struct * ehandler; /* Error recovery thread. */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100577 struct completion * eh_action; /* Wait for specific actions on the
578 host. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 wait_queue_head_t host_wait;
580 struct scsi_host_template *hostt;
581 struct scsi_transport_template *transportt;
06f81ea2005-04-17 14:57:29 -0500582
583 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800584 * Area to keep a shared tag map (if needed, will be
585 * NULL if not).
James Bottomley86e33a22006-08-30 09:45:51 -0400586 */
587 struct blk_queue_tag *bqt;
588
589 /*
06f81ea2005-04-17 14:57:29 -0500590 * The following two fields are protected with host_lock;
591 * however, eh routines can safely access during eh processing
592 * without acquiring the lock.
593 */
594 unsigned int host_busy; /* commands actually active on low-level */
595 unsigned int host_failed; /* commands that failed. */
Tejun Heoee7863b2006-05-15 20:57:20 +0900596 unsigned int host_eh_scheduled; /* EH scheduled without command */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Matthew Wilcox6d49f632008-07-15 14:54:16 -0600598 unsigned int host_no; /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 int resetting; /* if set, it means that last_reset is a valid value */
600 unsigned long last_reset;
601
602 /*
603 * These three parameters can be used to allow for wide scsi,
604 * and for host adapters that support multiple busses
605 * The first two should be set to 1 more than the actual max id
606 * or lun (i.e. 8 for normal systems).
607 */
608 unsigned int max_id;
609 unsigned int max_lun;
610 unsigned int max_channel;
611
612 /*
613 * This is a unique identifier that must be assigned so that we
614 * have some way of identifying each detected host adapter properly
615 * and uniquely. For hosts that do not support more than one card
616 * in the system at one time, this does not need to be set. It is
617 * initialized to 0 in scsi_register.
618 */
619 unsigned int unique_id;
620
621 /*
622 * The maximum length of SCSI commands that this host can accept.
623 * Probably 12 for most host adapters, but could be 16 for others.
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300624 * or 260 if the driver supports variable length cdbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 * For drivers that don't set this field, a value of 12 is
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300626 * assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627 */
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300628 unsigned short max_cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630 int this_id;
631 int can_queue;
632 short cmd_per_lun;
633 short unsigned int sg_tablesize;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200634 short unsigned int sg_prot_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 short unsigned int max_sectors;
636 unsigned long dma_boundary;
637 /*
638 * Used to assign serial numbers to the cmds.
639 * Protected by the host lock.
640 */
Matthew Wilcox12a44162007-09-18 19:54:43 -0600641 unsigned long cmd_serial_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900643 unsigned active_mode:2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 unsigned unchecked_isa_dma:1;
645 unsigned use_clustering:1;
646 unsigned use_blk_tcq:1;
647
648 /*
649 * Host has requested that no further requests come through for the
650 * time being.
651 */
652 unsigned host_self_blocked:1;
653
654 /*
655 * Host uses correct SCSI ordering not PC ordering. The bit is
656 * set for the minority of drivers whose authors actually read
Pavel Machekd850bd32008-02-04 23:53:24 -0800657 * the spec ;).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 */
659 unsigned reverse_ordering:1;
660
661 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800662 * Ordered write support
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 unsigned ordered_tag:1;
665
Pavel Machekd850bd32008-02-04 23:53:24 -0800666 /* Task mgmt function in progress */
James Smartd7a1bb02006-03-08 14:50:12 -0500667 unsigned tmf_in_progress:1;
668
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600669 /* Asynchronous scan in progress */
670 unsigned async_scan:1;
671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 /*
673 * Optional work queue to be utilized by the transport
674 */
Kay Sieversaab0de22008-05-02 06:02:41 +0200675 char work_q_name[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 struct workqueue_struct *work_q;
677
678 /*
679 * Host has rejected a command because it was busy.
680 */
681 unsigned int host_blocked;
682
683 /*
684 * Value host_blocked counts down from
685 */
686 unsigned int max_host_blocked;
687
Martin K. Petersen4469f982008-07-17 04:28:30 -0400688 /* Protection Information */
689 unsigned int prot_capabilities;
690 unsigned char prot_guard_type;
691
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900692 /*
693 * q used for scsi_tgt msgs, async events or any other requests that
694 * need to be processed in userspace
695 */
696 struct request_queue *uspace_req_q;
697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 /* legacy crap */
699 unsigned long base;
700 unsigned long io_port;
701 unsigned char n_io_port;
702 unsigned char dma_channel;
703 unsigned int irq;
704
705
Mike Andersond3301872005-06-16 11:12:38 -0700706 enum scsi_host_state shost_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708 /* ldm bits */
Tony Jonesee959b02008-02-22 00:13:36 +0100709 struct device shost_gendev, shost_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
711 /*
712 * List of hosts per template.
713 *
714 * This is only for use by scsi_module.c for legacy templates.
715 * For these access to it is synchronized implicitly by
716 * module_init/module_exit.
717 */
718 struct list_head sht_legacy_list;
719
720 /*
721 * Points to the transport data (if any) which is allocated
722 * separately
723 */
724 void *shost_data;
725
726 /*
James Bottomleyd139b9b2009-11-05 13:33:12 -0600727 * Points to the physical bus device we'd use to do DMA
728 * Needed just in case we have virtual hosts.
729 */
730 struct device *dma_dev;
731
732 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 * We should ensure that this is aligned, both for better performance
734 * and also because some compilers (m68k) don't automatically force
735 * alignment to a long boundary.
736 */
737 unsigned long hostdata[0] /* Used for storage of host specific stuff */
738 __attribute__ ((aligned (sizeof(unsigned long))));
739};
740
741#define class_to_shost(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100742 container_of(d, struct Scsi_Host, shost_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
James Bottomley9ccfc752005-10-02 11:45:08 -0500744#define shost_printk(prefix, shost, fmt, a...) \
745 dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)
746
Christoph Hellwigbcd92c92007-05-31 20:12:26 +0200747static inline void *shost_priv(struct Scsi_Host *shost)
748{
749 return (void *)shost->hostdata;
750}
James Bottomley9ccfc752005-10-02 11:45:08 -0500751
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752int scsi_is_host_device(const struct device *);
753
754static inline struct Scsi_Host *dev_to_shost(struct device *dev)
755{
756 while (!scsi_is_host_device(dev)) {
757 if (!dev->parent)
758 return NULL;
759 dev = dev->parent;
760 }
761 return container_of(dev, struct Scsi_Host, shost_gendev);
762}
763
James Bottomley939647e2005-09-18 15:05:20 -0500764static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
765{
766 return shost->shost_state == SHOST_RECOVERY ||
767 shost->shost_state == SHOST_CANCEL_RECOVERY ||
James Smartd7a1bb02006-03-08 14:50:12 -0500768 shost->shost_state == SHOST_DEL_RECOVERY ||
769 shost->tmf_in_progress;
James Bottomley939647e2005-09-18 15:05:20 -0500770}
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
773extern void scsi_flush_work(struct Scsi_Host *);
774
775extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
James Bottomleyd139b9b2009-11-05 13:33:12 -0600776extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *,
777 struct device *,
778 struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779extern void scsi_scan_host(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780extern void scsi_rescan_device(struct device *);
781extern void scsi_remove_host(struct Scsi_Host *);
782extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
783extern void scsi_host_put(struct Scsi_Host *t);
784extern struct Scsi_Host *scsi_host_lookup(unsigned short);
Mike Andersond3301872005-06-16 11:12:38 -0700785extern const char *scsi_host_state_name(enum scsi_host_state);
Jeff Garzikf2812332010-11-16 02:10:29 -0500786extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788extern u64 scsi_calculate_bounce_limit(struct Scsi_Host *);
789
James Bottomleyd139b9b2009-11-05 13:33:12 -0600790static inline int __must_check scsi_add_host(struct Scsi_Host *host,
791 struct device *dev)
792{
793 return scsi_add_host_with_dma(host, dev, dev);
794}
795
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796static inline struct device *scsi_get_device(struct Scsi_Host *shost)
797{
798 return shost->shost_gendev.parent;
799}
800
Mike Anderson82f29462005-06-16 11:14:33 -0700801/**
802 * scsi_host_scan_allowed - Is scanning of this host allowed
803 * @shost: Pointer to Scsi_Host.
804 **/
805static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
806{
Mike Christie76e4e122011-08-25 00:36:38 -0500807 return shost->shost_state == SHOST_RUNNING ||
808 shost->shost_state == SHOST_RECOVERY;
Mike Anderson82f29462005-06-16 11:14:33 -0700809}
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811extern void scsi_unblock_requests(struct Scsi_Host *);
812extern void scsi_block_requests(struct Scsi_Host *);
813
814struct class_container;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900815
816extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
817 void (*) (struct request_queue *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818/*
819 * These two functions are used to allocate and free a pseudo device
820 * which will connect to the host adapter itself rather than any
821 * physical device. You must deallocate when you are done with the
822 * thing. This physical pseudo-device isn't real and won't be available
823 * from any high-level drivers.
824 */
825extern void scsi_free_host_dev(struct scsi_device *);
826extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
827
Martin K. Petersen4469f982008-07-17 04:28:30 -0400828/*
829 * DIF defines the exchange of protection information between
830 * initiator and SBC block device.
831 *
832 * DIX defines the exchange of protection information between OS and
833 * initiator.
834 */
835enum scsi_host_prot_capabilities {
836 SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
837 SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
838 SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */
839
840 SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
841 SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
842 SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
843 SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
844};
845
846/*
847 * SCSI hosts which support the Data Integrity Extensions must
848 * indicate their capabilities by setting the prot_capabilities using
849 * this call.
850 */
851static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
852{
853 shost->prot_capabilities = mask;
854}
855
856static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
857{
858 return shost->prot_capabilities;
859}
860
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200861static inline int scsi_host_prot_dma(struct Scsi_Host *shost)
862{
863 return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION;
864}
865
Martin K. Petersen4469f982008-07-17 04:28:30 -0400866static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
867{
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400868 static unsigned char cap[] = { 0,
869 SHOST_DIF_TYPE1_PROTECTION,
870 SHOST_DIF_TYPE2_PROTECTION,
871 SHOST_DIF_TYPE3_PROTECTION };
Martin K. Petersen4469f982008-07-17 04:28:30 -0400872
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400873 return shost->prot_capabilities & cap[target_type] ? target_type : 0;
Martin K. Petersen4469f982008-07-17 04:28:30 -0400874}
875
876static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
877{
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400878#if defined(CONFIG_BLK_DEV_INTEGRITY)
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400879 static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
880 SHOST_DIX_TYPE1_PROTECTION,
881 SHOST_DIX_TYPE2_PROTECTION,
882 SHOST_DIX_TYPE3_PROTECTION };
883
884 return shost->prot_capabilities & cap[target_type];
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400885#endif
Martin K. Petersen4469f982008-07-17 04:28:30 -0400886 return 0;
887}
888
889/*
890 * All DIX-capable initiators must support the T10-mandated CRC
891 * checksum. Controllers can optionally implement the IP checksum
892 * scheme which has much lower impact on system performance. Note
893 * that the main rationale for the checksum is to match integrity
894 * metadata with data. Detecting bit errors are a job for ECC memory
895 * and buses.
896 */
897
898enum scsi_host_guard_type {
899 SHOST_DIX_GUARD_CRC = 1 << 0,
900 SHOST_DIX_GUARD_IP = 1 << 1,
901};
902
903static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
904{
905 shost->prot_guard_type = type;
906}
907
908static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
909{
910 return shost->prot_guard_type;
911}
912
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913/* legacy interfaces */
914extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
915extern void scsi_unregister(struct Scsi_Host *);
James Bottomley47ba39e2005-07-30 11:39:53 -0500916extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
918#endif /* _SCSI_SCSI_HOST_H */