blob: de28aab820b0cca9cdd7261c4000ee965f821e1d [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 Harrosh30b0c372007-12-13 13:47:40 +020014struct scsi_data_buffer {
15 struct sg_table table;
16 unsigned length;
17 int resid;
18};
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20/* embedded in scsi_cmnd */
21struct scsi_pointer {
22 char *ptr; /* data pointer */
23 int this_residual; /* left in this buffer */
24 struct scatterlist *buffer; /* which buffer */
25 int buffers_residual; /* how many buffers left */
26
27 dma_addr_t dma_handle;
28
29 volatile int Status;
30 volatile int Message;
31 volatile int have_data_in;
32 volatile int sent_command;
33 volatile int phase;
34};
35
36struct scsi_cmnd {
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct scsi_device *device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 struct list_head list; /* scsi_cmnd participates in queue lists */
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 struct list_head eh_entry; /* entry for the host eh_cmd_q */
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 int eh_eflags; /* Used by error handlr */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42 /*
c6295cd2005-04-03 14:59:11 -050043 * A SCSI Command is assigned a nonzero serial_number before passed
44 * to the driver's queue command function. The serial_number is
45 * cleared when scsi_done is entered indicating that the command
Matthew Wilcox12a44162007-09-18 19:54:43 -060046 * has been completed. It is a bug for LLDDs to use this number
47 * for purposes other than printk (and even that is only useful
48 * for debugging).
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 */
50 unsigned long serial_number;
Matthew Wilcox12a44162007-09-18 19:54:43 -060051
James Bottomleyb21a4132005-08-05 21:45:40 -050052 /*
53 * This is set to jiffies as it was when the command was first
54 * allocated. It is used to time how long the command has
55 * been outstanding
56 */
57 unsigned long jiffies_at_alloc;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59 int retries;
60 int allowed;
61 int timeout_per_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 unsigned char cmd_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 enum dma_data_direction sc_data_direction;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66 /* These elements define the operation we are about to perform */
67#define MAX_COMMAND_SIZE 16
68 unsigned char cmnd[MAX_COMMAND_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 struct timer_list eh_timeout; /* Used to time out the command. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72 /* These elements define the operation we ultimately want to perform */
Boaz Harrosh30b0c372007-12-13 13:47:40 +020073 struct scsi_data_buffer sdb;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 unsigned underflow; /* Return error if less than
75 this amount is transferred */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 unsigned transfersize; /* How much we are guaranteed to
78 transfer with each SCSI transfer
79 (ie, between disconnect /
80 reconnects. Probably == sector
81 size */
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 struct request *request; /* The command we are
84 working on */
85
86#define SCSI_SENSE_BUFFERSIZE 96
FUJITA Tomonoride25deb2008-01-16 13:32:17 +090087 unsigned char *sense_buffer;
Matthew Wilcoxc67a8482006-01-17 11:54:24 -070088 /* obtained by REQUEST SENSE when
89 * CHECK CONDITION is received on original
90 * command (auto-sense) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92 /* Low-level done function - can be used by low-level driver to point
93 * to completion function. Not used by mid/upper level code. */
94 void (*scsi_done) (struct scsi_cmnd *);
95
96 /*
97 * The following fields can be written to by the host specific code.
98 * Everything else should be left alone.
99 */
100 struct scsi_pointer SCp; /* Scratchpad used by some host adapters */
101
102 unsigned char *host_scribble; /* The host adapter is allowed to
Matthew Wilcoxc67a8482006-01-17 11:54:24 -0700103 * call scsi_malloc and get some memory
104 * and hang it here. The host adapter
105 * is also expected to call scsi_free
106 * to release this memory. (The memory
107 * obtained by scsi_malloc is guaranteed
108 * to be at an address < 16Mb). */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110 int result; /* Status code from lower level driver */
111
112 unsigned char tag; /* SCSI-II queued command tag */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
Al Viroc53033f2005-10-21 03:22:08 -0400115extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900116extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117extern void scsi_put_command(struct scsi_cmnd *);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900118extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *,
119 struct device *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120extern void scsi_finish_command(struct scsi_cmnd *cmd);
Luben Tuikov89f48c42006-05-15 20:57:18 +0900121extern void scsi_req_abort_cmd(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Guennadi Liakhovetskicdb8c2a2006-04-02 21:57:43 +0200123extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
124 size_t *offset, size_t *len);
125extern void scsi_kunmap_atomic_sg(void *virt);
126
Boaz Harroshbb52d822007-12-13 16:14:27 -0800127extern int scsi_init_io(struct scsi_cmnd *cmd, gfp_t gfp_mask);
128extern void scsi_release_buffers(struct scsi_cmnd *cmd);
FUJITA Tomonorib58d9152006-11-16 19:24:10 +0900129
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900130extern int scsi_dma_map(struct scsi_cmnd *cmd);
131extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
132
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200133static inline unsigned scsi_sg_count(struct scsi_cmnd *cmd)
134{
135 return cmd->sdb.table.nents;
136}
137
138static inline struct scatterlist *scsi_sglist(struct scsi_cmnd *cmd)
139{
140 return cmd->sdb.table.sgl;
141}
142
143static inline unsigned scsi_bufflen(struct scsi_cmnd *cmd)
144{
145 return cmd->sdb.length;
146}
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900147
148static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
149{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200150 cmd->sdb.resid = resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900151}
152
153static inline int scsi_get_resid(struct scsi_cmnd *cmd)
154{
Boaz Harrosh30b0c372007-12-13 13:47:40 +0200155 return cmd->sdb.resid;
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900156}
157
158#define scsi_for_each_sg(cmd, sg, nseg, __i) \
Jens Axboec6132da2007-10-16 11:08:49 +0200159 for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
FUJITA Tomonori824d7b52007-05-26 14:04:03 +0900160
Boaz Harrosh6f9a35e2007-12-13 13:50:53 +0200161static inline int scsi_bidi_cmnd(struct scsi_cmnd *cmd)
162{
163 return blk_bidi_rq(cmd->request) &&
164 (cmd->request->next_rq->special != NULL);
165}
166
167static inline struct scsi_data_buffer *scsi_in(struct scsi_cmnd *cmd)
168{
169 return scsi_bidi_cmnd(cmd) ?
170 cmd->request->next_rq->special : &cmd->sdb;
171}
172
173static inline struct scsi_data_buffer *scsi_out(struct scsi_cmnd *cmd)
174{
175 return &cmd->sdb;
176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178#endif /* _SCSI_SCSI_CMND_H */