scsi_host.h 27.8 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7
#ifndef _SCSI_SCSI_HOST_H
#define _SCSI_SCSI_HOST_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/types.h>
#include <linux/workqueue.h>
8
#include <linux/mutex.h>
9
#include <linux/seq_file.h>
10
#include <linux/blk-mq.h>
11
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
12

13
struct request_queue;
Linus Torvalds's avatar
Linus Torvalds committed
14
struct block_device;
15
struct completion;
Linus Torvalds's avatar
Linus Torvalds committed
16 17 18
struct module;
struct scsi_cmnd;
struct scsi_device;
19
struct scsi_host_cmd_pool;
20
struct scsi_target;
Linus Torvalds's avatar
Linus Torvalds committed
21 22 23
struct Scsi_Host;
struct scsi_host_cmd_pool;
struct scsi_transport_template;
24
struct blk_queue_tags;
Linus Torvalds's avatar
Linus Torvalds committed
25 26 27 28 29 30 31


/*
 * The various choices mean:
 * NONE: Self evident.	Host adapter is not capable of scatter-gather.
 * ALL:	 Means that the host adapter module can do scatter-gather,
 *	 and that there is no limit to the size of the table to which
32 33 34 35
 *	 we scatter/gather data.  The value we set here is the maximum
 *	 single element sglist.  To use chained sglists, the adapter
 *	 has to set a value beyond ALL (and correctly use the chain
 *	 handling API.
Linus Torvalds's avatar
Linus Torvalds committed
36 37 38 39
 * Anything else:  Indicates the maximum number of chains that can be
 *	 used in one scatter-gather request.
 */
#define SG_NONE 0
40
#define SG_ALL	SG_CHUNK_SIZE
Linus Torvalds's avatar
Linus Torvalds committed
41

42 43 44
#define MODE_UNKNOWN 0x00
#define MODE_INITIATOR 0x01
#define MODE_TARGET 0x02
Linus Torvalds's avatar
Linus Torvalds committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126

#define DISABLE_CLUSTERING 0
#define ENABLE_CLUSTERING 1

struct scsi_host_template {
	struct module *module;
	const char *name;

	/*
	 * Used to initialize old-style drivers.  For new-style drivers
	 * just perform all work in your module initialization function.
	 *
	 * Status:  OBSOLETE
	 */
	int (* detect)(struct scsi_host_template *);

	/*
	 * Used as unload callback for hosts with old-style drivers.
	 *
	 * Status: OBSOLETE
	 */
	int (* release)(struct Scsi_Host *);

	/*
	 * The info function will return whatever useful information the
	 * developer sees fit.  If not provided, then the name field will
	 * be used instead.
	 *
	 * Status: OPTIONAL
	 */
	const char *(* info)(struct Scsi_Host *);

	/*
	 * Ioctl interface
	 *
	 * Status: OPTIONAL
	 */
	int (* ioctl)(struct scsi_device *dev, int cmd, void __user *arg);


#ifdef CONFIG_COMPAT
	/* 
	 * Compat handler. Handle 32bit ABI.
	 * When unknown ioctl is passed return -ENOIOCTLCMD.
	 *
	 * Status: OPTIONAL
	 */
	int (* compat_ioctl)(struct scsi_device *dev, int cmd, void __user *arg);
#endif

