blob: 43b50d36925cab501acab17f7ed754867652aee5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _SCSI_SCSI_CMND_H
2#define _SCSI_SCSI_CMND_H
3
4#include <linux/dma-mapping.h>
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +02005#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/list.h>
7#include <linux/types.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -08008#include <linux/timer.h>
Jens Axboec6132da2007-10-16 11:08:49 +02009#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
FUJITA Tomonorib58d9152006-11-16 19:24:10 +090011struct Scsi_Host;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct scsi_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
Boaz Harrosh64a87b22008-04-30 11:19:47 +030014/*
15 * MAX_COMMAND_SIZE is:
16 * The longest fixed-length SCSI CDB as per the SCSI standard.
17 * fixed-length means: commands that their size can be determined
18 * by their opcode and the CDB does not carry a length specifier, (unlike
19 * the VARIABLE_LENGTH_CMD(0x7f) command). This is actually not exactly
20 * true and the SCSI standard also defines extended commands and
21 * vendor specific commands that can be bigger than 16 bytes. The kernel
22 * will support these using the same infrastructure used for VARLEN CDB's.
23 * So in effect MAX_COMMAND_SIZE means the maximum size command scsi-ml
24 * supports without specifying a cmd_len by ULD's
25 */
26#define MAX_COMMAND_SIZE 16
27#if (MAX_COMMAND_SIZE > BLK_MAX_CDB)
28# error MAX_COMMAND_SIZE can not be bigger than BLK_MAX_CDB
29#endif
30
Boaz Harrosh30b0c372007-12-13 13:47:40 +020031struct scsi_data_buffer {
32 struct sg_table table;
33 unsigned length;
34 int resid;
35};
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37/* embedded in scsi_cmnd */
38struct scsi_pointer {
39 char *ptr; /* data pointer */
40 int this_residual; /* left in this buffer */
41 struct scatterlist *buffer; /* which buffer */
42 int buffers_residual; /* how many buffers left */
43
44 dma_addr_t dma_handle;
45
46 volatile int Status;
47 volatile int Message;
48 volatile int have_data_in;
49 volatile int sent_command;
50 volatile int phase;
51};
52
53struct scsi_cmnd {
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 struct scsi_device *device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 struct list_head list; /* scsi_cmnd participates in queue lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 struct list_head eh_entry; /* entry for the host eh_cmd_q */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 int eh_eflags; /* Used by error handlr */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59 /*
c6295cd2005-04-03 14:59:11 -050060 * A SCSI Command is assigned a nonzero serial_number before passed
61 * to the driver's queue command function. The serial_number is
62 * cleared when scsi_done is entered indicating that the command
Matthew Wilcox12a44162007-09-18 19:54:43 -060063 * has been completed. It is a bug for LLDDs to use this number
64 * for purposes other than printk (and even that is only useful
65 * for debugging).
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 */
67 unsigned long serial_number;
Matthew Wilcox12a44162007-09-18 19:54:43 -060068
James Bottomleyb21a4132005-08-05 21:45:40 -050069 /*
70 * This is set to jiffies as it was when the command was first
71 * allocated. It is used to time how long the command has
72 * been outstanding
73 */
74 unsigned long jiffies_at_alloc;
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
76 int retries;
77 int allowed;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Martin K. Petersendb007fc2008-07-17 04:28:31 -040079 unsigned char prot_op;
80 unsigned char prot_type;
81
Boaz Harroshdb4742d2008-04-30 11:27:26 +030082 unsigned short cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 enum dma_data_direction sc_data_direction;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85 /* These elements define the operation we are about to perform */
Boaz Harrosh64a87b22008-04-30 11:19:47 +030086 unsigned char *cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 /* These elements define the operation we ultimately want to perform */
Boaz Harrosh30b0c372007-12-13 13:47:40 +020090 struct scsi_data_buffer sdb;
Martin K. Petersen7027ad72008-07-17 17:08:48 -040091 struct scsi_data_buffer *prot_sdb;
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 unsigned underflow; /* Return error if less than
94 this amount is transferred */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96 unsigned transfersize; /* How much we are guaranteed to
97 transfer with each SCSI transfer
98 (ie, between disconnect /
99 reconnects. Probably == sector
100 size */
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 struct request *request; /* The command we are
103 working on */
104
105#define SCSI_SENSE_BUFFERSIZE 96
FUJITA Tomonoride25deb2008-01-16 13:32:17 +0900106 unsigned char *sense_buffer;
Matthew Wilcoxc67a8482006-01-17 11:54:24 -0700107 /* obtained by REQUEST SENSE when
108 * CHECK CONDITION is received on original
109 * command (auto-sense) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 /* Low-level done function - can be used by low-level driver to point
112 * to completion function. Not used by mid/upper level code. */
113 void (*scsi_done) (struct scsi_cmnd *);
114
115 /*
116 * The following fields can be written to by the host specific code.
117 * Everything else should be left alone.
118 */
119 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
120
121 unsigned char *host_scribble; /* The host adapter is allowed to
Matthew Wilcoxc67a8482006-01-17 11:54:24 -0700122 * call scsi_malloc and get some memory
123 * and hang it here. The host adapter
124 * is also expected to call scsi_free
125 * to release this memory. (The memory
126 * obtained by scsi_malloc is guaranteed
127 * to be at an address < 16Mb). */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 int result; /* Status code from lower level driver */
130
131 unsigned char tag; /* SCSI-II queued command tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132};
133
Al Viroc53033f2005-10-21 03:22:08 -0400134extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900135extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136extern void scsi_put_command(struct scsi_cmnd *);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900137extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *,
138 struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139extern void scsi_finish_command(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +0200141extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
142 size_t *offset, size_t *len);
143extern void scsi_kunmap_atomic_sg(void *virt);
144
Boaz Harroshbb52d822007-12-13 16:14:27 -0800145extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask);
146extern void scsi_release_buffers(struct scsi_cmnd *cmd);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900147
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900148extern int scsi_dma_map(struct scsi_cmnd *cmd);
149extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
150
James Bottomley1c353f72008-03-13 11:19:36 -0500151struct scsi_cmnd *scsi_allocate_command(gfp_t gfp_mask);
152void scsi_free_command(gfp_t gfp_mask, struct scsi_cmnd *cmd);
153
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200154static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
155{
156 return cmd->sdb.table.nents;
157}
158
159static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
160{
161 return cmd->sdb.table.sgl;
162}
163
164static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
165{
166 return cmd->sdb.length;
167}
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900168
169static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
170{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200171 cmd->sdb.resid = resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900172}
173
174static inline int scsi_get_resid(struct scsi_cmnd *cmd)
175{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200176 return cmd->sdb.resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900177}
178
179#define scsi_for_each_sg(cmd, sg, nseg, __i) \
Jens Axboec6132da2007-10-16 11:08:49 +0200180 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900181
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200182static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
183{
184 return blk_bidi_rq(cmd->request) &&
185 (cmd->request->next_rq->special != NULL);
186}
187
188static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
189{
190 return scsi_bidi_cmnd(cmd) ?
191 cmd->request->next_rq->special : &cmd->sdb;
192}
193
194static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
195{
196 return &cmd->sdb;
197}
198
FUJITA Tomonori9ac16b62008-03-09 13:44:29 +0900199static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
200 void *buf, int buflen)
201{
202 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
203 buf, buflen);
204}
205
206static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
207 void *buf, int buflen)
208{
209 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
210 buf, buflen);
211}
212
Martin K. Petersendb007fc2008-07-17 04:28:31 -0400213/*
214 * The operations below are hints that tell the controller driver how
215 * to handle I/Os with DIF or similar types of protection information.
216 */
217enum scsi_prot_operations {
218 /* Normal I/O */
219 SCSI_PROT_NORMAL = 0,
220
221 /* OS-HBA: Protected, HBA-Target: Unprotected */
222 SCSI_PROT_READ_INSERT,
223 SCSI_PROT_WRITE_STRIP,
224
225 /* OS-HBA: Unprotected, HBA-Target: Protected */
226 SCSI_PROT_READ_STRIP,
227 SCSI_PROT_WRITE_INSERT,
228
229 /* OS-HBA: Protected, HBA-Target: Protected */
230 SCSI_PROT_READ_PASS,
231 SCSI_PROT_WRITE_PASS,
232
233 /* OS-HBA: Protected, HBA-Target: Protected, checksum conversion */
234 SCSI_PROT_READ_CONVERT,
235 SCSI_PROT_WRITE_CONVERT,
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 scmd->request->sector;
274}
275
Martin K. Petersen7027ad72008-07-17 17:08:48 -0400276static 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
James Bottomleyf290f192009-02-08 21:59:48 -0600294static inline void set_msg_byte(struct scsi_cmnd *cmd, char status)
295{
296 cmd->result |= status << 8;
297}
298
299static inline void set_host_byte(struct scsi_cmnd *cmd, char status)
300{
301 cmd->result |= status << 16;
302}
303
304static inline void set_driver_byte(struct scsi_cmnd *cmd, char status)
305{
306 cmd->result |= status << 24;
307}
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309#endif /* _SCSI_SCSI_CMND_H */