Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _SCSI_SCSI_CMND_H |
3 | #define _SCSI_SCSI_CMND_H | |
4 | ||
5 | #include <linux/dma-mapping.h> | |
6f9a35e2 | 6 | #include <linux/blkdev.h> |
1da177e4 LT |
7 | #include <linux/list.h> |
8 | #include <linux/types.h> | |
4e57b681 | 9 | #include <linux/timer.h> |
c6132da1 | 10 | #include <linux/scatterlist.h> |
8846bab1 | 11 | #include <scsi/scsi_device.h> |
82ed4db4 | 12 | #include <scsi/scsi_request.h> |
1da177e4 | 13 | |
b58d9154 | 14 | struct Scsi_Host; |
18a4d0a2 | 15 | struct scsi_driver; |
1da177e4 | 16 | |
c611529e MP |
17 | #include <scsi/scsi_device.h> |
18 | ||
64a87b24 BH |
19 | /* |
20 | * MAX_COMMAND_SIZE is: | |
21 | * The longest fixed-length SCSI CDB as per the SCSI standard. | |
22 | * fixed-length means: commands that their size can be determined | |
23 | * by their opcode and the CDB does not carry a length specifier, (unlike | |
24 | * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly | |
25 | * true and the SCSI standard also defines extended commands and | |
26 | * vendor specific commands that can be bigger than 16 bytes. The kernel | |
27 | * will support these using the same infrastructure used for VARLEN CDB's. | |
28 | * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml | |
29 | * supports without specifying a cmd_len by ULD's | |
30 | */ | |
31 | #define MAX_COMMAND_SIZE 16 | |
32 | #if (MAX_COMMAND_SIZE > BLK_MAX_CDB) | |
33 | # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB | |
34 | #endif | |
35 | ||
30b0c37b BH |
36 | struct scsi_data_buffer { |
37 | struct sg_table table; | |
38 | unsigned length; | |
39 | int resid; | |
40 | }; | |
1da177e4 LT |
41 | |
42 | /* embedded in scsi_cmnd */ | |
43 | struct scsi_pointer { | |
44 | char *ptr; /* data pointer */ | |
45 | int this_residual; /* left in this buffer */ | |
46 | struct scatterlist *buffer; /* which buffer */ | |
47 | int buffers_residual; /* how many buffers left */ | |
48 | ||
49 | dma_addr_t dma_handle; | |
50 | ||
51 | volatile int Status; | |
52 | volatile int Message; | |
53 | volatile int have_data_in; | |
54 | volatile int sent_command; | |
55 | volatile int phase; | |
56 | }; | |
57 | ||
125c99bc CH |
58 | /* for scmd->flags */ |
59 | #define SCMD_TAGGED (1 << 0) | |
8e688254 | 60 | #define SCMD_UNCHECKED_ISA_DMA (1 << 1) |
39051dd8 | 61 | #define SCMD_INITIALIZED (1 << 2) |
64104f70 BVA |
62 | /* flags preserved across unprep / reprep */ |
63 | #define SCMD_PRESERVED_FLAGS (SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED) | |
125c99bc | 64 | |
1da177e4 | 65 | struct scsi_cmnd { |
82ed4db4 | 66 | struct scsi_request req; |
1da177e4 | 67 | struct scsi_device *device; |
1da177e4 | 68 | struct list_head list; /* scsi_cmnd participates in queue lists */ |
1da177e4 | 69 | struct list_head eh_entry; /* entry for the host eh_cmd_q */ |
e494f6a7 | 70 | struct delayed_work abort_work; |
3be8828f BVA |
71 | |
72 | struct rcu_head rcu; | |
73 | ||
1da177e4 | 74 | int eh_eflags; /* Used by error handlr */ |
1da177e4 LT |
75 | |
76 | /* | |
c6295cdf | 77 | * A SCSI Command is assigned a nonzero serial_number before passed |
78 | * to the driver's queue command function. The serial_number is | |
79 | * cleared when scsi_done is entered indicating that the command | |
12a44162 MW |
80 | * has been completed. It is a bug for LLDDs to use this number |
81 | * for purposes other than printk (and even that is only useful | |
82 | * for debugging). | |
1da177e4 LT |
83 | */ |
84 | unsigned long serial_number; | |
12a44162 | 85 | |
b21a4138 JB |
86 | /* |
87 | * This is set to jiffies as it was when the command was first | |
88 | * allocated. It is used to time how long the command has | |
89 | * been outstanding | |
90 | */ | |
91 | unsigned long jiffies_at_alloc; | |
1da177e4 LT |
92 | |
93 | int retries; | |
94 | int allowed; | |
1da177e4 | 95 | |
db007fc5 MP |
96 | unsigned char prot_op; |
97 | unsigned char prot_type; | |
c611529e | 98 | unsigned char prot_flags; |
db007fc5 | 99 | |
db4742dd | 100 | unsigned short cmd_len; |
1da177e4 | 101 | enum dma_data_direction sc_data_direction; |
1da177e4 LT |
102 | |
103 | /* These elements define the operation we are about to perform */ | |
64a87b24 | 104 | unsigned char *cmnd; |
1da177e4 | 105 | |
1da177e4 LT |
106 | |
107 | /* These elements define the operation we ultimately want to perform */ | |
30b0c37b | 108 | struct scsi_data_buffer sdb; |
7027ad72 MP |
109 | struct scsi_data_buffer *prot_sdb; |
110 | ||
1da177e4 LT |
111 | unsigned underflow; /* Return error if less than |
112 | this amount is transferred */ | |
1da177e4 LT |
113 | |
114 | unsigned transfersize; /* How much we are guaranteed to | |
115 | transfer with each SCSI transfer | |
116 | (ie, between disconnect / | |
117 | reconnects. Probably == sector | |
118 | size */ | |
119 | ||
1da177e4 LT |
120 | struct request *request; /* The command we are |
121 | working on */ | |
122 | ||
123 | #define SCSI_SENSE_BUFFERSIZE 96 | |
de25deb1 | 124 | unsigned char *sense_buffer; |
c67a848c MW |
125 | /* obtained by REQUEST SENSE when |
126 | * CHECK CONDITION is received on original | |
127 | * command (auto-sense) */ | |
1da177e4 LT |
128 | |
129 | /* Low-level done function - can be used by low-level driver to point | |
130 | * to completion function. Not used by mid/upper level code. */ | |
131 | void (*scsi_done) (struct scsi_cmnd *); | |
132 | ||
133 | /* | |
134 | * The following fields can be written to by the host specific code. | |
135 | * Everything else should be left alone. | |
136 | */ | |
137 | struct scsi_pointer SCp; /* Scratchpad used by some host adapters */ | |
138 | ||
139 | unsigned char *host_scribble; /* The host adapter is allowed to | |
c67a848c MW |
140 | * call scsi_malloc and get some memory |
141 | * and hang it here. The host adapter | |
142 | * is also expected to call scsi_free | |
143 | * to release this memory. (The memory | |
144 | * obtained by scsi_malloc is guaranteed | |
145 | * to be at an address < 16Mb). */ | |
1da177e4 LT |
146 | |
147 | int result; /* Status code from lower level driver */ | |
125c99bc | 148 | int flags; /* Command flags */ |
1da177e4 LT |
149 | |
150 | unsigned char tag; /* SCSI-II queued command tag */ | |
1da177e4 LT |
151 | }; |
152 | ||
b54197c4 CH |
153 | /* |
154 | * Return the driver private allocation behind the command. | |
155 | * Only works if cmd_size is set in the host template. | |
156 | */ | |
157 | static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd) | |
158 | { | |
159 | return cmd + 1; | |
160 | } | |
161 | ||
57292b58 | 162 | /* make sure not to use it with passthrough commands */ |
18a4d0a2 MP |
163 | static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd) |
164 | { | |
329a402c | 165 | return *(struct scsi_driver **)cmd->request->rq_disk->private_data; |
18a4d0a2 MP |
166 | } |
167 | ||
1da177e4 | 168 | extern void scsi_put_command(struct scsi_cmnd *); |
1da177e4 LT |
169 | extern void scsi_finish_command(struct scsi_cmnd *cmd); |
170 | ||
cdb8c2a6 GL |
171 | extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count, |
172 | size_t *offset, size_t *len); | |
173 | extern void scsi_kunmap_atomic_sg(void *virt); | |
174 | ||
3c356bde | 175 | extern int scsi_init_io(struct scsi_cmnd *cmd); |
b58d9154 | 176 | |
824d7b57 FT |
177 | extern int scsi_dma_map(struct scsi_cmnd *cmd); |
178 | extern void scsi_dma_unmap(struct scsi_cmnd *cmd); | |
179 | ||
30b0c37b BH |
180 | static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd) |
181 | { | |
182 | return cmd->sdb.table.nents; | |
183 | } | |
184 | ||
185 | static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd) | |
186 | { | |
187 | return cmd->sdb.table.sgl; | |
188 | } | |
189 | ||
190 | static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd) | |
191 | { | |
192 | return cmd->sdb.length; | |
193 | } | |
824d7b57 FT |
194 | |
195 | static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid) | |
196 | { | |
30b0c37b | 197 | cmd->sdb.resid = resid; |
824d7b57 FT |
198 | } |
199 | ||
200 | static inline int scsi_get_resid(struct scsi_cmnd *cmd) | |
201 | { | |
30b0c37b | 202 | return cmd->sdb.resid; |
824d7b57 FT |
203 | } |
204 | ||
205 | #define scsi_for_each_sg(cmd, sg, nseg, __i) \ | |
c6132da1 | 206 | for_each_sg(scsi_sglist(cmd), sg, nseg, __i) |
824d7b57 | 207 | |
6f9a35e2 BH |
208 | static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd) |
209 | { | |
210 | return blk_bidi_rq(cmd->request) && | |
211 | (cmd->request->next_rq->special != NULL); | |
212 | } | |
213 | ||
214 | static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd) | |
215 | { | |
216 | return scsi_bidi_cmnd(cmd) ? | |
217 | cmd->request->next_rq->special : &cmd->sdb; | |
218 | } | |
219 | ||
220 | static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd) | |
221 | { | |
222 | return &cmd->sdb; | |
223 | } | |
224 | ||
9ac16b61 FT |
225 | static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd, |
226 | void *buf, int buflen) | |
227 | { | |
228 | return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), | |
229 | buf, buflen); | |
230 | } | |
231 | ||
232 | static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd, | |
233 | void *buf, int buflen) | |
234 | { | |
235 | return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), | |
236 | buf, buflen); | |
237 | } | |
238 | ||
db007fc5 MP |
239 | /* |
240 | * The operations below are hints that tell the controller driver how | |
241 | * to handle I/Os with DIF or similar types of protection information. | |
242 | */ | |
243 | enum scsi_prot_operations { | |
244 | /* Normal I/O */ | |
245 | SCSI_PROT_NORMAL = 0, | |
246 | ||
247 | /* OS-HBA: Protected, HBA-Target: Unprotected */ | |
248 | SCSI_PROT_READ_INSERT, | |
249 | SCSI_PROT_WRITE_STRIP, | |
250 | ||
251 | /* OS-HBA: Unprotected, HBA-Target: Protected */ | |
252 | SCSI_PROT_READ_STRIP, | |
253 | SCSI_PROT_WRITE_INSERT, | |
254 | ||
255 | /* OS-HBA: Protected, HBA-Target: Protected */ | |
256 | SCSI_PROT_READ_PASS, | |
257 | SCSI_PROT_WRITE_PASS, | |
db007fc5 MP |
258 | }; |
259 | ||
260 | static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op) | |
261 | { | |
262 | scmd->prot_op = op; | |
263 | } | |
264 | ||
265 | static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd) | |
266 | { | |
267 | return scmd->prot_op; | |
268 | } | |
269 | ||
c611529e MP |
270 | enum scsi_prot_flags { |
271 | SCSI_PROT_TRANSFER_PI = 1 << 0, | |
272 | SCSI_PROT_GUARD_CHECK = 1 << 1, | |
273 | SCSI_PROT_REF_CHECK = 1 << 2, | |
274 | SCSI_PROT_REF_INCREMENT = 1 << 3, | |
275 | SCSI_PROT_IP_CHECKSUM = 1 << 4, | |
276 | }; | |
277 | ||
db007fc5 MP |
278 | /* |
279 | * The controller usually does not know anything about the target it | |
280 | * is communicating with. However, when DIX is enabled the controller | |
281 | * must be know target type so it can verify the protection | |
282 | * information passed along with the I/O. | |
283 | */ | |
284 | enum scsi_prot_target_type { | |
285 | SCSI_PROT_DIF_TYPE0 = 0, | |
286 | SCSI_PROT_DIF_TYPE1, | |
287 | SCSI_PROT_DIF_TYPE2, | |
288 | SCSI_PROT_DIF_TYPE3, | |
289 | }; | |
290 | ||
291 | static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type) | |
292 | { | |
293 | scmd->prot_type = type; | |
294 | } | |
295 | ||
296 | static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd) | |
297 | { | |
298 | return scmd->prot_type; | |
299 | } | |
300 | ||
301 | static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd) | |
302 | { | |
83096ebf | 303 | return blk_rq_pos(scmd->request); |
db007fc5 MP |
304 | } |
305 | ||
c611529e MP |
306 | static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd) |
307 | { | |
308 | return scmd->device->sector_size; | |
309 | } | |
310 | ||
311 | static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd) | |
312 | { | |
313 | return blk_rq_pos(scmd->request) >> | |
314 | (ilog2(scsi_prot_interval(scmd)) - 9) & 0xffffffff; | |
315 | } | |
316 | ||
7027ad72 MP |
317 | static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd) |
318 | { | |
319 | return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0; | |
320 | } | |
321 | ||
322 | static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd) | |
323 | { | |
324 | return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL; | |
325 | } | |
326 | ||
327 | static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd) | |
328 | { | |
329 | return cmd->prot_sdb; | |
330 | } | |
331 | ||
332 | #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \ | |
333 | for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i) | |
334 | ||
f290f197 JB |
335 | static inline void set_msg_byte(struct scsi_cmnd *cmd, char status) |
336 | { | |
3384db9e | 337 | cmd->result = (cmd->result & 0xffff00ff) | (status << 8); |
f290f197 JB |
338 | } |
339 | ||
340 | static inline void set_host_byte(struct scsi_cmnd *cmd, char status) | |
341 | { | |
3384db9e | 342 | cmd->result = (cmd->result & 0xff00ffff) | (status << 16); |
f290f197 JB |
343 | } |
344 | ||
345 | static inline void set_driver_byte(struct scsi_cmnd *cmd, char status) | |
346 | { | |
3384db9e | 347 | cmd->result = (cmd->result & 0x00ffffff) | (status << 24); |
f290f197 JB |
348 | } |
349 | ||
8846bab1 SG |
350 | static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd) |
351 | { | |
5616b0a4 | 352 | unsigned int xfer_len = scsi_out(scmd)->length; |
c611529e | 353 | unsigned int prot_interval = scsi_prot_interval(scmd); |
8846bab1 | 354 | |
c611529e MP |
355 | if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI) |
356 | xfer_len += (xfer_len >> ilog2(prot_interval)) * 8; | |
8846bab1 | 357 | |
c611529e | 358 | return xfer_len; |
8846bab1 SG |
359 | } |
360 | ||
1da177e4 | 361 | #endif /* _SCSI_SCSI_CMND_H */ |