	/*
	 * The queuecommand function is used to queue up a scsi
	 * command block to the LLDD.  When the driver finished
	 * processing the command the done callback is invoked.
	 *
	 * If queuecommand returns 0, then the HBA has accepted the
	 * command.  The done() function must be called on the command
	 * when the driver has finished with it. (you may call done on the
	 * command before queuecommand returns, but in this case you
	 * *must* return 0 from queuecommand).
	 *
	 * Queuecommand may also reject the command, in which case it may
	 * not touch the command and must not call done() for it.
	 *
	 * There are two possible rejection returns:
	 *
	 *   SCSI_MLQUEUE_DEVICE_BUSY: Block this device temporarily, but
	 *   allow commands to other devices serviced by this host.
	 *
	 *   SCSI_MLQUEUE_HOST_BUSY: Block all devices served by this
	 *   host temporarily.
	 *
         * For compatibility, any other non-zero return is treated the
         * same as SCSI_MLQUEUE_HOST_BUSY.
	 *
	 * NOTE: "temporarily" means either until the next command for#
	 * this device/host completes, or a period of time determined by
	 * I/O pressure in the system if there are no other outstanding
	 * commands.
	 *
	 * STATUS: REQUIRED
	 */
Jeff Garzik's avatar
Jeff Garzik committed
127
	int (* queuecommand)(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

	/*
	 * This is an error handling strategy routine.  You don't need to
	 * define one of these if you don't want to - there is a default
	 * routine that is present that should work in most cases.  For those
	 * driver authors that have the inclination and ability to write their
	 * own strategy routine, this is where it is specified.  Note - the
	 * strategy routine is *ALWAYS* run in the context of the kernel eh
	 * thread.  Thus you are guaranteed to *NOT* be in an interrupt
	 * handler when you execute this, and you are also guaranteed to
	 * *NOT* have any other commands being queued while you are in the
	 * strategy routine. When you return from this function, operations
	 * return to normal.
	 *
	 * See scsi_error.c scsi_unjam_host for additional comments about
	 * what this function should and should not be attempting to do.
	 *
	 * Status: REQUIRED	(at least one of them)
	 */
	int (* eh_abort_handler)(struct scsi_cmnd *);
	int (* eh_device_reset_handler)(struct scsi_cmnd *);
149
	int (* eh_target_reset_handler)(struct scsi_cmnd *);
Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
	int (* eh_bus_reset_handler)(struct scsi_cmnd *);
	int (* eh_host_reset_handler)(struct scsi_cmnd *);

	/*
	 * Before the mid layer attempts to scan for a new device where none
	 * currently exists, it will call this entry in your driver.  Should
	 * your driver need to allocate any structs or perform any other init
	 * items in order to send commands to a currently unused target/lun
	 * combo, then this is where you can perform those allocations.  This
	 * is specifically so that drivers won't have to perform any kind of
	 * "is this a new device" checks in their queuecommand routine,
	 * thereby making the hot path a bit quicker.
	 *
	 * Return values: 0 on success, non-0 on failure
	 *
	 * Deallocation:  If we didn't find any devices at this ID, you will
	 * get an immediate call to slave_destroy().  If we find something
	 * here then you will get a call to slave_configure(), then the
	 * device will be used for however long it is kept around, then when
	 * the device is removed from the system (or * possibly at reboot
	 * time), you will then get a call to slave_destroy().  This is
	 * assuming you implement slave_configure and slave_destroy.
	 * However, if you allocate memory and hang it off the device struct,
	 * then you must implement the slave_destroy() routine at a minimum
	 * in order to avoid leaking memory
	 * each time a device is tore down.
	 *
	 * Status: OPTIONAL
	 */
	int (* slave_alloc)(struct scsi_device *);

	/*
	 * Once the device has responded to an INQUIRY and we know the
	 * device is online, we call into the low level driver with the
	 * struct scsi_device *.  If the low level device driver implements
	 * this function, it *must* perform the task of setting the queue
	 * depth on the device.  All other tasks are optional and depend
	 * on what the driver supports and various implementation details.
	 * 
	 * Things currently recommended to be handled at this time include:
	 *
	 * 1.  Setting the device queue depth.  Proper setting of this is
192
	 *     described in the comments for scsi_change_queue_depth.
Linus Torvalds's avatar
Linus Torvalds committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
	 * 2.  Determining if the device supports the various synchronous
	 *     negotiation protocols.  The device struct will already have
	 *     responded to INQUIRY and the results of the standard items
	 *     will have been shoved into the various device flag bits, eg.
	 *     device->sdtr will be true if the device supports SDTR messages.
	 * 3.  Allocating command structs that the device will need.
	 * 4.  Setting the default timeout on this device (if needed).
	 * 5.  Anything else the low level driver might want to do on a device
	 *     specific setup basis...
	 * 6.  Return 0 on success, non-0 on error.  The device will be marked
	 *     as offline on error so that no access will occur.  If you return
	 *     non-0, your slave_destroy routine will never get called for this
	 *     device, so don't leave any loose memory hanging around, clean
	 *     up after yourself before returning non-0
	 *
	 * Status: OPTIONAL
	 */
	int (* slave_configure)(struct scsi_device *);

	/*
	 * Immediately prior to deallocating the device and after all activity
	 * has ceased the mid layer calls this point so that the low level
	 * driver may completely detach itself from the scsi device and vice
	 * versa.  The low level driver is responsible for freeing any memory
	 * it allocated in the slave_alloc or slave_configure calls. 
	 *
	 * Status: OPTIONAL
	 */
	void (* slave_destroy)(struct scsi_device *);

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
	/*
	 * Before the mid layer attempts to scan for a new device attached
	 * to a target where no target currently exists, it will call this
	 * entry in your driver.  Should your driver need to allocate any
	 * structs or perform any other init items in order to send commands
	 * to a currently unused target, then this is where you can perform
	 * those allocations.
	 *
	 * Return values: 0 on success, non-0 on failure
	 *
	 * Status: OPTIONAL
	 */
	int (* target_alloc)(struct scsi_target *);

	/*
	 * Immediately prior to deallocating the target structure, and
	 * after all activity to attached scsi devices has ceased, the
	 * midlayer calls this point so that the driver may deallocate
	 * and terminate any references to the target.
	 *
	 * Status: OPTIONAL
	 */
	void (* target_destroy)(struct scsi_target *);

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
	/*
	 * If a host has the ability to discover targets on its own instead
	 * of scanning the entire bus, it can fill in this function and
	 * call scsi_scan_host().  This function will be called periodically
	 * until it returns 1 with the scsi_host and the elapsed time of
	 * the scan in jiffies.
	 *
	 * Status: OPTIONAL
	 */
	int (* scan_finished)(struct Scsi_Host *, unsigned long);

	/*
	 * If the host wants to be called before the scan starts, but
	 * after the midlayer has set up ready for the scan, it can fill
	 * in this function.
262 263
	 *
	 * Status: OPTIONAL
264 265 266
	 */
	void (* scan_start)(struct Scsi_Host *);

Linus Torvalds's avatar
Linus Torvalds committed
267
	/*
268 269
	 * Fill in this function to allow the queue depth of this host
	 * to be changeable (on a per device basis).  Returns either
Linus Torvalds's avatar
Linus Torvalds committed
270 271 272 273 274 275
	 * the current queue depth setting (may be different from what
	 * was passed in) or an error.  An error should only be
	 * returned if the requested depth is legal but the driver was
	 * unable to set it.  If the requested depth is illegal, the
	 * driver should set and return the closest legal queue depth.
	 *
276
	 * Status: OPTIONAL
Linus Torvalds's avatar
Linus Torvalds committed
277
	 */
278
	int (* change_queue_depth)(struct scsi_device *, int);
Linus Torvalds's avatar
Linus Torvalds committed
279 280

	/*
281
	 * This function determines the BIOS parameters for a given
Linus Torvalds's avatar
Linus Torvalds committed
282 283 284 285
	 * harddisk.  These tend to be numbers that are made up by
	 * the host adapter.  Parameters:
	 * size, device, list (heads, sectors, cylinders)
	 *
286 287
	 * Status: OPTIONAL
	 */
Linus Torvalds's avatar
Linus Torvalds committed
288 289 290
	int (* bios_param)(struct scsi_device *, struct block_device *,
			sector_t, int []);

291 292 293 294 295 296 297 298
	/*
	 * This function is called when one or more partitions on the
	 * device reach beyond the end of the device.
	 *
	 * Status: OPTIONAL
	 */
	void (*unlock_native_capacity)(struct scsi_device *);

Linus Torvalds's avatar
Linus Torvalds committed
299 300 301 302 303 304 305
	/*
	 * Can be used to export driver statistics and other infos to the
	 * world outside the kernel ie. userspace and it also provides an
	 * interface to feed the driver with information.
	 *
	 * Status: OBSOLETE
	 */
306 307
	int (*show_info)(struct seq_file *, struct Scsi_Host *);
	int (*write_info)(struct Scsi_Host *, char *, int);
Linus Torvalds's avatar
Linus Torvalds committed
308

309 310 311 312 313 314 315 316 317 318 319
	/*
	 * This is an optional routine that allows the transport to become
	 * involved when a scsi io timer fires. The return value tells the
	 * timer routine how to finish the io timeout handling:
	 * EH_HANDLED:		I fixed the error, please complete the command
	 * EH_RESET_TIMER:	I need more time, reset the timer and
	 *			begin counting again
	 * EH_NOT_HANDLED	Begin normal error recovery
	 *
	 * Status: OPTIONAL
	 */
320
	enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
321

322 323 324 325 326 327 328 329 330 331 332 333 334
	/* This is an optional routine that allows transport to initiate
	 * LLD adapter or firmware reset using sysfs attribute.
	 *
	 * Return values: 0 on success, -ve value on failure.
	 *
	 * Status: OPTIONAL
	 */

	int (*host_reset)(struct Scsi_Host *shost, int reset_type);
#define SCSI_ADAPTER_RESET	1
#define SCSI_FIRMWARE_RESET	2


Linus Torvalds's avatar
Linus Torvalds committed
335 336 337
	/*
	 * Name of proc directory
	 */
338
	const char *proc_name;
Linus Torvalds's avatar
Linus Torvalds committed
339 340 341

	/*
	 * Used to store the procfs directory if a driver implements the
Al Viro's avatar
Al Viro committed
342
	 * show_info method.
Linus Torvalds's avatar
Linus Torvalds committed
343 344 345 346 347
	 */
	struct proc_dir_entry *proc_dir;

	/*
	 * This determines if we will use a non-interrupt driven
348
	 * or an interrupt driven scheme.  It is set to the maximum number
Linus Torvalds's avatar
Linus Torvalds committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
	 * of simultaneous commands a given host adapter will accept.
	 */
	int can_queue;

	/*
	 * In many instances, especially where disconnect / reconnect are
	 * supported, our host also has an ID on the SCSI bus.  If this is
	 * the case, then it must be reserved.  Please set this_id to -1 if
	 * your setup is in single initiator mode, and the host lacks an
	 * ID.
	 */
	int this_id;

	/*
	 * This determines the degree to which the host adapter is capable
	 * of scatter-gather.
	 */
	unsigned short sg_tablesize;
367
	unsigned short sg_prot_tablesize;
Linus Torvalds's avatar
Linus Torvalds committed
368 369

	/*
370
	 * Set this if the host adapter has limitations beside segment count.
Linus Torvalds's avatar
Linus Torvalds committed
371
	 */
372
	unsigned int max_sectors;
Linus Torvalds's avatar
Linus Torvalds committed
373 374

	/*
375
	 * DMA scatter gather segment boundary limit. A segment crossing this
Linus Torvalds's avatar
Linus Torvalds committed
376 377 378 379 380 381 382 383
	 * boundary will be split in two.
	 */
	unsigned long dma_boundary;

	/*
	 * This specifies "machine infinity" for host templates which don't
	 * limit the transfer size.  Note this limit represents an absolute
	 * maximum, and may be over the transfer limits allowed for
384
	 * individual devices (e.g. 256 for SCSI-1).
Linus Torvalds's avatar
Linus Torvalds committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
	 */
#define SCSI_DEFAULT_MAX_SECTORS	1024

	/*
	 * True if this host adapter can make good use of linked commands.
	 * This will allow more than one command to be queued to a given
	 * unit on a given host.  Set this to the maximum number of command
	 * blocks to be provided for each device.  Set this to 1 for one
	 * command block per lun, 2 for two, etc.  Do not set this to 0.
	 * You should make sure that the host adapter will do the right thing
	 * before you try setting this above 1.
	 */
	short cmd_per_lun;

	/*
	 * present contains counter indicating how many boards of this
	 * type were found when we did the scan.
	 */
	unsigned char present;

405 406 407
	/* If use block layer to manage tags, this is tag allocation policy */
	int tag_alloc_policy;

408 409 410 411 412
	/*
	 * Track QUEUE_FULL events and reduce queue depth on demand.
	 */
	unsigned track_queue_depth:1;

413 414 415 416 417
	/*
	 * This specifies the mode that a LLD supports.
	 */
	unsigned supported_mode:2;

Linus Torvalds's avatar
Linus Torvalds committed
418
	/*
419
	 * True if this host adapter uses unchecked DMA onto an ISA bus.
Linus Torvalds's avatar
Linus Torvalds committed
420 421 422 423
	 */
	unsigned unchecked_isa_dma:1;

	/*
424
	 * True if this host adapter can make good use of clustering.
Linus Torvalds's avatar
Linus Torvalds committed
425 426 427 428 429 430 431 432 433
	 * I originally thought that if the tablesize was large that it
	 * was a waste of CPU cycles to prepare a cluster list, but
	 * it works out that the Buslogic is faster if you use a smaller
	 * number of segments (i.e. use clustering).  I guess it is
	 * inefficient.
	 */
	unsigned use_clustering:1;

	/*
434
	 * True for emulated SCSI host adapters (e.g. ATAPI).
Linus Torvalds's avatar
Linus Torvalds committed
435 436 437 438 439 440 441 442
	 */
	unsigned emulated:1;

	/*
	 * True if the low-level driver performs its own reset-settle delays.
	 */
	unsigned skip_settle_delay:1;

443 444 445
	/* True if the controller does not support WRITE SAME */
	unsigned no_write_same:1;

446 447 448 449 450
	/*
	 * True if asynchronous aborts are not supported
	 */
	unsigned no_async_abort:1;

Linus Torvalds's avatar
Linus Torvalds committed
451
	/*
452
	 * Countdown for host blocking with no commands outstanding.
Linus Torvalds's avatar
Linus Torvalds committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	 */
	unsigned int max_host_blocked;

	/*
	 * Default value for the blocking.  If the queue is empty,
	 * host_blocked counts down in the request_fn until it restarts
	 * host operations as zero is reached.  
	 *
	 * FIXME: This should probably be a value in the template
	 */
#define SCSI_DEFAULT_HOST_BLOCKED	7

	/*
	 * Pointer to the sysfs class properties for this host, NULL terminated.
	 */
468
	struct device_attribute **shost_attrs;
Linus Torvalds's avatar
Linus Torvalds committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482

	/*
	 * Pointer to the SCSI device properties for this host, NULL terminated.
	 */
	struct device_attribute **sdev_attrs;

	/*
	 * List of hosts per template.
	 *
	 * This is only for use by scsi_module.c for legacy templates.
	 * For these access to it is synchronized implicitly by
	 * module_init/module_exit.
	 */
	struct list_head legacy_hosts;
483 484 485 486 487 488 489 490 491

	/*
	 * Vendor Identifier associated with the host
	 *
	 * Note: When specifying vendor_id, be sure to read the
	 *   Vendor Type and ID formatting requirements specified in
	 *   scsi_netlink.h
	 */
	u64 vendor_id;
492 493 494 495 496 497

	/*
	 * Additional per-command data allocated for the driver.
	 */
	unsigned int cmd_size;
	struct scsi_host_cmd_pool *cmd_pool;
Linus Torvalds's avatar
Linus Torvalds committed
498 499
};

Jeff Garzik's avatar
Jeff Garzik committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
/*
 * Temporary #define for host lock push down. Can be removed when all
 * drivers have been updated to take advantage of unlocked
 * queuecommand.
 *
 */
#define DEF_SCSI_QCMD(func_name) \
	int func_name(struct Scsi_Host *shost, struct scsi_cmnd *cmd)	\
	{								\
		unsigned long irq_flags;				\
		int rc;							\
		spin_lock_irqsave(shost->host_lock, irq_flags);		\
		scsi_cmd_get_serial(shost, cmd);			\
		rc = func_name##_lck (cmd, cmd->scsi_done);			\
		spin_unlock_irqrestore(shost->host_lock, irq_flags);	\
		return rc;						\
	}


Linus Torvalds's avatar
Linus Torvalds committed
519
/*
520 521 522
 * shost state: If you alter this, you also need to alter scsi_sysfs.c
 * (for the ascii descriptions) and the state model enforcer:
 * scsi_host_set_state()
Linus Torvalds's avatar
Linus Torvalds committed
523
 */
524 525 526
enum scsi_host_state {
	SHOST_CREATED = 1,
	SHOST_RUNNING,
Linus Torvalds's avatar
Linus Torvalds committed
527
	SHOST_CANCEL,
528
	SHOST_DEL,
Linus Torvalds's avatar
Linus Torvalds committed
529
	SHOST_RECOVERY,
530 531
	SHOST_CANCEL_RECOVERY,
	SHOST_DEL_RECOVERY,
Linus Torvalds's avatar
Linus Torvalds committed
532 533 534 535 536 537 538
};

struct Scsi_Host {
	/*
	 * __devices is protected by the host_lock, but you should
	 * usually use scsi_device_lookup / shost_for_each_device
	 * to access it and don't care about locking yourself.
539
	 * In the rare case of being in irq context you can use
Linus Torvalds's avatar
Linus Torvalds committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553
	 * their __ prefixed variants with the lock held. NEVER
	 * access this list directly from a driver.
	 */
	struct list_head	__devices;
	struct list_head	__targets;
	
