[mirror_ubuntu-zesty-kernel.git] / include / scsi / scsi_device.h

#ifndef _SCSI_SCSI_DEVICE_H
#define _SCSI_SCSI_DEVICE_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/blkdev.h>
#include <scsi/scsi.h>
#include <asm/atomic.h>

struct request_queue;
struct scsi_cmnd;
struct scsi_lun;
struct scsi_sense_hdr;

struct scsi_mode_data {
	__u32	length;
	__u16	block_descriptor_length;
	__u8	medium_type;
	__u8	device_specific;
	__u8	header_length;
	__u8	longlba:1;
};

/*
 * sdev state: If you alter this, you also need to alter scsi_sysfs.c
 * (for the ascii descriptions) and the state model enforcer:
 * scsi_lib:scsi_device_set_state().
 */
enum scsi_device_state {
	SDEV_CREATED = 1,	/* device created but not added to sysfs
				 * Only internal commands allowed (for inq) */
	SDEV_RUNNING,		/* device properly configured
				 * All commands allowed */
	SDEV_CANCEL,		/* beginning to delete device
				 * Only error handler commands allowed */
	SDEV_DEL,		/* device deleted 
				 * no commands allowed */
	SDEV_QUIESCE,		/* Device quiescent.  No block commands
				 * will be accepted, only specials (which
				 * originate in the mid-layer) */
	SDEV_OFFLINE,		/* Device offlined (by error handling or
				 * user request */
	SDEV_BLOCK,		/* Device blocked by scsi lld.  No
				 * scsi commands from user or midlayer
				 * should be issued to the scsi
				 * lld. */
	SDEV_CREATED_BLOCK,	/* same as above but for created devices */
};

enum scsi_device_event {
	SDEV_EVT_MEDIA_CHANGE	= 1,	/* media has changed */

	SDEV_EVT_LAST		= SDEV_EVT_MEDIA_CHANGE,
	SDEV_EVT_MAXBITS	= SDEV_EVT_LAST + 1
};

struct scsi_event {
	enum scsi_device_event	evt_type;
	struct list_head	node;

	/* put union of data structures, for non-simple event types,
	 * here
	 */
};

struct scsi_device {
	struct Scsi_Host *host;
	struct request_queue *request_queue;

	/* the next two are protected by the host->host_lock */
	struct list_head    siblings;   /* list of all devices on this host */
	struct list_head    same_target_siblings; /* just the devices sharing same target id */

	/* this is now protected by the request_queue->queue_lock */
	unsigned int device_busy;	/* commands actually active on
					 * low-level. protected by queue_lock. */
	spinlock_t list_lock;
	struct list_head cmd_list;	/* queue of in use SCSI Command structures */
	struct list_head starved_entry;
	struct scsi_cmnd *current_cmnd;	/* currently active command */
	unsigned short queue_depth;	/* How deep of a queue we want */
	unsigned short max_queue_depth;	/* max queue depth */
	unsigned short last_queue_full_depth; /* These two are used by */
	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
	unsigned long last_queue_full_time;	/* last queue full time */
	unsigned long queue_ramp_up_period;	/* ramp up period in jiffies */
#define SCSI_DEFAULT_RAMP_UP_PERIOD	(120 * HZ)

	unsigned long last_queue_ramp_up;	/* last queue ramp up time */

	unsigned int id, lun, channel;

	unsigned int manufacturer;	/* Manufacturer of device, for using 
					 * vendor-specific cmd's */
	unsigned sector_size;	/* size in bytes */

	void *hostdata;		/* available to low-level driver */
	char type;
	char scsi_level;
	char inq_periph_qual;	/* PQ from INQUIRY data */	
	unsigned char inquiry_len;	/* valid bytes in 'inquiry' */
	unsigned char * inquiry;	/* INQUIRY response data */
	const char * vendor;		/* [back_compat] point into 'inquiry' ... */
	const char * model;		/* ... after scan; point to static string */
	const char * rev;		/* ... "nullnullnullnull" before scan */
	unsigned char current_tag;	/* current tag */
	struct scsi_target      *sdev_target;   /* used only for single_lun */

