1 /* SPDX-License-Identifier: GPL-2.0 */
2 #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 /*
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 is
19 * user modifiable via sysfs but initially set to SD_TIMEOUT
20 */
21 #define SD_FLUSH_TIMEOUT_MULTIPLIER 2
22 #define SD_WRITE_SAME_TIMEOUT (120 * HZ)
23
24 /*
25 * Number of allowed retries
26 */
27 #define SD_MAX_RETRIES 5
28 #define SD_PASSTHROUGH_RETRIES 1
29 #define SD_MAX_MEDIUM_TIMEOUTS 2
30
31 /*
32 * Size of the initial data buffer for mode and read capacity data
33 */
34 #define SD_BUF_SIZE 512
35
36 /*
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
42 enum {
43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
45 };
46
47 enum {
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
54 enum {
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
63 enum {
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 struct scsi_disk {
71 struct scsi_driver *driver; /* always &sd_template */
72 struct scsi_device *device;
73 struct device dev;
74 struct gendisk *disk;
75 struct opal_dev *opal_dev;
76 #ifdef CONFIG_BLK_DEV_ZONED
77 u32 nr_zones;
78 u32 rev_nr_zones;
79 u32 zone_blocks;
80 u32 rev_zone_blocks;
81 u32 zones_optimal_open;
82 u32 zones_optimal_nonseq;
83 u32 zones_max_open;
84 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;
90 #endif
91 atomic_t openers;
92 sector_t capacity; /* size in logical blocks */
93 int max_retries;
94 u32 max_xfer_blocks;
95 u32 opt_xfer_blocks;
96 u32 max_ws_blocks;
97 u32 max_unmap_blocks;
98 u32 unmap_granularity;
99 u32 unmap_alignment;
100 u32 index;
101 unsigned int physical_block_size;
102 unsigned int max_medium_access_timeouts;
103 unsigned int medium_access_timed_out;
104 u8 media_present;
105 u8 write_prot;
106 u8 protection_type;/* Data Integrity Field */
107 u8 provisioning_mode;
108 u8 zeroing_mode;
109 unsigned ATO : 1; /* state of disk ATO bit */
110 unsigned cache_override : 1; /* temp override of WCE,RCD */
111 unsigned WCE : 1; /* state of disk WCE bit */
112 unsigned RCD : 1; /* state of disk RCD bit, unused */
113 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
114 unsigned first_scan : 1;
115 unsigned lbpme : 1;
116 unsigned lbprz : 1;
117 unsigned lbpu : 1;
118 unsigned lbpws : 1;
119 unsigned lbpws10 : 1;
120 unsigned lbpvpd : 1;
121 unsigned ws10 : 1;
122 unsigned ws16 : 1;
123 unsigned rc_basis: 2;
124 unsigned zoned: 2;
125 unsigned urswrz : 1;
126 unsigned security : 1;
127 unsigned ignore_medium_access_errors : 1;
128 };
129 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
130
scsi_disk(struct gendisk * disk)131 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
132 {
133 return container_of(disk->private_data, struct scsi_disk, driver);
134 }
135
136 #define sd_printk(prefix, sdsk, fmt, a...) \
137 (sdsk)->disk ? \
138 sdev_prefix_printk(prefix, (sdsk)->device, \
139 (sdsk)->disk->disk_name, fmt, ##a) : \
140 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
141
142 #define sd_first_printk(prefix, sdsk, fmt, a...) \
143 do { \
144 if ((sdsk)->first_scan) \
145 sd_printk(prefix, sdsk, fmt, ##a); \
146 } while (0)
147
scsi_medium_access_command(struct scsi_cmnd * scmd)148 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
149 {
150 switch (scmd->cmnd[0]) {
151 case READ_6:
152 case READ_10:
153 case READ_12:
154 case READ_16:
155 case SYNCHRONIZE_CACHE:
156 case VERIFY:
157 case VERIFY_12:
158 case VERIFY_16:
159 case WRITE_6:
160 case WRITE_10:
161 case WRITE_12:
162 case WRITE_16:
163 case WRITE_SAME:
164 case WRITE_SAME_16:
165 case UNMAP:
166 return 1;
167 case VARIABLE_LENGTH_CMD:
168 switch (scmd->cmnd[9]) {
169 case READ_32:
170 case VERIFY_32:
171 case WRITE_32:
172 case WRITE_SAME_32:
173 return 1;
174 }
175 }
176
177 return 0;
178 }
179
logical_to_sectors(struct scsi_device * sdev,sector_t blocks)180 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
181 {
182 return blocks << (ilog2(sdev->sector_size) - 9);
183 }
184
logical_to_bytes(struct scsi_device * sdev,sector_t blocks)185 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
186 {
187 return blocks * sdev->sector_size;
188 }
189
bytes_to_logical(struct scsi_device * sdev,unsigned int bytes)190 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
191 {
192 return bytes >> ilog2(sdev->sector_size);
193 }
194
sectors_to_logical(struct scsi_device * sdev,sector_t sector)195 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
196 {
197 return sector >> (ilog2(sdev->sector_size) - 9);
198 }
199
200 #ifdef CONFIG_BLK_DEV_INTEGRITY
201
202 extern void sd_dif_config_host(struct scsi_disk *);
203
204 #else /* CONFIG_BLK_DEV_INTEGRITY */
205
sd_dif_config_host(struct scsi_disk * disk)206 static inline void sd_dif_config_host(struct scsi_disk *disk)
207 {
208 }
209
210 #endif /* CONFIG_BLK_DEV_INTEGRITY */
211
sd_is_zoned(struct scsi_disk * sdkp)212 static inline int sd_is_zoned(struct scsi_disk *sdkp)
213 {
214 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
215 }
216
217 #ifdef CONFIG_BLK_DEV_ZONED
218
219 void sd_zbc_release_disk(struct scsi_disk *sdkp);
220 int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
221 int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
222 blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
223 unsigned char op, bool all);
224 unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
225 struct scsi_sense_hdr *sshdr);
226 int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
227 unsigned int nr_zones, report_zones_cb cb, void *data);
228
229 blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
230 unsigned int nr_blocks);
231
232 #else /* CONFIG_BLK_DEV_ZONED */
233
sd_zbc_release_disk(struct scsi_disk * sdkp)234 static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
235
sd_zbc_read_zones(struct scsi_disk * sdkp,unsigned char * buf)236 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
237 unsigned char *buf)
238 {
239 return 0;
240 }
241
sd_zbc_revalidate_zones(struct scsi_disk * sdkp)242 static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
243 {
244 return 0;
245 }
246
sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd * cmd,unsigned char op,bool all)247 static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
248 unsigned char op,
249 bool all)
250 {
251 return BLK_STS_TARGET;
252 }
253
sd_zbc_complete(struct scsi_cmnd * cmd,unsigned int good_bytes,struct scsi_sense_hdr * sshdr)254 static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
255 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
256 {
257 return good_bytes;
258 }
259
sd_zbc_prepare_zone_append(struct scsi_cmnd * cmd,sector_t * lba,unsigned int nr_blocks)260 static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
261 sector_t *lba,
262 unsigned int nr_blocks)
263 {
264 return BLK_STS_TARGET;
265 }
266
267 #define sd_zbc_report_zones NULL
268
269 #endif /* CONFIG_BLK_DEV_ZONED */
270
271 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
272 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
273
274 #endif /* _SCSI_DISK_H */
275