[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

/*
 * This is limited by the naming scheme enforced in sd_probe,
 * add another character to it if you really need more disks.
 */
#define SD_MAX_DISKS	(((26 * 26) + 26 + 1) * 26)

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