	struct scsi_host_cmd_pool *cmd_pool;
	spinlock_t		free_list_lock;
	struct list_head	free_list; /* backup store of cmd structs */
	struct list_head	starved_list;

	spinlock_t		default_lock;
	spinlock_t		*host_lock;

554
	struct mutex		scan_mutex;/* serialize scanning activity */
Linus Torvalds's avatar
Linus Torvalds committed
555 556 557

	struct list_head	eh_cmd_q;
	struct task_struct    * ehandler;  /* Error recovery thread. */
558 559
	struct completion     * eh_action; /* Wait for specific actions on the
					      host. */
Linus Torvalds's avatar
Linus Torvalds committed
560 561 562
	wait_queue_head_t       host_wait;
	struct scsi_host_template *hostt;
	struct scsi_transport_template *transportt;
563

564
	/*
565 566
	 * Area to keep a shared tag map (if needed, will be
	 * NULL if not).
567
	 */
568 569 570 571
	union {
		struct blk_queue_tag	*bqt;
		struct blk_mq_tag_set	tag_set;
	};
572

573
	atomic_t host_busy;		   /* commands actually active on low-level */
574 575
	atomic_t host_blocked;

576 577
	unsigned int host_failed;	   /* commands that failed.
					      protected by host_lock */
578
	unsigned int host_eh_scheduled;    /* EH scheduled without command */
Linus Torvalds's avatar
Linus Torvalds committed
579
    
580
	unsigned int host_no;  /* Used for IOCTL_GET_IDLUN, /proc/scsi et al. */
Linus Torvalds's avatar
Linus Torvalds committed
581

582 583 584 585 586
	/* next two fields are used to bound the time spent in error handling */
	int eh_deadline;
	unsigned long last_reset;


Linus Torvalds's avatar
Linus Torvalds committed
587 588 589
	/*
	 * These three parameters can be used to allow for wide scsi,
	 * and for host adapters that support multiple busses
590
	 * The last two should be set to 1 more than the actual max id
591
	 * or lun (e.g. 8 for SCSI parallel systems).
Linus Torvalds's avatar
Linus Torvalds committed
592 593
	 */
	unsigned int max_channel;
594 595
	unsigned int max_id;
	u64 max_lun;
Linus Torvalds's avatar
Linus Torvalds committed
596 597 598 599 600 601 602 603 604 605 606 607 608