	unsigned int	sdev_bflags; /* black/white flags as also found in
				 * scsi_devinfo.[hc]. For now used only to
				 * pass settings from slave_alloc to scsi
				 * core. */
	unsigned writeable:1;
	unsigned removable:1;
	unsigned changed:1;	/* Data invalid due to media change */
	unsigned busy:1;	/* Used to prevent races */
	unsigned lockable:1;	/* Able to prevent media removal */
	unsigned locked:1;      /* Media removal disabled */
	unsigned borken:1;	/* Tell the Seagate driver to be 
				 * painfully slow on this device */
	unsigned disconnect:1;	/* can disconnect */
	unsigned soft_reset:1;	/* Uses soft reset option */
	unsigned sdtr:1;	/* Device supports SDTR messages */
	unsigned wdtr:1;	/* Device supports WDTR messages */
	unsigned ppr:1;		/* Device supports PPR messages */
	unsigned tagged_supported:1;	/* Supports SCSI-II tagged queuing */
	unsigned simple_tags:1;	/* simple queue tag messages are enabled */
	unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
	unsigned was_reset:1;	/* There was a bus reset on the bus for 
				 * this device */
	unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
				     * because we did a bus reset. */
	unsigned use_10_for_rw:1; /* first try 10-byte read / write */
	unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
	unsigned skip_ms_page_8:1;	/* do not use MODE SENSE page 0x08 */
	unsigned skip_ms_page_3f:1;	/* do not use MODE SENSE page 0x3f */
	unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
	unsigned no_start_on_add:1;	/* do not issue start on add */
	unsigned allow_restart:1; /* issue START_UNIT in error handler */
	unsigned manage_start_stop:1;	/* Let HLD (sd) manage start/stop */
	unsigned start_stop_pwr_cond:1;	/* Set power cond. in START_STOP_UNIT */
	unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
	unsigned select_no_atn:1;
	unsigned fix_capacity:1;	/* READ_CAPACITY is too high by 1 */
	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
	unsigned last_sector_bug:1;	/* do not use multisector accesses on
					   SD_LAST_BUGGY_SECTORS */

	DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
	struct list_head event_list;	/* asserted events */
	struct work_struct event_work;

	unsigned int device_blocked;	/* Device returned QUEUE_FULL. */

	unsigned int max_device_blocked; /* what device_blocked counts down from  */
#define SCSI_DEFAULT_DEVICE_BLOCKED	3

	atomic_t iorequest_cnt;
	atomic_t iodone_cnt;
	atomic_t ioerr_cnt;

	struct device		sdev_gendev,
				sdev_dev;

	struct execute_work	ew; /* used to get process context on put */

	struct scsi_dh_data	*scsi_dh_data;
	enum scsi_device_state sdev_state;
	unsigned long		sdev_data[0];
} __attribute__((aligned(sizeof(unsigned long))));

struct scsi_dh_devlist {
	char *vendor;
	char *model;
};

struct scsi_device_handler {
	/* Used by the infrastructure */
	struct list_head list; /* list of scsi_device_handlers */

	/* Filled by the hardware handler */
	struct module *module;
	const char *name;
	const struct scsi_dh_devlist *devlist;
	int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
	int (*attach)(struct scsi_device *);
	void (*detach)(struct scsi_device *);
	int (*activate)(struct scsi_device *);
	int (*prep_fn)(struct scsi_device *, struct request *);
	int (*set_params)(struct scsi_device *, const char *);
};

struct scsi_dh_data {
	struct scsi_device_handler *scsi_dh;
	struct scsi_device *sdev;
	struct kref kref;
	char buf[0];
};

#define	to_scsi_device(d)	\
	container_of(d, struct scsi_device, sdev_gendev)
#define	class_to_sdev(d)	\
	container_of(d, struct scsi_device, sdev_dev)
#define transport_class_to_sdev(class_dev) \
	to_scsi_device(class_dev->parent)

#define sdev_printk(prefix, sdev, fmt, a...)	\
	dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)

#define scmd_printk(prefix, scmd, fmt, a...)				\
        (scmd)->request->rq_disk ?					\
	sdev_printk(prefix, (scmd)->device, "[%s] " fmt,		\
		    (scmd)->request->rq_disk->disk_name, ##a) :		\
	sdev_printk(prefix, (scmd)->device, fmt, ##a)

enum scsi_target_state {
	STARGET_CREATED = 1,
	STARGET_RUNNING,
	STARGET_DEL,
};

/*
 * scsi_target: representation of a scsi target, for now, this is only
 * used for single_lun devices. If no one has active IO to the target,
 * starget_sdev_user is NULL, else it points to the active sdev.
 */
struct scsi_target {
	struct scsi_device	*starget_sdev_user;
	struct list_head	siblings;
	struct list_head	devices;
	struct device		dev;
	unsigned int		reap_ref; /* protected by the host lock */
	unsigned int		channel;
	unsigned int		id; /* target id ... replace
				     * scsi_device.id eventually */
	unsigned int		create:1; /* signal that it needs to be added */
	unsigned int		single_lun:1;	/* Indicates we should only
						 * allow I/O to one of the luns
						 * for the device at a time. */
	unsigned int		pdt_1f_for_no_lun;	/* PDT = 0x1f */
						/* means no lun present */
	/* commands actually active on LLD. protected by host lock. */
	unsigned int		target_busy;
	/*
	 * LLDs should set this in the slave_alloc host template callout.
	 * If set to zero then there is not limit.
	 */
	unsigned int		can_queue;
	unsigned int		target_blocked;
	unsigned int		max_target_blocked;
#define SCSI_DEFAULT_TARGET_BLOCKED	3

	char			scsi_level;
	struct execute_work	ew;
	enum scsi_target_state	state;
	void 			*hostdata; /* available to low-level driver */
	unsigned long		starget_data[0]; /* for the transport */
	/* starget_data must be the last element!!!! */
} __attribute__((aligned(sizeof(unsigned long))));

#define to_scsi_target(d)	container_of(d, struct scsi_target, dev)
static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
{
	return to_scsi_target(sdev->sdev_gendev.parent);
}
#define transport_class_to_starget(class_dev) \
	to_scsi_target(class_dev->parent)

#define starget_printk(prefix, starget, fmt, a...)	\
	dev_printk(prefix, &(starget)->dev, fmt, ##a)

extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
		uint, uint, uint, void *hostdata);
extern int scsi_add_device(struct Scsi_Host *host, uint channel,
			   uint target, uint lun);
extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
extern void scsi_remove_device(struct scsi_device *);
extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);

extern int scsi_device_get(struct scsi_device *);
extern void scsi_device_put(struct scsi_device *);
extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
					      uint, uint, uint);
extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
						uint, uint, uint);
extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
							uint);
extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
							  uint);
extern void starget_for_each_device(struct scsi_target *, void *,
		     void (*fn)(struct scsi_device *, void *));
extern void __starget_for_each_device(struct scsi_target *, void *,
				      void (*fn)(struct scsi_device *,
						 void *));

/* only exposed to implement shost_for_each_device */
extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
						  struct scsi_device *);

/**
 * shost_for_each_device - iterate over all devices of a host
 * @sdev: the &struct scsi_device to use as a cursor
 * @shost: the &struct scsi_host to iterate over
 *
 * Iterator that returns each device attached to @shost.  This loop
 * takes a reference on each device and releases it at the end.  If
 * you break out of the loop, you must call scsi_device_put(sdev).
 */
#define shost_for_each_device(sdev, shost) \
	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
	     (sdev); \
	     (sdev) = __scsi_iterate_devices((shost), (sdev)))

/**
 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
 * @sdev: the &struct scsi_device to use as a cursor
 * @shost: the &struct scsi_host to iterate over
 *
 * Iterator that returns each device attached to @shost.  It does _not_
 * take a reference on the scsi_device, so the whole loop must be
 * protected by shost->host_lock.
 *
 * Note: The only reason to use this is because you need to access the
 * device list in interrupt context.  Otherwise you really want to use
 * shost_for_each_device instead.
 */
#define __shost_for_each_device(sdev, shost) \
	list_for_each_entry((sdev), &((shost)->__devices), siblings)

extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
extern int scsi_track_queue_full(struct scsi_device *, int);

extern int scsi_set_medium_removal(struct scsi_device *, char);

extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
			   unsigned char *buffer, int len, int timeout,
			   int retries, struct scsi_mode_data *data,
			   struct scsi_sense_hdr *);
extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
			    int modepage, unsigned char *buffer, int len,
			    int timeout, int retries,
			    struct scsi_mode_data *data,
			    struct scsi_sense_hdr *);
extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
				int retries, struct scsi_sense_hdr *sshdr);
extern unsigned char *scsi_get_vpd_page(struct scsi_device *, u8 page);
extern int scsi_device_set_state(struct scsi_device *sdev,
				 enum scsi_device_state state);
extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
					  gfp_t gfpflags);
extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
extern void sdev_evt_send_simple(struct scsi_device *sdev,
			  enum scsi_device_event evt_type, gfp_t gfpflags);
extern int scsi_device_quiesce(struct scsi_device *sdev);
extern void scsi_device_resume(struct scsi_device *sdev);
extern void scsi_target_quiesce(struct scsi_target *);
extern void scsi_target_resume(struct scsi_target *);
extern void scsi_scan_target(struct device *parent, unsigned int channel,
			     unsigned int id, unsigned int lun, int rescan);
extern void scsi_target_reap(struct scsi_target *);
extern void scsi_target_block(struct device *);
extern void scsi_target_unblock(struct device *);
extern void scsi_remove_target(struct device *);
extern void int_to_scsilun(unsigned int, struct scsi_lun *);
extern int scsilun_to_int(struct scsi_lun *);
extern const char *scsi_device_state_name(enum scsi_device_state);
extern int scsi_is_sdev_device(const struct device *);
extern int scsi_is_target_device(const struct device *);
extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
			int data_direction, void *buffer, unsigned bufflen,
			unsigned char *sense, int timeout, int retries,
			int flag, int *resid);
extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
			    int data_direction, void *buffer, unsigned bufflen,
			    struct scsi_sense_hdr *, int timeout, int retries,
			    int *resid);

static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
{
	return device_reprobe(&sdev->sdev_gendev);
}

static inline unsigned int sdev_channel(struct scsi_device *sdev)
{
	return sdev->channel;
}

static inline unsigned int sdev_id(struct scsi_device *sdev)
{
	return sdev->id;
}

#define scmd_id(scmd) sdev_id((scmd)->device)
#define scmd_channel(scmd) sdev_channel((scmd)->device)

/*
 * checks for positions of the SCSI state machine
 */
