net/mlx4_core: drop useless LIST_HEAD
[linux-2.6-block.git] / drivers / scsi / sd.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
e73aec82
MP
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
e73aec82
MP
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)
7e660100
JB
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
5db44863 22#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
e73aec82
MP
23
24/*
25 * Number of allowed retries
26 */
27#define SD_MAX_RETRIES 5
28#define SD_PASSTHROUGH_RETRIES 1
18a4d0a2 29#define SD_MAX_MEDIUM_TIMEOUTS 2
e73aec82
MP
30
31/*
32 * Size of the initial data buffer for mode and read capacity data
33 */
34#define SD_BUF_SIZE 512
35
18351070
LT
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
4e7392ec
MP
42enum {
43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
45};
46
5db44863 47enum {
bcdb247c
MP
48 SD_DEF_XFER_BLOCKS = 0xffff,
49 SD_MAX_XFER_BLOCKS = 0xffffffff,
5db44863
MP
50 SD_MAX_WS10_BLOCKS = 0xffff,
51 SD_MAX_WS16_BLOCKS = 0x7fffff,
52};
53
c98a0eb0
MP
54enum {
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
e6bd9312
MP
63enum {
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
e73aec82
MP
70struct scsi_disk {
71 struct scsi_driver *driver; /* always &sd_template */
72 struct scsi_device *device;
ee959b00 73 struct device dev;
e73aec82 74 struct gendisk *disk;
d80210f2 75 struct opal_dev *opal_dev;
89d94756 76#ifdef CONFIG_BLK_DEV_ZONED
354f1132
BVA
77 u32 nr_zones;
78 u32 zone_blocks;
354f1132
BVA
79 u32 zones_optimal_open;
80 u32 zones_optimal_nonseq;
81 u32 zones_max_open;
89d94756 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;
d80210f2 117 unsigned security : 1;
7a38dc0b 118 unsigned ignore_medium_access_errors : 1;
e73aec82 119};
ee959b00 120#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
e73aec82 121
5b635da1
MP
122static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
123{
124 return container_of(disk->private_data, struct scsi_disk, driver);
125}
126
e73aec82
MP
127#define sd_printk(prefix, sdsk, fmt, a...) \
128 (sdsk)->disk ? \
22e0d994
HR
129 sdev_prefix_printk(prefix, (sdsk)->device, \
130 (sdsk)->disk->disk_name, fmt, ##a) : \
131 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
e73aec82 132
b2bff6ce
MP
133#define sd_first_printk(prefix, sdsk, fmt, a...) \
134 do { \
135 if ((sdkp)->first_scan) \
136 sd_printk(prefix, sdsk, fmt, ##a); \
137 } while (0)
138
18a4d0a2
MP
139static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
140{
141 switch (scmd->cmnd[0]) {
142 case READ_6:
143 case READ_10:
144 case READ_12:
145 case READ_16:
146 case SYNCHRONIZE_CACHE:
147 case VERIFY:
148 case VERIFY_12:
149 case VERIFY_16:
150 case WRITE_6:
151 case WRITE_10:
152 case WRITE_12:
153 case WRITE_16:
154 case WRITE_SAME:
155 case WRITE_SAME_16:
156 case UNMAP:
157 return 1;
158 case VARIABLE_LENGTH_CMD:
159 switch (scmd->cmnd[9]) {
160 case READ_32:
161 case VERIFY_32:
162 case WRITE_32:
163 case WRITE_SAME_32:
164 return 1;
165 }
166 }
167
168 return 0;
169}
170
f08bb1e0
MP
171static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
172{
173 return blocks << (ilog2(sdev->sector_size) - 9);
174}
175
6b7e9cde
MP
176static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
177{
178 return blocks * sdev->sector_size;
179}
180
6eadc612
DLM
181static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
182{
183 return bytes >> ilog2(sdev->sector_size);
184}
185
89d94756
HR
186static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
187{
188 return sector >> (ilog2(sdev->sector_size) - 9);
189}
190
c611529e
MP
191/*
192 * Look up the DIX operation based on whether the command is read or
193 * write and whether dix and dif are enabled.
194 */
195static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
196{
197 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
198 const unsigned int ops[] = { /* wrt dix dif */
199 SCSI_PROT_NORMAL, /* 0 0 0 */
200 SCSI_PROT_READ_STRIP, /* 0 0 1 */
201 SCSI_PROT_READ_INSERT, /* 0 1 0 */
202 SCSI_PROT_READ_PASS, /* 0 1 1 */
203 SCSI_PROT_NORMAL, /* 1 0 0 */
204 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
205 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
206 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
207 };
208
209 return ops[write << 2 | dix << 1 | dif];
210}
211
212/*
213 * Returns a mask of the protection flags that are valid for a given DIX
214 * operation.
215 */
216static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
217{
218 const unsigned int flag_mask[] = {
219 [SCSI_PROT_NORMAL] = 0,
220
221 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
222 SCSI_PROT_GUARD_CHECK |
223 SCSI_PROT_REF_CHECK |
224 SCSI_PROT_REF_INCREMENT,
225
226 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
227 SCSI_PROT_IP_CHECKSUM,
228
229 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
230 SCSI_PROT_GUARD_CHECK |
231 SCSI_PROT_REF_CHECK |
232 SCSI_PROT_REF_INCREMENT |
233 SCSI_PROT_IP_CHECKSUM,
234
235 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
236 SCSI_PROT_REF_INCREMENT,
237
238 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
239 SCSI_PROT_REF_CHECK |
240 SCSI_PROT_REF_INCREMENT |
241 SCSI_PROT_IP_CHECKSUM,
242
243 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
244 SCSI_PROT_GUARD_CHECK |
245 SCSI_PROT_REF_CHECK |
246 SCSI_PROT_REF_INCREMENT |
247 SCSI_PROT_IP_CHECKSUM,
248 };
249
250 return flag_mask[prot_op];
251}
252
4c393e6e 253#ifdef CONFIG_BLK_DEV_INTEGRITY
af55ff67 254
af55ff67 255extern void sd_dif_config_host(struct scsi_disk *);
af55ff67
MP
256
257#else /* CONFIG_BLK_DEV_INTEGRITY */
258
4c393e6e
JB
259static inline void sd_dif_config_host(struct scsi_disk *disk)
260{
261}
af55ff67
MP
262
263#endif /* CONFIG_BLK_DEV_INTEGRITY */
264
89d94756
HR
265static inline int sd_is_zoned(struct scsi_disk *sdkp)
266{
267 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
268}
269
270#ifdef CONFIG_BLK_DEV_ZONED
271
272extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
89d94756 273extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
89d94756
HR
274extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd);
275extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
276 struct scsi_sense_hdr *sshdr);
e76239a3
CH
277extern int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
278 struct blk_zone *zones, unsigned int *nr_zones,
279 gfp_t gfp_mask);
89d94756
HR
280
281#else /* CONFIG_BLK_DEV_ZONED */
282
283static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
284 unsigned char *buf)
285{
286 return 0;
287}
288
89d94756
HR
289static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
290
89d94756
HR
291static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd)
292{
293 return BLKPREP_INVALID;
294}
295
296static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
297 unsigned int good_bytes,
298 struct scsi_sense_hdr *sshdr) {}
299
e76239a3
CH
300#define sd_zbc_report_zones NULL
301
89d94756
HR
302#endif /* CONFIG_BLK_DEV_ZONED */
303
e73aec82 304#endif /* _SCSI_DISK_H */