xref: /linux/drivers/scsi/aacraid/sa.c (revision 14b42963f64b98ab61fa9723c03d71aa5ef4f862)
1 /*
2  *	Adaptec AAC series RAID controller driver
3  *	(c) Copyright 2001 Red Hat Inc.	<alan@redhat.com>
4  *
5  * based on the old aacraid driver that is..
6  * Adaptec aacraid device driver for Linux.
7  *
8  * Copyright (c) 2000 Adaptec, Inc. (aacraid@adaptec.com)
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2, or (at your option)
13  * any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; see the file COPYING.  If not, write to
22  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23  *
24  * Module Name:
25  *  sa.c
26  *
27  * Abstract: Drawbridge specific support functions
28  *
29  */
30 
31 #include <linux/kernel.h>
32 #include <linux/init.h>
33 #include <linux/types.h>
34 #include <linux/sched.h>
35 #include <linux/pci.h>
36 #include <linux/spinlock.h>
37 #include <linux/slab.h>
38 #include <linux/blkdev.h>
39 #include <linux/delay.h>
40 #include <linux/completion.h>
41 #include <linux/time.h>
42 #include <linux/interrupt.h>
43 #include <asm/semaphore.h>
44 
45 #include <scsi/scsi_host.h>
46 
47 #include "aacraid.h"
48 
49 static irqreturn_t aac_sa_intr(int irq, void *dev_id, struct pt_regs *regs)
50 {
51 	struct aac_dev *dev = dev_id;
52 	unsigned short intstat, mask;
53 
54 	intstat = sa_readw(dev, DoorbellReg_p);
55 	/*
56 	 *	Read mask and invert because drawbridge is reversed.
57 	 *	This allows us to only service interrupts that have been enabled.
58 	 */
59 	mask = ~(sa_readw(dev, SaDbCSR.PRISETIRQMASK));
60 
61 	/* Check to see if this is our interrupt.  If it isn't just return */
62 
63 	if (intstat & mask) {
64 		if (intstat & PrintfReady) {
65 			aac_printf(dev, sa_readl(dev, Mailbox5));
66 			sa_writew(dev, DoorbellClrReg_p, PrintfReady); /* clear PrintfReady */
67 			sa_writew(dev, DoorbellReg_s, PrintfDone);
68 		} else if (intstat & DOORBELL_1) {	// dev -> Host Normal Command Ready
69 			sa_writew(dev, DoorbellClrReg_p, DOORBELL_1);
70 			aac_command_normal(&dev->queues->queue[HostNormCmdQueue]);
71 		} else if (intstat & DOORBELL_2) {	// dev -> Host Normal Response Ready
72 			sa_writew(dev, DoorbellClrReg_p, DOORBELL_2);
73 			aac_response_normal(&dev->queues->queue[HostNormRespQueue]);
74 		} else if (intstat & DOORBELL_3) {	// dev -> Host Normal Command Not Full
75 			sa_writew(dev, DoorbellClrReg_p, DOORBELL_3);
76 		} else if (intstat & DOORBELL_4) {	// dev -> Host Normal Response Not Full
77 			sa_writew(dev, DoorbellClrReg_p, DOORBELL_4);
78 		}
79 		return IRQ_HANDLED;
80 	}
81 	return IRQ_NONE;
82 }
83 
84 /**
85  *	aac_sa_disable_interrupt	-	disable interrupt
86  *	@dev: Which adapter to enable.
87  */
88 
89 static void aac_sa_disable_interrupt (struct aac_dev *dev)
90 {
91 	sa_writew(dev, SaDbCSR.PRISETIRQMASK, 0xffff);
92 }
93 
94 /**
95  *	aac_sa_notify_adapter		-	handle adapter notification
96  *	@dev:	Adapter that notification is for
97  *	@event:	Event to notidy
98  *
99  *	Notify the adapter of an event
100  */
101 
102 static void aac_sa_notify_adapter(struct aac_dev *dev, u32 event)
103 {
104 	switch (event) {
105 
106 	case AdapNormCmdQue:
107 		sa_writew(dev, DoorbellReg_s,DOORBELL_1);
108 		break;
109 	case HostNormRespNotFull:
110 		sa_writew(dev, DoorbellReg_s,DOORBELL_4);
111 		break;
112 	case AdapNormRespQue:
113 		sa_writew(dev, DoorbellReg_s,DOORBELL_2);
114 		break;
115 	case HostNormCmdNotFull:
116 		sa_writew(dev, DoorbellReg_s,DOORBELL_3);
117 		break;
118 	case HostShutdown:
119 		/*
120 		sa_sync_cmd(dev, HOST_CRASHING, 0, 0, 0, 0, 0, 0,
121 		NULL, NULL, NULL, NULL, NULL);
122 		*/
123 		break;
124 	case FastIo:
125 		sa_writew(dev, DoorbellReg_s,DOORBELL_6);
126 		break;
127 	case AdapPrintfDone:
128 		sa_writew(dev, DoorbellReg_s,DOORBELL_5);
129 		break;
130 	default:
131 		BUG();
132 		break;
133 	}
134 }
135 
136 
137 /**
138  *	sa_sync_cmd	-	send a command and wait
139  *	@dev: Adapter
140  *	@command: Command to execute
141  *	@p1: first parameter
142  *	@ret: adapter status
143  *
144  *	This routine will send a synchronous command to the adapter and wait
145  *	for its	completion.
146  */
147 
148 static int sa_sync_cmd(struct aac_dev *dev, u32 command,
149 		u32 p1, u32 p2, u32 p3, u32 p4, u32 p5, u32 p6,
150 		u32 *ret, u32 *r1, u32 *r2, u32 *r3, u32 *r4)
151 {
152 	unsigned long start;
153  	int ok;
154 	/*
155 	 *	Write the Command into Mailbox 0
156 	 */
157 	sa_writel(dev, Mailbox0, command);
158 	/*
159 	 *	Write the parameters into Mailboxes 1 - 4
160 	 */
161 	sa_writel(dev, Mailbox1, p1);
162 	sa_writel(dev, Mailbox2, p2);
163 	sa_writel(dev, Mailbox3, p3);
164 	sa_writel(dev, Mailbox4, p4);
165 
166 	/*
167 	 *	Clear the synch command doorbell to start on a clean slate.
168 	 */
169 	sa_writew(dev, DoorbellClrReg_p, DOORBELL_0);
170 	/*
171 	 *	Signal that there is a new synch command
172 	 */
173 	sa_writew(dev, DoorbellReg_s, DOORBELL_0);
174 
175 	ok = 0;
176 	start = jiffies;
177 
178 	while(time_before(jiffies, start+30*HZ))
179 	{
180 		/*
181 		 *	Delay 5uS so that the monitor gets access
182 		 */
183 		udelay(5);
184 		/*
185 		 *	Mon110 will set doorbell0 bit when it has
186 		 *	completed the command.
187 		 */
188 		if(sa_readw(dev, DoorbellReg_p) & DOORBELL_0)  {
189 			ok = 1;
190 			break;
191 		}
192 		msleep(1);
193 	}
194 
195 	if (ok != 1)
196 		return -ETIMEDOUT;
197 	/*
198 	 *	Clear the synch command doorbell.
199 	 */
200 	sa_writew(dev, DoorbellClrReg_p, DOORBELL_0);
201 	/*
202 	 *	Pull the synch status from Mailbox 0.
203 	 */
204 	if (ret)
205 		*ret = sa_readl(dev, Mailbox0);
206 	if (r1)
207 		*r1 = sa_readl(dev, Mailbox1);
208 	if (r2)
209 		*r2 = sa_readl(dev, Mailbox2);
210 	if (r3)
211 		*r3 = sa_readl(dev, Mailbox3);
212 	if (r4)
213 		*r4 = sa_readl(dev, Mailbox4);
214 	return 0;
215 }
216 
217 /**
218  *	aac_sa_interrupt_adapter	-	interrupt an adapter
219  *	@dev: Which adapter to enable.
220  *
221  *	Breakpoint an adapter.
222  */
223 
224 static void aac_sa_interrupt_adapter (struct aac_dev *dev)
225 {
226 	sa_sync_cmd(dev, BREAKPOINT_REQUEST, 0, 0, 0, 0, 0, 0,
227 			NULL, NULL, NULL, NULL, NULL);
228 }
229 
230 /**
231  *	aac_sa_start_adapter		-	activate adapter
232  *	@dev:	Adapter
233  *
234  *	Start up processing on an ARM based AAC adapter
235  */
236 
237 static void aac_sa_start_adapter(struct aac_dev *dev)
238 {
239 	struct aac_init *init;
240 	/*
241 	 * Fill in the remaining pieces of the init.
242 	 */
243 	init = dev->init;
244 	init->HostElapsedSeconds = cpu_to_le32(get_seconds());
245 	/* We can only use a 32 bit address here */
246 	sa_sync_cmd(dev, INIT_STRUCT_BASE_ADDRESS,
247 			(u32)(ulong)dev->init_pa, 0, 0, 0, 0, 0,
248 			NULL, NULL, NULL, NULL, NULL);
249 }
250 
251 /**
252  *	aac_sa_check_health
253  *	@dev: device to check if healthy
254  *
255  *	Will attempt to determine if the specified adapter is alive and
256  *	capable of handling requests, returning 0 if alive.
257  */
258 static int aac_sa_check_health(struct aac_dev *dev)
259 {
260 	long status = sa_readl(dev, Mailbox7);
261 
262 	/*
263 	 *	Check to see if the board failed any self tests.
264 	 */
265 	if (status & SELF_TEST_FAILED)
266 		return -1;
267 	/*
268 	 *	Check to see if the board panic'd while booting.
269 	 */
270 	if (status & KERNEL_PANIC)
271 		return -2;
272 	/*
273 	 *	Wait for the adapter to be up and running. Wait up to 3 minutes
274 	 */
275 	if (!(status & KERNEL_UP_AND_RUNNING))
276 		return -3;
277 	/*
278 	 *	Everything is OK
279 	 */
280 	return 0;
281 }
282 
283 /**
284  *	aac_sa_init	-	initialize an ARM based AAC card
285  *	@dev: device to configure
286  *
287  *	Allocate and set up resources for the ARM based AAC variants. The
288  *	device_interface in the commregion will be allocated and linked
289  *	to the comm region.
290  */
291 
292 int aac_sa_init(struct aac_dev *dev)
293 {
294 	unsigned long start;
295 	unsigned long status;
296 	int instance;
297 	const char *name;
298 
299 	instance = dev->id;
300 	name     = dev->name;
301 
302 	/*
303 	 *	Check to see if the board failed any self tests.
304 	 */
305 	if (sa_readl(dev, Mailbox7) & SELF_TEST_FAILED) {
306 		printk(KERN_WARNING "%s%d: adapter self-test failed.\n", name, instance);
307 		goto error_iounmap;
308 	}
309 	/*
310 	 *	Check to see if the board panic'd while booting.
311 	 */
312 	if (sa_readl(dev, Mailbox7) & KERNEL_PANIC) {
313 		printk(KERN_WARNING "%s%d: adapter kernel panic'd.\n", name, instance);
314 		goto error_iounmap;
315 	}
316 	start = jiffies;
317 	/*
318 	 *	Wait for the adapter to be up and running. Wait up to 3 minutes.
319 	 */
320 	while (!(sa_readl(dev, Mailbox7) & KERNEL_UP_AND_RUNNING)) {
321 		if (time_after(jiffies, start+startup_timeout*HZ)) {
322 			status = sa_readl(dev, Mailbox7);
323 			printk(KERN_WARNING "%s%d: adapter kernel failed to start, init status = %lx.\n",
324 					name, instance, status);
325 			goto error_iounmap;
326 		}
327 		msleep(1);
328 	}
329 
330 	if (request_irq(dev->scsi_host_ptr->irq, aac_sa_intr, IRQF_SHARED|IRQF_DISABLED, "aacraid", (void *)dev ) < 0) {
331 		printk(KERN_WARNING "%s%d: Interrupt unavailable.\n", name, instance);
332 		goto error_iounmap;
333 	}
334 
335 	/*
336 	 *	Fill in the function dispatch table.
337 	 */
338 
339 	dev->a_ops.adapter_interrupt = aac_sa_interrupt_adapter;
340 	dev->a_ops.adapter_disable_int = aac_sa_disable_interrupt;
341 	dev->a_ops.adapter_notify = aac_sa_notify_adapter;
342 	dev->a_ops.adapter_sync_cmd = sa_sync_cmd;
343 	dev->a_ops.adapter_check_health = aac_sa_check_health;
344 
345 	/*
346 	 *	First clear out all interrupts.  Then enable the one's that
347 	 *	we can handle.
348 	 */
349 	sa_writew(dev, SaDbCSR.PRISETIRQMASK, 0xffff);
350 	sa_writew(dev, SaDbCSR.PRICLEARIRQMASK, (PrintfReady | DOORBELL_1 |
351 				DOORBELL_2 | DOORBELL_3 | DOORBELL_4));
352 
353 	if(aac_init_adapter(dev) == NULL)
354 		goto error_irq;
355 
356 	/*
357 	 *	Tell the adapter that all is configure, and it can start
358 	 *	accepting requests
359 	 */
360 	aac_sa_start_adapter(dev);
361 	return 0;
362 
363 error_irq:
364 	sa_writew(dev, SaDbCSR.PRISETIRQMASK, 0xffff);
365 	free_irq(dev->scsi_host_ptr->irq, (void *)dev);
366 
367 error_iounmap:
368 
369 	return -1;
370 }
371 
372