1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 2aa91696eSMartin K. Petersen #ifndef _SCSI_DISK_H 3aa91696eSMartin K. Petersen #define _SCSI_DISK_H 4aa91696eSMartin K. Petersen 5aa91696eSMartin K. Petersen /* 6aa91696eSMartin K. Petersen * More than enough for everybody ;) The huge number of majors 7aa91696eSMartin K. Petersen * is a leftover from 16bit dev_t days, we don't really need that 8aa91696eSMartin K. Petersen * much numberspace. 9aa91696eSMartin K. Petersen */ 10aa91696eSMartin K. Petersen #define SD_MAJORS 16 11aa91696eSMartin K. Petersen 12aa91696eSMartin K. Petersen /* 13aa91696eSMartin K. Petersen * Time out in seconds for disks and Magneto-opticals (which are slower). 14aa91696eSMartin K. Petersen */ 15aa91696eSMartin K. Petersen #define SD_TIMEOUT (30 * HZ) 16aa91696eSMartin K. Petersen #define SD_MOD_TIMEOUT (75 * HZ) 177e660100SJames Bottomley /* 187e660100SJames Bottomley * Flush timeout is a multiplier over the standard device timeout which is 197e660100SJames Bottomley * user modifiable via sysfs but initially set to SD_TIMEOUT 207e660100SJames Bottomley */ 217e660100SJames Bottomley #define SD_FLUSH_TIMEOUT_MULTIPLIER 2 225db44863SMartin K. Petersen #define SD_WRITE_SAME_TIMEOUT (120 * HZ) 23aa91696eSMartin K. Petersen 24aa91696eSMartin K. Petersen /* 25aa91696eSMartin K. Petersen * Number of allowed retries 26aa91696eSMartin K. Petersen */ 27aa91696eSMartin K. Petersen #define SD_MAX_RETRIES 5 28aa91696eSMartin K. Petersen #define SD_PASSTHROUGH_RETRIES 1 2918a4d0a2SMartin K. Petersen #define SD_MAX_MEDIUM_TIMEOUTS 2 30aa91696eSMartin K. Petersen 31aa91696eSMartin K. Petersen /* 32aa91696eSMartin K. Petersen * Size of the initial data buffer for mode and read capacity data 33aa91696eSMartin K. Petersen */ 34aa91696eSMartin K. Petersen #define SD_BUF_SIZE 512 35aa91696eSMartin K. Petersen 3618351070SLinus Torvalds /* 3718351070SLinus Torvalds * Number of sectors at the end of the device to avoid multi-sector 3818351070SLinus Torvalds * accesses to in the case of last_sector_bug 3918351070SLinus Torvalds */ 4018351070SLinus Torvalds #define SD_LAST_BUGGY_SECTORS 8 4118351070SLinus Torvalds 424e7392ecSMartin K. Petersen enum { 434e7392ecSMartin K. Petersen SD_EXT_CDB_SIZE = 32, /* Extended CDB size */ 444e7392ecSMartin K. Petersen SD_MEMPOOL_SIZE = 2, /* CDB pool size */ 454e7392ecSMartin K. Petersen }; 464e7392ecSMartin K. Petersen 47c98a0eb0SMartin K. Petersen enum { 48bcdb247cSMartin K. Petersen SD_DEF_XFER_BLOCKS = 0xffff, 49bcdb247cSMartin K. Petersen SD_MAX_XFER_BLOCKS = 0xffffffff, 505db44863SMartin K. Petersen SD_MAX_WS10_BLOCKS = 0xffff, 515db44863SMartin K. Petersen SD_MAX_WS16_BLOCKS = 0x7fffff, 525db44863SMartin K. Petersen }; 535db44863SMartin K. Petersen 545db44863SMartin K. Petersen enum { 55c98a0eb0SMartin K. Petersen SD_LBP_FULL = 0, /* Full logical block provisioning */ 56c98a0eb0SMartin K. Petersen SD_LBP_UNMAP, /* Use UNMAP command */ 57c98a0eb0SMartin K. Petersen SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */ 58c98a0eb0SMartin K. Petersen SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */ 59c98a0eb0SMartin K. Petersen SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */ 60c98a0eb0SMartin K. Petersen SD_LBP_DISABLE, /* Discard disabled due to failed cmd */ 61c98a0eb0SMartin K. Petersen }; 62c98a0eb0SMartin K. Petersen 63e6bd9312SMartin K. Petersen enum { 64e6bd9312SMartin K. Petersen SD_ZERO_WRITE = 0, /* Use WRITE(10/16) command */ 65e6bd9312SMartin K. Petersen SD_ZERO_WS, /* Use WRITE SAME(10/16) command */ 66e6bd9312SMartin K. Petersen SD_ZERO_WS16_UNMAP, /* Use WRITE SAME(16) with UNMAP */ 67e6bd9312SMartin K. Petersen SD_ZERO_WS10_UNMAP, /* Use WRITE SAME(10) with UNMAP */ 68e6bd9312SMartin K. Petersen }; 69e6bd9312SMartin K. Petersen 70*628617beSBart Van Assche /** 71*628617beSBart Van Assche * struct zoned_disk_info - Specific properties of a ZBC SCSI device. 72*628617beSBart Van Assche * @nr_zones: number of zones. 73*628617beSBart Van Assche * @zone_blocks: number of logical blocks per zone. 74*628617beSBart Van Assche * 75*628617beSBart Van Assche * This data structure holds the ZBC SCSI device properties that are retrieved 76*628617beSBart Van Assche * twice: a first time before the gendisk capacity is known and a second time 77*628617beSBart Van Assche * after the gendisk capacity is known. 78*628617beSBart Van Assche */ 79*628617beSBart Van Assche struct zoned_disk_info { 80*628617beSBart Van Assche u32 nr_zones; 81*628617beSBart Van Assche u32 zone_blocks; 82*628617beSBart Van Assche }; 83*628617beSBart Van Assche 84aa91696eSMartin K. Petersen struct scsi_disk { 85aa91696eSMartin K. Petersen struct scsi_device *device; 86fad45c30SChristoph Hellwig 87fad45c30SChristoph Hellwig /* 88fad45c30SChristoph Hellwig * disk_dev is used to show attributes in /sys/class/scsi_disk/, 89fad45c30SChristoph Hellwig * but otherwise not really needed. Do not use for refcounting. 90fad45c30SChristoph Hellwig */ 91fad45c30SChristoph Hellwig struct device disk_dev; 92aa91696eSMartin K. Petersen struct gendisk *disk; 93d80210f2SChristoph Hellwig struct opal_dev *opal_dev; 9489d94756SHannes Reinecke #ifdef CONFIG_BLK_DEV_ZONED 95*628617beSBart Van Assche /* Updated during revalidation before the gendisk capacity is known. */ 96*628617beSBart Van Assche struct zoned_disk_info early_zone_info; 97*628617beSBart Van Assche /* Updated during revalidation after the gendisk capacity is known. */ 98*628617beSBart Van Assche struct zoned_disk_info zone_info; 99354f1132SBart Van Assche u32 zones_optimal_open; 100354f1132SBart Van Assche u32 zones_optimal_nonseq; 101354f1132SBart Van Assche u32 zones_max_open; 1025795eb44SJohannes Thumshirn u32 *zones_wp_offset; 1035795eb44SJohannes Thumshirn spinlock_t zones_wp_offset_lock; 1045795eb44SJohannes Thumshirn u32 *rev_wp_offset; 1055795eb44SJohannes Thumshirn struct mutex rev_mutex; 1065795eb44SJohannes Thumshirn struct work_struct zone_wp_offset_work; 1075795eb44SJohannes Thumshirn char *zone_wp_update_buf; 10889d94756SHannes Reinecke #endif 109409f3499SArnd Bergmann atomic_t openers; 110f08bb1e0SMartin K. Petersen sector_t capacity; /* size in logical blocks */ 1110610959fSMike Christie int max_retries; 112bcdb247cSMartin K. Petersen u32 max_xfer_blocks; 113ca369d51SMartin K. Petersen u32 opt_xfer_blocks; 114c98a0eb0SMartin K. Petersen u32 max_ws_blocks; 115c98a0eb0SMartin K. Petersen u32 max_unmap_blocks; 116c98a0eb0SMartin K. Petersen u32 unmap_granularity; 117c98a0eb0SMartin K. Petersen u32 unmap_alignment; 118aa91696eSMartin K. Petersen u32 index; 119526f7c79SMartin K. Petersen unsigned int physical_block_size; 12018a4d0a2SMartin K. Petersen unsigned int max_medium_access_timeouts; 12118a4d0a2SMartin K. Petersen unsigned int medium_access_timed_out; 122aa91696eSMartin K. Petersen u8 media_present; 123aa91696eSMartin K. Petersen u8 write_prot; 124e0597d70SMartin K. Petersen u8 protection_type;/* Data Integrity Field */ 125c98a0eb0SMartin K. Petersen u8 provisioning_mode; 126e6bd9312SMartin K. Petersen u8 zeroing_mode; 127e815d365SDamien Le Moal u8 nr_actuators; /* Number of actuators */ 128e0597d70SMartin K. Petersen unsigned ATO : 1; /* state of disk ATO bit */ 12939c60a09SJames Bottomley unsigned cache_override : 1; /* temp override of WCE,RCD */ 130aa91696eSMartin K. Petersen unsigned WCE : 1; /* state of disk WCE bit */ 131aa91696eSMartin K. Petersen unsigned RCD : 1; /* state of disk RCD bit, unused */ 132aa91696eSMartin K. Petersen unsigned DPOFUA : 1; /* state of disk DPOFUA bit */ 13370a9b873SMartin K. Petersen unsigned first_scan : 1; 134c98a0eb0SMartin K. Petersen unsigned lbpme : 1; 135c98a0eb0SMartin K. Petersen unsigned lbprz : 1; 136c98a0eb0SMartin K. Petersen unsigned lbpu : 1; 137c98a0eb0SMartin K. Petersen unsigned lbpws : 1; 138c98a0eb0SMartin K. Petersen unsigned lbpws10 : 1; 139c98a0eb0SMartin K. Petersen unsigned lbpvpd : 1; 14066c28f97SMartin K. Petersen unsigned ws10 : 1; 1415db44863SMartin K. Petersen unsigned ws16 : 1; 14289d94756SHannes Reinecke unsigned rc_basis: 2; 14389d94756SHannes Reinecke unsigned zoned: 2; 14489d94756SHannes Reinecke unsigned urswrz : 1; 145d80210f2SChristoph Hellwig unsigned security : 1; 1467a38dc0bSHannes Reinecke unsigned ignore_medium_access_errors : 1; 147aa91696eSMartin K. Petersen }; 148fad45c30SChristoph Hellwig #define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev) 149aa91696eSMartin K. Petersen 1505b635da1SMartin K. Petersen static inline struct scsi_disk *scsi_disk(struct gendisk *disk) 1515b635da1SMartin K. Petersen { 152e7f76552SChristoph Hellwig return disk->private_data; 1535b635da1SMartin K. Petersen } 1545b635da1SMartin K. Petersen 155aa91696eSMartin K. Petersen #define sd_printk(prefix, sdsk, fmt, a...) \ 156aa91696eSMartin K. Petersen (sdsk)->disk ? \ 15722e0d994SHannes Reinecke sdev_prefix_printk(prefix, (sdsk)->device, \ 15822e0d994SHannes Reinecke (sdsk)->disk->disk_name, fmt, ##a) : \ 159aa91696eSMartin K. Petersen sdev_printk(prefix, (sdsk)->device, fmt, ##a) 160aa91696eSMartin K. Petersen 161b2bff6ceSMartin K. Petersen #define sd_first_printk(prefix, sdsk, fmt, a...) \ 162b2bff6ceSMartin K. Petersen do { \ 163df46cac3SDietmar Hahn if ((sdsk)->first_scan) \ 164b2bff6ceSMartin K. Petersen sd_printk(prefix, sdsk, fmt, ##a); \ 165b2bff6ceSMartin K. Petersen } while (0) 166b2bff6ceSMartin K. Petersen 16718a4d0a2SMartin K. Petersen static inline int scsi_medium_access_command(struct scsi_cmnd *scmd) 16818a4d0a2SMartin K. Petersen { 16918a4d0a2SMartin K. Petersen switch (scmd->cmnd[0]) { 17018a4d0a2SMartin K. Petersen case READ_6: 17118a4d0a2SMartin K. Petersen case READ_10: 17218a4d0a2SMartin K. Petersen case READ_12: 17318a4d0a2SMartin K. Petersen case READ_16: 17418a4d0a2SMartin K. Petersen case SYNCHRONIZE_CACHE: 17518a4d0a2SMartin K. Petersen case VERIFY: 17618a4d0a2SMartin K. Petersen case VERIFY_12: 17718a4d0a2SMartin K. Petersen case VERIFY_16: 17818a4d0a2SMartin K. Petersen case WRITE_6: 17918a4d0a2SMartin K. Petersen case WRITE_10: 18018a4d0a2SMartin K. Petersen case WRITE_12: 18118a4d0a2SMartin K. Petersen case WRITE_16: 18218a4d0a2SMartin K. Petersen case WRITE_SAME: 18318a4d0a2SMartin K. Petersen case WRITE_SAME_16: 18418a4d0a2SMartin K. Petersen case UNMAP: 18518a4d0a2SMartin K. Petersen return 1; 18618a4d0a2SMartin K. Petersen case VARIABLE_LENGTH_CMD: 18718a4d0a2SMartin K. Petersen switch (scmd->cmnd[9]) { 18818a4d0a2SMartin K. Petersen case READ_32: 18918a4d0a2SMartin K. Petersen case VERIFY_32: 19018a4d0a2SMartin K. Petersen case WRITE_32: 19118a4d0a2SMartin K. Petersen case WRITE_SAME_32: 19218a4d0a2SMartin K. Petersen return 1; 19318a4d0a2SMartin K. Petersen } 19418a4d0a2SMartin K. Petersen } 19518a4d0a2SMartin K. Petersen 19618a4d0a2SMartin K. Petersen return 0; 19718a4d0a2SMartin K. Petersen } 19818a4d0a2SMartin K. Petersen 199f08bb1e0SMartin K. Petersen static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks) 200f08bb1e0SMartin K. Petersen { 201f08bb1e0SMartin K. Petersen return blocks << (ilog2(sdev->sector_size) - 9); 202f08bb1e0SMartin K. Petersen } 203f08bb1e0SMartin K. Petersen 2046b7e9cdeSMartin K. Petersen static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks) 2056b7e9cdeSMartin K. Petersen { 2066b7e9cdeSMartin K. Petersen return blocks * sdev->sector_size; 2076b7e9cdeSMartin K. Petersen } 2086b7e9cdeSMartin K. Petersen 2096eadc612SDamien Le Moal static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes) 2106eadc612SDamien Le Moal { 2116eadc612SDamien Le Moal return bytes >> ilog2(sdev->sector_size); 2126eadc612SDamien Le Moal } 2136eadc612SDamien Le Moal 21489d94756SHannes Reinecke static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector) 21589d94756SHannes Reinecke { 21689d94756SHannes Reinecke return sector >> (ilog2(sdev->sector_size) - 9); 21789d94756SHannes Reinecke } 21889d94756SHannes Reinecke 2194c393e6eSJames Bottomley #ifdef CONFIG_BLK_DEV_INTEGRITY 220af55ff67SMartin K. Petersen 221af55ff67SMartin K. Petersen extern void sd_dif_config_host(struct scsi_disk *); 222af55ff67SMartin K. Petersen 223af55ff67SMartin K. Petersen #else /* CONFIG_BLK_DEV_INTEGRITY */ 224af55ff67SMartin K. Petersen 2254c393e6eSJames Bottomley static inline void sd_dif_config_host(struct scsi_disk *disk) 2264c393e6eSJames Bottomley { 2274c393e6eSJames Bottomley } 228af55ff67SMartin K. Petersen 229af55ff67SMartin K. Petersen #endif /* CONFIG_BLK_DEV_INTEGRITY */ 230af55ff67SMartin K. Petersen 23189d94756SHannes Reinecke static inline int sd_is_zoned(struct scsi_disk *sdkp) 23289d94756SHannes Reinecke { 23389d94756SHannes Reinecke return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC; 23489d94756SHannes Reinecke } 23589d94756SHannes Reinecke 23689d94756SHannes Reinecke #ifdef CONFIG_BLK_DEV_ZONED 23789d94756SHannes Reinecke 2385795eb44SJohannes Thumshirn void sd_zbc_release_disk(struct scsi_disk *sdkp); 239aa96bfb4SBart Van Assche int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE]); 240a3d8a257SDamien Le Moal int sd_zbc_revalidate_zones(struct scsi_disk *sdkp); 241ad512f20SAjay Joshi blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd, 242ad512f20SAjay Joshi unsigned char op, bool all); 2435795eb44SJohannes Thumshirn unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes, 24489d94756SHannes Reinecke struct scsi_sense_hdr *sshdr); 245d4100351SChristoph Hellwig int sd_zbc_report_zones(struct gendisk *disk, sector_t sector, 246d4100351SChristoph Hellwig unsigned int nr_zones, report_zones_cb cb, void *data); 24789d94756SHannes Reinecke 2485795eb44SJohannes Thumshirn blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba, 2495795eb44SJohannes Thumshirn unsigned int nr_blocks); 2505795eb44SJohannes Thumshirn 25189d94756SHannes Reinecke #else /* CONFIG_BLK_DEV_ZONED */ 25289d94756SHannes Reinecke 2535795eb44SJohannes Thumshirn static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {} 2545795eb44SJohannes Thumshirn 255aa96bfb4SBart Van Assche static inline int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE]) 25689d94756SHannes Reinecke { 25789d94756SHannes Reinecke return 0; 25889d94756SHannes Reinecke } 25989d94756SHannes Reinecke 260a3d8a257SDamien Le Moal static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp) 261a3d8a257SDamien Le Moal { 262a3d8a257SDamien Le Moal return 0; 263a3d8a257SDamien Le Moal } 26489d94756SHannes Reinecke 265ad512f20SAjay Joshi static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd, 266ad512f20SAjay Joshi unsigned char op, 267d81e9d49SChaitanya Kulkarni bool all) 26889d94756SHannes Reinecke { 269159b2cbfSChristoph Hellwig return BLK_STS_TARGET; 27089d94756SHannes Reinecke } 27189d94756SHannes Reinecke 2725795eb44SJohannes Thumshirn static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, 2735795eb44SJohannes Thumshirn unsigned int good_bytes, struct scsi_sense_hdr *sshdr) 2745795eb44SJohannes Thumshirn { 27527ba3e8fSDamien Le Moal return good_bytes; 2765795eb44SJohannes Thumshirn } 2775795eb44SJohannes Thumshirn 2785795eb44SJohannes Thumshirn static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, 2795795eb44SJohannes Thumshirn sector_t *lba, 2805795eb44SJohannes Thumshirn unsigned int nr_blocks) 2815795eb44SJohannes Thumshirn { 2825795eb44SJohannes Thumshirn return BLK_STS_TARGET; 2835795eb44SJohannes Thumshirn } 28489d94756SHannes Reinecke 285e76239a3SChristoph Hellwig #define sd_zbc_report_zones NULL 286e76239a3SChristoph Hellwig 28789d94756SHannes Reinecke #endif /* CONFIG_BLK_DEV_ZONED */ 28889d94756SHannes Reinecke 289a35989a0SDamien Le Moal void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr); 290a35989a0SDamien Le Moal void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result); 291a35989a0SDamien Le Moal 292aa91696eSMartin K. Petersen #endif /* _SCSI_DISK_H */ 293