Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[linux-2.6.git] / drivers / block / cciss.h
1 #ifndef CCISS_H
2 #define CCISS_H
3
4 #include <linux/genhd.h>
5 #include <linux/mutex.h>
6
7 #include "cciss_cmd.h"
8
9
10 #define NWD_SHIFT       4
11 #define MAX_PART        (1 << NWD_SHIFT)
12
13 #define IO_OK           0
14 #define IO_ERROR        1
15 #define IO_NEEDS_RETRY  3
16
17 #define VENDOR_LEN      8
18 #define MODEL_LEN       16
19 #define REV_LEN         4
20
21 struct ctlr_info;
22 typedef struct ctlr_info ctlr_info_t;
23
24 struct access_method {
25         void (*submit_command)(ctlr_info_t *h, CommandList_struct *c);
26         void (*set_intr_mask)(ctlr_info_t *h, unsigned long val);
27         unsigned long (*fifo_full)(ctlr_info_t *h);
28         unsigned long (*intr_pending)(ctlr_info_t *h);
29         unsigned long (*command_completed)(ctlr_info_t *h);
30 };
31 typedef struct _drive_info_struct
32 {
33         unsigned char LunID[8];
34         int     usage_count;
35         struct request_queue *queue;
36         sector_t nr_blocks;
37         int     block_size;
38         int     heads;
39         int     sectors;
40         int     cylinders;
41         int     raid_level; /* set to -1 to indicate that
42                              * the drive is not in use/configured
43                              */
44         int     busy_configuring; /* This is set when a drive is being removed
45                                    * to prevent it from being opened or it's
46                                    * queue from being started.
47                                    */
48         struct  device dev;
49         __u8 serial_no[16]; /* from inquiry page 0x83,
50                              * not necc. null terminated.
51                              */
52         char vendor[VENDOR_LEN + 1]; /* SCSI vendor string */
53         char model[MODEL_LEN + 1];   /* SCSI model string */
54         char rev[REV_LEN + 1];       /* SCSI revision string */
55         char device_initialized;     /* indicates whether dev is initialized */
56 } drive_info_struct;
57
58 struct ctlr_info
59 {
60         int     ctlr;
61         char    devname[8];
62         char    *product_name;
63         char    firm_ver[4]; /* Firmware version */
64         struct pci_dev *pdev;
65         __u32   board_id;
66         void __iomem *vaddr;
67         unsigned long paddr;
68         int     nr_cmds; /* Number of commands allowed on this controller */
69         CfgTable_struct __iomem *cfgtable;
70         int     interrupts_enabled;
71         int     major;
72         int     max_commands;
73         int     commands_outstanding;
74         int     max_outstanding; /* Debug */ 
75         int     num_luns;
76         int     highest_lun;
77         int     usage_count;  /* number of opens all all minor devices */
78         /* Need space for temp sg list
79          * number of scatter/gathers supported
80          * number of scatter/gathers in chained block
81          */
82         struct  scatterlist **scatter_list;
83         int     maxsgentries;
84         int     chainsize;
85         int     max_cmd_sgentries;
86         SGDescriptor_struct **cmd_sg_list;
87
88 #       define DOORBELL_INT     0
89 #       define PERF_MODE_INT    1
90 #       define SIMPLE_MODE_INT  2
91 #       define MEMQ_MODE_INT    3
92         unsigned int intr[4];
93         unsigned int msix_vector;
94         unsigned int msi_vector;
95         int     cciss_max_sectors;
96         BYTE    cciss_read;
97         BYTE    cciss_write;
98         BYTE    cciss_read_capacity;
99
100         /* information about each logical volume */
101         drive_info_struct *drv[CISS_MAX_LUN];
102
103         struct access_method access;
104
105         /* queue and queue Info */ 
106         struct hlist_head reqQ;
107         struct hlist_head cmpQ;
108         unsigned int Qdepth;
109         unsigned int maxQsinceinit;
110         unsigned int maxSG;
111         spinlock_t lock;
112
113         /* pointers to command and error info pool */
114         CommandList_struct      *cmd_pool;
115         dma_addr_t              cmd_pool_dhandle; 
116         ErrorInfo_struct        *errinfo_pool;
117         dma_addr_t              errinfo_pool_dhandle; 
118         unsigned long           *cmd_pool_bits;
119         int                     nr_allocs;
120         int                     nr_frees; 
121         int                     busy_configuring;
122         int                     busy_initializing;
123         int                     busy_scanning;
124         struct mutex            busy_shutting_down;
125
126         /* This element holds the zero based queue number of the last
127          * queue to be started.  It is used for fairness.
128         */
129         int                     next_to_run;
130
131         /* Disk structures we need to pass back */
132         struct gendisk   *gendisk[CISS_MAX_LUN];
133 #ifdef CONFIG_CISS_SCSI_TAPE
134         struct cciss_scsi_adapter_data_t *scsi_ctlr;
135 #endif
136         unsigned char alive;
137         struct list_head scan_list;
138         struct completion scan_wait;
139         struct device dev;
140 };
141
142 /*  Defining the diffent access_menthods */
143 /*
144  * Memory mapped FIFO interface (SMART 53xx cards)
145  */
146 #define SA5_DOORBELL    0x20
147 #define SA5_REQUEST_PORT_OFFSET 0x40
148 #define SA5_REPLY_INTR_MASK_OFFSET      0x34
149 #define SA5_REPLY_PORT_OFFSET           0x44
150 #define SA5_INTR_STATUS         0x30
151 #define SA5_SCRATCHPAD_OFFSET   0xB0
152
153 #define SA5_CTCFG_OFFSET        0xB4
154 #define SA5_CTMEM_OFFSET        0xB8
155
156 #define SA5_INTR_OFF            0x08
157 #define SA5B_INTR_OFF           0x04
158 #define SA5_INTR_PENDING        0x08
159 #define SA5B_INTR_PENDING       0x04
160 #define FIFO_EMPTY              0xffffffff      
161 #define CCISS_FIRMWARE_READY    0xffff0000 /* value in scratchpad register */
162
163 #define  CISS_ERROR_BIT         0x02
164
165 #define CCISS_INTR_ON   1 
166 #define CCISS_INTR_OFF  0
167 /* 
168         Send the command to the hardware 
169 */
170 static void SA5_submit_command( ctlr_info_t *h, CommandList_struct *c) 
171 {
172 #ifdef CCISS_DEBUG
173          printk("Sending %x - down to controller\n", c->busaddr );
174 #endif /* CCISS_DEBUG */ 
175          writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
176          h->commands_outstanding++;
177          if ( h->commands_outstanding > h->max_outstanding)
178                 h->max_outstanding = h->commands_outstanding;
179 }
180
181 /*  
182  *  This card is the opposite of the other cards.  
183  *   0 turns interrupts on... 
184  *   0x08 turns them off... 
185  */
186 static void SA5_intr_mask(ctlr_info_t *h, unsigned long val)
187 {
188         if (val) 
189         { /* Turn interrupts on */
190                 h->interrupts_enabled = 1;
191                 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
192         } else /* Turn them off */
193         {
194                 h->interrupts_enabled = 0;
195                 writel( SA5_INTR_OFF, 
196                         h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
197         }
198 }
199 /*
200  *  This card is the opposite of the other cards.
201  *   0 turns interrupts on...
202  *   0x04 turns them off...
203  */
204 static void SA5B_intr_mask(ctlr_info_t *h, unsigned long val)
205 {
206         if (val)
207         { /* Turn interrupts on */
208                 h->interrupts_enabled = 1;
209                 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
210         } else /* Turn them off */
211         {
212                 h->interrupts_enabled = 0;
213                 writel( SA5B_INTR_OFF,
214                         h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
215         }
216 }
217 /*
218  *  Returns true if fifo is full.  
219  * 
220  */ 
221 static unsigned long SA5_fifo_full(ctlr_info_t *h)
222 {
223         if( h->commands_outstanding >= h->max_commands)
224                 return(1);
225         else 
226                 return(0);
227
228 }
229 /* 
230  *   returns value read from hardware. 
231  *     returns FIFO_EMPTY if there is nothing to read 
232  */ 
233 static unsigned long SA5_completed(ctlr_info_t *h)
234 {
235         unsigned long register_value 
236                 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
237         if(register_value != FIFO_EMPTY)
238         {
239                 h->commands_outstanding--;
240 #ifdef CCISS_DEBUG
241                 printk("cciss:  Read %lx back from board\n", register_value);
242 #endif /* CCISS_DEBUG */ 
243         } 
244 #ifdef CCISS_DEBUG
245         else
246         {
247                 printk("cciss:  FIFO Empty read\n");
248         }
249 #endif 
250         return ( register_value); 
251
252 }
253 /*
254  *      Returns true if an interrupt is pending.. 
255  */
256 static unsigned long SA5_intr_pending(ctlr_info_t *h)
257 {
258         unsigned long register_value  = 
259                 readl(h->vaddr + SA5_INTR_STATUS);
260 #ifdef CCISS_DEBUG
261         printk("cciss: intr_pending %lx\n", register_value);
262 #endif  /* CCISS_DEBUG */
263         if( register_value &  SA5_INTR_PENDING) 
264                 return  1;      
265         return 0 ;
266 }
267
268 /*
269  *      Returns true if an interrupt is pending..
270  */
271 static unsigned long SA5B_intr_pending(ctlr_info_t *h)
272 {
273         unsigned long register_value  =
274                 readl(h->vaddr + SA5_INTR_STATUS);
275 #ifdef CCISS_DEBUG
276         printk("cciss: intr_pending %lx\n", register_value);
277 #endif  /* CCISS_DEBUG */
278         if( register_value &  SA5B_INTR_PENDING)
279                 return  1;
280         return 0 ;
281 }
282
283
284 static struct access_method SA5_access = {
285         SA5_submit_command,
286         SA5_intr_mask,
287         SA5_fifo_full,
288         SA5_intr_pending,
289         SA5_completed,
290 };
291
292 static struct access_method SA5B_access = {
293         SA5_submit_command,
294         SA5B_intr_mask,
295         SA5_fifo_full,
296         SA5B_intr_pending,
297         SA5_completed,
298 };
299
300 struct board_type {
301         __u32   board_id;
302         char    *product_name;
303         struct access_method *access;
304         int nr_cmds; /* Max cmds this kind of ctlr can handle. */
305 };
306
307 #define CCISS_LOCK(i)   (&hba[i]->lock)
308
309 #endif /* CCISS_H */