static inline int scsi_device_online(struct scsi_device *sdev)
{
	return (sdev->sdev_state != SDEV_OFFLINE &&
		sdev->sdev_state != SDEV_DEL);
}
static inline int scsi_device_blocked(struct scsi_device *sdev)
{
	return sdev->sdev_state == SDEV_BLOCK ||
		sdev->sdev_state == SDEV_CREATED_BLOCK;
}
static inline int scsi_device_created(struct scsi_device *sdev)
{
	return sdev->sdev_state == SDEV_CREATED ||
		sdev->sdev_state == SDEV_CREATED_BLOCK;
}

/* accessor functions for the SCSI parameters */
static inline int scsi_device_sync(struct scsi_device *sdev)
{
	return sdev->sdtr;
}
static inline int scsi_device_wide(struct scsi_device *sdev)
{
	return sdev->wdtr;
}
static inline int scsi_device_dt(struct scsi_device *sdev)
{
	return sdev->ppr;
}
static inline int scsi_device_dt_only(struct scsi_device *sdev)
{
	if (sdev->inquiry_len < 57)
		return 0;
	return (sdev->inquiry[56] & 0x0c) == 0x04;
}
static inline int scsi_device_ius(struct scsi_device *sdev)
{
	if (sdev->inquiry_len < 57)
		return 0;
	return sdev->inquiry[56] & 0x01;
}
static inline int scsi_device_qas(struct scsi_device *sdev)
{
	if (sdev->inquiry_len < 57)
		return 0;
	return sdev->inquiry[56] & 0x02;
}
static inline int scsi_device_enclosure(struct scsi_device *sdev)
{
	return sdev->inquiry[6] & (1<<6);
}

static inline int scsi_device_protection(struct scsi_device *sdev)
{
	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
}

#define MODULE_ALIAS_SCSI_DEVICE(type) \
	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"

#endif /* _SCSI_SCSI_DEVICE_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _SCSI_SCSI_DEVICE_H
	2	#define _SCSI_SCSI_DEVICE_H
	3
	4	#include <linux/device.h>
	5	#include <linux/list.h>
	6	#include <linux/spinlock.h>
ffedb452	7	#include <linux/workqueue.h>
a4d04a4c	8	#include <linux/blkdev.h>
d211f052	9	#include <scsi/scsi.h>
1da177e4 LT	10	#include <asm/atomic.h>
	11
	12	struct request_queue;
	13	struct scsi_cmnd;
e10fb91c	14	struct scsi_lun;
ea73a9f2	15	struct scsi_sense_hdr;
1da177e4	16
1cf72699 JB	17	struct scsi_mode_data {
	18	__u32 length;
	19	__u16 block_descriptor_length;
	20	__u8 medium_type;
	21	__u8 device_specific;
	22	__u8 header_length;
	23	__u8 longlba:1;
	24	};
	25
1da177e4 LT	26	/*
	27	* sdev state: If you alter this, you also need to alter scsi_sysfs.c
	28	* (for the ascii descriptions) and the state model enforcer:
	29	* scsi_lib:scsi_device_set_state().
	30	*/
	31	enum scsi_device_state {
	32	SDEV_CREATED = 1, /* device created but not added to sysfs
	33	* Only internal commands allowed (for inq) */
	34	SDEV_RUNNING, /* device properly configured
	35	* All commands allowed */
	36	SDEV_CANCEL, /* beginning to delete device
	37	* Only error handler commands allowed */
	38	SDEV_DEL, /* device deleted
	39	* no commands allowed */
	40	SDEV_QUIESCE, /* Device quiescent. No block commands
	41	* will be accepted, only specials (which
	42	* originate in the mid-layer) */
	43	SDEV_OFFLINE, /* Device offlined (by error handling or
	44	* user request */
6f4267e3 JB	45	SDEV_BLOCK, /* Device blocked by scsi lld. No
	46	* scsi commands from user or midlayer
	47	* should be issued to the scsi
	48	* lld. */
	49	SDEV_CREATED_BLOCK, /* same as above but for created devices */
1da177e4 LT	50	};
1da177e4 LT	51
a341cd0f JG	52	enum scsi_device_event {
	53	SDEV_EVT_MEDIA_CHANGE = 1, /* media has changed */
	54
	55	SDEV_EVT_LAST = SDEV_EVT_MEDIA_CHANGE,
	56	SDEV_EVT_MAXBITS = SDEV_EVT_LAST + 1
	57	};
	58
	59	struct scsi_event {
	60	enum scsi_device_event evt_type;
	61	struct list_head node;
	62
	63	/* put union of data structures, for non-simple event types,
	64	* here
	65	*/
	66	};
	67
