279 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef _SCSI_DISK_H3#define _SCSI_DISK_H4 5/*6 * More than enough for everybody ;) The huge number of majors7 * is a leftover from 16bit dev_t days, we don't really need that8 * much numberspace.9 */10#define SD_MAJORS 1611 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 is19 * user modifiable via sysfs but initially set to SD_TIMEOUT20 */21#define SD_FLUSH_TIMEOUT_MULTIPLIER 222#define SD_WRITE_SAME_TIMEOUT (120 * HZ)23 24/*25 * Number of allowed retries26 */27#define SD_MAX_RETRIES 528#define SD_PASSTHROUGH_RETRIES 129#define SD_MAX_MEDIUM_TIMEOUTS 230 31/*32 * Size of the initial data buffer for mode and read capacity data33 */34#define SD_BUF_SIZE 51235 36/*37 * Number of sectors at the end of the device to avoid multi-sector38 * accesses to in the case of last_sector_bug39 */40#define SD_LAST_BUGGY_SECTORS 841 42enum {43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */45};46 47enum {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 54enum {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 63enum {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 retrieved76 * twice: a first time before the gendisk capacity is known and a second time77 * after the gendisk capacity is known.78 */79struct zoned_disk_info {80 u32 nr_zones;81 u32 zone_blocks;82};83 84struct scsi_disk {85 struct scsi_device *device;86 87 /*88 * disk_dev is used to show attributes in /sys/class/scsi_disk/,89 * but otherwise not really needed. Do not use for refcounting.90 */91 struct device disk_dev;92 struct gendisk *disk;93 struct opal_dev *opal_dev;94#ifdef CONFIG_BLK_DEV_ZONED95 /* Updated during revalidation before the gendisk capacity is known. */96 struct zoned_disk_info early_zone_info;97 /* Updated during revalidation after the gendisk capacity is known. */98 struct zoned_disk_info zone_info;99 u32 zones_optimal_open;100 u32 zones_optimal_nonseq;101 u32 zones_max_open;102 /*103 * Either zero or a power of two. If not zero it means that the offset104 * between zone starting LBAs is constant.105 */106 u32 zone_starting_lba_gran;107#endif108 atomic_t openers;109 sector_t capacity; /* size in logical blocks */110 int max_retries;111 u32 min_xfer_blocks;112 u32 max_xfer_blocks;113 u32 opt_xfer_blocks;114 u32 max_ws_blocks;115 u32 max_unmap_blocks;116 u32 unmap_granularity;117 u32 unmap_alignment;118 119 u32 max_atomic;120 u32 atomic_alignment;121 u32 atomic_granularity;122 u32 max_atomic_with_boundary;123 u32 max_atomic_boundary;124 125 u32 index;126 unsigned int physical_block_size;127 unsigned int max_medium_access_timeouts;128 unsigned int medium_access_timed_out;129 /* number of permanent streams */130 u16 permanent_stream_count;131 u8 media_present;132 u8 write_prot;133 u8 protection_type;/* Data Integrity Field */134 u8 provisioning_mode;135 u8 zeroing_mode;136 u8 nr_actuators; /* Number of actuators */137 bool suspended; /* Disk is suspended (stopped) */138 unsigned ATO : 1; /* state of disk ATO bit */139 unsigned cache_override : 1; /* temp override of WCE,RCD */140 unsigned WCE : 1; /* state of disk WCE bit */141 unsigned RCD : 1; /* state of disk RCD bit, unused */142 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */143 unsigned first_scan : 1;144 unsigned lbpme : 1;145 unsigned lbprz : 1;146 unsigned lbpu : 1;147 unsigned lbpws : 1;148 unsigned lbpws10 : 1;149 unsigned lbpvpd : 1;150 unsigned ws10 : 1;151 unsigned ws16 : 1;152 unsigned rc_basis: 2;153 unsigned zoned: 2;154 unsigned urswrz : 1;155 unsigned security : 1;156 unsigned ignore_medium_access_errors : 1;157 unsigned rscs : 1; /* reduced stream control support */158 unsigned use_atomic_write_boundary : 1;159};160#define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)161 162static inline struct scsi_disk *scsi_disk(struct gendisk *disk)163{164 return disk->private_data;165}166 167#define sd_printk(prefix, sdsk, fmt, a...) \168 (sdsk)->disk ? \169 sdev_prefix_printk(prefix, (sdsk)->device, \170 (sdsk)->disk->disk_name, fmt, ##a) : \171 sdev_printk(prefix, (sdsk)->device, fmt, ##a)172 173#define sd_first_printk(prefix, sdsk, fmt, a...) \174 do { \175 if ((sdsk)->first_scan) \176 sd_printk(prefix, sdsk, fmt, ##a); \177 } while (0)178 179static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)180{181 switch (scmd->cmnd[0]) {182 case READ_6:183 case READ_10:184 case READ_12:185 case READ_16:186 case SYNCHRONIZE_CACHE:187 case VERIFY:188 case VERIFY_12:189 case VERIFY_16:190 case WRITE_6:191 case WRITE_10:192 case WRITE_12:193 case WRITE_16:194 case WRITE_SAME:195 case WRITE_SAME_16:196 case UNMAP:197 return 1;198 case VARIABLE_LENGTH_CMD:199 switch (scmd->cmnd[9]) {200 case READ_32:201 case VERIFY_32:202 case WRITE_32:203 case WRITE_SAME_32:204 return 1;205 }206 }207 208 return 0;209}210 211static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)212{213 return blocks << (ilog2(sdev->sector_size) - 9);214}215 216static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)217{218 return blocks * sdev->sector_size;219}220 221static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)222{223 return bytes >> ilog2(sdev->sector_size);224}225 226static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)227{228 return sector >> (ilog2(sdev->sector_size) - 9);229}230 231void sd_dif_config_host(struct scsi_disk *sdkp, struct queue_limits *lim);232 233#ifdef CONFIG_BLK_DEV_ZONED234 235int sd_zbc_read_zones(struct scsi_disk *sdkp, struct queue_limits *lim,236 u8 buf[SD_BUF_SIZE]);237int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);238blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,239 unsigned char op, bool all);240unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,241 struct scsi_sense_hdr *sshdr);242int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,243 unsigned int nr_zones, report_zones_cb cb, void *data);244 245#else /* CONFIG_BLK_DEV_ZONED */246 247static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,248 struct queue_limits *lim, u8 buf[SD_BUF_SIZE])249{250 return 0;251}252 253static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)254{255 return 0;256}257 258static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,259 unsigned char op,260 bool all)261{262 return BLK_STS_TARGET;263}264 265static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,266 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)267{268 return good_bytes;269}270 271#define sd_zbc_report_zones NULL272 273#endif /* CONFIG_BLK_DEV_ZONED */274 275void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);276void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);277 278#endif /* _SCSI_DISK_H */279