blob: 546084964d554fc8e463e9244558fce4e4eb8563 [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>
Al Viro0ffddfb2013-03-30 23:58:05 -04009#include <linux/seq_file.h>
James Bottomley4660c8e2008-02-10 09:42:46 -060010#include <scsi/scsi.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
FUJITA Tomonorib58d9152006-11-16 19:24:10 +090012struct request_queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013struct block_device;
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +010014struct completion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct module;
16struct scsi_cmnd;
17struct scsi_device;
James Bottomleya283bd32005-05-24 12:06:38 -050018struct scsi_target;
Linus Torvalds1da177e2005-04-16 15:20:36 -070019struct Scsi_Host;
20struct scsi_host_cmd_pool;
21struct scsi_transport_template;
James Bottomley86e33a22006-08-30 09:45:51 -040022struct blk_queue_tags;
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
24
25/*
26 * The various choices mean:
27 * NONE: Self evident. Host adapter is not capable of scatter-gather.
28 * ALL: Means that the host adapter module can do scatter-gather,
29 * and that there is no limit to the size of the table to which
James Bottomley4660c8e2008-02-10 09:42:46 -060030 * we scatter/gather data. The value we set here is the maximum
31 * single element sglist. To use chained sglists, the adapter
32 * has to set a value beyond ALL (and correctly use the chain
33 * handling API.
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 * Anything else: Indicates the maximum number of chains that can be
35 * used in one scatter-gather request.
36 */
37#define SG_NONE 0
James Bottomley4660c8e2008-02-10 09:42:46 -060038#define SG_ALL SCSI_MAX_SG_SEGMENTS
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +090040#define MODE_UNKNOWN 0x00
41#define MODE_INITIATOR 0x01
42#define MODE_TARGET 0x02
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
44#define DISABLE_CLUSTERING 0
45#define ENABLE_CLUSTERING 1
46
Mike Christiee881a172009-10-15 17:46:39 -070047enum {
48 SCSI_QDEPTH_DEFAULT, /* default requested change, e.g. from sysfs */
49 SCSI_QDEPTH_QFULL, /* scsi-ml requested due to queue full */
Lucas De Marchi25985ed2011-03-30 22:57:33 -030050 SCSI_QDEPTH_RAMP_UP, /* scsi-ml requested due to threshold event */
Mike Christiee881a172009-10-15 17:46:39 -070051};
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053struct scsi_host_template {
54 struct module *module;
55 const char *name;
56
57 /*
58 * Used to initialize old-style drivers. For new-style drivers
59 * just perform all work in your module initialization function.
60 *
61 * Status: OBSOLETE
62 */
63 int (* detect)(struct scsi_host_template *);
64
65 /*
66 * Used as unload callback for hosts with old-style drivers.
67 *
68 * Status: OBSOLETE
69 */
70 int (* release)(struct Scsi_Host *);
71
72 /*
73 * The info function will return whatever useful information the
74 * developer sees fit. If not provided, then the name field will
75 * be used instead.
76 *
77 * Status: OPTIONAL
78 */
79 const char *(* info)(struct Scsi_Host *);
80
81 /*
82 * Ioctl interface
83 *
84 * Status: OPTIONAL
85 */
86 int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
87
88
89#ifdef CONFIG_COMPAT
90 /*
91 * Compat handler. Handle 32bit ABI.
92 * When unknown ioctl is passed return -ENOIOCTLCMD.
93 *
94 * Status: OPTIONAL
95 */
96 int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
97#endif
98
99 /*
100 * The queuecommand function is used to queue up a scsi
101 * command block to the LLDD. When the driver finished
102 * processing the command the done callback is invoked.
103 *
104 * If queuecommand returns 0, then the HBA has accepted the
105 * command. The done() function must be called on the command
106 * when the driver has finished with it. (you may call done on the
107 * command before queuecommand returns, but in this case you
108 * *must* return 0 from queuecommand).
109 *
110 * Queuecommand may also reject the command, in which case it may
111 * not touch the command and must not call done() for it.
112 *
113 * There are two possible rejection returns:
114 *
115 * SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
116 * allow commands to other devices serviced by this host.
117 *
118 * SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
119 * host temporarily.
120 *
121 * For compatibility, any other non-zero return is treated the
122 * same as SCSI_MLQUEUE_HOST_BUSY.
123 *
124 * NOTE: "temporarily" means either until the next command for#
125 * this device/host completes, or a period of time determined by
126 * I/O pressure in the system if there are no other outstanding
127 * commands.
128 *
129 * STATUS: REQUIRED
130 */
Jeff Garzikf2812332010-11-16 02:10:29 -0500131 int (* queuecommand)(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 /*
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900134 * The transfer functions are used to queue a scsi command to
135 * the LLD. When the driver is finished processing the command
136 * the done callback is invoked.
137 *
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900138 * This is called to inform the LLD to transfer
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200139 * scsi_bufflen(cmd) bytes. scsi_sg_count(cmd) speciefies the
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900140 * number of scatterlist entried in the command and
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200141 * scsi_sglist(cmd) returns the scatterlist.
FUJITA Tomonoribc7e3802007-03-03 09:55:54 +0900142 *
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900143 * return values: see queuecommand
144 *
145 * If the LLD accepts the cmd, it should set the result to an
146 * appropriate value when completed before calling the done function.
147 *
148 * STATUS: REQUIRED FOR TARGET DRIVERS
149 */
150 /* TODO: rename */
151 int (* transfer_response)(struct scsi_cmnd *,
152 void (*done)(struct scsi_cmnd *));
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900153
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900154 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 * This is an error handling strategy routine. You don't need to
156 * define one of these if you don't want to - there is a default
157 * routine that is present that should work in most cases. For those
158 * driver authors that have the inclination and ability to write their
159 * own strategy routine, this is where it is specified. Note - the
160 * strategy routine is *ALWAYS* run in the context of the kernel eh
161 * thread. Thus you are guaranteed to *NOT* be in an interrupt
162 * handler when you execute this, and you are also guaranteed to
163 * *NOT* have any other commands being queued while you are in the
164 * strategy routine. When you return from this function, operations
165 * return to normal.
166 *
167 * See scsi_error.c scsi_unjam_host for additional comments about
168 * what this function should and should not be attempting to do.
169 *
170 * Status: REQUIRED (at least one of them)
171 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 int (* eh_abort_handler)(struct scsi_cmnd *);
173 int (* eh_device_reset_handler)(struct scsi_cmnd *);
Mike Christie30bd7df2008-02-29 18:25:19 -0600174 int (* eh_target_reset_handler)(struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 int (* eh_bus_reset_handler)(struct scsi_cmnd *);
176 int (* eh_host_reset_handler)(struct scsi_cmnd *);
177
178 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 * Before the mid layer attempts to scan for a new device where none
180 * currently exists, it will call this entry in your driver. Should
181 * your driver need to allocate any structs or perform any other init
182 * items in order to send commands to a currently unused target/lun
183 * combo, then this is where you can perform those allocations. This
184 * is specifically so that drivers won't have to perform any kind of
185 * "is this a new device" checks in their queuecommand routine,
186 * thereby making the hot path a bit quicker.
187 *
188 * Return values: 0 on success, non-0 on failure
189 *
190 * Deallocation: If we didn't find any devices at this ID, you will
191 * get an immediate call to slave_destroy(). If we find something
192 * here then you will get a call to slave_configure(), then the
193 * device will be used for however long it is kept around, then when
194 * the device is removed from the system (or * possibly at reboot
195 * time), you will then get a call to slave_destroy(). This is
196 * assuming you implement slave_configure and slave_destroy.
197 * However, if you allocate memory and hang it off the device struct,
198 * then you must implement the slave_destroy() routine at a minimum
199 * in order to avoid leaking memory
200 * each time a device is tore down.
201 *
202 * Status: OPTIONAL
203 */
204 int (* slave_alloc)(struct scsi_device *);
205
206 /*
207 * Once the device has responded to an INQUIRY and we know the
208 * device is online, we call into the low level driver with the
209 * struct scsi_device *. If the low level device driver implements
210 * this function, it *must* perform the task of setting the queue
211 * depth on the device. All other tasks are optional and depend
212 * on what the driver supports and various implementation details.
213 *
214 * Things currently recommended to be handled at this time include:
215 *
216 * 1. Setting the device queue depth. Proper setting of this is
217 * described in the comments for scsi_adjust_queue_depth.
218 * 2. Determining if the device supports the various synchronous
219 * negotiation protocols. The device struct will already have
220 * responded to INQUIRY and the results of the standard items
221 * will have been shoved into the various device flag bits, eg.
222 * device->sdtr will be true if the device supports SDTR messages.
223 * 3. Allocating command structs that the device will need.
224 * 4. Setting the default timeout on this device (if needed).
225 * 5. Anything else the low level driver might want to do on a device
226 * specific setup basis...
227 * 6. Return 0 on success, non-0 on error. The device will be marked
228 * as offline on error so that no access will occur. If you return
229 * non-0, your slave_destroy routine will never get called for this
230 * device, so don't leave any loose memory hanging around, clean
231 * up after yourself before returning non-0
232 *
233 * Status: OPTIONAL
234 */
235 int (* slave_configure)(struct scsi_device *);
236
237 /*
238 * Immediately prior to deallocating the device and after all activity
239 * has ceased the mid layer calls this point so that the low level
240 * driver may completely detach itself from the scsi device and vice
241 * versa. The low level driver is responsible for freeing any memory
242 * it allocated in the slave_alloc or slave_configure calls.
243 *
244 * Status: OPTIONAL
245 */
246 void (* slave_destroy)(struct scsi_device *);
247
248 /*
James Bottomleya283bd32005-05-24 12:06:38 -0500249 * Before the mid layer attempts to scan for a new device attached
250 * to a target where no target currently exists, it will call this
251 * entry in your driver. Should your driver need to allocate any
252 * structs or perform any other init items in order to send commands
253 * to a currently unused target, then this is where you can perform
254 * those allocations.
255 *
256 * Return values: 0 on success, non-0 on failure
257 *
258 * Status: OPTIONAL
259 */
260 int (* target_alloc)(struct scsi_target *);
261
262 /*
263 * Immediately prior to deallocating the target structure, and
264 * after all activity to attached scsi devices has ceased, the
265 * midlayer calls this point so that the driver may deallocate
266 * and terminate any references to the target.
267 *
268 * Status: OPTIONAL
269 */
270 void (* target_destroy)(struct scsi_target *);
271
272 /*
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700273 * If a host has the ability to discover targets on its own instead
274 * of scanning the entire bus, it can fill in this function and
275 * call scsi_scan_host(). This function will be called periodically
276 * until it returns 1 with the scsi_host and the elapsed time of
277 * the scan in jiffies.
278 *
279 * Status: OPTIONAL
280 */
281 int (* scan_finished)(struct Scsi_Host *, unsigned long);
282
283 /*
284 * If the host wants to be called before the scan starts, but
285 * after the midlayer has set up ready for the scan, it can fill
286 * in this function.
Pavel Machekd850bd32008-02-04 23:53:24 -0800287 *
288 * Status: OPTIONAL
Matthew Wilcox1aa8fab2006-11-22 13:24:54 -0700289 */
290 void (* scan_start)(struct Scsi_Host *);
291
292 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800293 * Fill in this function to allow the queue depth of this host
294 * to be changeable (on a per device basis). Returns either
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 * the current queue depth setting (may be different from what
296 * was passed in) or an error. An error should only be
297 * returned if the requested depth is legal but the driver was
298 * unable to set it. If the requested depth is illegal, the
299 * driver should set and return the closest legal queue depth.
300 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800301 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 */
Mike Christiee881a172009-10-15 17:46:39 -0700303 int (* change_queue_depth)(struct scsi_device *, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
305 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800306 * Fill in this function to allow the changing of tag types
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 * (this also allows the enabling/disabling of tag command
308 * queueing). An error should only be returned if something
309 * went wrong in the driver while trying to set the tag type.
310 * If the driver doesn't support the requested tag type, then
311 * it should set the closest type it does support without
312 * returning an error. Returns the actual tag type set.
Pavel Machekd850bd32008-02-04 23:53:24 -0800313 *
314 * Status: OPTIONAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 */
316 int (* change_queue_type)(struct scsi_device *, int);
317
318 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800319 * This function determines the BIOS parameters for a given
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * harddisk. These tend to be numbers that are made up by
321 * the host adapter. Parameters:
322 * size, device, list (heads, sectors, cylinders)
323 *
Pavel Machekd850bd32008-02-04 23:53:24 -0800324 * Status: OPTIONAL
325 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 int (* bios_param)(struct scsi_device *, struct block_device *,
327 sector_t, int []);
328
329 /*
Tejun Heo72ec24b2010-05-15 20:09:32 +0200330 * This function is called when one or more partitions on the
331 * device reach beyond the end of the device.
332 *
333 * Status: OPTIONAL
334 */
335 void (*unlock_native_capacity)(struct scsi_device *);
336
337 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 * Can be used to export driver statistics and other infos to the
339 * world outside the kernel ie. userspace and it also provides an
340 * interface to feed the driver with information.
341 *
342 * Status: OBSOLETE
343 */
Al Viro0ffddfb2013-03-30 23:58:05 -0400344 int (*show_info)(struct seq_file *, struct Scsi_Host *);
345 int (*write_info)(struct Scsi_Host *, char *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347 /*
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500348 * This is an optional routine that allows the transport to become
349 * involved when a scsi io timer fires. The return value tells the
350 * timer routine how to finish the io timeout handling:
351 * EH_HANDLED: I fixed the error, please complete the command
352 * EH_RESET_TIMER: I need more time, reset the timer and
353 * begin counting again
354 * EH_NOT_HANDLED Begin normal error recovery
355 *
356 * Status: OPTIONAL
357 */
Jens Axboe242f9dc2008-09-14 05:55:09 -0700358 enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500359
Vikas Chaudhary29443692011-08-12 02:51:28 -0700360 /* This is an optional routine that allows transport to initiate
361 * LLD adapter or firmware reset using sysfs attribute.
362 *
363 * Return values: 0 on success, -ve value on failure.
364 *
365 * Status: OPTIONAL
366 */
367
368 int (*host_reset)(struct Scsi_Host *shost, int reset_type);
369#define SCSI_ADAPTER_RESET 1
370#define SCSI_FIRMWARE_RESET 2
371
372
James Bottomley6c5f8ce2007-03-16 17:44:41 -0500373 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * Name of proc directory
375 */
Kristian Høgsbergb02b6bc2007-05-09 19:23:12 -0400376 const char *proc_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 /*
379 * Used to store the procfs directory if a driver implements the
Al Viro70ef4572013-03-31 13:27:56 -0400380 * show_info method.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 */
382 struct proc_dir_entry *proc_dir;
383
384 /*
385 * This determines if we will use a non-interrupt driven
Pavel Machekd850bd32008-02-04 23:53:24 -0800386 * or an interrupt driven scheme. It is set to the maximum number
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 * of simultaneous commands a given host adapter will accept.
388 */
389 int can_queue;
390
391 /*
392 * In many instances, especially where disconnect / reconnect are
393 * supported, our host also has an ID on the SCSI bus. If this is
394 * the case, then it must be reserved. Please set this_id to -1 if
395 * your setup is in single initiator mode, and the host lacks an
396 * ID.
397 */
398 int this_id;
399
400 /*
401 * This determines the degree to which the host adapter is capable
402 * of scatter-gather.
403 */
404 unsigned short sg_tablesize;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200405 unsigned short sg_prot_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800408 * Set this if the host adapter has limitations beside segment count.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 */
410 unsigned short max_sectors;
411
412 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800413 * DMA scatter gather segment boundary limit. A segment crossing this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 * boundary will be split in two.
415 */
416 unsigned long dma_boundary;
417
418 /*
419 * This specifies "machine infinity" for host templates which don't
420 * limit the transfer size. Note this limit represents an absolute
421 * maximum, and may be over the transfer limits allowed for
Pavel Machekd850bd32008-02-04 23:53:24 -0800422 * individual devices (e.g. 256 for SCSI-1).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 */
424#define SCSI_DEFAULT_MAX_SECTORS 1024
425
426 /*
427 * True if this host adapter can make good use of linked commands.
428 * This will allow more than one command to be queued to a given
429 * unit on a given host. Set this to the maximum number of command
430 * blocks to be provided for each device. Set this to 1 for one
431 * command block per lun, 2 for two, etc. Do not set this to 0.
432 * You should make sure that the host adapter will do the right thing
433 * before you try setting this above 1.
434 */
435 short cmd_per_lun;
436
437 /*
438 * present contains counter indicating how many boards of this
439 * type were found when we did the scan.
440 */
441 unsigned char present;
442
443 /*
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900444 * This specifies the mode that a LLD supports.
445 */
446 unsigned supported_mode:2;
447
448 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800449 * True if this host adapter uses unchecked DMA onto an ISA bus.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 */
451 unsigned unchecked_isa_dma:1;
452
453 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800454 * True if this host adapter can make good use of clustering.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 * I originally thought that if the tablesize was large that it
456 * was a waste of CPU cycles to prepare a cluster list, but
457 * it works out that the Buslogic is faster if you use a smaller
458 * number of segments (i.e. use clustering). I guess it is
459 * inefficient.
460 */
461 unsigned use_clustering:1;
462
463 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800464 * True for emulated SCSI host adapters (e.g. ATAPI).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 */
466 unsigned emulated:1;
467
468 /*
469 * True if the low-level driver performs its own reset-settle delays.
470 */
471 unsigned skip_settle_delay:1;
472
473 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800474 * True if we are using ordered write support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 unsigned ordered_tag:1;
477
478 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800479 * Countdown for host blocking with no commands outstanding.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 */
481 unsigned int max_host_blocked;
482
483 /*
484 * Default value for the blocking. If the queue is empty,
485 * host_blocked counts down in the request_fn until it restarts
486 * host operations as zero is reached.
487 *
488 * FIXME: This should probably be a value in the template
489 */
490#define SCSI_DEFAULT_HOST_BLOCKED 7
491
492 /*
493 * Pointer to the sysfs class properties for this host, NULL terminated.
494 */
Tony Jonesee959b02008-02-22 00:13:36 +0100495 struct device_attribute **shost_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497 /*
498 * Pointer to the SCSI device properties for this host, NULL terminated.
499 */
500 struct device_attribute **sdev_attrs;
501
502 /*
503 * List of hosts per template.
504 *
505 * This is only for use by scsi_module.c for legacy templates.
506 * For these access to it is synchronized implicitly by
507 * module_init/module_exit.
508 */
509 struct list_head legacy_hosts;
James Smart9e4f5e22009-03-26 13:33:19 -0400510
511 /*
512 * Vendor Identifier associated with the host
513 *
514 * Note: When specifying vendor_id, be sure to read the
515 * Vendor Type and ID formatting requirements specified in
516 * scsi_netlink.h
517 */
518 u64 vendor_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519};
520
521/*
Jeff Garzikf2812332010-11-16 02:10:29 -0500522 * Temporary #define for host lock push down. Can be removed when all
523 * drivers have been updated to take advantage of unlocked
524 * queuecommand.
525 *
526 */
527#define DEF_SCSI_QCMD(func_name) \
528 int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd) \
529 { \
530 unsigned long irq_flags; \
531 int rc; \
532 spin_lock_irqsave(shost->host_lock, irq_flags); \
533 scsi_cmd_get_serial(shost, cmd); \
534 rc = func_name##_lck (cmd, cmd->scsi_done); \
535 spin_unlock_irqrestore(shost->host_lock, irq_flags); \
536 return rc; \
537 }
538
539
540/*
Mike Andersond3301872005-06-16 11:12:38 -0700541 * shost state: If you alter this, you also need to alter scsi_sysfs.c
542 * (for the ascii descriptions) and the state model enforcer:
543 * scsi_host_set_state()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 */
Mike Andersond3301872005-06-16 11:12:38 -0700545enum scsi_host_state {
546 SHOST_CREATED = 1,
547 SHOST_RUNNING,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 SHOST_CANCEL,
Mike Andersond3301872005-06-16 11:12:38 -0700549 SHOST_DEL,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 SHOST_RECOVERY,
James Bottomley939647e2005-09-18 15:05:20 -0500551 SHOST_CANCEL_RECOVERY,
552 SHOST_DEL_RECOVERY,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553};
554
555struct Scsi_Host {
556 /*
557 * __devices is protected by the host_lock, but you should
558 * usually use scsi_device_lookup / shost_for_each_device
559 * to access it and don't care about locking yourself.
560 * In the rare case of beeing in irq context you can use
561 * their __ prefixed variants with the lock held. NEVER
562 * access this list directly from a driver.
563 */
564 struct list_head __devices;
565 struct list_head __targets;
566
567 struct scsi_host_cmd_pool *cmd_pool;
568 spinlock_t free_list_lock;
569 struct list_head free_list; /* backup store of cmd structs */
570 struct list_head starved_list;
571
572 spinlock_t default_lock;
573 spinlock_t *host_lock;
574
Arjan van de Ven0b950672006-01-11 13:16:10 +0100575 struct mutex scan_mutex;/* serialize scanning activity */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577 struct list_head eh_cmd_q;
578 struct task_struct * ehandler; /* Error recovery thread. */
Christoph Hellwig7dfdc9a2005-10-31 18:49:52 +0100579 struct completion * eh_action; /* Wait for specific actions on the
580 host. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 wait_queue_head_t host_wait;
582 struct scsi_host_template *hostt;
583 struct scsi_transport_template *transportt;
06f81ea2005-04-17 14:57:29 -0500584
585 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800586 * Area to keep a shared tag map (if needed, will be
587 * NULL if not).
James Bottomley86e33a22006-08-30 09:45:51 -0400588 */
589 struct blk_queue_tag *bqt;
590
591 /*
06f81ea2005-04-17 14:57:29 -0500592 * The following two fields are protected with host_lock;
593 * however, eh routines can safely access during eh processing
594 * without acquiring the lock.
595 */
596 unsigned int host_busy; /* commands actually active on low-level */
597 unsigned int host_failed; /* commands that failed. */
Tejun Heoee7863b2006-05-15 20:57:20 +0900598 unsigned int host_eh_scheduled; /* EH scheduled without command */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Matthew Wilcox6d49f632008-07-15 14:54:16 -0600600 unsigned int host_no; /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Hannes Reineckeb4562022013-10-23 10:51:21 +0200602 /* next two fields are used to bound the time spent in error handling */
603 int eh_deadline;
604 unsigned long last_reset;
605
606
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 /*
608 * These three parameters can be used to allow for wide scsi,
609 * and for host adapters that support multiple busses
610 * The first two should be set to 1 more than the actual max id
611 * or lun (i.e. 8 for normal systems).
612 */
613 unsigned int max_id;
614 unsigned int max_lun;
615 unsigned int max_channel;
616
617 /*
618 * This is a unique identifier that must be assigned so that we
619 * have some way of identifying each detected host adapter properly
620 * and uniquely. For hosts that do not support more than one card
621 * in the system at one time, this does not need to be set. It is
622 * initialized to 0 in scsi_register.
623 */
624 unsigned int unique_id;
625
626 /*
627 * The maximum length of SCSI commands that this host can accept.
628 * Probably 12 for most host adapters, but could be 16 for others.
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300629 * or 260 if the driver supports variable length cdbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 * For drivers that don't set this field, a value of 12 is
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300631 * assumed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 */
Boaz Harroshdb4742d2008-04-30 11:27:26 +0300633 unsigned short max_cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635 int this_id;
636 int can_queue;
637 short cmd_per_lun;
638 short unsigned int sg_tablesize;
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200639 short unsigned int sg_prot_tablesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 short unsigned int max_sectors;
641 unsigned long dma_boundary;
642 /*
643 * Used to assign serial numbers to the cmds.
644 * Protected by the host lock.
645 */
Matthew Wilcox12a44162007-09-18 19:54:43 -0600646 unsigned long cmd_serial_number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
FUJITA Tomonori5dc2b892007-09-01 02:02:20 +0900648 unsigned active_mode:2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 unsigned unchecked_isa_dma:1;
650 unsigned use_clustering:1;
651 unsigned use_blk_tcq:1;
652
653 /*
654 * Host has requested that no further requests come through for the
655 * time being.
656 */
657 unsigned host_self_blocked:1;
658
659 /*
660 * Host uses correct SCSI ordering not PC ordering. The bit is
661 * set for the minority of drivers whose authors actually read
Pavel Machekd850bd32008-02-04 23:53:24 -0800662 * the spec ;).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
664 unsigned reverse_ordering:1;
665
666 /*
Pavel Machekd850bd32008-02-04 23:53:24 -0800667 * Ordered write support
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 unsigned ordered_tag:1;
670
Pavel Machekd850bd32008-02-04 23:53:24 -0800671 /* Task mgmt function in progress */
James Smartd7a1bb02006-03-08 14:50:12 -0500672 unsigned tmf_in_progress:1;
673
Matthew Wilcox3e082a92006-09-28 15:19:20 -0600674 /* Asynchronous scan in progress */
675 unsigned async_scan:1;
676
Lin Mingae0751f2011-12-05 09:20:24 +0800677 /* Don't resume host in EH */
678 unsigned eh_noresume:1;
679
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 /*
681 * Optional work queue to be utilized by the transport
682 */
Kay Sieversaab0de22008-05-02 06:02:41 +0200683 char work_q_name[20];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 struct workqueue_struct *work_q;
685
686 /*
687 * Host has rejected a command because it was busy.
688 */
689 unsigned int host_blocked;
690
691 /*
692 * Value host_blocked counts down from
693 */
694 unsigned int max_host_blocked;
695
Martin K. Petersen4469f982008-07-17 04:28:30 -0400696 /* Protection Information */
697 unsigned int prot_capabilities;
698 unsigned char prot_guard_type;
699
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900700 /*
701 * q used for scsi_tgt msgs, async events or any other requests that
702 * need to be processed in userspace
703 */
704 struct request_queue *uspace_req_q;
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 /* legacy crap */
707 unsigned long base;
708 unsigned long io_port;
709 unsigned char n_io_port;
710 unsigned char dma_channel;
711 unsigned int irq;
712
713
Mike Andersond3301872005-06-16 11:12:38 -0700714 enum scsi_host_state shost_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716 /* ldm bits */
Tony Jonesee959b02008-02-22 00:13:36 +0100717 struct device shost_gendev, shost_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
719 /*
720 * List of hosts per template.
721 *
722 * This is only for use by scsi_module.c for legacy templates.
723 * For these access to it is synchronized implicitly by
724 * module_init/module_exit.
725 */
726 struct list_head sht_legacy_list;
727
728 /*
729 * Points to the transport data (if any) which is allocated
730 * separately
731 */
732 void *shost_data;
733
734 /*
James Bottomleyd139b9b2009-11-05 13:33:12 -0600735 * Points to the physical bus device we'd use to do DMA
736 * Needed just in case we have virtual hosts.
737 */
738 struct device *dma_dev;
739
740 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 * We should ensure that this is aligned, both for better performance
742 * and also because some compilers (m68k) don't automatically force
743 * alignment to a long boundary.
744 */
745 unsigned long hostdata[0] /* Used for storage of host specific stuff */
746 __attribute__ ((aligned (sizeof(unsigned long))));
747};
748
749#define class_to_shost(d) \
Tony Jonesee959b02008-02-22 00:13:36 +0100750 container_of(d, struct Scsi_Host, shost_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
James Bottomley9ccfc752005-10-02 11:45:08 -0500752#define shost_printk(prefix, shost, fmt, a...) \
753 dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)
754
Christoph Hellwigbcd92c92007-05-31 20:12:26 +0200755static inline void *shost_priv(struct Scsi_Host *shost)
756{
757 return (void *)shost->hostdata;
758}
James Bottomley9ccfc752005-10-02 11:45:08 -0500759
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760int scsi_is_host_device(const struct device *);
761
762static inline struct Scsi_Host *dev_to_shost(struct device *dev)
763{
764 while (!scsi_is_host_device(dev)) {
765 if (!dev->parent)
766 return NULL;
767 dev = dev->parent;
768 }
769 return container_of(dev, struct Scsi_Host, shost_gendev);
770}
771
James Bottomley939647e2005-09-18 15:05:20 -0500772static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
773{
774 return shost->shost_state == SHOST_RECOVERY ||
775 shost->shost_state == SHOST_CANCEL_RECOVERY ||
James Smartd7a1bb02006-03-08 14:50:12 -0500776 shost->shost_state == SHOST_DEL_RECOVERY ||
777 shost->tmf_in_progress;
James Bottomley939647e2005-09-18 15:05:20 -0500778}
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
781extern void scsi_flush_work(struct Scsi_Host *);
782
783extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
James Bottomleyd139b9b2009-11-05 13:33:12 -0600784extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *,
785 struct device *,
786 struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787extern void scsi_scan_host(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788extern void scsi_rescan_device(struct device *);
789extern void scsi_remove_host(struct Scsi_Host *);
790extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
791extern void scsi_host_put(struct Scsi_Host *t);
792extern struct Scsi_Host *scsi_host_lookup(unsigned short);
Mike Andersond3301872005-06-16 11:12:38 -0700793extern const char *scsi_host_state_name(enum scsi_host_state);
Jeff Garzikf2812332010-11-16 02:10:29 -0500794extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
796extern u64 scsi_calculate_bounce_limit(struct Scsi_Host *);
797
James Bottomleyd139b9b2009-11-05 13:33:12 -0600798static inline int __must_check scsi_add_host(struct Scsi_Host *host,
799 struct device *dev)
800{
801 return scsi_add_host_with_dma(host, dev, dev);
802}
803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804static inline struct device *scsi_get_device(struct Scsi_Host *shost)
805{
806 return shost->shost_gendev.parent;
807}
808
Mike Anderson82f29462005-06-16 11:14:33 -0700809/**
810 * scsi_host_scan_allowed - Is scanning of this host allowed
811 * @shost: Pointer to Scsi_Host.
812 **/
813static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
814{
Mike Christie76e4e122011-08-25 00:36:38 -0500815 return shost->shost_state == SHOST_RUNNING ||
816 shost->shost_state == SHOST_RECOVERY;
Mike Anderson82f29462005-06-16 11:14:33 -0700817}
818
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819extern void scsi_unblock_requests(struct Scsi_Host *);
820extern void scsi_block_requests(struct Scsi_Host *);
821
822struct class_container;
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900823
824extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
825 void (*) (struct request_queue *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826/*
827 * These two functions are used to allocate and free a pseudo device
828 * which will connect to the host adapter itself rather than any
829 * physical device. You must deallocate when you are done with the
830 * thing. This physical pseudo-device isn't real and won't be available
831 * from any high-level drivers.
832 */
833extern void scsi_free_host_dev(struct scsi_device *);
834extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);
835
Martin K. Petersen4469f982008-07-17 04:28:30 -0400836/*
837 * DIF defines the exchange of protection information between
838 * initiator and SBC block device.
839 *
840 * DIX defines the exchange of protection information between OS and
841 * initiator.
842 */
843enum scsi_host_prot_capabilities {
844 SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
845 SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
846 SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */
847
848 SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
849 SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
850 SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
851 SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
852};
853
854/*
855 * SCSI hosts which support the Data Integrity Extensions must
856 * indicate their capabilities by setting the prot_capabilities using
857 * this call.
858 */
859static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
860{
861 shost->prot_capabilities = mask;
862}
863
864static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
865{
866 return shost->prot_capabilities;
867}
868
Martin K. Petersen13f05c82010-09-10 20:50:10 +0200869static inline int scsi_host_prot_dma(struct Scsi_Host *shost)
870{
871 return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION;
872}
873
Martin K. Petersen4469f982008-07-17 04:28:30 -0400874static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
875{
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400876 static unsigned char cap[] = { 0,
877 SHOST_DIF_TYPE1_PROTECTION,
878 SHOST_DIF_TYPE2_PROTECTION,
879 SHOST_DIF_TYPE3_PROTECTION };
Martin K. Petersen4469f982008-07-17 04:28:30 -0400880
Martin K. Petersen4d248342012-09-26 22:39:44 -0400881 if (target_type >= ARRAY_SIZE(cap))
Martin K. Petersenfe542392012-09-21 12:44:12 -0400882 return 0;
883
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400884 return shost->prot_capabilities & cap[target_type] ? target_type : 0;
Martin K. Petersen4469f982008-07-17 04:28:30 -0400885}
886
887static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
888{
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400889#if defined(CONFIG_BLK_DEV_INTEGRITY)
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400890 static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
891 SHOST_DIX_TYPE1_PROTECTION,
892 SHOST_DIX_TYPE2_PROTECTION,
893 SHOST_DIX_TYPE3_PROTECTION };
894
Martin K. Petersen4d248342012-09-26 22:39:44 -0400895 if (target_type >= ARRAY_SIZE(cap))
Martin K. Petersenfe542392012-09-21 12:44:12 -0400896 return 0;
897
Martin K. Petersenb2b465e2009-10-29 22:32:26 -0400898 return shost->prot_capabilities & cap[target_type];
Martin K. Petersen35e1a5d2009-09-18 17:33:00 -0400899#endif
Martin K. Petersen4469f982008-07-17 04:28:30 -0400900 return 0;
901}
902
903/*
904 * All DIX-capable initiators must support the T10-mandated CRC
905 * checksum. Controllers can optionally implement the IP checksum
906 * scheme which has much lower impact on system performance. Note
907 * that the main rationale for the checksum is to match integrity
908 * metadata with data. Detecting bit errors are a job for ECC memory
909 * and buses.
910 */
911
912enum scsi_host_guard_type {
913 SHOST_DIX_GUARD_CRC = 1 << 0,
914 SHOST_DIX_GUARD_IP = 1 << 1,
915};
916
917static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
918{
919 shost->prot_guard_type = type;
920}
921
922static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
923{
924 return shost->prot_guard_type;
925}
926
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927/* legacy interfaces */
928extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
929extern void scsi_unregister(struct Scsi_Host *);
James Bottomley47ba39e2005-07-30 11:39:53 -0500930extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932#endif /* _SCSI_SCSI_HOST_H */