/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
 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);
 28	bool (*intr_pending)(ctlr_info_t *h);
 29	unsigned long (*command_completed)(ctlr_info_t *h);
 30};
 31typedef 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
 58struct 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 PERF_MODE_INT	0
 89#	define DOORBELL_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 list_head reqQ;
107	struct list_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	 * 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;
157};
158
159/*  Defining the diffent access_methods
160 *
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 */
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
188
189#define  CISS_ERROR_BIT		0x02
190
191#define CCISS_INTR_ON 	1 
192#define CCISS_INTR_OFF	0
193
194
195/* CCISS_BOARD_READY_WAIT_SECS is how long to wait for a board
196 * to become ready, in seconds, before giving up on it.
197 * CCISS_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
198 * between polling the board to see if it is ready, in
199 * milliseconds.  CCISS_BOARD_READY_ITERATIONS is derived
200 * the above.
201 */
202#define CCISS_BOARD_READY_WAIT_SECS (120)
203#define CCISS_BOARD_NOT_READY_WAIT_SECS (100)
204#define CCISS_BOARD_READY_POLL_INTERVAL_MSECS (100)
205#define CCISS_BOARD_READY_ITERATIONS \
206	((CCISS_BOARD_READY_WAIT_SECS * 1000) / \
207		CCISS_BOARD_READY_POLL_INTERVAL_MSECS)
208#define CCISS_BOARD_NOT_READY_ITERATIONS \
209	((CCISS_BOARD_NOT_READY_WAIT_SECS * 1000) / \
210		CCISS_BOARD_READY_POLL_INTERVAL_MSECS)
211#define CCISS_POST_RESET_PAUSE_MSECS (3000)
212#define CCISS_POST_RESET_NOOP_INTERVAL_MSECS (4000)
213#define CCISS_POST_RESET_NOOP_RETRIES (12)
214#define CCISS_POST_RESET_NOOP_TIMEOUT_MSECS (10000)
215
216/* 
217	Send the command to the hardware 
218*/
219static void SA5_submit_command( ctlr_info_t *h, CommandList_struct *c) 
220{
221#ifdef CCISS_DEBUG
222	printk(KERN_WARNING "cciss%d: Sending %08x - down to controller\n",
223			h->ctlr, c->busaddr);
224#endif /* CCISS_DEBUG */
225         writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
226	readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
227	 h->commands_outstanding++;
228	 if ( h->commands_outstanding > h->max_outstanding)
229		h->max_outstanding = h->commands_outstanding;
230}
231
232/*  
233 *  This card is the opposite of the other cards.  
234 *   0 turns interrupts on... 
235 *   0x08 turns them off... 
236 */
237static void SA5_intr_mask(ctlr_info_t *h, unsigned long val)
238{
239	if (val) 
240	{ /* Turn interrupts on */
241		h->interrupts_enabled = 1;
242		writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
243		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
244	} else /* Turn them off */
245	{
246		h->interrupts_enabled = 0;
247        	writel( SA5_INTR_OFF, 
248			h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
249		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
250	}
251}
252/*
253 *  This card is the opposite of the other cards.
254 *   0 turns interrupts on...
255 *   0x04 turns them off...
256 */
257static void SA5B_intr_mask(ctlr_info_t *h, unsigned long val)
258{
259        if (val)
260        { /* Turn interrupts on */
261		h->interrupts_enabled = 1;
262                writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
263		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
264        } else /* Turn them off */
265        {
266		h->interrupts_enabled = 0;
267                writel( SA5B_INTR_OFF,
268                        h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
269		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
270        }
271}
272
273/* Performant mode intr_mask */
274static void SA5_performant_intr_mask(ctlr_info_t *h, unsigned long val)
275{
276	if (val) { /* turn on interrupts */
277		h->interrupts_enabled = 1;
278		writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
279		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
280	} else {
281		h->interrupts_enabled = 0;
282		writel(SA5_PERF_INTR_OFF,
283				h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
284		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
285	}
286}
287
288/*
289 *  Returns true if fifo is full.  
290 * 
291 */ 
292static unsigned long SA5_fifo_full(ctlr_info_t *h)
293{
294	if( h->commands_outstanding >= h->max_commands)
295		return(1);
296	else 
297		return(0);
298
299}
300/* 
301 *   returns value read from hardware. 
302 *     returns FIFO_EMPTY if there is nothing to read 
303 */ 
304static unsigned long SA5_completed(ctlr_info_t *h)
305{
306	unsigned long register_value 
307		= readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
308	if(register_value != FIFO_EMPTY)
309	{
310		h->commands_outstanding--;
311#ifdef CCISS_DEBUG
312		printk("cciss:  Read %lx back from board\n", register_value);
313#endif /* CCISS_DEBUG */ 
314	} 
315#ifdef CCISS_DEBUG
316	else
317	{
318		printk("cciss:  FIFO Empty read\n");
319	}
320#endif 
321	return ( register_value); 
322
323}
324
325/* Performant mode command completed */
326static unsigned long SA5_performant_completed(ctlr_info_t *h)
327{
328	unsigned long register_value = FIFO_EMPTY;
329
330	/* flush the controller write of the reply queue by reading
331	 * outbound doorbell status register.
332	 */
333	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
334	/* msi auto clears the interrupt pending bit. */
335	if (!(h->msi_vector || h->msix_vector)) {
336		writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
337		/* Do a read in order to flush the write to the controller
338		 * (as per spec.)
339		 */
340		register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
341	}
342
343	if ((*(h->reply_pool_head) & 1) == (h->reply_pool_wraparound)) {
344		register_value = *(h->reply_pool_head);
345		(h->reply_pool_head)++;
346		h->commands_outstanding--;
347	} else {
348		register_value = FIFO_EMPTY;
349	}
350	/* Check for wraparound */
351	if (h->reply_pool_head == (h->reply_pool + h->max_commands)) {
352		h->reply_pool_head = h->reply_pool;
353		h->reply_pool_wraparound ^= 1;
354	}
355
356	return register_value;
357}
358/*
359 *	Returns true if an interrupt is pending.. 
360 */
361static bool SA5_intr_pending(ctlr_info_t *h)
362{
363	unsigned long register_value  = 
364		readl(h->vaddr + SA5_INTR_STATUS);
365#ifdef CCISS_DEBUG
366	printk("cciss: intr_pending %lx\n", register_value);
367#endif  /* CCISS_DEBUG */
368	if( register_value &  SA5_INTR_PENDING) 
369		return  1;	
370	return 0 ;
371}
372
373/*
374 *      Returns true if an interrupt is pending..
375 */
376static bool SA5B_intr_pending(ctlr_info_t *h)
377{
378        unsigned long register_value  =
379                readl(h->vaddr + SA5_INTR_STATUS);
380#ifdef CCISS_DEBUG
381        printk("cciss: intr_pending %lx\n", register_value);
382#endif  /* CCISS_DEBUG */
383        if( register_value &  SA5B_INTR_PENDING)
384                return  1;
385        return 0 ;
386}
387
388static bool SA5_performant_intr_pending(ctlr_info_t *h)
389{
390	unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
391
392	if (!register_value)
393		return false;
394
395	if (h->msi_vector || h->msix_vector)
396		return true;
397
398	/* Read outbound doorbell to flush */
399	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
400	return register_value & SA5_OUTDB_STATUS_PERF_BIT;
401}
402
403static struct access_method SA5_access = {
404	SA5_submit_command,
405	SA5_intr_mask,
406	SA5_fifo_full,
407	SA5_intr_pending,
408	SA5_completed,
409};
410
411static struct access_method SA5B_access = {
412        SA5_submit_command,
413        SA5B_intr_mask,
414        SA5_fifo_full,
415        SA5B_intr_pending,
416        SA5_completed,
417};
418
419static struct access_method SA5_performant_access = {
420	SA5_submit_command,
421	SA5_performant_intr_mask,
422	SA5_fifo_full,
423	SA5_performant_intr_pending,
424	SA5_performant_completed,
425};
426
427struct board_type {
428	__u32	board_id;
429	char	*product_name;
430	struct access_method *access;
431	int nr_cmds; /* Max cmds this kind of ctlr can handle. */
432};
433
434#endif /* CCISS_H */