	/*
	 * This is a unique identifier that must be assigned so that we
	 * have some way of identifying each detected host adapter properly
	 * and uniquely.  For hosts that do not support more than one card
	 * in the system at one time, this does not need to be set.  It is
	 * initialized to 0 in scsi_register.
	 */
	unsigned int unique_id;

	/*
	 * The maximum length of SCSI commands that this host can accept.
	 * Probably 12 for most host adapters, but could be 16 for others.
609
	 * or 260 if the driver supports variable length cdbs.
Linus Torvalds's avatar
Linus Torvalds committed
610
	 * For drivers that don't set this field, a value of 12 is
611
	 * assumed.
Linus Torvalds's avatar
Linus Torvalds committed
612
	 */
613
	unsigned short max_cmd_len;
Linus Torvalds's avatar
Linus Torvalds committed
614 615 616 617 618

	int this_id;
	int can_queue;
	short cmd_per_lun;
	short unsigned int sg_tablesize;
619
	short unsigned int sg_prot_tablesize;
620
	unsigned int max_sectors;
Linus Torvalds's avatar
Linus Torvalds committed
621
	unsigned long dma_boundary;
622 623 624 625 626 627 628 629
	/*
	 * In scsi-mq mode, the number of hardware queues supported by the LLD.
	 *
	 * Note: it is assumed that each hardware queue has a queue depth of
	 * can_queue. In other words, the total queue depth per host
	 * is nr_hw_queues * can_queue.
	 */
	unsigned nr_hw_queues;
Linus Torvalds's avatar
Linus Torvalds committed
630 631 632 633
	/* 
	 * Used to assign serial numbers to the cmds.
	 * Protected by the host lock.
	 */
634
	unsigned long cmd_serial_number;
Linus Torvalds's avatar
Linus Torvalds committed
635
	
636
	unsigned active_mode:2;
Linus Torvalds's avatar
Linus Torvalds committed
637 638 639 640 641 642 643 644 645 646 647 648
	unsigned unchecked_isa_dma:1;
	unsigned use_clustering:1;

