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>
16 * MAX_COMMAND_SIZE is:
17 * The longest fixed-length SCSI CDB as per the SCSI standard.
18 * fixed-length means: commands that their size can be determined
19 * by their opcode and the CDB does not carry a length specifier, (unlike
20 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
21 * true and the SCSI standard also defines extended commands and
22 * vendor specific commands that can be bigger than 16 bytes. The kernel
23 * will support these using the same infrastructure used for VARLEN CDB's.
24 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
25 * supports without specifying a cmd_len by ULD's
27 #define MAX_COMMAND_SIZE 16
28 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
29 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
32 struct scsi_data_buffer {
33 struct sg_table table;
38 /* embedded in scsi_cmnd */
40 char *ptr; /* data pointer */
41 int this_residual; /* left in this buffer */
42 struct scatterlist *buffer; /* which buffer */
43 int buffers_residual; /* how many buffers left */
45 dma_addr_t dma_handle;
49 volatile int have_data_in;
50 volatile int sent_command;
55 struct scsi_device *device;
56 struct list_head list; /* scsi_cmnd participates in queue lists */
57 struct list_head eh_entry; /* entry for the host eh_cmd_q */
58 struct delayed_work abort_work;
59 int eh_eflags; /* Used by error handlr */
62 * A SCSI Command is assigned a nonzero serial_number before passed
63 * to the driver's queue command function. The serial_number is
64 * cleared when scsi_done is entered indicating that the command
65 * has been completed. It is a bug for LLDDs to use this number
66 * for purposes other than printk (and even that is only useful
69 unsigned long serial_number;
72 * This is set to jiffies as it was when the command was first
73 * allocated. It is used to time how long the command has
76 unsigned long jiffies_at_alloc;
81 unsigned char prot_op;
82 unsigned char prot_type;
84 unsigned short cmd_len;
85 enum dma_data_direction sc_data_direction;
87 /* These elements define the operation we are about to perform */
91 /* These elements define the operation we ultimately want to perform */
92 struct scsi_data_buffer sdb;
93 struct scsi_data_buffer *prot_sdb;
95 unsigned underflow; /* Return error if less than
96 this amount is transferred */
98 unsigned transfersize; /* How much we are guaranteed to
99 transfer with each SCSI transfer
100 (ie, between disconnect /
101 reconnects. Probably == sector
104 struct request *request; /* The command we are
107 #define SCSI_SENSE_BUFFERSIZE 96
108 unsigned char *sense_buffer;
109 /* obtained by REQUEST SENSE when
110 * CHECK CONDITION is received on original
111 * command (auto-sense) */
113 /* Low-level done function - can be used by low-level driver to point
114 * to completion function. Not used by mid/upper level code. */
115 void (*scsi_done) (struct scsi_cmnd *);
118 * The following fields can be written to by the host specific code.
119 * Everything else should be left alone.
121 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
123 unsigned char *host_scribble; /* The host adapter is allowed to
124 * call scsi_malloc and get some memory
125 * and hang it here. The host adapter
126 * is also expected to call scsi_free
127 * to release this memory. (The memory
128 * obtained by scsi_malloc is guaranteed
129 * to be at an address < 16Mb). */
131 int result; /* Status code from lower level driver */
133 unsigned char tag; /* SCSI-II queued command tag */
137 * Return the driver private allocation behind the command.
138 * Only works if cmd_size is set in the host template.
140 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
145 /* make sure not to use it with REQ_TYPE_BLOCK_PC commands */
146 static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
148 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
151 extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
152 extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
153 extern void scsi_put_command(struct scsi_cmnd *);
154 extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *);
155 extern void scsi_finish_command(struct scsi_cmnd *cmd);
157 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
158 size_t *offset, size_t *len);
159 extern void scsi_kunmap_atomic_sg(void *virt);
161 extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask);
162 extern void scsi_release_buffers(struct scsi_cmnd *cmd);
164 extern int scsi_dma_map(struct scsi_cmnd *cmd);
165 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
167 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
169 return cmd->sdb.table.nents;
172 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
174 return cmd->sdb.table.sgl;
177 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
179 return cmd->sdb.length;
182 static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
184 cmd->sdb.resid = resid;
187 static inline int scsi_get_resid(struct scsi_cmnd *cmd)
189 return cmd->sdb.resid;
192 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
193 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
195 static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
197 return blk_bidi_rq(cmd->request) &&
198 (cmd->request->next_rq->special != NULL);
201 static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
203 return scsi_bidi_cmnd(cmd) ?
204 cmd->request->next_rq->special : &cmd->sdb;
207 static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
212 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
213 void *buf, int buflen)
215 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
219 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
220 void *buf, int buflen)
222 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
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.
230 enum scsi_prot_operations {
232 SCSI_PROT_NORMAL = 0,
234 /* OS-HBA: Protected, HBA-Target: Unprotected */
235 SCSI_PROT_READ_INSERT,
236 SCSI_PROT_WRITE_STRIP,
238 /* OS-HBA: Unprotected, HBA-Target: Protected */
239 SCSI_PROT_READ_STRIP,
240 SCSI_PROT_WRITE_INSERT,
242 /* OS-HBA: Protected, HBA-Target: Protected */
244 SCSI_PROT_WRITE_PASS,
247 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
252 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
254 return scmd->prot_op;
258 * The controller usually does not know anything about the target it
259 * is communicating with. However, when DIX is enabled the controller
260 * must be know target type so it can verify the protection
261 * information passed along with the I/O.
263 enum scsi_prot_target_type {
264 SCSI_PROT_DIF_TYPE0 = 0,
270 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
272 scmd->prot_type = type;
275 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
277 return scmd->prot_type;
280 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
282 return blk_rq_pos(scmd->request);
285 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
287 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
290 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
292 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
295 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
297 return cmd->prot_sdb;
300 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
301 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
303 static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
305 cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
308 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
310 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
313 static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
315 cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
318 #endif /* _SCSI_SCSI_CMND_H */