xref: /linux/drivers/scsi/sd.h (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
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  * 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)
16 #define SD_FLUSH_TIMEOUT	(60 * HZ)
17 
18 /*
19  * Number of allowed retries
20  */
21 #define SD_MAX_RETRIES		5
22 #define SD_PASSTHROUGH_RETRIES	1
23 #define SD_MAX_MEDIUM_TIMEOUTS	2
24 
25 /*
26  * Size of the initial data buffer for mode and read capacity data
27  */
28 #define SD_BUF_SIZE		512
29 
30 /*
31  * Number of sectors at the end of the device to avoid multi-sector
32  * accesses to in the case of last_sector_bug
33  */
34 #define SD_LAST_BUGGY_SECTORS	8
35 
36 enum {
37 	SD_EXT_CDB_SIZE = 32,	/* Extended CDB size */
38 	SD_MEMPOOL_SIZE = 2,	/* CDB pool size */
39 };
40 
41 enum {
42 	SD_LBP_FULL = 0,	/* Full logical block provisioning */
43 	SD_LBP_UNMAP,		/* Use UNMAP command */
44 	SD_LBP_WS16,		/* Use WRITE SAME(16) with UNMAP bit */
45 	SD_LBP_WS10,		/* Use WRITE SAME(10) with UNMAP bit */
46 	SD_LBP_ZERO,		/* Use WRITE SAME(10) with zero payload */
47 	SD_LBP_DISABLE,		/* Discard disabled due to failed cmd */
48 };
49 
50 struct scsi_disk {
51 	struct scsi_driver *driver;	/* always &sd_template */
52 	struct scsi_device *device;
53 	struct device	dev;
54 	struct gendisk	*disk;
55 	atomic_t	openers;
56 	sector_t	capacity;	/* size in 512-byte sectors */
57 	u32		max_ws_blocks;
58 	u32		max_unmap_blocks;
59 	u32		unmap_granularity;
60 	u32		unmap_alignment;
61 	u32		index;
62 	unsigned int	physical_block_size;
63 	unsigned int	max_medium_access_timeouts;
64 	unsigned int	medium_access_timed_out;
65 	u8		media_present;
66 	u8		write_prot;
67 	u8		protection_type;/* Data Integrity Field */
68 	u8		provisioning_mode;
69 	unsigned	ATO : 1;	/* state of disk ATO bit */
70 	unsigned	WCE : 1;	/* state of disk WCE bit */
71 	unsigned	RCD : 1;	/* state of disk RCD bit, unused */
72 	unsigned	DPOFUA : 1;	/* state of disk DPOFUA bit */
73 	unsigned	first_scan : 1;
74 	unsigned	lbpme : 1;
75 	unsigned	lbprz : 1;
76 	unsigned	lbpu : 1;
77 	unsigned	lbpws : 1;
78 	unsigned	lbpws10 : 1;
79 	unsigned	lbpvpd : 1;
80 };
81 #define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
82 
83 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
84 {
85 	return container_of(disk->private_data, struct scsi_disk, driver);
86 }
87 
88 #define sd_printk(prefix, sdsk, fmt, a...)				\
89         (sdsk)->disk ?							\
90 	sdev_printk(prefix, (sdsk)->device, "[%s] " fmt,		\
91 		    (sdsk)->disk->disk_name, ##a) :			\
92 	sdev_printk(prefix, (sdsk)->device, fmt, ##a)
93 
94 static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
95 {
96 	switch (scmd->cmnd[0]) {
97 	case READ_6:
98 	case READ_10:
99 	case READ_12:
100 	case READ_16:
101 	case SYNCHRONIZE_CACHE:
102 	case VERIFY:
103 	case VERIFY_12:
104 	case VERIFY_16:
105 	case WRITE_6:
106 	case WRITE_10:
107 	case WRITE_12:
108 	case WRITE_16:
109 	case WRITE_SAME:
110 	case WRITE_SAME_16:
111 	case UNMAP:
112 		return 1;
113 	case VARIABLE_LENGTH_CMD:
114 		switch (scmd->cmnd[9]) {
115 		case READ_32:
116 		case VERIFY_32:
117 		case WRITE_32:
118 		case WRITE_SAME_32:
119 			return 1;
120 		}
121 	}
122 
123 	return 0;
124 }
125 
126 /*
127  * A DIF-capable target device can be formatted with different
128  * protection schemes.  Currently 0 through 3 are defined:
129  *
130  * Type 0 is regular (unprotected) I/O
131  *
132  * Type 1 defines the contents of the guard and reference tags
133  *
134  * Type 2 defines the contents of the guard and reference tags and
135  * uses 32-byte commands to seed the latter
136  *
137  * Type 3 defines the contents of the guard tag only
138  */
139 
140 enum sd_dif_target_protection_types {
141 	SD_DIF_TYPE0_PROTECTION = 0x0,
142 	SD_DIF_TYPE1_PROTECTION = 0x1,
143 	SD_DIF_TYPE2_PROTECTION = 0x2,
144 	SD_DIF_TYPE3_PROTECTION = 0x3,
145 };
146 
147 /*
148  * Data Integrity Field tuple.
149  */
150 struct sd_dif_tuple {
151        __be16 guard_tag;	/* Checksum */
152        __be16 app_tag;		/* Opaque storage */
153        __be32 ref_tag;		/* Target LBA or indirect LBA */
154 };
155 
156 #ifdef CONFIG_BLK_DEV_INTEGRITY
157 
158 extern void sd_dif_config_host(struct scsi_disk *);
159 extern int sd_dif_prepare(struct request *rq, sector_t, unsigned int);
160 extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
161 
162 #else /* CONFIG_BLK_DEV_INTEGRITY */
163 
164 static inline void sd_dif_config_host(struct scsi_disk *disk)
165 {
166 }
167 static inline int sd_dif_prepare(struct request *rq, sector_t s, unsigned int a)
168 {
169 	return 0;
170 }
171 static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
172 {
173 }
174 
175 #endif /* CONFIG_BLK_DEV_INTEGRITY */
176 
177 #endif /* _SCSI_DISK_H */
178