[mirror_ubuntu-bionic-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 <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. */
};

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 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;/* don't let QUEUE_FULLs on the same
					   jiffie count on our counter, they
					   could all be from the same event. */

	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 single_lun:1;	/* Indicates we should only allow I/O to
				 * one of the luns for the device at a 
				 * time. */
	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 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 */

	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;

	int timeout;

	struct device		sdev_gendev;
	struct class_device	sdev_classdev;

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

	enum scsi_device_state sdev_state;
	unsigned long		sdev_data[0];
} __attribute__((aligned(sizeof(unsigned long))));
#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_classdev)
#define transport_class_to_sdev(class_dev) \
	to_scsi_device(class_dev->dev)

#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_RUNNING = 1,
	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		pdt_1f_for_no_lun;	/* PDT = 0x1f */
						/* means no lun present */

	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->dev)

#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 void scsi_remove_device(struct scsi_device *);

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 *));

/* 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);
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);
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);
extern int scsi_execute_async(struct scsi_device *sdev,
			      const unsigned char *cmd, int cmd_len, int data_direction,
			      void *buffer, unsigned bufflen, int use_sg,
			      int timeout, int retries, void *privdata,
			      void (*done)(void *, char *, int, int),
			      gfp_t gfp);

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)

static inline int scsi_device_online(struct scsi_device *sdev)
{
	return sdev->sdev_state != SDEV_OFFLINE;
}

/* 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;
}

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