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