1da177e4 LT	68	struct scsi_device {
	69	struct Scsi_Host *host;
	70	struct request_queue *request_queue;
	71
	72	/* the next two are protected by the host->host_lock */
	73	struct list_head siblings; /* list of all devices on this host */
	74	struct list_head same_target_siblings; /* just the devices sharing same target id */
	75
c2a9331c	76	/* this is now protected by the request_queue->queue_lock */
06f81ea8 TH	77	unsigned int device_busy; /* commands actually active on
06f81ea8 TH	78	* low-level. protected by queue_lock. */
1da177e4 LT	79	spinlock_t list_lock;
	80	struct list_head cmd_list; /* queue of in use SCSI Command structures */
	81	struct list_head starved_entry;
	82	struct scsi_cmnd current_cmnd; / currently active command */
	83	unsigned short queue_depth; /* How deep of a queue we want */
4a84067d	84	unsigned short max_queue_depth; /* max queue depth */
1da177e4 LT	85	unsigned short last_queue_full_depth; /* These two are used by */
1da177e4 LT	86	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
4a84067d VD	87	unsigned long last_queue_full_time; /* last queue full time */
	88	unsigned long queue_ramp_up_period; /* ramp up period in jiffies */
	89	#define SCSI_DEFAULT_RAMP_UP_PERIOD (120 * HZ)
	90
	91	unsigned long last_queue_ramp_up; /* last queue ramp up time */
1da177e4 LT	92
	93	unsigned int id, lun, channel;
	94
	95	unsigned int manufacturer; /* Manufacturer of device, for using
	96	* vendor-specific cmd's */
	97	unsigned sector_size; /* size in bytes */
	98
	99	void hostdata; / available to low-level driver */
1da177e4 LT	100	char type;
	101	char scsi_level;
	102	char inq_periph_qual; /* PQ from INQUIRY data */
	103	unsigned char inquiry_len; /* valid bytes in 'inquiry' */
	104	unsigned char * inquiry; /* INQUIRY response data */
7f23e146 JB	105	const char * vendor; /* [back_compat] point into 'inquiry' ... */
	106	const char * model; /* ... after scan; point to static string */
	107	const char * rev; /* ... "nullnullnullnull" before scan */
1da177e4 LT	108	unsigned char current_tag; /* current tag */
	109	struct scsi_target sdev_target; / used only for single_lun */
	110
	111	unsigned int sdev_bflags; /* black/white flags as also found in
	112	* scsi_devinfo.[hc]. For now used only to
	113	* pass settings from slave_alloc to scsi
	114	* core. */
	115	unsigned writeable:1;
	116	unsigned removable:1;
	117	unsigned changed:1; /* Data invalid due to media change */
	118	unsigned busy:1; /* Used to prevent races */
	119	unsigned lockable:1; /* Able to prevent media removal */
	120	unsigned locked:1; /* Media removal disabled */
	121	unsigned borken:1; /* Tell the Seagate driver to be
	122	* painfully slow on this device */
	123	unsigned disconnect:1; /* can disconnect */
	124	unsigned soft_reset:1; /* Uses soft reset option */
	125	unsigned sdtr:1; /* Device supports SDTR messages */
	126	unsigned wdtr:1; /* Device supports WDTR messages */
	127	unsigned ppr:1; /* Device supports PPR messages */
	128	unsigned tagged_supported:1; /* Supports SCSI-II tagged queuing */
	129	unsigned simple_tags:1; /* simple queue tag messages are enabled */
	130	unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
1da177e4 LT	131	unsigned was_reset:1; /* There was a bus reset on the bus for
	132	* this device */
	133	unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
	134	* because we did a bus reset. */
	135	unsigned use_10_for_rw:1; /* first try 10-byte read / write */
	136	unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
	137	unsigned skip_ms_page_8:1; /* do not use MODE SENSE page 0x08 */
	138	unsigned skip_ms_page_3f:1; /* do not use MODE SENSE page 0x3f */
	139	unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
	140	unsigned no_start_on_add:1; /* do not issue start on add */
	141	unsigned allow_restart:1; /* issue START_UNIT in error handler */
c3c94c5a	142	unsigned manage_start_stop:1; /* Let HLD (sd) manage start/stop */
d2886ea3	143	unsigned start_stop_pwr_cond:1; /* Set power cond. in START_STOP_UNIT */
1da177e4 LT	144	unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
	145	unsigned select_no_atn:1;
	146	unsigned fix_capacity:1; /* READ_CAPACITY is too high by 1 */
61bf54b7	147	unsigned guess_capacity:1; /* READ_CAPACITY might be too high by 1 */
1da177e4	148	unsigned retry_hwerror:1; /* Retry HARDWARE_ERROR */
18351070 LT	149	unsigned last_sector_bug:1; /* do not use multisector accesses on
18351070 LT	150	SD_LAST_BUGGY_SECTORS */
1da177e4	151
a341cd0f JG	152	DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
	153	struct list_head event_list; /* asserted events */
	154	struct work_struct event_work;
	155
1da177e4 LT	156	unsigned int device_blocked; /* Device returned QUEUE_FULL. */
	157
	158	unsigned int max_device_blocked; /* what device_blocked counts down from */
	159	#define SCSI_DEFAULT_DEVICE_BLOCKED 3
	160
	161	atomic_t iorequest_cnt;
	162	atomic_t iodone_cnt;
	163	atomic_t ioerr_cnt;
	164
ee959b00 TJ	165	struct device sdev_gendev,
ee959b00 TJ	166	sdev_dev;
1da177e4	167
ffedb452 JB	168	struct execute_work ew; /* used to get process context on put */
ffedb452 JB	169
a6a8d9f8	170	struct scsi_dh_data *scsi_dh_data;
1da177e4 LT	171	enum scsi_device_state sdev_state;
	172	unsigned long sdev_data[0];
	173	} __attribute__((aligned(sizeof(unsigned long))));
