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 /**
71 * struct zoned_disk_info - Specific properties of a ZBC SCSI device.
72 * @nr_zones: number of zones.
73 * @zone_blocks: number of logical blocks per zone.
74 *
75 * This data structure holds the ZBC SCSI device properties that are retrieved
76 * twice: a first time before the gendisk capacity is known and a second time
77 * after the gendisk capacity is known.
78 */
79 struct zoned_disk_info {
80 u32 nr_zones;
81 u32 zone_blocks;
82 };
83
84 struct scsi_disk {
85 struct scsi_driver *driver; /* always &sd_template */
86 struct scsi_device *device;
87 struct device dev;
88 struct gendisk *disk;
89 struct opal_dev *opal_dev;
90 #ifdef CONFIG_BLK_DEV_ZONED
91 /* Updated during revalidation before the gendisk capacity is known. */
92 struct zoned_disk_info early_zone_info;
93 /* Updated during revalidation after the gendisk capacity is known. */
94 struct zoned_disk_info zone_info;
95 u32 zones_optimal_open;
96 u32 zones_optimal_nonseq;
97 u32 zones_max_open;
98 /*
99 * Either zero or a power of two. If not zero it means that the offset
100 * between zone starting LBAs is constant.
101 */
102 u32 zone_starting_lba_gran;
103 u32 *zones_wp_offset;
104 spinlock_t zones_wp_offset_lock;
105 u32 *rev_wp_offset;
106 struct mutex rev_mutex;
107 struct work_struct zone_wp_offset_work;
108 char *zone_wp_update_buf;
109 #endif
110 atomic_t openers;
111 sector_t capacity; /* size in logical blocks */
112 int max_retries;
113 u32 max_xfer_blocks;
114 u32 opt_xfer_blocks;
115 u32 max_ws_blocks;
116 u32 max_unmap_blocks;
117 u32 unmap_granularity;
118 u32 unmap_alignment;
119 u32 index;
120 unsigned int physical_block_size;
121 unsigned int max_medium_access_timeouts;
122 unsigned int medium_access_timed_out;
123 u8 media_present;
124 u8 write_prot;
125 u8 protection_type;/* Data Integrity Field */
126 u8 provisioning_mode;
127 u8 zeroing_mode;
128 unsigned ATO : 1; /* state of disk ATO bit */
129 unsigned cache_override : 1; /* temp override of WCE,RCD */
130 unsigned WCE : 1; /* state of disk WCE bit */
131 unsigned RCD : 1; /* state of disk RCD bit, unused */
132 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
133 unsigned first_scan : 1;
134 unsigned lbpme : 1;
135 unsigned lbprz : 1;
136 unsigned lbpu : 1;
137 unsigned lbpws : 1;
138 unsigned lbpws10 : 1;
139 unsigned lbpvpd : 1;
140 unsigned ws10 : 1;
141 unsigned ws16 : 1;
142 unsigned rc_basis: 2;
143 unsigned zoned: 2;
144 unsigned urswrz : 1;
145 unsigned security : 1;
146 unsigned ignore_medium_access_errors : 1;
147
148 ANDROID_KABI_RESERVE(1);
149 ANDROID_KABI_RESERVE(2);
150 };
151 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
152
scsi_disk(struct gendisk * disk)153 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
154 {
155 return container_of(disk->private_data, struct scsi_disk, driver);
156 }
157
158 #define sd_printk(prefix, sdsk, fmt, a...) \
159 (sdsk)->disk ? \
160 sdev_prefix_printk(prefix, (sdsk)->device, \
161 (sdsk)->disk->disk_name, fmt, ##a) : \
162 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
163
164 #define sd_first_printk(prefix, sdsk, fmt, a...) \
165 do { \
166 if ((sdsk)->first_scan) \
167 sd_printk(prefix, sdsk, fmt, ##a); \
168 } while (0)
169
scsi_medium_access_command(struct scsi_cmnd * scmd)170 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
171 {
172 switch (scmd->cmnd[0]) {
173 case READ_6:
174 case READ_10:
175 case READ_12:
176 case READ_16:
177 case SYNCHRONIZE_CACHE:
178 case VERIFY:
179 case VERIFY_12:
180 case VERIFY_16:
181 case WRITE_6:
182 case WRITE_10:
183 case WRITE_12:
184 case WRITE_16:
185 case WRITE_SAME:
186 case WRITE_SAME_16:
187 case UNMAP:
188 return 1;
189 case VARIABLE_LENGTH_CMD:
190 switch (scmd->cmnd[9]) {
191 case READ_32:
192 case VERIFY_32:
193 case WRITE_32:
194 case WRITE_SAME_32:
195 return 1;
196 }
197 }
198
199 return 0;
200 }
201
logical_to_sectors(struct scsi_device * sdev,sector_t blocks)202 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
203 {
204 return blocks << (ilog2(sdev->sector_size) - 9);
205 }
206
logical_to_bytes(struct scsi_device * sdev,sector_t blocks)207 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
208 {
209 return blocks * sdev->sector_size;
210 }
211
bytes_to_logical(struct scsi_device * sdev,unsigned int bytes)212 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
213 {
214 return bytes >> ilog2(sdev->sector_size);
215 }
216
sectors_to_logical(struct scsi_device * sdev,sector_t sector)217 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
218 {
219 return sector >> (ilog2(sdev->sector_size) - 9);
220 }
221
222 #ifdef CONFIG_BLK_DEV_INTEGRITY
223
224 extern void sd_dif_config_host(struct scsi_disk *);
225
226 #else /* CONFIG_BLK_DEV_INTEGRITY */
227
sd_dif_config_host(struct scsi_disk * disk)228 static inline void sd_dif_config_host(struct scsi_disk *disk)
229 {
230 }
231
232 #endif /* CONFIG_BLK_DEV_INTEGRITY */
233
sd_is_zoned(struct scsi_disk * sdkp)234 static inline int sd_is_zoned(struct scsi_disk *sdkp)
235 {
236 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
237 }
238
239 #ifdef CONFIG_BLK_DEV_ZONED
240
241 void sd_zbc_release_disk(struct scsi_disk *sdkp);
242 int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE]);
243 int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
244 blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
245 unsigned char op, bool all);
246 unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
247 struct scsi_sense_hdr *sshdr);
248 int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
249 unsigned int nr_zones, report_zones_cb cb, void *data);
250
251 blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
252 unsigned int nr_blocks);
253
254 #else /* CONFIG_BLK_DEV_ZONED */
255
sd_zbc_release_disk(struct scsi_disk * sdkp)256 static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
257
sd_zbc_read_zones(struct scsi_disk * sdkp,u8 buf[SD_BUF_SIZE])258 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE])
259 {
260 return 0;
261 }
262
sd_zbc_revalidate_zones(struct scsi_disk * sdkp)263 static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
264 {
265 return 0;
266 }
267
sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd * cmd,unsigned char op,bool all)268 static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
269 unsigned char op,
270 bool all)
271 {
272 return BLK_STS_TARGET;
273 }
274
sd_zbc_complete(struct scsi_cmnd * cmd,unsigned int good_bytes,struct scsi_sense_hdr * sshdr)275 static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
276 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
277 {
278 return good_bytes;
279 }
280
sd_zbc_prepare_zone_append(struct scsi_cmnd * cmd,sector_t * lba,unsigned int nr_blocks)281 static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
282 sector_t *lba,
283 unsigned int nr_blocks)
284 {
285 return BLK_STS_TARGET;
286 }
287
288 #define sd_zbc_report_zones NULL
289
290 #endif /* CONFIG_BLK_DEV_ZONED */
291
292 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
293 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
294
295 #endif /* _SCSI_DISK_H */
296