blob: 2e5932bde43d12bbb5c26a1d147c72147751c2ea [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Martin K. Petersene73aec82007-02-27 22:40:55 -05002#ifndef _SCSI_DISK_H
3#define _SCSI_DISK_H
4
5/*
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
8 * much numberspace.
9 */
10#define SD_MAJORS 16
11
12/*
Martin K. Petersene73aec82007-02-27 22:40:55 -050013 * 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)
James Bottomley7e660102013-10-04 21:42:24 +000017/*
18 * Flush timeout is a multiplier over the standard device timeout which is
19 * user modifiable via sysfs but initially set to SD_TIMEOUT
20 */
21#define SD_FLUSH_TIMEOUT_MULTIPLIER 2
Martin K. Petersen5db44862012-09-18 12:19:32 -040022#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
Martin K. Petersene73aec82007-02-27 22:40:55 -050023
24/*
25 * Number of allowed retries
26 */
27#define SD_MAX_RETRIES 5
28#define SD_PASSTHROUGH_RETRIES 1
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -050029#define SD_MAX_MEDIUM_TIMEOUTS 2
Martin K. Petersene73aec82007-02-27 22:40:55 -050030
31/*
32 * Size of the initial data buffer for mode and read capacity data
33 */
34#define SD_BUF_SIZE 512
35
Linus Torvalds18351072008-08-05 21:42:21 -070036/*
37 * Number of sectors at the end of the device to avoid multi-sector
38 * accesses to in the case of last_sector_bug
39 */
40#define SD_LAST_BUGGY_SECTORS 8
41
Martin K. Petersen4e7392e2009-09-20 16:49:38 -040042enum {
43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
45};
46
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050047enum {
Martin K. Petersenbcdb2472014-06-03 18:45:51 -040048 SD_DEF_XFER_BLOCKS = 0xffff,
49 SD_MAX_XFER_BLOCKS = 0xffffffff,
Martin K. Petersen5db44862012-09-18 12:19:32 -040050 SD_MAX_WS10_BLOCKS = 0xffff,
51 SD_MAX_WS16_BLOCKS = 0x7fffff,
52};
53
54enum {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050055 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
Martin K. Petersene6bd9312017-04-05 19:21:24 +020063enum {
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
Martin K. Petersene73aec82007-02-27 22:40:55 -050070struct scsi_disk {
71 struct scsi_driver *driver; /* always &sd_template */
72 struct scsi_device *device;
Tony Jonesee959b02008-02-22 00:13:36 +010073 struct device dev;
Martin K. Petersene73aec82007-02-27 22:40:55 -050074 struct gendisk *disk;
Christoph Hellwigd80210f2017-06-19 14:26:46 +020075 struct opal_dev *opal_dev;
Hannes Reinecke89d94752016-10-18 15:40:34 +090076#ifdef CONFIG_BLK_DEV_ZONED
Bart Van Assche354f1132018-04-16 18:04:39 -070077 u32 nr_zones;
Damien Le Moala3d8a2572020-07-31 14:49:28 +090078 u32 rev_nr_zones;
Bart Van Assche354f1132018-04-16 18:04:39 -070079 u32 zone_blocks;
Damien Le Moala3d8a2572020-07-31 14:49:28 +090080 u32 rev_zone_blocks;
Bart Van Assche354f1132018-04-16 18:04:39 -070081 u32 zones_optimal_open;
82 u32 zones_optimal_nonseq;
83 u32 zones_max_open;
Johannes Thumshirn5795eb42020-05-12 17:55:51 +090084 u32 *zones_wp_offset;
85 spinlock_t zones_wp_offset_lock;
86 u32 *rev_wp_offset;
87 struct mutex rev_mutex;
88 struct work_struct zone_wp_offset_work;
89 char *zone_wp_update_buf;
Hannes Reinecke89d94752016-10-18 15:40:34 +090090#endif
Arnd Bergmann409f3492010-07-07 16:51:29 +020091 atomic_t openers;
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -040092 sector_t capacity; /* size in logical blocks */
Mike Christie06109592020-10-01 10:35:54 -050093 int max_retries;
Martin K. Petersenbcdb2472014-06-03 18:45:51 -040094 u32 max_xfer_blocks;
Martin K. Petersenca369d52015-11-13 16:46:48 -050095 u32 opt_xfer_blocks;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050096 u32 max_ws_blocks;
97 u32 max_unmap_blocks;
98 u32 unmap_granularity;
99 u32 unmap_alignment;
Martin K. Petersene73aec82007-02-27 22:40:55 -0500100 u32 index;
Martin K. Petersen526f7c72010-09-28 14:48:47 -0400101 unsigned int physical_block_size;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500102 unsigned int max_medium_access_timeouts;
103 unsigned int medium_access_timed_out;
Martin K. Petersene73aec82007-02-27 22:40:55 -0500104 u8 media_present;
105 u8 write_prot;
Martin K. Petersene0597d72008-07-17 04:28:34 -0400106 u8 protection_type;/* Data Integrity Field */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500107 u8 provisioning_mode;
Martin K. Petersene6bd9312017-04-05 19:21:24 +0200108 u8 zeroing_mode;
Damien Le Moale815d362021-10-27 11:22:20 +0900109 u8 nr_actuators; /* Number of actuators */
Martin K. Petersene0597d72008-07-17 04:28:34 -0400110 unsigned ATO : 1; /* state of disk ATO bit */
James Bottomley39c60a02013-04-24 14:02:53 -0700111 unsigned cache_override : 1; /* temp override of WCE,RCD */
Martin K. Petersene73aec82007-02-27 22:40:55 -0500112 unsigned WCE : 1; /* state of disk WCE bit */
113 unsigned RCD : 1; /* state of disk RCD bit, unused */
114 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
Martin K. Petersen70a9b872009-03-09 11:33:31 -0400115 unsigned first_scan : 1;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -0500116 unsigned lbpme : 1;
117 unsigned lbprz : 1;
118 unsigned lbpu : 1;
119 unsigned lbpws : 1;
120 unsigned lbpws10 : 1;
121 unsigned lbpvpd : 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -0400122 unsigned ws10 : 1;
Martin K. Petersen5db44862012-09-18 12:19:32 -0400123 unsigned ws16 : 1;
Hannes Reinecke89d94752016-10-18 15:40:34 +0900124 unsigned rc_basis: 2;
125 unsigned zoned: 2;
126 unsigned urswrz : 1;
Christoph Hellwigd80210f2017-06-19 14:26:46 +0200127 unsigned security : 1;
Hannes Reinecke7a38dc02017-04-06 15:36:29 +0200128 unsigned ignore_medium_access_errors : 1;
Martin K. Petersene73aec82007-02-27 22:40:55 -0500129};
Tony Jonesee959b02008-02-22 00:13:36 +0100130#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
Martin K. Petersene73aec82007-02-27 22:40:55 -0500131
Martin K. Petersen5b635da2008-06-25 11:22:41 -0400132static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
133{
134 return container_of(disk->private_data, struct scsi_disk, driver);
135}
136
Martin K. Petersene73aec82007-02-27 22:40:55 -0500137#define sd_printk(prefix, sdsk, fmt, a...) \
138 (sdsk)->disk ? \
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200139 sdev_prefix_printk(prefix, (sdsk)->device, \
140 (sdsk)->disk->disk_name, fmt, ##a) : \
141 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
Martin K. Petersene73aec82007-02-27 22:40:55 -0500142
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -0500143#define sd_first_printk(prefix, sdsk, fmt, a...) \
144 do { \
Dietmar Hahndf46cac2019-02-05 11:10:48 +0100145 if ((sdsk)->first_scan) \
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -0500146 sd_printk(prefix, sdsk, fmt, ##a); \
147 } while (0)
148
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500149static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
150{
151 switch (scmd->cmnd[0]) {
152 case READ_6:
153 case READ_10:
154 case READ_12:
155 case READ_16:
156 case SYNCHRONIZE_CACHE:
157 case VERIFY:
158 case VERIFY_12:
159 case VERIFY_16:
160 case WRITE_6:
161 case WRITE_10:
162 case WRITE_12:
163 case WRITE_16:
164 case WRITE_SAME:
165 case WRITE_SAME_16:
166 case UNMAP:
167 return 1;
168 case VARIABLE_LENGTH_CMD:
169 switch (scmd->cmnd[9]) {
170 case READ_32:
171 case VERIFY_32:
172 case WRITE_32:
173 case WRITE_SAME_32:
174 return 1;
175 }
176 }
177
178 return 0;
179}
180
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -0400181static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
182{
183 return blocks << (ilog2(sdev->sector_size) - 9);
184}
185
Martin K. Petersen6b7e9cd2016-05-12 22:17:34 -0400186static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
187{
188 return blocks * sdev->sector_size;
189}
190
Damien Le Moal6eadc612017-04-24 16:51:10 +0900191static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
192{
193 return bytes >> ilog2(sdev->sector_size);
194}
195
Hannes Reinecke89d94752016-10-18 15:40:34 +0900196static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
197{
198 return sector >> (ilog2(sdev->sector_size) - 9);
199}
200
James Bottomley4c393e62008-10-13 15:20:06 -0400201#ifdef CONFIG_BLK_DEV_INTEGRITY
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400202
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400203extern void sd_dif_config_host(struct scsi_disk *);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400204
205#else /* CONFIG_BLK_DEV_INTEGRITY */
206
James Bottomley4c393e62008-10-13 15:20:06 -0400207static inline void sd_dif_config_host(struct scsi_disk *disk)
208{
209}
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400210
211#endif /* CONFIG_BLK_DEV_INTEGRITY */
212
Hannes Reinecke89d94752016-10-18 15:40:34 +0900213static inline int sd_is_zoned(struct scsi_disk *sdkp)
214{
215 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
216}
217
218#ifdef CONFIG_BLK_DEV_ZONED
219
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900220void sd_zbc_release_disk(struct scsi_disk *sdkp);
Damien Le Moala3d8a2572020-07-31 14:49:28 +0900221int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
222int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
Ajay Joshiad512f22019-10-27 23:05:47 +0900223blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
224 unsigned char op, bool all);
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900225unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
226 struct scsi_sense_hdr *sshdr);
Christoph Hellwigd4100352019-11-11 11:39:30 +0900227int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
228 unsigned int nr_zones, report_zones_cb cb, void *data);
Hannes Reinecke89d94752016-10-18 15:40:34 +0900229
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900230blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
231 unsigned int nr_blocks);
232
Hannes Reinecke89d94752016-10-18 15:40:34 +0900233#else /* CONFIG_BLK_DEV_ZONED */
234
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900235static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
236
Hannes Reinecke89d94752016-10-18 15:40:34 +0900237static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
238 unsigned char *buf)
239{
240 return 0;
241}
242
Damien Le Moala3d8a2572020-07-31 14:49:28 +0900243static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
244{
245 return 0;
246}
Hannes Reinecke89d94752016-10-18 15:40:34 +0900247
Ajay Joshiad512f22019-10-27 23:05:47 +0900248static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
249 unsigned char op,
250 bool all)
Hannes Reinecke89d94752016-10-18 15:40:34 +0900251{
Christoph Hellwig159b2cb2018-11-09 14:42:39 +0100252 return BLK_STS_TARGET;
Hannes Reinecke89d94752016-10-18 15:40:34 +0900253}
254
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900255static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
256 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
257{
Damien Le Moal27ba3e82020-09-15 16:33:46 +0900258 return good_bytes;
Johannes Thumshirn5795eb42020-05-12 17:55:51 +0900259}
260
261static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
262 sector_t *lba,
263 unsigned int nr_blocks)
264{
265 return BLK_STS_TARGET;
266}
Hannes Reinecke89d94752016-10-18 15:40:34 +0900267
Christoph Hellwige76239a2018-10-12 19:08:49 +0900268#define sd_zbc_report_zones NULL
269
Hannes Reinecke89d94752016-10-18 15:40:34 +0900270#endif /* CONFIG_BLK_DEV_ZONED */
271
Damien Le Moala35989a2019-11-25 16:05:18 +0900272void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
273void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
274
Martin K. Petersene73aec82007-02-27 22:40:55 -0500275#endif /* _SCSI_DISK_H */