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>
19 * MAX_COMMAND_SIZE is:
20 * The longest fixed-length SCSI CDB as per the SCSI standard.
21 * fixed-length means: commands that their size can be determined
22 * by their opcode and the CDB does not carry a length specifier, (unlike
23 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
24 * true and the SCSI standard also defines extended commands and
25 * vendor specific commands that can be bigger than 16 bytes. The kernel
26 * will support these using the same infrastructure used for VARLEN CDB's.
27 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
28 * supports without specifying a cmd_len by ULD's
30 #define MAX_COMMAND_SIZE 16
31 #if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
32 # error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
35 struct scsi_data_buffer {
36 struct sg_table table;
41 /* embedded in scsi_cmnd */
43 char *ptr; /* data pointer */
44 int this_residual; /* left in this buffer */
45 struct scatterlist *buffer; /* which buffer */
46 int buffers_residual; /* how many buffers left */
48 dma_addr_t dma_handle;
52 volatile int have_data_in;
53 volatile int sent_command;
58 #define SCMD_TAGGED (1 << 0)
59 #define SCMD_UNCHECKED_ISA_DMA (1 << 1)
60 #define SCMD_INITIALIZED (1 << 2)
61 /* flags preserved across unprep / reprep */
62 #define SCMD_PRESERVED_FLAGS (SCMD_UNCHECKED_ISA_DMA | SCMD_INITIALIZED)
65 #define SCMD_STATE_COMPLETE 0
68 struct scsi_request req;
69 struct scsi_device *device;
70 struct list_head list; /* scsi_cmnd participates in queue lists */
71 struct list_head eh_entry; /* entry for the host eh_cmd_q */
72 struct delayed_work abort_work;
76 int eh_eflags; /* Used by error handlr */
79 * A SCSI Command is assigned a nonzero serial_number before passed
80 * to the driver's queue command function. The serial_number is
81 * cleared when scsi_done is entered indicating that the command
82 * has been completed. It is a bug for LLDDs to use this number
83 * for purposes other than printk (and even that is only useful
86 unsigned long serial_number;
89 * This is set to jiffies as it was when the command was first
90 * allocated. It is used to time how long the command has
93 unsigned long jiffies_at_alloc;
98 unsigned char prot_op;
99 unsigned char prot_type;
100 unsigned char prot_flags;
102 unsigned short cmd_len;
103 enum dma_data_direction sc_data_direction;
105 /* These elements define the operation we are about to perform */
109 /* These elements define the operation we ultimately want to perform */
110 struct scsi_data_buffer sdb;
111 struct scsi_data_buffer *prot_sdb;
113 unsigned underflow; /* Return error if less than
114 this amount is transferred */
116 unsigned transfersize; /* How much we are guaranteed to
117 transfer with each SCSI transfer
118 (ie, between disconnect /
119 reconnects. Probably == sector
122 struct request *request; /* The command we are
125 unsigned char *sense_buffer;
126 /* obtained by REQUEST SENSE when
127 * CHECK CONDITION is received on original
128 * command (auto-sense). Length must be
129 * SCSI_SENSE_BUFFERSIZE bytes. */
131 /* Low-level done function - can be used by low-level driver to point
132 * to completion function. Not used by mid/upper level code. */
133 void (*scsi_done) (struct scsi_cmnd *);
136 * The following fields can be written to by the host specific code.
137 * Everything else should be left alone.
139 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
141 unsigned char *host_scribble; /* The host adapter is allowed to
142 * call scsi_malloc and get some memory
143 * and hang it here. The host adapter
144 * is also expected to call scsi_free
145 * to release this memory. (The memory
146 * obtained by scsi_malloc is guaranteed
147 * to be at an address < 16Mb). */
149 int result; /* Status code from lower level driver */
150 int flags; /* Command flags */
151 unsigned long state; /* Command completion state */
153 unsigned char tag; /* SCSI-II queued command tag */
157 * Return the driver private allocation behind the command.
158 * Only works if cmd_size is set in the host template.
160 static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
165 /* make sure not to use it with passthrough commands */
166 static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
168 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
171 extern void scsi_put_command(struct scsi_cmnd *);
172 extern void scsi_finish_command(struct scsi_cmnd *cmd);
174 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
175 size_t *offset, size_t *len);
176 extern void scsi_kunmap_atomic_sg(void *virt);
178 extern blk_status_t scsi_init_io(struct scsi_cmnd *cmd);
180 #ifdef CONFIG_SCSI_DMA
181 extern int scsi_dma_map(struct scsi_cmnd *cmd);
182 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
183 #else /* !CONFIG_SCSI_DMA */
184 static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
185 static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
186 #endif /* !CONFIG_SCSI_DMA */
188 static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
190 return cmd->sdb.table.nents;
193 static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
195 return cmd->sdb.table.sgl;
198 static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
200 return cmd->sdb.length;
203 static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
205 cmd->sdb.resid = resid;
208 static inline int scsi_get_resid(struct scsi_cmnd *cmd)
210 return cmd->sdb.resid;
213 #define scsi_for_each_sg(cmd, sg, nseg, __i) \
214 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
216 static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
218 return blk_bidi_rq(cmd->request) &&
219 (cmd->request->next_rq->special != NULL);
222 static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
224 return scsi_bidi_cmnd(cmd) ?
225 cmd->request->next_rq->special : &cmd->sdb;
228 static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
233 static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
234 void *buf, int buflen)
236 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
240 static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
241 void *buf, int buflen)
243 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
248 * The operations below are hints that tell the controller driver how
249 * to handle I/Os with DIF or similar types of protection information.
251 enum scsi_prot_operations {
253 SCSI_PROT_NORMAL = 0,
255 /* OS-HBA: Protected, HBA-Target: Unprotected */
256 SCSI_PROT_READ_INSERT,
257 SCSI_PROT_WRITE_STRIP,
259 /* OS-HBA: Unprotected, HBA-Target: Protected */
260 SCSI_PROT_READ_STRIP,
261 SCSI_PROT_WRITE_INSERT,
263 /* OS-HBA: Protected, HBA-Target: Protected */
265 SCSI_PROT_WRITE_PASS,
268 static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
273 static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
275 return scmd->prot_op;
278 enum scsi_prot_flags {
279 SCSI_PROT_TRANSFER_PI = 1 << 0,
280 SCSI_PROT_GUARD_CHECK = 1 << 1,
281 SCSI_PROT_REF_CHECK = 1 << 2,
282 SCSI_PROT_REF_INCREMENT = 1 << 3,
283 SCSI_PROT_IP_CHECKSUM = 1 << 4,
287 * The controller usually does not know anything about the target it
288 * is communicating with. However, when DIX is enabled the controller
289 * must be know target type so it can verify the protection
290 * information passed along with the I/O.
292 enum scsi_prot_target_type {
293 SCSI_PROT_DIF_TYPE0 = 0,
299 static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
301 scmd->prot_type = type;
304 static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
306 return scmd->prot_type;
309 static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
311 return blk_rq_pos(scmd->request);
314 static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
316 return scmd->device->sector_size;
319 static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
321 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
324 static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
326 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
329 static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
331 return cmd->prot_sdb;
334 #define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
335 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
337 static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
339 cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
342 static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
344 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
347 static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
349 cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
352 static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
354 unsigned int xfer_len = scsi_out(scmd)->length;
355 unsigned int prot_interval = scsi_prot_interval(scmd);
357 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
358 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
363 #endif /* _SCSI_SCSI_CMND_H */