	/*
	 * Host has requested that no further requests come through for the
	 * time being.
	 */
	unsigned host_self_blocked:1;
    
	/*
	 * Host uses correct SCSI ordering not PC ordering. The bit is
	 * set for the minority of drivers whose authors actually read
649
	 * the spec ;).
Linus Torvalds's avatar
Linus Torvalds committed
650 651 652
	 */
	unsigned reverse_ordering:1;

653
	/* Task mgmt function in progress */
654 655
	unsigned tmf_in_progress:1;

656 657 658
	/* Asynchronous scan in progress */
	unsigned async_scan:1;

659 660 661
	/* Don't resume host in EH */
	unsigned eh_noresume:1;

662 663 664
	/* The controller does not support WRITE SAME */
	unsigned no_write_same:1;

665
	unsigned use_blk_mq:1;
666
	unsigned use_cmd_list:1;
667

668 669 670
	/* Host responded with short (<36 bytes) INQUIRY result */
	unsigned short_inquiry:1;

Linus Torvalds's avatar
Linus Torvalds committed
671 672 673
	/*
	 * Optional work queue to be utilized by the transport
	 */
674
	char work_q_name[20];
Linus Torvalds's avatar
Linus Torvalds committed
675 676
	struct workqueue_struct *work_q;

677 678 679 680 681
	/*
	 * Task management function work queue
	 */
	struct workqueue_struct *tmf_work_q;

682 683 684
	/* The transport requires the LUN bits NOT to be stored in CDB[1] */
	unsigned no_scsi2_lun_in_cdb:1;

Linus Torvalds's avatar
Linus Torvalds committed
685 686 687 688 689
	/*
	 * Value host_blocked counts down from
	 */
	unsigned int max_host_blocked;

690 691 692 693
	/* Protection Information */
	unsigned int prot_capabilities;
	unsigned char prot_guard_type;

694 695 696 697 698 699
	/*
	 * q used for scsi_tgt msgs, async events or any other requests that
	 * need to be processed in userspace
	 */
	struct request_queue *uspace_req_q;

Linus Torvalds's avatar
Linus Torvalds committed
700 701 702 703 704 705 706 707
	/* legacy crap */
	unsigned long base;
	unsigned long io_port;
	unsigned char n_io_port;
	unsigned char dma_channel;
	unsigned int  irq;
	

708
	enum scsi_host_state shost_state;
Linus Torvalds's avatar
Linus Torvalds committed
709 710

