]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/block/cciss.h
cciss: factor out cciss_find_memory_BAR()
[mirror_ubuntu-zesty-kernel.git] / drivers / block / cciss.h
CommitLineData
1da177e4
LT
1#ifndef CCISS_H
2#define CCISS_H
3
4#include <linux/genhd.h>
b368c9dd 5#include <linux/mutex.h>
1da177e4
LT
6
7#include "cciss_cmd.h"
8
9
1da177e4
LT
10#define NWD_SHIFT 4
11#define MAX_PART (1 << NWD_SHIFT)
12
13#define IO_OK 0
14#define IO_ERROR 1
789a424a 15#define IO_NEEDS_RETRY 3
1da177e4 16
7fe06326
AP
17#define VENDOR_LEN 8
18#define MODEL_LEN 16
19#define REV_LEN 4
20
1da177e4
LT
21struct ctlr_info;
22typedef struct ctlr_info ctlr_info_t;
23
24struct 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);
1d141441 28 bool (*intr_pending)(ctlr_info_t *h);
1da177e4
LT
29 unsigned long (*command_completed)(ctlr_info_t *h);
30};
31typedef struct _drive_info_struct
32{
39ccf9a6 33 unsigned char LunID[8];
1da177e4 34 int usage_count;
ad2b9312 35 struct request_queue *queue;
1da177e4
LT
36 sector_t nr_blocks;
37 int block_size;
38 int heads;
39 int sectors;
40 int cylinders;
ddd47442
MM
41 int raid_level; /* set to -1 to indicate that
42 * the drive is not in use/configured
7fe06326
AP
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 */
9cef0d2f 48 struct device dev;
7fe06326
AP
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 */
9cef0d2f 55 char device_initialized; /* indicates whether dev is initialized */
1da177e4
LT
56} drive_info_struct;
57
5c07a311 58struct ctlr_info
1da177e4
LT
59{
60 int ctlr;
61 char devname[8];
62 char *product_name;
b028461d 63 char firm_ver[4]; /* Firmware version */
1da177e4
LT
64 struct pci_dev *pdev;
65 __u32 board_id;
66 void __iomem *vaddr;
67 unsigned long paddr;
f880632f 68 int nr_cmds; /* Number of commands allowed on this controller */
1da177e4 69 CfgTable_struct __iomem *cfgtable;
1da177e4
LT
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 */
5c07a311
DB
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;
dccc9b56 86 SGDescriptor_struct **cmd_sg_list;
5c07a311 87
5e216153
MM
88# define PERF_MODE_INT 0
89# define DOORBELL_INT 1
fb86a35b
MM
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;
92c4231a 95 int cciss_max_sectors;
00988a35
MMOD
96 BYTE cciss_read;
97 BYTE cciss_write;
98 BYTE cciss_read_capacity;
1da177e4 99
b028461d 100 /* information about each logical volume */
9cef0d2f 101 drive_info_struct *drv[CISS_MAX_LUN];
1da177e4
LT
102
103 struct access_method access;
104
105 /* queue and queue Info */
8a3173de
JA
106 struct hlist_head reqQ;
107 struct hlist_head cmpQ;
1da177e4
LT
108 unsigned int Qdepth;
109 unsigned int maxQsinceinit;
110 unsigned int maxSG;
111 spinlock_t lock;
1da177e4 112
b028461d 113 /* pointers to command and error info pool */
1da177e4
LT
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;
1f8ef380 122 int busy_initializing;
b368c9dd
AP
123 int busy_scanning;
124 struct mutex busy_shutting_down;
1da177e4
LT
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
b028461d 131 /* Disk structures we need to pass back */
799202cb 132 struct gendisk *gendisk[CISS_MAX_LUN];
1da177e4 133#ifdef CONFIG_CISS_SCSI_TAPE
aad9fb6f 134 struct cciss_scsi_adapter_data_t *scsi_ctlr;
1da177e4 135#endif
33079b21 136 unsigned char alive;
b368c9dd
AP
137 struct list_head scan_list;
138 struct completion scan_wait;
7fe06326 139 struct device dev;
5e216153
MM
140 /*
141 * Performant mode tables.
142 */
143 u32 trans_support;
144 u32 trans_offset;
145 struct TransTable_struct *transtable;
146 unsigned long transMethod;
147
148 /*
149 * Performant mode completion buffer
150 */
151 u64 *reply_pool;
152 dma_addr_t reply_pool_dhandle;
153 u64 *reply_pool_head;
154 size_t reply_pool_size;
155 unsigned char reply_pool_wraparound;
156 u32 *blockFetchTable;
1da177e4
LT
157};
158
5e216153
MM
159/* Defining the diffent access_methods
160 *
1da177e4
LT
161 * Memory mapped FIFO interface (SMART 53xx cards)
162 */
163#define SA5_DOORBELL 0x20
164#define SA5_REQUEST_PORT_OFFSET 0x40
165#define SA5_REPLY_INTR_MASK_OFFSET 0x34
166#define SA5_REPLY_PORT_OFFSET 0x44
167#define SA5_INTR_STATUS 0x30
168#define SA5_SCRATCHPAD_OFFSET 0xB0
169
170#define SA5_CTCFG_OFFSET 0xB4
171#define SA5_CTMEM_OFFSET 0xB8
172
173#define SA5_INTR_OFF 0x08
174#define SA5B_INTR_OFF 0x04
175#define SA5_INTR_PENDING 0x08
176#define SA5B_INTR_PENDING 0x04
177#define FIFO_EMPTY 0xffffffff
178#define CCISS_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
5e216153
MM
179/* Perf. mode flags */
180#define SA5_PERF_INTR_PENDING 0x04
181#define SA5_PERF_INTR_OFF 0x05
182#define SA5_OUTDB_STATUS_PERF_BIT 0x01
183#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
184#define SA5_OUTDB_CLEAR 0xA0
185#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
186#define SA5_OUTDB_STATUS 0x9C
187
1da177e4
LT
188
189#define CISS_ERROR_BIT 0x02
190
191#define CCISS_INTR_ON 1
192#define CCISS_INTR_OFF 0
193/*
194 Send the command to the hardware
195*/
196static void SA5_submit_command( ctlr_info_t *h, CommandList_struct *c)
197{
198#ifdef CCISS_DEBUG
5e216153
MM
199 printk(KERN_WARNING "cciss%d: Sending %08x - down to controller\n",
200 h->ctlr, c->busaddr);
201#endif /* CCISS_DEBUG */
1da177e4
LT
202 writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
203 h->commands_outstanding++;
204 if ( h->commands_outstanding > h->max_outstanding)
205 h->max_outstanding = h->commands_outstanding;
206}
207
208/*
209 * This card is the opposite of the other cards.
210 * 0 turns interrupts on...
211 * 0x08 turns them off...
212 */
213static void SA5_intr_mask(ctlr_info_t *h, unsigned long val)
214{
215 if (val)
216 { /* Turn interrupts on */
217 h->interrupts_enabled = 1;
218 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
219 } else /* Turn them off */
220 {
221 h->interrupts_enabled = 0;
222 writel( SA5_INTR_OFF,
223 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
224 }
225}
226/*
227 * This card is the opposite of the other cards.
228 * 0 turns interrupts on...
229 * 0x04 turns them off...
230 */
231static void SA5B_intr_mask(ctlr_info_t *h, unsigned long val)
232{
233 if (val)
234 { /* Turn interrupts on */
235 h->interrupts_enabled = 1;
236 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
237 } else /* Turn them off */
238 {
239 h->interrupts_enabled = 0;
240 writel( SA5B_INTR_OFF,
241 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
242 }
243}
5e216153
MM
244
245/* Performant mode intr_mask */
246static void SA5_performant_intr_mask(ctlr_info_t *h, unsigned long val)
247{
248 if (val) { /* turn on interrupts */
249 h->interrupts_enabled = 1;
250 writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
251 } else {
252 h->interrupts_enabled = 0;
253 writel(SA5_PERF_INTR_OFF,
254 h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
255 }
256}
257
1da177e4
LT
258/*
259 * Returns true if fifo is full.
260 *
261 */
262static unsigned long SA5_fifo_full(ctlr_info_t *h)
263{
264 if( h->commands_outstanding >= h->max_commands)
265 return(1);
266 else
267 return(0);
268
269}
270/*
271 * returns value read from hardware.
272 * returns FIFO_EMPTY if there is nothing to read
273 */
274static unsigned long SA5_completed(ctlr_info_t *h)
275{
276 unsigned long register_value
277 = readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
278 if(register_value != FIFO_EMPTY)
279 {
280 h->commands_outstanding--;
281#ifdef CCISS_DEBUG
282 printk("cciss: Read %lx back from board\n", register_value);
283#endif /* CCISS_DEBUG */
284 }
285#ifdef CCISS_DEBUG
286 else
287 {
288 printk("cciss: FIFO Empty read\n");
289 }
290#endif
291 return ( register_value);
292
293}
5e216153
MM
294
295/* Performant mode command completed */
296static unsigned long SA5_performant_completed(ctlr_info_t *h)
297{
298 unsigned long register_value = FIFO_EMPTY;
299
300 /* flush the controller write of the reply queue by reading
301 * outbound doorbell status register.
302 */
303 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
304 /* msi auto clears the interrupt pending bit. */
305 if (!(h->msi_vector || h->msix_vector)) {
306 writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
307 /* Do a read in order to flush the write to the controller
308 * (as per spec.)
309 */
310 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
311 }
312
313 if ((*(h->reply_pool_head) & 1) == (h->reply_pool_wraparound)) {
314 register_value = *(h->reply_pool_head);
315 (h->reply_pool_head)++;
316 h->commands_outstanding--;
317 } else {
318 register_value = FIFO_EMPTY;
319 }
320 /* Check for wraparound */
321 if (h->reply_pool_head == (h->reply_pool + h->max_commands)) {
322 h->reply_pool_head = h->reply_pool;
323 h->reply_pool_wraparound ^= 1;
324 }
325
326 return register_value;
327}
1da177e4
LT
328/*
329 * Returns true if an interrupt is pending..
330 */
1d141441 331static bool SA5_intr_pending(ctlr_info_t *h)
1da177e4
LT
332{
333 unsigned long register_value =
334 readl(h->vaddr + SA5_INTR_STATUS);
335#ifdef CCISS_DEBUG
336 printk("cciss: intr_pending %lx\n", register_value);
337#endif /* CCISS_DEBUG */
338 if( register_value & SA5_INTR_PENDING)
339 return 1;
340 return 0 ;
341}
342
343/*
344 * Returns true if an interrupt is pending..
345 */
1d141441 346static bool SA5B_intr_pending(ctlr_info_t *h)
1da177e4
LT
347{
348 unsigned long register_value =
349 readl(h->vaddr + SA5_INTR_STATUS);
350#ifdef CCISS_DEBUG
351 printk("cciss: intr_pending %lx\n", register_value);
352#endif /* CCISS_DEBUG */
353 if( register_value & SA5B_INTR_PENDING)
354 return 1;
355 return 0 ;
356}
357
5e216153
MM
358static bool SA5_performant_intr_pending(ctlr_info_t *h)
359{
360 unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
361
362 if (!register_value)
363 return false;
364
365 if (h->msi_vector || h->msix_vector)
366 return true;
367
368 /* Read outbound doorbell to flush */
369 register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
370 return register_value & SA5_OUTDB_STATUS_PERF_BIT;
371}
1da177e4
LT
372
373static struct access_method SA5_access = {
374 SA5_submit_command,
375 SA5_intr_mask,
376 SA5_fifo_full,
377 SA5_intr_pending,
378 SA5_completed,
379};
380
381static struct access_method SA5B_access = {
382 SA5_submit_command,
383 SA5B_intr_mask,
384 SA5_fifo_full,
385 SA5B_intr_pending,
386 SA5_completed,
387};
388
5e216153
MM
389static struct access_method SA5_performant_access = {
390 SA5_submit_command,
391 SA5_performant_intr_mask,
392 SA5_fifo_full,
393 SA5_performant_intr_pending,
394 SA5_performant_completed,
395};
396
1da177e4
LT
397struct board_type {
398 __u32 board_id;
399 char *product_name;
400 struct access_method *access;
f880632f 401 int nr_cmds; /* Max cmds this kind of ctlr can handle. */
1da177e4
LT
402};
403
ad2b9312 404#define CCISS_LOCK(i) (&hba[i]->lock)
1da177e4
LT
405
406#endif /* CCISS_H */