a6a8d9f8	174
765cbc6d HR	175	struct scsi_dh_devlist {
	176	char *vendor;
	177	char *model;
	178	};
	179
a6a8d9f8 CS	180	struct scsi_device_handler {
	181	/* Used by the infrastructure */
	182	struct list_head list; /* list of scsi_device_handlers */
a6a8d9f8 CS	183
	184	/* Filled by the hardware handler */
	185	struct module *module;
	186	const char *name;
765cbc6d	187	const struct scsi_dh_devlist *devlist;
a6a8d9f8	188	int (check_sense)(struct scsi_device , struct scsi_sense_hdr *);
765cbc6d HR	189	int (attach)(struct scsi_device );
765cbc6d HR	190	void (detach)(struct scsi_device );
a6a8d9f8 CS	191	int (activate)(struct scsi_device );
a6a8d9f8 CS	192	int (prep_fn)(struct scsi_device , struct request *);
18ee70c9	193	int (set_params)(struct scsi_device , const char *);
a6a8d9f8 CS	194	};
	195
	196	struct scsi_dh_data {
	197	struct scsi_device_handler *scsi_dh;
6c10db72 CS	198	struct scsi_device *sdev;
6c10db72 CS	199	struct kref kref;
a6a8d9f8 CS	200	char buf[0];
	201	};
	202
1da177e4 LT	203	#define to_scsi_device(d) \
	204	container_of(d, struct scsi_device, sdev_gendev)
	205	#define class_to_sdev(d) \
ee959b00	206	container_of(d, struct scsi_device, sdev_dev)
1da177e4	207	#define transport_class_to_sdev(class_dev) \
ee959b00	208	to_scsi_device(class_dev->parent)
1da177e4	209
9ccfc756 JB	210	#define sdev_printk(prefix, sdev, fmt, a...) \
	211	dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
	212
