Linux Audio

Check our new training course

Loading...
v3.1
  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>
  7#include <linux/workqueue.h>
  8#include <linux/blkdev.h>
  9#include <scsi/scsi.h>
 10#include <linux/atomic.h>
 11
 
 12struct request_queue;
 13struct scsi_cmnd;
 14struct scsi_lun;
 15struct scsi_sense_hdr;
 16
 17struct 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
 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 */
 31enum 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 */
 
 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 */
 50};
 51
 52enum 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
 59struct 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
 68struct 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
 76	/* this is now protected by the request_queue->queue_lock */
 77	unsigned int device_busy;	/* commands actually active on
 78					 * low-level. protected by queue_lock. */
 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 */
 84	unsigned short max_queue_depth;	/* max queue depth */
 85	unsigned short last_queue_full_depth; /* These two are used by */
 86	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
 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 */
 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 */
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 */
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 */
 
 
 
 
 
 
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 */
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 */
142	unsigned manage_start_stop:1;	/* Let HLD (sd) manage start/stop */
143	unsigned start_stop_pwr_cond:1;	/* Set power cond. in START_STOP_UNIT */
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 */
147	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
148	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
149	unsigned last_sector_bug:1;	/* do not use multisector accesses on
150					   SD_LAST_BUGGY_SECTORS */
151	unsigned no_read_disc_info:1;	/* Avoid READ_DISC_INFO cmds */
152	unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
 
153	unsigned is_visible:1;	/* is the device visible in sysfs */
 
 
 
 
154
155	DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
 
156	struct list_head event_list;	/* asserted events */
157	struct work_struct event_work;
158
159	unsigned int device_blocked;	/* Device returned QUEUE_FULL. */
160
161	unsigned int max_device_blocked; /* what device_blocked counts down from  */
162#define SCSI_DEFAULT_DEVICE_BLOCKED	3
163
164	atomic_t iorequest_cnt;
165	atomic_t iodone_cnt;
166	atomic_t ioerr_cnt;
167
168	struct device		sdev_gendev,
169				sdev_dev;
170
171	struct execute_work	ew; /* used to get process context on put */
172	struct work_struct	requeue_work;
173
174	struct scsi_dh_data	*scsi_dh_data;
175	enum scsi_device_state sdev_state;
176	unsigned long		sdev_data[0];
177} __attribute__((aligned(sizeof(unsigned long))));
178
179struct scsi_dh_devlist {
180	char *vendor;
181	char *model;
182};
183
184typedef void (*activate_complete)(void *, int);
185struct scsi_device_handler {
186	/* Used by the infrastructure */
187	struct list_head list; /* list of scsi_device_handlers */
188	int idx;
189
190	/* Filled by the hardware handler */
191	struct module *module;
192	const char *name;
193	const struct scsi_dh_devlist *devlist;
194	int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
195	int (*attach)(struct scsi_device *);
196	void (*detach)(struct scsi_device *);
197	int (*activate)(struct scsi_device *, activate_complete, void *);
198	int (*prep_fn)(struct scsi_device *, struct request *);
199	int (*set_params)(struct scsi_device *, const char *);
 
200};
201
202struct scsi_dh_data {
203	struct scsi_device_handler *scsi_dh;
204	struct scsi_device *sdev;
205	struct kref kref;
206	char buf[0];
207};
208
209#define	to_scsi_device(d)	\
210	container_of(d, struct scsi_device, sdev_gendev)
211#define	class_to_sdev(d)	\
212	container_of(d, struct scsi_device, sdev_dev)
213#define transport_class_to_sdev(class_dev) \
214	to_scsi_device(class_dev->parent)
215
216#define sdev_printk(prefix, sdev, fmt, a...)	\
217	dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
218
 
 
 
