1 #ifndef _SCSI_SCSI_CMND_H
2 #define _SCSI_SCSI_CMND_H
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>
16 #include <scsi/scsi_device.h>
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
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
35 struct scsi_data_buffer {
36 struct sg_table table;
41 /* embedded in scsi_cmnd */
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 */
48 dma_addr_t dma_handle;
52 volatile int have_data_in;
53 volatile int sent_command;
58 #define SCMD_TAGGED (1 << 0)
59 #define SCMD_UNCHECKED_ISA_DMA (1 << 1)
60 #define SCMD_INITIALIZED (1 << 3)
61 /* flags preserved across unprep / reprep */
62 #define SCMD_PRESERVED_FLAGS (SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)
65 struct scsi_request req;
66 struct scsi_device *device;
67 struct list_head list; /* scsi_cmnd participates in queue lists */
68 struct list_head eh_entry; /* entry for the host eh_cmd_q */
69 struct delayed_work abort_work;
70 int eh_eflags; /* Used by error handlr */
73 * A SCSI Command is assigned a nonzero serial_number before passed
74 * to the driver's queue command function. The serial_number is
75 * cleared when scsi_done is entered indicating that the command
76 * has been completed. It is a bug for LLDDs to use this number
77 * for purposes other than printk (and even that is only useful
80 unsigned long serial_number;
83 * This is set to jiffies as it was when the command was first
84 * allocated. It is used to time how long the command has
87 unsigned long jiffies_at_alloc;
92 unsigned char prot_op;
93 unsigned char prot_type;
94 unsigned char prot_flags;
96 unsigned short cmd_len;
97 enum dma_data_direction sc_data_direction;
99 /* These elements define the operation we are about to perform */
103 /* These elements define the operation we ultimately want to perform */
104 struct scsi_data_buffer sdb;
105 struct scsi_data_buffer *prot_sdb;
107 unsigned underflow; /* Return error if less than
108 this amount is transferred */
110 unsigned transfersize; /* How much we are guaranteed to
111 transfer with each SCSI transfer
112 (ie, between disconnect /
113 reconnects. Probably == sector
116 struct request *request; /* The command we are
119 #define SCSI_SENSE_BUFFERSIZE 96
120 unsigned char *sense_buffer;
121 /* obtained by REQUEST SENSE when
122 * CHECK CONDITION is received on original
123 * command (auto-sense) */
125 /* Low-level done function - can be used by low-level driver to point
126 * to completion function. Not used by mid/upper level code. */
127 void (*scsi_done) (struct scsi_cmnd *);
130 * The following fields can be written to by the host specific code.
131 * Everything else should be left alone.
133 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
135 unsigned char *host_scribble; /* The host adapter is allowed to
136 * call scsi_malloc and get some memory
137 * and hang it here. The host adapter
138 * is also expected to call scsi_free
139 * to release this memory. (The memory
140 * obtained by scsi_malloc is guaranteed
141 * to be at an address < 16Mb). */
143 int result; /* Status code from lower level driver */
144 int flags; /* Command flags */
146 unsigned char tag; /* SCSI-II queued command tag */
150 * Return the driver private allocation behind the command.
151 * Only works if cmd_size is set in the host template.
153 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
158 /* make sure not to use it with passthrough commands */
159 static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
161 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
164 extern void scsi_put_command(struct scsi_cmnd *);
165 extern void scsi_finish_command(struct scsi_cmnd *cmd);
167 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
168 size_t *offset, size_t *len);
169 extern void scsi_kunmap_atomic_sg(void *virt);
171 extern int scsi_init_io(struct scsi_cmnd *cmd);
172 extern void scsi_initialize_rq(struct request *rq);
174 extern int scsi_dma_map(struct scsi_cmnd *cmd);
175 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
177 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
179 return cmd->sdb.table.nents;
182 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
184 return cmd->sdb.table.sgl;
187 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
189 return cmd->sdb.length;
192 static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
194 cmd->sdb.resid = resid;
197 static inline int scsi_get_resid(struct scsi_cmnd *cmd)
199 return cmd->sdb.resid;
202 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
203 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
205 static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
207 return blk_bidi_rq(cmd->request) &&
208 (cmd->request->next_rq->special != NULL);
211 static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
213 return scsi_bidi_cmnd(cmd) ?
214 cmd->request->next_rq->special : &cmd->sdb;
217 static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
222 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
223 void *buf, int buflen)
225 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
229 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
230 void *buf, int buflen)
232 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
237 * The operations below are hints that tell the controller driver how
238 * to handle I/Os with DIF or similar types of protection information.
240 enum scsi_prot_operations {
242 SCSI_PROT_NORMAL = 0,
244 /* OS-HBA: Protected, HBA-Target: Unprotected */
245 SCSI_PROT_READ_INSERT,
246 SCSI_PROT_WRITE_STRIP,
248 /* OS-HBA: Unprotected, HBA-Target: Protected */
249 SCSI_PROT_READ_STRIP,
250 SCSI_PROT_WRITE_INSERT,
252 /* OS-HBA: Protected, HBA-Target: Protected */
254 SCSI_PROT_WRITE_PASS,
257 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
262 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
264 return scmd->prot_op;
267 enum scsi_prot_flags {
268 SCSI_PROT_TRANSFER_PI = 1 << 0,
269 SCSI_PROT_GUARD_CHECK = 1 << 1,
270 SCSI_PROT_REF_CHECK = 1 << 2,
271 SCSI_PROT_REF_INCREMENT = 1 << 3,
272 SCSI_PROT_IP_CHECKSUM = 1 << 4,
276 * The controller usually does not know anything about the target it
277 * is communicating with. However, when DIX is enabled the controller
278 * must be know target type so it can verify the protection
279 * information passed along with the I/O.
281 enum scsi_prot_target_type {
282 SCSI_PROT_DIF_TYPE0 = 0,
288 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
290 scmd->prot_type = type;
293 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
295 return scmd->prot_type;
298 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
300 return blk_rq_pos(scmd->request);
303 static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
305 return scmd->device->sector_size;
308 static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
310 return blk_rq_pos(scmd->request) >>
311 (ilog2(scsi_prot_interval(scmd)) - 9) & 0xffffffff;
314 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
316 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
319 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
321 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
324 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
326 return cmd->prot_sdb;
329 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
330 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
332 static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
334 cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
337 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
339 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
342 static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
344 cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
347 static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
349 unsigned int xfer_len = scsi_out(scmd)->length;
350 unsigned int prot_interval = scsi_prot_interval(scmd);
352 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
353 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
358 #endif /* _SCSI_SCSI_CMND_H */