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>
17 * MAX_COMMAND_SIZE is:
18 * The longest fixed-length SCSI CDB as per the SCSI standard.
19 * fixed-length means: commands that their size can be determined
20 * by their opcode and the CDB does not carry a length specifier, (unlike
21 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
22 * true and the SCSI standard also defines extended commands and
23 * vendor specific commands that can be bigger than 16 bytes. The kernel
24 * will support these using the same infrastructure used for VARLEN CDB's.
25 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
26 * supports without specifying a cmd_len by ULD's
28 #define MAX_COMMAND_SIZE 16
29 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
30 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
33 struct scsi_data_buffer
{
34 struct sg_table table
;
39 /* embedded in scsi_cmnd */
41 char *ptr
; /* data pointer */
42 int this_residual
; /* left in this buffer */
43 struct scatterlist
*buffer
; /* which buffer */
44 int buffers_residual
; /* how many buffers left */
46 dma_addr_t dma_handle
;
50 volatile int have_data_in
;
51 volatile int sent_command
;
56 struct scsi_device
*device
;
57 struct list_head list
; /* scsi_cmnd participates in queue lists */
58 struct list_head eh_entry
; /* entry for the host eh_cmd_q */
59 struct delayed_work abort_work
;
60 int eh_eflags
; /* Used by error handlr */
63 * A SCSI Command is assigned a nonzero serial_number before passed
64 * to the driver's queue command function. The serial_number is
65 * cleared when scsi_done is entered indicating that the command
66 * has been completed. It is a bug for LLDDs to use this number
67 * for purposes other than printk (and even that is only useful
70 unsigned long serial_number
;
73 * This is set to jiffies as it was when the command was first
74 * allocated. It is used to time how long the command has
77 unsigned long jiffies_at_alloc
;
82 unsigned char prot_op
;
83 unsigned char prot_type
;
85 unsigned short cmd_len
;
86 enum dma_data_direction sc_data_direction
;
88 /* These elements define the operation we are about to perform */
92 /* These elements define the operation we ultimately want to perform */
93 struct scsi_data_buffer sdb
;
94 struct scsi_data_buffer
*prot_sdb
;
96 unsigned underflow
; /* Return error if less than
97 this amount is transferred */
99 unsigned transfersize
; /* How much we are guaranteed to
100 transfer with each SCSI transfer
101 (ie, between disconnect /
102 reconnects. Probably == sector
105 struct request
*request
; /* The command we are
108 #define SCSI_SENSE_BUFFERSIZE 96
109 unsigned char *sense_buffer
;
110 /* obtained by REQUEST SENSE when
111 * CHECK CONDITION is received on original
112 * command (auto-sense) */
114 /* Low-level done function - can be used by low-level driver to point
115 * to completion function. Not used by mid/upper level code. */
116 void (*scsi_done
) (struct scsi_cmnd
*);
119 * The following fields can be written to by the host specific code.
120 * Everything else should be left alone.
122 struct scsi_pointer SCp
; /* Scratchpad used by some host adapters */
124 unsigned char *host_scribble
; /* The host adapter is allowed to
125 * call scsi_malloc and get some memory
126 * and hang it here. The host adapter
127 * is also expected to call scsi_free
128 * to release this memory. (The memory
129 * obtained by scsi_malloc is guaranteed
130 * to be at an address < 16Mb). */
132 int result
; /* Status code from lower level driver */
134 unsigned char tag
; /* SCSI-II queued command tag */
138 * Return the driver private allocation behind the command.
139 * Only works if cmd_size is set in the host template.
141 static inline void *scsi_cmd_priv(struct scsi_cmnd
*cmd
)
146 /* make sure not to use it with REQ_TYPE_BLOCK_PC commands */
147 static inline struct scsi_driver
*scsi_cmd_to_driver(struct scsi_cmnd
*cmd
)
149 return *(struct scsi_driver
**)cmd
->request
->rq_disk
->private_data
;
152 extern struct scsi_cmnd
*scsi_get_command(struct scsi_device
*, gfp_t
);
153 extern void scsi_put_command(struct scsi_cmnd
*);
154 extern void scsi_finish_command(struct scsi_cmnd
*cmd
);
156 extern void *scsi_kmap_atomic_sg(struct scatterlist
*sg
, int sg_count
,
157 size_t *offset
, size_t *len
);
158 extern void scsi_kunmap_atomic_sg(void *virt
);
160 extern int scsi_init_io(struct scsi_cmnd
*cmd
, gfp_t gfp_mask
);
162 extern int scsi_dma_map(struct scsi_cmnd
*cmd
);
163 extern void scsi_dma_unmap(struct scsi_cmnd
*cmd
);
165 static inline unsigned scsi_sg_count(struct scsi_cmnd
*cmd
)
167 return cmd
->sdb
.table
.nents
;
170 static inline struct scatterlist
*scsi_sglist(struct scsi_cmnd
*cmd
)
172 return cmd
->sdb
.table
.sgl
;
175 static inline unsigned scsi_bufflen(struct scsi_cmnd
*cmd
)
177 return cmd
->sdb
.length
;
180 static inline void scsi_set_resid(struct scsi_cmnd
*cmd
, int resid
)
182 cmd
->sdb
.resid
= resid
;
185 static inline int scsi_get_resid(struct scsi_cmnd
*cmd
)
187 return cmd
->sdb
.resid
;
190 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
191 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
193 static inline int scsi_bidi_cmnd(struct scsi_cmnd
*cmd
)
195 return blk_bidi_rq(cmd
->request
) &&
196 (cmd
->request
->next_rq
->special
!= NULL
);
199 static inline struct scsi_data_buffer
*scsi_in(struct scsi_cmnd
*cmd
)
201 return scsi_bidi_cmnd(cmd
) ?
202 cmd
->request
->next_rq
->special
: &cmd
->sdb
;
205 static inline struct scsi_data_buffer
*scsi_out(struct scsi_cmnd
*cmd
)
210 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd
*cmd
,
211 void *buf
, int buflen
)
213 return sg_copy_from_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
217 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd
*cmd
,
218 void *buf
, int buflen
)
220 return sg_copy_to_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
225 * The operations below are hints that tell the controller driver how
226 * to handle I/Os with DIF or similar types of protection information.
228 enum scsi_prot_operations
{
230 SCSI_PROT_NORMAL
= 0,
232 /* OS-HBA: Protected, HBA-Target: Unprotected */
233 SCSI_PROT_READ_INSERT
,
234 SCSI_PROT_WRITE_STRIP
,
236 /* OS-HBA: Unprotected, HBA-Target: Protected */
237 SCSI_PROT_READ_STRIP
,
238 SCSI_PROT_WRITE_INSERT
,
240 /* OS-HBA: Protected, HBA-Target: Protected */
242 SCSI_PROT_WRITE_PASS
,
245 static inline void scsi_set_prot_op(struct scsi_cmnd
*scmd
, unsigned char op
)
250 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd
*scmd
)
252 return scmd
->prot_op
;
256 * The controller usually does not know anything about the target it
257 * is communicating with. However, when DIX is enabled the controller
258 * must be know target type so it can verify the protection
259 * information passed along with the I/O.
261 enum scsi_prot_target_type
{
262 SCSI_PROT_DIF_TYPE0
= 0,
268 static inline void scsi_set_prot_type(struct scsi_cmnd
*scmd
, unsigned char type
)
270 scmd
->prot_type
= type
;
273 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd
*scmd
)
275 return scmd
->prot_type
;
278 static inline sector_t
scsi_get_lba(struct scsi_cmnd
*scmd
)
280 return blk_rq_pos(scmd
->request
);
283 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd
*cmd
)
285 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.nents
: 0;
288 static inline struct scatterlist
*scsi_prot_sglist(struct scsi_cmnd
*cmd
)
290 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.sgl
: NULL
;
293 static inline struct scsi_data_buffer
*scsi_prot(struct scsi_cmnd
*cmd
)
295 return cmd
->prot_sdb
;
298 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
299 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
301 static inline void set_msg_byte(struct scsi_cmnd
*cmd
, char status
)
303 cmd
->result
= (cmd
->result
& 0xffff00ff) | (status
<< 8);
306 static inline void set_host_byte(struct scsi_cmnd
*cmd
, char status
)
308 cmd
->result
= (cmd
->result
& 0xff00ffff) | (status
<< 16);
311 static inline void set_driver_byte(struct scsi_cmnd
*cmd
, char status
)
313 cmd
->result
= (cmd
->result
& 0x00ffffff) | (status
<< 24);
316 static inline unsigned scsi_transfer_length(struct scsi_cmnd
*scmd
)
318 unsigned int xfer_len
= scsi_out(scmd
)->length
;
319 unsigned int prot_op
= scsi_get_prot_op(scmd
);
320 unsigned int sector_size
= scmd
->device
->sector_size
;
323 case SCSI_PROT_NORMAL
:
324 case SCSI_PROT_WRITE_STRIP
:
325 case SCSI_PROT_READ_INSERT
:
329 return xfer_len
+ (xfer_len
>> ilog2(sector_size
)) * 8;
332 #endif /* _SCSI_SCSI_CMND_H */