xref: /linux/drivers/scsi/sd.h (revision 3f0a50f345f78183f6e9b39c2f45ca5dcaa511ca)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _SCSI_DISK_H
3 #define _SCSI_DISK_H
4 
5 /*
6  * More than enough for everybody ;)  The huge number of majors
7  * is a leftover from 16bit dev_t days, we don't really need that
8  * much numberspace.
9  */
10 #define SD_MAJORS	16
11 
12 /*
13  * Time out in seconds for disks and Magneto-opticals (which are slower).
14  */
15 #define SD_TIMEOUT		(30 * HZ)
16 #define SD_MOD_TIMEOUT		(75 * HZ)
17 /*
18  * Flush timeout is a multiplier over the standard device timeout which is
19  * user modifiable via sysfs but initially set to SD_TIMEOUT
20  */
21 #define SD_FLUSH_TIMEOUT_MULTIPLIER	2
22 #define SD_WRITE_SAME_TIMEOUT	(120 * HZ)
23 
24 /*
25  * Number of allowed retries
26  */
27 #define SD_MAX_RETRIES		5
28 #define SD_PASSTHROUGH_RETRIES	1
29 #define SD_MAX_MEDIUM_TIMEOUTS	2
30 
31 /*
32  * Size of the initial data buffer for mode and read capacity data
33  */
34 #define SD_BUF_SIZE		512
35 
36 /*
37  * Number of sectors at the end of the device to avoid multi-sector
38  * accesses to in the case of last_sector_bug
39  */
40 #define SD_LAST_BUGGY_SECTORS	8
41 
42 enum {
43 	SD_EXT_CDB_SIZE = 32,	/* Extended CDB size */
44 	SD_MEMPOOL_SIZE = 2,	/* CDB pool size */
45 };
46 
47 enum {
48 	SD_DEF_XFER_BLOCKS = 0xffff,
49 	SD_MAX_XFER_BLOCKS = 0xffffffff,
50 	SD_MAX_WS10_BLOCKS = 0xffff,
51 	SD_MAX_WS16_BLOCKS = 0x7fffff,
52 };
53 
54 enum {
55 	SD_LBP_FULL = 0,	/* Full logical block provisioning */
56 	SD_LBP_UNMAP,		/* Use UNMAP command */
57 	SD_LBP_WS16,		/* Use WRITE SAME(16) with UNMAP bit */
58 	SD_LBP_WS10,		/* Use WRITE SAME(10) with UNMAP bit */
59 	SD_LBP_ZERO,		/* Use WRITE SAME(10) with zero payload */
60 	SD_LBP_DISABLE,		/* Discard disabled due to failed cmd */
61 };
62 
63 enum {
64 	SD_ZERO_WRITE = 0,	/* Use WRITE(10/16) command */
65 	SD_ZERO_WS,		/* Use WRITE SAME(10/16) command */
66 	SD_ZERO_WS16_UNMAP,	/* Use WRITE SAME(16) with UNMAP */
67 	SD_ZERO_WS10_UNMAP,	/* Use WRITE SAME(10) with UNMAP */
68 };
69 
70 struct scsi_disk {
71 	struct scsi_device *device;
72 
73 	/*
74 	 * disk_dev is used to show attributes in /sys/class/scsi_disk/,
75 	 * but otherwise not really needed.  Do not use for refcounting.
76 	 */
77 	struct device	disk_dev;
78 	struct gendisk	*disk;
79 	struct opal_dev *opal_dev;
80 #ifdef CONFIG_BLK_DEV_ZONED
81 	u32		nr_zones;
82 	u32		rev_nr_zones;
83 	u32		zone_blocks;
84 	u32		rev_zone_blocks;
85 	u32		zones_optimal_open;
86 	u32		zones_optimal_nonseq;
87 	u32		zones_max_open;
88 	u32		*zones_wp_offset;
89 	spinlock_t	zones_wp_offset_lock;
90 	u32		*rev_wp_offset;
91 	struct mutex	rev_mutex;
92 	struct work_struct zone_wp_offset_work;
93 	char		*zone_wp_update_buf;
94 #endif
95 	atomic_t	openers;
96 	sector_t	capacity;	/* size in logical blocks */
97 	int		max_retries;
98 	u32		max_xfer_blocks;
99 	u32		opt_xfer_blocks;
100 	u32		max_ws_blocks;
101 	u32		max_unmap_blocks;
102 	u32		unmap_granularity;
103 	u32		unmap_alignment;
104 	u32		index;
105 	unsigned int	physical_block_size;
106 	unsigned int	max_medium_access_timeouts;
107 	unsigned int	medium_access_timed_out;
108 	u8		media_present;
109 	u8		write_prot;
110 	u8		protection_type;/* Data Integrity Field */
111 	u8		provisioning_mode;
112 	u8		zeroing_mode;
113 	u8		nr_actuators;		/* Number of actuators */
114 	unsigned	ATO : 1;	/* state of disk ATO bit */
115 	unsigned	cache_override : 1; /* temp override of WCE,RCD */
116 	unsigned	WCE : 1;	/* state of disk WCE bit */
117 	unsigned	RCD : 1;	/* state of disk RCD bit, unused */
118 	unsigned	DPOFUA : 1;	/* state of disk DPOFUA bit */
119 	unsigned	first_scan : 1;
120 	unsigned	lbpme : 1;
121 	unsigned	lbprz : 1;
122 	unsigned	lbpu : 1;
123 	unsigned	lbpws : 1;
124 	unsigned	lbpws10 : 1;
125 	unsigned	lbpvpd : 1;
126 	unsigned	ws10 : 1;
127 	unsigned	ws16 : 1;
128 	unsigned	rc_basis: 2;
129 	unsigned	zoned: 2;
130 	unsigned	urswrz : 1;
131 	unsigned	security : 1;
132 	unsigned	ignore_medium_access_errors : 1;
133 };
134 #define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)
135 
136 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
137 {
138 	return disk->private_data;
139 }
140 
141 #define sd_printk(prefix, sdsk, fmt, a...)				\
142         (sdsk)->disk ?							\
143 	      sdev_prefix_printk(prefix, (sdsk)->device,		\
144 				 (sdsk)->disk->disk_name, fmt, ##a) :	\
145 	      sdev_printk(prefix, (sdsk)->device, fmt, ##a)
146 
147 #define sd_first_printk(prefix, sdsk, fmt, a...)			\
148 	do {								\
149 		if ((sdsk)->first_scan)					\
150 			sd_printk(prefix, sdsk, fmt, ##a);		\
151 	} while (0)
152 
153 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
154 {
155 	switch (scmd->cmnd[0]) {
156 	case READ_6:
157 	case READ_10:
158 	case READ_12:
159 	case READ_16:
160 	case SYNCHRONIZE_CACHE:
161 	case VERIFY:
162 	case VERIFY_12:
163 	case VERIFY_16:
164 	case WRITE_6:
165 	case WRITE_10:
166 	case WRITE_12:
167 	case WRITE_16:
168 	case WRITE_SAME:
169 	case WRITE_SAME_16:
170 	case UNMAP:
171 		return 1;
172 	case VARIABLE_LENGTH_CMD:
173 		switch (scmd->cmnd[9]) {
174 		case READ_32:
175 		case VERIFY_32:
176 		case WRITE_32:
177 		case WRITE_SAME_32:
178 			return 1;
179 		}
180 	}
181 
182 	return 0;
183 }
184 
185 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
186 {
187 	return blocks << (ilog2(sdev->sector_size) - 9);
188 }
189 
190 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
191 {
192 	return blocks * sdev->sector_size;
193 }
194 
195 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
196 {
197 	return bytes >> ilog2(sdev->sector_size);
198 }
199 
200 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
201 {
202 	return sector >> (ilog2(sdev->sector_size) - 9);
203 }
204 
205 #ifdef CONFIG_BLK_DEV_INTEGRITY
206 
207 extern void sd_dif_config_host(struct scsi_disk *);
208 
209 #else /* CONFIG_BLK_DEV_INTEGRITY */
210 
211 static inline void sd_dif_config_host(struct scsi_disk *disk)
212 {
213 }
214 
215 #endif /* CONFIG_BLK_DEV_INTEGRITY */
216 
217 static inline int sd_is_zoned(struct scsi_disk *sdkp)
218 {
219 	return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
220 }
221 
222 #ifdef CONFIG_BLK_DEV_ZONED
223 
224 void sd_zbc_release_disk(struct scsi_disk *sdkp);
225 int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
226 int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
227 blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
228 					 unsigned char op, bool all);
229 unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
230 			     struct scsi_sense_hdr *sshdr);
231 int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
232 		unsigned int nr_zones, report_zones_cb cb, void *data);
233 
234 blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
235 				        unsigned int nr_blocks);
236 
237 #else /* CONFIG_BLK_DEV_ZONED */
238 
239 static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
240 
241 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
242 				    unsigned char *buf)
243 {
244 	return 0;
245 }
246 
247 static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
248 {
249 	return 0;
250 }
251 
252 static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
253 						       unsigned char op,
254 						       bool all)
255 {
256 	return BLK_STS_TARGET;
257 }
258 
259 static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
260 			unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
261 {
262 	return good_bytes;
263 }
264 
265 static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
266 						      sector_t *lba,
267 						      unsigned int nr_blocks)
268 {
269 	return BLK_STS_TARGET;
270 }
271 
272 #define sd_zbc_report_zones NULL
273 
274 #endif /* CONFIG_BLK_DEV_ZONED */
275 
276 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
277 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
278 
279 #endif /* _SCSI_DISK_H */
280