219#define scmd_printk(prefix, scmd, fmt, a...)				\
220        (scmd)->request->rq_disk ?					\
221	sdev_printk(prefix, (scmd)->device, "[%s] " fmt,		\
222		    (scmd)->request->rq_disk->disk_name, ##a) :		\
223	sdev_printk(prefix, (scmd)->device, fmt, ##a)
224
 
 
 
 
 
 
 
 
 
225enum scsi_target_state {
226	STARGET_CREATED = 1,
227	STARGET_RUNNING,
228	STARGET_DEL,
229};
230
231/*
232 * scsi_target: representation of a scsi target, for now, this is only
233 * used for single_lun devices. If no one has active IO to the target,
234 * starget_sdev_user is NULL, else it points to the active sdev.
235 */
236struct scsi_target {
237	struct scsi_device	*starget_sdev_user;
238	struct list_head	siblings;
239	struct list_head	devices;
240	struct device		dev;
241	unsigned int		reap_ref; /* protected by the host lock */
242	unsigned int		channel;
243	unsigned int		id; /* target id ... replace
244				     * scsi_device.id eventually */
245	unsigned int		create:1; /* signal that it needs to be added */
246	unsigned int		single_lun:1;	/* Indicates we should only
247						 * allow I/O to one of the luns
248						 * for the device at a time. */
249	unsigned int		pdt_1f_for_no_lun;	/* PDT = 0x1f */
250						/* means no lun present */
 
 
 
 
 
251	/* commands actually active on LLD. protected by host lock. */
252	unsigned int		target_busy;
253	/*
254	 * LLDs should set this in the slave_alloc host template callout.
255	 * If set to zero then there is not limit.
256	 */
257	unsigned int		can_queue;
258	unsigned int		target_blocked;
259	unsigned int		max_target_blocked;
260#define SCSI_DEFAULT_TARGET_BLOCKED	3
261
262	char			scsi_level;
263	struct execute_work	ew;
264	enum scsi_target_state	state;
265	void 			*hostdata; /* available to low-level driver */
266	unsigned long		starget_data[0]; /* for the transport */
267	/* starget_data must be the last element!!!! */
268} __attribute__((aligned(sizeof(unsigned long))));
269
270#define to_scsi_target(d)	container_of(d, struct scsi_target, dev)
271static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
272{
273	return to_scsi_target(sdev->sdev_gendev.parent);
274}
275#define transport_class_to_starget(class_dev) \
276	to_scsi_target(class_dev->parent)
277
278#define starget_printk(prefix, starget, fmt, a...)	\
279	dev_printk(prefix, &(starget)->dev, fmt, ##a)
280
281extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
282		uint, uint, uint, void *hostdata);
283extern int scsi_add_device(struct Scsi_Host *host, uint channel,
284			   uint target, uint lun);
285extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
286extern void scsi_remove_device(struct scsi_device *);
287extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
 
288
289extern int scsi_device_get(struct scsi_device *);
290extern void scsi_device_put(struct scsi_device *);
291extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
292					      uint, uint, uint);
293extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
294						uint, uint, uint);
295extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
296							uint);
297extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
298							  uint);
299extern void starget_for_each_device(struct scsi_target *, void *,
300		     void (*fn)(struct scsi_device *, void *));
301extern void __starget_for_each_device(struct scsi_target *, void *,
302				      void (*fn)(struct scsi_device *,
303						 void *));
304
305/* only exposed to implement shost_for_each_device */
306extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
307						  struct scsi_device *);
308
309/**
310 * shost_for_each_device - iterate over all devices of a host
311 * @sdev: the &struct scsi_device to use as a cursor
312 * @shost: the &struct scsi_host to iterate over
313 *
314 * Iterator that returns each device attached to @shost.  This loop
315 * takes a reference on each device and releases it at the end.  If
316 * you break out of the loop, you must call scsi_device_put(sdev).
317 */
318#define shost_for_each_device(sdev, shost) \
319	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
320	     (sdev); \
321	     (sdev) = __scsi_iterate_devices((shost), (sdev)))
322
323/**
324 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
325 * @sdev: the &struct scsi_device to use as a cursor
326 * @shost: the &struct scsi_host to iterate over
327 *
328 * Iterator that returns each device attached to @shost.  It does _not_
329 * take a reference on the scsi_device, so the whole loop must be
330 * protected by shost->host_lock.
331 *
332 * Note: The only reason to use this is because you need to access the
333 * device list in interrupt context.  Otherwise you really want to use
334 * shost_for_each_device instead.
335 */
336#define __shost_for_each_device(sdev, shost) \
337	list_for_each_entry((sdev), &((shost)->__devices), siblings)
338
339extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
340extern int scsi_track_queue_full(struct scsi_device *, int);
341
342extern int scsi_set_medium_removal(struct scsi_device *, char);
343
344extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
345			   unsigned char *buffer, int len, int timeout,
346			   int retries, struct scsi_mode_data *data,
347			   struct scsi_sense_hdr *);
348extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
349			    int modepage, unsigned char *buffer, int len,
350			    int timeout, int retries,
351			    struct scsi_mode_data *data,
352			    struct scsi_sense_hdr *);
353extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
354				int retries, struct scsi_sense_hdr *sshdr);
355extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
356			     int buf_len);
 
 
357extern int scsi_device_set_state(struct scsi_device *sdev,
358				 enum scsi_device_state state);
359extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
360					  gfp_t gfpflags);
361extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
362extern void sdev_evt_send_simple(struct scsi_device *sdev,
363			  enum scsi_device_event evt_type, gfp_t gfpflags);
364extern int scsi_device_quiesce(struct scsi_device *sdev);
365extern void scsi_device_resume(struct scsi_device *sdev);
366extern void scsi_target_quiesce(struct scsi_target *);
367extern void scsi_target_resume(struct scsi_target *);
368extern void scsi_scan_target(struct device *parent, unsigned int channel,
369			     unsigned int id, unsigned int lun, int rescan);
370extern void scsi_target_reap(struct scsi_target *);
371extern void scsi_target_block(struct device *);
372extern void scsi_target_unblock(struct device *);
373extern void scsi_remove_target(struct device *);
374extern void int_to_scsilun(unsigned int, struct scsi_lun *);
375extern int scsilun_to_int(struct scsi_lun *);
376extern const char *scsi_device_state_name(enum scsi_device_state);
377extern int scsi_is_sdev_device(const struct device *);
378extern int scsi_is_target_device(const struct device *);
379extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
380			int data_direction, void *buffer, unsigned bufflen,
381			unsigned char *sense, int timeout, int retries,
382			int flag, int *resid);
383extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
384			    int data_direction, void *buffer, unsigned bufflen,
385			    struct scsi_sense_hdr *, int timeout, int retries,
386			    int *resid);
 
 
 
 
 
 
 
 
 
 
387
388#ifdef CONFIG_PM_RUNTIME
389extern int scsi_autopm_get_device(struct scsi_device *);
390extern void scsi_autopm_put_device(struct scsi_device *);
391#else
392static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
393static inline void scsi_autopm_put_device(struct scsi_device *d) {}
394#endif /* CONFIG_PM_RUNTIME */
395
396static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
397{
398	return device_reprobe(&sdev->sdev_gendev);
399}
400
401static inline unsigned int sdev_channel(struct scsi_device *sdev)
402{
403	return sdev->channel;
404}
405
406static inline unsigned int sdev_id(struct scsi_device *sdev)
407{
408	return sdev->id;
409}
410
411#define scmd_id(scmd) sdev_id((scmd)->device)
412#define scmd_channel(scmd) sdev_channel((scmd)->device)
413
414/*
415 * checks for positions of the SCSI state machine
416 */
417static inline int scsi_device_online(struct scsi_device *sdev)
418{
419	return (sdev->sdev_state != SDEV_OFFLINE &&
 
420		sdev->sdev_state != SDEV_DEL);
421}
422static inline int scsi_device_blocked(struct scsi_device *sdev)
423{
424	return sdev->sdev_state == SDEV_BLOCK ||
425		sdev->sdev_state == SDEV_CREATED_BLOCK;
426}
427static inline int scsi_device_created(struct scsi_device *sdev)
428{
429	return sdev->sdev_state == SDEV_CREATED ||
430		sdev->sdev_state == SDEV_CREATED_BLOCK;
431}
432
433/* accessor functions for the SCSI parameters */
434static inline int scsi_device_sync(struct scsi_device *sdev)
435{
436	return sdev->sdtr;
437}
438static inline int scsi_device_wide(struct scsi_device *sdev)
439{
440	return sdev->wdtr;
441}
442static inline int scsi_device_dt(struct scsi_device *sdev)
443{
444	return sdev->ppr;
445}
446static inline int scsi_device_dt_only(struct scsi_device *sdev)
447{
448	if (sdev->inquiry_len < 57)
449		return 0;
450	return (sdev->inquiry[56] & 0x0c) == 0x04;
451}
452static inline int scsi_device_ius(struct scsi_device *sdev)
453{
454	if (sdev->inquiry_len < 57)
455		return 0;
456	return sdev->inquiry[56] & 0x01;
457}
458static inline int scsi_device_qas(struct scsi_device *sdev)
459{
460	if (sdev->inquiry_len < 57)
461		return 0;
462	return sdev->inquiry[56] & 0x02;
463}
464static inline int scsi_device_enclosure(struct scsi_device *sdev)
465{
466	return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
467}
468
469static inline int scsi_device_protection(struct scsi_device *sdev)
470{
 
 
 
471	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
 
 
 
 
 
472}
473
474#define MODULE_ALIAS_SCSI_DEVICE(type) \
475	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
476#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
477
478#endif /* _SCSI_SCSI_DEVICE_H */
v3.15
  1#ifndef _SCSI_SCSI_DEVICE_H
  2#define _SCSI_SCSI_DEVICE_H
  3
 
  4#include <linux/list.h>
  5#include <linux/spinlock.h>
  6#include <linux/workqueue.h>
  7#include <linux/blkdev.h>
  8#include <scsi/scsi.h>
  9#include <linux/atomic.h>
 10
 11struct device;
 12struct request_queue;
 13struct scsi_cmnd;
 14struct scsi_lun;
 15struct scsi_sense_hdr;
 16
 17struct 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
 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 */
 31enum 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 */
 45	SDEV_TRANSPORT_OFFLINE,	/* Offlined by transport class error handler */
 46	SDEV_BLOCK,		/* Device blocked by scsi lld.  No
 47				 * scsi commands from user or midlayer
 48				 * should be issued to the scsi
 49				 * lld. */
 50	SDEV_CREATED_BLOCK,	/* same as above but for created devices */
 51};
 52
 53enum scsi_device_event {
 54	SDEV_EVT_MEDIA_CHANGE	= 1,	/* media has changed */
 55	SDEV_EVT_INQUIRY_CHANGE_REPORTED,		/* 3F 03  UA reported */
 56	SDEV_EVT_CAPACITY_CHANGE_REPORTED,		/* 2A 09  UA reported */
 57	SDEV_EVT_SOFT_THRESHOLD_REACHED_REPORTED,	/* 38 07  UA reported */
 58	SDEV_EVT_MODE_PARAMETER_CHANGE_REPORTED,	/* 2A 01  UA reported */
 59	SDEV_EVT_LUN_CHANGE_REPORTED,			/* 3F 0E  UA reported */
 60
 61	SDEV_EVT_FIRST		= SDEV_EVT_MEDIA_CHANGE,
 62	SDEV_EVT_LAST		= SDEV_EVT_LUN_CHANGE_REPORTED,
 63
 
 64	SDEV_EVT_MAXBITS	= SDEV_EVT_LAST + 1
 65};
 66
 67struct scsi_event {
 68	enum scsi_device_event	evt_type;
 69	struct list_head	node;
 70
 71	/* put union of data structures, for non-simple event types,
 72	 * here
 73	 */
 74};
 75
 76struct scsi_device {
 77	struct Scsi_Host *host;
 78	struct request_queue *request_queue;
 79
 80	/* the next two are protected by the host->host_lock */
 81	struct list_head    siblings;   /* list of all devices on this host */
 82	struct list_head    same_target_siblings; /* just the devices sharing same target id */
 83
 84	/* this is now protected by the request_queue->queue_lock */
 85	unsigned int device_busy;	/* commands actually active on
 86					 * low-level. protected by queue_lock. */
 87	spinlock_t list_lock;
 88	struct list_head cmd_list;	/* queue of in use SCSI Command structures */
 89	struct list_head starved_entry;
 90	struct scsi_cmnd *current_cmnd;	/* currently active command */
 91	unsigned short queue_depth;	/* How deep of a queue we want */
 92	unsigned short max_queue_depth;	/* max queue depth */
 93	unsigned short last_queue_full_depth; /* These two are used by */
 94	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
 95	unsigned long last_queue_full_time;	/* last queue full time */
 96	unsigned long queue_ramp_up_period;	/* ramp up period in jiffies */
 97#define SCSI_DEFAULT_RAMP_UP_PERIOD	(120 * HZ)
 98
 99	unsigned long last_queue_ramp_up;	/* last queue ramp up time */
100
101	unsigned int id, lun, channel;
102
103	unsigned int manufacturer;	/* Manufacturer of device, for using 
104					 * vendor-specific cmd's */
105	unsigned sector_size;	/* size in bytes */
106
107	void *hostdata;		/* available to low-level driver */
108	char type;
109	char scsi_level;
110	char inq_periph_qual;	/* PQ from INQUIRY data */	
111	unsigned char inquiry_len;	/* valid bytes in 'inquiry' */
112	unsigned char * inquiry;	/* INQUIRY response data */
113	const char * vendor;		/* [back_compat] point into 'inquiry' ... */
114	const char * model;		/* ... after scan; point to static string */
115	const char * rev;		/* ... "nullnullnullnull" before scan */
116
117#define SCSI_VPD_PG_LEN                255
118	int vpd_pg83_len;
119	unsigned char *vpd_pg83;
120	int vpd_pg80_len;
121	unsigned char *vpd_pg80;
122	unsigned char current_tag;	/* current tag */
123	struct scsi_target      *sdev_target;   /* used only for single_lun */
124
125	unsigned int	sdev_bflags; /* black/white flags as also found in
126				 * scsi_devinfo.[hc]. For now used only to
127				 * pass settings from slave_alloc to scsi
128				 * core. */
129	unsigned int eh_timeout; /* Error handling timeout */
130	unsigned writeable:1;
131	unsigned removable:1;
132	unsigned changed:1;	/* Data invalid due to media change */
133	unsigned busy:1;	/* Used to prevent races */
134	unsigned lockable:1;	/* Able to prevent media removal */
135	unsigned locked:1;      /* Media removal disabled */
136	unsigned borken:1;	/* Tell the Seagate driver to be 
137				 * painfully slow on this device */
138	unsigned disconnect:1;	/* can disconnect */
139	unsigned soft_reset:1;	/* Uses soft reset option */
140	unsigned sdtr:1;	/* Device supports SDTR messages */
141	unsigned wdtr:1;	/* Device supports WDTR messages */
142	unsigned ppr:1;		/* Device supports PPR messages */
143	unsigned tagged_supported:1;	/* Supports SCSI-II tagged queuing */
144	unsigned simple_tags:1;	/* simple queue tag messages are enabled */
145	unsigned ordered_tags:1;/* ordered queue tag messages are enabled */
146	unsigned was_reset:1;	/* There was a bus reset on the bus for 
147				 * this device */
148	unsigned expecting_cc_ua:1; /* Expecting a CHECK_CONDITION/UNIT_ATTN
149				     * because we did a bus reset. */
150	unsigned use_10_for_rw:1; /* first try 10-byte read / write */
151	unsigned use_10_for_ms:1; /* first try 10-byte mode sense/select */
152	unsigned no_report_opcodes:1;	/* no REPORT SUPPORTED OPERATION CODES */
153	unsigned no_write_same:1;	/* no WRITE SAME command */
154	unsigned use_16_for_rw:1; /* Use read/write(16) over read/write(10) */
155	unsigned skip_ms_page_8:1;	/* do not use MODE SENSE page 0x08 */
156	unsigned skip_ms_page_3f:1;	/* do not use MODE SENSE page 0x3f */
157	unsigned skip_vpd_pages:1;	/* do not read VPD pages */
158	unsigned use_192_bytes_for_3f:1; /* ask for 192 bytes from page 0x3f */
159	unsigned no_start_on_add:1;	/* do not issue start on add */
160	unsigned allow_restart:1; /* issue START_UNIT in error handler */
161	unsigned manage_start_stop:1;	/* Let HLD (sd) manage start/stop */
162	unsigned start_stop_pwr_cond:1;	/* Set power cond. in START_STOP_UNIT */
163	unsigned no_uld_attach:1; /* disable connecting to upper level drivers */
164	unsigned select_no_atn:1;
165	unsigned fix_capacity:1;	/* READ_CAPACITY is too high by 1 */
166	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
167	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
168	unsigned last_sector_bug:1;	/* do not use multisector accesses on
169					   SD_LAST_BUGGY_SECTORS */
170	unsigned no_read_disc_info:1;	/* Avoid READ_DISC_INFO cmds */
171	unsigned no_read_capacity_16:1; /* Avoid READ_CAPACITY_16 cmds */
172	unsigned try_rc_10_first:1;	/* Try READ_CAPACACITY_10 first */
173	unsigned is_visible:1;	/* is the device visible in sysfs */
174	unsigned wce_default_on:1;	/* Cache is ON by default */
175	unsigned no_dif:1;	/* T10 PI (DIF) should be disabled */
176
177	atomic_t disk_events_disable_depth; /* disable depth for disk events */
178
179	DECLARE_BITMAP(supported_events, SDEV_EVT_MAXBITS); /* supported events */
180	DECLARE_BITMAP(pending_events, SDEV_EVT_MAXBITS); /* pending events */
181	struct list_head event_list;	/* asserted events */
182	struct work_struct event_work;
183
184	unsigned int device_blocked;	/* Device returned QUEUE_FULL. */
185
186	unsigned int max_device_blocked; /* what device_blocked counts down from  */
187#define SCSI_DEFAULT_DEVICE_BLOCKED	3
188
189	atomic_t iorequest_cnt;
190	atomic_t iodone_cnt;
191	atomic_t ioerr_cnt;
192
193	struct device		sdev_gendev,
194				sdev_dev;
195
196	struct execute_work	ew; /* used to get process context on put */
197	struct work_struct	requeue_work;
198
199	struct scsi_dh_data	*scsi_dh_data;
200	enum scsi_device_state sdev_state;
201	unsigned long		sdev_data[0];
202} __attribute__((aligned(sizeof(unsigned long))));
203
204struct scsi_dh_devlist {
205	char *vendor;
206	char *model;
207};
208
209typedef void (*activate_complete)(void *, int);
210struct scsi_device_handler {
211	/* Used by the infrastructure */
212	struct list_head list; /* list of scsi_device_handlers */
 
213
214	/* Filled by the hardware handler */
215	struct module *module;
216	const char *name;
217	const struct scsi_dh_devlist *devlist;
218	int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
219	int (*attach)(struct scsi_device *);
220	void (*detach)(struct scsi_device *);
221	int (*activate)(struct scsi_device *, activate_complete, void *);
222	int (*prep_fn)(struct scsi_device *, struct request *);
223	int (*set_params)(struct scsi_device *, const char *);
224	bool (*match)(struct scsi_device *);
225};
226
227struct scsi_dh_data {
228	struct scsi_device_handler *scsi_dh;
229	struct scsi_device *sdev;
230	struct kref kref;
231	char buf[0];
232};
233
234#define	to_scsi_device(d)	\
235	container_of(d, struct scsi_device, sdev_gendev)
236#define	class_to_sdev(d)	\
237	container_of(d, struct scsi_device, sdev_dev)
238#define transport_class_to_sdev(class_dev) \
239	to_scsi_device(class_dev->parent)
240
241#define sdev_printk(prefix, sdev, fmt, a...)	\
242	dev_printk(prefix, &(sdev)->sdev_gendev, fmt, ##a)
243
244#define sdev_dbg(sdev, fmt, a...) \
245	dev_dbg(&(sdev)->sdev_gendev, fmt, ##a)
246
247#define scmd_printk(prefix, scmd, fmt, a...)				\
248        (scmd)->request->rq_disk ?					\
249	sdev_printk(prefix, (scmd)->device, "[%s] " fmt,		\
250		    (scmd)->request->rq_disk->disk_name, ##a) :		\
251	sdev_printk(prefix, (scmd)->device, fmt, ##a)
252
253#define scmd_dbg(scmd, fmt, a...)					   \
254	do {								   \
255		if ((scmd)->request->rq_disk)				   \
256			sdev_dbg((scmd)->device, "[%s] " fmt,		   \
257				 (scmd)->request->rq_disk->disk_name, ##a);\
258		else							   \
259			sdev_dbg((scmd)->device, fmt, ##a);		   \
260	} while (0)
261
262enum scsi_target_state {
263	STARGET_CREATED = 1,
264	STARGET_RUNNING,
265	STARGET_DEL,
266};
267
268/*
269 * scsi_target: representation of a scsi target, for now, this is only
270 * used for single_lun devices. If no one has active IO to the target,
271 * starget_sdev_user is NULL, else it points to the active sdev.
272 */
273struct scsi_target {
274	struct scsi_device	*starget_sdev_user;
275	struct list_head	siblings;
276	struct list_head	devices;
277	struct device		dev;
278	struct kref		reap_ref; /* last put renders target invisible */
279	unsigned int		channel;
280	unsigned int		id; /* target id ... replace
281				     * scsi_device.id eventually */
282	unsigned int		create:1; /* signal that it needs to be added */
283	unsigned int		single_lun:1;	/* Indicates we should only
284						 * allow I/O to one of the luns
285						 * for the device at a time. */
286	unsigned int		pdt_1f_for_no_lun:1;	/* PDT = 0x1f
287						 * means no lun present. */
288	unsigned int		no_report_luns:1;	/* Don't use
289						 * REPORT LUNS for scanning. */
290	unsigned int		expecting_lun_change:1;	/* A device has reported
291						 * a 3F/0E UA, other devices on
292						 * the same target will also. */
293	/* commands actually active on LLD. protected by host lock. */
294	unsigned int		target_busy;
295	/*
296	 * LLDs should set this in the slave_alloc host template callout.
297	 * If set to zero then there is not limit.
298	 */
299	unsigned int		can_queue;
300	unsigned int		target_blocked;
301	unsigned int		max_target_blocked;
302#define SCSI_DEFAULT_TARGET_BLOCKED	3
303
304	char			scsi_level;
 
305	enum scsi_target_state	state;
306	void 			*hostdata; /* available to low-level driver */
307	unsigned long		starget_data[0]; /* for the transport */
308	/* starget_data must be the last element!!!! */
309} __attribute__((aligned(sizeof(unsigned long))));
310
311#define to_scsi_target(d)	container_of(d, struct scsi_target, dev)
312static inline struct scsi_target *scsi_target(struct scsi_device *sdev)
313{
314	return to_scsi_target(sdev->sdev_gendev.parent);
315}
316#define transport_class_to_starget(class_dev) \
317	to_scsi_target(class_dev->parent)
318
319#define starget_printk(prefix, starget, fmt, a...)	\
320	dev_printk(prefix, &(starget)->dev, fmt, ##a)
321
322extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
323		uint, uint, uint, void *hostdata);
324extern int scsi_add_device(struct Scsi_Host *host, uint channel,
325			   uint target, uint lun);
326extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
327extern void scsi_remove_device(struct scsi_device *);
328extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
329void scsi_attach_vpd(struct scsi_device *sdev);
330
331extern int scsi_device_get(struct scsi_device *);
332extern void scsi_device_put(struct scsi_device *);
333extern struct scsi_device *scsi_device_lookup(struct Scsi_Host *,
334					      uint, uint, uint);
335extern struct scsi_device *__scsi_device_lookup(struct Scsi_Host *,
336						uint, uint, uint);
337extern struct scsi_device *scsi_device_lookup_by_target(struct scsi_target *,
338							uint);
339extern struct scsi_device *__scsi_device_lookup_by_target(struct scsi_target *,
340							  uint);
341extern void starget_for_each_device(struct scsi_target *, void *,
342		     void (*fn)(struct scsi_device *, void *));
343extern void __starget_for_each_device(struct scsi_target *, void *,
344				      void (*fn)(struct scsi_device *,
345						 void *));
346
347/* only exposed to implement shost_for_each_device */
348extern struct scsi_device *__scsi_iterate_devices(struct Scsi_Host *,
349						  struct scsi_device *);
350
351/**
352 * shost_for_each_device - iterate over all devices of a host
353 * @sdev: the &struct scsi_device to use as a cursor
354 * @shost: the &struct scsi_host to iterate over
355 *
356 * Iterator that returns each device attached to @shost.  This loop
357 * takes a reference on each device and releases it at the end.  If
358 * you break out of the loop, you must call scsi_device_put(sdev).
359 */
360#define shost_for_each_device(sdev, shost) \
361	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
362	     (sdev); \
363	     (sdev) = __scsi_iterate_devices((shost), (sdev)))
364
365/**
366 * __shost_for_each_device - iterate over all devices of a host (UNLOCKED)
367 * @sdev: the &struct scsi_device to use as a cursor
368 * @shost: the &struct scsi_host to iterate over
369 *
370 * Iterator that returns each device attached to @shost.  It does _not_
371 * take a reference on the scsi_device, so the whole loop must be
372 * protected by shost->host_lock.
373 *
374 * Note: The only reason to use this is because you need to access the
375 * device list in interrupt context.  Otherwise you really want to use
376 * shost_for_each_device instead.
377 */
378#define __shost_for_each_device(sdev, shost) \
379	list_for_each_entry((sdev), &((shost)->__devices), siblings)
380
381extern void scsi_adjust_queue_depth(struct scsi_device *, int, int);
382extern int scsi_track_queue_full(struct scsi_device *, int);
383
384extern int scsi_set_medium_removal(struct scsi_device *, char);
385
386extern int scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
387			   unsigned char *buffer, int len, int timeout,
388			   int retries, struct scsi_mode_data *data,
389			   struct scsi_sense_hdr *);
390extern int scsi_mode_select(struct scsi_device *sdev, int pf, int sp,
391			    int modepage, unsigned char *buffer, int len,
392			    int timeout, int retries,
393			    struct scsi_mode_data *data,
394			    struct scsi_sense_hdr *);
395extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
396				int retries, struct scsi_sense_hdr *sshdr);
397extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
398			     int buf_len);
399extern int scsi_report_opcode(struct scsi_device *sdev, unsigned char *buffer,
400			      unsigned int len, unsigned char opcode);
401extern int scsi_device_set_state(struct scsi_device *sdev,
402				 enum scsi_device_state state);
403extern struct scsi_event *sdev_evt_alloc(enum scsi_device_event evt_type,
404					  gfp_t gfpflags);
405extern void sdev_evt_send(struct scsi_device *sdev, struct scsi_event *evt);
406extern void sdev_evt_send_simple(struct scsi_device *sdev,
407			  enum scsi_device_event evt_type, gfp_t gfpflags);
408extern int scsi_device_quiesce(struct scsi_device *sdev);
409extern void scsi_device_resume(struct scsi_device *sdev);
410extern void scsi_target_quiesce(struct scsi_target *);
411extern void scsi_target_resume(struct scsi_target *);
412extern void scsi_scan_target(struct device *parent, unsigned int channel,
413			     unsigned int id, unsigned int lun, int rescan);
414extern void scsi_target_reap(struct scsi_target *);
415extern void scsi_target_block(struct device *);
416extern void scsi_target_unblock(struct device *, enum scsi_device_state);
417extern void scsi_remove_target(struct device *);
418extern void int_to_scsilun(unsigned int, struct scsi_lun *);
419extern int scsilun_to_int(struct scsi_lun *);
420extern const char *scsi_device_state_name(enum scsi_device_state);
421extern int scsi_is_sdev_device(const struct device *);
422extern int scsi_is_target_device(const struct device *);
423extern int scsi_execute(struct scsi_device *sdev, const unsigned char *cmd,
424			int data_direction, void *buffer, unsigned bufflen,
425			unsigned char *sense, int timeout, int retries,
426			u64 flags, int *resid);
427extern int scsi_execute_req_flags(struct scsi_device *sdev,
428	const unsigned char *cmd, int data_direction, void *buffer,
429	unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
430	int retries, int *resid, u64 flags);
431static inline int scsi_execute_req(struct scsi_device *sdev,
432	const unsigned char *cmd, int data_direction, void *buffer,
433	unsigned bufflen, struct scsi_sense_hdr *sshdr, int timeout,
434	int retries, int *resid)
435{
436	return scsi_execute_req_flags(sdev, cmd, data_direction, buffer,
437		bufflen, sshdr, timeout, retries, resid, 0);
438}
439extern void sdev_disable_disk_events(struct scsi_device *sdev);
440extern void sdev_enable_disk_events(struct scsi_device *sdev);
441
442#ifdef CONFIG_PM_RUNTIME
443extern int scsi_autopm_get_device(struct scsi_device *);
444extern void scsi_autopm_put_device(struct scsi_device *);
445#else
446static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
447static inline void scsi_autopm_put_device(struct scsi_device *d) {}
448#endif /* CONFIG_PM_RUNTIME */
449
450static inline int __must_check scsi_device_reprobe(struct scsi_device *sdev)
451{
452	return device_reprobe(&sdev->sdev_gendev);
453}
454
455static inline unsigned int sdev_channel(struct scsi_device *sdev)
456{
457	return sdev->channel;
458}
459
460static inline unsigned int sdev_id(struct scsi_device *sdev)
461{
462	return sdev->id;
463}
464
465#define scmd_id(scmd) sdev_id((scmd)->device)
466#define scmd_channel(scmd) sdev_channel((scmd)->device)
467
468/*
469 * checks for positions of the SCSI state machine
470 */
471static inline int scsi_device_online(struct scsi_device *sdev)
472{
473	return (sdev->sdev_state != SDEV_OFFLINE &&
474		sdev->sdev_state != SDEV_TRANSPORT_OFFLINE &&
475		sdev->sdev_state != SDEV_DEL);
476}
477static inline int scsi_device_blocked(struct scsi_device *sdev)
478{
479	return sdev->sdev_state == SDEV_BLOCK ||
480		sdev->sdev_state == SDEV_CREATED_BLOCK;
481}
482static inline int scsi_device_created(struct scsi_device *sdev)
483{
484	return sdev->sdev_state == SDEV_CREATED ||
485		sdev->sdev_state == SDEV_CREATED_BLOCK;
486}
487
488/* accessor functions for the SCSI parameters */
489static inline int scsi_device_sync(struct scsi_device *sdev)
490{
491	return sdev->sdtr;
492}
493static inline int scsi_device_wide(struct scsi_device *sdev)
494{
495	return sdev->wdtr;
496}
497static inline int scsi_device_dt(struct scsi_device *sdev)
498{
499	return sdev->ppr;
500}
501static inline int scsi_device_dt_only(struct scsi_device *sdev)
502{
503	if (sdev->inquiry_len < 57)
504		return 0;
505	return (sdev->inquiry[56] & 0x0c) == 0x04;
506}
507static inline int scsi_device_ius(struct scsi_device *sdev)
508{
509	if (sdev->inquiry_len < 57)
510		return 0;
511	return sdev->inquiry[56] & 0x01;
512}
513static inline int scsi_device_qas(struct scsi_device *sdev)
514{
515	if (sdev->inquiry_len < 57)
516		return 0;
517	return sdev->inquiry[56] & 0x02;
518}
519static inline int scsi_device_enclosure(struct scsi_device *sdev)
520{
521	return sdev->inquiry ? (sdev->inquiry[6] & (1<<6)) : 1;
522}
523
524static inline int scsi_device_protection(struct scsi_device *sdev)
525{
526	if (sdev->no_dif)
527		return 0;
528
529	return sdev->scsi_level > SCSI_2 && sdev->inquiry[5] & (1<<0);
530}
531
532static inline int scsi_device_tpgs(struct scsi_device *sdev)
533{
534	return sdev->inquiry ? (sdev->inquiry[5] >> 4) & 0x3 : 0;
535}
536
537#define MODULE_ALIAS_SCSI_DEVICE(type) \
538	MODULE_ALIAS("scsi:t-" __stringify(type) "*")
539#define SCSI_DEVICE_MODALIAS_FMT "scsi:t-0x%02x"
540
541#endif /* _SCSI_SCSI_DEVICE_H */