blob: c5d411174db0fb282d019a391c94f723513a84ae [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef CCISS_H
2#define CCISS_H
3
4#include <linux/genhd.h>
Andrew Pattersonb368c9d2009-09-17 13:46:58 -05005#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7#include "cciss_cmd.h"
8
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#define NWD_SHIFT 4
11#define MAX_PART (1 << NWD_SHIFT)
12
13#define IO_OK 0
14#define IO_ERROR 1
scameron@beardog.cca.cpqcorp.net789a4242009-06-08 16:05:56 -050015#define IO_NEEDS_RETRY 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Andrew Patterson7fe06322009-06-02 14:48:39 +020017#define VENDOR_LEN 8
18#define MODEL_LEN 16
19#define REV_LEN 4
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct 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);
28 unsigned long (*intr_pending)(ctlr_info_t *h);
29 unsigned long (*command_completed)(ctlr_info_t *h);
30};
31typedef struct _drive_info_struct
32{
Stephen M. Cameron39ccf9a2009-09-17 13:48:00 -050033 unsigned char LunID[8];
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 int usage_count;
Mike Millerad2b9312005-07-28 01:07:31 -070035 struct request_queue *queue;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 sector_t nr_blocks;
37 int block_size;
38 int heads;
39 int sectors;
40 int cylinders;
Mike Millerddd47442005-09-13 01:25:22 -070041 int raid_level; /* set to -1 to indicate that
42 * the drive is not in use/configured
Andrew Patterson7fe06322009-06-02 14:48:39 +020043 */
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 */
Stephen M. Cameron9cef0d22009-09-17 13:48:31 -050048 struct device dev;
Andrew Patterson7fe06322009-06-02 14:48:39 +020049 __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 */
Stephen M. Cameron9cef0d22009-09-17 13:48:31 -050055 char device_initialized; /* indicates whether dev is initialized */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056} drive_info_struct;
57
Don Brace5c07a312009-11-12 12:50:01 -060058struct ctlr_info
Linus Torvalds1da177e2005-04-16 15:20:36 -070059{
60 int ctlr;
61 char devname[8];
62 char *product_name;
dann frazierb0284612010-02-17 16:53:31 -070063 char firm_ver[4]; /* Firmware version */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 struct pci_dev *pdev;
65 __u32 board_id;
66 void __iomem *vaddr;
67 unsigned long paddr;
Mike Millerf8806322006-12-06 20:35:01 -080068 int nr_cmds; /* Number of commands allowed on this controller */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 CfgTable_struct __iomem *cfgtable;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 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 */
Don Brace5c07a312009-11-12 12:50:01 -060078 /* 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;
Stephen M. Camerondccc9b52010-02-26 16:01:27 -060086 SGDescriptor_struct **cmd_sg_list;
Don Brace5c07a312009-11-12 12:50:01 -060087
Mike Millerfb86a352006-01-08 01:03:50 -080088# 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;
Mike Miller92c4231a2006-12-06 20:35:06 -080095 int cciss_max_sectors;
Mike Miller (OS Dev)00988a32006-09-30 23:27:23 -070096 BYTE cciss_read;
97 BYTE cciss_write;
98 BYTE cciss_read_capacity;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
dann frazierb0284612010-02-17 16:53:31 -0700100 /* information about each logical volume */
Stephen M. Cameron9cef0d22009-09-17 13:48:31 -0500101 drive_info_struct *drv[CISS_MAX_LUN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 struct access_method access;
104
105 /* queue and queue Info */
Jens Axboe8a3173d2008-11-20 09:46:09 +0100106 struct hlist_head reqQ;
107 struct hlist_head cmpQ;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 unsigned int Qdepth;
109 unsigned int maxQsinceinit;
110 unsigned int maxSG;
111 spinlock_t lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
dann frazierb0284612010-02-17 16:53:31 -0700113 /* pointers to command and error info pool */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 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;
Mike Miller1f8ef382005-09-13 01:25:21 -0700122 int busy_initializing;
Andrew Pattersonb368c9d2009-09-17 13:46:58 -0500123 int busy_scanning;
124 struct mutex busy_shutting_down;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
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
dann frazierb0284612010-02-17 16:53:31 -0700131 /* Disk structures we need to pass back */
Mike Miller799202c2006-12-06 20:35:12 -0800132 struct gendisk *gendisk[CISS_MAX_LUN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#ifdef CONFIG_CISS_SCSI_TAPE
Stephen M. Cameronaad9fb62010-02-26 16:01:42 -0600134 struct cciss_scsi_adapter_data_t *scsi_ctlr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135#endif
Mike Miller33079b22005-09-13 01:25:22 -0700136 unsigned char alive;
Andrew Pattersonb368c9d2009-09-17 13:46:58 -0500137 struct list_head scan_list;
138 struct completion scan_wait;
Andrew Patterson7fe06322009-06-02 14:48:39 +0200139 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
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*/
170static 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 */
186static 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 */
204static 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 */
221static 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 */
233static 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 */
256static 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 */
271static 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
284static 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
292static 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
300struct board_type {
301 __u32 board_id;
302 char *product_name;
303 struct access_method *access;
Mike Millerf8806322006-12-06 20:35:01 -0800304 int nr_cmds; /* Max cmds this kind of ctlr can handle. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305};
306
Mike Millerad2b9312005-07-28 01:07:31 -0700307#define CCISS_LOCK(i) (&hba[i]->lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309#endif /* CCISS_H */