blob: 66c944849d6b385f1e6d25fe81be0eff59e1b471 [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;
78 int timeout_per_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Boaz Harroshdb4742d2008-04-30 11:27:26 +030080 unsigned short cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 enum dma_data_direction sc_data_direction;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 /* These elements define the operation we are about to perform */
Boaz Harrosh64a87b22008-04-30 11:19:47 +030084 unsigned char *cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 struct timer_list eh_timeout; /* Used to time out the command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
88 /* These elements define the operation we ultimately want to perform */
Boaz Harrosh30b0c372007-12-13 13:47:40 +020089 struct scsi_data_buffer sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 unsigned underflow; /* Return error if less than
91 this amount is transferred */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93 unsigned transfersize; /* How much we are guaranteed to
94 transfer with each SCSI transfer
95 (ie, between disconnect /
96 reconnects. Probably == sector
97 size */
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 struct request *request; /* The command we are
100 working on */
101
102#define SCSI_SENSE_BUFFERSIZE 96
FUJITA Tomonoride25deb2008-01-16 13:32:17 +0900103 unsigned char *sense_buffer;
Matthew Wilcoxc67a8482006-01-17 11:54:24 -0700104 /* obtained by REQUEST SENSE when
105 * CHECK CONDITION is received on original
106 * command (auto-sense) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108 /* Low-level done function - can be used by low-level driver to point
109 * to completion function. Not used by mid/upper level code. */
110 void (*scsi_done) (struct scsi_cmnd *);
111
112 /*
113 * The following fields can be written to by the host specific code.
114 * Everything else should be left alone.
115 */
116 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
117
118 unsigned char *host_scribble; /* The host adapter is allowed to
Matthew Wilcoxc67a8482006-01-17 11:54:24 -0700119 * call scsi_malloc and get some memory
120 * and hang it here. The host adapter
121 * is also expected to call scsi_free
122 * to release this memory. (The memory
123 * obtained by scsi_malloc is guaranteed
124 * to be at an address < 16Mb). */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
126 int result; /* Status code from lower level driver */
127
128 unsigned char tag; /* SCSI-II queued command tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
130
Al Viroc53033f2005-10-21 03:22:08 -0400131extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900132extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133extern void scsi_put_command(struct scsi_cmnd *);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900134extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *,
135 struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136extern void scsi_finish_command(struct scsi_cmnd *cmd);
Luben Tuikov89f48c42006-05-15 20:57:18 +0900137extern void scsi_req_abort_cmd(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +0200139extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
140 size_t *offset, size_t *len);
141extern void scsi_kunmap_atomic_sg(void *virt);
142
Boaz Harroshbb52d822007-12-13 16:14:27 -0800143extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask);
144extern void scsi_release_buffers(struct scsi_cmnd *cmd);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900145
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900146extern int scsi_dma_map(struct scsi_cmnd *cmd);
147extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
148
James Bottomley1c353f72008-03-13 11:19:36 -0500149struct scsi_cmnd *scsi_allocate_command(gfp_t gfp_mask);
150void scsi_free_command(gfp_t gfp_mask, struct scsi_cmnd *cmd);
151
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200152static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
153{
154 return cmd->sdb.table.nents;
155}
156
157static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
158{
159 return cmd->sdb.table.sgl;
160}
161
162static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
163{
164 return cmd->sdb.length;
165}
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900166
167static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
168{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200169 cmd->sdb.resid = resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900170}
171
172static inline int scsi_get_resid(struct scsi_cmnd *cmd)
173{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200174 return cmd->sdb.resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900175}
176
177#define scsi_for_each_sg(cmd, sg, nseg, __i) \
Jens Axboec6132da2007-10-16 11:08:49 +0200178 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900179
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200180static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
181{
182 return blk_bidi_rq(cmd->request) &&
183 (cmd->request->next_rq->special != NULL);
184}
185
186static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
187{
188 return scsi_bidi_cmnd(cmd) ?
189 cmd->request->next_rq->special : &cmd->sdb;
190}
191
192static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
193{
194 return &cmd->sdb;
195}
196
FUJITA Tomonori9ac16b62008-03-09 13:44:29 +0900197static inline int scsi_sg_copy_from_buffer(struct scsi_cmnd *cmd,
198 void *buf, int buflen)
199{
200 return sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
201 buf, buflen);
202}
203
204static inline int scsi_sg_copy_to_buffer(struct scsi_cmnd *cmd,
205 void *buf, int buflen)
206{
207 return sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
208 buf, buflen);
209}
210
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#endif /* _SCSI_SCSI_CMND_H */