1#ifndef _SCSI_SCSI_CMND_H
2#define _SCSI_SCSI_CMND_H
3
4#include <linux/dma-mapping.h>
5#include <linux/blkdev.h>
6#include <linux/list.h>
7#include <linux/types.h>
8#include <linux/timer.h>
9#include <linux/scatterlist.h>
10#include <scsi/scsi_device.h>
11#include <scsi/scsi_request.h>
12
13struct Scsi_Host;
14struct scsi_driver;
15
16#include <scsi/scsi_device.h>
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 int resid;
39};
40
41
42struct scsi_pointer {
43 char *ptr;
44 int this_residual;
45 struct scatterlist *buffer;
46 int buffers_residual;
47
48 dma_addr_t dma_handle;
49
50 volatile int Status;
51 volatile int Message;
52 volatile int have_data_in;
53 volatile int sent_command;
54 volatile int phase;
55};
56
57
58#define SCMD_TAGGED (1 << 0)
59
60struct scsi_cmnd {
61 struct scsi_request req;
62 struct scsi_device *device;
63 struct list_head list;
64 struct list_head eh_entry;
65 struct delayed_work abort_work;
66 int eh_eflags;
67
68
69
70
71
72
73
74
75
76 unsigned long serial_number;
77
78
79
80
81
82
83 unsigned long jiffies_at_alloc;
84
85 int retries;
86 int allowed;
87
88 unsigned char prot_op;
89 unsigned char prot_type;
90 unsigned char prot_flags;
91
92 unsigned short cmd_len;
93 enum dma_data_direction sc_data_direction;
94
95
96 unsigned char *cmnd;
97
98
99
100 struct scsi_data_buffer sdb;
101 struct scsi_data_buffer *prot_sdb;
102
103 unsigned underflow;
104
105
106 unsigned transfersize;
107
108
109
110
111
112 struct request *request;
113
114
115#define SCSI_SENSE_BUFFERSIZE 96
116 unsigned char *sense_buffer;
117
118
119
120
121
122
123 void (*scsi_done) (struct scsi_cmnd *);
124
125
126
127
128
129 struct scsi_pointer SCp;
130
131 unsigned char *host_scribble;
132
133
134
135
136
137
138
139 int result;
140 int flags;
141
142 unsigned char tag;
143};
144
145
146
147
148
149static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
150{
151 return cmd + 1;
152}
153
154
155static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
156{
157 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
158}
159
160extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
161extern void scsi_put_command(struct scsi_cmnd *);
162extern void scsi_finish_command(struct scsi_cmnd *cmd);
163
164extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
165 size_t *offset, size_t *len);
166extern void scsi_kunmap_atomic_sg(void *virt);
167
168extern int scsi_init_io(struct scsi_cmnd *cmd);
169
170extern int scsi_dma_map(struct scsi_cmnd *cmd);
171extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
172
173static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
174{
175 return cmd->sdb.table.nents;
176}
177
178static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
179{
180 return cmd->sdb.table.sgl;
181}
182
183static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
184{
185 return cmd->sdb.length;
186}
187
188static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
189{
190 cmd->sdb.resid = resid;
191}
192
193static inline int scsi_get_resid(struct scsi_cmnd *cmd)
194{
195 return cmd->sdb.resid;
196}
197
198#define scsi_for_each_sg(cmd, sg, nseg, __i) \
199 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
200
201static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
202{
203 return blk_bidi_rq(cmd->request) &&
204 (cmd->request->next_rq->special != NULL);
205}
206
207static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
208{
209 return scsi_bidi_cmnd(cmd) ?
210 cmd->request->next_rq->special : &cmd->sdb;
211}
212
213static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
214{
215 return &cmd->sdb;
216}
217
218static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
219 void *buf, int buflen)
220{
221 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
222 buf, buflen);
223}
224
225static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
226 void *buf, int buflen)
227{
228 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
229 buf, buflen);
230}
231
232
233
234
235
236enum scsi_prot_operations {
237
238 SCSI_PROT_NORMAL = 0,
239
240
241 SCSI_PROT_READ_INSERT,
242 SCSI_PROT_WRITE_STRIP,
243
244
245 SCSI_PROT_READ_STRIP,
246 SCSI_PROT_WRITE_INSERT,
247
248
249 SCSI_PROT_READ_PASS,
250 SCSI_PROT_WRITE_PASS,
251};
252
253static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
254{
255 scmd->prot_op = op;
256}
257
258static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
259{
260 return scmd->prot_op;
261}
262
263enum scsi_prot_flags {
264 SCSI_PROT_TRANSFER_PI = 1 << 0,
265 SCSI_PROT_GUARD_CHECK = 1 << 1,
266 SCSI_PROT_REF_CHECK = 1 << 2,
267 SCSI_PROT_REF_INCREMENT = 1 << 3,
268 SCSI_PROT_IP_CHECKSUM = 1 << 4,
269};
270
271
272
273
274
275
276
277enum scsi_prot_target_type {
278 SCSI_PROT_DIF_TYPE0 = 0,
279 SCSI_PROT_DIF_TYPE1,
280 SCSI_PROT_DIF_TYPE2,
281 SCSI_PROT_DIF_TYPE3,
282};
283
284static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
285{
286 scmd->prot_type = type;
287}
288
289static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
290{
291 return scmd->prot_type;
292}
293
294static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
295{
296 return blk_rq_pos(scmd->request);
297}
298
299static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
300{
301 return scmd->device->sector_size;
302}
303
304static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
305{
306 return blk_rq_pos(scmd->request) >>
307 (ilog2(scsi_prot_interval(scmd)) - 9) & 0xffffffff;
308}
309
310static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
311{
312 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
313}
314
315static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
316{
317 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
318}
319
320static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
321{
322 return cmd->prot_sdb;
323}
324
325#define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
326 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
327
328static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
329{
330 cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
331}
332
333static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
334{
335 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
336}
337
338static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
339{
340 cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
341}
342
343static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
344{
345 unsigned int xfer_len = scsi_out(scmd)->length;
346 unsigned int prot_interval = scsi_prot_interval(scmd);
347
348 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
349 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
350
351 return xfer_len;
352}
353
354#endif
355