scsi: revert "[SCSI] Get rid of scsi_cmnd->done"
[linux-2.6.git] / include / 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/list.h>
6 #include <linux/types.h>
7 #include <linux/timer.h>
8 #include <linux/scatterlist.h>
9
10 struct request;
11 struct scatterlist;
12 struct Scsi_Host;
13 struct scsi_device;
14
15
16 /* embedded in scsi_cmnd */
17 struct scsi_pointer {
18         char *ptr;              /* data pointer */
19         int this_residual;      /* left in this buffer */
20         struct scatterlist *buffer;     /* which buffer */
21         int buffers_residual;   /* how many buffers left */
22
23         dma_addr_t dma_handle;
24
25         volatile int Status;
26         volatile int Message;
27         volatile int have_data_in;
28         volatile int sent_command;
29         volatile int phase;
30 };
31
32 struct scsi_cmnd {
33         struct scsi_device *device;
34         struct list_head list;  /* scsi_cmnd participates in queue lists */
35         struct list_head eh_entry; /* entry for the host eh_cmd_q */
36         int eh_eflags;          /* Used by error handlr */
37         void (*done) (struct scsi_cmnd *);      /* Mid-level done function */
38
39         /*
40          * A SCSI Command is assigned a nonzero serial_number before passed
41          * to the driver's queue command function.  The serial_number is
42          * cleared when scsi_done is entered indicating that the command
43          * has been completed.  It is a bug for LLDDs to use this number
44          * for purposes other than printk (and even that is only useful
45          * for debugging).
46          */
47         unsigned long serial_number;
48
49         /*
50          * This is set to jiffies as it was when the command was first
51          * allocated.  It is used to time how long the command has
52          * been outstanding
53          */
54         unsigned long jiffies_at_alloc;
55
56         int retries;
57         int allowed;
58         int timeout_per_command;
59
60         unsigned char cmd_len;
61         enum dma_data_direction sc_data_direction;
62
63         /* These elements define the operation we are about to perform */
64 #define MAX_COMMAND_SIZE        16
65         unsigned char cmnd[MAX_COMMAND_SIZE];
66         unsigned request_bufflen;       /* Actual request size */
67
68         struct timer_list eh_timeout;   /* Used to time out the command. */
69         void *request_buffer;           /* Actual requested buffer */
70
71         /* These elements define the operation we ultimately want to perform */
72         unsigned short use_sg;  /* Number of pieces of scatter-gather */
73         unsigned short __use_sg;
74
75         unsigned underflow;     /* Return error if less than
76                                    this amount is transferred */
77
78         unsigned transfersize;  /* How much we are guaranteed to
79                                    transfer with each SCSI transfer
80                                    (ie, between disconnect / 
81                                    reconnects.   Probably == sector
82                                    size */
83
84         int resid;              /* Number of bytes requested to be
85                                    transferred less actual number
86                                    transferred (0 if not supported) */
87
88         struct request *request;        /* The command we are
89                                            working on */
90
91 #define SCSI_SENSE_BUFFERSIZE   96
92         unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE];
93                                 /* obtained by REQUEST SENSE when
94                                  * CHECK CONDITION is received on original
95                                  * command (auto-sense) */
96
97         /* Low-level done function - can be used by low-level driver to point
98          *        to completion function.  Not used by mid/upper level code. */
99         void (*scsi_done) (struct scsi_cmnd *);
100
101         /*
102          * The following fields can be written to by the host specific code. 
103          * Everything else should be left alone. 
104          */
105         struct scsi_pointer SCp;        /* Scratchpad used by some host adapters */
106
107         unsigned char *host_scribble;   /* The host adapter is allowed to
108                                          * call scsi_malloc and get some memory
109                                          * and hang it here.  The host adapter
110                                          * is also expected to call scsi_free
111                                          * to release this memory.  (The memory
112                                          * obtained by scsi_malloc is guaranteed
113                                          * to be at an address < 16Mb). */
114
115         int result;             /* Status code from lower level driver */
116
117         unsigned char tag;      /* SCSI-II queued command tag */
118 };
119
120 extern struct scsi_cmnd *scsi_get_command(struct scsi_device *, gfp_t);
121 extern struct scsi_cmnd *__scsi_get_command(struct Scsi_Host *, gfp_t);
122 extern void scsi_put_command(struct scsi_cmnd *);
123 extern void __scsi_put_command(struct Scsi_Host *, struct scsi_cmnd *,
124                                struct device *);
125 extern void scsi_io_completion(struct scsi_cmnd *, unsigned int);
126 extern void scsi_finish_command(struct scsi_cmnd *cmd);
127 extern void scsi_req_abort_cmd(struct scsi_cmnd *cmd);
128
129 extern void *scsi_kmap_atomic_sg(struct scatterlist *sg, int sg_count,
130                                  size_t *offset, size_t *len);
131 extern void scsi_kunmap_atomic_sg(void *virt);
132
133 extern struct scatterlist *scsi_alloc_sgtable(struct scsi_cmnd *, gfp_t);
134 extern void scsi_free_sgtable(struct scsi_cmnd *);
135
136 extern int scsi_dma_map(struct scsi_cmnd *cmd);
137 extern void scsi_dma_unmap(struct scsi_cmnd *cmd);
138
139 #define scsi_sg_count(cmd) ((cmd)->use_sg)
140 #define scsi_sglist(cmd) ((struct scatterlist *)(cmd)->request_buffer)
141 #define scsi_bufflen(cmd) ((cmd)->request_bufflen)
142
143 static inline void scsi_set_resid(struct scsi_cmnd *cmd, int resid)
144 {
145         cmd->resid = resid;
146 }
147
148 static inline int scsi_get_resid(struct scsi_cmnd *cmd)
149 {
150         return cmd->resid;
151 }
152
153 #define scsi_for_each_sg(cmd, sg, nseg, __i)                    \
154         for_each_sg(scsi_sglist(cmd), sg, nseg, __i)
155
156 #endif /* _SCSI_SCSI_CMND_H */