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_DEF_XFER_BLOCKS = 0xffff, 48 SD_MAX_XFER_BLOCKS = 0xffffffff, 49 SD_MAX_WS10_BLOCKS = 0xffff, 50 SD_MAX_WS16_BLOCKS = 0x7fffff, 51 }; 52 53 enum { 54 SD_LBP_FULL = 0, /* Full logical block provisioning */ 55 SD_LBP_UNMAP, /* Use UNMAP command */ 56 SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */ 57 SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */ 58 SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */ 59 SD_LBP_DISABLE, /* Discard disabled due to failed cmd */ 60 }; 61 62 enum { 63 SD_ZERO_WRITE = 0, /* Use WRITE(10/16) command */ 64 SD_ZERO_WS, /* Use WRITE SAME(10/16) command */ 65 SD_ZERO_WS16_UNMAP, /* Use WRITE SAME(16) with UNMAP */ 66 SD_ZERO_WS10_UNMAP, /* Use WRITE SAME(10) with UNMAP */ 67 }; 68 69 struct scsi_disk { 70 struct scsi_driver *driver; /* always &sd_template */ 71 struct scsi_device *device; 72 struct device dev; 73 struct gendisk *disk; 74 #ifdef CONFIG_BLK_DEV_ZONED 75 unsigned int nr_zones; 76 unsigned int zone_blocks; 77 unsigned int zone_shift; 78 unsigned long *zones_wlock; 79 unsigned int zones_optimal_open; 80 unsigned int zones_optimal_nonseq; 81 unsigned int zones_max_open; 82 #endif 83 atomic_t openers; 84 sector_t capacity; /* size in logical blocks */ 85 u32 max_xfer_blocks; 86 u32 opt_xfer_blocks; 87 u32 max_ws_blocks; 88 u32 max_unmap_blocks; 89 u32 unmap_granularity; 90 u32 unmap_alignment; 91 u32 index; 92 unsigned int physical_block_size; 93 unsigned int max_medium_access_timeouts; 94 unsigned int medium_access_timed_out; 95 u8 media_present; 96 u8 write_prot; 97 u8 protection_type;/* Data Integrity Field */ 98 u8 provisioning_mode; 99 u8 zeroing_mode; 100 unsigned ATO : 1; /* state of disk ATO bit */ 101 unsigned cache_override : 1; /* temp override of WCE,RCD */ 102 unsigned WCE : 1; /* state of disk WCE bit */ 103 unsigned RCD : 1; /* state of disk RCD bit, unused */ 104 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */ 105 unsigned first_scan : 1; 106 unsigned lbpme : 1; 107 unsigned lbprz : 1; 108 unsigned lbpu : 1; 109 unsigned lbpws : 1; 110 unsigned lbpws10 : 1; 111 unsigned lbpvpd : 1; 112 unsigned ws10 : 1; 113 unsigned ws16 : 1; 114 unsigned rc_basis: 2; 115 unsigned zoned: 2; 116 unsigned urswrz : 1; 117 }; 118 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev) 119 120 static inline struct scsi_disk *scsi_disk(struct gendisk *disk) 121 { 122 return container_of(disk->private_data, struct scsi_disk, driver); 123 } 124 125 #define sd_printk(prefix, sdsk, fmt, a...) \ 126 (sdsk)->disk ? \ 127 sdev_prefix_printk(prefix, (sdsk)->device, \ 128 (sdsk)->disk->disk_name, fmt, ##a) : \ 129 sdev_printk(prefix, (sdsk)->device, fmt, ##a) 130 131 #define sd_first_printk(prefix, sdsk, fmt, a...) \ 132 do { \ 133 if ((sdkp)->first_scan) \ 134 sd_printk(prefix, sdsk, fmt, ##a); \ 135 } while (0) 136 137 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd) 138 { 139 switch (scmd->cmnd[0]) { 140 case READ_6: 141 case READ_10: 142 case READ_12: 143 case READ_16: 144 case SYNCHRONIZE_CACHE: 145 case VERIFY: 146 case VERIFY_12: 147 case VERIFY_16: 148 case WRITE_6: 149 case WRITE_10: 150 case WRITE_12: 151 case WRITE_16: 152 case WRITE_SAME: 153 case WRITE_SAME_16: 154 case UNMAP: 155 return 1; 156 case VARIABLE_LENGTH_CMD: 157 switch (scmd->cmnd[9]) { 158 case READ_32: 159 case VERIFY_32: 160 case WRITE_32: 161 case WRITE_SAME_32: 162 return 1; 163 } 164 } 165 166 return 0; 167 } 168 169 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks) 170 { 171 return blocks << (ilog2(sdev->sector_size) - 9); 172 } 173 174 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks) 175 { 176 return blocks * sdev->sector_size; 177 } 178 179 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector) 180 { 181 return sector >> (ilog2(sdev->sector_size) - 9); 182 } 183 184 /* 185 * Look up the DIX operation based on whether the command is read or 186 * write and whether dix and dif are enabled. 187 */ 188 static inline unsigned int sd_prot_op(bool write, bool dix, bool dif) 189 { 190 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */ 191 const unsigned int ops[] = { /* wrt dix dif */ 192 SCSI_PROT_NORMAL, /* 0 0 0 */ 193 SCSI_PROT_READ_STRIP, /* 0 0 1 */ 194 SCSI_PROT_READ_INSERT, /* 0 1 0 */ 195 SCSI_PROT_READ_PASS, /* 0 1 1 */ 196 SCSI_PROT_NORMAL, /* 1 0 0 */ 197 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */ 198 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */ 199 SCSI_PROT_WRITE_PASS, /* 1 1 1 */ 200 }; 201 202 return ops[write << 2 | dix << 1 | dif]; 203 } 204 205 /* 206 * Returns a mask of the protection flags that are valid for a given DIX 207 * operation. 208 */ 209 static inline unsigned int sd_prot_flag_mask(unsigned int prot_op) 210 { 211 const unsigned int flag_mask[] = { 212 [SCSI_PROT_NORMAL] = 0, 213 214 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI | 215 SCSI_PROT_GUARD_CHECK | 216 SCSI_PROT_REF_CHECK | 217 SCSI_PROT_REF_INCREMENT, 218 219 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT | 220 SCSI_PROT_IP_CHECKSUM, 221 222 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI | 223 SCSI_PROT_GUARD_CHECK | 224 SCSI_PROT_REF_CHECK | 225 SCSI_PROT_REF_INCREMENT | 226 SCSI_PROT_IP_CHECKSUM, 227 228 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI | 229 SCSI_PROT_REF_INCREMENT, 230 231 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK | 232 SCSI_PROT_REF_CHECK | 233 SCSI_PROT_REF_INCREMENT | 234 SCSI_PROT_IP_CHECKSUM, 235 236 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI | 237 SCSI_PROT_GUARD_CHECK | 238 SCSI_PROT_REF_CHECK | 239 SCSI_PROT_REF_INCREMENT | 240 SCSI_PROT_IP_CHECKSUM, 241 }; 242 243 return flag_mask[prot_op]; 244 } 245 246 #ifdef CONFIG_BLK_DEV_INTEGRITY 247 248 extern void sd_dif_config_host(struct scsi_disk *); 249 extern void sd_dif_prepare(struct scsi_cmnd *scmd); 250 extern void sd_dif_complete(struct scsi_cmnd *, unsigned int); 251 252 #else /* CONFIG_BLK_DEV_INTEGRITY */ 253 254 static inline void sd_dif_config_host(struct scsi_disk *disk) 255 { 256 } 257 static inline int sd_dif_prepare(struct scsi_cmnd *scmd) 258 { 259 return 0; 260 } 261 static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a) 262 { 263 } 264 265 #endif /* CONFIG_BLK_DEV_INTEGRITY */ 266 267 static inline int sd_is_zoned(struct scsi_disk *sdkp) 268 { 269 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC; 270 } 271 272 #ifdef CONFIG_BLK_DEV_ZONED 273 274 extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer); 275 extern void sd_zbc_remove(struct scsi_disk *sdkp); 276 extern void sd_zbc_print_zones(struct scsi_disk *sdkp); 277 extern int sd_zbc_setup_write_cmnd(struct scsi_cmnd *cmd); 278 extern void sd_zbc_cancel_write_cmnd(struct scsi_cmnd *cmd); 279 extern int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd); 280 extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd); 281 extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes, 282 struct scsi_sense_hdr *sshdr); 283 284 #else /* CONFIG_BLK_DEV_ZONED */ 285 286 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp, 287 unsigned char *buf) 288 { 289 return 0; 290 } 291 292 static inline void sd_zbc_remove(struct scsi_disk *sdkp) {} 293 294 static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {} 295 296 static inline int sd_zbc_setup_write_cmnd(struct scsi_cmnd *cmd) 297 { 298 /* Let the drive fail requests */ 299 return BLKPREP_OK; 300 } 301 302 static inline void sd_zbc_cancel_write_cmnd(struct scsi_cmnd *cmd) {} 303 304 static inline int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd) 305 { 306 return BLKPREP_INVALID; 307 } 308 309 static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd) 310 { 311 return BLKPREP_INVALID; 312 } 313 314 static inline void sd_zbc_complete(struct scsi_cmnd *cmd, 315 unsigned int good_bytes, 316 struct scsi_sense_hdr *sshdr) {} 317 318 #endif /* CONFIG_BLK_DEV_ZONED */ 319 320 #endif /* _SCSI_DISK_H */ 321