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/t10-pi.h>
8 #include <linux/list.h>
9 #include <linux/types.h>
10 #include <linux/timer.h>
11 #include <linux/scatterlist.h>
12 #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
30 struct scsi_data_buffer
{
31 struct sg_table table
;
35 /* embedded in scsi_cmnd */
37 char *ptr
; /* data pointer */
38 int this_residual
; /* left in this buffer */
39 struct scatterlist
*buffer
; /* which buffer */
40 int buffers_residual
; /* how many buffers left */
42 dma_addr_t dma_handle
;
46 volatile int have_data_in
;
47 volatile int sent_command
;
52 #define SCMD_TAGGED (1 << 0)
53 #define SCMD_INITIALIZED (1 << 1)
54 #define SCMD_LAST (1 << 2)
55 #define SCMD_FAIL_IF_RECOVERING (1 << 4)
56 /* flags preserved across unprep / reprep */
57 #define SCMD_PRESERVED_FLAGS (SCMD_INITIALIZED | SCMD_FAIL_IF_RECOVERING)
60 #define SCMD_STATE_COMPLETE 0
61 #define SCMD_STATE_INFLIGHT 1
63 enum scsi_cmnd_submitter
{
64 SUBMITTED_BY_BLOCK_LAYER
= 0,
65 SUBMITTED_BY_SCSI_ERROR_HANDLER
= 1,
66 SUBMITTED_BY_SCSI_RESET_IOCTL
= 2,
70 struct scsi_device
*device
;
71 struct list_head eh_entry
; /* entry for the host eh_abort_list/eh_cmd_q */
72 struct delayed_work abort_work
;
76 int eh_eflags
; /* Used by error handlr */
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
85 unsigned long jiffies_at_alloc
;
90 unsigned char prot_op
;
91 unsigned char prot_type
;
92 unsigned char prot_flags
;
93 enum scsi_cmnd_submitter submitter
;
95 unsigned short cmd_len
;
96 enum dma_data_direction sc_data_direction
;
98 unsigned char cmnd
[32]; /* SCSI CDB */
100 /* These elements define the operation we ultimately want to perform */
101 struct scsi_data_buffer sdb
;
102 struct scsi_data_buffer
*prot_sdb
;
104 unsigned underflow
; /* Return error if less than
105 this amount is transferred */
107 unsigned transfersize
; /* How much we are guaranteed to
108 transfer with each SCSI transfer
109 (ie, between disconnect /
110 reconnects. Probably == sector
112 unsigned resid_len
; /* residual count */
114 unsigned char *sense_buffer
;
115 /* obtained by REQUEST SENSE when
116 * CHECK CONDITION is received on original
117 * command (auto-sense). Length must be
118 * SCSI_SENSE_BUFFERSIZE bytes. */
120 int flags
; /* Command flags */
121 unsigned long state
; /* Command completion state */
123 unsigned int extra_len
; /* length of alignment and padding */
126 * The fields below can be modified by the LLD but the fields above
127 * must not be modified.
130 unsigned char *host_scribble
; /* The host adapter is allowed to
131 * call scsi_malloc and get some memory
132 * and hang it here. The host adapter
133 * is also expected to call scsi_free
134 * to release this memory. (The memory
135 * obtained by scsi_malloc is guaranteed
136 * to be at an address < 16Mb). */
138 int result
; /* Status code from lower level driver */
141 /* Variant of blk_mq_rq_from_pdu() that verifies the type of its argument. */
142 static inline struct request
*scsi_cmd_to_rq(struct scsi_cmnd
*scmd
)
144 return blk_mq_rq_from_pdu(scmd
);
148 * Return the driver private allocation behind the command.
149 * Only works if cmd_size is set in the host template.
151 static inline void *scsi_cmd_priv(struct scsi_cmnd
*cmd
)
156 void scsi_done(struct scsi_cmnd
*cmd
);
157 void scsi_done_direct(struct scsi_cmnd
*cmd
);
159 extern void scsi_finish_command(struct scsi_cmnd
*cmd
);
161 extern void *scsi_kmap_atomic_sg(struct scatterlist
*sg
, int sg_count
,
162 size_t *offset
, size_t *len
);
163 extern void scsi_kunmap_atomic_sg(void *virt
);
165 blk_status_t
scsi_alloc_sgtables(struct scsi_cmnd
*cmd
);
166 void scsi_free_sgtables(struct scsi_cmnd
*cmd
);
168 #ifdef CONFIG_SCSI_DMA
169 extern int scsi_dma_map(struct scsi_cmnd
*cmd
);
170 extern void scsi_dma_unmap(struct scsi_cmnd
*cmd
);
171 #else /* !CONFIG_SCSI_DMA */
172 static inline int scsi_dma_map(struct scsi_cmnd
*cmd
) { return -ENOSYS
; }
173 static inline void scsi_dma_unmap(struct scsi_cmnd
*cmd
) { }
174 #endif /* !CONFIG_SCSI_DMA */
176 static inline unsigned scsi_sg_count(struct scsi_cmnd
*cmd
)
178 return cmd
->sdb
.table
.nents
;
181 static inline struct scatterlist
*scsi_sglist(struct scsi_cmnd
*cmd
)
183 return cmd
->sdb
.table
.sgl
;
186 static inline unsigned scsi_bufflen(struct scsi_cmnd
*cmd
)
188 return cmd
->sdb
.length
;
191 static inline void scsi_set_resid(struct scsi_cmnd
*cmd
, unsigned int resid
)
193 cmd
->resid_len
= resid
;
196 static inline unsigned int scsi_get_resid(struct scsi_cmnd
*cmd
)
198 return cmd
->resid_len
;
201 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
202 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
204 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd
*cmd
,
205 const void *buf
, int buflen
)
207 return sg_copy_from_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
211 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd
*cmd
,
212 void *buf
, int buflen
)
214 return sg_copy_to_buffer(scsi_sglist(cmd
), scsi_sg_count(cmd
),
218 static inline sector_t
scsi_get_sector(struct scsi_cmnd
*scmd
)
220 return blk_rq_pos(scsi_cmd_to_rq(scmd
));
223 static inline sector_t
scsi_get_lba(struct scsi_cmnd
*scmd
)
225 unsigned int shift
= ilog2(scmd
->device
->sector_size
) - SECTOR_SHIFT
;
227 return blk_rq_pos(scsi_cmd_to_rq(scmd
)) >> shift
;
230 static inline unsigned int scsi_logical_block_count(struct scsi_cmnd
*scmd
)
232 unsigned int shift
= ilog2(scmd
->device
->sector_size
) - SECTOR_SHIFT
;
234 return blk_rq_bytes(scsi_cmd_to_rq(scmd
)) >> shift
;
238 * The operations below are hints that tell the controller driver how
239 * to handle I/Os with DIF or similar types of protection information.
241 enum scsi_prot_operations
{
243 SCSI_PROT_NORMAL
= 0,
245 /* OS-HBA: Protected, HBA-Target: Unprotected */
246 SCSI_PROT_READ_INSERT
,
247 SCSI_PROT_WRITE_STRIP
,
249 /* OS-HBA: Unprotected, HBA-Target: Protected */
250 SCSI_PROT_READ_STRIP
,
251 SCSI_PROT_WRITE_INSERT
,
253 /* OS-HBA: Protected, HBA-Target: Protected */
255 SCSI_PROT_WRITE_PASS
,
258 static inline void scsi_set_prot_op(struct scsi_cmnd
*scmd
, unsigned char op
)
263 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd
*scmd
)
265 return scmd
->prot_op
;
268 enum scsi_prot_flags
{
269 SCSI_PROT_TRANSFER_PI
= 1 << 0,
270 SCSI_PROT_GUARD_CHECK
= 1 << 1,
271 SCSI_PROT_REF_CHECK
= 1 << 2,
272 SCSI_PROT_REF_INCREMENT
= 1 << 3,
273 SCSI_PROT_IP_CHECKSUM
= 1 << 4,
277 * The controller usually does not know anything about the target it
278 * is communicating with. However, when DIX is enabled the controller
279 * must be know target type so it can verify the protection
280 * information passed along with the I/O.
282 enum scsi_prot_target_type
{
283 SCSI_PROT_DIF_TYPE0
= 0,
289 static inline void scsi_set_prot_type(struct scsi_cmnd
*scmd
, unsigned char type
)
291 scmd
->prot_type
= type
;
294 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd
*scmd
)
296 return scmd
->prot_type
;
299 static inline u32
scsi_prot_ref_tag(struct scsi_cmnd
*scmd
)
301 struct request
*rq
= blk_mq_rq_from_pdu(scmd
);
303 return t10_pi_ref_tag(rq
);
306 static inline unsigned int scsi_prot_interval(struct scsi_cmnd
*scmd
)
308 return scmd
->device
->sector_size
;
311 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd
*cmd
)
313 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.nents
: 0;
316 static inline struct scatterlist
*scsi_prot_sglist(struct scsi_cmnd
*cmd
)
318 return cmd
->prot_sdb
? cmd
->prot_sdb
->table
.sgl
: NULL
;
321 static inline struct scsi_data_buffer
*scsi_prot(struct scsi_cmnd
*cmd
)
323 return cmd
->prot_sdb
;
326 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
327 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
329 static inline void set_status_byte(struct scsi_cmnd
*cmd
, char status
)
331 cmd
->result
= (cmd
->result
& 0xffffff00) | status
;
334 static inline u8
get_status_byte(struct scsi_cmnd
*cmd
)
336 return cmd
->result
& 0xff;
339 static inline void set_host_byte(struct scsi_cmnd
*cmd
, char status
)
341 cmd
->result
= (cmd
->result
& 0xff00ffff) | (status
<< 16);
344 static inline u8
get_host_byte(struct scsi_cmnd
*cmd
)
346 return (cmd
->result
>> 16) & 0xff;
350 * scsi_msg_to_host_byte() - translate message byte
352 * Translate the SCSI parallel message byte to a matching
353 * host byte setting. A message of COMMAND_COMPLETE indicates
354 * a successful command execution, any other message indicate
355 * an error. As the messages themselves only have a meaning
356 * for the SCSI parallel protocol this function translates
357 * them into a matching host byte value for SCSI EH.
359 static inline void scsi_msg_to_host_byte(struct scsi_cmnd
*cmd
, u8 msg
)
362 case COMMAND_COMPLETE
:
365 set_host_byte(cmd
, DID_ABORT
);
368 set_host_byte(cmd
, DID_RESET
);
371 set_host_byte(cmd
, DID_ERROR
);
376 static inline unsigned scsi_transfer_length(struct scsi_cmnd
*scmd
)
378 unsigned int xfer_len
= scmd
->sdb
.length
;
379 unsigned int prot_interval
= scsi_prot_interval(scmd
);
381 if (scmd
->prot_flags
& SCSI_PROT_TRANSFER_PI
)
382 xfer_len
+= (xfer_len
>> ilog2(prot_interval
)) * 8;
387 extern void scsi_build_sense(struct scsi_cmnd
*scmd
, int desc
,
388 u8 key
, u8 asc
, u8 ascq
);
390 struct request
*scsi_alloc_request(struct request_queue
*q
, blk_opf_t opf
,
391 blk_mq_req_flags_t flags
);
393 #endif /* _SCSI_SCSI_CMND_H */