xref: /linux/drivers/scsi/sd.h (revision c98be0c96db00e9b6b02d31e0fa7590c54cdaaac)
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  * 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)
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
21 #define SD_WRITE_SAME_TIMEOUT	(120 * HZ)
22 
23 /*
24  * Number of allowed retries
25  */
26 #define SD_MAX_RETRIES		5
27 #define SD_PASSTHROUGH_RETRIES	1
28 #define SD_MAX_MEDIUM_TIMEOUTS	2
29 
30 /*
31  * Size of the initial data buffer for mode and read capacity data
32  */
33 #define SD_BUF_SIZE		512
34 
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 
41 enum {
42 	SD_EXT_CDB_SIZE = 32,	/* Extended CDB size */
43 	SD_MEMPOOL_SIZE = 2,	/* CDB pool size */
44 };
45 
46 enum {
47 	SD_MAX_WS10_BLOCKS = 0xffff,
48 	SD_MAX_WS16_BLOCKS = 0x7fffff,
49 };
50 
51 enum {
52 	SD_LBP_FULL = 0,	/* Full logical block provisioning */
53 	SD_LBP_UNMAP,		/* Use UNMAP command */
54 	SD_LBP_WS16,		/* Use WRITE SAME(16) with UNMAP bit */
55 	SD_LBP_WS10,		/* Use WRITE SAME(10) with UNMAP bit */
56 	SD_LBP_ZERO,		/* Use WRITE SAME(10) with zero payload */
57 	SD_LBP_DISABLE,		/* Discard disabled due to failed cmd */
58 };
59 
60 struct scsi_disk {
61 	struct scsi_driver *driver;	/* always &sd_template */
62 	struct scsi_device *device;
63 	struct device	dev;
64 	struct gendisk	*disk;
65 	atomic_t	openers;
66 	sector_t	capacity;	/* size in 512-byte sectors */
67 	u32		max_ws_blocks;
68 	u32		max_unmap_blocks;
69 	u32		unmap_granularity;
70 	u32		unmap_alignment;
71 	u32		index;
72 	unsigned int	physical_block_size;
73 	unsigned int	max_medium_access_timeouts;
74 	unsigned int	medium_access_timed_out;
75 	u8		media_present;
76 	u8		write_prot;
77 	u8		protection_type;/* Data Integrity Field */
78 	u8		provisioning_mode;
79 	unsigned	ATO : 1;	/* state of disk ATO bit */
80 	unsigned	cache_override : 1; /* temp override of WCE,RCD */
81 	unsigned	WCE : 1;	/* state of disk WCE bit */
82 	unsigned	RCD : 1;	/* state of disk RCD bit, unused */
83 	unsigned	DPOFUA : 1;	/* state of disk DPOFUA bit */
84 	unsigned	first_scan : 1;
85 	unsigned	lbpme : 1;
86 	unsigned	lbprz : 1;
87 	unsigned	lbpu : 1;
88 	unsigned	lbpws : 1;
89 	unsigned	lbpws10 : 1;
90 	unsigned	lbpvpd : 1;
91 	unsigned	ws10 : 1;
92 	unsigned	ws16 : 1;
93 };
94 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
95 
96 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
97 {
98 	return container_of(disk->private_data, struct scsi_disk, driver);
99 }
100 
101 #define sd_printk(prefix, sdsk, fmt, a...)				\
102         (sdsk)->disk ?							\
103 	sdev_printk(prefix, (sdsk)->device, "[%s] " fmt,		\
104 		    (sdsk)->disk->disk_name, ##a) :			\
105 	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
106 
107 #define sd_first_printk(prefix, sdsk, fmt, a...)			\
108 	do {								\
109 		if ((sdkp)->first_scan)					\
110 			sd_printk(prefix, sdsk, fmt, ##a);		\
111 	} while (0)
112 
113 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
114 {
115 	switch (scmd->cmnd[0]) {
116 	case READ_6:
117 	case READ_10:
118 	case READ_12:
119 	case READ_16:
120 	case SYNCHRONIZE_CACHE:
121 	case VERIFY:
122 	case VERIFY_12:
123 	case VERIFY_16:
124 	case WRITE_6:
125 	case WRITE_10:
126 	case WRITE_12:
127 	case WRITE_16:
128 	case WRITE_SAME:
129 	case WRITE_SAME_16:
130 	case UNMAP:
131 		return 1;
132 	case VARIABLE_LENGTH_CMD:
133 		switch (scmd->cmnd[9]) {
134 		case READ_32:
135 		case VERIFY_32:
136 		case WRITE_32:
137 		case WRITE_SAME_32:
138 			return 1;
139 		}
140 	}
141 
142 	return 0;
143 }
144 
145 /*
146  * A DIF-capable target device can be formatted with different
147  * protection schemes.  Currently 0 through 3 are defined:
148  *
149  * Type 0 is regular (unprotected) I/O
150  *
151  * Type 1 defines the contents of the guard and reference tags
152  *
153  * Type 2 defines the contents of the guard and reference tags and
154  * uses 32-byte commands to seed the latter
155  *
156  * Type 3 defines the contents of the guard tag only
157  */
158 
159 enum sd_dif_target_protection_types {
160 	SD_DIF_TYPE0_PROTECTION = 0x0,
161 	SD_DIF_TYPE1_PROTECTION = 0x1,
162 	SD_DIF_TYPE2_PROTECTION = 0x2,
163 	SD_DIF_TYPE3_PROTECTION = 0x3,
164 };
165 
166 /*
167  * Data Integrity Field tuple.
168  */
169 struct sd_dif_tuple {
170        __be16 guard_tag;	/* Checksum */
171        __be16 app_tag;		/* Opaque storage */
172        __be32 ref_tag;		/* Target LBA or indirect LBA */
173 };
174 
175 #ifdef CONFIG_BLK_DEV_INTEGRITY
176 
177 extern void sd_dif_config_host(struct scsi_disk *);
178 extern void sd_dif_prepare(struct request *rq, sector_t, unsigned int);
179 extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
180 
181 #else /* CONFIG_BLK_DEV_INTEGRITY */
182 
183 static inline void sd_dif_config_host(struct scsi_disk *disk)
184 {
185 }
186 static inline int sd_dif_prepare(struct request *rq, sector_t s, unsigned int a)
187 {
188 	return 0;
189 }
190 static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
191 {
192 }
193 
194 #endif /* CONFIG_BLK_DEV_INTEGRITY */
195 
196 #endif /* _SCSI_DISK_H */
197