[deliverable/linux.git] / drivers / scsi / sd.h

#ifndef _SCSI_DISK_H
#define _SCSI_DISK_H

/*
 * More than enough for everybody ;)  The huge number of majors
 * is a leftover from 16bit dev_t days, we don't really need that
 * much numberspace.
 */
#define SD_MAJORS	16

/*
 * Time out in seconds for disks and Magneto-opticals (which are slower).
 */
#define SD_TIMEOUT		(30 * HZ)
#define SD_MOD_TIMEOUT		(75 * HZ)
/*
 * Flush timeout is a multiplier over the standard device timeout which is
 * user modifiable via sysfs but initially set to SD_TIMEOUT
 */
#define SD_FLUSH_TIMEOUT_MULTIPLIER	2
#define SD_WRITE_SAME_TIMEOUT	(120 * HZ)

/*
 * Number of allowed retries
 */
#define SD_MAX_RETRIES		5
#define SD_PASSTHROUGH_RETRIES	1
#define SD_MAX_MEDIUM_TIMEOUTS	2

/*
 * Size of the initial data buffer for mode and read capacity data
 */
#define SD_BUF_SIZE		512

/*
 * Number of sectors at the end of the device to avoid multi-sector
 * accesses to in the case of last_sector_bug
 */
#define SD_LAST_BUGGY_SECTORS	8

enum {
	SD_EXT_CDB_SIZE = 32,	/* Extended CDB size */
	SD_MEMPOOL_SIZE = 2,	/* CDB pool size */
};

enum {
	SD_DEF_XFER_BLOCKS = 0xffff,
	SD_MAX_XFER_BLOCKS = 0xffffffff,
	SD_MAX_WS10_BLOCKS = 0xffff,
	SD_MAX_WS16_BLOCKS = 0x7fffff,
};

enum {
	SD_LBP_FULL = 0,	/* Full logical block provisioning */
	SD_LBP_UNMAP,		/* Use UNMAP command */
	SD_LBP_WS16,		/* Use WRITE SAME(16) with UNMAP bit */
	SD_LBP_WS10,		/* Use WRITE SAME(10) with UNMAP bit */
	SD_LBP_ZERO,		/* Use WRITE SAME(10) with zero payload */
	SD_LBP_DISABLE,		/* Discard disabled due to failed cmd */
};

struct scsi_disk {
	struct scsi_driver *driver;	/* always &sd_template */
	struct scsi_device *device;
	struct device	dev;
	struct gendisk	*disk;
	atomic_t	openers;
	sector_t	capacity;	/* size in logical blocks */
	u32		max_xfer_blocks;
	u32		opt_xfer_blocks;
	u32		max_ws_blocks;
	u32		max_unmap_blocks;
	u32		unmap_granularity;
	u32		unmap_alignment;
	u32		index;
	unsigned int	physical_block_size;
	unsigned int	max_medium_access_timeouts;
	unsigned int	medium_access_timed_out;
	u8		media_present;
	u8		write_prot;
	u8		protection_type;/* Data Integrity Field */
	u8		provisioning_mode;
	unsigned	ATO : 1;	/* state of disk ATO bit */
	unsigned	cache_override : 1; /* temp override of WCE,RCD */
	unsigned	WCE : 1;	/* state of disk WCE bit */
	unsigned	RCD : 1;	/* state of disk RCD bit, unused */
	unsigned	DPOFUA : 1;	/* state of disk DPOFUA bit */
	unsigned	first_scan : 1;
	unsigned	lbpme : 1;
	unsigned	lbprz : 1;
	unsigned	lbpu : 1;
	unsigned	lbpws : 1;
	unsigned	lbpws10 : 1;
	unsigned	lbpvpd : 1;
	unsigned	ws10 : 1;
	unsigned	ws16 : 1;
};
#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)

static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
{
	return container_of(disk->private_data, struct scsi_disk, driver);
}