a4d04a4c MP	213	#define scmd_printk(prefix, scmd, fmt, a...) \
	214	(scmd)->request->rq_disk ? \
	215	sdev_printk(prefix, (scmd)->device, "[%s] " fmt, \
	216	(scmd)->request->rq_disk->disk_name, ##a) : \
	217	sdev_printk(prefix, (scmd)->device, fmt, ##a)
01d7b3b8	218
ffedb452	219	enum scsi_target_state {
643eb2d9 JB	220	STARGET_CREATED = 1,
643eb2d9 JB	221	STARGET_RUNNING,
ffedb452 JB	222	STARGET_DEL,
	223	};
	224
1da177e4 LT	225	/*
	226	* scsi_target: representation of a scsi target, for now, this is only
	227	* used for single_lun devices. If no one has active IO to the target,
	228	* starget_sdev_user is NULL, else it points to the active sdev.
	229	*/
	230	struct scsi_target {
	231	struct scsi_device *starget_sdev_user;
	232	struct list_head siblings;
	233	struct list_head devices;
	234	struct device dev;
	235	unsigned int reap_ref; /* protected by the host lock */
	236	unsigned int channel;
	237	unsigned int id; /* target id ... replace
	238	* scsi_device.id eventually */
1bfc5d9d	239	unsigned int create:1; /* signal that it needs to be added */
25d7c363 TB	240	unsigned int single_lun:1; /* Indicates we should only
	241	* allow I/O to one of the luns
	242	* for the device at a time. */
1bfc5d9d AS	243	unsigned int pdt_1f_for_no_lun; /* PDT = 0x1f */
1bfc5d9d AS	244	/* means no lun present */
f0c0a376 MC	245	/* commands actually active on LLD. protected by host lock. */
	246	unsigned int target_busy;
	247	/*
	248	* LLDs should set this in the slave_alloc host template callout.
	249	* If set to zero then there is not limit.
	250	*/
	251	unsigned int can_queue;
	252	unsigned int target_blocked;
	253	unsigned int max_target_blocked;
	254	#define SCSI_DEFAULT_TARGET_BLOCKED 3
1bfc5d9d	255
6f3a2024	256	char scsi_level;
ffedb452 JB	257	struct execute_work ew;
ffedb452 JB	258	enum scsi_target_state state;
a283bd37 JB	259	void hostdata; / available to low-level driver */
	260	unsigned long starget_data[0]; /* for the transport */
	261	/* starget_data must be the last element!!!! */
1da177e4 LT	262	} __attribute__((aligned(sizeof(unsigned long))));
	263
	264	#define to_scsi_target(d) container_of(d, struct scsi_target, dev)
	265	static inline struct scsi_target scsi_target(struct scsi_device sdev)
	266	{
	267	return to_scsi_target(sdev->sdev_gendev.parent);
	268	}
	269	#define transport_class_to_starget(class_dev) \
ee959b00	270	to_scsi_target(class_dev->parent)
1da177e4	271
9ccfc756 JB	272	#define starget_printk(prefix, starget, fmt, a...) \
	273	dev_printk(prefix, &(starget)->dev, fmt, ##a)
	274
1da177e4 LT	275	extern struct scsi_device __scsi_add_device(struct Scsi_Host ,
1da177e4 LT	276	uint, uint, uint, void *hostdata);
146f7262 JB	277	extern int scsi_add_device(struct Scsi_Host *host, uint channel,
146f7262 JB	278	uint target, uint lun);
a6a8d9f8	279	extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
1da177e4	280	extern void scsi_remove_device(struct scsi_device *);
a6a8d9f8	281	extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
1da177e4 LT	282
	283	extern int scsi_device_get(struct scsi_device *);
	284	extern void scsi_device_put(struct scsi_device *);
	285	extern struct scsi_device scsi_device_lookup(struct Scsi_Host ,
	286	uint, uint, uint);
	287	extern struct scsi_device __scsi_device_lookup(struct Scsi_Host ,
	288	uint, uint, uint);
	289	extern struct scsi_device scsi_device_lookup_by_target(struct scsi_target ,
	290	uint);
	291	extern struct scsi_device __scsi_device_lookup_by_target(struct scsi_target ,
	292	uint);
	293	extern void starget_for_each_device(struct scsi_target , void ,
	294	void (fn)(struct scsi_device , void *));
522939d4 MR	295	extern void __starget_for_each_device(struct scsi_target , void ,
	296	void (fn)(struct scsi_device ,
	297	void *));
1da177e4 LT	298
	299	/* only exposed to implement shost_for_each_device */
	300	extern struct scsi_device __scsi_iterate_devices(struct Scsi_Host ,
	301	struct scsi_device *);
	302
	303	/**
3e082a91 MW	304	* shost_for_each_device - iterate over all devices of a host
	305	* @sdev: the &struct scsi_device to use as a cursor
	306	* @shost: the &struct scsi_host to iterate over
1da177e4	307	*
3e082a91 MW	308	* Iterator that returns each device attached to @shost. This loop
	309	* takes a reference on each device and releases it at the end. If
	310	* you break out of the loop, you must call scsi_device_put(sdev).
1da177e4 LT	311	*/
	312	#define shost_for_each_device(sdev, shost) \
	313	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
	314	(sdev); \
	315	(sdev) = __scsi_iterate_devices((shost), (sdev)))
	316
	317	/**
3e082a91 MW	318	* __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
	319	* @sdev: the &struct scsi_device to use as a cursor
	320	* @shost: the &struct scsi_host to iterate over
1da177e4	321	*
3e082a91 MW	322	* Iterator that returns each device attached to @shost. It does _not_
	323	* take a reference on the scsi_device, so the whole loop must be
	324	* protected by shost->host_lock.
1da177e4	325	*
3e082a91 MW	326	* Note: The only reason to use this is because you need to access the
	327	* device list in interrupt context. Otherwise you really want to use
	328	* shost_for_each_device instead.
1da177e4 LT	329	*/
	330	#define __shost_for_each_device(sdev, shost) \
	331	list_for_each_entry((sdev), &((shost)->__devices), siblings)
	332
	333	extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
	334	extern int scsi_track_queue_full(struct scsi_device *, int);
	335
	336	extern int scsi_set_medium_removal(struct scsi_device *, char);
	337
	338	extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
	339	unsigned char *buffer, int len, int timeout,
1cf72699	340	int retries, struct scsi_mode_data *data,
ea73a9f2	341	struct scsi_sense_hdr *);
5baba830 JB	342	extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
	343	int modepage, unsigned char *buffer, int len,
	344	int timeout, int retries,
	345	struct scsi_mode_data *data,
	346	struct scsi_sense_hdr *);
1da177e4	347	extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
001aac25	348	int retries, struct scsi_sense_hdr *sshdr);
881a256d	349	extern unsigned char scsi_get_vpd_page(struct scsi_device , u8 page);
1da177e4 LT	350	extern int scsi_device_set_state(struct scsi_device *sdev,
1da177e4 LT	351	enum scsi_device_state state);
a341cd0f JG	352	extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
	353	gfp_t gfpflags);
	354	extern void sdev_evt_send(struct scsi_device sdev, struct scsi_event evt);
	355	extern void sdev_evt_send_simple(struct scsi_device *sdev,
	356	enum scsi_device_event evt_type, gfp_t gfpflags);
