blob: 765a6f1ac1b7320edc860b1eb6baa30e7e1beac4 [file] [log] [blame]
Martin K. Petersene73aec82007-02-27 22:40:55 -05001#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
11/*
Martin K. Petersene73aec82007-02-27 22:40:55 -050012 * 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)
James Bottomley7e660102013-10-04 21:42:24 +000016/*
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
Martin K. Petersen5db44862012-09-18 12:19:32 -040021#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
Martin K. Petersene73aec82007-02-27 22:40:55 -050022
23/*
24 * Number of allowed retries
25 */
26#define SD_MAX_RETRIES 5
27#define SD_PASSTHROUGH_RETRIES 1
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -050028#define SD_MAX_MEDIUM_TIMEOUTS 2
Martin K. Petersene73aec82007-02-27 22:40:55 -050029
30/*
31 * Size of the initial data buffer for mode and read capacity data
32 */
33#define SD_BUF_SIZE 512
34
Linus Torvalds18351072008-08-05 21:42:21 -070035/*
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
Martin K. Petersen4e7392e2009-09-20 16:49:38 -040041enum {
42 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
43 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
44};
45
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050046enum {
Martin K. Petersenbcdb2472014-06-03 18:45:51 -040047 SD_DEF_XFER_BLOCKS = 0xffff,
48 SD_MAX_XFER_BLOCKS = 0xffffffff,
Martin K. Petersen5db44862012-09-18 12:19:32 -040049 SD_MAX_WS10_BLOCKS = 0xffff,
50 SD_MAX_WS16_BLOCKS = 0x7fffff,
51};
52
53enum {
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050054 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
Martin K. Petersene73aec82007-02-27 22:40:55 -050062struct scsi_disk {
63 struct scsi_driver *driver; /* always &sd_template */
64 struct scsi_device *device;
Tony Jonesee959b02008-02-22 00:13:36 +010065 struct device dev;
Martin K. Petersene73aec82007-02-27 22:40:55 -050066 struct gendisk *disk;
Arnd Bergmann409f3492010-07-07 16:51:29 +020067 atomic_t openers;
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -040068 sector_t capacity; /* size in logical blocks */
Martin K. Petersenbcdb2472014-06-03 18:45:51 -040069 u32 max_xfer_blocks;
Martin K. Petersenca369d52015-11-13 16:46:48 -050070 u32 opt_xfer_blocks;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050071 u32 max_ws_blocks;
72 u32 max_unmap_blocks;
73 u32 unmap_granularity;
74 u32 unmap_alignment;
Martin K. Petersene73aec82007-02-27 22:40:55 -050075 u32 index;
Martin K. Petersen526f7c72010-09-28 14:48:47 -040076 unsigned int physical_block_size;
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -050077 unsigned int max_medium_access_timeouts;
78 unsigned int medium_access_timed_out;
Martin K. Petersene73aec82007-02-27 22:40:55 -050079 u8 media_present;
80 u8 write_prot;
Martin K. Petersene0597d72008-07-17 04:28:34 -040081 u8 protection_type;/* Data Integrity Field */
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050082 u8 provisioning_mode;
Martin K. Petersene0597d72008-07-17 04:28:34 -040083 unsigned ATO : 1; /* state of disk ATO bit */
James Bottomley39c60a02013-04-24 14:02:53 -070084 unsigned cache_override : 1; /* temp override of WCE,RCD */
Martin K. Petersene73aec82007-02-27 22:40:55 -050085 unsigned WCE : 1; /* state of disk WCE bit */
86 unsigned RCD : 1; /* state of disk RCD bit, unused */
87 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
Martin K. Petersen70a9b872009-03-09 11:33:31 -040088 unsigned first_scan : 1;
Martin K. Petersenc98a0eb2011-03-08 02:07:15 -050089 unsigned lbpme : 1;
90 unsigned lbprz : 1;
91 unsigned lbpu : 1;
92 unsigned lbpws : 1;
93 unsigned lbpws10 : 1;
94 unsigned lbpvpd : 1;
Martin K. Petersen66c28f92013-06-06 22:15:55 -040095 unsigned ws10 : 1;
Martin K. Petersen5db44862012-09-18 12:19:32 -040096 unsigned ws16 : 1;
Martin K. Petersene73aec82007-02-27 22:40:55 -050097};
Tony Jonesee959b02008-02-22 00:13:36 +010098#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
Martin K. Petersene73aec82007-02-27 22:40:55 -050099
Martin K. Petersen5b635da2008-06-25 11:22:41 -0400100static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
101{
102 return container_of(disk->private_data, struct scsi_disk, driver);
103}
104
Martin K. Petersene73aec82007-02-27 22:40:55 -0500105#define sd_printk(prefix, sdsk, fmt, a...) \
106 (sdsk)->disk ? \
Hannes Reinecke22e0d992014-10-24 14:26:44 +0200107 sdev_prefix_printk(prefix, (sdsk)->device, \
108 (sdsk)->disk->disk_name, fmt, ##a) : \
109 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
Martin K. Petersene73aec82007-02-27 22:40:55 -0500110
Martin K. Petersenb2bff6c2014-01-03 18:19:26 -0500111#define sd_first_printk(prefix, sdsk, fmt, a...) \
112 do { \
113 if ((sdkp)->first_scan) \
114 sd_printk(prefix, sdsk, fmt, ##a); \
115 } while (0)
116
Martin K. Petersen18a4d0a2012-02-09 13:48:53 -0500117static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
118{
119 switch (scmd->cmnd[0]) {
120 case READ_6:
121 case READ_10:
122 case READ_12:
123 case READ_16:
124 case SYNCHRONIZE_CACHE:
125 case VERIFY:
126 case VERIFY_12:
127 case VERIFY_16:
128 case WRITE_6:
129 case WRITE_10:
130 case WRITE_12:
131 case WRITE_16:
132 case WRITE_SAME:
133 case WRITE_SAME_16:
134 case UNMAP:
135 return 1;
136 case VARIABLE_LENGTH_CMD:
137 switch (scmd->cmnd[9]) {
138 case READ_32:
139 case VERIFY_32:
140 case WRITE_32:
141 case WRITE_SAME_32:
142 return 1;
143 }
144 }
145
146 return 0;
147}
148
Martin K. Petersenf08bb1e2016-03-28 21:18:56 -0400149static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
150{
151 return blocks << (ilog2(sdev->sector_size) - 9);
152}
153
Martin K. Petersen6b7e9cd2016-05-12 22:17:34 -0400154static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
155{
156 return blocks * sdev->sector_size;
157}
158
Martin K. Petersene0597d72008-07-17 04:28:34 -0400159/*
160 * A DIF-capable target device can be formatted with different
161 * protection schemes. Currently 0 through 3 are defined:
162 *
163 * Type 0 is regular (unprotected) I/O
164 *
165 * Type 1 defines the contents of the guard and reference tags
166 *
167 * Type 2 defines the contents of the guard and reference tags and
168 * uses 32-byte commands to seed the latter
169 *
170 * Type 3 defines the contents of the guard tag only
171 */
172
173enum sd_dif_target_protection_types {
174 SD_DIF_TYPE0_PROTECTION = 0x0,
175 SD_DIF_TYPE1_PROTECTION = 0x1,
176 SD_DIF_TYPE2_PROTECTION = 0x2,
177 SD_DIF_TYPE3_PROTECTION = 0x3,
178};
179
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400180/*
Martin K. Petersenc6115292014-09-26 19:20:08 -0400181 * Look up the DIX operation based on whether the command is read or
182 * write and whether dix and dif are enabled.
183 */
184static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
185{
186 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
187 const unsigned int ops[] = { /* wrt dix dif */
188 SCSI_PROT_NORMAL, /* 0 0 0 */
189 SCSI_PROT_READ_STRIP, /* 0 0 1 */
190 SCSI_PROT_READ_INSERT, /* 0 1 0 */
191 SCSI_PROT_READ_PASS, /* 0 1 1 */
192 SCSI_PROT_NORMAL, /* 1 0 0 */
193 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
194 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
195 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
196 };
197
198 return ops[write << 2 | dix << 1 | dif];
199}
200
201/*
202 * Returns a mask of the protection flags that are valid for a given DIX
203 * operation.
204 */
205static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
206{
207 const unsigned int flag_mask[] = {
208 [SCSI_PROT_NORMAL] = 0,
209
210 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
211 SCSI_PROT_GUARD_CHECK |
212 SCSI_PROT_REF_CHECK |
213 SCSI_PROT_REF_INCREMENT,
214
215 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
216 SCSI_PROT_IP_CHECKSUM,
217
218 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
219 SCSI_PROT_GUARD_CHECK |
220 SCSI_PROT_REF_CHECK |
221 SCSI_PROT_REF_INCREMENT |
222 SCSI_PROT_IP_CHECKSUM,
223
224 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
225 SCSI_PROT_REF_INCREMENT,
226
227 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
228 SCSI_PROT_REF_CHECK |
229 SCSI_PROT_REF_INCREMENT |
230 SCSI_PROT_IP_CHECKSUM,
231
232 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
233 SCSI_PROT_GUARD_CHECK |
234 SCSI_PROT_REF_CHECK |
235 SCSI_PROT_REF_INCREMENT |
236 SCSI_PROT_IP_CHECKSUM,
237 };
238
239 return flag_mask[prot_op];
240}
241
242/*
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400243 * Data Integrity Field tuple.
244 */
245struct sd_dif_tuple {
246 __be16 guard_tag; /* Checksum */
247 __be16 app_tag; /* Opaque storage */
248 __be32 ref_tag; /* Target LBA or indirect LBA */
249};
250
James Bottomley4c393e62008-10-13 15:20:06 -0400251#ifdef CONFIG_BLK_DEV_INTEGRITY
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400252
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400253extern void sd_dif_config_host(struct scsi_disk *);
Martin K. Petersenc6115292014-09-26 19:20:08 -0400254extern void sd_dif_prepare(struct scsi_cmnd *scmd);
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400255extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
256
257#else /* CONFIG_BLK_DEV_INTEGRITY */
258
James Bottomley4c393e62008-10-13 15:20:06 -0400259static inline void sd_dif_config_host(struct scsi_disk *disk)
260{
261}
Martin K. Petersenc6115292014-09-26 19:20:08 -0400262static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
James Bottomley4c393e62008-10-13 15:20:06 -0400263{
264 return 0;
265}
266static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
267{
268}
Martin K. Petersenaf55ff62008-07-17 04:28:35 -0400269
270#endif /* CONFIG_BLK_DEV_INTEGRITY */
271
Martin K. Petersene73aec82007-02-27 22:40:55 -0500272#endif /* _SCSI_DISK_H */