scsi_device.h 16.9 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6
#ifndef _SCSI_SCSI_DEVICE_H
#define _SCSI_SCSI_DEVICE_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/spinlock.h>
7
#include <linux/workqueue.h>
8
#include <linux/blkdev.h>
9
#include <scsi/scsi.h>
Linus Torvalds's avatar
Linus Torvalds committed
10 11 12 13
#include <asm/atomic.h>

struct request_queue;
struct scsi_cmnd;
14
struct scsi_lun;
15
struct scsi_sense_hdr;
Linus Torvalds's avatar
Linus Torvalds committed
16

17 18 19 20 21 22 23 24 25
struct scsi_mode_data {
	__u32	length;
	__u16	block_descriptor_length;
	__u8	medium_type;
	__u8	device_specific;
	__u8	header_length;
	__u8	longlba:1;
};

Linus Torvalds's avatar
Linus Torvalds committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/*
 * 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 */
45 46 47 48 49
	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 */
Linus Torvalds's avatar
Linus Torvalds committed
50 51
};

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
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
	 */
};

Linus Torvalds's avatar
Linus Torvalds committed
68 69 70 71 72 73 74 75
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 */

's avatar
committed
76
	/* this is now protected by the request_queue->queue_lock */
77 78
	unsigned int device_busy;	/* commands actually active on
					 * low-level. protected by queue_lock. */
Linus Torvalds's avatar
Linus Torvalds committed
79 80 81 82 83
	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 */
Vasu Dev's avatar
Vasu Dev committed
84
	unsigned short max_queue_depth;	/* max queue depth */
Linus Torvalds's avatar
Linus Torvalds committed
85 86
	unsigned short last_queue_full_depth; /* These two are used by */
	unsigned short last_queue_full_count; /* scsi_track_queue_full() */
Vasu Dev's avatar
Vasu Dev committed
87 88 89 90 91
	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 */
Linus Torvalds's avatar
Linus Torvalds committed
92 93 94 95 96 97 98 99 100 101 102 103 104

	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 */
105 106 107
	const char * vendor;		/* [back_compat] point into 'inquiry' ... */
	const char * model;		/* ... after scan; point to static string */
	const char * rev;		/* ... "nullnullnullnull" before scan */
Linus Torvalds's avatar
Linus Torvalds committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
	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 */
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 */
Linus Torvalds's avatar
Linus Torvalds committed
144 145 146
	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 */
147
	unsigned guess_capacity:1;	/* READ_CAPACITY might be too high by 1 */
Linus Torvalds's avatar
Linus Torvalds committed
148
	unsigned retry_hwerror:1;	/* Retry HARDWARE_ERROR */
149 150
	unsigned last_sector_bug:1;	/* do not use multisector accesses on
					   SD_LAST_BUGGY_SECTORS */
151
	unsigned no_read_disc_info:1;	/* Avoid READ_DISC_INFO cmds */
152
	unsigned is_visible:1;	/* is the device visible in sysfs */
Linus Torvalds's avatar
Linus Torvalds committed
153

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

Linus Torvalds's avatar
Linus Torvalds committed
158 159 160 161 162 163 164 165 166
	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;

167 168
	struct device		sdev_gendev,
				sdev_dev;
Linus Torvalds's avatar
Linus Torvalds committed
169

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

172
	struct scsi_dh_data	*scsi_dh_data;
Linus Torvalds's avatar
Linus Torvalds committed
173 174 175
	enum scsi_device_state sdev_state;
	unsigned long		sdev_data[0];
} __attribute__((aligned(sizeof(unsigned long))));
176

177 178 179 180 181
struct scsi_dh_devlist {
	char *vendor;
	char *model;
};

182
typedef void (*activate_complete)(void *, int);
183 184 185 186 187 188 189
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;
190
	const struct scsi_dh_devlist *devlist;
191
	int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
192 193
	int (*attach)(struct scsi_device *);
	void (*detach)(struct scsi_device *);
194
	int (*activate)(struct scsi_device *, activate_complete, void *);
195
	int (*prep_fn)(struct scsi_device *, struct request *);
196
	int (*set_params)(struct scsi_device *, const char *);
197 198 199 200
};

struct scsi_dh_data {
	struct scsi_device_handler *scsi_dh;
201 202
	struct scsi_device *sdev;
	struct kref kref;
203 204 205
	char buf[0];
};

Linus Torvalds's avatar
Linus Torvalds committed
206 207 208
#define	to_scsi_device(d)	\
	container_of(d, struct scsi_device, sdev_gendev)
#define	class_to_sdev(d)	\
209
	container_of(d, struct scsi_device, sdev_dev)
Linus Torvalds's avatar
Linus Torvalds committed
210
#define transport_class_to_sdev(class_dev) \
211
	to_scsi_device(class_dev->parent)
Linus Torvalds's avatar
Linus Torvalds committed
212

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

216 217 218 219 220
#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)
221

222
enum scsi_target_state {
223 224
	STARGET_CREATED = 1,
	STARGET_RUNNING,
225 226 227
	STARGET_DEL,
};

Linus Torvalds's avatar
Linus Torvalds committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241
/*
 * 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 */
242
	unsigned int		create:1; /* signal that it needs to be added */
243 244 245
	unsigned int		single_lun:1;	/* Indicates we should only
						 * allow I/O to one of the luns
						 * for the device at a time. */
