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>
13 #include <scsi/scsi_request.h>
18 * MAX_COMMAND_SIZE is:
19 * The longest fixed-length SCSI CDB as per the SCSI standard.
20 * fixed-length means: commands that their size can be determined
21 * by their opcode and the CDB does not carry a length specifier, (unlike
22 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
23 * true and the SCSI standard also defines extended commands and
24 * vendor specific commands that can be bigger than 16 bytes. The kernel
25 * will support these using the same infrastructure used for VARLEN CDB's.
26 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
27 * supports without specifying a cmd_len by ULD's
29 #define MAX_COMMAND_SIZE 16
30 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
31 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
34 struct scsi_data_buffer {
35 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 #define SCMD_TAGGED (1 << 0)
57 #define SCMD_INITIALIZED (1 << 1)
58 #define SCMD_LAST (1 << 2)
59 /* flags preserved across unprep / reprep */
60 #define SCMD_PRESERVED_FLAGS (SCMD_INITIALIZED)
63 #define SCMD_STATE_COMPLETE 0
64 #define SCMD_STATE_INFLIGHT 1
66 enum scsi_cmnd_submitter {
67 SUBMITTED_BY_BLOCK_LAYER = 0,
68 SUBMITTED_BY_SCSI_ERROR_HANDLER = 1,
69 SUBMITTED_BY_SCSI_RESET_IOCTL = 2,
73 struct scsi_request req;
74 struct scsi_device *device;
75 struct list_head eh_entry; /* entry for the host eh_abort_list/eh_cmd_q */
76 struct delayed_work abort_work;
80 int eh_eflags; /* Used by error handlr */
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;
97 enum scsi_cmnd_submitter submitter;
99 unsigned short cmd_len;
100 enum dma_data_direction sc_data_direction;
102 /* These elements define the operation we are about to perform */
106 /* These elements define the operation we ultimately want to perform */
107 struct scsi_data_buffer sdb;
108 struct scsi_data_buffer *prot_sdb;
110 unsigned underflow; /* Return error if less than
111 this amount is transferred */
113 unsigned transfersize; /* How much we are guaranteed to
114 transfer with each SCSI transfer
115 (ie, between disconnect /
116 reconnects. Probably == sector
119 unsigned char *sense_buffer;
120 /* obtained by REQUEST SENSE when
121 * CHECK CONDITION is received on original
122 * command (auto-sense). Length must be
123 * SCSI_SENSE_BUFFERSIZE bytes. */
126 * The following fields can be written to by the host specific code.
127 * Everything else should be left alone.
129 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
131 unsigned char *host_scribble; /* The host adapter is allowed to
132 * call scsi_malloc and get some memory
133 * and hang it here. The host adapter
134 * is also expected to call scsi_free
135 * to release this memory. (The memory
136 * obtained by scsi_malloc is guaranteed
137 * to be at an address < 16Mb). */
139 int result; /* Status code from lower level driver */
140 int flags; /* Command flags */
141 unsigned long state; /* Command completion state */
143 unsigned int extra_len; /* length of alignment and padding */
146 /* Variant of blk_mq_rq_from_pdu() that verifies the type of its argument. */
147 static inline struct request *scsi_cmd_to_rq(struct scsi_cmnd *scmd)
149 return blk_mq_rq_from_pdu(scmd);
153 * Return the driver private allocation behind the command.
154 * Only works if cmd_size is set in the host template.
156 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
161 void scsi_done(struct scsi_cmnd *cmd);
163 extern void scsi_finish_command(struct scsi_cmnd *cmd);
165 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
166 size_t *offset, size_t *len);
167 extern void scsi_kunmap_atomic_sg(void *virt);
169 blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
170 void scsi_free_sgtables(struct scsi_cmnd *cmd);
172 #ifdef CONFIG_SCSI_DMA
173 extern int scsi_dma_map(struct scsi_cmnd *cmd);
174 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
175 #else /* !CONFIG_SCSI_DMA */
176 static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
177 static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
178 #endif /* !CONFIG_SCSI_DMA */
180 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
182 return cmd->sdb.table.nents;
185 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
187 return cmd->sdb.table.sgl;
190 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
192 return cmd->sdb.length;
195 static inline void scsi_set_resid(struct scsi_cmnd *cmd, unsigned int resid)
197 cmd->req.resid_len = resid;
200 static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
202 return cmd->req.resid_len;
205 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
206 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
208 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
209 void *buf, int buflen)
211 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
215 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
216 void *buf, int buflen)
218 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
222 static inline sector_t scsi_get_sector(struct scsi_cmnd *scmd)
224 return blk_rq_pos(scsi_cmd_to_rq(scmd));
227 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
229 unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
231 return blk_rq_pos(scsi_cmd_to_rq(scmd)) >> shift;
234 static inline unsigned int scsi_logical_block_count(struct scsi_cmnd *scmd)
236 unsigned int shift = ilog2(scmd->device->sector_size) - SECTOR_SHIFT;
238 return blk_rq_bytes(scsi_cmd_to_rq(scmd)) >> shift;
242 * The operations below are hints that tell the controller driver how
243 * to handle I/Os with DIF or similar types of protection information.
245 enum scsi_prot_operations {
247 SCSI_PROT_NORMAL = 0,
249 /* OS-HBA: Protected, HBA-Target: Unprotected */
250 SCSI_PROT_READ_INSERT,
251 SCSI_PROT_WRITE_STRIP,
253 /* OS-HBA: Unprotected, HBA-Target: Protected */
254 SCSI_PROT_READ_STRIP,
255 SCSI_PROT_WRITE_INSERT,
257 /* OS-HBA: Protected, HBA-Target: Protected */
259 SCSI_PROT_WRITE_PASS,
262 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
267 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
269 return scmd->prot_op;
272 enum scsi_prot_flags {
273 SCSI_PROT_TRANSFER_PI = 1 << 0,
274 SCSI_PROT_GUARD_CHECK = 1 << 1,
275 SCSI_PROT_REF_CHECK = 1 << 2,
276 SCSI_PROT_REF_INCREMENT = 1 << 3,
277 SCSI_PROT_IP_CHECKSUM = 1 << 4,
281 * The controller usually does not know anything about the target it
282 * is communicating with. However, when DIX is enabled the controller
283 * must be know target type so it can verify the protection
284 * information passed along with the I/O.
286 enum scsi_prot_target_type {
287 SCSI_PROT_DIF_TYPE0 = 0,
293 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
295 scmd->prot_type = type;
298 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
300 return scmd->prot_type;
303 static inline u32 scsi_prot_ref_tag(struct scsi_cmnd *scmd)
305 struct request *rq = blk_mq_rq_from_pdu(scmd);
307 return t10_pi_ref_tag(rq);
310 static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
312 return scmd->device->sector_size;
315 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
317 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
320 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
322 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
325 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
327 return cmd->prot_sdb;
330 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
331 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
333 static inline void set_status_byte(struct scsi_cmnd *cmd, char status)
335 cmd->result = (cmd->result & 0xffffff00) | status;
338 static inline u8 get_status_byte(struct scsi_cmnd *cmd)
340 return cmd->result & 0xff;
343 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
345 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
348 static inline u8 get_host_byte(struct scsi_cmnd *cmd)
350 return (cmd->result >> 16) & 0xff;
354 * scsi_msg_to_host_byte() - translate message byte
356 * Translate the SCSI parallel message byte to a matching
357 * host byte setting. A message of COMMAND_COMPLETE indicates
358 * a successful command execution, any other message indicate
359 * an error. As the messages themselves only have a meaning
360 * for the SCSI parallel protocol this function translates
361 * them into a matching host byte value for SCSI EH.
363 static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
366 case COMMAND_COMPLETE:
369 set_host_byte(cmd, DID_ABORT);
372 set_host_byte(cmd, DID_RESET);
375 set_host_byte(cmd, DID_ERROR);
380 static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
382 unsigned int xfer_len = scmd->sdb.length;
383 unsigned int prot_interval = scsi_prot_interval(scmd);
385 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
386 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
391 extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
392 u8 key, u8 asc, u8 ascq);
394 struct request *scsi_alloc_request(struct request_queue *q,
395 unsigned int op, blk_mq_req_flags_t flags);
397 #endif /* _SCSI_SCSI_CMND_H */