1da177e4 LT	357	extern int scsi_device_quiesce(struct scsi_device *sdev);
	358	extern void scsi_device_resume(struct scsi_device *sdev);
	359	extern void scsi_target_quiesce(struct scsi_target *);
	360	extern void scsi_target_resume(struct scsi_target *);
	361	extern void scsi_scan_target(struct device *parent, unsigned int channel,
	362	unsigned int id, unsigned int lun, int rescan);
	363	extern void scsi_target_reap(struct scsi_target *);
	364	extern void scsi_target_block(struct device *);
	365	extern void scsi_target_unblock(struct device *);
	366	extern void scsi_remove_target(struct device *);
2f4701d8	367	extern void int_to_scsilun(unsigned int, struct scsi_lun *);
462b7859	368	extern int scsilun_to_int(struct scsi_lun *);
1da177e4 LT	369	extern const char *scsi_device_state_name(enum scsi_device_state);
	370	extern int scsi_is_sdev_device(const struct device *);
	371	extern int scsi_is_target_device(const struct device *);
33aa687d JB	372	extern int scsi_execute(struct scsi_device sdev, const unsigned char cmd,
	373	int data_direction, void *buffer, unsigned bufflen,
	374	unsigned char *sense, int timeout, int retries,
f4f4e47e	375	int flag, int *resid);
ea73a9f2 JB	376	extern int scsi_execute_req(struct scsi_device sdev, const unsigned char cmd,
ea73a9f2 JB	377	int data_direction, void *buffer, unsigned bufflen,
f4f4e47e FT	378	struct scsi_sense_hdr *, int timeout, int retries,
f4f4e47e FT	379	int *resid);
33aa687d	380
cb5d9e09	381	static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
e28482c5	382	{
cb5d9e09	383	return device_reprobe(&sdev->sdev_gendev);
e28482c5 JB	384	}
e28482c5 JB	385
01d7b3b8 JG	386	static inline unsigned int sdev_channel(struct scsi_device *sdev)
	387	{
	388	return sdev->channel;
	389	}
	390
	391	static inline unsigned int sdev_id(struct scsi_device *sdev)
	392	{
	393	return sdev->id;
	394	}
	395
	396	#define scmd_id(scmd) sdev_id((scmd)->device)
	397	#define scmd_channel(scmd) sdev_channel((scmd)->device)
	398
0f1d87a2 JB	399	/*
	400	* checks for positions of the SCSI state machine
	401	*/
1da177e4 LT	402	static inline int scsi_device_online(struct scsi_device *sdev)
1da177e4 LT	403	{
0762a482 HR	404	return (sdev->sdev_state != SDEV_OFFLINE &&
0762a482 HR	405	sdev->sdev_state != SDEV_DEL);
1da177e4	406	}
0f1d87a2 JB	407	static inline int scsi_device_blocked(struct scsi_device *sdev)
0f1d87a2 JB	408	{
6f4267e3 JB	409	return sdev->sdev_state == SDEV_BLOCK \|\|
6f4267e3 JB	410	sdev->sdev_state == SDEV_CREATED_BLOCK;
0f1d87a2 JB	411	}
	412	static inline int scsi_device_created(struct scsi_device *sdev)
	413	{
6f4267e3 JB	414	return sdev->sdev_state == SDEV_CREATED \|\|
6f4267e3 JB	415	sdev->sdev_state == SDEV_CREATED_BLOCK;
0f1d87a2	416	}
1da177e4 LT	417
	418	/* accessor functions for the SCSI parameters */
	419	static inline int scsi_device_sync(struct scsi_device *sdev)
	420	{
	421	return sdev->sdtr;
	422	}
	423	static inline int scsi_device_wide(struct scsi_device *sdev)
	424	{
	425	return sdev->wdtr;
	426	}
	427	static inline int scsi_device_dt(struct scsi_device *sdev)
	428	{
	429	return sdev->ppr;
	430	}
	431	static inline int scsi_device_dt_only(struct scsi_device *sdev)
	432	{
	433	if (sdev->inquiry_len < 57)
	434	return 0;
	435	return (sdev->inquiry[56] & 0x0c) == 0x04;
	436	}
	437	static inline int scsi_device_ius(struct scsi_device *sdev)
	438	{
	439	if (sdev->inquiry_len < 57)
	440	return 0;
	441	return sdev->inquiry[56] & 0x01;
	442	}
	443	static inline int scsi_device_qas(struct scsi_device *sdev)
	444	{
	445	if (sdev->inquiry_len < 57)
	446	return 0;
	447	return sdev->inquiry[56] & 0x02;
	448	}
b30c2fc1 JB	449	static inline int scsi_device_enclosure(struct scsi_device *sdev)
	450	{
	451	return sdev->inquiry[6] & (1<<6);
	452	}
d7b8bcb0	453
7027ad72 MP	454	static inline int scsi_device_protection(struct scsi_device *sdev)
7027ad72 MP	455	{
d211f052	456	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
7027ad72 MP	457	}
7027ad72 MP	458
d7b8bcb0 MT	459	#define MODULE_ALIAS_SCSI_DEVICE(type) \
	460	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
	461	#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
	462
1da177e4	463	#endif /* _SCSI_SCSI_DEVICE_H */