xref: /freebsd/sys/dev/aac/aacvar.h (revision 5686c6c38a3e1cc78804eaf5f880bda23dcf592f)
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  *	$FreeBSD$
30  */
31 
32 #include <sys/bio.h>
33 #include <sys/callout.h>
34 #include <sys/lock.h>
35 #include <sys/mutex.h>
36 #include <sys/selinfo.h>
37 #include <sys/sysctl.h>
38 #include <sys/taskqueue.h>
39 #include <geom/geom_disk.h>
40 
41 SYSCTL_DECL(_hw_aac);
42 
43 #define	AAC_TYPE_DEVO			1
44 #define	AAC_TYPE_ALPHA			2
45 #define	AAC_TYPE_BETA			3
46 #define	AAC_TYPE_RELEASE		4
47 
48 #define	AAC_DRIVER_MAJOR_VERSION	2
49 #define	AAC_DRIVER_MINOR_VERSION	1
50 #define	AAC_DRIVER_BUGFIX_LEVEL		9
51 #define	AAC_DRIVER_TYPE			AAC_TYPE_RELEASE
52 
53 #ifndef AAC_DRIVER_BUILD
54 # define AAC_DRIVER_BUILD 1
55 #endif
56 
57 /*
58  * Driver Parameter Definitions
59  */
60 
61 /*
62  * The firmware interface allows for a 16-bit s/g list length.  We limit
63  * ourselves to a reasonable maximum and ensure alignment.
64  */
65 #define AAC_MAXSGENTRIES	64	/* max S/G entries, limit 65535 */
66 
67 /*
68  * We allocate a small set of FIBs for the adapter to use to send us messages.
69  */
70 #define AAC_ADAPTER_FIBS	8
71 
72 /*
73  * The controller reports status events in AIFs.  We hang on to a number of
74  * these in order to pass them out to user-space management tools.
75  */
76 #define AAC_AIFQ_LENGTH		64
77 
78 /*
79  * Firmware messages are passed in the printf buffer.
80  */
81 #define AAC_PRINTF_BUFSIZE	256
82 
83 /*
84  * We wait this many seconds for the adapter to come ready if it is still
85  * booting
86  */
87 #define AAC_BOOT_TIMEOUT	(3 * 60)
88 
89 /*
90  * Timeout for immediate commands.
91  */
92 #define AAC_IMMEDIATE_TIMEOUT	30		/* seconds */
93 
94 /*
95  * Timeout for normal commands
96  */
97 #define AAC_CMD_TIMEOUT		120		/* seconds */
98 
99 /*
100  * Rate at which we periodically check for timed out commands and kick the
101  * controller.
102  */
103 #define AAC_PERIODIC_INTERVAL	20		/* seconds */
104 
105 /*
106  * Per-container data structure
107  */
108 struct aac_container
109 {
110 	struct aac_mntobj		co_mntobj;
111 	device_t			co_disk;
112 	int				co_found;
113 	TAILQ_ENTRY(aac_container)	co_link;
114 };
115 
116 /*
117  * Per-SIM data structure
118  */
119 struct aac_cam;
120 struct aac_sim
121 {
122 	device_t		sim_dev;
123 	int			TargetsPerBus;
124 	int			BusNumber;
125 	int			InitiatorBusId;
126 	struct aac_softc	*aac_sc;
127 	struct aac_cam		*aac_cam;
128 	TAILQ_ENTRY(aac_sim)	sim_link;
129 };
130 
131 /*
132  * Per-disk structure
133  */
134 struct aac_disk
135 {
136 	device_t			ad_dev;
137 	struct aac_softc		*ad_controller;
138 	struct aac_container		*ad_container;
139 	struct disk			*ad_disk;
140 	int				ad_flags;
141 #define AAC_DISK_OPEN	(1<<0)
142 	int				ad_cylinders;
143 	int				ad_heads;
144 	int				ad_sectors;
145 	u_int64_t			ad_size;
146 	int				unit;
147 };
148 
149 /*
150  * Per-command control structure.
151  */
152 struct aac_command
153 {
154 	TAILQ_ENTRY(aac_command) cm_link;	/* list linkage */
155 
156 	struct aac_softc	*cm_sc;		/* controller that owns us */
157 
158 	struct aac_fib		*cm_fib;	/* FIB associated with this
159 						 * command */
160 	u_int64_t		cm_fibphys;	/* bus address of the FIB */
161 	struct bio		*cm_data;	/* pointer to data in kernel
162 						 * space */
163 	u_int32_t		cm_datalen;	/* data length */
164 	bus_dmamap_t		cm_datamap;	/* DMA map for bio data */
165 	struct aac_sg_table	*cm_sgtable;	/* pointer to s/g table in
166 						 * command */
167 	int			cm_flags;
168 #define AAC_CMD_MAPPED		(1<<0)		/* command has had its data
169 						 * mapped */
170 #define AAC_CMD_DATAIN		(1<<1)		/* command involves data moving
171 						 * from controller to host */
172 #define AAC_CMD_DATAOUT		(1<<2)		/* command involves data moving
173 						 * from host to controller */
174 #define AAC_CMD_COMPLETED	(1<<3)		/* command has been completed */
175 #define AAC_CMD_TIMEDOUT	(1<<4)		/* command taken too long */
176 #define AAC_ON_AACQ_FREE	(1<<5)
177 #define AAC_ON_AACQ_READY	(1<<6)
178 #define AAC_ON_AACQ_BUSY	(1<<7)
179 #define AAC_ON_AACQ_AIF		(1<<8)
180 #define AAC_ON_AACQ_NORM	(1<<10)
181 #define AAC_ON_AACQ_MASK	((1<<5)|(1<<6)|(1<<7)|(1<<8)|(1<<10))
182 #define AAC_QUEUE_FRZN		(1<<9)		/* Freeze the processing of
183 						 * commands on the queue. */
184 
185 	void			(* cm_complete)(struct aac_command *cm);
186 	void			*cm_private;
187 	time_t			cm_timestamp;	/* command creation time */
188 	int			cm_queue;
189 	int			cm_index;
190 };
191 
192 struct aac_fibmap {
193 	TAILQ_ENTRY(aac_fibmap) fm_link;	/* list linkage */
194 	struct aac_fib		*aac_fibs;
195 	bus_dmamap_t		aac_fibmap;
196 	struct aac_command	*aac_commands;
197 };
198 
199 /*
200  * We gather a number of adapter-visible items into a single structure.
201  *
202  * The ordering of this strucure may be important; we copy the Linux driver:
203  *
204  * Adapter FIBs
205  * Init struct
206  * Queue headers (Comm Area)
207  * Printf buffer
208  *
209  * In addition, we add:
210  * Sync Fib
211  */
212 struct aac_common {
213 	/* fibs for the controller to send us messages */
214 	struct aac_fib		ac_fibs[AAC_ADAPTER_FIBS];
215 
216 	/* the init structure */
217 	struct aac_adapter_init	ac_init;
218 
219 	/* arena within which the queue structures are kept */
220 	u_int8_t		ac_qbuf[sizeof(struct aac_queue_table) +
221 				AAC_QUEUE_ALIGN];
222 
223 	/* buffer for text messages from the controller */
224 	char			ac_printf[AAC_PRINTF_BUFSIZE];
225 
226 	/* fib for synchronous commands */
227 	struct aac_fib		ac_sync_fib;
228 };
229 
230 /*
231  * Interface operations
232  */
233 struct aac_interface
234 {
235 	int	(*aif_get_fwstatus)(struct aac_softc *sc);
236 	void	(*aif_qnotify)(struct aac_softc *sc, int qbit);
237 	int	(*aif_get_istatus)(struct aac_softc *sc);
238 	void	(*aif_clr_istatus)(struct aac_softc *sc, int mask);
239 	void	(*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command,
240 				   u_int32_t arg0, u_int32_t arg1,
241 				   u_int32_t arg2, u_int32_t arg3);
242 	int	(*aif_get_mailbox)(struct aac_softc *sc, int mb);
243 	void	(*aif_set_interrupts)(struct aac_softc *sc, int enable);
244 	int (*aif_send_command)(struct aac_softc *sc, struct aac_command *cm);
245 	int (*aif_get_outb_queue)(struct aac_softc *sc);
246 	void (*aif_set_outb_queue)(struct aac_softc *sc, int index);
247 };
248 extern const struct aac_interface	aac_rx_interface;
249 extern const struct aac_interface	aac_sa_interface;
250 extern const struct aac_interface	aac_fa_interface;
251 extern const struct aac_interface	aac_rkt_interface;
252 
253 #define AAC_GET_FWSTATUS(sc)		((sc)->aac_if->aif_get_fwstatus((sc)))
254 #define AAC_QNOTIFY(sc, qbit)		((sc)->aac_if->aif_qnotify((sc), (qbit)))
255 #define AAC_GET_ISTATUS(sc)		((sc)->aac_if->aif_get_istatus((sc)))
256 #define AAC_CLEAR_ISTATUS(sc, mask)	((sc)->aac_if->aif_clr_istatus((sc), \
257 					(mask)))
258 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \
259 	((sc)->aac_if->aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \
260 	(arg3)))
261 #define AAC_GET_MAILBOX(sc, mb)		((sc)->aac_if->aif_get_mailbox((sc), \
262 					(mb)))
263 #define	AAC_MASK_INTERRUPTS(sc)		((sc)->aac_if->aif_set_interrupts((sc), \
264 					0))
265 #define AAC_UNMASK_INTERRUPTS(sc)	((sc)->aac_if->aif_set_interrupts((sc), \
266 					1))
267 #define AAC_SEND_COMMAND(sc, cm)	((sc)->aac_if->aif_send_command((sc), (cm)))
268 #define AAC_GET_OUTB_QUEUE(sc)		((sc)->aac_if->aif_get_outb_queue((sc)))
269 #define AAC_SET_OUTB_QUEUE(sc, idx)	((sc)->aac_if->aif_set_outb_queue((sc), (idx)))
270 
271 #define AAC_MEM0_SETREG4(sc, reg, val)	bus_space_write_4(sc->aac_btag0, \
272 					sc->aac_bhandle0, reg, val)
273 #define AAC_MEM0_GETREG4(sc, reg)	bus_space_read_4(sc->aac_btag0, \
274 					sc->aac_bhandle0, reg)
275 #define AAC_MEM0_SETREG2(sc, reg, val)	bus_space_write_2(sc->aac_btag0, \
276 					sc->aac_bhandle0, reg, val)
277 #define AAC_MEM0_GETREG2(sc, reg)	bus_space_read_2(sc->aac_btag0, \
278 					sc->aac_bhandle0, reg)
279 #define AAC_MEM0_SETREG1(sc, reg, val)	bus_space_write_1(sc->aac_btag0, \
280 					sc->aac_bhandle0, reg, val)
281 #define AAC_MEM0_GETREG1(sc, reg)	bus_space_read_1(sc->aac_btag0, \
282 					sc->aac_bhandle0, reg)
283 
284 #define AAC_MEM1_SETREG4(sc, reg, val)	bus_space_write_4(sc->aac_btag1, \
285 					sc->aac_bhandle1, reg, val)
286 #define AAC_MEM1_GETREG4(sc, reg)	bus_space_read_4(sc->aac_btag1, \
287 					sc->aac_bhandle1, reg)
288 #define AAC_MEM1_SETREG2(sc, reg, val)	bus_space_write_2(sc->aac_btag1, \
289 					sc->aac_bhandle1, reg, val)
290 #define AAC_MEM1_GETREG2(sc, reg)	bus_space_read_2(sc->aac_btag1, \
291 					sc->aac_bhandle1, reg)
292 #define AAC_MEM1_SETREG1(sc, reg, val)	bus_space_write_1(sc->aac_btag1, \
293 					sc->aac_bhandle1, reg, val)
294 #define AAC_MEM1_GETREG1(sc, reg)	bus_space_read_1(sc->aac_btag1, \
295 					sc->aac_bhandle1, reg)
296 
297 /* fib context (IOCTL) */
298 struct aac_fib_context {
299 	u_int32_t		unique;
300 	int			ctx_idx;
301 	int			ctx_wrap;
302 	struct aac_fib_context *next, *prev;
303 };
304 
305 /*
306  * Per-controller structure.
307  */
308 struct aac_softc
309 {
310 	/* bus connections */
311 	device_t		aac_dev;
312 	struct resource		*aac_regs_res0, *aac_regs_res1; /* reg. if. window */
313 	bus_space_handle_t	aac_bhandle0, aac_bhandle1;		/* bus space handle */
314 	bus_space_tag_t		aac_btag0, aac_btag1;		/* bus space tag */
315 	bus_dma_tag_t		aac_parent_dmat;	/* parent DMA tag */
316 	bus_dma_tag_t		aac_buffer_dmat;	/* data buffer/command
317 							 * DMA tag */
318 	struct resource		*aac_irq;		/* interrupt */
319 	void			*aac_intr;		/* interrupt handle */
320 	eventhandler_tag	eh;
321 
322 	/* controller features, limits and status */
323 	int			aac_state;
324 #define AAC_STATE_SUSPEND	(1<<0)
325 #define	AAC_STATE_UNUSED0	(1<<1)
326 #define AAC_STATE_INTERRUPTS_ON	(1<<2)
327 #define AAC_STATE_AIF_SLEEPER	(1<<3)
328 	struct FsaRevision		aac_revision;
329 
330 	/* controller hardware interface */
331 	int			aac_hwif;
332 #define AAC_HWIF_I960RX		0
333 #define AAC_HWIF_STRONGARM	1
334 #define AAC_HWIF_RKT		3
335 #define	AAC_HWIF_NARK		4
336 #define AAC_HWIF_UNKNOWN	-1
337 	bus_dma_tag_t		aac_common_dmat;	/* common structure
338 							 * DMA tag */
339 	bus_dmamap_t		aac_common_dmamap;	/* common structure
340 							 * DMA map */
341 	struct aac_common	*aac_common;
342 	u_int32_t		aac_common_busaddr;
343 	const struct aac_interface	*aac_if;
344 
345 	/* command/fib resources */
346 	bus_dma_tag_t		aac_fib_dmat;	/* DMA tag for allocing FIBs */
347 	TAILQ_HEAD(,aac_fibmap)	aac_fibmap_tqh;
348 	u_int			total_fibs;
349 	struct aac_command	*aac_commands;
350 
351 	/* command management */
352 	TAILQ_HEAD(,aac_command) aac_free;	/* command structures
353 						 * available for reuse */
354 	TAILQ_HEAD(,aac_command) aac_ready;	/* commands on hold for
355 						 * controller resources */
356 	TAILQ_HEAD(,aac_command) aac_busy;
357 	TAILQ_HEAD(,aac_event)	aac_ev_cmfree;
358 	struct bio_queue_head	aac_bioq;
359 	struct aac_queue_table	*aac_queues;
360 	struct aac_queue_entry	*aac_qentries[AAC_QUEUE_COUNT];
361 
362 	struct aac_qstat	aac_qstat[AACQ_COUNT];	/* queue statistics */
363 
364 	/* connected containters */
365 	TAILQ_HEAD(,aac_container)	aac_container_tqh;
366 	struct mtx		aac_container_lock;
367 
368 	/*
369 	 * The general I/O lock.  This protects the sync fib, the lists, the
370 	 * queues, and the registers.
371 	 */
372 	struct mtx		aac_io_lock;
373 
374 	/* delayed activity infrastructure */
375 	struct task		aac_task_complete;	/* deferred-completion
376 							 * task */
377 	struct intr_config_hook	aac_ich;
378 
379 	/* management interface */
380 	struct cdev *aac_dev_t;
381 	struct mtx		aac_aifq_lock;
382 	struct aac_fib		aac_aifq[AAC_AIFQ_LENGTH];
383 	int			aifq_idx;
384 	int			aifq_filled;
385 	struct aac_fib_context *fibctx;
386 	struct selinfo		rcv_select;
387 	struct proc		*aifthread;
388 	int			aifflags;
389 #define AAC_AIFFLAGS_RUNNING	(1 << 0)
390 #define AAC_AIFFLAGS_UNUSED0	(1 << 1)
391 #define	AAC_AIFFLAGS_EXIT	(1 << 2)
392 #define AAC_AIFFLAGS_EXITED	(1 << 3)
393 #define AAC_AIFFLAGS_UNUSED1	(1 << 4)
394 #define	AAC_AIFFLAGS_ALLOCFIBS	(1 << 5)
395 #define AAC_AIFFLAGS_PENDING	AAC_AIFFLAGS_ALLOCFIBS
396 	u_int32_t		flags;
397 #define AAC_FLAGS_PERC2QC	(1 << 0)
398 #define	AAC_FLAGS_ENABLE_CAM	(1 << 1)	/* No SCSI passthrough */
399 #define	AAC_FLAGS_CAM_NORESET	(1 << 2)	/* Fake SCSI resets */
400 #define	AAC_FLAGS_CAM_PASSONLY	(1 << 3)	/* Only create pass devices */
401 #define	AAC_FLAGS_SG_64BIT	(1 << 4)	/* Use 64-bit S/G addresses */
402 #define	AAC_FLAGS_4GB_WINDOW	(1 << 5)	/* Device can access host mem
403 						 * 2GB-4GB range */
404 #define	AAC_FLAGS_NO4GB		(1 << 6)	/* Can't access host mem >2GB */
405 #define	AAC_FLAGS_256FIBS	(1 << 7)	/* Can only do 256 commands */
406 #define	AAC_FLAGS_BROKEN_MEMMAP (1 << 8)	/* Broken HostPhysMemPages */
407 #define AAC_FLAGS_SLAVE	(1 << 9)
408 #define AAC_FLAGS_MASTER	(1 << 10)
409 #define AAC_FLAGS_NEW_COMM	(1 << 11)	/* New comm. interface supported */
410 #define AAC_FLAGS_RAW_IO	(1 << 12)	/* Raw I/O interface */
411 #define AAC_FLAGS_ARRAY_64BIT	(1 << 13)	/* 64-bit array size */
412 #define	AAC_FLAGS_LBA_64BIT	(1 << 14)	/* 64-bit LBA support */
413 
414 	u_int32_t		supported_options;
415 	u_int32_t		scsi_method_id;
416 	TAILQ_HEAD(,aac_sim)	aac_sim_tqh;
417 
418 	struct callout	aac_daemontime;		/* clock daemon callout */
419 
420 	u_int32_t	aac_max_fibs;		/* max. FIB count */
421 	u_int32_t	aac_max_fibs_alloc;		/* max. alloc. per alloc_commands() */
422 	u_int32_t	aac_max_fib_size;		/* max. FIB size */
423 	u_int32_t	aac_sg_tablesize;		/* max. sg count from host */
424 	u_int32_t	aac_max_sectors;		/* max. I/O size from host (blocks) */
425 #define AAC_CAM_TARGET_WILDCARD ~0
426 	void			(*cam_rescan_cb)(struct aac_softc *, uint32_t,
427 				    uint32_t);
428 };
429 
430 /*
431  * Event callback mechanism for the driver
432  */
433 #define AAC_EVENT_NONE		0x00
434 #define AAC_EVENT_CMFREE	0x01
435 #define	AAC_EVENT_MASK		0xff
436 #define AAC_EVENT_REPEAT	0x100
437 
438 typedef void aac_event_cb_t(struct aac_softc *sc, struct aac_event *event,
439     void *arg);
440 struct aac_event {
441 	TAILQ_ENTRY(aac_event)	ev_links;
442 	int			ev_type;
443 	aac_event_cb_t		*ev_callback;
444 	void			*ev_arg;
445 };
446 
447 /*
448  * Public functions
449  */
450 extern void		aac_free(struct aac_softc *sc);
451 extern int		aac_attach(struct aac_softc *sc);
452 extern int		aac_detach(device_t dev);
453 extern int		aac_shutdown(device_t dev);
454 extern int		aac_suspend(device_t dev);
455 extern int		aac_resume(device_t dev);
456 extern void		aac_new_intr(void *arg);
457 extern int		aac_filter(void *arg);
458 extern void		aac_submit_bio(struct bio *bp);
459 extern void		aac_biodone(struct bio *bp);
460 extern void		aac_startio(struct aac_softc *sc);
461 extern int		aac_alloc_command(struct aac_softc *sc,
462 					  struct aac_command **cmp);
463 extern void		aac_release_command(struct aac_command *cm);
464 extern int		aac_sync_fib(struct aac_softc *sc, u_int32_t command,
465 				     u_int32_t xferstate, struct aac_fib *fib,
466 				     u_int16_t datasize);
467 extern void		aac_add_event(struct aac_softc *sc, struct aac_event
468 				      *event);
469 
470 #ifdef AAC_DEBUG
471 extern int	aac_debug_enable;
472 # define fwprintf(sc, flags, fmt, args...)				\
473 do {									\
474 	if (!aac_debug_enable)						\
475 		break;							\
476 	if (sc != NULL)							\
477 		device_printf(((struct aac_softc *)sc)->aac_dev,	\
478 		    "%s: " fmt "\n", __func__, ##args);			\
479 	else								\
480 		printf("%s: " fmt "\n", __func__, ##args);		\
481 } while(0)
482 
483 extern void	aac_print_queues(struct aac_softc *sc);
484 extern void	aac_panic(struct aac_softc *sc, char *reason);
485 extern void	aac_print_fib(struct aac_softc *sc, struct aac_fib *fib,
486 			      const char *caller);
487 extern void	aac_print_aif(struct aac_softc *sc,
488 			      struct aac_aif_command *aif);
489 
490 #define AAC_PRINT_FIB(sc, fib)	aac_print_fib(sc, fib, __func__)
491 
492 #else
493 # define fwprintf(sc, flags, fmt, args...)
494 
495 # define aac_print_queues(sc)
496 # define aac_panic(sc, reason)
497 
498 # define AAC_PRINT_FIB(sc, fib)
499 # define aac_print_aif(sc, aac_aif_command)
500 #endif
501 
502 struct aac_code_lookup {
503 	const char	*string;
504 	u_int32_t	code;
505 };
506 
507 /*
508  * Queue primitives for driver queues.
509  */
510 #define AACQ_ADD(sc, qname)					\
511 	do {							\
512 		struct aac_qstat *qs;				\
513 								\
514 		qs = &(sc)->aac_qstat[qname];			\
515 								\
516 		qs->q_length++;					\
517 		if (qs->q_length > qs->q_max)			\
518 			qs->q_max = qs->q_length;		\
519 	} while (0)
520 
521 #define AACQ_REMOVE(sc, qname)    (sc)->aac_qstat[qname].q_length--
522 #define AACQ_INIT(sc, qname)				\
523 	do {						\
524 		sc->aac_qstat[qname].q_length = 0;	\
525 		sc->aac_qstat[qname].q_max = 0;		\
526 	} while (0)
527 
528 
529 #define AACQ_COMMAND_QUEUE(name, index)					\
530 static __inline void							\
531 aac_initq_ ## name (struct aac_softc *sc)				\
532 {									\
533 	TAILQ_INIT(&sc->aac_ ## name);					\
534 	AACQ_INIT(sc, index);						\
535 }									\
536 static __inline void							\
537 aac_enqueue_ ## name (struct aac_command *cm)				\
538 {									\
539 	if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) {			\
540 		panic("aac: command %p is on another queue, flags = %#x", \
541 		    cm, cm->cm_flags);					\
542 	}								\
543 	TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link);	\
544 	cm->cm_flags |= AAC_ON_ ## index;				\
545 	AACQ_ADD(cm->cm_sc, index);					\
546 }									\
547 static __inline void							\
548 aac_requeue_ ## name (struct aac_command *cm)				\
549 {									\
550 	if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) {			\
551 		panic("aac: command %p is on another queue, flags = %#x", \
552 		    cm, cm->cm_flags);					\
553 	}								\
554 	TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link);	\
555 	cm->cm_flags |= AAC_ON_ ## index;				\
556 	AACQ_ADD(cm->cm_sc, index);					\
557 }									\
558 static __inline struct aac_command *					\
559 aac_dequeue_ ## name (struct aac_softc *sc)				\
560 {									\
561 	struct aac_command *cm;						\
562 									\
563 	if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) {		\
564 		if ((cm->cm_flags & AAC_ON_ ## index) == 0) {		\
565 			panic("aac: command %p not in queue, flags = %#x, bit = %#x", \
566 			    cm, cm->cm_flags, AAC_ON_ ## index);	\
567 		}							\
568 		TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link);		\
569 		cm->cm_flags &= ~AAC_ON_ ## index;			\
570 		AACQ_REMOVE(sc, index);					\
571 	}								\
572 	return(cm);							\
573 }									\
574 static __inline void							\
575 aac_remove_ ## name (struct aac_command *cm)				\
576 {									\
577 	if ((cm->cm_flags & AAC_ON_ ## index) == 0) {			\
578 		panic("aac: command %p not in queue, flags = %#x, bit = %#x", \
579 		    cm, cm->cm_flags, AAC_ON_ ## index);		\
580 	}								\
581 	TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link);		\
582 	cm->cm_flags &= ~AAC_ON_ ## index;				\
583 	AACQ_REMOVE(cm->cm_sc, index);					\
584 }									\
585 
586 AACQ_COMMAND_QUEUE(free, AACQ_FREE);
587 AACQ_COMMAND_QUEUE(ready, AACQ_READY);
588 AACQ_COMMAND_QUEUE(busy, AACQ_BUSY);
589 
590 /*
591  * outstanding bio queue
592  */
593 static __inline void
594 aac_initq_bio(struct aac_softc *sc)
595 {
596 	bioq_init(&sc->aac_bioq);
597 	AACQ_INIT(sc, AACQ_BIO);
598 }
599 
600 static __inline void
601 aac_enqueue_bio(struct aac_softc *sc, struct bio *bp)
602 {
603 	bioq_insert_tail(&sc->aac_bioq, bp);
604 	AACQ_ADD(sc, AACQ_BIO);
605 }
606 
607 static __inline struct bio *
608 aac_dequeue_bio(struct aac_softc *sc)
609 {
610 	struct bio *bp;
611 
612 	if ((bp = bioq_first(&sc->aac_bioq)) != NULL) {
613 		bioq_remove(&sc->aac_bioq, bp);
614 		AACQ_REMOVE(sc, AACQ_BIO);
615 	}
616 	return(bp);
617 }
618 
619 static __inline void
620 aac_print_printf(struct aac_softc *sc)
621 {
622 	/*
623 	 * XXX We have the ability to read the length of the printf string
624 	 * from out of the mailboxes.
625 	 */
626 	device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE,
627 		      sc->aac_common->ac_printf);
628 	sc->aac_common->ac_printf[0] = 0;
629 	AAC_QNOTIFY(sc, AAC_DB_PRINTF);
630 }
631 
632 static __inline int
633 aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib)
634 {
635 
636 	mtx_assert(&sc->aac_io_lock, MA_OWNED);
637 	*fib = &sc->aac_common->ac_sync_fib;
638 	return (0);
639 }
640 
641 static __inline void
642 aac_release_sync_fib(struct aac_softc *sc)
643 {
644 
645 	mtx_assert(&sc->aac_io_lock, MA_OWNED);
646 }
647