aac.c revision 125542
1/*-
2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2001 Scott Long
4 * Copyright (c) 2000 BSDi
5 * Copyright (c) 2001 Adaptec, Inc.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: head/sys/dev/aac/aac.c 125542 2004-02-07 03:26:38Z scottl $");
32
33/*
34 * Driver for the Adaptec 'FSA' family of PCI/SCSI RAID adapters.
35 */
36
37#include "opt_aac.h"
38
39/* #include <stddef.h> */
40#include <sys/param.h>
41#include <sys/systm.h>
42#include <sys/malloc.h>
43#include <sys/kernel.h>
44#include <sys/kthread.h>
45#include <sys/sysctl.h>
46#include <sys/poll.h>
47#include <sys/ioccom.h>
48
49#include <sys/bus.h>
50#include <sys/conf.h>
51#include <sys/signalvar.h>
52#include <sys/time.h>
53#include <sys/eventhandler.h>
54
55#include <machine/bus_memio.h>
56#include <machine/bus.h>
57#include <machine/resource.h>
58
59#include <dev/aac/aacreg.h>
60#include <dev/aac/aac_ioctl.h>
61#include <dev/aac/aacvar.h>
62#include <dev/aac/aac_tables.h>
63
64static void	aac_startup(void *arg);
65static void	aac_add_container(struct aac_softc *sc,
66				  struct aac_mntinforesp *mir, int f);
67static void	aac_get_bus_info(struct aac_softc *sc);
68
69/* Command Processing */
70static void	aac_timeout(struct aac_softc *sc);
71static int	aac_map_command(struct aac_command *cm);
72static void	aac_complete(void *context, int pending);
73static int	aac_bio_command(struct aac_softc *sc, struct aac_command **cmp);
74static void	aac_bio_complete(struct aac_command *cm);
75static int	aac_wait_command(struct aac_command *cm, int timeout);
76static void	aac_command_thread(struct aac_softc *sc);
77
78/* Command Buffer Management */
79static void	aac_map_command_sg(void *arg, bus_dma_segment_t *segs,
80				   int nseg, int error);
81static void	aac_map_command_helper(void *arg, bus_dma_segment_t *segs,
82				       int nseg, int error);
83static int	aac_alloc_commands(struct aac_softc *sc);
84static void	aac_free_commands(struct aac_softc *sc);
85static void	aac_unmap_command(struct aac_command *cm);
86
87/* Hardware Interface */
88static void	aac_common_map(void *arg, bus_dma_segment_t *segs, int nseg,
89			       int error);
90static int	aac_check_firmware(struct aac_softc *sc);
91static int	aac_init(struct aac_softc *sc);
92static int	aac_sync_command(struct aac_softc *sc, u_int32_t command,
93				 u_int32_t arg0, u_int32_t arg1, u_int32_t arg2,
94				 u_int32_t arg3, u_int32_t *sp);
95static int	aac_enqueue_fib(struct aac_softc *sc, int queue,
96				struct aac_command *cm);
97static int	aac_dequeue_fib(struct aac_softc *sc, int queue,
98				u_int32_t *fib_size, struct aac_fib **fib_addr);
99static int	aac_enqueue_response(struct aac_softc *sc, int queue,
100				     struct aac_fib *fib);
101
102/* Falcon/PPC interface */
103static int	aac_fa_get_fwstatus(struct aac_softc *sc);
104static void	aac_fa_qnotify(struct aac_softc *sc, int qbit);
105static int	aac_fa_get_istatus(struct aac_softc *sc);
106static void	aac_fa_clear_istatus(struct aac_softc *sc, int mask);
107static void	aac_fa_set_mailbox(struct aac_softc *sc, u_int32_t command,
108				   u_int32_t arg0, u_int32_t arg1,
109				   u_int32_t arg2, u_int32_t arg3);
110static int	aac_fa_get_mailbox(struct aac_softc *sc, int mb);
111static void	aac_fa_set_interrupts(struct aac_softc *sc, int enable);
112
113struct aac_interface aac_fa_interface = {
114	aac_fa_get_fwstatus,
115	aac_fa_qnotify,
116	aac_fa_get_istatus,
117	aac_fa_clear_istatus,
118	aac_fa_set_mailbox,
119	aac_fa_get_mailbox,
120	aac_fa_set_interrupts
121};
122
123/* StrongARM interface */
124static int	aac_sa_get_fwstatus(struct aac_softc *sc);
125static void	aac_sa_qnotify(struct aac_softc *sc, int qbit);
126static int	aac_sa_get_istatus(struct aac_softc *sc);
127static void	aac_sa_clear_istatus(struct aac_softc *sc, int mask);
128static void	aac_sa_set_mailbox(struct aac_softc *sc, u_int32_t command,
129				   u_int32_t arg0, u_int32_t arg1,
130				   u_int32_t arg2, u_int32_t arg3);
131static int	aac_sa_get_mailbox(struct aac_softc *sc, int mb);
132static void	aac_sa_set_interrupts(struct aac_softc *sc, int enable);
133
134struct aac_interface aac_sa_interface = {
135	aac_sa_get_fwstatus,
136	aac_sa_qnotify,
137	aac_sa_get_istatus,
138	aac_sa_clear_istatus,
139	aac_sa_set_mailbox,
140	aac_sa_get_mailbox,
141	aac_sa_set_interrupts
142};
143
144/* i960Rx interface */
145static int	aac_rx_get_fwstatus(struct aac_softc *sc);
146static void	aac_rx_qnotify(struct aac_softc *sc, int qbit);
147static int	aac_rx_get_istatus(struct aac_softc *sc);
148static void	aac_rx_clear_istatus(struct aac_softc *sc, int mask);
149static void	aac_rx_set_mailbox(struct aac_softc *sc, u_int32_t command,
150				   u_int32_t arg0, u_int32_t arg1,
151				   u_int32_t arg2, u_int32_t arg3);
152static int	aac_rx_get_mailbox(struct aac_softc *sc, int mb);
153static void	aac_rx_set_interrupts(struct aac_softc *sc, int enable);
154
155struct aac_interface aac_rx_interface = {
156	aac_rx_get_fwstatus,
157	aac_rx_qnotify,
158	aac_rx_get_istatus,
159	aac_rx_clear_istatus,
160	aac_rx_set_mailbox,
161	aac_rx_get_mailbox,
162	aac_rx_set_interrupts
163};
164
165/* Debugging and Diagnostics */
166static void	aac_describe_controller(struct aac_softc *sc);
167static char	*aac_describe_code(struct aac_code_lookup *table,
168				   u_int32_t code);
169
170/* Management Interface */
171static d_open_t		aac_open;
172static d_close_t	aac_close;
173static d_ioctl_t	aac_ioctl;
174static d_poll_t		aac_poll;
175static int		aac_ioctl_sendfib(struct aac_softc *sc, caddr_t ufib);
176static void		aac_handle_aif(struct aac_softc *sc,
177					   struct aac_fib *fib);
178static int		aac_rev_check(struct aac_softc *sc, caddr_t udata);
179static int		aac_getnext_aif(struct aac_softc *sc, caddr_t arg);
180static int		aac_return_aif(struct aac_softc *sc, caddr_t uptr);
181static int		aac_query_disk(struct aac_softc *sc, caddr_t uptr);
182
183static struct cdevsw aac_cdevsw = {
184	.d_open =	aac_open,
185	.d_close =	aac_close,
186	.d_ioctl =	aac_ioctl,
187	.d_poll =	aac_poll,
188	.d_name =	"aac",
189};
190
191MALLOC_DEFINE(M_AACBUF, "aacbuf", "Buffers for the AAC driver");
192
193/* sysctl node */
194SYSCTL_NODE(_hw, OID_AUTO, aac, CTLFLAG_RD, 0, "AAC driver parameters");
195
196/*
197 * Device Interface
198 */
199
200/*
201 * Initialise the controller and softc
202 */
203int
204aac_attach(struct aac_softc *sc)
205{
206	int error, unit;
207
208	debug_called(1);
209
210	/*
211	 * Initialise per-controller queues.
212	 */
213	aac_initq_free(sc);
214	aac_initq_ready(sc);
215	aac_initq_busy(sc);
216	aac_initq_bio(sc);
217
218	/*
219	 * Initialise command-completion task.
220	 */
221	TASK_INIT(&sc->aac_task_complete, 0, aac_complete, sc);
222
223	/* disable interrupts before we enable anything */
224	AAC_MASK_INTERRUPTS(sc);
225
226	/* mark controller as suspended until we get ourselves organised */
227	sc->aac_state |= AAC_STATE_SUSPEND;
228
229	/*
230	 * Check that the firmware on the card is supported.
231	 */
232	if ((error = aac_check_firmware(sc)) != 0)
233		return(error);
234
235	/*
236	 * Initialize locks
237	 */
238	AAC_LOCK_INIT(&sc->aac_sync_lock, "AAC sync FIB lock");
239	AAC_LOCK_INIT(&sc->aac_aifq_lock, "AAC AIF lock");
240	AAC_LOCK_INIT(&sc->aac_io_lock, "AAC I/O lock");
241	AAC_LOCK_INIT(&sc->aac_container_lock, "AAC container lock");
242	TAILQ_INIT(&sc->aac_container_tqh);
243
244	/* Initialize the local AIF queue pointers */
245	sc->aac_aifq_head = sc->aac_aifq_tail = AAC_AIFQ_LENGTH;
246
247	/*
248	 * Initialise the adapter.
249	 */
250	if ((error = aac_init(sc)) != 0)
251		return(error);
252
253	/*
254	 * Print a little information about the controller.
255	 */
256	aac_describe_controller(sc);
257
258	/*
259	 * Register to probe our containers later.
260	 */
261	sc->aac_ich.ich_func = aac_startup;
262	sc->aac_ich.ich_arg = sc;
263	if (config_intrhook_establish(&sc->aac_ich) != 0) {
264		device_printf(sc->aac_dev,
265			      "can't establish configuration hook\n");
266		return(ENXIO);
267	}
268
269	/*
270	 * Make the control device.
271	 */
272	unit = device_get_unit(sc->aac_dev);
273	sc->aac_dev_t = make_dev(&aac_cdevsw, unit, UID_ROOT, GID_OPERATOR,
274				 0640, "aac%d", unit);
275	(void)make_dev_alias(sc->aac_dev_t, "afa%d", unit);
276	(void)make_dev_alias(sc->aac_dev_t, "hpn%d", unit);
277	sc->aac_dev_t->si_drv1 = sc;
278
279	/* Create the AIF thread */
280	if (kthread_create((void(*)(void *))aac_command_thread, sc,
281			   &sc->aifthread, 0, 0, "aac%daif", unit))
282		panic("Could not create AIF thread\n");
283
284	/* Register the shutdown method to only be called post-dump */
285	if ((sc->eh = EVENTHANDLER_REGISTER(shutdown_final, aac_shutdown,
286	    sc->aac_dev, SHUTDOWN_PRI_DEFAULT)) == NULL)
287		device_printf(sc->aac_dev,
288			      "shutdown event registration failed\n");
289
290	/* Register with CAM for the non-DASD devices */
291	if ((sc->flags & AAC_FLAGS_ENABLE_CAM) != 0) {
292		TAILQ_INIT(&sc->aac_sim_tqh);
293		aac_get_bus_info(sc);
294	}
295
296	return(0);
297}
298
299/*
300 * Probe for containers, create disks.
301 */
302static void
303aac_startup(void *arg)
304{
305	struct aac_softc *sc;
306	struct aac_fib *fib;
307	struct aac_mntinfo *mi;
308	struct aac_mntinforesp *mir = NULL;
309	int count = 0, i = 0;
310
311	debug_called(1);
312
313	sc = (struct aac_softc *)arg;
314
315	/* disconnect ourselves from the intrhook chain */
316	config_intrhook_disestablish(&sc->aac_ich);
317
318	aac_alloc_sync_fib(sc, &fib, 0);
319	mi = (struct aac_mntinfo *)&fib->data[0];
320
321	/* loop over possible containers */
322	do {
323		/* request information on this container */
324		bzero(mi, sizeof(struct aac_mntinfo));
325		mi->Command = VM_NameServe;
326		mi->MntType = FT_FILESYS;
327		mi->MntCount = i;
328		if (aac_sync_fib(sc, ContainerCommand, 0, fib,
329				 sizeof(struct aac_mntinfo))) {
330			printf("error probing container %d", i);
331			continue;
332		}
333
334		mir = (struct aac_mntinforesp *)&fib->data[0];
335		/* XXX Need to check if count changed */
336		count = mir->MntRespCount;
337		aac_add_container(sc, mir, 0);
338		i++;
339	} while ((i < count) && (i < AAC_MAX_CONTAINERS));
340
341	aac_release_sync_fib(sc);
342
343	/* poke the bus to actually attach the child devices */
344	if (bus_generic_attach(sc->aac_dev))
345		device_printf(sc->aac_dev, "bus_generic_attach failed\n");
346
347	/* mark the controller up */
348	sc->aac_state &= ~AAC_STATE_SUSPEND;
349
350	/* enable interrupts now */
351	AAC_UNMASK_INTERRUPTS(sc);
352}
353
354/*
355 * Create a device to respresent a new container
356 */
357static void
358aac_add_container(struct aac_softc *sc, struct aac_mntinforesp *mir, int f)
359{
360	struct aac_container *co;
361	device_t child;
362
363	/*
364	 * Check container volume type for validity.  Note that many of
365	 * the possible types may never show up.
366	 */
367	if ((mir->Status == ST_OK) && (mir->MntTable[0].VolType != CT_NONE)) {
368		co = (struct aac_container *)malloc(sizeof *co, M_AACBUF,
369		       M_NOWAIT | M_ZERO);
370		if (co == NULL)
371			panic("Out of memory?!\n");
372		debug(1, "id %x  name '%.16s'  size %u  type %d",
373		      mir->MntTable[0].ObjectId,
374		      mir->MntTable[0].FileSystemName,
375		      mir->MntTable[0].Capacity, mir->MntTable[0].VolType);
376
377		if ((child = device_add_child(sc->aac_dev, "aacd", -1)) == NULL)
378			device_printf(sc->aac_dev, "device_add_child failed\n");
379		else
380			device_set_ivars(child, co);
381		device_set_desc(child, aac_describe_code(aac_container_types,
382				mir->MntTable[0].VolType));
383		co->co_disk = child;
384		co->co_found = f;
385		bcopy(&mir->MntTable[0], &co->co_mntobj,
386		      sizeof(struct aac_mntobj));
387		AAC_LOCK_ACQUIRE(&sc->aac_container_lock);
388		TAILQ_INSERT_TAIL(&sc->aac_container_tqh, co, co_link);
389		AAC_LOCK_RELEASE(&sc->aac_container_lock);
390	}
391}
392
393/*
394 * Free all of the resources associated with (sc)
395 *
396 * Should not be called if the controller is active.
397 */
398void
399aac_free(struct aac_softc *sc)
400{
401
402	debug_called(1);
403
404	/* remove the control device */
405	if (sc->aac_dev_t != NULL)
406		destroy_dev(sc->aac_dev_t);
407
408	/* throw away any FIB buffers, discard the FIB DMA tag */
409	aac_free_commands(sc);
410	if (sc->aac_fib_dmat)
411		bus_dma_tag_destroy(sc->aac_fib_dmat);
412
413	free(sc->aac_commands, M_AACBUF);
414
415	/* destroy the common area */
416	if (sc->aac_common) {
417		bus_dmamap_unload(sc->aac_common_dmat, sc->aac_common_dmamap);
418		bus_dmamem_free(sc->aac_common_dmat, sc->aac_common,
419				sc->aac_common_dmamap);
420	}
421	if (sc->aac_common_dmat)
422		bus_dma_tag_destroy(sc->aac_common_dmat);
423
424	/* disconnect the interrupt handler */
425	if (sc->aac_intr)
426		bus_teardown_intr(sc->aac_dev, sc->aac_irq, sc->aac_intr);
427	if (sc->aac_irq != NULL)
428		bus_release_resource(sc->aac_dev, SYS_RES_IRQ, sc->aac_irq_rid,
429				     sc->aac_irq);
430
431	/* destroy data-transfer DMA tag */
432	if (sc->aac_buffer_dmat)
433		bus_dma_tag_destroy(sc->aac_buffer_dmat);
434
435	/* destroy the parent DMA tag */
436	if (sc->aac_parent_dmat)
437		bus_dma_tag_destroy(sc->aac_parent_dmat);
438
439	/* release the register window mapping */
440	if (sc->aac_regs_resource != NULL)
441		bus_release_resource(sc->aac_dev, SYS_RES_MEMORY,
442				     sc->aac_regs_rid, sc->aac_regs_resource);
443}
444
445/*
446 * Disconnect from the controller completely, in preparation for unload.
447 */
448int
449aac_detach(device_t dev)
450{
451	struct aac_softc *sc;
452	struct aac_container *co;
453	struct aac_sim	*sim;
454	int error;
455
456	debug_called(1);
457
458	sc = device_get_softc(dev);
459
460	if (sc->aac_state & AAC_STATE_OPEN)
461		return(EBUSY);
462
463	/* Remove the child containers */
464	while ((co = TAILQ_FIRST(&sc->aac_container_tqh)) != NULL) {
465		error = device_delete_child(dev, co->co_disk);
466		if (error)
467			return (error);
468		TAILQ_REMOVE(&sc->aac_container_tqh, co, co_link);
469		free(co, M_AACBUF);
470	}
471
472	/* Remove the CAM SIMs */
473	while ((sim = TAILQ_FIRST(&sc->aac_sim_tqh)) != NULL) {
474		TAILQ_REMOVE(&sc->aac_sim_tqh, sim, sim_link);
475		error = device_delete_child(dev, sim->sim_dev);
476		if (error)
477			return (error);
478		free(sim, M_AACBUF);
479	}
480
481	if (sc->aifflags & AAC_AIFFLAGS_RUNNING) {
482		sc->aifflags |= AAC_AIFFLAGS_EXIT;
483		wakeup(sc->aifthread);
484		tsleep(sc->aac_dev, PUSER | PCATCH, "aacdch", 30 * hz);
485	}
486
487	if (sc->aifflags & AAC_AIFFLAGS_RUNNING)
488		panic("Cannot shutdown AIF thread\n");
489
490	if ((error = aac_shutdown(dev)))
491		return(error);
492
493	EVENTHANDLER_DEREGISTER(shutdown_final, sc->eh);
494
495	aac_free(sc);
496
497	return(0);
498}
499
500/*
501 * Bring the controller down to a dormant state and detach all child devices.
502 *
503 * This function is called before detach or system shutdown.
504 *
505 * Note that we can assume that the bioq on the controller is empty, as we won't
506 * allow shutdown if any device is open.
507 */
508int
509aac_shutdown(device_t dev)
510{
511	struct aac_softc *sc;
512	struct aac_fib *fib;
513	struct aac_close_command *cc;
514
515	debug_called(1);
516
517	sc = device_get_softc(dev);
518
519	sc->aac_state |= AAC_STATE_SUSPEND;
520
521	/*
522	 * Send a Container shutdown followed by a HostShutdown FIB to the
523	 * controller to convince it that we don't want to talk to it anymore.
524	 * We've been closed and all I/O completed already
525	 */
526	device_printf(sc->aac_dev, "shutting down controller...");
527
528	aac_alloc_sync_fib(sc, &fib, AAC_SYNC_LOCK_FORCE);
529	cc = (struct aac_close_command *)&fib->data[0];
530
531	bzero(cc, sizeof(struct aac_close_command));
532	cc->Command = VM_CloseAll;
533	cc->ContainerId = 0xffffffff;
534	if (aac_sync_fib(sc, ContainerCommand, 0, fib,
535	    sizeof(struct aac_close_command)))
536		printf("FAILED.\n");
537	else
538		printf("done\n");
539#if 0
540	else {
541		fib->data[0] = 0;
542		/*
543		 * XXX Issuing this command to the controller makes it shut down
544		 * but also keeps it from coming back up without a reset of the
545		 * PCI bus.  This is not desirable if you are just unloading the
546		 * driver module with the intent to reload it later.
547		 */
548		if (aac_sync_fib(sc, FsaHostShutdown, AAC_FIBSTATE_SHUTDOWN,
549		    fib, 1)) {
550			printf("FAILED.\n");
551		} else {
552			printf("done.\n");
553		}
554	}
555#endif
556
557	AAC_MASK_INTERRUPTS(sc);
558
559	return(0);
560}
561
562/*
563 * Bring the controller to a quiescent state, ready for system suspend.
564 */
565int
566aac_suspend(device_t dev)
567{
568	struct aac_softc *sc;
569
570	debug_called(1);
571
572	sc = device_get_softc(dev);
573
574	sc->aac_state |= AAC_STATE_SUSPEND;
575
576	AAC_MASK_INTERRUPTS(sc);
577	return(0);
578}
579
580/*
581 * Bring the controller back to a state ready for operation.
582 */
583int
584aac_resume(device_t dev)
585{
586	struct aac_softc *sc;
587
588	debug_called(1);
589
590	sc = device_get_softc(dev);
591
592	sc->aac_state &= ~AAC_STATE_SUSPEND;
593	AAC_UNMASK_INTERRUPTS(sc);
594	return(0);
595}
596
597/*
598 * Take an interrupt.
599 */
600void
601aac_intr(void *arg)
602{
603	struct aac_softc *sc;
604	u_int16_t reason;
605
606	debug_called(2);
607
608	sc = (struct aac_softc *)arg;
609
610	/*
611	 * Read the status register directly.  This is faster than taking the
612	 * driver lock and reading the queues directly.  It also saves having
613	 * to turn parts of the driver lock into a spin mutex, which would be
614	 * ugly.
615	 */
616	reason = AAC_GET_ISTATUS(sc);
617	AAC_CLEAR_ISTATUS(sc, reason);
618
619	/* handle completion processing */
620	if (reason & AAC_DB_RESPONSE_READY)
621		taskqueue_enqueue_fast(taskqueue_fast, &sc->aac_task_complete);
622
623	/* controller wants to talk to us */
624	if (reason & (AAC_DB_PRINTF | AAC_DB_COMMAND_READY)) {
625		/*
626		 * XXX Make sure that we don't get fooled by strange messages
627		 * that start with a NULL.
628		 */
629		if ((reason & AAC_DB_PRINTF) &&
630		    (sc->aac_common->ac_printf[0] == 0))
631			sc->aac_common->ac_printf[0] = 32;
632
633		/*
634		 * This might miss doing the actual wakeup.  However, the
635		 * msleep that this is waking up has a timeout, so it will
636		 * wake up eventually.  AIFs and printfs are low enough
637		 * priority that they can handle hanging out for a few seconds
638		 * if needed.
639		 */
640		wakeup(sc->aifthread);
641	}
642}
643
644/*
645 * Command Processing
646 */
647
648/*
649 * Start as much queued I/O as possible on the controller
650 */
651void
652aac_startio(struct aac_softc *sc)
653{
654	struct aac_command *cm;
655
656	debug_called(2);
657
658	if (sc->flags & AAC_QUEUE_FRZN)
659		return;
660
661	for (;;) {
662		/*
663		 * Try to get a command that's been put off for lack of
664		 * resources
665		 */
666		cm = aac_dequeue_ready(sc);
667
668		/*
669		 * Try to build a command off the bio queue (ignore error
670		 * return)
671		 */
672		if (cm == NULL)
673			aac_bio_command(sc, &cm);
674
675		/* nothing to do? */
676		if (cm == NULL)
677			break;
678
679		/* try to give the command to the controller */
680		if (aac_map_command(cm) == EBUSY) {
681			/* put it on the ready queue for later */
682			aac_requeue_ready(cm);
683			break;
684		}
685	}
686}
687
688/*
689 * Deliver a command to the controller; allocate controller resources at the
690 * last moment when possible.
691 */
692static int
693aac_map_command(struct aac_command *cm)
694{
695	struct aac_softc *sc;
696	int error;
697
698	debug_called(2);
699
700	sc = cm->cm_sc;
701	error = 0;
702
703	/* don't map more than once */
704	if (cm->cm_flags & AAC_CMD_MAPPED)
705		return (0);
706
707	if (cm->cm_datalen != 0) {
708		error = bus_dmamap_load(sc->aac_buffer_dmat, cm->cm_datamap,
709					cm->cm_data, cm->cm_datalen,
710					aac_map_command_sg, cm, 0);
711		if (error == EINPROGRESS) {
712			debug(1, "freezing queue\n");
713			sc->flags |= AAC_QUEUE_FRZN;
714			error = 0;
715		}
716	} else {
717		aac_map_command_sg(cm, NULL, 0, 0);
718	}
719	return (error);
720}
721
722/*
723 * Handle notification of one or more FIBs coming from the controller.
724 */
725static void
726aac_command_thread(struct aac_softc *sc)
727{
728	struct aac_fib *fib;
729	u_int32_t fib_size;
730	int size, retval;
731
732	debug_called(2);
733
734	AAC_LOCK_ACQUIRE(&sc->aac_io_lock);
735	sc->aifflags = AAC_AIFFLAGS_RUNNING;
736
737	while ((sc->aifflags & AAC_AIFFLAGS_EXIT) == 0) {
738
739		retval = 0;
740		if ((sc->aifflags & AAC_AIFFLAGS_PENDING) == 0)
741			retval = msleep(sc->aifthread, &sc->aac_io_lock, PRIBIO,
742					"aifthd", AAC_PERIODIC_INTERVAL * hz);
743
744		/*
745		 * First see if any FIBs need to be allocated.  This needs
746		 * to be called without the driver lock because contigmalloc
747		 * will grab Giant, and would result in an LOR.
748		 */
749		if ((sc->aifflags & AAC_AIFFLAGS_ALLOCFIBS) != 0) {
750			sc->aifflags &= ~AAC_AIFFLAGS_ALLOCFIBS;
751			AAC_LOCK_RELEASE(&sc->aac_io_lock);
752			aac_alloc_commands(sc);
753			AAC_LOCK_ACQUIRE(&sc->aac_io_lock);
754			aac_startio(sc);
755		}
756
757		/*
758		 * While we're here, check to see if any commands are stuck.
759		 * This is pretty low-priority, so it's ok if it doesn't
760		 * always fire.
761		 */
762		if (retval == EWOULDBLOCK)
763			aac_timeout(sc);
764
765		/* Check the hardware printf message buffer */
766		if (sc->aac_common->ac_printf[0] != 0)
767			aac_print_printf(sc);
768
769		/* Also check to see if the adapter has a command for us. */
770		while (aac_dequeue_fib(sc, AAC_HOST_NORM_CMD_QUEUE,
771				       &fib_size, &fib) == 0) {
772
773			AAC_PRINT_FIB(sc, fib);
774
775			switch (fib->Header.Command) {
776			case AifRequest:
777				aac_handle_aif(sc, fib);
778				break;
779			default:
780				device_printf(sc->aac_dev, "unknown command "
781					      "from controller\n");
782				break;
783			}
784
785			if ((fib->Header.XferState == 0) ||
786			    (fib->Header.StructType != AAC_FIBTYPE_TFIB))
787				break;
788
789			/* Return the AIF to the controller. */
790			if (fib->Header.XferState & AAC_FIBSTATE_FROMADAP) {
791				fib->Header.XferState |= AAC_FIBSTATE_DONEHOST;
792				*(AAC_FSAStatus*)fib->data = ST_OK;
793
794				/* XXX Compute the Size field? */
795				size = fib->Header.Size;
796				if (size > sizeof(struct aac_fib)) {
797					size = sizeof(struct aac_fib);
798					fib->Header.Size = size;
799				}
800				/*
801				 * Since we did not generate this command, it
802				 * cannot go through the normal
803				 * enqueue->startio chain.
804				 */
805				aac_enqueue_response(sc,
806						     AAC_ADAP_NORM_RESP_QUEUE,
807						     fib);
808			}
809		}
810	}
811	sc->aifflags &= ~AAC_AIFFLAGS_RUNNING;
812	AAC_LOCK_RELEASE(&sc->aac_io_lock);
813	wakeup(sc->aac_dev);
814
815	mtx_lock(&Giant);
816	kthread_exit(0);
817}
818
819/*
820 * Process completed commands.
821 */
822static void
823aac_complete(void *context, int pending)
824{
825	struct aac_softc *sc;
826	struct aac_command *cm;
827	struct aac_fib *fib;
828	u_int32_t fib_size;
829
830	debug_called(2);
831
832	sc = (struct aac_softc *)context;
833
834	AAC_LOCK_ACQUIRE(&sc->aac_io_lock);
835
836	/* pull completed commands off the queue */
837	for (;;) {
838		/* look for completed FIBs on our queue */
839		if (aac_dequeue_fib(sc, AAC_HOST_NORM_RESP_QUEUE, &fib_size,
840				    &fib))
841			break;	/* nothing to do */
842
843		/* get the command, unmap and queue for later processing */
844		cm = sc->aac_commands + fib->Header.SenderData;
845		if (cm == NULL) {
846			AAC_PRINT_FIB(sc, fib);
847			break;
848		}
849
850		aac_remove_busy(cm);
851		aac_unmap_command(cm);		/* XXX defer? */
852		cm->cm_flags |= AAC_CMD_COMPLETED;
853
854		/* is there a completion handler? */
855		if (cm->cm_complete != NULL) {
856			cm->cm_complete(cm);
857		} else {
858			/* assume that someone is sleeping on this command */
859			wakeup(cm);
860		}
861	}
862
863	/* see if we can start some more I/O */
864	sc->flags &= ~AAC_QUEUE_FRZN;
865	aac_startio(sc);
866
867	AAC_LOCK_RELEASE(&sc->aac_io_lock);
868}
869
870/*
871 * Handle a bio submitted from a disk device.
872 */
873void
874aac_submit_bio(struct bio *bp)
875{
876	struct aac_disk *ad;
877	struct aac_softc *sc;
878
879	debug_called(2);
880
881	ad = (struct aac_disk *)bp->bio_disk->d_drv1;
882	sc = ad->ad_controller;
883
884	/* queue the BIO and try to get some work done */
885	aac_enqueue_bio(sc, bp);
886	aac_startio(sc);
887}
888
889/*
890 * Get a bio and build a command to go with it.
891 */
892static int
893aac_bio_command(struct aac_softc *sc, struct aac_command **cmp)
894{
895	struct aac_command *cm;
896	struct aac_fib *fib;
897	struct aac_disk *ad;
898	struct bio *bp;
899
900	debug_called(2);
901
902	/* get the resources we will need */
903	cm = NULL;
904	bp = NULL;
905	if (aac_alloc_command(sc, &cm))	/* get a command */
906		goto fail;
907	if ((bp = aac_dequeue_bio(sc)) == NULL)
908		goto fail;
909
910	/* fill out the command */
911	cm->cm_data = (void *)bp->bio_data;
912	cm->cm_datalen = bp->bio_bcount;
913	cm->cm_complete = aac_bio_complete;
914	cm->cm_private = bp;
915	cm->cm_timestamp = time_second;
916	cm->cm_queue = AAC_ADAP_NORM_CMD_QUEUE;
917
918	/* build the FIB */
919	fib = cm->cm_fib;
920	fib->Header.Size = sizeof(struct aac_fib_header);
921	fib->Header.XferState =
922		AAC_FIBSTATE_HOSTOWNED   |
923		AAC_FIBSTATE_INITIALISED |
924		AAC_FIBSTATE_EMPTY	 |
925		AAC_FIBSTATE_FROMHOST	 |
926		AAC_FIBSTATE_REXPECTED   |
927		AAC_FIBSTATE_NORM	 |
928		AAC_FIBSTATE_ASYNC	 |
929		AAC_FIBSTATE_FAST_RESPONSE;
930
931	/* build the read/write request */
932	ad = (struct aac_disk *)bp->bio_disk->d_drv1;
933
934	if ((sc->flags & AAC_FLAGS_SG_64BIT) == 0) {
935		fib->Header.Command = ContainerCommand;
936		if (bp->bio_cmd == BIO_READ) {
937			struct aac_blockread *br;
938			br = (struct aac_blockread *)&fib->data[0];
939			br->Command = VM_CtBlockRead;
940			br->ContainerId = ad->ad_container->co_mntobj.ObjectId;
941			br->BlockNumber = bp->bio_pblkno;
942			br->ByteCount = bp->bio_bcount;
943			fib->Header.Size += sizeof(struct aac_blockread);
944			cm->cm_sgtable = &br->SgMap;
945			cm->cm_flags |= AAC_CMD_DATAIN;
946		} else {
947			struct aac_blockwrite *bw;
948			bw = (struct aac_blockwrite *)&fib->data[0];
949			bw->Command = VM_CtBlockWrite;
950			bw->ContainerId = ad->ad_container->co_mntobj.ObjectId;
951			bw->BlockNumber = bp->bio_pblkno;
952			bw->ByteCount = bp->bio_bcount;
953			bw->Stable = CUNSTABLE;
954			fib->Header.Size += sizeof(struct aac_blockwrite);
955			cm->cm_flags |= AAC_CMD_DATAOUT;
956			cm->cm_sgtable = &bw->SgMap;
957		}
958	} else {
959		fib->Header.Command = ContainerCommand64;
960		if (bp->bio_cmd == BIO_READ) {
961			struct aac_blockread64 *br;
962			br = (struct aac_blockread64 *)&fib->data[0];
963			br->Command = VM_CtHostRead64;
964			br->ContainerId = ad->ad_container->co_mntobj.ObjectId;
965			br->SectorCount = bp->bio_bcount / AAC_BLOCK_SIZE;
966			br->BlockNumber = bp->bio_pblkno;
967			br->Pad = 0;
968			br->Flags = 0;
969			fib->Header.Size += sizeof(struct aac_blockread64);
970			cm->cm_flags |= AAC_CMD_DATAOUT;
971			(struct aac_sg_table64 *)cm->cm_sgtable = &br->SgMap64;
972		} else {
973			struct aac_blockwrite64 *bw;
974			bw = (struct aac_blockwrite64 *)&fib->data[0];
975			bw->Command = VM_CtHostWrite64;
976			bw->ContainerId = ad->ad_container->co_mntobj.ObjectId;
977			bw->SectorCount = bp->bio_bcount / AAC_BLOCK_SIZE;
978			bw->BlockNumber = bp->bio_pblkno;
979			bw->Pad = 0;
980			bw->Flags = 0;
981			fib->Header.Size += sizeof(struct aac_blockwrite64);
982			cm->cm_flags |= AAC_CMD_DATAIN;
983			(struct aac_sg_table64 *)cm->cm_sgtable = &bw->SgMap64;
984		}
985	}
986
987	*cmp = cm;
988	return(0);
989
990fail:
991	if (bp != NULL)
992		aac_enqueue_bio(sc, bp);
993	if (cm != NULL)
994		aac_release_command(cm);
995	return(ENOMEM);
996}
997
998/*
999 * Handle a bio-instigated command that has been completed.
1000 */
1001static void
1002aac_bio_complete(struct aac_command *cm)
1003{
1004	struct aac_blockread_response *brr;
1005	struct aac_blockwrite_response *bwr;
1006	struct bio *bp;
1007	AAC_FSAStatus status;
1008
1009	/* fetch relevant status and then release the command */
1010	bp = (struct bio *)cm->cm_private;
1011	if (bp->bio_cmd == BIO_READ) {
1012		brr = (struct aac_blockread_response *)&cm->cm_fib->data[0];
1013		status = brr->Status;
1014	} else {
1015		bwr = (struct aac_blockwrite_response *)&cm->cm_fib->data[0];
1016		status = bwr->Status;
1017	}
1018	aac_release_command(cm);
1019
1020	/* fix up the bio based on status */
1021	if (status == ST_OK) {
1022		bp->bio_resid = 0;
1023	} else {
1024		bp->bio_error = EIO;
1025		bp->bio_flags |= BIO_ERROR;
1026		/* pass an error string out to the disk layer */
1027		bp->bio_driver1 = aac_describe_code(aac_command_status_table,
1028						    status);
1029	}
1030	aac_biodone(bp);
1031}
1032
1033/*
1034 * Submit a command to the controller, return when it completes.
1035 * XXX This is very dangerous!  If the card has gone out to lunch, we could
1036 *     be stuck here forever.  At the same time, signals are not caught
1037 *     because there is a risk that a signal could wakeup the tsleep before
1038 *     the card has a chance to complete the command.  The passed in timeout
1039 *     is ignored for the same reason.  Since there is no way to cancel a
1040 *     command in progress, we should probably create a 'dead' queue where
1041 *     commands go that have been interrupted/timed-out/etc, that keeps them
1042 *     out of the free pool.  That way, if the card is just slow, it won't
1043 *     spam the memory of a command that has been recycled.
1044 */
1045static int
1046aac_wait_command(struct aac_command *cm, int timeout)
1047{
1048	struct aac_softc *sc;
1049	int error = 0;
1050
1051	debug_called(2);
1052
1053	sc = cm->cm_sc;
1054
1055	/* Put the command on the ready queue and get things going */
1056	cm->cm_queue = AAC_ADAP_NORM_CMD_QUEUE;
1057	aac_enqueue_ready(cm);
1058	aac_startio(sc);
1059	while (!(cm->cm_flags & AAC_CMD_COMPLETED) && (error != EWOULDBLOCK)) {
1060		error = msleep(cm, &sc->aac_io_lock, PRIBIO, "aacwait", 0);
1061	}
1062	return(error);
1063}
1064
1065/*
1066 *Command Buffer Management
1067 */
1068
1069/*
1070 * Allocate a command.
1071 */
1072int
1073aac_alloc_command(struct aac_softc *sc, struct aac_command **cmp)
1074{
1075	struct aac_command *cm;
1076
1077	debug_called(3);
1078
1079	if ((cm = aac_dequeue_free(sc)) == NULL) {
1080		if (sc->total_fibs < sc->aac_max_fibs) {
1081			sc->aifflags |= AAC_AIFFLAGS_ALLOCFIBS;
1082			wakeup(sc->aifthread);
1083		}
1084		return (EBUSY);
1085	}
1086
1087	*cmp = cm;
1088	return(0);
1089}
1090
1091/*
1092 * Release a command back to the freelist.
1093 */
1094void
1095aac_release_command(struct aac_command *cm)
1096{
1097	debug_called(3);
1098
1099	/* (re)initialise the command/FIB */
1100	cm->cm_sgtable = NULL;
1101	cm->cm_flags = 0;
1102	cm->cm_complete = NULL;
1103	cm->cm_private = NULL;
1104	cm->cm_fib->Header.XferState = AAC_FIBSTATE_EMPTY;
1105	cm->cm_fib->Header.StructType = AAC_FIBTYPE_TFIB;
1106	cm->cm_fib->Header.Flags = 0;
1107	cm->cm_fib->Header.SenderSize = sizeof(struct aac_fib);
1108
1109	/*
1110	 * These are duplicated in aac_start to cover the case where an
1111	 * intermediate stage may have destroyed them.  They're left
1112	 * initialised here for debugging purposes only.
1113	 */
1114	cm->cm_fib->Header.ReceiverFibAddress = (u_int32_t)cm->cm_fibphys;
1115	cm->cm_fib->Header.SenderData = 0;
1116
1117	aac_enqueue_free(cm);
1118}
1119
1120/*
1121 * Map helper for command/FIB allocation.
1122 */
1123static void
1124aac_map_command_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1125{
1126	uint32_t	*fibphys;
1127
1128	fibphys = (uint32_t *)arg;
1129
1130	debug_called(3);
1131
1132	*fibphys = segs[0].ds_addr;
1133}
1134
1135/*
1136 * Allocate and initialise commands/FIBs for this adapter.
1137 */
1138static int
1139aac_alloc_commands(struct aac_softc *sc)
1140{
1141	struct aac_command *cm;
1142	struct aac_fibmap *fm;
1143	uint32_t fibphys;
1144	int i, error;
1145
1146	debug_called(2);
1147
1148	if (sc->total_fibs + AAC_FIB_COUNT > sc->aac_max_fibs)
1149		return (ENOMEM);
1150
1151	fm = malloc(sizeof(struct aac_fibmap), M_AACBUF, M_NOWAIT|M_ZERO);
1152	if (fm == NULL)
1153		return (ENOMEM);
1154
1155	/* allocate the FIBs in DMAable memory and load them */
1156	if (bus_dmamem_alloc(sc->aac_fib_dmat, (void **)&fm->aac_fibs,
1157			     BUS_DMA_NOWAIT, &fm->aac_fibmap)) {
1158		device_printf(sc->aac_dev,
1159			      "Not enough contiguous memory available.\n");
1160		free(fm, M_AACBUF);
1161		return (ENOMEM);
1162	}
1163
1164	/* Ignore errors since this doesn't bounce */
1165	(void)bus_dmamap_load(sc->aac_fib_dmat, fm->aac_fibmap, fm->aac_fibs,
1166			      AAC_FIB_COUNT * sizeof(struct aac_fib),
1167			      aac_map_command_helper, &fibphys, 0);
1168
1169	/* initialise constant fields in the command structure */
1170	AAC_LOCK_ACQUIRE(&sc->aac_io_lock);
1171	bzero(fm->aac_fibs, AAC_FIB_COUNT * sizeof(struct aac_fib));
1172	for (i = 0; i < AAC_FIB_COUNT; i++) {
1173		cm = sc->aac_commands + sc->total_fibs;
1174		fm->aac_commands = cm;
1175		cm->cm_sc = sc;
1176		cm->cm_fib = fm->aac_fibs + i;
1177		cm->cm_fibphys = fibphys + (i * sizeof(struct aac_fib));
1178		cm->cm_index = sc->total_fibs;
1179
1180		if ((error = bus_dmamap_create(sc->aac_buffer_dmat, 0,
1181					       &cm->cm_datamap)) == 0)
1182			aac_release_command(cm);
1183		else
1184			break;
1185		sc->total_fibs++;
1186	}
1187
1188	if (i > 0) {
1189		TAILQ_INSERT_TAIL(&sc->aac_fibmap_tqh, fm, fm_link);
1190		debug(1, "total_fibs= %d\n", sc->total_fibs);
1191		AAC_LOCK_RELEASE(&sc->aac_io_lock);
1192		return (0);
1193	}
1194
1195	AAC_LOCK_RELEASE(&sc->aac_io_lock);
1196	bus_dmamap_unload(sc->aac_fib_dmat, fm->aac_fibmap);
1197	bus_dmamem_free(sc->aac_fib_dmat, fm->aac_fibs, fm->aac_fibmap);
1198	free(fm, M_AACBUF);
1199	return (ENOMEM);
1200}
1201
1202/*
1203 * Free FIBs owned by this adapter.
1204 */
1205static void
1206aac_free_commands(struct aac_softc *sc)
1207{
1208	struct aac_fibmap *fm;
1209	struct aac_command *cm;
1210	int i;
1211
1212	debug_called(1);
1213
1214	while ((fm = TAILQ_FIRST(&sc->aac_fibmap_tqh)) != NULL) {
1215
1216		TAILQ_REMOVE(&sc->aac_fibmap_tqh, fm, fm_link);
1217		/*
1218		 * We check against total_fibs to handle partially
1219		 * allocated blocks.
1220		 */
1221		for (i = 0; i < AAC_FIB_COUNT && sc->total_fibs--; i++) {
1222			cm = fm->aac_commands + i;
1223			bus_dmamap_destroy(sc->aac_buffer_dmat, cm->cm_datamap);
1224		}
1225		bus_dmamap_unload(sc->aac_fib_dmat, fm->aac_fibmap);
1226		bus_dmamem_free(sc->aac_fib_dmat, fm->aac_fibs, fm->aac_fibmap);
1227		free(fm, M_AACBUF);
1228	}
1229}
1230
1231/*
1232 * Command-mapping helper function - populate this command's s/g table.
1233 */
1234static void
1235aac_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1236{
1237	struct aac_softc *sc;
1238	struct aac_command *cm;
1239	struct aac_fib *fib;
1240	int i;
1241
1242	debug_called(3);
1243
1244	cm = (struct aac_command *)arg;
1245	sc = cm->cm_sc;
1246	fib = cm->cm_fib;
1247
1248	/* copy into the FIB */
1249	if (cm->cm_sgtable != NULL) {
1250		if ((cm->cm_sc->flags & AAC_FLAGS_SG_64BIT) == 0) {
1251			struct aac_sg_table *sg;
1252			sg = cm->cm_sgtable;
1253			sg->SgCount = nseg;
1254			for (i = 0; i < nseg; i++) {
1255				sg->SgEntry[i].SgAddress = segs[i].ds_addr;
1256				sg->SgEntry[i].SgByteCount = segs[i].ds_len;
1257			}
1258			/* update the FIB size for the s/g count */
1259			fib->Header.Size += nseg * sizeof(struct aac_sg_entry);
1260		} else {
1261			struct aac_sg_table64 *sg;
1262			sg = (struct aac_sg_table64 *)cm->cm_sgtable;
1263			sg->SgCount = nseg;
1264			for (i = 0; i < nseg; i++) {
1265				sg->SgEntry64[i].SgAddress = segs[i].ds_addr;
1266				sg->SgEntry64[i].SgByteCount = segs[i].ds_len;
1267			}
1268			/* update the FIB size for the s/g count */
1269			fib->Header.Size += nseg*sizeof(struct aac_sg_entry64);
1270		}
1271	}
1272
1273	/* Fix up the address values in the FIB.  Use the command array index
1274	 * instead of a pointer since these fields are only 32 bits.  Shift
1275	 * the SenderFibAddress over to make room for the fast response bit.
1276	 */
1277	cm->cm_fib->Header.SenderFibAddress = (cm->cm_index << 1);
1278	cm->cm_fib->Header.ReceiverFibAddress = cm->cm_fibphys;
1279
1280	/* save a pointer to the command for speedy reverse-lookup */
1281	cm->cm_fib->Header.SenderData = cm->cm_index;
1282
1283	if (cm->cm_flags & AAC_CMD_DATAIN)
1284		bus_dmamap_sync(sc->aac_buffer_dmat, cm->cm_datamap,
1285				BUS_DMASYNC_PREREAD);
1286	if (cm->cm_flags & AAC_CMD_DATAOUT)
1287		bus_dmamap_sync(sc->aac_buffer_dmat, cm->cm_datamap,
1288				BUS_DMASYNC_PREWRITE);
1289	cm->cm_flags |= AAC_CMD_MAPPED;
1290
1291	/* put the FIB on the outbound queue */
1292	if (aac_enqueue_fib(sc, cm->cm_queue, cm) == EBUSY)
1293		aac_requeue_ready(cm);
1294
1295	return;
1296}
1297
1298/*
1299 * Unmap a command from controller-visible space.
1300 */
1301static void
1302aac_unmap_command(struct aac_command *cm)
1303{
1304	struct aac_softc *sc;
1305
1306	debug_called(2);
1307
1308	sc = cm->cm_sc;
1309
1310	if (!(cm->cm_flags & AAC_CMD_MAPPED))
1311		return;
1312
1313	if (cm->cm_datalen != 0) {
1314		if (cm->cm_flags & AAC_CMD_DATAIN)
1315			bus_dmamap_sync(sc->aac_buffer_dmat, cm->cm_datamap,
1316					BUS_DMASYNC_POSTREAD);
1317		if (cm->cm_flags & AAC_CMD_DATAOUT)
1318			bus_dmamap_sync(sc->aac_buffer_dmat, cm->cm_datamap,
1319					BUS_DMASYNC_POSTWRITE);
1320
1321		bus_dmamap_unload(sc->aac_buffer_dmat, cm->cm_datamap);
1322	}
1323	cm->cm_flags &= ~AAC_CMD_MAPPED;
1324}
1325
1326/*
1327 * Hardware Interface
1328 */
1329
1330/*
1331 * Initialise the adapter.
1332 */
1333static void
1334aac_common_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1335{
1336	struct aac_softc *sc;
1337
1338	debug_called(1);
1339
1340	sc = (struct aac_softc *)arg;
1341
1342	sc->aac_common_busaddr = segs[0].ds_addr;
1343}
1344
1345static int
1346aac_check_firmware(struct aac_softc *sc)
1347{
1348	u_int32_t major, minor, options;
1349
1350	debug_called(1);
1351
1352	/*
1353	 * Retrieve the firmware version numbers.  Dell PERC2/QC cards with
1354	 * firmware version 1.x are not compatible with this driver.
1355	 */
1356	if (sc->flags & AAC_FLAGS_PERC2QC) {
1357		if (aac_sync_command(sc, AAC_MONKER_GETKERNVER, 0, 0, 0, 0,
1358				     NULL)) {
1359			device_printf(sc->aac_dev,
1360				      "Error reading firmware version\n");
1361			return (EIO);
1362		}
1363
1364		/* These numbers are stored as ASCII! */
1365		major = (AAC_GET_MAILBOX(sc, 1) & 0xff) - 0x30;
1366		minor = (AAC_GET_MAILBOX(sc, 2) & 0xff) - 0x30;
1367		if (major == 1) {
1368			device_printf(sc->aac_dev,
1369			    "Firmware version %d.%d is not supported.\n",
1370			    major, minor);
1371			return (EINVAL);
1372		}
1373	}
1374
1375	/*
1376	 * Retrieve the capabilities/supported options word so we know what
1377	 * work-arounds to enable.
1378	 */
1379	if (aac_sync_command(sc, AAC_MONKER_GETINFO, 0, 0, 0, 0, NULL)) {
1380		device_printf(sc->aac_dev, "RequestAdapterInfo failed\n");
1381		return (EIO);
1382	}
1383	options = AAC_GET_MAILBOX(sc, 1);
1384	sc->supported_options = options;
1385
1386	if ((options & AAC_SUPPORTED_4GB_WINDOW) != 0 &&
1387	    (sc->flags & AAC_FLAGS_NO4GB) == 0)
1388		sc->flags |= AAC_FLAGS_4GB_WINDOW;
1389	if (options & AAC_SUPPORTED_NONDASD)
1390		sc->flags |= AAC_FLAGS_ENABLE_CAM;
1391	if ((options & AAC_SUPPORTED_SGMAP_HOST64) != 0
1392	     && (sizeof(bus_addr_t) > 4)) {
1393		device_printf(sc->aac_dev, "Enabling 64-bit address support\n");
1394		sc->flags |= AAC_FLAGS_SG_64BIT;
1395	}
1396
1397	/* Check for broken hardware that does a lower number of commands */
1398	if ((sc->flags & AAC_FLAGS_256FIBS) == 0)
1399		sc->aac_max_fibs = AAC_MAX_FIBS;
1400	else
1401		sc->aac_max_fibs = 256;
1402
1403	return (0);
1404}
1405
1406static int
1407aac_init(struct aac_softc *sc)
1408{
1409	struct aac_adapter_init	*ip;
1410	time_t then;
1411	u_int32_t code, qoffset;
1412	int error;
1413
1414	debug_called(1);
1415
1416	/*
1417	 * First wait for the adapter to come ready.
1418	 */
1419	then = time_second;
1420	do {
1421		code = AAC_GET_FWSTATUS(sc);
1422		if (code & AAC_SELF_TEST_FAILED) {
1423			device_printf(sc->aac_dev, "FATAL: selftest failed\n");
1424			return(ENXIO);
1425		}
1426		if (code & AAC_KERNEL_PANIC) {
1427			device_printf(sc->aac_dev,
1428				      "FATAL: controller kernel panic\n");
1429			return(ENXIO);
1430		}
1431		if (time_second > (then + AAC_BOOT_TIMEOUT)) {
1432			device_printf(sc->aac_dev,
1433				      "FATAL: controller not coming ready, "
1434					   "status %x\n", code);
1435			return(ENXIO);
1436		}
1437	} while (!(code & AAC_UP_AND_RUNNING));
1438
1439	error = ENOMEM;
1440	/*
1441	 * Create DMA tag for mapping buffers into controller-addressable space.
1442	 */
1443	if (bus_dma_tag_create(sc->aac_parent_dmat, 	/* parent */
1444			       1, 0, 			/* algnmnt, boundary */
1445			       (sc->flags & AAC_FLAGS_SG_64BIT) ?
1446			       BUS_SPACE_MAXADDR :
1447			       BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
1448			       BUS_SPACE_MAXADDR, 	/* highaddr */
1449			       NULL, NULL, 		/* filter, filterarg */
1450			       MAXBSIZE,		/* maxsize */
1451			       AAC_MAXSGENTRIES,	/* nsegments */
1452			       MAXBSIZE,		/* maxsegsize */
1453			       BUS_DMA_ALLOCNOW,	/* flags */
1454			       busdma_lock_mutex,	/* lockfunc */
1455			       &sc->aac_io_lock,	/* lockfuncarg */
1456			       &sc->aac_buffer_dmat)) {
1457		device_printf(sc->aac_dev, "can't allocate buffer DMA tag\n");
1458		goto out;
1459	}
1460
1461	/*
1462	 * Create DMA tag for mapping FIBs into controller-addressable space..
1463	 */
1464	if (bus_dma_tag_create(sc->aac_parent_dmat,	/* parent */
1465			       1, 0, 			/* algnmnt, boundary */
1466			       (sc->flags & AAC_FLAGS_4GB_WINDOW) ?
1467			       BUS_SPACE_MAXADDR_32BIT :
1468			       0x7fffffff,		/* lowaddr */
1469			       BUS_SPACE_MAXADDR, 	/* highaddr */
1470			       NULL, NULL, 		/* filter, filterarg */
1471			       AAC_FIB_COUNT *
1472			       sizeof(struct aac_fib),  /* maxsize */
1473			       1,			/* nsegments */
1474			       AAC_FIB_COUNT *
1475			       sizeof(struct aac_fib),	/* maxsegsize */
1476			       BUS_DMA_ALLOCNOW,	/* flags */
1477			       NULL, NULL,		/* No locking needed */
1478			       &sc->aac_fib_dmat)) {
1479		device_printf(sc->aac_dev, "can't allocate FIB DMA tag\n");;
1480		goto out;
1481	}
1482
1483	/*
1484	 * Create DMA tag for the common structure and allocate it.
1485	 */
1486	if (bus_dma_tag_create(sc->aac_parent_dmat, 	/* parent */
1487			       1, 0,			/* algnmnt, boundary */
1488			       (sc->flags & AAC_FLAGS_4GB_WINDOW) ?
1489			       BUS_SPACE_MAXADDR_32BIT :
1490			       0x7fffffff,		/* lowaddr */
1491			       BUS_SPACE_MAXADDR, 	/* highaddr */
1492			       NULL, NULL, 		/* filter, filterarg */
1493			       8192 + sizeof(struct aac_common), /* maxsize */
1494			       1,			/* nsegments */
1495			       BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
1496			       BUS_DMA_ALLOCNOW,	/* flags */
1497			       NULL, NULL,		/* No locking needed */
1498			       &sc->aac_common_dmat)) {
1499		device_printf(sc->aac_dev,
1500			      "can't allocate common structure DMA tag\n");
1501		goto out;
1502	}
1503	if (bus_dmamem_alloc(sc->aac_common_dmat, (void **)&sc->aac_common,
1504			     BUS_DMA_NOWAIT, &sc->aac_common_dmamap)) {
1505		device_printf(sc->aac_dev, "can't allocate common structure\n");
1506		goto out;
1507	}
1508
1509	/*
1510	 * Work around a bug in the 2120 and 2200 that cannot DMA commands
1511	 * below address 8192 in physical memory.
1512	 * XXX If the padding is not needed, can it be put to use instead
1513	 * of ignored?
1514	 */
1515	(void)bus_dmamap_load(sc->aac_common_dmat, sc->aac_common_dmamap,
1516			sc->aac_common, 8192 + sizeof(*sc->aac_common),
1517			aac_common_map, sc, 0);
1518
1519	if (sc->aac_common_busaddr < 8192) {
1520		(uint8_t *)sc->aac_common += 8192;
1521		sc->aac_common_busaddr += 8192;
1522	}
1523	bzero(sc->aac_common, sizeof(*sc->aac_common));
1524
1525	/* Allocate some FIBs and associated command structs */
1526	TAILQ_INIT(&sc->aac_fibmap_tqh);
1527	sc->aac_commands = malloc(AAC_MAX_FIBS * sizeof(struct aac_command),
1528				  M_AACBUF, M_WAITOK|M_ZERO);
1529	while (sc->total_fibs < AAC_PREALLOCATE_FIBS) {
1530		if (aac_alloc_commands(sc) != 0)
1531			break;
1532	}
1533	if (sc->total_fibs == 0)
1534		goto out;
1535
1536	/*
1537	 * Fill in the init structure.  This tells the adapter about the
1538	 * physical location of various important shared data structures.
1539	 */
1540	ip = &sc->aac_common->ac_init;
1541	ip->InitStructRevision = AAC_INIT_STRUCT_REVISION;
1542	ip->MiniPortRevision = AAC_INIT_STRUCT_MINIPORT_REVISION;
1543
1544	ip->AdapterFibsPhysicalAddress = sc->aac_common_busaddr +
1545					 offsetof(struct aac_common, ac_fibs);
1546	ip->AdapterFibsVirtualAddress = 0;
1547	ip->AdapterFibsSize = AAC_ADAPTER_FIBS * sizeof(struct aac_fib);
1548	ip->AdapterFibAlign = sizeof(struct aac_fib);
1549
1550	ip->PrintfBufferAddress = sc->aac_common_busaddr +
1551				  offsetof(struct aac_common, ac_printf);
1552	ip->PrintfBufferSize = AAC_PRINTF_BUFSIZE;
1553
1554	/*
1555	 * The adapter assumes that pages are 4K in size, except on some
1556 	 * broken firmware versions that do the page->byte conversion twice,
1557	 * therefore 'assuming' that this value is in 16MB units (2^24).
1558	 * Round up since the granularity is so high.
1559	 */
1560	ip->HostPhysMemPages = ctob(physmem) / AAC_PAGE_SIZE;
1561	if (sc->flags & AAC_FLAGS_BROKEN_MEMMAP) {
1562		ip->HostPhysMemPages =
1563		    (ip->HostPhysMemPages + AAC_PAGE_SIZE) / AAC_PAGE_SIZE;
1564	}
1565	ip->HostElapsedSeconds = time_second;	/* reset later if invalid */
1566
1567	/*
1568	 * Initialise FIB queues.  Note that it appears that the layout of the
1569	 * indexes and the segmentation of the entries may be mandated by the
1570	 * adapter, which is only told about the base of the queue index fields.
1571	 *
1572	 * The initial values of the indices are assumed to inform the adapter
1573	 * of the sizes of the respective queues, and theoretically it could
1574	 * work out the entire layout of the queue structures from this.  We
1575	 * take the easy route and just lay this area out like everyone else
1576	 * does.
1577	 *
1578	 * The Linux driver uses a much more complex scheme whereby several
1579	 * header records are kept for each queue.  We use a couple of generic
1580	 * list manipulation functions which 'know' the size of each list by
1581	 * virtue of a table.
1582	 */
1583	qoffset = offsetof(struct aac_common, ac_qbuf) + AAC_QUEUE_ALIGN;
1584	qoffset &= ~(AAC_QUEUE_ALIGN - 1);
1585	sc->aac_queues =
1586	    (struct aac_queue_table *)((uintptr_t)sc->aac_common + qoffset);
1587	ip->CommHeaderAddress = sc->aac_common_busaddr + qoffset;
1588
1589	sc->aac_queues->qt_qindex[AAC_HOST_NORM_CMD_QUEUE][AAC_PRODUCER_INDEX] =
1590		AAC_HOST_NORM_CMD_ENTRIES;
1591	sc->aac_queues->qt_qindex[AAC_HOST_NORM_CMD_QUEUE][AAC_CONSUMER_INDEX] =
1592		AAC_HOST_NORM_CMD_ENTRIES;
1593	sc->aac_queues->qt_qindex[AAC_HOST_HIGH_CMD_QUEUE][AAC_PRODUCER_INDEX] =
1594		AAC_HOST_HIGH_CMD_ENTRIES;
1595	sc->aac_queues->qt_qindex[AAC_HOST_HIGH_CMD_QUEUE][AAC_CONSUMER_INDEX] =
1596		AAC_HOST_HIGH_CMD_ENTRIES;
1597	sc->aac_queues->qt_qindex[AAC_ADAP_NORM_CMD_QUEUE][AAC_PRODUCER_INDEX] =
1598		AAC_ADAP_NORM_CMD_ENTRIES;
1599	sc->aac_queues->qt_qindex[AAC_ADAP_NORM_CMD_QUEUE][AAC_CONSUMER_INDEX] =
1600		AAC_ADAP_NORM_CMD_ENTRIES;
1601	sc->aac_queues->qt_qindex[AAC_ADAP_HIGH_CMD_QUEUE][AAC_PRODUCER_INDEX] =
1602		AAC_ADAP_HIGH_CMD_ENTRIES;
1603	sc->aac_queues->qt_qindex[AAC_ADAP_HIGH_CMD_QUEUE][AAC_CONSUMER_INDEX] =
1604		AAC_ADAP_HIGH_CMD_ENTRIES;
1605	sc->aac_queues->qt_qindex[AAC_HOST_NORM_RESP_QUEUE][AAC_PRODUCER_INDEX]=
1606		AAC_HOST_NORM_RESP_ENTRIES;
1607	sc->aac_queues->qt_qindex[AAC_HOST_NORM_RESP_QUEUE][AAC_CONSUMER_INDEX]=
1608		AAC_HOST_NORM_RESP_ENTRIES;
1609	sc->aac_queues->qt_qindex[AAC_HOST_HIGH_RESP_QUEUE][AAC_PRODUCER_INDEX]=
1610		AAC_HOST_HIGH_RESP_ENTRIES;
1611	sc->aac_queues->qt_qindex[AAC_HOST_HIGH_RESP_QUEUE][AAC_CONSUMER_INDEX]=
1612		AAC_HOST_HIGH_RESP_ENTRIES;
1613	sc->aac_queues->qt_qindex[AAC_ADAP_NORM_RESP_QUEUE][AAC_PRODUCER_INDEX]=
1614		AAC_ADAP_NORM_RESP_ENTRIES;
1615	sc->aac_queues->qt_qindex[AAC_ADAP_NORM_RESP_QUEUE][AAC_CONSUMER_INDEX]=
1616		AAC_ADAP_NORM_RESP_ENTRIES;
1617	sc->aac_queues->qt_qindex[AAC_ADAP_HIGH_RESP_QUEUE][AAC_PRODUCER_INDEX]=
1618		AAC_ADAP_HIGH_RESP_ENTRIES;
1619	sc->aac_queues->qt_qindex[AAC_ADAP_HIGH_RESP_QUEUE][AAC_CONSUMER_INDEX]=
1620		AAC_ADAP_HIGH_RESP_ENTRIES;
1621	sc->aac_qentries[AAC_HOST_NORM_CMD_QUEUE] =
1622		&sc->aac_queues->qt_HostNormCmdQueue[0];
1623	sc->aac_qentries[AAC_HOST_HIGH_CMD_QUEUE] =
1624		&sc->aac_queues->qt_HostHighCmdQueue[0];
1625	sc->aac_qentries[AAC_ADAP_NORM_CMD_QUEUE] =
1626		&sc->aac_queues->qt_AdapNormCmdQueue[0];
1627	sc->aac_qentries[AAC_ADAP_HIGH_CMD_QUEUE] =
1628		&sc->aac_queues->qt_AdapHighCmdQueue[0];
1629	sc->aac_qentries[AAC_HOST_NORM_RESP_QUEUE] =
1630		&sc->aac_queues->qt_HostNormRespQueue[0];
1631	sc->aac_qentries[AAC_HOST_HIGH_RESP_QUEUE] =
1632		&sc->aac_queues->qt_HostHighRespQueue[0];
1633	sc->aac_qentries[AAC_ADAP_NORM_RESP_QUEUE] =
1634		&sc->aac_queues->qt_AdapNormRespQueue[0];
1635	sc->aac_qentries[AAC_ADAP_HIGH_RESP_QUEUE] =
1636		&sc->aac_queues->qt_AdapHighRespQueue[0];
1637
1638	/*
1639	 * Do controller-type-specific initialisation
1640	 */
1641	switch (sc->aac_hwif) {
1642	case AAC_HWIF_I960RX:
1643		AAC_SETREG4(sc, AAC_RX_ODBR, ~0);
1644		break;
1645	}
1646
1647	/*
1648	 * Give the init structure to the controller.
1649	 */
1650	if (aac_sync_command(sc, AAC_MONKER_INITSTRUCT,
1651			     sc->aac_common_busaddr +
1652			     offsetof(struct aac_common, ac_init), 0, 0, 0,
1653			     NULL)) {
1654		device_printf(sc->aac_dev,
1655			      "error establishing init structure\n");
1656		error = EIO;
1657		goto out;
1658	}
1659
1660	error = 0;
1661out:
1662	return(error);
1663}
1664
1665/*
1666 * Send a synchronous command to the controller and wait for a result.
1667 */
1668static int
1669aac_sync_command(struct aac_softc *sc, u_int32_t command,
1670		 u_int32_t arg0, u_int32_t arg1, u_int32_t arg2, u_int32_t arg3,
1671		 u_int32_t *sp)
1672{
1673	time_t then;
1674	u_int32_t status;
1675
1676	debug_called(3);
1677
1678	/* populate the mailbox */
1679	AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3);
1680
1681	/* ensure the sync command doorbell flag is cleared */
1682	AAC_CLEAR_ISTATUS(sc, AAC_DB_SYNC_COMMAND);
1683
1684	/* then set it to signal the adapter */
1685	AAC_QNOTIFY(sc, AAC_DB_SYNC_COMMAND);
1686
1687	/* spin waiting for the command to complete */
1688	then = time_second;
1689	do {
1690		if (time_second > (then + AAC_IMMEDIATE_TIMEOUT)) {
1691			debug(1, "timed out");
1692			return(EIO);
1693		}
1694	} while (!(AAC_GET_ISTATUS(sc) & AAC_DB_SYNC_COMMAND));
1695
1696	/* clear the completion flag */
1697	AAC_CLEAR_ISTATUS(sc, AAC_DB_SYNC_COMMAND);
1698
1699	/* get the command status */
1700	status = AAC_GET_MAILBOX(sc, 0);
1701	if (sp != NULL)
1702		*sp = status;
1703	return(0);
1704}
1705
1706/*
1707 * Grab the sync fib area.
1708 */
1709int
1710aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib, int flags)
1711{
1712
1713	/*
1714	 * If the force flag is set, the system is shutting down, or in
1715	 * trouble.  Ignore the mutex.
1716	 */
1717	if (!(flags & AAC_SYNC_LOCK_FORCE))
1718		AAC_LOCK_ACQUIRE(&sc->aac_sync_lock);
1719
1720	*fib = &sc->aac_common->ac_sync_fib;
1721
1722	return (1);
1723}
1724
1725/*
1726 * Release the sync fib area.
1727 */
1728void
1729aac_release_sync_fib(struct aac_softc *sc)
1730{
1731
1732	AAC_LOCK_RELEASE(&sc->aac_sync_lock);
1733}
1734
1735/*
1736 * Send a synchronous FIB to the controller and wait for a result.
1737 */
1738int
1739aac_sync_fib(struct aac_softc *sc, u_int32_t command, u_int32_t xferstate,
1740		 struct aac_fib *fib, u_int16_t datasize)
1741{
1742	debug_called(3);
1743
1744	if (datasize > AAC_FIB_DATASIZE)
1745		return(EINVAL);
1746
1747	/*
1748	 * Set up the sync FIB
1749	 */
1750	fib->Header.XferState = AAC_FIBSTATE_HOSTOWNED |
1751				AAC_FIBSTATE_INITIALISED |
1752				AAC_FIBSTATE_EMPTY;
1753	fib->Header.XferState |= xferstate;
1754	fib->Header.Command = command;
1755	fib->Header.StructType = AAC_FIBTYPE_TFIB;
1756	fib->Header.Size = sizeof(struct aac_fib) + datasize;
1757	fib->Header.SenderSize = sizeof(struct aac_fib);
1758	fib->Header.SenderFibAddress = 0;	/* Not needed */
1759	fib->Header.ReceiverFibAddress = sc->aac_common_busaddr +
1760					 offsetof(struct aac_common,
1761						  ac_sync_fib);
1762
1763	/*
1764	 * Give the FIB to the controller, wait for a response.
1765	 */
1766	if (aac_sync_command(sc, AAC_MONKER_SYNCFIB,
1767			     fib->Header.ReceiverFibAddress, 0, 0, 0, NULL)) {
1768		debug(2, "IO error");
1769		return(EIO);
1770	}
1771
1772	return (0);
1773}
1774
1775/*
1776 * Adapter-space FIB queue manipulation
1777 *
1778 * Note that the queue implementation here is a little funky; neither the PI or
1779 * CI will ever be zero.  This behaviour is a controller feature.
1780 */
1781static struct {
1782	int		size;
1783	int		notify;
1784} aac_qinfo[] = {
1785	{AAC_HOST_NORM_CMD_ENTRIES, AAC_DB_COMMAND_NOT_FULL},
1786	{AAC_HOST_HIGH_CMD_ENTRIES, 0},
1787	{AAC_ADAP_NORM_CMD_ENTRIES, AAC_DB_COMMAND_READY},
1788	{AAC_ADAP_HIGH_CMD_ENTRIES, 0},
1789	{AAC_HOST_NORM_RESP_ENTRIES, AAC_DB_RESPONSE_NOT_FULL},
1790	{AAC_HOST_HIGH_RESP_ENTRIES, 0},
1791	{AAC_ADAP_NORM_RESP_ENTRIES, AAC_DB_RESPONSE_READY},
1792	{AAC_ADAP_HIGH_RESP_ENTRIES, 0}
1793};
1794
1795/*
1796 * Atomically insert an entry into the nominated queue, returns 0 on success or
1797 * EBUSY if the queue is full.
1798 *
1799 * Note: it would be more efficient to defer notifying the controller in
1800 *	 the case where we may be inserting several entries in rapid succession,
1801 *	 but implementing this usefully may be difficult (it would involve a
1802 *	 separate queue/notify interface).
1803 */
1804static int
1805aac_enqueue_fib(struct aac_softc *sc, int queue, struct aac_command *cm)
1806{
1807	u_int32_t pi, ci;
1808	int error;
1809	u_int32_t fib_size;
1810	u_int32_t fib_addr;
1811
1812	debug_called(3);
1813
1814	fib_size = cm->cm_fib->Header.Size;
1815	fib_addr = cm->cm_fib->Header.ReceiverFibAddress;
1816
1817	/* get the producer/consumer indices */
1818	pi = sc->aac_queues->qt_qindex[queue][AAC_PRODUCER_INDEX];
1819	ci = sc->aac_queues->qt_qindex[queue][AAC_CONSUMER_INDEX];
1820
1821	/* wrap the queue? */
1822	if (pi >= aac_qinfo[queue].size)
1823		pi = 0;
1824
1825	/* check for queue full */
1826	if ((pi + 1) == ci) {
1827		error = EBUSY;
1828		goto out;
1829	}
1830
1831	/* populate queue entry */
1832	(sc->aac_qentries[queue] + pi)->aq_fib_size = fib_size;
1833	(sc->aac_qentries[queue] + pi)->aq_fib_addr = fib_addr;
1834
1835	/* update producer index */
1836	sc->aac_queues->qt_qindex[queue][AAC_PRODUCER_INDEX] = pi + 1;
1837
1838	/*
1839	 * To avoid a race with its completion interrupt, place this command on
1840	 * the busy queue prior to advertising it to the controller.
1841	 */
1842	aac_enqueue_busy(cm);
1843
1844	/* notify the adapter if we know how */
1845	if (aac_qinfo[queue].notify != 0)
1846		AAC_QNOTIFY(sc, aac_qinfo[queue].notify);
1847
1848	error = 0;
1849
1850out:
1851	return(error);
1852}
1853
1854/*
1855 * Atomically remove one entry from the nominated queue, returns 0 on
1856 * success or ENOENT if the queue is empty.
1857 */
1858static int
1859aac_dequeue_fib(struct aac_softc *sc, int queue, u_int32_t *fib_size,
1860		struct aac_fib **fib_addr)
1861{
1862	u_int32_t pi, ci;
1863	u_int32_t fib_index;
1864	int error;
1865	int notify;
1866
1867	debug_called(3);
1868
1869	/* get the producer/consumer indices */
1870	pi = sc->aac_queues->qt_qindex[queue][AAC_PRODUCER_INDEX];
1871	ci = sc->aac_queues->qt_qindex[queue][AAC_CONSUMER_INDEX];
1872
1873	/* check for queue empty */
1874	if (ci == pi) {
1875		error = ENOENT;
1876		goto out;
1877	}
1878
1879	/* wrap the pi so the following test works */
1880	if (pi >= aac_qinfo[queue].size)
1881		pi = 0;
1882
1883	notify = 0;
1884	if (ci == pi + 1)
1885		notify++;
1886
1887	/* wrap the queue? */
1888	if (ci >= aac_qinfo[queue].size)
1889		ci = 0;
1890
1891	/* fetch the entry */
1892	*fib_size = (sc->aac_qentries[queue] + ci)->aq_fib_size;
1893
1894	switch (queue) {
1895	case AAC_HOST_NORM_CMD_QUEUE:
1896	case AAC_HOST_HIGH_CMD_QUEUE:
1897		/*
1898		 * The aq_fib_addr is only 32 bits wide so it can't be counted
1899		 * on to hold an address.  For AIF's, the adapter assumes
1900		 * that it's giving us an address into the array of AIF fibs.
1901		 * Therefore, we have to convert it to an index.
1902		 */
1903		fib_index = (sc->aac_qentries[queue] + ci)->aq_fib_addr /
1904			sizeof(struct aac_fib);
1905		*fib_addr = &sc->aac_common->ac_fibs[fib_index];
1906		break;
1907
1908	case AAC_HOST_NORM_RESP_QUEUE:
1909	case AAC_HOST_HIGH_RESP_QUEUE:
1910	{
1911		struct aac_command *cm;
1912
1913		/*
1914		 * As above, an index is used instead of an actual address.
1915		 * Gotta shift the index to account for the fast response
1916		 * bit.  No other correction is needed since this value was
1917		 * originally provided by the driver via the SenderFibAddress
1918		 * field.
1919		 */
1920		fib_index = (sc->aac_qentries[queue] + ci)->aq_fib_addr;
1921		cm = sc->aac_commands + (fib_index >> 1);
1922		*fib_addr = cm->cm_fib;
1923
1924		/*
1925		 * Is this a fast response? If it is, update the fib fields in
1926		 * local memory since the whole fib isn't DMA'd back up.
1927		 */
1928		if (fib_index & 0x01) {
1929			(*fib_addr)->Header.XferState |= AAC_FIBSTATE_DONEADAP;
1930			*((u_int32_t*)((*fib_addr)->data)) = AAC_ERROR_NORMAL;
1931		}
1932		break;
1933	}
1934	default:
1935		panic("Invalid queue in aac_dequeue_fib()");
1936		break;
1937	}
1938
1939	/* update consumer index */
1940	sc->aac_queues->qt_qindex[queue][AAC_CONSUMER_INDEX] = ci + 1;
1941
1942	/* if we have made the queue un-full, notify the adapter */
1943	if (notify && (aac_qinfo[queue].notify != 0))
1944		AAC_QNOTIFY(sc, aac_qinfo[queue].notify);
1945	error = 0;
1946
1947out:
1948	return(error);
1949}
1950
1951/*
1952 * Put our response to an Adapter Initialed Fib on the response queue
1953 */
1954static int
1955aac_enqueue_response(struct aac_softc *sc, int queue, struct aac_fib *fib)
1956{
1957	u_int32_t pi, ci;
1958	int error;
1959	u_int32_t fib_size;
1960	u_int32_t fib_addr;
1961
1962	debug_called(1);
1963
1964	/* Tell the adapter where the FIB is */
1965	fib_size = fib->Header.Size;
1966	fib_addr = fib->Header.SenderFibAddress;
1967	fib->Header.ReceiverFibAddress = fib_addr;
1968
1969	/* get the producer/consumer indices */
1970	pi = sc->aac_queues->qt_qindex[queue][AAC_PRODUCER_INDEX];
1971	ci = sc->aac_queues->qt_qindex[queue][AAC_CONSUMER_INDEX];
1972
1973	/* wrap the queue? */
1974	if (pi >= aac_qinfo[queue].size)
1975		pi = 0;
1976
1977	/* check for queue full */
1978	if ((pi + 1) == ci) {
1979		error = EBUSY;
1980		goto out;
1981	}
1982
1983	/* populate queue entry */
1984	(sc->aac_qentries[queue] + pi)->aq_fib_size = fib_size;
1985	(sc->aac_qentries[queue] + pi)->aq_fib_addr = fib_addr;
1986
1987	/* update producer index */
1988	sc->aac_queues->qt_qindex[queue][AAC_PRODUCER_INDEX] = pi + 1;
1989
1990	/* notify the adapter if we know how */
1991	if (aac_qinfo[queue].notify != 0)
1992		AAC_QNOTIFY(sc, aac_qinfo[queue].notify);
1993
1994	error = 0;
1995
1996out:
1997	return(error);
1998}
1999
2000/*
2001 * Check for commands that have been outstanding for a suspiciously long time,
2002 * and complain about them.
2003 */
2004static void
2005aac_timeout(struct aac_softc *sc)
2006{
2007	struct aac_command *cm;
2008	time_t deadline;
2009
2010	/*
2011	 * Traverse the busy command list, bitch about late commands once
2012	 * only.
2013	 */
2014	deadline = time_second - AAC_CMD_TIMEOUT;
2015	TAILQ_FOREACH(cm, &sc->aac_busy, cm_link) {
2016		if ((cm->cm_timestamp  < deadline)
2017			/* && !(cm->cm_flags & AAC_CMD_TIMEDOUT) */) {
2018			cm->cm_flags |= AAC_CMD_TIMEDOUT;
2019			device_printf(sc->aac_dev,
2020				      "COMMAND %p TIMEOUT AFTER %d SECONDS\n",
2021				      cm, (int)(time_second-cm->cm_timestamp));
2022			AAC_PRINT_FIB(sc, cm->cm_fib);
2023		}
2024	}
2025
2026	return;
2027}
2028
2029/*
2030 * Interface Function Vectors
2031 */
2032
2033/*
2034 * Read the current firmware status word.
2035 */
2036static int
2037aac_sa_get_fwstatus(struct aac_softc *sc)
2038{
2039	debug_called(3);
2040
2041	return(AAC_GETREG4(sc, AAC_SA_FWSTATUS));
2042}
2043
2044static int
2045aac_rx_get_fwstatus(struct aac_softc *sc)
2046{
2047	debug_called(3);
2048
2049	return(AAC_GETREG4(sc, AAC_RX_FWSTATUS));
2050}
2051
2052static int
2053aac_fa_get_fwstatus(struct aac_softc *sc)
2054{
2055	int val;
2056
2057	debug_called(3);
2058
2059	val = AAC_GETREG4(sc, AAC_FA_FWSTATUS);
2060	return (val);
2061}
2062
2063/*
2064 * Notify the controller of a change in a given queue
2065 */
2066
2067static void
2068aac_sa_qnotify(struct aac_softc *sc, int qbit)
2069{
2070	debug_called(3);
2071
2072	AAC_SETREG2(sc, AAC_SA_DOORBELL1_SET, qbit);
2073}
2074
2075static void
2076aac_rx_qnotify(struct aac_softc *sc, int qbit)
2077{
2078	debug_called(3);
2079
2080	AAC_SETREG4(sc, AAC_RX_IDBR, qbit);
2081}
2082
2083static void
2084aac_fa_qnotify(struct aac_softc *sc, int qbit)
2085{
2086	debug_called(3);
2087
2088	AAC_SETREG2(sc, AAC_FA_DOORBELL1, qbit);
2089	AAC_FA_HACK(sc);
2090}
2091
2092/*
2093 * Get the interrupt reason bits
2094 */
2095static int
2096aac_sa_get_istatus(struct aac_softc *sc)
2097{
2098	debug_called(3);
2099
2100	return(AAC_GETREG2(sc, AAC_SA_DOORBELL0));
2101}
2102
2103static int
2104aac_rx_get_istatus(struct aac_softc *sc)
2105{
2106	debug_called(3);
2107
2108	return(AAC_GETREG4(sc, AAC_RX_ODBR));
2109}
2110
2111static int
2112aac_fa_get_istatus(struct aac_softc *sc)
2113{
2114	int val;
2115
2116	debug_called(3);
2117
2118	val = AAC_GETREG2(sc, AAC_FA_DOORBELL0);
2119	return (val);
2120}
2121
2122/*
2123 * Clear some interrupt reason bits
2124 */
2125static void
2126aac_sa_clear_istatus(struct aac_softc *sc, int mask)
2127{
2128	debug_called(3);
2129
2130	AAC_SETREG2(sc, AAC_SA_DOORBELL0_CLEAR, mask);
2131}
2132
2133static void
2134aac_rx_clear_istatus(struct aac_softc *sc, int mask)
2135{
2136	debug_called(3);
2137
2138	AAC_SETREG4(sc, AAC_RX_ODBR, mask);
2139}
2140
2141static void
2142aac_fa_clear_istatus(struct aac_softc *sc, int mask)
2143{
2144	debug_called(3);
2145
2146	AAC_SETREG2(sc, AAC_FA_DOORBELL0_CLEAR, mask);
2147	AAC_FA_HACK(sc);
2148}
2149
2150/*
2151 * Populate the mailbox and set the command word
2152 */
2153static void
2154aac_sa_set_mailbox(struct aac_softc *sc, u_int32_t command,
2155		u_int32_t arg0, u_int32_t arg1, u_int32_t arg2, u_int32_t arg3)
2156{
2157	debug_called(4);
2158
2159	AAC_SETREG4(sc, AAC_SA_MAILBOX, command);
2160	AAC_SETREG4(sc, AAC_SA_MAILBOX + 4, arg0);
2161	AAC_SETREG4(sc, AAC_SA_MAILBOX + 8, arg1);
2162	AAC_SETREG4(sc, AAC_SA_MAILBOX + 12, arg2);
2163	AAC_SETREG4(sc, AAC_SA_MAILBOX + 16, arg3);
2164}
2165
2166static void
2167aac_rx_set_mailbox(struct aac_softc *sc, u_int32_t command,
2168		u_int32_t arg0, u_int32_t arg1, u_int32_t arg2, u_int32_t arg3)
2169{
2170	debug_called(4);
2171
2172	AAC_SETREG4(sc, AAC_RX_MAILBOX, command);
2173	AAC_SETREG4(sc, AAC_RX_MAILBOX + 4, arg0);
2174	AAC_SETREG4(sc, AAC_RX_MAILBOX + 8, arg1);
2175	AAC_SETREG4(sc, AAC_RX_MAILBOX + 12, arg2);
2176	AAC_SETREG4(sc, AAC_RX_MAILBOX + 16, arg3);
2177}
2178
2179static void
2180aac_fa_set_mailbox(struct aac_softc *sc, u_int32_t command,
2181		u_int32_t arg0, u_int32_t arg1, u_int32_t arg2, u_int32_t arg3)
2182{
2183	debug_called(4);
2184
2185	AAC_SETREG4(sc, AAC_FA_MAILBOX, command);
2186	AAC_FA_HACK(sc);
2187	AAC_SETREG4(sc, AAC_FA_MAILBOX + 4, arg0);
2188	AAC_FA_HACK(sc);
2189	AAC_SETREG4(sc, AAC_FA_MAILBOX + 8, arg1);
2190	AAC_FA_HACK(sc);
2191	AAC_SETREG4(sc, AAC_FA_MAILBOX + 12, arg2);
2192	AAC_FA_HACK(sc);
2193	AAC_SETREG4(sc, AAC_FA_MAILBOX + 16, arg3);
2194	AAC_FA_HACK(sc);
2195}
2196
2197/*
2198 * Fetch the immediate command status word
2199 */
2200static int
2201aac_sa_get_mailbox(struct aac_softc *sc, int mb)
2202{
2203	debug_called(4);
2204
2205	return(AAC_GETREG4(sc, AAC_SA_MAILBOX + (mb * 4)));
2206}
2207
2208static int
2209aac_rx_get_mailbox(struct aac_softc *sc, int mb)
2210{
2211	debug_called(4);
2212
2213	return(AAC_GETREG4(sc, AAC_RX_MAILBOX + (mb * 4)));
2214}
2215
2216static int
2217aac_fa_get_mailbox(struct aac_softc *sc, int mb)
2218{
2219	int val;
2220
2221	debug_called(4);
2222
2223	val = AAC_GETREG4(sc, AAC_FA_MAILBOX + (mb * 4));
2224	return (val);
2225}
2226
2227/*
2228 * Set/clear interrupt masks
2229 */
2230static void
2231aac_sa_set_interrupts(struct aac_softc *sc, int enable)
2232{
2233	debug(2, "%sable interrupts", enable ? "en" : "dis");
2234
2235	if (enable) {
2236		AAC_SETREG2((sc), AAC_SA_MASK0_CLEAR, AAC_DB_INTERRUPTS);
2237	} else {
2238		AAC_SETREG2((sc), AAC_SA_MASK0_SET, ~0);
2239	}
2240}
2241
2242static void
2243aac_rx_set_interrupts(struct aac_softc *sc, int enable)
2244{
2245	debug(2, "%sable interrupts", enable ? "en" : "dis");
2246
2247	if (enable) {
2248		AAC_SETREG4(sc, AAC_RX_OIMR, ~AAC_DB_INTERRUPTS);
2249	} else {
2250		AAC_SETREG4(sc, AAC_RX_OIMR, ~0);
2251	}
2252}
2253
2254static void
2255aac_fa_set_interrupts(struct aac_softc *sc, int enable)
2256{
2257	debug(2, "%sable interrupts", enable ? "en" : "dis");
2258
2259	if (enable) {
2260		AAC_SETREG2((sc), AAC_FA_MASK0_CLEAR, AAC_DB_INTERRUPTS);
2261		AAC_FA_HACK(sc);
2262	} else {
2263		AAC_SETREG2((sc), AAC_FA_MASK0, ~0);
2264		AAC_FA_HACK(sc);
2265	}
2266}
2267
2268/*
2269 * Debugging and Diagnostics
2270 */
2271
2272/*
2273 * Print some information about the controller.
2274 */
2275static void
2276aac_describe_controller(struct aac_softc *sc)
2277{
2278	struct aac_fib *fib;
2279	struct aac_adapter_info	*info;
2280
2281	debug_called(2);
2282
2283	aac_alloc_sync_fib(sc, &fib, 0);
2284
2285	fib->data[0] = 0;
2286	if (aac_sync_fib(sc, RequestAdapterInfo, 0, fib, 1)) {
2287		device_printf(sc->aac_dev, "RequestAdapterInfo failed\n");
2288		aac_release_sync_fib(sc);
2289		return;
2290	}
2291	info = (struct aac_adapter_info *)&fib->data[0];
2292
2293	device_printf(sc->aac_dev, "%s %dMHz, %dMB cache memory, %s\n",
2294		      aac_describe_code(aac_cpu_variant, info->CpuVariant),
2295		      info->ClockSpeed, info->BufferMem / (1024 * 1024),
2296		      aac_describe_code(aac_battery_platform,
2297					info->batteryPlatform));
2298
2299	/* save the kernel revision structure for later use */
2300	sc->aac_revision = info->KernelRevision;
2301	device_printf(sc->aac_dev, "Kernel %d.%d-%d, Build %d, S/N %6X\n",
2302		      info->KernelRevision.external.comp.major,
2303		      info->KernelRevision.external.comp.minor,
2304		      info->KernelRevision.external.comp.dash,
2305		      info->KernelRevision.buildNumber,
2306		      (u_int32_t)(info->SerialNumber & 0xffffff));
2307
2308	aac_release_sync_fib(sc);
2309
2310	if (1 || bootverbose) {
2311		device_printf(sc->aac_dev, "Supported Options=%b\n",
2312			      sc->supported_options,
2313			      "\20"
2314			      "\1SNAPSHOT"
2315			      "\2CLUSTERS"
2316			      "\3WCACHE"
2317			      "\4DATA64"
2318			      "\5HOSTTIME"
2319			      "\6RAID50"
2320			      "\7WINDOW4GB"
2321			      "\10SCSIUPGD"
2322			      "\11SOFTERR"
2323			      "\12NORECOND"
2324			      "\13SGMAP64"
2325			      "\14ALARM"
2326			      "\15NONDASD");
2327	}
2328}
2329
2330/*
2331 * Look up a text description of a numeric error code and return a pointer to
2332 * same.
2333 */
2334static char *
2335aac_describe_code(struct aac_code_lookup *table, u_int32_t code)
2336{
2337	int i;
2338
2339	for (i = 0; table[i].string != NULL; i++)
2340		if (table[i].code == code)
2341			return(table[i].string);
2342	return(table[i + 1].string);
2343}
2344
2345/*
2346 * Management Interface
2347 */
2348
2349static int
2350aac_open(dev_t dev, int flags, int fmt, d_thread_t *td)
2351{
2352	struct aac_softc *sc;
2353
2354	debug_called(2);
2355
2356	sc = dev->si_drv1;
2357
2358	/* Check to make sure the device isn't already open */
2359	if (sc->aac_state & AAC_STATE_OPEN) {
2360		return EBUSY;
2361	}
2362	sc->aac_state |= AAC_STATE_OPEN;
2363
2364	return 0;
2365}
2366
2367static int
2368aac_close(dev_t dev, int flags, int fmt, d_thread_t *td)
2369{
2370	struct aac_softc *sc;
2371
2372	debug_called(2);
2373
2374	sc = dev->si_drv1;
2375
2376	/* Mark this unit as no longer open  */
2377	sc->aac_state &= ~AAC_STATE_OPEN;
2378
2379	return 0;
2380}
2381
2382static int
2383aac_ioctl(dev_t dev, u_long cmd, caddr_t arg, int flag, d_thread_t *td)
2384{
2385	union aac_statrequest *as;
2386	struct aac_softc *sc;
2387	int error = 0;
2388	uint32_t cookie;
2389
2390	debug_called(2);
2391
2392	as = (union aac_statrequest *)arg;
2393	sc = dev->si_drv1;
2394
2395	switch (cmd) {
2396	case AACIO_STATS:
2397		switch (as->as_item) {
2398		case AACQ_FREE:
2399		case AACQ_BIO:
2400		case AACQ_READY:
2401		case AACQ_BUSY:
2402		case AACQ_COMPLETE:
2403			bcopy(&sc->aac_qstat[as->as_item], &as->as_qstat,
2404			      sizeof(struct aac_qstat));
2405			break;
2406		default:
2407			error = ENOENT;
2408			break;
2409		}
2410	break;
2411
2412	case FSACTL_SENDFIB:
2413		arg = *(caddr_t*)arg;
2414	case FSACTL_LNX_SENDFIB:
2415		debug(1, "FSACTL_SENDFIB");
2416		error = aac_ioctl_sendfib(sc, arg);
2417		break;
2418	case FSACTL_AIF_THREAD:
2419	case FSACTL_LNX_AIF_THREAD:
2420		debug(1, "FSACTL_AIF_THREAD");
2421		error = EINVAL;
2422		break;
2423	case FSACTL_OPEN_GET_ADAPTER_FIB:
2424		arg = *(caddr_t*)arg;
2425	case FSACTL_LNX_OPEN_GET_ADAPTER_FIB:
2426		debug(1, "FSACTL_OPEN_GET_ADAPTER_FIB");
2427		/*
2428		 * Pass the caller out an AdapterFibContext.
2429		 *
2430		 * Note that because we only support one opener, we
2431		 * basically ignore this.  Set the caller's context to a magic
2432		 * number just in case.
2433		 *
2434		 * The Linux code hands the driver a pointer into kernel space,
2435		 * and then trusts it when the caller hands it back.  Aiee!
2436		 * Here, we give it the proc pointer of the per-adapter aif
2437		 * thread. It's only used as a sanity check in other calls.
2438		 */
2439		cookie = (uint32_t)(uintptr_t)sc->aifthread;
2440		error = copyout(&cookie, arg, sizeof(cookie));
2441		break;
2442	case FSACTL_GET_NEXT_ADAPTER_FIB:
2443		arg = *(caddr_t*)arg;
2444	case FSACTL_LNX_GET_NEXT_ADAPTER_FIB:
2445		debug(1, "FSACTL_GET_NEXT_ADAPTER_FIB");
2446		error = aac_getnext_aif(sc, arg);
2447		break;
2448	case FSACTL_CLOSE_GET_ADAPTER_FIB:
2449	case FSACTL_LNX_CLOSE_GET_ADAPTER_FIB:
2450		debug(1, "FSACTL_CLOSE_GET_ADAPTER_FIB");
2451		/* don't do anything here */
2452		break;
2453	case FSACTL_MINIPORT_REV_CHECK:
2454		arg = *(caddr_t*)arg;
2455	case FSACTL_LNX_MINIPORT_REV_CHECK:
2456		debug(1, "FSACTL_MINIPORT_REV_CHECK");
2457		error = aac_rev_check(sc, arg);
2458		break;
2459	case FSACTL_QUERY_DISK:
2460		arg = *(caddr_t*)arg;
2461	case FSACTL_LNX_QUERY_DISK:
2462		debug(1, "FSACTL_QUERY_DISK");
2463		error = aac_query_disk(sc, arg);
2464			break;
2465	case FSACTL_DELETE_DISK:
2466	case FSACTL_LNX_DELETE_DISK:
2467		/*
2468		 * We don't trust the underland to tell us when to delete a
2469		 * container, rather we rely on an AIF coming from the
2470		 * controller
2471		 */
2472		error = 0;
2473		break;
2474	default:
2475		debug(1, "unsupported cmd 0x%lx\n", cmd);
2476		error = EINVAL;
2477		break;
2478	}
2479	return(error);
2480}
2481
2482static int
2483aac_poll(dev_t dev, int poll_events, d_thread_t *td)
2484{
2485	struct aac_softc *sc;
2486	int revents;
2487
2488	sc = dev->si_drv1;
2489	revents = 0;
2490
2491	AAC_LOCK_ACQUIRE(&sc->aac_aifq_lock);
2492	if ((poll_events & (POLLRDNORM | POLLIN)) != 0) {
2493		if (sc->aac_aifq_tail != sc->aac_aifq_head)
2494			revents |= poll_events & (POLLIN | POLLRDNORM);
2495	}
2496	AAC_LOCK_RELEASE(&sc->aac_aifq_lock);
2497
2498	if (revents == 0) {
2499		if (poll_events & (POLLIN | POLLRDNORM))
2500			selrecord(td, &sc->rcv_select);
2501	}
2502
2503	return (revents);
2504}
2505
2506/*
2507 * Send a FIB supplied from userspace
2508 */
2509static int
2510aac_ioctl_sendfib(struct aac_softc *sc, caddr_t ufib)
2511{
2512	struct aac_command *cm;
2513	int size, error;
2514
2515	debug_called(2);
2516
2517	cm = NULL;
2518
2519	/*
2520	 * Get a command
2521	 */
2522	AAC_LOCK_ACQUIRE(&sc->aac_io_lock);
2523	if (aac_alloc_command(sc, &cm)) {
2524		error = EBUSY;
2525		goto out;
2526	}
2527
2528	/*
2529	 * Fetch the FIB header, then re-copy to get data as well.
2530	 */
2531	if ((error = copyin(ufib, cm->cm_fib,
2532			    sizeof(struct aac_fib_header))) != 0)
2533		goto out;
2534	size = cm->cm_fib->Header.Size + sizeof(struct aac_fib_header);
2535	if (size > sizeof(struct aac_fib)) {
2536		device_printf(sc->aac_dev, "incoming FIB oversized (%d > %zd)\n",
2537			      size, sizeof(struct aac_fib));
2538		size = sizeof(struct aac_fib);
2539	}
2540	if ((error = copyin(ufib, cm->cm_fib, size)) != 0)
2541		goto out;
2542	cm->cm_fib->Header.Size = size;
2543	cm->cm_timestamp = time_second;
2544
2545	/*
2546	 * Pass the FIB to the controller, wait for it to complete.
2547	 */
2548	if ((error = aac_wait_command(cm, 30)) != 0) {	/* XXX user timeout? */
2549		device_printf(sc->aac_dev,
2550			      "aac_wait_command return %d\n", error);
2551		goto out;
2552	}
2553
2554	/*
2555	 * Copy the FIB and data back out to the caller.
2556	 */
2557	size = cm->cm_fib->Header.Size;
2558	if (size > sizeof(struct aac_fib)) {
2559		device_printf(sc->aac_dev, "outbound FIB oversized (%d > %zd)\n",
2560			      size, sizeof(struct aac_fib));
2561		size = sizeof(struct aac_fib);
2562	}
2563	error = copyout(cm->cm_fib, ufib, size);
2564
2565out:
2566	if (cm != NULL) {
2567		aac_release_command(cm);
2568	}
2569
2570	AAC_LOCK_RELEASE(&sc->aac_io_lock);
2571	return(error);
2572}
2573
2574/*
2575 * Handle an AIF sent to us by the controller; queue it for later reference.
2576 * If the queue fills up, then drop the older entries.
2577 */
2578static void
2579aac_handle_aif(struct aac_softc *sc, struct aac_fib *fib)
2580{
2581	struct aac_aif_command *aif;
2582	struct aac_container *co, *co_next;
2583	struct aac_mntinfo *mi;
2584	struct aac_mntinforesp *mir = NULL;
2585	u_int16_t rsize;
2586	int next, found;
2587	int count = 0, added = 0, i = 0;
2588
2589	debug_called(2);
2590
2591	aif = (struct aac_aif_command*)&fib->data[0];
2592	aac_print_aif(sc, aif);
2593
2594	/* Is it an event that we should care about? */
2595	switch (aif->command) {
2596	case AifCmdEventNotify:
2597		switch (aif->data.EN.type) {
2598		case AifEnAddContainer:
2599		case AifEnDeleteContainer:
2600			/*
2601			 * A container was added or deleted, but the message
2602			 * doesn't tell us anything else!  Re-enumerate the
2603			 * containers and sort things out.
2604			 */
2605			aac_alloc_sync_fib(sc, &fib, 0);
2606			mi = (struct aac_mntinfo *)&fib->data[0];
2607			do {
2608				/*
2609				 * Ask the controller for its containers one at
2610				 * a time.
2611				 * XXX What if the controller's list changes
2612				 * midway through this enumaration?
2613				 * XXX This should be done async.
2614				 */
2615				bzero(mi, sizeof(struct aac_mntinfo));
2616				mi->Command = VM_NameServe;
2617				mi->MntType = FT_FILESYS;
2618				mi->MntCount = i;
2619				rsize = sizeof(mir);
2620				if (aac_sync_fib(sc, ContainerCommand, 0, fib,
2621						 sizeof(struct aac_mntinfo))) {
2622					printf("Error probing container %d\n",
2623					      i);
2624					continue;
2625				}
2626				mir = (struct aac_mntinforesp *)&fib->data[0];
2627				/* XXX Need to check if count changed */
2628				count = mir->MntRespCount;
2629				/*
2630				 * Check the container against our list.
2631				 * co->co_found was already set to 0 in a
2632				 * previous run.
2633				 */
2634				if ((mir->Status == ST_OK) &&
2635				    (mir->MntTable[0].VolType != CT_NONE)) {
2636					found = 0;
2637					TAILQ_FOREACH(co,
2638						      &sc->aac_container_tqh,
2639						      co_link) {
2640						if (co->co_mntobj.ObjectId ==
2641						    mir->MntTable[0].ObjectId) {
2642							co->co_found = 1;
2643							found = 1;
2644							break;
2645						}
2646					}
2647					/*
2648					 * If the container matched, continue
2649					 * in the list.
2650					 */
2651					if (found) {
2652						i++;
2653						continue;
2654					}
2655
2656					/*
2657					 * This is a new container.  Do all the
2658					 * appropriate things to set it up.
2659					 */
2660					aac_add_container(sc, mir, 1);
2661					added = 1;
2662				}
2663				i++;
2664			} while ((i < count) && (i < AAC_MAX_CONTAINERS));
2665			aac_release_sync_fib(sc);
2666
2667			/*
2668			 * Go through our list of containers and see which ones
2669			 * were not marked 'found'.  Since the controller didn't
2670			 * list them they must have been deleted.  Do the
2671			 * appropriate steps to destroy the device.  Also reset
2672			 * the co->co_found field.
2673			 */
2674			co = TAILQ_FIRST(&sc->aac_container_tqh);
2675			while (co != NULL) {
2676				if (co->co_found == 0) {
2677					device_delete_child(sc->aac_dev,
2678							    co->co_disk);
2679					co_next = TAILQ_NEXT(co, co_link);
2680					AAC_LOCK_ACQUIRE(&sc->
2681							aac_container_lock);
2682					TAILQ_REMOVE(&sc->aac_container_tqh, co,
2683						     co_link);
2684					AAC_LOCK_RELEASE(&sc->
2685							 aac_container_lock);
2686					FREE(co, M_AACBUF);
2687					co = co_next;
2688				} else {
2689					co->co_found = 0;
2690					co = TAILQ_NEXT(co, co_link);
2691				}
2692			}
2693
2694			/* Attach the newly created containers */
2695			if (added)
2696				bus_generic_attach(sc->aac_dev);
2697
2698			break;
2699
2700		default:
2701			break;
2702		}
2703
2704	default:
2705		break;
2706	}
2707
2708	/* Copy the AIF data to the AIF queue for ioctl retrieval */
2709	AAC_LOCK_ACQUIRE(&sc->aac_aifq_lock);
2710	next = (sc->aac_aifq_head + 1) % AAC_AIFQ_LENGTH;
2711	if (next != sc->aac_aifq_tail) {
2712		bcopy(aif, &sc->aac_aifq[next], sizeof(struct aac_aif_command));
2713		sc->aac_aifq_head = next;
2714
2715		/* On the off chance that someone is sleeping for an aif... */
2716		if (sc->aac_state & AAC_STATE_AIF_SLEEPER)
2717			wakeup(sc->aac_aifq);
2718		/* Wakeup any poll()ers */
2719		selwakeuppri(&sc->rcv_select, PRIBIO);
2720	}
2721	AAC_LOCK_RELEASE(&sc->aac_aifq_lock);
2722
2723	return;
2724}
2725
2726/*
2727 * Return the Revision of the driver to userspace and check to see if the
2728 * userspace app is possibly compatible.  This is extremely bogus since
2729 * our driver doesn't follow Adaptec's versioning system.  Cheat by just
2730 * returning what the card reported.
2731 */
2732static int
2733aac_rev_check(struct aac_softc *sc, caddr_t udata)
2734{
2735	struct aac_rev_check rev_check;
2736	struct aac_rev_check_resp rev_check_resp;
2737	int error = 0;
2738
2739	debug_called(2);
2740
2741	/*
2742	 * Copyin the revision struct from userspace
2743	 */
2744	if ((error = copyin(udata, (caddr_t)&rev_check,
2745			sizeof(struct aac_rev_check))) != 0) {
2746		return error;
2747	}
2748
2749	debug(2, "Userland revision= %d\n",
2750	      rev_check.callingRevision.buildNumber);
2751
2752	/*
2753	 * Doctor up the response struct.
2754	 */
2755	rev_check_resp.possiblyCompatible = 1;
2756	rev_check_resp.adapterSWRevision.external.ul =
2757	    sc->aac_revision.external.ul;
2758	rev_check_resp.adapterSWRevision.buildNumber =
2759	    sc->aac_revision.buildNumber;
2760
2761	return(copyout((caddr_t)&rev_check_resp, udata,
2762			sizeof(struct aac_rev_check_resp)));
2763}
2764
2765/*
2766 * Pass the caller the next AIF in their queue
2767 */
2768static int
2769aac_getnext_aif(struct aac_softc *sc, caddr_t arg)
2770{
2771	struct get_adapter_fib_ioctl agf;
2772	int error;
2773
2774	debug_called(2);
2775
2776	if ((error = copyin(arg, &agf, sizeof(agf))) == 0) {
2777
2778		/*
2779		 * Check the magic number that we gave the caller.
2780		 */
2781		if (agf.AdapterFibContext != (int)(uintptr_t)sc->aifthread) {
2782			error = EFAULT;
2783		} else {
2784			error = aac_return_aif(sc, agf.AifFib);
2785			if ((error == EAGAIN) && (agf.Wait)) {
2786				sc->aac_state |= AAC_STATE_AIF_SLEEPER;
2787				while (error == EAGAIN) {
2788					error = tsleep(sc->aac_aifq, PRIBIO |
2789						       PCATCH, "aacaif", 0);
2790					if (error == 0)
2791						error = aac_return_aif(sc,
2792						    agf.AifFib);
2793				}
2794				sc->aac_state &= ~AAC_STATE_AIF_SLEEPER;
2795			}
2796		}
2797	}
2798	return(error);
2799}
2800
2801/*
2802 * Hand the next AIF off the top of the queue out to userspace.
2803 */
2804static int
2805aac_return_aif(struct aac_softc *sc, caddr_t uptr)
2806{
2807	int next, error;
2808
2809	debug_called(2);
2810
2811	AAC_LOCK_ACQUIRE(&sc->aac_aifq_lock);
2812	if (sc->aac_aifq_tail == sc->aac_aifq_head) {
2813		AAC_LOCK_RELEASE(&sc->aac_aifq_lock);
2814		return (EAGAIN);
2815	}
2816
2817	next = (sc->aac_aifq_tail + 1) % AAC_AIFQ_LENGTH;
2818	error = copyout(&sc->aac_aifq[next], uptr,
2819			sizeof(struct aac_aif_command));
2820	if (error)
2821		device_printf(sc->aac_dev,
2822		    "aac_return_aif: copyout returned %d\n", error);
2823	else
2824		sc->aac_aifq_tail = next;
2825
2826	AAC_LOCK_RELEASE(&sc->aac_aifq_lock);
2827	return(error);
2828}
2829
2830/*
2831 * Give the userland some information about the container.  The AAC arch
2832 * expects the driver to be a SCSI passthrough type driver, so it expects
2833 * the containers to have b:t:l numbers.  Fake it.
2834 */
2835static int
2836aac_query_disk(struct aac_softc *sc, caddr_t uptr)
2837{
2838	struct aac_query_disk query_disk;
2839	struct aac_container *co;
2840	struct aac_disk	*disk;
2841	int error, id;
2842
2843	debug_called(2);
2844
2845	disk = NULL;
2846
2847	error = copyin(uptr, (caddr_t)&query_disk,
2848		       sizeof(struct aac_query_disk));
2849	if (error)
2850		return (error);
2851
2852	id = query_disk.ContainerNumber;
2853	if (id == -1)
2854		return (EINVAL);
2855
2856	AAC_LOCK_ACQUIRE(&sc->aac_container_lock);
2857	TAILQ_FOREACH(co, &sc->aac_container_tqh, co_link) {
2858		if (co->co_mntobj.ObjectId == id)
2859			break;
2860		}
2861
2862	if (co == NULL) {
2863			query_disk.Valid = 0;
2864			query_disk.Locked = 0;
2865			query_disk.Deleted = 1;		/* XXX is this right? */
2866	} else {
2867		disk = device_get_softc(co->co_disk);
2868		query_disk.Valid = 1;
2869		query_disk.Locked =
2870		    (disk->ad_flags & AAC_DISK_OPEN) ? 1 : 0;
2871		query_disk.Deleted = 0;
2872		query_disk.Bus = device_get_unit(sc->aac_dev);
2873		query_disk.Target = disk->unit;
2874		query_disk.Lun = 0;
2875		query_disk.UnMapped = 0;
2876		sprintf(&query_disk.diskDeviceName[0], "%s%d",
2877		        disk->ad_disk.d_name, disk->ad_disk.d_unit);
2878	}
2879	AAC_LOCK_RELEASE(&sc->aac_container_lock);
2880
2881	error = copyout((caddr_t)&query_disk, uptr,
2882			sizeof(struct aac_query_disk));
2883
2884	return (error);
2885}
2886
2887static void
2888aac_get_bus_info(struct aac_softc *sc)
2889{
2890	struct aac_fib *fib;
2891	struct aac_ctcfg *c_cmd;
2892	struct aac_ctcfg_resp *c_resp;
2893	struct aac_vmioctl *vmi;
2894	struct aac_vmi_businf_resp *vmi_resp;
2895	struct aac_getbusinf businfo;
2896	struct aac_sim *caminf;
2897	device_t child;
2898	int i, found, error;
2899
2900	aac_alloc_sync_fib(sc, &fib, 0);
2901	c_cmd = (struct aac_ctcfg *)&fib->data[0];
2902	bzero(c_cmd, sizeof(struct aac_ctcfg));
2903
2904	c_cmd->Command = VM_ContainerConfig;
2905	c_cmd->cmd = CT_GET_SCSI_METHOD;
2906	c_cmd->param = 0;
2907
2908	error = aac_sync_fib(sc, ContainerCommand, 0, fib,
2909	    sizeof(struct aac_ctcfg));
2910	if (error) {
2911		device_printf(sc->aac_dev, "Error %d sending "
2912		    "VM_ContainerConfig command\n", error);
2913		aac_release_sync_fib(sc);
2914		return;
2915	}
2916
2917	c_resp = (struct aac_ctcfg_resp *)&fib->data[0];
2918	if (c_resp->Status != ST_OK) {
2919		device_printf(sc->aac_dev, "VM_ContainerConfig returned 0x%x\n",
2920		    c_resp->Status);
2921		aac_release_sync_fib(sc);
2922		return;
2923	}
2924
2925	sc->scsi_method_id = c_resp->param;
2926
2927	vmi = (struct aac_vmioctl *)&fib->data[0];
2928	bzero(vmi, sizeof(struct aac_vmioctl));
2929
2930	vmi->Command = VM_Ioctl;
2931	vmi->ObjType = FT_DRIVE;
2932	vmi->MethId = sc->scsi_method_id;
2933	vmi->ObjId = 0;
2934	vmi->IoctlCmd = GetBusInfo;
2935
2936	error = aac_sync_fib(sc, ContainerCommand, 0, fib,
2937	    sizeof(struct aac_vmioctl));
2938	if (error) {
2939		device_printf(sc->aac_dev, "Error %d sending VMIoctl command\n",
2940		    error);
2941		aac_release_sync_fib(sc);
2942		return;
2943	}
2944
2945	vmi_resp = (struct aac_vmi_businf_resp *)&fib->data[0];
2946	if (vmi_resp->Status != ST_OK) {
2947		device_printf(sc->aac_dev, "VM_Ioctl returned %d\n",
2948		    vmi_resp->Status);
2949		aac_release_sync_fib(sc);
2950		return;
2951	}
2952
2953	bcopy(&vmi_resp->BusInf, &businfo, sizeof(struct aac_getbusinf));
2954	aac_release_sync_fib(sc);
2955
2956	found = 0;
2957	for (i = 0; i < businfo.BusCount; i++) {
2958		if (businfo.BusValid[i] != AAC_BUS_VALID)
2959			continue;
2960
2961		caminf = (struct aac_sim *)malloc( sizeof(struct aac_sim),
2962		    M_AACBUF, M_NOWAIT | M_ZERO);
2963		if (caminf == NULL)
2964			continue;
2965
2966		child = device_add_child(sc->aac_dev, "aacp", -1);
2967		if (child == NULL) {
2968			device_printf(sc->aac_dev, "device_add_child failed\n");
2969			continue;
2970		}
2971
2972		caminf->TargetsPerBus = businfo.TargetsPerBus;
2973		caminf->BusNumber = i;
2974		caminf->InitiatorBusId = businfo.InitiatorBusId[i];
2975		caminf->aac_sc = sc;
2976		caminf->sim_dev = child;
2977
2978		device_set_ivars(child, caminf);
2979		device_set_desc(child, "SCSI Passthrough Bus");
2980		TAILQ_INSERT_TAIL(&sc->aac_sim_tqh, caminf, sim_link);
2981
2982		found = 1;
2983	}
2984
2985	if (found)
2986		bus_generic_attach(sc->aac_dev);
2987
2988	return;
2989}
2990