	/* ldm bits */
711
	struct device		shost_gendev, shost_dev;
Linus Torvalds's avatar
Linus Torvalds committed
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727

	/*
	 * List of hosts per template.
	 *
	 * This is only for use by scsi_module.c for legacy templates.
	 * For these access to it is synchronized implicitly by
	 * module_init/module_exit.
	 */
	struct list_head sht_legacy_list;

	/*
	 * Points to the transport data (if any) which is allocated
	 * separately
	 */
	void *shost_data;

728 729 730 731 732 733
	/*
	 * Points to the physical bus device we'd use to do DMA
	 * Needed just in case we have virtual hosts.
	 */
	struct device *dma_dev;

Linus Torvalds's avatar
Linus Torvalds committed
734 735 736 737 738 739 740 741 742 743
	/*
	 * We should ensure that this is aligned, both for better performance
	 * and also because some compilers (m68k) don't automatically force
	 * alignment to a long boundary.
	 */
	unsigned long hostdata[0]  /* Used for storage of host specific stuff */
		__attribute__ ((aligned (sizeof(unsigned long))));
};

#define		class_to_shost(d)	\
744
	container_of(d, struct Scsi_Host, shost_dev)
Linus Torvalds's avatar
Linus Torvalds committed
745

746 747 748
#define shost_printk(prefix, shost, fmt, a...)	\
	dev_printk(prefix, &(shost)->shost_gendev, fmt, ##a)

749 750 751 752
static inline void *shost_priv(struct Scsi_Host *shost)
{
	return (void *)shost->hostdata;
}
753

Linus Torvalds's avatar
Linus Torvalds committed
754 755 756 757 758 759 760 761 762 763 764 765
int scsi_is_host_device(const struct device *);

static inline struct Scsi_Host *dev_to_shost(struct device *dev)
{
	while (!scsi_is_host_device(dev)) {
		if (!dev->parent)
			return NULL;
		dev = dev->parent;
	}
	return container_of(dev, struct Scsi_Host, shost_gendev);
}

766 767 768 769
static inline int scsi_host_in_recovery(struct Scsi_Host *shost)
{
	return shost->shost_state == SHOST_RECOVERY ||
		shost->shost_state == SHOST_CANCEL_RECOVERY ||
770 771
		shost->shost_state == SHOST_DEL_RECOVERY ||
		shost->tmf_in_progress;
772 773
}

774 775
static inline bool shost_use_blk_mq(struct Scsi_Host *shost)
{
776
	return shost->use_blk_mq;
777 778
}

Linus Torvalds's avatar
Linus Torvalds committed
779 780 781 782
extern int scsi_queue_work(struct Scsi_Host *, struct work_struct *);
extern void scsi_flush_work(struct Scsi_Host *);

extern struct Scsi_Host *scsi_host_alloc(struct scsi_host_template *, int);
783 784 785
extern int __must_check scsi_add_host_with_dma(struct Scsi_Host *,
					       struct device *,
					       struct device *);
Linus Torvalds's avatar
Linus Torvalds committed
786 787 788 789 790 791
extern void scsi_scan_host(struct Scsi_Host *);
extern void scsi_rescan_device(struct device *);
extern void scsi_remove_host(struct Scsi_Host *);
extern struct Scsi_Host *scsi_host_get(struct Scsi_Host *);
extern void scsi_host_put(struct Scsi_Host *t);
extern struct Scsi_Host *scsi_host_lookup(unsigned short);
792
extern const char *scsi_host_state_name(enum scsi_host_state);
Jeff Garzik's avatar
Jeff Garzik committed
793
extern void scsi_cmd_get_serial(struct Scsi_Host *, struct scsi_cmnd *);
Linus Torvalds's avatar
Linus Torvalds committed
794

795 796 797 798 799 800
static inline int __must_check scsi_add_host(struct Scsi_Host *host,
					     struct device *dev)
{
	return scsi_add_host_with_dma(host, dev, dev);
}

Linus Torvalds's avatar
Linus Torvalds committed
801 802 803 804 805
static inline struct device *scsi_get_device(struct Scsi_Host *shost)
{
        return shost->shost_gendev.parent;
}

806 807 808 809 810 811
/**
 * scsi_host_scan_allowed - Is scanning of this host allowed
 * @shost:	Pointer to Scsi_Host.
 **/
static inline int scsi_host_scan_allowed(struct Scsi_Host *shost)
{
812 813
	return shost->shost_state == SHOST_RUNNING ||
	       shost->shost_state == SHOST_RECOVERY;
814 815
}

Linus Torvalds's avatar
Linus Torvalds committed
816 817 818 819
extern void scsi_unblock_requests(struct Scsi_Host *);
extern void scsi_block_requests(struct Scsi_Host *);

struct class_container;
820 821 822

extern struct request_queue *__scsi_alloc_queue(struct Scsi_Host *shost,
						void (*) (struct request_queue *));
Linus Torvalds's avatar
Linus Torvalds committed
823 824 825 826 827 828 829 830 831 832
/*
 * These two functions are used to allocate and free a pseudo device
 * which will connect to the host adapter itself rather than any
 * physical device.  You must deallocate when you are done with the
 * thing.  This physical pseudo-device isn't real and won't be available
 * from any high-level drivers.
 */
extern void scsi_free_host_dev(struct scsi_device *);
extern struct scsi_device *scsi_get_host_dev(struct Scsi_Host *);

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
/*
 * DIF defines the exchange of protection information between
 * initiator and SBC block device.
 *
 * DIX defines the exchange of protection information between OS and
 * initiator.
 */
enum scsi_host_prot_capabilities {
	SHOST_DIF_TYPE1_PROTECTION = 1 << 0, /* T10 DIF Type 1 */
	SHOST_DIF_TYPE2_PROTECTION = 1 << 1, /* T10 DIF Type 2 */
	SHOST_DIF_TYPE3_PROTECTION = 1 << 2, /* T10 DIF Type 3 */

	SHOST_DIX_TYPE0_PROTECTION = 1 << 3, /* DIX between OS and HBA only */
	SHOST_DIX_TYPE1_PROTECTION = 1 << 4, /* DIX with DIF Type 1 */
	SHOST_DIX_TYPE2_PROTECTION = 1 << 5, /* DIX with DIF Type 2 */
	SHOST_DIX_TYPE3_PROTECTION = 1 << 6, /* DIX with DIF Type 3 */
};

/*
 * SCSI hosts which support the Data Integrity Extensions must
 * indicate their capabilities by setting the prot_capabilities using
 * this call.
 */
static inline void scsi_host_set_prot(struct Scsi_Host *shost, unsigned int mask)
{
	shost->prot_capabilities = mask;
}

static inline unsigned int scsi_host_get_prot(struct Scsi_Host *shost)
{
	return shost->prot_capabilities;
}

866 867 868 869 870
static inline int scsi_host_prot_dma(struct Scsi_Host *shost)
{
	return shost->prot_capabilities >= SHOST_DIX_TYPE0_PROTECTION;
}

871 872
static inline unsigned int scsi_host_dif_capable(struct Scsi_Host *shost, unsigned int target_type)
{
873 874 875 876
	static unsigned char cap[] = { 0,
				       SHOST_DIF_TYPE1_PROTECTION,
				       SHOST_DIF_TYPE2_PROTECTION,
				       SHOST_DIF_TYPE3_PROTECTION };
877

878
	if (target_type >= ARRAY_SIZE(cap))
879 880
		return 0;

881
	return shost->prot_capabilities & cap[target_type] ? target_type : 0;
882 883 884 885
}

static inline unsigned int scsi_host_dix_capable(struct Scsi_Host *shost, unsigned int target_type)
{
886
#if defined(CONFIG_BLK_DEV_INTEGRITY)
887 888 889 890 891
	static unsigned char cap[] = { SHOST_DIX_TYPE0_PROTECTION,
				       SHOST_DIX_TYPE1_PROTECTION,
				       SHOST_DIX_TYPE2_PROTECTION,
				       SHOST_DIX_TYPE3_PROTECTION };

892
	if (target_type >= ARRAY_SIZE(cap))
893 894
		return 0;

895
	return shost->prot_capabilities & cap[target_type];
896
#endif
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
	return 0;
}

/*
 * All DIX-capable initiators must support the T10-mandated CRC
 * checksum.  Controllers can optionally implement the IP checksum
 * scheme which has much lower impact on system performance.  Note
 * that the main rationale for the checksum is to match integrity
 * metadata with data.  Detecting bit errors are a job for ECC memory
 * and buses.
 */

enum scsi_host_guard_type {
	SHOST_DIX_GUARD_CRC = 1 << 0,
	SHOST_DIX_GUARD_IP  = 1 << 1,
};

static inline void scsi_host_set_guard(struct Scsi_Host *shost, unsigned char type)
{
	shost->prot_guard_type = type;
}

static inline unsigned char scsi_host_get_guard(struct Scsi_Host *shost)
{
	return shost->prot_guard_type;
}

Linus Torvalds's avatar
Linus Torvalds committed
924 925 926
/* legacy interfaces */
extern struct Scsi_Host *scsi_register(struct scsi_host_template *, int);
extern void scsi_unregister(struct Scsi_Host *);
927
extern int scsi_host_set_state(struct Scsi_Host *, enum scsi_host_state);
Linus Torvalds's avatar
Linus Torvalds committed
928 929

#endif /* _SCSI_SCSI_HOST_H */