tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
42enum {
43 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
44 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
45};
46
47enum {
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
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
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
70/**
71 * struct zoned_disk_info - Specific properties of a ZBC SCSI device.
72 * @nr_zones: number of zones.
73 * @zone_blocks: number of logical blocks per zone.
74 *
75 * This data structure holds the ZBC SCSI device properties that are retrieved
76 * twice: a first time before the gendisk capacity is known and a second time
77 * after the gendisk capacity is known.
78 */
79struct zoned_disk_info {
80 u32 nr_zones;
81 u32 zone_blocks;
82};
83
84struct scsi_disk {
85 struct scsi_device *device;
86
87 /*
88 * disk_dev is used to show attributes in /sys/class/scsi_disk/,
89 * but otherwise not really needed. Do not use for refcounting.
90 */
91 struct device disk_dev;
92 struct gendisk *disk;
93 struct opal_dev *opal_dev;
94#ifdef CONFIG_BLK_DEV_ZONED
95 /* Updated during revalidation before the gendisk capacity is known. */
96 struct zoned_disk_info early_zone_info;
97 /* Updated during revalidation after the gendisk capacity is known. */
98 struct zoned_disk_info zone_info;
99 u32 zones_optimal_open;
100 u32 zones_optimal_nonseq;
101 u32 zones_max_open;
102 /*
103 * Either zero or a power of two. If not zero it means that the offset
104 * between zone starting LBAs is constant.
105 */
106 u32 zone_starting_lba_gran;
107#endif
108 atomic_t openers;
109 sector_t capacity; /* size in logical blocks */
110 int max_retries;
111 u32 min_xfer_blocks;
112 u32 max_xfer_blocks;
113 u32 opt_xfer_blocks;
114 u32 max_ws_blocks;
115 u32 max_unmap_blocks;
116 u32 unmap_granularity;
117 u32 unmap_alignment;
118 u32 index;
119 unsigned int physical_block_size;
120 unsigned int max_medium_access_timeouts;
121 unsigned int medium_access_timed_out;
122 /* number of permanent streams */
123 u16 permanent_stream_count;
124 u8 media_present;
125 u8 write_prot;
126 u8 protection_type;/* Data Integrity Field */
127 u8 provisioning_mode;
128 u8 zeroing_mode;
129 u8 nr_actuators; /* Number of actuators */
130 bool suspended; /* Disk is suspended (stopped) */
131 unsigned ATO : 1; /* state of disk ATO bit */
132 unsigned cache_override : 1; /* temp override of WCE,RCD */
133 unsigned WCE : 1; /* state of disk WCE bit */
134 unsigned RCD : 1; /* state of disk RCD bit, unused */
135 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
136 unsigned first_scan : 1;
137 unsigned lbpme : 1;
138 unsigned lbprz : 1;
139 unsigned lbpu : 1;
140 unsigned lbpws : 1;
141 unsigned lbpws10 : 1;
142 unsigned lbpvpd : 1;
143 unsigned ws10 : 1;
144 unsigned ws16 : 1;
145 unsigned rc_basis: 2;
146 unsigned zoned: 2;
147 unsigned urswrz : 1;
148 unsigned security : 1;
149 unsigned ignore_medium_access_errors : 1;
150 unsigned rscs : 1; /* reduced stream control support */
151};
152#define to_scsi_disk(obj) container_of(obj, struct scsi_disk, disk_dev)
153
154static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
155{
156 return disk->private_data;
157}
158
159#define sd_printk(prefix, sdsk, fmt, a...) \
160 (sdsk)->disk ? \
161 sdev_prefix_printk(prefix, (sdsk)->device, \
162 (sdsk)->disk->disk_name, fmt, ##a) : \
163 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
164
165#define sd_first_printk(prefix, sdsk, fmt, a...) \
166 do { \
167 if ((sdsk)->first_scan) \
168 sd_printk(prefix, sdsk, fmt, ##a); \
169 } while (0)
170
171static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
172{
173 switch (scmd->cmnd[0]) {
174 case READ_6:
175 case READ_10:
176 case READ_12:
177 case READ_16:
178 case SYNCHRONIZE_CACHE:
179 case VERIFY:
180 case VERIFY_12:
181 case VERIFY_16:
182 case WRITE_6:
183 case WRITE_10:
184 case WRITE_12:
185 case WRITE_16:
186 case WRITE_SAME:
187 case WRITE_SAME_16:
188 case UNMAP:
189 return 1;
190 case VARIABLE_LENGTH_CMD:
191 switch (scmd->cmnd[9]) {
192 case READ_32:
193 case VERIFY_32:
194 case WRITE_32:
195 case WRITE_SAME_32:
196 return 1;
197 }
198 }
199
200 return 0;
201}
202
203static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
204{
205 return blocks << (ilog2(sdev->sector_size) - 9);
206}
207
208static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
209{
210 return blocks * sdev->sector_size;
211}
212
213static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
214{
215 return bytes >> ilog2(sdev->sector_size);
216}
217
218static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
219{
220 return sector >> (ilog2(sdev->sector_size) - 9);
221}
222
223#ifdef CONFIG_BLK_DEV_INTEGRITY
224
225extern void sd_dif_config_host(struct scsi_disk *);
226
227#else /* CONFIG_BLK_DEV_INTEGRITY */
228
229static inline void sd_dif_config_host(struct scsi_disk *disk)
230{
231}
232
233#endif /* CONFIG_BLK_DEV_INTEGRITY */
234
235static inline int sd_is_zoned(struct scsi_disk *sdkp)
236{
237 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
238}
239
240#ifdef CONFIG_BLK_DEV_ZONED
241
242int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE]);
243int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
244blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
245 unsigned char op, bool all);
246unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
247 struct scsi_sense_hdr *sshdr);
248int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
249 unsigned int nr_zones, report_zones_cb cb, void *data);
250
251#else /* CONFIG_BLK_DEV_ZONED */
252
253static inline int sd_zbc_read_zones(struct scsi_disk *sdkp, u8 buf[SD_BUF_SIZE])
254{
255 return 0;
256}
257
258static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
259{
260 return 0;
261}
262
263static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
264 unsigned char op,
265 bool all)
266{
267 return BLK_STS_TARGET;
268}
269
270static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
271 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
272{
273 return good_bytes;
274}
275
276#define sd_zbc_report_zones NULL
277
278#endif /* CONFIG_BLK_DEV_ZONED */
279
280void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
281void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
282
283#endif /* _SCSI_DISK_H */