Loading...
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
11/*
12 * This is limited by the naming scheme enforced in sd_probe,
13 * add another character to it if you really need more disks.
14 */
15#define SD_MAX_DISKS (((26 * 26) + 26 + 1) * 26)
16
17/*
18 * Time out in seconds for disks and Magneto-opticals (which are slower).
19 */
20#define SD_TIMEOUT (30 * HZ)
21#define SD_MOD_TIMEOUT (75 * HZ)
22#define SD_FLUSH_TIMEOUT (60 * HZ)
23
24/*
25 * Number of allowed retries
26 */
27#define SD_MAX_RETRIES 5
28#define SD_PASSTHROUGH_RETRIES 1
29
30/*
31 * Size of the initial data buffer for mode and read capacity data
32 */
33#define SD_BUF_SIZE 512
34
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
41enum {
42 SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
43 SD_MEMPOOL_SIZE = 2, /* CDB pool size */
44};
45
46enum {
47 SD_LBP_FULL = 0, /* Full logical block provisioning */
48 SD_LBP_UNMAP, /* Use UNMAP command */
49 SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
50 SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
51 SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
52 SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
53};
54
55struct scsi_disk {
56 struct scsi_driver *driver; /* always &sd_template */
57 struct scsi_device *device;
58 struct device dev;
59 struct gendisk *disk;
60 atomic_t openers;
61 sector_t capacity; /* size in 512-byte sectors */
62 u32 max_ws_blocks;
63 u32 max_unmap_blocks;
64 u32 unmap_granularity;
65 u32 unmap_alignment;
66 u32 index;
67 unsigned int physical_block_size;
68 u8 media_present;
69 u8 write_prot;
70 u8 protection_type;/* Data Integrity Field */
71 u8 provisioning_mode;
72 unsigned ATO : 1; /* state of disk ATO bit */
73 unsigned WCE : 1; /* state of disk WCE bit */
74 unsigned RCD : 1; /* state of disk RCD bit, unused */
75 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
76 unsigned first_scan : 1;
77 unsigned lbpme : 1;
78 unsigned lbprz : 1;
79 unsigned lbpu : 1;
80 unsigned lbpws : 1;
81 unsigned lbpws10 : 1;
82 unsigned lbpvpd : 1;
83};
84#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
85
86static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
87{
88 return container_of(disk->private_data, struct scsi_disk, driver);
89}
90
91#define sd_printk(prefix, sdsk, fmt, a...) \
92 (sdsk)->disk ? \
93 sdev_printk(prefix, (sdsk)->device, "[%s] " fmt, \
94 (sdsk)->disk->disk_name, ##a) : \
95 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
96
97/*
98 * A DIF-capable target device can be formatted with different
99 * protection schemes. Currently 0 through 3 are defined:
100 *
101 * Type 0 is regular (unprotected) I/O
102 *
103 * Type 1 defines the contents of the guard and reference tags
104 *
105 * Type 2 defines the contents of the guard and reference tags and
106 * uses 32-byte commands to seed the latter
107 *
108 * Type 3 defines the contents of the guard tag only
109 */
110
111enum sd_dif_target_protection_types {
112 SD_DIF_TYPE0_PROTECTION = 0x0,
113 SD_DIF_TYPE1_PROTECTION = 0x1,
114 SD_DIF_TYPE2_PROTECTION = 0x2,
115 SD_DIF_TYPE3_PROTECTION = 0x3,
116};
117
118/*
119 * Data Integrity Field tuple.
120 */
121struct sd_dif_tuple {
122 __be16 guard_tag; /* Checksum */
123 __be16 app_tag; /* Opaque storage */
124 __be32 ref_tag; /* Target LBA or indirect LBA */
125};
126
127#ifdef CONFIG_BLK_DEV_INTEGRITY
128
129extern void sd_dif_config_host(struct scsi_disk *);
130extern int sd_dif_prepare(struct request *rq, sector_t, unsigned int);
131extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
132
133#else /* CONFIG_BLK_DEV_INTEGRITY */
134
135static inline void sd_dif_config_host(struct scsi_disk *disk)
136{
137}
138static inline int sd_dif_prepare(struct request *rq, sector_t s, unsigned int a)
139{
140 return 0;
141}
142static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
143{
144}
145
146#endif /* CONFIG_BLK_DEV_INTEGRITY */
147
148#endif /* _SCSI_DISK_H */
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 rev_nr_zones;
79 u32 zone_blocks;
80 u32 rev_zone_blocks;
81 u32 zones_optimal_open;
82 u32 zones_optimal_nonseq;
83 u32 zones_max_open;
84 u32 *zones_wp_offset;
85 spinlock_t zones_wp_offset_lock;
86 u32 *rev_wp_offset;
87 struct mutex rev_mutex;
88 struct work_struct zone_wp_offset_work;
89 char *zone_wp_update_buf;
90#endif
91 atomic_t openers;
92 sector_t capacity; /* size in logical blocks */
93 u32 max_xfer_blocks;
94 u32 opt_xfer_blocks;
95 u32 max_ws_blocks;
96 u32 max_unmap_blocks;
97 u32 unmap_granularity;
98 u32 unmap_alignment;
99 u32 index;
100 unsigned int physical_block_size;
101 unsigned int max_medium_access_timeouts;
102 unsigned int medium_access_timed_out;
103 u8 media_present;
104 u8 write_prot;
105 u8 protection_type;/* Data Integrity Field */
106 u8 provisioning_mode;
107 u8 zeroing_mode;
108 unsigned ATO : 1; /* state of disk ATO bit */
109 unsigned cache_override : 1; /* temp override of WCE,RCD */
110 unsigned WCE : 1; /* state of disk WCE bit */
111 unsigned RCD : 1; /* state of disk RCD bit, unused */
112 unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
113 unsigned first_scan : 1;
114 unsigned lbpme : 1;
115 unsigned lbprz : 1;
116 unsigned lbpu : 1;
117 unsigned lbpws : 1;
118 unsigned lbpws10 : 1;
119 unsigned lbpvpd : 1;
120 unsigned ws10 : 1;
121 unsigned ws16 : 1;
122 unsigned rc_basis: 2;
123 unsigned zoned: 2;
124 unsigned urswrz : 1;
125 unsigned security : 1;
126 unsigned ignore_medium_access_errors : 1;
127};
128#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
129
130static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
131{
132 return container_of(disk->private_data, struct scsi_disk, driver);
133}
134
135#define sd_printk(prefix, sdsk, fmt, a...) \
136 (sdsk)->disk ? \
137 sdev_prefix_printk(prefix, (sdsk)->device, \
138 (sdsk)->disk->disk_name, fmt, ##a) : \
139 sdev_printk(prefix, (sdsk)->device, fmt, ##a)
140
141#define sd_first_printk(prefix, sdsk, fmt, a...) \
142 do { \
143 if ((sdsk)->first_scan) \
144 sd_printk(prefix, sdsk, fmt, ##a); \
145 } while (0)
146
147static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
148{
149 switch (scmd->cmnd[0]) {
150 case READ_6:
151 case READ_10:
152 case READ_12:
153 case READ_16:
154 case SYNCHRONIZE_CACHE:
155 case VERIFY:
156 case VERIFY_12:
157 case VERIFY_16:
158 case WRITE_6:
159 case WRITE_10:
160 case WRITE_12:
161 case WRITE_16:
162 case WRITE_SAME:
163 case WRITE_SAME_16:
164 case UNMAP:
165 return 1;
166 case VARIABLE_LENGTH_CMD:
167 switch (scmd->cmnd[9]) {
168 case READ_32:
169 case VERIFY_32:
170 case WRITE_32:
171 case WRITE_SAME_32:
172 return 1;
173 }
174 }
175
176 return 0;
177}
178
179static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
180{
181 return blocks << (ilog2(sdev->sector_size) - 9);
182}
183
184static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
185{
186 return blocks * sdev->sector_size;
187}
188
189static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
190{
191 return bytes >> ilog2(sdev->sector_size);
192}
193
194static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
195{
196 return sector >> (ilog2(sdev->sector_size) - 9);
197}
198
199#ifdef CONFIG_BLK_DEV_INTEGRITY
200
201extern void sd_dif_config_host(struct scsi_disk *);
202
203#else /* CONFIG_BLK_DEV_INTEGRITY */
204
205static inline void sd_dif_config_host(struct scsi_disk *disk)
206{
207}
208
209#endif /* CONFIG_BLK_DEV_INTEGRITY */
210
211static inline int sd_is_zoned(struct scsi_disk *sdkp)
212{
213 return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
214}
215
216#ifdef CONFIG_BLK_DEV_ZONED
217
218void sd_zbc_release_disk(struct scsi_disk *sdkp);
219int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
220int sd_zbc_revalidate_zones(struct scsi_disk *sdkp);
221blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
222 unsigned char op, bool all);
223unsigned int sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
224 struct scsi_sense_hdr *sshdr);
225int sd_zbc_report_zones(struct gendisk *disk, sector_t sector,
226 unsigned int nr_zones, report_zones_cb cb, void *data);
227
228blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd, sector_t *lba,
229 unsigned int nr_blocks);
230
231#else /* CONFIG_BLK_DEV_ZONED */
232
233static inline void sd_zbc_release_disk(struct scsi_disk *sdkp) {}
234
235static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
236 unsigned char *buf)
237{
238 return 0;
239}
240
241static inline int sd_zbc_revalidate_zones(struct scsi_disk *sdkp)
242{
243 return 0;
244}
245
246static inline blk_status_t sd_zbc_setup_zone_mgmt_cmnd(struct scsi_cmnd *cmd,
247 unsigned char op,
248 bool all)
249{
250 return BLK_STS_TARGET;
251}
252
253static inline unsigned int sd_zbc_complete(struct scsi_cmnd *cmd,
254 unsigned int good_bytes, struct scsi_sense_hdr *sshdr)
255{
256 return good_bytes;
257}
258
259static inline blk_status_t sd_zbc_prepare_zone_append(struct scsi_cmnd *cmd,
260 sector_t *lba,
261 unsigned int nr_blocks)
262{
263 return BLK_STS_TARGET;
264}
265
266#define sd_zbc_report_zones NULL
267
268#endif /* CONFIG_BLK_DEV_ZONED */
269
270void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr);
271void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result);
272
273#endif /* _SCSI_DISK_H */