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 ANDROID_KABI_RESERVE(1);
130 ANDROID_KABI_RESERVE(2);
131 };
132 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
133
scsi_disk(struct gendisk * disk)134 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
135 {
136 return container_of(disk->private_data, struct scsi_disk, driver);
137 }
138
139 #define sd_printk(prefix, sdsk, fmt, a...) \
140 (sdsk)->disk ? \
141 sdev_prefix_printk(prefix, (sdsk)->device, \
142 (sdsk)->disk->disk_name, fmt, ##a) : \
143 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
144
145 #define sd_first_printk(prefix, sdsk, fmt, a...) \
146 do { \
147 if ((sdsk)->first_scan) \
148 sd_printk(prefix, sdsk, fmt, ##a); \
149 } while (0)
150
scsi_medium_access_command(struct scsi_cmnd * scmd)151 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
152 {
153 switch (scmd->cmnd[0]) {
154 case READ_6:
155 case READ_10:
156 case READ_12:
157 case READ_16:
158 case SYNCHRONIZE_CACHE:
159 case VERIFY:
160 case VERIFY_12:
161 case VERIFY_16:
162 case WRITE_6:
163 case WRITE_10:
164 case WRITE_12:
165 case WRITE_16:
166 case WRITE_SAME:
167 case WRITE_SAME_16:
168 case UNMAP:
169 return 1;
170 case VARIABLE_LENGTH_CMD:
171 switch (scmd->cmnd[9]) {
172 case READ_32:
173 case VERIFY_32:
174 case WRITE_32:
175 case WRITE_SAME_32:
176 return 1;
177 }
178 }
179
180 return 0;
181 }
182
logical_to_sectors(struct scsi_device * sdev,sector_t blocks)183 static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
184 {
185 return blocks << (ilog2(sdev->sector_size) - 9);
186 }
187
logical_to_bytes(struct scsi_device * sdev,sector_t blocks)188 static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
189 {
190 return blocks * sdev->sector_size;
191 }
192
bytes_to_logical(struct scsi_device * sdev,unsigned int bytes)193 static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
194 {
195 return bytes >> ilog2(sdev->sector_size);
196 }
197
sectors_to_logical(struct scsi_device * sdev,sector_t sector)198 static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
199 {
200 return sector >> (ilog2(sdev->sector_size) - 9);
201 }
202
203 #ifdef CONFIG_BLK_DEV_INTEGRITY
204
205 extern void sd_dif_config_host(struct scsi_disk *);
206
207 #else /* CONFIG_BLK_DEV_INTEGRITY */
208
sd_dif_config_host(struct scsi_disk * disk)209 static inline void sd_dif_config_host(struct scsi_disk *disk)
210 {
211 }
212
213 #endif /* CONFIG_BLK_DEV_INTEGRITY */
214
sd_is_zoned(struct scsi_disk * sdkp)215 static inline int sd_is_zoned(struct scsi_disk *sdkp)
216 {
217 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
218 }
219
220 #ifdef CONFIG_BLK_DEV_ZONED
221
222 void sd_zbc_release_disk(struct scsi_disk *sdkp);
223 int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
224 int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
225 blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
226 unsigned char op, bool all);
227 unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
228 struct scsi_sense_hdr *sshdr);
229 int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
230 unsigned int nr_zones, report_zones_cb cb, void *data);
231
232 blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
233 unsigned int nr_blocks);
234
235 #else /* CONFIG_BLK_DEV_ZONED */
236
sd_zbc_release_disk(struct scsi_disk * sdkp)237 static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
238
sd_zbc_read_zones(struct scsi_disk * sdkp,unsigned char * buf)239 static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
240 unsigned char *buf)
241 {
242 return 0;
243 }
244
sd_zbc_revalidate_zones(struct scsi_disk * sdkp)245 static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
246 {
247 return 0;
248 }
249
sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd * cmd,unsigned char op,bool all)250 static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
251 unsigned char op,
252 bool all)
253 {
254 return BLK_STS_TARGET;
255 }
256
sd_zbc_complete(struct scsi_cmnd * cmd,unsigned int good_bytes,struct scsi_sense_hdr * sshdr)257 static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
258 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
259 {
260 return good_bytes;
261 }
262
sd_zbc_prepare_zone_append(struct scsi_cmnd * cmd,sector_t * lba,unsigned int nr_blocks)263 static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
264 sector_t *lba,
265 unsigned int nr_blocks)
266 {
267 return BLK_STS_TARGET;
268 }
269
270 #define sd_zbc_report_zones NULL
271
272 #endif /* CONFIG_BLK_DEV_ZONED */
273
274 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
275 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
276
277 #endif /* _SCSI_DISK_H */
278