1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _SCSI_SCSI_CMND_H
3 #define _SCSI_SCSI_CMND_H
5 #include <linux/dma-mapping.h>
6 #include <linux/blkdev.h>
7 #include <linux/list.h>
8 #include <linux/types.h>
9 #include <linux/timer.h>
10 #include <linux/scatterlist.h>
11 #include <scsi/scsi_device.h>
12 #include <scsi/scsi_request.h>
17 #include <scsi/scsi_device.h>
20 * MAX_COMMAND_SIZE is:
21 * The longest fixed-length SCSI CDB as per the SCSI standard.
22 * fixed-length means: commands that their size can be determined
23 * by their opcode and the CDB does not carry a length specifier, (unlike
24 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
25 * true and the SCSI standard also defines extended commands and
26 * vendor specific commands that can be bigger than 16 bytes. The kernel
27 * will support these using the same infrastructure used for VARLEN CDB's.
28 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
29 * supports without specifying a cmd_len by ULD's
31 #define MAX_COMMAND_SIZE 16
32 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
33 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
36 struct scsi_data_buffer
{
37 struct sg_table table
;
42 /* embedded in scsi_cmnd */
44 char *ptr
; /* data pointer */
45 int this_residual
; /* left in this buffer */
46 struct scatterlist
*buffer
; /* which buffer */
47 int buffers_residual
; /* how many buffers left */
49 dma_addr_t dma_handle
;
53 volatile int have_data_in
;
54 volatile int sent_command
;
59 #define SCMD_TAGGED (1 << 0)
60 #define SCMD_UNCHECKED_ISA_DMA (1 << 1)
61 #define SCMD_ZONE_WRITE_LOCK (1 << 2)
62 #define SCMD_INITIALIZED (1 << 3)
63 /* flags preserved across unprep / reprep */
64 #define SCMD_PRESERVED_FLAGS (SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)
67 struct scsi_request req
;
68 struct scsi_device
*device
;
69 struct list_head list
; /* scsi_cmnd participates in queue lists */
70 struct list_head eh_entry
; /* entry for the host eh_cmd_q */
71 struct delayed_work abort_work
;
72 int eh_eflags
; /* Used by error handlr */
75 * A SCSI Command is assigned a nonzero serial_number before passed
76 * to the driver's queue command function. The serial_number is
77 * cleared when scsi_done is entered indicating that the command
78 * has been completed. It is a bug for LLDDs to use this number
79 * for purposes other than printk (and even that is only useful
82 unsigned long serial_number
;
85 * This is set to jiffies as it was when the command was first
86 * allocated. It is used to time how long the command has
89 unsigned long jiffies_at_alloc
;
94 unsigned char prot_op
;
95 unsigned char prot_type
;
96 unsigned char prot_flags
;
98 unsigned short cmd_len
;
99 enum dma_data_direction sc_data_direction
;
101 /* These elements define the operation we are about to perform */
105 /* These elements define the operation we ultimately want to perform */
106 struct scsi_data_buffer sdb
;
107 struct scsi_data_buffer
*prot_sdb
;
109 unsigned underflow
; /* Return error if less than
110 this amount is transferred */
112 unsigned transfersize
; /* How much we are guaranteed to
113 transfer with each SCSI transfer
114 (ie, between disconnect /
115 reconnects. Probably == sector
118 struct request
*request
; /* The command we are
121 #define SCSI_SENSE_BUFFERSIZE 96
122 unsigned char *sense_buffer
;
123 /* obtained by REQUEST SENSE when
124 * CHECK CONDITION is received on original
125 * command (auto-sense) */
127 /* Low-level done function - can be used by low-level driver to point
128 * to completion function. Not used by mid/upper level code. */
129 void (*scsi_done
) (struct scsi_cmnd
*);
132 * The following fields can be written to by the host specific code.
133 * Everything else should be left alone.
135 struct scsi_pointer SCp
; /* Scratchpad used by some host adapters */
137 unsigned char *host_scribble
; /* The host adapter is allowed to
138 * call scsi_malloc and get some memory
139 * and hang it here. The host adapter
140 * is also expected to call scsi_free
141 * to release this memory. (The memory
142 * obtained by scsi_malloc is guaranteed
143 * to be at an address < 16Mb). */
145 int result
; /* Status code from lower level driver */
146 int flags
; /* Command flags */
148 unsigned char tag
; /* SCSI-II queued command tag */
152 * Return the driver private allocation behind the command.
153 * Only works if cmd_size is set in the host template.
155 static inline void *scsi_cmd_priv(struct scsi_cmnd
*cmd
)
160 /* make sure not to use it with passthrough commands */
161 static inline struct scsi_driver
*scsi_cmd_to_driver(struct scsi_cmnd
*cmd
)
163 return *(struct scsi_driver
**)cmd
->request
->rq_disk
->private_data
;
166 extern void scsi_put_command(struct scsi_cmnd
*);
167 extern void scsi_finish_command(struct scsi_cmnd
*cmd
);
169 extern void *scsi_kmap_atomic_sg(struct scatterlist
*sg
, int sg_count
,
170 size_t *offset
, size_t *len
);
171 extern void scsi_kunmap_atomic_sg(void *virt
);
173 extern int scsi_init_io(struct scsi_cmnd
*cmd
);
174 extern void scsi_initialize_rq(struct request
*rq
);
176 extern int scsi_dma_map(struct scsi_cmnd
*cmd
);
177 extern void scsi_dma_unmap(struct scsi_cmnd
*cmd
);
179 static inline unsigned scsi_sg_count(struct scsi_cmnd
*cmd
)
181 return cmd
->sdb
.table
.nents
;
184 static inline struct scatterlist
*scsi_sglist(struct scsi_cmnd
*cmd
)
186 return cmd
->sdb
.table
.sgl
;
189 static inline unsigned scsi_bufflen(struct scsi_cmnd
*cmd
)
191 return cmd
->sdb
.length
;
194 static inline void scsi_set_resid(struct scsi_cmnd
*cmd
, int resid
)
196 cmd
->sdb
.resid
= resid
;
199 static inline int scsi_get_resid(struct scsi_cmnd
*cmd
)
201 return cmd
->sdb
.resid
;
204 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
205 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
207 static inline int scsi_bidi_cmnd(struct scsi_cmnd
*cmd
)
209 return blk_bidi_rq(cmd
->request
) &&
210 (cmd
->request
->next_rq
->special
!= NULL
);
213 static inline struct scsi_data_buffer
*scsi_in(struct scsi_cmnd
*cmd
)
215 return scsi_bidi_cmnd(cmd
) ?
216 cmd
->request
->next_rq
->special
: &cmd
->sdb
;
219 static inline struct scsi_data_buffer
*scsi_out(struct scsi_cmnd
*cmd
)
224 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd
*cmd
,
225 void *buf
, int buflen
)
227 return sg_copy_from_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
231 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd
*cmd
,
232 void *buf
, int buflen
)
234 return sg_copy_to_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
239 * The operations below are hints that tell the controller driver how
240 * to handle I/Os with DIF or similar types of protection information.
242 enum scsi_prot_operations
{
244 SCSI_PROT_NORMAL
= 0,
246 /* OS-HBA: Protected, HBA-Target: Unprotected */
247 SCSI_PROT_READ_INSERT
,
248 SCSI_PROT_WRITE_STRIP
,
250 /* OS-HBA: Unprotected, HBA-Target: Protected */
251 SCSI_PROT_READ_STRIP
,
252 SCSI_PROT_WRITE_INSERT
,
254 /* OS-HBA: Protected, HBA-Target: Protected */
256 SCSI_PROT_WRITE_PASS
,
259 static inline void scsi_set_prot_op(struct scsi_cmnd
*scmd
, unsigned char op
)
264 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd
*scmd
)
266 return scmd
->prot_op
;
269 enum scsi_prot_flags
{
270 SCSI_PROT_TRANSFER_PI
= 1 << 0,
271 SCSI_PROT_GUARD_CHECK
= 1 << 1,
272 SCSI_PROT_REF_CHECK
= 1 << 2,
273 SCSI_PROT_REF_INCREMENT
= 1 << 3,
274 SCSI_PROT_IP_CHECKSUM
= 1 << 4,
278 * The controller usually does not know anything about the target it
279 * is communicating with. However, when DIX is enabled the controller
280 * must be know target type so it can verify the protection
281 * information passed along with the I/O.
283 enum scsi_prot_target_type
{
284 SCSI_PROT_DIF_TYPE0
= 0,
290 static inline void scsi_set_prot_type(struct scsi_cmnd
*scmd
, unsigned char type
)
292 scmd
->prot_type
= type
;
295 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd
*scmd
)
297 return scmd
->prot_type
;
300 static inline sector_t
scsi_get_lba(struct scsi_cmnd
*scmd
)
302 return blk_rq_pos(scmd
->request
);
305 static inline unsigned int scsi_prot_interval(struct scsi_cmnd
*scmd
)
307 return scmd
->device
->sector_size
;
310 static inline u32
scsi_prot_ref_tag(struct scsi_cmnd
*scmd
)
312 return blk_rq_pos(scmd
->request
) >>
313 (ilog2(scsi_prot_interval(scmd
)) - 9) & 0xffffffff;
316 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd
*cmd
)
318 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.nents
: 0;
321 static inline struct scatterlist
*scsi_prot_sglist(struct scsi_cmnd
*cmd
)
323 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.sgl
: NULL
;
326 static inline struct scsi_data_buffer
*scsi_prot(struct scsi_cmnd
*cmd
)
328 return cmd
->prot_sdb
;
331 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
332 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
334 static inline void set_msg_byte(struct scsi_cmnd
*cmd
, char status
)
336 cmd
->result
= (cmd
->result
& 0xffff00ff) | (status
<< 8);
339 static inline void set_host_byte(struct scsi_cmnd
*cmd
, char status
)
341 cmd
->result
= (cmd
->result
& 0xff00ffff) | (status
<< 16);
344 static inline void set_driver_byte(struct scsi_cmnd
*cmd
, char status
)
346 cmd
->result
= (cmd
->result
& 0x00ffffff) | (status
<< 24);
349 static inline unsigned scsi_transfer_length(struct scsi_cmnd
*scmd
)
351 unsigned int xfer_len
= scsi_out(scmd
)->length
;
352 unsigned int prot_interval
= scsi_prot_interval(scmd
);
354 if (scmd
->prot_flags
& SCSI_PROT_TRANSFER_PI
)
355 xfer_len
+= (xfer_len
>> ilog2(prot_interval
)) * 8;
360 #endif /* _SCSI_SCSI_CMND_H */