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