Merge tag 'pci-v4.12-fixes-1' of git://git.kernel.org/pub/scm/linux/kernel/git/helgaa...
[GitHub/LineageOS/android_kernel_motorola_exynos9610.git] / drivers / scsi / sd.h
CommitLineData
e73aec82
MP
1#ifndef _SCSI_DISK_H
2#define _SCSI_DISK_H
3
4/*
5 * More than enough for everybody ;) The huge number of majors
6 * is a leftover from 16bit dev_t days, we don't really need that
7 * much numberspace.
8 */
9#define SD_MAJORS 16
10
e73aec82
MP
11/*
12 * Time out in seconds for disks and Magneto-opticals (which are slower).
13 */
14#define SD_TIMEOUT (30 * HZ)
15#define SD_MOD_TIMEOUT (75 * HZ)
7e660100
JB
16/*
17 * Flush timeout is a multiplier over the standard device timeout which is
18 * user modifiable via sysfs but initially set to SD_TIMEOUT
19 */
20#define SD_FLUSH_TIMEOUT_MULTIPLIER 2
5db44863 21#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
e73aec82
MP
22
23/*
24 * Number of allowed retries
25 */
26#define SD_MAX_RETRIES 5
27#define SD_PASSTHROUGH_RETRIES 1
18a4d0a2 28#define SD_MAX_MEDIUM_TIMEOUTS 2
e73aec82
MP
29
30/*
31 * Size of the initial data buffer for mode and read capacity data
32 */
33#define SD_BUF_SIZE 512
34
18351070
LT
35/*
36 * Number of sectors at the end of the device to avoid multi-sector
37 * accesses to in the case of last_sector_bug
38 */
39#define SD_LAST_BUGGY_SECTORS 8
40
4e7392ec
MP
41enum {
42 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
43 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
44};
45
5db44863 46enum {
bcdb247c
MP
47 SD_DEF_XFER_BLOCKS = 0xffff,
48 SD_MAX_XFER_BLOCKS = 0xffffffff,
5db44863
MP
49 SD_MAX_WS10_BLOCKS = 0xffff,
50 SD_MAX_WS16_BLOCKS = 0x7fffff,
51};
52
c98a0eb0
MP
53enum {
54 SD_LBP_FULL = 0, /* Full logical block provisioning */
55 SD_LBP_UNMAP, /* Use UNMAP command */
56 SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
57 SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
58 SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
59 SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
60};
61
e6bd9312
MP
62enum {
63 SD_ZERO_WRITE = 0, /* Use WRITE(10/16) command */
64 SD_ZERO_WS, /* Use WRITE SAME(10/16) command */
65 SD_ZERO_WS16_UNMAP, /* Use WRITE SAME(16) with UNMAP */
66 SD_ZERO_WS10_UNMAP, /* Use WRITE SAME(10) with UNMAP */
67};
68
e73aec82
MP
69struct scsi_disk {
70 struct scsi_driver *driver; /* always &sd_template */
71 struct scsi_device *device;
ee959b00 72 struct device dev;
e73aec82 73 struct gendisk *disk;
89d94756
HR
74#ifdef CONFIG_BLK_DEV_ZONED
75 unsigned int nr_zones;
76 unsigned int zone_blocks;
77 unsigned int zone_shift;
78 unsigned long *zones_wlock;
79 unsigned int zones_optimal_open;
80 unsigned int zones_optimal_nonseq;
81 unsigned int zones_max_open;
82#endif
409f3499 83 atomic_t openers;
f08bb1e0 84 sector_t capacity; /* size in logical blocks */
bcdb247c 85 u32 max_xfer_blocks;
ca369d51 86 u32 opt_xfer_blocks;
c98a0eb0
MP
87 u32 max_ws_blocks;
88 u32 max_unmap_blocks;
89 u32 unmap_granularity;
90 u32 unmap_alignment;
e73aec82 91 u32 index;
526f7c79 92 unsigned int physical_block_size;
18a4d0a2
MP
93 unsigned int max_medium_access_timeouts;
94 unsigned int medium_access_timed_out;
e73aec82
MP
95 u8 media_present;
96 u8 write_prot;
e0597d70 97 u8 protection_type;/* Data Integrity Field */
c98a0eb0 98 u8 provisioning_mode;
e6bd9312 99 u8 zeroing_mode;
e0597d70 100 unsigned ATO : 1; /* state of disk ATO bit */
39c60a09 101 unsigned cache_override : 1; /* temp override of WCE,RCD */
e73aec82
MP
102 unsigned WCE : 1; /* state of disk WCE bit */
103 unsigned RCD : 1; /* state of disk RCD bit, unused */
104 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
70a9b873 105 unsigned first_scan : 1;
c98a0eb0
MP
106 unsigned lbpme : 1;
107 unsigned lbprz : 1;
108 unsigned lbpu : 1;
109 unsigned lbpws : 1;
110 unsigned lbpws10 : 1;
111 unsigned lbpvpd : 1;
66c28f97 112 unsigned ws10 : 1;
5db44863 113 unsigned ws16 : 1;
89d94756
HR
114 unsigned rc_basis: 2;
115 unsigned zoned: 2;
116 unsigned urswrz : 1;
7a38dc0b 117 unsigned ignore_medium_access_errors : 1;
e73aec82 118};
ee959b00 119#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82 120
5b635da1
MP
121static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
122{
123 return container_of(disk->private_data, struct scsi_disk, driver);
124}
125
e73aec82
MP
126#define sd_printk(prefix, sdsk, fmt, a...) \
127 (sdsk)->disk ? \
22e0d994
HR
128 sdev_prefix_printk(prefix, (sdsk)->device, \
129 (sdsk)->disk->disk_name, fmt, ##a) : \
130 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
e73aec82 131
b2bff6ce
MP
132#define sd_first_printk(prefix, sdsk, fmt, a...) \
133 do { \
134 if ((sdkp)->first_scan) \
135 sd_printk(prefix, sdsk, fmt, ##a); \
136 } while (0)
137
18a4d0a2
MP
138static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
139{
140 switch (scmd->cmnd[0]) {
141 case READ_6:
142 case READ_10:
143 case READ_12:
144 case READ_16:
145 case SYNCHRONIZE_CACHE:
146 case VERIFY:
147 case VERIFY_12:
148 case VERIFY_16:
149 case WRITE_6:
150 case WRITE_10:
151 case WRITE_12:
152 case WRITE_16:
153 case WRITE_SAME:
154 case WRITE_SAME_16:
155 case UNMAP:
156 return 1;
157 case VARIABLE_LENGTH_CMD:
158 switch (scmd->cmnd[9]) {
159 case READ_32:
160 case VERIFY_32:
161 case WRITE_32:
162 case WRITE_SAME_32:
163 return 1;
164 }
165 }
166
167 return 0;
168}
169
f08bb1e0
MP
170static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
171{
172 return blocks << (ilog2(sdev->sector_size) - 9);
173}
174
6b7e9cde
MP
175static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
176{
177 return blocks * sdev->sector_size;
178}
179
6eadc612
DLM
180static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
181{
182 return bytes >> ilog2(sdev->sector_size);
183}
184
89d94756
HR
185static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
186{
187 return sector >> (ilog2(sdev->sector_size) - 9);
188}
189
c611529e
MP
190/*
191 * Look up the DIX operation based on whether the command is read or
192 * write and whether dix and dif are enabled.
193 */
194static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
195{
196 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
197 const unsigned int ops[] = { /* wrt dix dif */
198 SCSI_PROT_NORMAL, /* 0 0 0 */
199 SCSI_PROT_READ_STRIP, /* 0 0 1 */
200 SCSI_PROT_READ_INSERT, /* 0 1 0 */
201 SCSI_PROT_READ_PASS, /* 0 1 1 */
202 SCSI_PROT_NORMAL, /* 1 0 0 */
203 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
204 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
205 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
206 };
207
208 return ops[write << 2 | dix << 1 | dif];
209}
210
211/*
212 * Returns a mask of the protection flags that are valid for a given DIX
213 * operation.
214 */
215static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
216{
217 const unsigned int flag_mask[] = {
218 [SCSI_PROT_NORMAL] = 0,
219
220 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
221 SCSI_PROT_GUARD_CHECK |
222 SCSI_PROT_REF_CHECK |
223 SCSI_PROT_REF_INCREMENT,
224
225 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
226 SCSI_PROT_IP_CHECKSUM,
227
228 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
229 SCSI_PROT_GUARD_CHECK |
230 SCSI_PROT_REF_CHECK |
231 SCSI_PROT_REF_INCREMENT |
232 SCSI_PROT_IP_CHECKSUM,
233
234 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
235 SCSI_PROT_REF_INCREMENT,
236
237 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
238 SCSI_PROT_REF_CHECK |
239 SCSI_PROT_REF_INCREMENT |
240 SCSI_PROT_IP_CHECKSUM,
241
242 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
243 SCSI_PROT_GUARD_CHECK |
244 SCSI_PROT_REF_CHECK |
245 SCSI_PROT_REF_INCREMENT |
246 SCSI_PROT_IP_CHECKSUM,
247 };
248
249 return flag_mask[prot_op];
250}
251
4c393e6e 252#ifdef CONFIG_BLK_DEV_INTEGRITY
af55ff67 253
af55ff67 254extern void sd_dif_config_host(struct scsi_disk *);
c611529e 255extern void sd_dif_prepare(struct scsi_cmnd *scmd);
af55ff67
MP
256extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
257
258#else /* CONFIG_BLK_DEV_INTEGRITY */
259
4c393e6e
JB
260static inline void sd_dif_config_host(struct scsi_disk *disk)
261{
262}
c611529e 263static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
4c393e6e
JB
264{
265 return 0;
266}
267static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
268{
269}
af55ff67
MP
270
271#endif /* CONFIG_BLK_DEV_INTEGRITY */
272
89d94756
HR
273static inline int sd_is_zoned(struct scsi_disk *sdkp)
274{
275 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
276}
277
278#ifdef CONFIG_BLK_DEV_ZONED
279
280extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
281extern void sd_zbc_remove(struct scsi_disk *sdkp);
282extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
a90dfdc2
DLM
283extern int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd);
284extern void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd);
89d94756
HR
285extern int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd);
286extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd);
287extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
288 struct scsi_sense_hdr *sshdr);
289
290#else /* CONFIG_BLK_DEV_ZONED */
291
292static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
293 unsigned char *buf)
294{
295 return 0;
296}
297
298static inline void sd_zbc_remove(struct scsi_disk *sdkp) {}
299
300static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
301
a90dfdc2 302static inline int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd)
89d94756
HR
303{
304 /* Let the drive fail requests */
305 return BLKPREP_OK;
306}
307
a90dfdc2 308static inline void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd) {}
89d94756
HR
309
310static inline int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd)
311{
312 return BLKPREP_INVALID;
313}
314
315static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd)
316{
317 return BLKPREP_INVALID;
318}
319
320static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
321 unsigned int good_bytes,
322 struct scsi_sense_hdr *sshdr) {}
323
324#endif /* CONFIG_BLK_DEV_ZONED */
325
e73aec82 326#endif /* _SCSI_DISK_H */