246 247
	unsigned int		pdt_1f_for_no_lun;	/* PDT = 0x1f */
						/* means no lun present */
248 249 250 251 252 253 254 255 256 257
	/* 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
258

259
	char			scsi_level;
260 261
	struct execute_work	ew;
	enum scsi_target_state	state;
262 263 264
	void 			*hostdata; /* available to low-level driver */
	unsigned long		starget_data[0]; /* for the transport */
	/* starget_data must be the last element!!!! */
Linus Torvalds's avatar
Linus Torvalds committed
265 266 267 268 269 270 271 272
} __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) \
273
	to_scsi_target(class_dev->parent)
Linus Torvalds's avatar
Linus Torvalds committed
274

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

Linus Torvalds's avatar
Linus Torvalds committed
278 279
extern struct scsi_device *__scsi_add_device(struct Scsi_Host *,
		uint, uint, uint, void *hostdata);
280 281
extern int scsi_add_device(struct Scsi_Host *host, uint channel,
			   uint target, uint lun);
282
extern int scsi_register_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds's avatar
Linus Torvalds committed
283
extern void scsi_remove_device(struct scsi_device *);
284
extern int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh);
Linus Torvalds's avatar
Linus Torvalds committed
285 286 287 288 289 290 291 292 293 294 295 296 297

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 *));
298 299 300
extern void __starget_for_each_device(struct scsi_target *, void *,
				      void (*fn)(struct scsi_device *,
						 void *));
Linus Torvalds's avatar
Linus Torvalds committed
301 302 303 304 305 306

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

/**
307 308 309
 * 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
Linus Torvalds's avatar
Linus Torvalds committed
310
 *
311 312 313
 * 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).
Linus Torvalds's avatar
Linus Torvalds committed
314 315 316 317 318 319 320
 */
#define shost_for_each_device(sdev, shost) \
	for ((sdev) = __scsi_iterate_devices((shost), NULL); \
	     (sdev); \
	     (sdev) = __scsi_iterate_devices((shost), (sdev)))

/**
321 322 323
 * __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
Linus Torvalds's avatar
Linus Torvalds committed
324
 *
325 326 327
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
328
 *
329 330 331
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
332 333 334 335 336 337 338 339 340 341 342
 */
#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,
343
			   int retries, struct scsi_mode_data *data,
344
			   struct scsi_sense_hdr *);
345 346 347 348 349
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 *);
Linus Torvalds's avatar
Linus Torvalds committed
350
extern int scsi_test_unit_ready(struct scsi_device *sdev, int timeout,
351
				int retries, struct scsi_sense_hdr *sshdr);
352 353
extern int scsi_get_vpd_page(struct scsi_device *, u8 page, unsigned char *buf,
			     int buf_len);
Linus Torvalds's avatar
Linus Torvalds committed
354 355
extern int scsi_device_set_state(struct scsi_device *sdev,
				 enum scsi_device_state state);
356 357 358 359 360
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);
Linus Torvalds's avatar
Linus Torvalds committed
361 362 363 364 365 366 367 368 369 370
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 *);
371
extern void int_to_scsilun(unsigned int, struct scsi_lun *);
372
extern int scsilun_to_int(struct scsi_lun *);
Linus Torvalds's avatar
Linus Torvalds committed
373 374 375
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 *);
376 377 378
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,
379
			int flag, int *resid);
380 381
extern int scsi_execute_req(struct scsi_device *sdev, const unsigned char *cmd,
			    int data_direction, void *buffer, unsigned bufflen,
382 383
			    struct scsi_sense_hdr *, int timeout, int retries,
			    int *resid);
384

385 386 387 388 389 390 391 392
#ifdef CONFIG_PM_RUNTIME
extern int scsi_autopm_get_device(struct scsi_device *);
extern void scsi_autopm_put_device(struct scsi_device *);
#else
static inline int scsi_autopm_get_device(struct scsi_device *d) { return 0; }
static inline void scsi_autopm_put_device(struct scsi_device *d) {}
#endif /* CONFIG_PM_RUNTIME */

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

398 399 400 401 402 403 404 405 406 407 408 409 410
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)

411 412 413
/*
 * checks for positions of the SCSI state machine
 */
Linus Torvalds's avatar
Linus Torvalds committed
414 415
static inline int scsi_device_online(struct scsi_device *sdev)
{
416 417
	return (sdev->sdev_state != SDEV_OFFLINE &&
		sdev->sdev_state != SDEV_DEL);
Linus Torvalds's avatar
Linus Torvalds committed
418
}
419 420
static inline int scsi_device_blocked(struct scsi_device *sdev)
{
421 422
	return sdev->sdev_state == SDEV_BLOCK ||
		sdev->sdev_state == SDEV_CREATED_BLOCK;
423 424 425
}
static inline int scsi_device_created(struct scsi_device *sdev)
{
426 427
	return sdev->sdev_state == SDEV_CREATED ||
		sdev->sdev_state == SDEV_CREATED_BLOCK;
428
}
Linus Torvalds's avatar
Linus Torvalds committed
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

/* 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;
}
461 462 463 464
static inline int scsi_device_enclosure(struct scsi_device *sdev)
{
	return sdev->inquiry[6] & (1<<6);
}
465

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

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

Linus Torvalds's avatar
Linus Torvalds committed
475
#endif /* _SCSI_SCSI_DEVICE_H */