Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _SCSI_SCSI_CMND_H
3#define _SCSI_SCSI_CMND_H
4
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_host.h>
14#include <scsi/scsi_request.h>
15
16struct Scsi_Host;
17struct scsi_driver;
18
19/*
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
30 */
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
34#endif
35
36struct scsi_data_buffer {
37 struct sg_table table;
38 unsigned length;
39};
40
41/* embedded in scsi_cmnd */
42struct scsi_pointer {
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 */
47
48 dma_addr_t dma_handle;
49
50 volatile int Status;
51 volatile int Message;
52 volatile int have_data_in;
53 volatile int sent_command;
54 volatile int phase;
55};
56
57/* for scmd->flags */
58#define SCMD_TAGGED (1 << 0)
59#define SCMD_INITIALIZED (1 << 1)
60#define SCMD_LAST (1 << 2)
61/* flags preserved across unprep / reprep */
62#define SCMD_PRESERVED_FLAGS (SCMD_INITIALIZED)
63
64/* for scmd->state */
65#define SCMD_STATE_COMPLETE 0
66#define SCMD_STATE_INFLIGHT 1
67
68struct scsi_cmnd {
69 struct scsi_request req;
70 struct scsi_device *device;
71 struct list_head eh_entry; /* entry for the host eh_cmd_q */
72 struct delayed_work abort_work;
73
74 struct rcu_head rcu;
75
76 int eh_eflags; /* Used by error handlr */
77
78 int budget_token;
79
80 /*
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
83 * been outstanding
84 */
85 unsigned long jiffies_at_alloc;
86
87 int retries;
88 int allowed;
89
90 unsigned char prot_op;
91 unsigned char prot_type;
92 unsigned char prot_flags;
93
94 unsigned short cmd_len;
95 enum dma_data_direction sc_data_direction;
96
97 /* These elements define the operation we are about to perform */
98 unsigned char *cmnd;
99
100
101 /* These elements define the operation we ultimately want to perform */
102 struct scsi_data_buffer sdb;
103 struct scsi_data_buffer *prot_sdb;
104
105 unsigned underflow; /* Return error if less than
106 this amount is transferred */
107
108 unsigned transfersize; /* How much we are guaranteed to
109 transfer with each SCSI transfer
110 (ie, between disconnect /
111 reconnects. Probably == sector
112 size */
113
114 struct request *request; /* The command we are
115 working on */
116
117 unsigned char *sense_buffer;
118 /* obtained by REQUEST SENSE when
119 * CHECK CONDITION is received on original
120 * command (auto-sense). Length must be
121 * SCSI_SENSE_BUFFERSIZE bytes. */
122
123 /* Low-level done function - can be used by low-level driver to point
124 * to completion function. Not used by mid/upper level code. */
125 void (*scsi_done) (struct scsi_cmnd *);
126
127 /*
128 * The following fields can be written to by the host specific code.
129 * Everything else should be left alone.
130 */
131 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
132
133 unsigned char *host_scribble; /* The host adapter is allowed to
134 * call scsi_malloc and get some memory
135 * and hang it here. The host adapter
136 * is also expected to call scsi_free
137 * to release this memory. (The memory
138 * obtained by scsi_malloc is guaranteed
139 * to be at an address < 16Mb). */
140
141 int result; /* Status code from lower level driver */
142 int flags; /* Command flags */
143 unsigned long state; /* Command completion state */
144
145 unsigned char tag; /* SCSI-II queued command tag */
146 unsigned int extra_len; /* length of alignment and padding */
147};
148
149/*
150 * Return the driver private allocation behind the command.
151 * Only works if cmd_size is set in the host template.
152 */
153static inline void *scsi_cmd_priv(struct scsi_cmnd *cmd)
154{
155 return cmd + 1;
156}
157
158/* make sure not to use it with passthrough commands */
159static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
160{
161 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
162}
163
164extern void scsi_finish_command(struct scsi_cmnd *cmd);
165
166extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
167 size_t *offset, size_t *len);
168extern void scsi_kunmap_atomic_sg(void *virt);
169
170blk_status_t scsi_alloc_sgtables(struct scsi_cmnd *cmd);
171void scsi_free_sgtables(struct scsi_cmnd *cmd);
172
173#ifdef CONFIG_SCSI_DMA
174extern int scsi_dma_map(struct scsi_cmnd *cmd);
175extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
176#else /* !CONFIG_SCSI_DMA */
177static inline int scsi_dma_map(struct scsi_cmnd *cmd) { return -ENOSYS; }
178static inline void scsi_dma_unmap(struct scsi_cmnd *cmd) { }
179#endif /* !CONFIG_SCSI_DMA */
180
181static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
182{
183 return cmd->sdb.table.nents;
184}
185
186static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
187{
188 return cmd->sdb.table.sgl;
189}
190
191static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
192{
193 return cmd->sdb.length;
194}
195
196static inline void scsi_set_resid(struct scsi_cmnd *cmd, unsigned int resid)
197{
198 cmd->req.resid_len = resid;
199}
200
201static inline unsigned int scsi_get_resid(struct scsi_cmnd *cmd)
202{
203 return cmd->req.resid_len;
204}
205
206#define scsi_for_each_sg(cmd, sg, nseg, __i) \
207 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
208
209static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
210 void *buf, int buflen)
211{
212 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
213 buf, buflen);
214}
215
216static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
217 void *buf, int buflen)
218{
219 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
220 buf, buflen);
221}
222
223/*
224 * The operations below are hints that tell the controller driver how
225 * to handle I/Os with DIF or similar types of protection information.
226 */
227enum scsi_prot_operations {
228 /* Normal I/O */
229 SCSI_PROT_NORMAL = 0,
230
231 /* OS-HBA: Protected, HBA-Target: Unprotected */
232 SCSI_PROT_READ_INSERT,
233 SCSI_PROT_WRITE_STRIP,
234
235 /* OS-HBA: Unprotected, HBA-Target: Protected */
236 SCSI_PROT_READ_STRIP,
237 SCSI_PROT_WRITE_INSERT,
238
239 /* OS-HBA: Protected, HBA-Target: Protected */
240 SCSI_PROT_READ_PASS,
241 SCSI_PROT_WRITE_PASS,
242};
243
244static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
245{
246 scmd->prot_op = op;
247}
248
249static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
250{
251 return scmd->prot_op;
252}
253
254enum scsi_prot_flags {
255 SCSI_PROT_TRANSFER_PI = 1 << 0,
256 SCSI_PROT_GUARD_CHECK = 1 << 1,
257 SCSI_PROT_REF_CHECK = 1 << 2,
258 SCSI_PROT_REF_INCREMENT = 1 << 3,
259 SCSI_PROT_IP_CHECKSUM = 1 << 4,
260};
261
262/*
263 * The controller usually does not know anything about the target it
264 * is communicating with. However, when DIX is enabled the controller
265 * must be know target type so it can verify the protection
266 * information passed along with the I/O.
267 */
268enum scsi_prot_target_type {
269 SCSI_PROT_DIF_TYPE0 = 0,
270 SCSI_PROT_DIF_TYPE1,
271 SCSI_PROT_DIF_TYPE2,
272 SCSI_PROT_DIF_TYPE3,
273};
274
275static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
276{
277 scmd->prot_type = type;
278}
279
280static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
281{
282 return scmd->prot_type;
283}
284
285static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
286{
287 return blk_rq_pos(scmd->request);
288}
289
290static inline unsigned int scsi_prot_interval(struct scsi_cmnd *scmd)
291{
292 return scmd->device->sector_size;
293}
294
295static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
296{
297 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
298}
299
300static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
301{
302 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
303}
304
305static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
306{
307 return cmd->prot_sdb;
308}
309
310#define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
311 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
312
313static inline void set_status_byte(struct scsi_cmnd *cmd, char status)
314{
315 cmd->result = (cmd->result & 0xffffff00) | status;
316}
317
318static inline u8 get_status_byte(struct scsi_cmnd *cmd)
319{
320 return cmd->result & 0xff;
321}
322
323static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
324{
325 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
326}
327
328static inline u8 get_host_byte(struct scsi_cmnd *cmd)
329{
330 return (cmd->result >> 16) & 0xff;
331}
332
333/**
334 * scsi_msg_to_host_byte() - translate message byte
335 *
336 * Translate the SCSI parallel message byte to a matching
337 * host byte setting. A message of COMMAND_COMPLETE indicates
338 * a successful command execution, any other message indicate
339 * an error. As the messages themselves only have a meaning
340 * for the SCSI parallel protocol this function translates
341 * them into a matching host byte value for SCSI EH.
342 */
343static inline void scsi_msg_to_host_byte(struct scsi_cmnd *cmd, u8 msg)
344{
345 switch (msg) {
346 case COMMAND_COMPLETE:
347 break;
348 case ABORT_TASK_SET:
349 set_host_byte(cmd, DID_ABORT);
350 break;
351 case TARGET_RESET:
352 set_host_byte(cmd, DID_RESET);
353 break;
354 default:
355 set_host_byte(cmd, DID_ERROR);
356 break;
357 }
358}
359
360static inline unsigned scsi_transfer_length(struct scsi_cmnd *scmd)
361{
362 unsigned int xfer_len = scmd->sdb.length;
363 unsigned int prot_interval = scsi_prot_interval(scmd);
364
365 if (scmd->prot_flags & SCSI_PROT_TRANSFER_PI)
366 xfer_len += (xfer_len >> ilog2(prot_interval)) * 8;
367
368 return xfer_len;
369}
370
371extern void scsi_build_sense(struct scsi_cmnd *scmd, int desc,
372 u8 key, u8 asc, u8 ascq);
373
374#endif /* _SCSI_SCSI_CMND_H */
1#ifndef _SCSI_SCSI_CMND_H
2#define _SCSI_SCSI_CMND_H
3
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
11struct Scsi_Host;
12struct scsi_device;
13struct scsi_driver;
14
15/*
16 * MAX_COMMAND_SIZE is:
17 * The longest fixed-length SCSI CDB as per the SCSI standard.
18 * fixed-length means: commands that their size can be determined
19 * by their opcode and the CDB does not carry a length specifier, (unlike
20 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
21 * true and the SCSI standard also defines extended commands and
22 * vendor specific commands that can be bigger than 16 bytes. The kernel
23 * will support these using the same infrastructure used for VARLEN CDB's.
24 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
25 * supports without specifying a cmd_len by ULD's
26 */
27#define MAX_COMMAND_SIZE 16
28#if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
29# error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
30#endif
31
32struct scsi_data_buffer {
33 struct sg_table table;
34 unsigned length;
35 int resid;
36};
37
38/* embedded in scsi_cmnd */
39struct scsi_pointer {
40 char *ptr; /* data pointer */
41 int this_residual; /* left in this buffer */
42 struct scatterlist *buffer; /* which buffer */
43 int buffers_residual; /* how many buffers left */
44
45 dma_addr_t dma_handle;
46
47 volatile int Status;
48 volatile int Message;
49 volatile int have_data_in;
50 volatile int sent_command;
51 volatile int phase;
52};
53
54struct scsi_cmnd {
55 struct scsi_device *device;
56 struct list_head list; /* scsi_cmnd participates in queue lists */
57 struct list_head eh_entry; /* entry for the host eh_cmd_q */
58 struct delayed_work abort_work;
59 int eh_eflags; /* Used by error handlr */
60
61 /*
62 * A SCSI Command is assigned a nonzero serial_number before passed
63 * to the driver's queue command function. The serial_number is
64 * cleared when scsi_done is entered indicating that the command
65 * has been completed. It is a bug for LLDDs to use this number
66 * for purposes other than printk (and even that is only useful
67 * for debugging).
68 */
69 unsigned long serial_number;
70
71 /*
72 * This is set to jiffies as it was when the command was first
73 * allocated. It is used to time how long the command has
74 * been outstanding
75 */
76 unsigned long jiffies_at_alloc;
77
78 int retries;
79 int allowed;
80
81 unsigned char prot_op;
82 unsigned char prot_type;
83
84 unsigned short cmd_len;
85 enum dma_data_direction sc_data_direction;
86
87 /* These elements define the operation we are about to perform */
88 unsigned char *cmnd;
89
90
91 /* These elements define the operation we ultimately want to perform */
92 struct scsi_data_buffer sdb;
93 struct scsi_data_buffer *prot_sdb;
94
95 unsigned underflow; /* Return error if less than
96 this amount is transferred */
97
98 unsigned transfersize; /* How much we are guaranteed to
99 transfer with each SCSI transfer
100 (ie, between disconnect /
101 reconnects. Probably == sector
102 size */
103
104 struct request *request; /* The command we are
105 working on */
106
107#define SCSI_SENSE_BUFFERSIZE 96
108 unsigned char *sense_buffer;
109 /* obtained by REQUEST SENSE when
110 * CHECK CONDITION is received on original
111 * command (auto-sense) */
112
113 /* Low-level done function - can be used by low-level driver to point
114 * to completion function. Not used by mid/upper level code. */
115 void (*scsi_done) (struct scsi_cmnd *);
116
117 /*
118 * The following fields can be written to by the host specific code.
119 * Everything else should be left alone.
120 */
121 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
122
123 unsigned char *host_scribble; /* The host adapter is allowed to
124 * call scsi_malloc and get some memory
125 * and hang it here. The host adapter
126 * is also expected to call scsi_free
127 * to release this memory. (The memory
128 * obtained by scsi_malloc is guaranteed
129 * to be at an address < 16Mb). */
130
131 int result; /* Status code from lower level driver */
132
133 unsigned char tag; /* SCSI-II queued command tag */
134};
135
136/* make sure not to use it with REQ_TYPE_BLOCK_PC commands */
137static inline struct scsi_driver *scsi_cmd_to_driver(struct scsi_cmnd *cmd)
138{
139 return *(struct scsi_driver **)cmd->request->rq_disk->private_data;
140}
141
142extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
143extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
144extern void scsi_put_command(struct scsi_cmnd *);
145extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *);
146extern void scsi_finish_command(struct scsi_cmnd *cmd);
147
148extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
149 size_t *offset, size_t *len);
150extern void scsi_kunmap_atomic_sg(void *virt);
151
152extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask);
153extern void scsi_release_buffers(struct scsi_cmnd *cmd);
154
155extern int scsi_dma_map(struct scsi_cmnd *cmd);
156extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
157
158static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
159{
160 return cmd->sdb.table.nents;
161}
162
163static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
164{
165 return cmd->sdb.table.sgl;
166}
167
168static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
169{
170 return cmd->sdb.length;
171}
172
173static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
174{
175 cmd->sdb.resid = resid;
176}
177
178static inline int scsi_get_resid(struct scsi_cmnd *cmd)
179{
180 return cmd->sdb.resid;
181}
182
183#define scsi_for_each_sg(cmd, sg, nseg, __i) \
184 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
185
186static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
187{
188 return blk_bidi_rq(cmd->request) &&
189 (cmd->request->next_rq->special != NULL);
190}
191
192static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
193{
194 return scsi_bidi_cmnd(cmd) ?
195 cmd->request->next_rq->special : &cmd->sdb;
196}
197
198static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
199{
200 return &cmd->sdb;
201}
202
203static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
204 void *buf, int buflen)
205{
206 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
207 buf, buflen);
208}
209
210static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
211 void *buf, int buflen)
212{
213 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
214 buf, buflen);
215}
216
217/*
218 * The operations below are hints that tell the controller driver how
219 * to handle I/Os with DIF or similar types of protection information.
220 */
221enum scsi_prot_operations {
222 /* Normal I/O */
223 SCSI_PROT_NORMAL = 0,
224
225 /* OS-HBA: Protected, HBA-Target: Unprotected */
226 SCSI_PROT_READ_INSERT,
227 SCSI_PROT_WRITE_STRIP,
228
229 /* OS-HBA: Unprotected, HBA-Target: Protected */
230 SCSI_PROT_READ_STRIP,
231 SCSI_PROT_WRITE_INSERT,
232
233 /* OS-HBA: Protected, HBA-Target: Protected */
234 SCSI_PROT_READ_PASS,
235 SCSI_PROT_WRITE_PASS,
236};
237
238static inline void scsi_set_prot_op(struct scsi_cmnd *scmd, unsigned char op)
239{
240 scmd->prot_op = op;
241}
242
243static inline unsigned char scsi_get_prot_op(struct scsi_cmnd *scmd)
244{
245 return scmd->prot_op;
246}
247
248/*
249 * The controller usually does not know anything about the target it
250 * is communicating with. However, when DIX is enabled the controller
251 * must be know target type so it can verify the protection
252 * information passed along with the I/O.
253 */
254enum scsi_prot_target_type {
255 SCSI_PROT_DIF_TYPE0 = 0,
256 SCSI_PROT_DIF_TYPE1,
257 SCSI_PROT_DIF_TYPE2,
258 SCSI_PROT_DIF_TYPE3,
259};
260
261static inline void scsi_set_prot_type(struct scsi_cmnd *scmd, unsigned char type)
262{
263 scmd->prot_type = type;
264}
265
266static inline unsigned char scsi_get_prot_type(struct scsi_cmnd *scmd)
267{
268 return scmd->prot_type;
269}
270
271static inline sector_t scsi_get_lba(struct scsi_cmnd *scmd)
272{
273 return blk_rq_pos(scmd->request);
274}
275
276static inline unsigned scsi_prot_sg_count(struct scsi_cmnd *cmd)
277{
278 return cmd->prot_sdb ? cmd->prot_sdb->table.nents : 0;
279}
280
281static inline struct scatterlist *scsi_prot_sglist(struct scsi_cmnd *cmd)
282{
283 return cmd->prot_sdb ? cmd->prot_sdb->table.sgl : NULL;
284}
285
286static inline struct scsi_data_buffer *scsi_prot(struct scsi_cmnd *cmd)
287{
288 return cmd->prot_sdb;
289}
290
291#define scsi_for_each_prot_sg(cmd, sg, nseg, __i) \
292 for_each_sg(scsi_prot_sglist(cmd), sg, nseg, __i)
293
294static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
295{
296 cmd->result = (cmd->result & 0xffff00ff) | (status << 8);
297}
298
299static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
300{
301 cmd->result = (cmd->result & 0xff00ffff) | (status << 16);
302}
303
304static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
305{
306 cmd->result = (cmd->result & 0x00ffffff) | (status << 24);
307}
308
309#endif /* _SCSI_SCSI_CMND_H */