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
70628617beSBart Van Assche /**
71628617beSBart Van Assche * struct zoned_disk_info - Specific properties of a ZBC SCSI device.
72628617beSBart Van Assche * @nr_zones: number of zones.
73628617beSBart Van Assche * @zone_blocks: number of logical blocks per zone.
74628617beSBart Van Assche *
75628617beSBart Van Assche * This data structure holds the ZBC SCSI device properties that are retrieved
76628617beSBart Van Assche * twice: a first time before the gendisk capacity is known and a second time
77628617beSBart Van Assche * after the gendisk capacity is known.
78628617beSBart Van Assche */
79628617beSBart Van Assche struct zoned_disk_info {
80628617beSBart Van Assche u32 nr_zones;
81628617beSBart Van Assche u32 zone_blocks;
82628617beSBart Van Assche };
83628617beSBart 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
95628617beSBart Van Assche /* Updated during revalidation before the gendisk capacity is known. */
96628617beSBart Van Assche struct zoned_disk_info early_zone_info;
97628617beSBart Van Assche /* Updated during revalidation after the gendisk capacity is known. */
98628617beSBart 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;
102c976e588SDamien Le Moal /*
103c976e588SDamien Le Moal * Either zero or a power of two. If not zero it means that the offset
104c976e588SDamien Le Moal * between zone starting LBAs is constant.
105c976e588SDamien Le Moal */
106c976e588SDamien Le Moal u32 zone_starting_lba_gran;
1075795eb44SJohannes Thumshirn u32 *zones_wp_offset;
1085795eb44SJohannes Thumshirn spinlock_t zones_wp_offset_lock;
1095795eb44SJohannes Thumshirn u32 *rev_wp_offset;
1105795eb44SJohannes Thumshirn struct mutex rev_mutex;
1115795eb44SJohannes Thumshirn struct work_struct zone_wp_offset_work;
1125795eb44SJohannes Thumshirn char *zone_wp_update_buf;
11389d94756SHannes Reinecke #endif
114409f3499SArnd Bergmann atomic_t openers;
115f08bb1e0SMartin K. Petersen sector_t capacity; /* size in logical blocks */
1160610959fSMike Christie int max_retries;
117631669a2SMartin K. Petersen u32 min_xfer_blocks;
118bcdb247cSMartin K. Petersen u32 max_xfer_blocks;
119ca369d51SMartin K. Petersen u32 opt_xfer_blocks;
120c98a0eb0SMartin K. Petersen u32 max_ws_blocks;
121c98a0eb0SMartin K. Petersen u32 max_unmap_blocks;
122c98a0eb0SMartin K. Petersen u32 unmap_granularity;
123c98a0eb0SMartin K. Petersen u32 unmap_alignment;
124aa91696eSMartin K. Petersen u32 index;
125526f7c79SMartin K. Petersen unsigned int physical_block_size;
12618a4d0a2SMartin K. Petersen unsigned int max_medium_access_timeouts;
12718a4d0a2SMartin K. Petersen unsigned int medium_access_timed_out;
128aa91696eSMartin K. Petersen u8 media_present;
129aa91696eSMartin K. Petersen u8 write_prot;
130e0597d70SMartin K. Petersen u8 protection_type;/* Data Integrity Field */
131c98a0eb0SMartin K. Petersen u8 provisioning_mode;
132e6bd9312SMartin K. Petersen u8 zeroing_mode;
133e815d365SDamien Le Moal u8 nr_actuators; /* Number of actuators */
134*99398d20SDamien Le Moal bool suspended; /* Disk is suspended (stopped) */
135e0597d70SMartin K. Petersen unsigned ATO : 1; /* state of disk ATO bit */
13639c60a09SJames Bottomley unsigned cache_override : 1; /* temp override of WCE,RCD */
137aa91696eSMartin K. Petersen unsigned WCE : 1; /* state of disk WCE bit */
138aa91696eSMartin K. Petersen unsigned RCD : 1; /* state of disk RCD bit, unused */
139aa91696eSMartin K. Petersen unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
14070a9b873SMartin K. Petersen unsigned first_scan : 1;
141c98a0eb0SMartin K. Petersen unsigned lbpme : 1;
142c98a0eb0SMartin K. Petersen unsigned lbprz : 1;
143c98a0eb0SMartin K. Petersen unsigned lbpu : 1;
144c98a0eb0SMartin K. Petersen unsigned lbpws : 1;
145c98a0eb0SMartin K. Petersen unsigned lbpws10 : 1;
146c98a0eb0SMartin K. Petersen unsigned lbpvpd : 1;
14766c28f97SMartin K. Petersen unsigned ws10 : 1;
1485db44863SMartin K. Petersen unsigned ws16 : 1;
14989d94756SHannes Reinecke unsigned rc_basis: 2;
15089d94756SHannes Reinecke unsigned zoned: 2;
15189d94756SHannes Reinecke unsigned urswrz : 1;
152d80210f2SChristoph Hellwig unsigned security : 1;
1537a38dc0bSHannes Reinecke unsigned ignore_medium_access_errors : 1;
154aa91696eSMartin K. Petersen };
155fad45c30SChristoph Hellwig #define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)
156aa91696eSMartin K. Petersen
scsi_disk(struct gendisk * disk)1575b635da1SMartin K. Petersen static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
1585b635da1SMartin K. Petersen {
159e7f76552SChristoph Hellwig return disk->private_data;
1605b635da1SMartin K. Petersen }
1615b635da1SMartin K. Petersen
162aa91696eSMartin K. Petersen #define sd_printk(prefix, sdsk, fmt, a...) \
163aa91696eSMartin K. Petersen (sdsk)->disk ? \
16422e0d994SHannes Reinecke sdev_prefix_printk(prefix, (sdsk)->device, \
16522e0d994SHannes Reinecke (sdsk)->disk->disk_name, fmt, ##a) : \
166aa91696eSMartin K. Petersen sdev_printk(prefix, (sdsk)->device, fmt, ##a)
167aa91696eSMartin K. Petersen
168b2bff6ceSMartin K. Petersen #define sd_first_printk(prefix, sdsk, fmt, a...) \
169b2bff6ceSMartin K. Petersen do { \
170df46cac3SDietmar Hahn if ((sdsk)->first_scan) \
171b2bff6ceSMartin K. Petersen sd_printk(prefix, sdsk, fmt, ##a); \
172b2bff6ceSMartin K. Petersen } while (0)
173b2bff6ceSMartin K. Petersen
scsi_medium_access_command(struct scsi_cmnd * scmd)17418a4d0a2SMartin K. Petersen static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
17518a4d0a2SMartin K. Petersen {
17618a4d0a2SMartin K. Petersen switch (scmd->cmnd[0]) {
17718a4d0a2SMartin K. Petersen case READ_6:
17818a4d0a2SMartin K. Petersen case READ_10:
17918a4d0a2SMartin K. Petersen case READ_12:
18018a4d0a2SMartin K. Petersen case READ_16:
18118a4d0a2SMartin K. Petersen case SYNCHRONIZE_CACHE:
18218a4d0a2SMartin K. Petersen case VERIFY:
18318a4d0a2SMartin K. Petersen case VERIFY_12:
18418a4d0a2SMartin K. Petersen case VERIFY_16:
18518a4d0a2SMartin K. Petersen case WRITE_6:
18618a4d0a2SMartin K. Petersen case WRITE_10:
18718a4d0a2SMartin K. Petersen case WRITE_12:
18818a4d0a2SMartin K. Petersen case WRITE_16:
18918a4d0a2SMartin K. Petersen case WRITE_SAME:
19018a4d0a2SMartin K. Petersen case WRITE_SAME_16:
19118a4d0a2SMartin K. Petersen case UNMAP:
19218a4d0a2SMartin K. Petersen return 1;
19318a4d0a2SMartin K. Petersen case VARIABLE_LENGTH_CMD:
19418a4d0a2SMartin K. Petersen switch (scmd->cmnd[9]) {
19518a4d0a2SMartin K. Petersen case READ_32:
19618a4d0a2SMartin K. Petersen case VERIFY_32:
19718a4d0a2SMartin K. Petersen case WRITE_32:
19818a4d0a2SMartin K. Petersen case WRITE_SAME_32:
19918a4d0a2SMartin K. Petersen return 1;
20018a4d0a2SMartin K. Petersen }
20118a4d0a2SMartin K. Petersen }
20218a4d0a2SMartin K. Petersen
20318a4d0a2SMartin K. Petersen return 0;
20418a4d0a2SMartin K. Petersen }
20518a4d0a2SMartin K. Petersen
logical_to_sectors(struct scsi_device * sdev,sector_t blocks)206f08bb1e0SMartin K. Petersen static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
207f08bb1e0SMartin K. Petersen {
208f08bb1e0SMartin K. Petersen return blocks << (ilog2(sdev->sector_size) - 9);
209f08bb1e0SMartin K. Petersen }
210f08bb1e0SMartin K. Petersen
logical_to_bytes(struct scsi_device * sdev,sector_t blocks)2116b7e9cdeSMartin K. Petersen static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
2126b7e9cdeSMartin K. Petersen {
2136b7e9cdeSMartin K. Petersen return blocks * sdev->sector_size;
2146b7e9cdeSMartin K. Petersen }
2156b7e9cdeSMartin K. Petersen
bytes_to_logical(struct scsi_device * sdev,unsigned int bytes)2166eadc612SDamien Le Moal static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
2176eadc612SDamien Le Moal {
2186eadc612SDamien Le Moal return bytes >> ilog2(sdev->sector_size);
2196eadc612SDamien Le Moal }
2206eadc612SDamien Le Moal
sectors_to_logical(struct scsi_device * sdev,sector_t sector)22189d94756SHannes Reinecke static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
22289d94756SHannes Reinecke {
22389d94756SHannes Reinecke return sector >> (ilog2(sdev->sector_size) - 9);
22489d94756SHannes Reinecke }
22589d94756SHannes Reinecke
2264c393e6eSJames Bottomley #ifdef CONFIG_BLK_DEV_INTEGRITY
227af55ff67SMartin K. Petersen
228af55ff67SMartin K. Petersen extern void sd_dif_config_host(struct scsi_disk *);
229af55ff67SMartin K. Petersen
230af55ff67SMartin K. Petersen #else /* CONFIG_BLK_DEV_INTEGRITY */
231af55ff67SMartin K. Petersen
sd_dif_config_host(struct scsi_disk * disk)2324c393e6eSJames Bottomley static inline void sd_dif_config_host(struct scsi_disk *disk)
2334c393e6eSJames Bottomley {
2344c393e6eSJames Bottomley }
235af55ff67SMartin K. Petersen
236af55ff67SMartin K. Petersen #endif /* CONFIG_BLK_DEV_INTEGRITY */
237af55ff67SMartin K. Petersen
sd_is_zoned(struct scsi_disk * sdkp)23889d94756SHannes Reinecke static inline int sd_is_zoned(struct scsi_disk *sdkp)
23989d94756SHannes Reinecke {
24089d94756SHannes Reinecke return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
24189d94756SHannes Reinecke }
24289d94756SHannes Reinecke
24389d94756SHannes Reinecke #ifdef CONFIG_BLK_DEV_ZONED
24489d94756SHannes Reinecke
24530c4fdc3SDamien Le Moal void sd_zbc_free_zone_info(struct scsi_disk *sdkp);
246aa96bfb4SBart Van Assche int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE]);
247a3d8a257SDamien Le Moal int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
248ad512f20SAjay Joshi blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
249ad512f20SAjay Joshi unsigned char op, bool all);
2505795eb44SJohannes Thumshirn unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
25189d94756SHannes Reinecke struct scsi_sense_hdr *sshdr);
252d4100351SChristoph Hellwig int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
253d4100351SChristoph Hellwig unsigned int nr_zones, report_zones_cb cb, void *data);
25489d94756SHannes Reinecke
2555795eb44SJohannes Thumshirn blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
2565795eb44SJohannes Thumshirn unsigned int nr_blocks);
2575795eb44SJohannes Thumshirn
25889d94756SHannes Reinecke #else /* CONFIG_BLK_DEV_ZONED */
25989d94756SHannes Reinecke
sd_zbc_free_zone_info(struct scsi_disk * sdkp)26030c4fdc3SDamien Le Moal static inline void sd_zbc_free_zone_info(struct scsi_disk *sdkp) {}
2615795eb44SJohannes Thumshirn
sd_zbc_read_zones(struct scsi_disk * sdkp,u8 buf[SD_BUF_SIZE])262aa96bfb4SBart Van Assche static inline int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE])
26389d94756SHannes Reinecke {
26489d94756SHannes Reinecke return 0;
26589d94756SHannes Reinecke }
26689d94756SHannes Reinecke
sd_zbc_revalidate_zones(struct scsi_disk * sdkp)267a3d8a257SDamien Le Moal static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
268a3d8a257SDamien Le Moal {
269a3d8a257SDamien Le Moal return 0;
270a3d8a257SDamien Le Moal }
27189d94756SHannes Reinecke
sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd * cmd,unsigned char op,bool all)272ad512f20SAjay Joshi static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
273ad512f20SAjay Joshi unsigned char op,
274d81e9d49SChaitanya Kulkarni bool all)
27589d94756SHannes Reinecke {
276159b2cbfSChristoph Hellwig return BLK_STS_TARGET;
27789d94756SHannes Reinecke }
27889d94756SHannes Reinecke
sd_zbc_complete(struct scsi_cmnd * cmd,unsigned int good_bytes,struct scsi_sense_hdr * sshdr)2795795eb44SJohannes Thumshirn static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
2805795eb44SJohannes Thumshirn unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
2815795eb44SJohannes Thumshirn {
28227ba3e8fSDamien Le Moal return good_bytes;
2835795eb44SJohannes Thumshirn }
2845795eb44SJohannes Thumshirn
sd_zbc_prepare_zone_append(struct scsi_cmnd * cmd,sector_t * lba,unsigned int nr_blocks)2855795eb44SJohannes Thumshirn static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
2865795eb44SJohannes Thumshirn sector_t *lba,
2875795eb44SJohannes Thumshirn unsigned int nr_blocks)
2885795eb44SJohannes Thumshirn {
2895795eb44SJohannes Thumshirn return BLK_STS_TARGET;
2905795eb44SJohannes Thumshirn }
29189d94756SHannes Reinecke
292e76239a3SChristoph Hellwig #define sd_zbc_report_zones NULL
293e76239a3SChristoph Hellwig
29489d94756SHannes Reinecke #endif /* CONFIG_BLK_DEV_ZONED */
29589d94756SHannes Reinecke
296a35989a0SDamien Le Moal void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
297a35989a0SDamien Le Moal void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
298a35989a0SDamien Le Moal
299aa91696eSMartin K. Petersen #endif /* _SCSI_DISK_H */
300