[mirror_ubuntu-artful-kernel.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)

/*
 * 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

struct scsi_disk {
	struct scsi_driver *driver;	/* always &sd_template */
	struct scsi_device *device;
	struct device	dev;
	struct gendisk	*disk;
	unsigned int	openers;	/* protected by BKL for now, yuck */
	sector_t	capacity;	/* size in 512-byte sectors */
	u32		index;
	u8		media_present;
	u8		write_prot;
	u8		protection_type;/* Data Integrity Field */
	unsigned	previous_state : 1;
	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 */
};
#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 */
};

#if defined(CONFIG_BLK_DEV_INTEGRITY)

extern void sd_dif_op(struct scsi_cmnd *, unsigned int, unsigned int, unsigned int);
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 */

#define sd_dif_op(a, b, c)			do { } while (0)
#define sd_dif_config_host(a)			do { } while (0)
#define sd_dif_prepare(a, b, c)			(0)
#define sd_dif_complete(a, b)			(0)

#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)
	22
	23	/*
	24	* Number of allowed retries
	25	*/
	26	#define SD_MAX_RETRIES 5
	27	#define SD_PASSTHROUGH_RETRIES 1
	28
	29	/*
	30	* Size of the initial data buffer for mode and read capacity data
	31	*/
	32	#define SD_BUF_SIZE 512
	33
18351070 LT	34	/*
	35	* Number of sectors at the end of the device to avoid multi-sector
	36	* accesses to in the case of last_sector_bug
	37	*/
	38	#define SD_LAST_BUGGY_SECTORS 8
	39
e73aec82 MP	40	struct scsi_disk {
	41	struct scsi_driver driver; / always &sd_template */
	42	struct scsi_device *device;
ee959b00	43	struct device dev;
e73aec82 MP	44	struct gendisk *disk;
	45	unsigned int openers; /* protected by BKL for now, yuck */
	46	sector_t capacity; /* size in 512-byte sectors */
	47	u32 index;
	48	u8 media_present;
	49	u8 write_prot;
e0597d70	50	u8 protection_type;/* Data Integrity Field */
285e9670	51	unsigned previous_state : 1;
e0597d70	52	unsigned ATO : 1; /* state of disk ATO bit */
e73aec82 MP	53	unsigned WCE : 1; /* state of disk WCE bit */
	54	unsigned RCD : 1; /* state of disk RCD bit, unused */
	55	unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
	56	};
ee959b00	57	#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82	58
5b635da1 MP	59	static inline struct scsi_disk scsi_disk(struct gendisk disk)
	60	{
	61	return container_of(disk->private_data, struct scsi_disk, driver);
	62	}
	63
e73aec82 MP	64	#define sd_printk(prefix, sdsk, fmt, a...) \
	65	(sdsk)->disk ? \
	66	sdev_printk(prefix, (sdsk)->device, "[%s] " fmt, \
	67	(sdsk)->disk->disk_name, ##a) : \
	68	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
	69
e0597d70 MP	70	/*
	71	* A DIF-capable target device can be formatted with different
	72	* protection schemes. Currently 0 through 3 are defined:
	73	*
	74	* Type 0 is regular (unprotected) I/O
	75	*
	76	* Type 1 defines the contents of the guard and reference tags
	77	*
	78	* Type 2 defines the contents of the guard and reference tags and
	79	* uses 32-byte commands to seed the latter
	80	*
	81	* Type 3 defines the contents of the guard tag only
	82	*/
	83
	84	enum sd_dif_target_protection_types {
	85	SD_DIF_TYPE0_PROTECTION = 0x0,
	86	SD_DIF_TYPE1_PROTECTION = 0x1,
	87	SD_DIF_TYPE2_PROTECTION = 0x2,
	88	SD_DIF_TYPE3_PROTECTION = 0x3,
	89	};
	90
af55ff67 MP	91	/*
	92	* Data Integrity Field tuple.
	93	*/
	94	struct sd_dif_tuple {
	95	__be16 guard_tag; /* Checksum */
	96	__be16 app_tag; /* Opaque storage */
	97	__be32 ref_tag; /* Target LBA or indirect LBA */
	98	};
	99
	100	#if defined(CONFIG_BLK_DEV_INTEGRITY)
	101
9e06688e	102	extern void sd_dif_op(struct scsi_cmnd *, unsigned int, unsigned int, unsigned int);
af55ff67 MP	103	extern void sd_dif_config_host(struct scsi_disk *);
	104	extern int sd_dif_prepare(struct request *rq, sector_t, unsigned int);
	105	extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
	106
	107	#else /* CONFIG_BLK_DEV_INTEGRITY */
	108
	109	#define sd_dif_op(a, b, c) do { } while (0)
	110	#define sd_dif_config_host(a) do { } while (0)
	111	#define sd_dif_prepare(a, b, c) (0)
	112	#define sd_dif_complete(a, b) (0)
	113
	114	#endif /* CONFIG_BLK_DEV_INTEGRITY */
	115
e73aec82	116	#endif /* _SCSI_DISK_H */