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
70struct 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 zone_blocks;
79 u32 zones_optimal_open;
80 u32 zones_optimal_nonseq;
81 u32 zones_max_open;
82 u32 *zones_wp_offset;
83 spinlock_t zones_wp_offset_lock;
84 u32 *rev_wp_offset;
85 struct mutex rev_mutex;
86 struct work_struct zone_wp_offset_work;
87 char *zone_wp_update_buf;
88#endif
89 atomic_t openers;
90 sector_t capacity; /* size in logical blocks */
91 u32 max_xfer_blocks;
92 u32 opt_xfer_blocks;
93 u32 max_ws_blocks;
94 u32 max_unmap_blocks;
95 u32 unmap_granularity;
96 u32 unmap_alignment;
97 u32 index;
98 unsigned int physical_block_size;
99 unsigned int max_medium_access_timeouts;
100 unsigned int medium_access_timed_out;
101 u8 media_present;
102 u8 write_prot;
103 u8 protection_type;/* Data Integrity Field */
104 u8 provisioning_mode;
105 u8 zeroing_mode;
106 unsigned ATO : 1; /* state of disk ATO bit */
107 unsigned cache_override : 1; /* temp override of WCE,RCD */
108 unsigned WCE : 1; /* state of disk WCE bit */
109 unsigned RCD : 1; /* state of disk RCD bit, unused */
110 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
111 unsigned first_scan : 1;
112 unsigned lbpme : 1;
113 unsigned lbprz : 1;
114 unsigned lbpu : 1;
115 unsigned lbpws : 1;
116 unsigned lbpws10 : 1;
117 unsigned lbpvpd : 1;
118 unsigned ws10 : 1;
119 unsigned ws16 : 1;
120 unsigned rc_basis: 2;
121 unsigned zoned: 2;
122 unsigned urswrz : 1;
123 unsigned security : 1;
124 unsigned ignore_medium_access_errors : 1;
125};
126#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
127
128static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
129{
130 return container_of(disk->private_data, struct scsi_disk, driver);
131}
132
133#define sd_printk(prefix, sdsk, fmt, a...) \
134 (sdsk)->disk ? \
135 sdev_prefix_printk(prefix, (sdsk)->device, \
136 (sdsk)->disk->disk_name, fmt, ##a) : \
137 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
138
139#define sd_first_printk(prefix, sdsk, fmt, a...) \
140 do { \
141 if ((sdsk)->first_scan) \
142 sd_printk(prefix, sdsk, fmt, ##a); \
143 } while (0)
144
145static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
146{
147 switch (scmd->cmnd[0]) {
148 case READ_6:
149 case READ_10:
150 case READ_12:
151 case READ_16:
152 case SYNCHRONIZE_CACHE:
153 case VERIFY:
154 case VERIFY_12:
155 case VERIFY_16:
156 case WRITE_6:
157 case WRITE_10:
158 case WRITE_12:
159 case WRITE_16:
160 case WRITE_SAME:
161 case WRITE_SAME_16:
162 case UNMAP:
163 return 1;
164 case VARIABLE_LENGTH_CMD:
165 switch (scmd->cmnd[9]) {
166 case READ_32:
167 case VERIFY_32:
168 case WRITE_32:
169 case WRITE_SAME_32:
170 return 1;
171 }
172 }
173
174 return 0;
175}
176
177static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
178{
179 return blocks << (ilog2(sdev->sector_size) - 9);
180}
181
182static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
183{
184 return blocks * sdev->sector_size;
185}
186
187static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
188{
189 return bytes >> ilog2(sdev->sector_size);
190}
191
192static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
193{
194 return sector >> (ilog2(sdev->sector_size) - 9);
195}
196
197#ifdef CONFIG_BLK_DEV_INTEGRITY
198
199extern void sd_dif_config_host(struct scsi_disk *);
200
201#else /* CONFIG_BLK_DEV_INTEGRITY */
202
203static inline void sd_dif_config_host(struct scsi_disk *disk)
204{
205}
206
207#endif /* CONFIG_BLK_DEV_INTEGRITY */
208
209static inline int sd_is_zoned(struct scsi_disk *sdkp)
210{
211 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
212}
213
214#ifdef CONFIG_BLK_DEV_ZONED
215
216int sd_zbc_init_disk(struct scsi_disk *sdkp);
217void sd_zbc_release_disk(struct scsi_disk *sdkp);
218extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
219extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
220blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
221 unsigned char op, bool all);
222unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
223 struct scsi_sense_hdr *sshdr);
224int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
225 unsigned int nr_zones, report_zones_cb cb, void *data);
226
227blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
228 unsigned int nr_blocks);
229
230#else /* CONFIG_BLK_DEV_ZONED */
231
232static inline int sd_zbc_init(void)
233{
234 return 0;
235}
236
237static inline int sd_zbc_init_disk(struct scsi_disk *sdkp)
238{
239 return 0;
240}
241
242static inline void sd_zbc_exit(void) {}
243static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
244
245static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
246 unsigned char *buf)
247{
248 return 0;
249}
250
251static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
252
253static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
254 unsigned char op,
255 bool all)
256{
257 return BLK_STS_TARGET;
258}
259
260static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
261 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
262{
263 return 0;
264}
265
266static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
267 sector_t *lba,
268 unsigned int nr_blocks)
269{
270 return BLK_STS_TARGET;
271}
272
273#define sd_zbc_report_zones NULL
274
275#endif /* CONFIG_BLK_DEV_ZONED */
276
277void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
278void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
279
280#endif /* _SCSI_DISK_H */