1
2#ifndef _SCSI_SCSI_CMND_H
3#define _SCSI_SCSI_CMND_H
4
5#include <linux/dma-mapping.h>
6#include <linux/blkdev.h>
7#include <linux/t10-pi.h>
8#include <linux/list.h>
9#include <linux/types.h>
10#include <linux/timer.h>
11#include <linux/scatterlist.h>
12#include <scsi/scsi_device.h>
13#include <scsi/scsi_request.h>
14
15struct Scsi_Host;
16struct scsi_driver;
17
18
19
20
21
22
23
24
25
26
27
28
29
30#define MAX_COMMAND_SIZE 16
31#if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
32# error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
33#endif
34
35struct scsi_data_buffer {
36 struct sg_table table;
37 unsigned length;
38};
39
40
41struct scsi_pointer {
42 char *ptr;
43 int this_residual;
44 struct scatterlist *buffer;
45 int buffers_residual;
46
47 dma_addr_t dma_handle;
48
49 volatile int Status;
50 volatile int Message;
51 volatile int have_data_in;
52 volatile int sent_command;
53 volatile int phase;
54};
55
56
57#define SCMD_TAGGED (1 << 0)
58#define SCMD_INITIALIZED (1 << 1)
59#define SCMD_LAST (1 << 2)
60
61#define SCMD_PRESERVED_FLAGS (SCMD_INITIALIZED)
62
63
64#define SCMD_STATE_COMPLETE 0
65#define SCMD_STATE_INFLIGHT 1
66
67enum scsi_cmnd_submitter {
68 SUBMITTED_BY_BLOCK_LAYER = 0,
69 SUBMITTED_BY_SCSI_ERROR_HANDLER = 1,
70 SUBMITTED_BY_SCSI_RESET_IOCTL = 2,
71} __packed;
72
73struct scsi_cmnd {
74 struct scsi_request req;
75 struct scsi_device *device;
76 struct list_head eh_entry;
77 struct delayed_work abort_work;
78
79 struct rcu_head rcu;
80
81 int eh_eflags;
82
83 int budget_token;
84
85
86
87
88
89
90 unsigned long jiffies_at_alloc;
91
92 int retries;
93 int allowed;
94
95 unsigned char prot_op;
96 unsigned char prot_type;
97 unsigned char prot_flags;
98 enum scsi_cmnd_submitter submitter;
99
100 unsigned short cmd_len;
101 enum dma_data_direction sc_data_direction;
102
103
104 unsigned char *cmnd;
105
106
107
108 struct scsi_data_buffer sdb;
109 struct scsi_data_buffer *prot_sdb;
110
111 unsigned underflow;
112
113
114 unsigned transfersize;
115
116
117
118
119
120 unsigned char *sense_buffer;
121
122
123
124
125
126
127
128
129
130 struct scsi_pointer SCp;
131
132 unsigned char *host_scribble;
133
134
135
136
137
138
139
140 int result;
141 int flags;
142 unsigned long state;
143
144 unsigned int extra_len;
145};
146
147
148static inline struct request *scsi_cmd_to_rq(struct scsi_cmnd *scmd)
149{
150 return blk_mq_rq_from_pdu(scmd);
151}
152
153
154
155
156
157static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
158{
159 return cmd + 1;
160}
161
162
163static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
164{
165 struct request *rq = scsi_cmd_to_rq(cmd);
166
167 return *(struct scsi_driver **)rq->rq_disk->private_data;
168}
169
170void scsi_done(struct scsi_cmnd *cmd);
171
172extern void scsi_finish_command(struct scsi_cmnd *cmd);
173
174extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
175 size_t *offset, size_t *len);
176extern void scsi_kunmap_atomic_sg(void *virt);
177
178blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
179void scsi_free_sgtables(struct scsi_cmnd *cmd);
180
181#ifdef CONFIG_SCSI_DMA
182extern int scsi_dma_map(struct scsi_cmnd *cmd);
183extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
184#else
185static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
186static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
187#endif
188
189static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
190{
191 return cmd->sdb.table.nents;
192}
193
194static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
195{
196 return cmd->sdb.table.sgl;
197}
198
199static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
200{
201 return cmd->sdb.length;
202}
203
204static inline void scsi_set_resid(struct scsi_cmnd *cmd, unsigned int resid)
205{
206 cmd->req.resid_len = resid;
207}
208
209static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
210{
211 return cmd->req.resid_len;
212}
213
214#define scsi_for_each_sg(cmd, sg, nseg, __i) \
215 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
216
217static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
218 void *buf, int buflen)
219{
220 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
221 buf, buflen);
222}
223
224static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
225 void *buf, int buflen)
226{
227 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
228 buf, buflen);
229}
230
231static inline sector_t scsi_get_sector(struct scsi_cmnd *scmd)
232{
233 return blk_rq_pos(scsi_cmd_to_rq(scmd));
234}
235
236static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
237{
238 unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
239
240 return blk_rq_pos(scsi_cmd_to_rq(scmd)) >> shift;
241}
242
243static inline unsigned int scsi_logical_block_count(struct scsi_cmnd *scmd)
244{
245 unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
246
247 return blk_rq_bytes(scsi_cmd_to_rq(scmd)) >> shift;
248}
249
250
251
252
253
254enum scsi_prot_operations {
255
256 SCSI_PROT_NORMAL = 0,
257
258
259 SCSI_PROT_READ_INSERT,
260 SCSI_PROT_WRITE_STRIP,
261
262
263 SCSI_PROT_READ_STRIP,
264 SCSI_PROT_WRITE_INSERT,
265
266
267 SCSI_PROT_READ_PASS,
268 SCSI_PROT_WRITE_PASS,
269};
270
271static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
272{
273 scmd->prot_op = op;
274}
275
276static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
277{
278 return scmd->prot_op;
279}
280
281enum scsi_prot_flags {
282 SCSI_PROT_TRANSFER_PI = 1 << 0,
283 SCSI_PROT_GUARD_CHECK = 1 << 1,
284 SCSI_PROT_REF_CHECK = 1 << 2,
285 SCSI_PROT_REF_INCREMENT = 1 << 3,
286 SCSI_PROT_IP_CHECKSUM = 1 << 4,
287};
288
289
290
291
292
293
294
295enum scsi_prot_target_type {
296 SCSI_PROT_DIF_TYPE0 = 0,
297 SCSI_PROT_DIF_TYPE1,
298 SCSI_PROT_DIF_TYPE2,
299 SCSI_PROT_DIF_TYPE3,
300};
301
302static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
303{
304 scmd->prot_type = type;
305}
306
307static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
308{
309 return scmd->prot_type;
310}
311
312static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
313{
314 struct request *rq = blk_mq_rq_from_pdu(scmd);
315
316 return t10_pi_ref_tag(rq);
317}
318
319static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
320{
321 return scmd->device->sector_size;
322}
323
324static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
325{
326 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
327}
328
329static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
330{
331 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
332}
333
334static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
335{
336 return cmd->prot_sdb;
337}
338
339#define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
340 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
341
342static inline void set_status_byte(struct scsi_cmnd *cmd, char status)
343{
344 cmd->result = (cmd->result & 0xffffff00) | status;
345}
346
347static inline u8 get_status_byte(struct scsi_cmnd *cmd)
348{
349 return cmd->result & 0xff;
350}
351
352static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
353{
354 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
355}
356
357static inline u8 get_host_byte(struct scsi_cmnd *cmd)
358{
359 return (cmd->result >> 16) & 0xff;
360}
361
362
363
364
365
366
367
368
369
370
371
372static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
373{
374 switch (msg) {
375 case COMMAND_COMPLETE:
376 break;
377 case ABORT_TASK_SET:
378 set_host_byte(cmd, DID_ABORT);
379 break;
380 case TARGET_RESET:
381 set_host_byte(cmd, DID_RESET);
382 break;
383 default:
384 set_host_byte(cmd, DID_ERROR);
385 break;
386 }
387}
388
389static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
390{
391 unsigned int xfer_len = scmd->sdb.length;
392 unsigned int prot_interval = scsi_prot_interval(scmd);
393
394 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
395 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
396
397 return xfer_len;
398}
399
400extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
401 u8 key, u8 asc, u8 ascq);
402
403struct request *scsi_alloc_request(struct request_queue *q,
404 unsigned int op, blk_mq_req_flags_t flags);
405
406#endif
407