[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)
#define SD_FLUSH_TIMEOUT	(60 * HZ)

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

/*
 * 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_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 512-byte sectors */
	u32		max_ws_blocks;
	u32		max_unmap_blocks;
	u32		unmap_granularity;
	u32		unmap_alignment;
	u32		index;
	unsigned int	physical_block_size;
	u8		media_present;
	u8		write_prot;
	u8		protection_type;/* Data Integrity Field */
	u8		provisioning_mode;
	unsigned	ATO : 1;	/* state of disk ATO bit */
	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;
};
#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_printk(prefix, (sdsk)->device, "[%s] " fmt,		\
		    (sdsk)->disk->disk_name, ##a) :			\
	sdev_printk(prefix, (sdsk)->device, fmt, ##a)

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

/*
 * 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 int sd_dif_prepare(struct request *rq, sector_t, unsigned int);
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 request *rq, sector_t s, unsigned int a)
{
	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)
e3b3e624	16	#define SD_FLUSH_TIMEOUT (60 * HZ)
e73aec82 MP	17
	18	/*
	19	* Number of allowed retries
	20	*/
	21	#define SD_MAX_RETRIES 5
	22	#define SD_PASSTHROUGH_RETRIES 1
	23
	24	/*
	25	* Size of the initial data buffer for mode and read capacity data
	26	*/
	27	#define SD_BUF_SIZE 512
	28
18351070 LT	29	/*
	30	* Number of sectors at the end of the device to avoid multi-sector
	31	* accesses to in the case of last_sector_bug
	32	*/
	33	#define SD_LAST_BUGGY_SECTORS 8
	34
4e7392ec MP	35	enum {
	36	SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
	37	SD_MEMPOOL_SIZE = 2, /* CDB pool size */
	38	};
	39
c98a0eb0 MP	40	enum {
	41	SD_LBP_FULL = 0, /* Full logical block provisioning */
	42	SD_LBP_UNMAP, /* Use UNMAP command */
	43	SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
	44	SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
	45	SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
	46	SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
	47	};
	48
e73aec82 MP	49	struct scsi_disk {
	50	struct scsi_driver driver; / always &sd_template */
	51	struct scsi_device *device;
ee959b00	52	struct device dev;
e73aec82	53	struct gendisk *disk;
409f3499	54	atomic_t openers;
e73aec82	55	sector_t capacity; /* size in 512-byte sectors */
c98a0eb0 MP	56	u32 max_ws_blocks;
	57	u32 max_unmap_blocks;
	58	u32 unmap_granularity;
	59	u32 unmap_alignment;
e73aec82	60	u32 index;
526f7c79	61	unsigned int physical_block_size;
e73aec82 MP	62	u8 media_present;
e73aec82 MP	63	u8 write_prot;
e0597d70	64	u8 protection_type;/* Data Integrity Field */
c98a0eb0	65	u8 provisioning_mode;
e0597d70	66	unsigned ATO : 1; /* state of disk ATO bit */
e73aec82 MP	67	unsigned WCE : 1; /* state of disk WCE bit */
	68	unsigned RCD : 1; /* state of disk RCD bit, unused */
	69	unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
70a9b873	70	unsigned first_scan : 1;
c98a0eb0 MP	71	unsigned lbpme : 1;
	72	unsigned lbprz : 1;
	73	unsigned lbpu : 1;
	74	unsigned lbpws : 1;
	75	unsigned lbpws10 : 1;
	76	unsigned lbpvpd : 1;
e73aec82	77	};
ee959b00	78	#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82	79
5b635da1 MP	80	static inline struct scsi_disk scsi_disk(struct gendisk disk)
	81	{
	82	return container_of(disk->private_data, struct scsi_disk, driver);
	83	}
	84
e73aec82 MP	85	#define sd_printk(prefix, sdsk, fmt, a...) \
	86	(sdsk)->disk ? \
	87	sdev_printk(prefix, (sdsk)->device, "[%s] " fmt, \
	88	(sdsk)->disk->disk_name, ##a) : \
	89	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
	90
e0597d70 MP	91	/*
	92	* A DIF-capable target device can be formatted with different
	93	* protection schemes. Currently 0 through 3 are defined:
	94	*
	95	* Type 0 is regular (unprotected) I/O
	96	*
	97	* Type 1 defines the contents of the guard and reference tags
	98	*
	99	* Type 2 defines the contents of the guard and reference tags and
	100	* uses 32-byte commands to seed the latter
	101	*
	102	* Type 3 defines the contents of the guard tag only
	103	*/
	104
	105	enum sd_dif_target_protection_types {
	106	SD_DIF_TYPE0_PROTECTION = 0x0,
	107	SD_DIF_TYPE1_PROTECTION = 0x1,
	108	SD_DIF_TYPE2_PROTECTION = 0x2,
	109	SD_DIF_TYPE3_PROTECTION = 0x3,
	110	};
	111
af55ff67 MP	112	/*
	113	* Data Integrity Field tuple.
	114	*/
	115	struct sd_dif_tuple {
	116	__be16 guard_tag; /* Checksum */
	117	__be16 app_tag; /* Opaque storage */
	118	__be32 ref_tag; /* Target LBA or indirect LBA */
	119	};
	120
4c393e6e	121	#ifdef CONFIG_BLK_DEV_INTEGRITY
af55ff67	122
af55ff67 MP	123	extern void sd_dif_config_host(struct scsi_disk *);
	124	extern int sd_dif_prepare(struct request *rq, sector_t, unsigned int);
	125	extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
	126
	127	#else /* CONFIG_BLK_DEV_INTEGRITY */
	128
4c393e6e JB	129	static inline void sd_dif_config_host(struct scsi_disk *disk)
	130	{
	131	}
	132	static inline int sd_dif_prepare(struct request *rq, sector_t s, unsigned int a)
	133	{
	134	return 0;
	135	}
	136	static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
	137	{
	138	}
af55ff67 MP	139
	140	#endif /* CONFIG_BLK_DEV_INTEGRITY */
	141
e73aec82	142	#endif /* _SCSI_DISK_H */