#define sd_printk(prefix, sdsk, fmt, a...)				\
        (sdsk)->disk ?							\
	      sdev_prefix_printk(prefix, (sdsk)->device,		\
				 (sdsk)->disk->disk_name, fmt, ##a) :	\
	      sdev_printk(prefix, (sdsk)->device, fmt, ##a)

#define sd_first_printk(prefix, sdsk, fmt, a...)			\
	do {								\
		if ((sdkp)->first_scan)					\
			sd_printk(prefix, sdsk, fmt, ##a);		\
	} while (0)

static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
{
	switch (scmd->cmnd[0]) {
	case READ_6:
	case READ_10:
	case READ_12:
	case READ_16:
	case SYNCHRONIZE_CACHE:
	case VERIFY:
	case VERIFY_12:
	case VERIFY_16:
	case WRITE_6:
	case WRITE_10:
	case WRITE_12:
	case WRITE_16:
	case WRITE_SAME:
	case WRITE_SAME_16:
	case UNMAP:
		return 1;
	case VARIABLE_LENGTH_CMD:
		switch (scmd->cmnd[9]) {
		case READ_32:
		case VERIFY_32:
		case WRITE_32:
		case WRITE_SAME_32:
			return 1;
		}
	}

	return 0;
}

static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
{
	return blocks << (ilog2(sdev->sector_size) - 9);
}

/*
 * A DIF-capable target device can be formatted with different
 * protection schemes.  Currently 0 through 3 are defined:
 *
 * Type 0 is regular (unprotected) I/O
 *
 * Type 1 defines the contents of the guard and reference tags
 *
 * Type 2 defines the contents of the guard and reference tags and
 * uses 32-byte commands to seed the latter
 *
 * Type 3 defines the contents of the guard tag only
 */

enum sd_dif_target_protection_types {
	SD_DIF_TYPE0_PROTECTION = 0x0,
	SD_DIF_TYPE1_PROTECTION = 0x1,
	SD_DIF_TYPE2_PROTECTION = 0x2,
	SD_DIF_TYPE3_PROTECTION = 0x3,
};

/*
 * Look up the DIX operation based on whether the command is read or
 * write and whether dix and dif are enabled.
 */
static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
{
	/* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
	const unsigned int ops[] = {	/* wrt dix dif */
		SCSI_PROT_NORMAL,	/*  0	0   0  */
		SCSI_PROT_READ_STRIP,	/*  0	0   1  */
		SCSI_PROT_READ_INSERT,	/*  0	1   0  */
		SCSI_PROT_READ_PASS,	/*  0	1   1  */
		SCSI_PROT_NORMAL,	/*  1	0   0  */
		SCSI_PROT_WRITE_INSERT, /*  1	0   1  */
		SCSI_PROT_WRITE_STRIP,	/*  1	1   0  */
		SCSI_PROT_WRITE_PASS,	/*  1	1   1  */
	};

	return ops[write << 2 | dix << 1 | dif];
}

/*
 * Returns a mask of the protection flags that are valid for a given DIX
 * operation.
 */
static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
{
	const unsigned int flag_mask[] = {
		[SCSI_PROT_NORMAL]		= 0,

		[SCSI_PROT_READ_STRIP]		= SCSI_PROT_TRANSFER_PI |
						  SCSI_PROT_GUARD_CHECK |
						  SCSI_PROT_REF_CHECK |
						  SCSI_PROT_REF_INCREMENT,

		[SCSI_PROT_READ_INSERT]		= SCSI_PROT_REF_INCREMENT |
						  SCSI_PROT_IP_CHECKSUM,

		[SCSI_PROT_READ_PASS]		= SCSI_PROT_TRANSFER_PI |
						  SCSI_PROT_GUARD_CHECK |
						  SCSI_PROT_REF_CHECK |
						  SCSI_PROT_REF_INCREMENT |
						  SCSI_PROT_IP_CHECKSUM,

		[SCSI_PROT_WRITE_INSERT]	= SCSI_PROT_TRANSFER_PI |
						  SCSI_PROT_REF_INCREMENT,

		[SCSI_PROT_WRITE_STRIP]		= SCSI_PROT_GUARD_CHECK |
						  SCSI_PROT_REF_CHECK |
						  SCSI_PROT_REF_INCREMENT |
						  SCSI_PROT_IP_CHECKSUM,

		[SCSI_PROT_WRITE_PASS]		= SCSI_PROT_TRANSFER_PI |
						  SCSI_PROT_GUARD_CHECK |
						  SCSI_PROT_REF_CHECK |
						  SCSI_PROT_REF_INCREMENT |
						  SCSI_PROT_IP_CHECKSUM,
	};

	return flag_mask[prot_op];
}

/*
 * Data Integrity Field tuple.
 */
struct sd_dif_tuple {
       __be16 guard_tag;	/* Checksum */
       __be16 app_tag;		/* Opaque storage */
       __be32 ref_tag;		/* Target LBA or indirect LBA */
};

#ifdef CONFIG_BLK_DEV_INTEGRITY

extern void sd_dif_config_host(struct scsi_disk *);
extern void sd_dif_prepare(struct scsi_cmnd *scmd);
extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);

#else /* CONFIG_BLK_DEV_INTEGRITY */

static inline void sd_dif_config_host(struct scsi_disk *disk)
{
}
static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
{
	return 0;
}
static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
{
}

#endif /* CONFIG_BLK_DEV_INTEGRITY */

#endif /* _SCSI_DISK_H */
Commit	Line	Data
e73aec82 MP	1	#ifndef _SCSI_DISK_H
	2	#define _SCSI_DISK_H
	3
	4	/*
	5	* More than enough for everybody ;) The huge number of majors
	6	* is a leftover from 16bit dev_t days, we don't really need that
	7	* much numberspace.
	8	*/
	9	#define SD_MAJORS 16
	10
e73aec82 MP	11	/*
	12	* Time out in seconds for disks and Magneto-opticals (which are slower).
	13	*/
	14	#define SD_TIMEOUT (30 * HZ)
	15	#define SD_MOD_TIMEOUT (75 * HZ)
7e660100 JB	16	/*
	17	* Flush timeout is a multiplier over the standard device timeout which is
	18	* user modifiable via sysfs but initially set to SD_TIMEOUT
	19	*/
	20	#define SD_FLUSH_TIMEOUT_MULTIPLIER 2
5db44863	21	#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
e73aec82 MP	22
	23	/*
	24	* Number of allowed retries
	25	*/
	26	#define SD_MAX_RETRIES 5
	27	#define SD_PASSTHROUGH_RETRIES 1
18a4d0a2	28	#define SD_MAX_MEDIUM_TIMEOUTS 2
e73aec82 MP	29
	30	/*
	31	* Size of the initial data buffer for mode and read capacity data
	32	*/
	33	#define SD_BUF_SIZE 512
	34
18351070 LT	35	/*
	36	* Number of sectors at the end of the device to avoid multi-sector
	37	* accesses to in the case of last_sector_bug
	38	*/
	39	#define SD_LAST_BUGGY_SECTORS 8
	40
4e7392ec MP	41	enum {
	42	SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
	43	SD_MEMPOOL_SIZE = 2, /* CDB pool size */
	44	};
	45
5db44863	46	enum {
bcdb247c MP	47	SD_DEF_XFER_BLOCKS = 0xffff,
bcdb247c MP	48	SD_MAX_XFER_BLOCKS = 0xffffffff,
5db44863 MP	49	SD_MAX_WS10_BLOCKS = 0xffff,
	50	SD_MAX_WS16_BLOCKS = 0x7fffff,
	51	};
	52
c98a0eb0 MP	53	enum {
	54	SD_LBP_FULL = 0, /* Full logical block provisioning */
	55	SD_LBP_UNMAP, /* Use UNMAP command */
	56	SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
	57	SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
	58	SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
	59	SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
	60	};
	61
e73aec82 MP	62	struct scsi_disk {
	63	struct scsi_driver driver; / always &sd_template */
	64	struct scsi_device *device;
ee959b00	65	struct device dev;
e73aec82	66	struct gendisk *disk;
409f3499	67	atomic_t openers;
f08bb1e0	68	sector_t capacity; /* size in logical blocks */
bcdb247c	69	u32 max_xfer_blocks;
ca369d51	70	u32 opt_xfer_blocks;
c98a0eb0 MP	71	u32 max_ws_blocks;
	72	u32 max_unmap_blocks;
	73	u32 unmap_granularity;
	74	u32 unmap_alignment;
e73aec82	75	u32 index;
526f7c79	76	unsigned int physical_block_size;
18a4d0a2 MP	77	unsigned int max_medium_access_timeouts;
18a4d0a2 MP	78	unsigned int medium_access_timed_out;
e73aec82 MP	79	u8 media_present;
e73aec82 MP	80	u8 write_prot;
e0597d70	81	u8 protection_type;/* Data Integrity Field */
c98a0eb0	82	u8 provisioning_mode;
e0597d70	83	unsigned ATO : 1; /* state of disk ATO bit */
39c60a09	84	unsigned cache_override : 1; /* temp override of WCE,RCD */
e73aec82 MP	85	unsigned WCE : 1; /* state of disk WCE bit */
	86	unsigned RCD : 1; /* state of disk RCD bit, unused */
	87	unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
70a9b873	88	unsigned first_scan : 1;
c98a0eb0 MP	89	unsigned lbpme : 1;
	90	unsigned lbprz : 1;
	91	unsigned lbpu : 1;
	92	unsigned lbpws : 1;
	93	unsigned lbpws10 : 1;
	94	unsigned lbpvpd : 1;
66c28f97	95	unsigned ws10 : 1;
5db44863	96	unsigned ws16 : 1;
e73aec82	97	};
ee959b00	98	#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82	99
5b635da1 MP	100	static inline struct scsi_disk scsi_disk(struct gendisk disk)
	101	{
	102	return container_of(disk->private_data, struct scsi_disk, driver);
	103	}
	104
e73aec82 MP	105	#define sd_printk(prefix, sdsk, fmt, a...) \
e73aec82 MP	106	(sdsk)->disk ? \
22e0d994 HR	107	sdev_prefix_printk(prefix, (sdsk)->device, \
	108	(sdsk)->disk->disk_name, fmt, ##a) : \
	109	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
e73aec82	110
b2bff6ce MP	111	#define sd_first_printk(prefix, sdsk, fmt, a...) \
	112	do { \
	113	if ((sdkp)->first_scan) \
	114	sd_printk(prefix, sdsk, fmt, ##a); \
	115	} while (0)
	116
18a4d0a2 MP	117	static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
	118	{
	119	switch (scmd->cmnd[0]) {
	120	case READ_6:
	121	case READ_10:
	122	case READ_12:
	123	case READ_16:
	124	case SYNCHRONIZE_CACHE:
	125	case VERIFY:
	126	case VERIFY_12:
	127	case VERIFY_16:
	128	case WRITE_6:
	129	case WRITE_10:
	130	case WRITE_12:
	131	case WRITE_16:
	132	case WRITE_SAME:
	133	case WRITE_SAME_16:
	134	case UNMAP:
	135	return 1;
	136	case VARIABLE_LENGTH_CMD:
	137	switch (scmd->cmnd[9]) {
	138	case READ_32:
	139	case VERIFY_32:
	140	case WRITE_32:
	141	case WRITE_SAME_32:
	142	return 1;
	143	}
	144	}
	145
	146	return 0;
	147	}
	148
f08bb1e0 MP	149	static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
	150	{
	151	return blocks << (ilog2(sdev->sector_size) - 9);
	152	}
	153
e0597d70 MP	154	/*
	155	* A DIF-capable target device can be formatted with different
	156	* protection schemes. Currently 0 through 3 are defined:
	157	*
	158	* Type 0 is regular (unprotected) I/O
	159	*
	160	* Type 1 defines the contents of the guard and reference tags
	161	*
	162	* Type 2 defines the contents of the guard and reference tags and
	163	* uses 32-byte commands to seed the latter
	164	*
	165	* Type 3 defines the contents of the guard tag only
	166	*/
	167
	168	enum sd_dif_target_protection_types {
	169	SD_DIF_TYPE0_PROTECTION = 0x0,
	170	SD_DIF_TYPE1_PROTECTION = 0x1,
	171	SD_DIF_TYPE2_PROTECTION = 0x2,
	172	SD_DIF_TYPE3_PROTECTION = 0x3,
	173	};
	174
c611529e MP	175	/*
	176	* Look up the DIX operation based on whether the command is read or
	177	* write and whether dix and dif are enabled.
	178	*/
	179	static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
	180	{
	181	/* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
	182	const unsigned int ops[] = { /* wrt dix dif */
	183	SCSI_PROT_NORMAL, /* 0 0 0 */
	184	SCSI_PROT_READ_STRIP, /* 0 0 1 */
	185	SCSI_PROT_READ_INSERT, /* 0 1 0 */
	186	SCSI_PROT_READ_PASS, /* 0 1 1 */
	187	SCSI_PROT_NORMAL, /* 1 0 0 */
	188	SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
	189	SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
	190	SCSI_PROT_WRITE_PASS, /* 1 1 1 */
	191	};
	192
	193	return ops[write << 2 \| dix << 1 \| dif];
	194	}
	195
	196	/*
	197	* Returns a mask of the protection flags that are valid for a given DIX
	198	* operation.
	199	*/
	200	static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
	201	{
	202	const unsigned int flag_mask[] = {
	203	[SCSI_PROT_NORMAL] = 0,
	204
	205	[SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI \|
	206	SCSI_PROT_GUARD_CHECK \|
	207	SCSI_PROT_REF_CHECK \|
	208	SCSI_PROT_REF_INCREMENT,
	209
	210	[SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT \|
	211	SCSI_PROT_IP_CHECKSUM,
	212
	213	[SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI \|
	214	SCSI_PROT_GUARD_CHECK \|
	215	SCSI_PROT_REF_CHECK \|
	216	SCSI_PROT_REF_INCREMENT \|
	217	SCSI_PROT_IP_CHECKSUM,
	218
	219	[SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI \|
	220	SCSI_PROT_REF_INCREMENT,
	221
	222	[SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK \|
	223	SCSI_PROT_REF_CHECK \|
	224	SCSI_PROT_REF_INCREMENT \|
	225	SCSI_PROT_IP_CHECKSUM,
	226
	227	[SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI \|
	228	SCSI_PROT_GUARD_CHECK \|
	229	SCSI_PROT_REF_CHECK \|
	230	SCSI_PROT_REF_INCREMENT \|
	231	SCSI_PROT_IP_CHECKSUM,
	232	};
	233
	234	return flag_mask[prot_op];
	235	}
	236
af55ff67 MP	237	/*
	238	* Data Integrity Field tuple.
	239	*/
	240	struct sd_dif_tuple {
	241	__be16 guard_tag; /* Checksum */
	242	__be16 app_tag; /* Opaque storage */
	243	__be32 ref_tag; /* Target LBA or indirect LBA */
	244	};
	245
4c393e6e	246	#ifdef CONFIG_BLK_DEV_INTEGRITY
af55ff67	247
af55ff67	248	extern void sd_dif_config_host(struct scsi_disk *);
c611529e	249	extern void sd_dif_prepare(struct scsi_cmnd *scmd);
af55ff67 MP	250	extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
	251
	252	#else /* CONFIG_BLK_DEV_INTEGRITY */
	253
4c393e6e JB	254	static inline void sd_dif_config_host(struct scsi_disk *disk)
	255	{
	256	}
c611529e	257	static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
4c393e6e JB	258	{
	259	return 0;
	260	}
	261	static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
	262	{
	263	}
af55ff67 MP	264
	265	#endif /* CONFIG_BLK_DEV_INTEGRITY */
	266
e73aec82	267	#endif /* _SCSI_DISK_H */