1 /* SPDX-License-Identifier: GPL-2.0 */
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
13 * Time out in seconds for disks and Magneto-opticals (which are slower).
15 #define SD_TIMEOUT (30 * HZ)
16 #define SD_MOD_TIMEOUT (75 * HZ)
18 * Flush timeout is a multiplier over the standard device timeout which is
19 * user modifiable via sysfs but initially set to SD_TIMEOUT
21 #define SD_FLUSH_TIMEOUT_MULTIPLIER 2
22 #define SD_WRITE_SAME_TIMEOUT (120 * HZ)
25 * Number of allowed retries
27 #define SD_MAX_RETRIES 5
28 #define SD_PASSTHROUGH_RETRIES 1
29 #define SD_MAX_MEDIUM_TIMEOUTS 2
32 * Size of the initial data buffer for mode and read capacity data
34 #define SD_BUF_SIZE 512
37 * Number of sectors at the end of the device to avoid multi-sector
38 * accesses to in the case of last_sector_bug
40 #define SD_LAST_BUGGY_SECTORS 8
43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
48 SD_DEF_XFER_BLOCKS = 0xffff,
49 SD_MAX_XFER_BLOCKS = 0xffffffff,
50 SD_MAX_WS10_BLOCKS = 0xffff,
51 SD_MAX_WS16_BLOCKS = 0x7fffff,
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 */
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 */
71 struct scsi_driver *driver; /* always &sd_template */
72 struct scsi_device *device;
75 struct opal_dev *opal_dev;
76 #ifdef CONFIG_BLK_DEV_ZONED
77 unsigned int nr_zones;
78 unsigned int zone_blocks;
79 unsigned int zone_shift;
80 unsigned long *zones_wlock;
81 unsigned int zones_optimal_open;
82 unsigned int zones_optimal_nonseq;
83 unsigned int zones_max_open;
86 sector_t capacity; /* size in logical blocks */
91 u32 unmap_granularity;
94 unsigned int physical_block_size;
95 unsigned int max_medium_access_timeouts;
96 unsigned int medium_access_timed_out;
99 u8 protection_type;/* Data Integrity Field */
100 u8 provisioning_mode;
102 unsigned ATO : 1; /* state of disk ATO bit */
103 unsigned cache_override : 1; /* temp override of WCE,RCD */
104 unsigned WCE : 1; /* state of disk WCE bit */
105 unsigned RCD : 1; /* state of disk RCD bit, unused */
106 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
107 unsigned first_scan : 1;
112 unsigned lbpws10 : 1;
116 unsigned rc_basis: 2;
119 unsigned security : 1;
120 unsigned ignore_medium_access_errors : 1;
122 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
124 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
126 return container_of(disk->private_data, struct scsi_disk, driver);
129 #define sd_printk(prefix, sdsk, fmt, a...) \
131 sdev_prefix_printk(prefix, (sdsk)->device, \
132 (sdsk)->disk->disk_name, fmt, ##a) : \
133 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
135 #define sd_first_printk(prefix, sdsk, fmt, a...) \
137 if ((sdkp)->first_scan) \
138 sd_printk(prefix, sdsk, fmt, ##a); \
141 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
143 switch (scmd->cmnd[0]) {
148 case SYNCHRONIZE_CACHE:
160 case VARIABLE_LENGTH_CMD:
161 switch (scmd->cmnd[9]) {
173 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
175 return blocks << (ilog2(sdev->sector_size) - 9);
178 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
180 return blocks * sdev->sector_size;
183 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
185 return bytes >> ilog2(sdev->sector_size);
188 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
190 return sector >> (ilog2(sdev->sector_size) - 9);
194 * Look up the DIX operation based on whether the command is read or
195 * write and whether dix and dif are enabled.
197 static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
199 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
200 const unsigned int ops[] = { /* wrt dix dif */
201 SCSI_PROT_NORMAL, /* 0 0 0 */
202 SCSI_PROT_READ_STRIP, /* 0 0 1 */
203 SCSI_PROT_READ_INSERT, /* 0 1 0 */
204 SCSI_PROT_READ_PASS, /* 0 1 1 */
205 SCSI_PROT_NORMAL, /* 1 0 0 */
206 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
207 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
208 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
211 return ops[write << 2 | dix << 1 | dif];
215 * Returns a mask of the protection flags that are valid for a given DIX
218 static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
220 const unsigned int flag_mask[] = {
221 [SCSI_PROT_NORMAL] = 0,
223 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
224 SCSI_PROT_GUARD_CHECK |
225 SCSI_PROT_REF_CHECK |
226 SCSI_PROT_REF_INCREMENT,
228 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
229 SCSI_PROT_IP_CHECKSUM,
231 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
232 SCSI_PROT_GUARD_CHECK |
233 SCSI_PROT_REF_CHECK |
234 SCSI_PROT_REF_INCREMENT |
235 SCSI_PROT_IP_CHECKSUM,
237 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
238 SCSI_PROT_REF_INCREMENT,
240 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
241 SCSI_PROT_REF_CHECK |
242 SCSI_PROT_REF_INCREMENT |
243 SCSI_PROT_IP_CHECKSUM,
245 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
246 SCSI_PROT_GUARD_CHECK |
247 SCSI_PROT_REF_CHECK |
248 SCSI_PROT_REF_INCREMENT |
249 SCSI_PROT_IP_CHECKSUM,
252 return flag_mask[prot_op];
255 #ifdef CONFIG_BLK_DEV_INTEGRITY
257 extern void sd_dif_config_host(struct scsi_disk *);
258 extern void sd_dif_prepare(struct scsi_cmnd *scmd);
259 extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
261 #else /* CONFIG_BLK_DEV_INTEGRITY */
263 static inline void sd_dif_config_host(struct scsi_disk *disk)
266 static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
270 static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
274 #endif /* CONFIG_BLK_DEV_INTEGRITY */
276 static inline int sd_is_zoned(struct scsi_disk *sdkp)
278 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
281 #ifdef CONFIG_BLK_DEV_ZONED
283 extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
284 extern void sd_zbc_remove(struct scsi_disk *sdkp);
285 extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
286 extern int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd);
287 extern void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd);
288 extern int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd);
289 extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd);
290 extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
291 struct scsi_sense_hdr *sshdr);
293 #else /* CONFIG_BLK_DEV_ZONED */
295 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
301 static inline void sd_zbc_remove(struct scsi_disk *sdkp) {}
303 static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
305 static inline int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd)
307 /* Let the drive fail requests */
311 static inline void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd) {}
313 static inline int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd)
315 return BLKPREP_INVALID;
318 static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd)
320 return BLKPREP_INVALID;
323 static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
324 unsigned int good_bytes,
325 struct scsi_sense_hdr *sshdr) {}
327 #endif /* CONFIG_BLK_DEV_ZONED */
329 #endif /* _SCSI_DISK_H */