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