2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2001 Scott Long
4 * Copyright (c) 2000 BSDi
5 * Copyright (c) 2001 Adaptec, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
29 * $FreeBSD: src/sys/dev/aac/aacvar.h,v 1.4.2.7 2003/04/08 13:22:08 scottl Exp $
30 * $DragonFly: src/sys/dev/raid/aac/aacvar.h,v 1.9 2005/06/09 20:55:05 swildner Exp $
33 #include <sys/thread2.h>
36 * Driver Parameter Definitions
40 * The firmware interface allows for a 16-bit s/g list length. We limit
41 * ourselves to a reasonable maximum and ensure alignment.
43 #define AAC_MAXSGENTRIES 64 /* max S/G entries, limit 65535 */
46 * We allocate a small set of FIBs for the adapter to use to send us messages.
48 #define AAC_ADAPTER_FIBS 8
51 * FIBs are allocated up-front, and the pool isn't grown. We should allocate
52 * enough here to let us keep the adapter busy without wasting large amounts
53 * of kernel memory. The current interface implementation limits us to 512
54 * FIBs queued for the adapter at any one time.
56 #define AAC_FIB_COUNT 128
59 * The controller reports status events in AIFs. We hang on to a number of
60 * these in order to pass them out to user-space management tools.
62 #define AAC_AIFQ_LENGTH 64
65 * Firmware messages are passed in the printf buffer.
67 #define AAC_PRINTF_BUFSIZE 256
70 * We wait this many seconds for the adapter to come ready if it is still
73 #define AAC_BOOT_TIMEOUT (3 * 60)
76 * Timeout for immediate commands.
78 #define AAC_IMMEDIATE_TIMEOUT 30 /* seconds */
81 * Timeout for normal commands
83 #define AAC_CMD_TIMEOUT 30 /* seconds */
86 * Rate at which we periodically check for timed out commands and kick the
89 #define AAC_PERIODIC_INTERVAL 20 /* seconds */
92 * Character device major numbers.
94 #define AAC_DISK_MAJOR 200
97 * Driver Variable Definitions
100 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
101 # include <sys/taskqueue.h>
105 * Per-container data structure
109 struct aac_mntobj co_mntobj;
112 TAILQ_ENTRY(aac_container) co_link;
122 struct aac_softc *ad_controller;
123 struct aac_container *ad_container;
125 struct devstat ad_stats;
126 struct disklabel ad_label;
128 #define AAC_DISK_OPEN (1<<0)
137 * Per-command control structure.
141 TAILQ_ENTRY(aac_command) cm_link; /* list linkage */
143 struct aac_softc *cm_sc; /* controller that owns us */
145 struct aac_fib *cm_fib; /* FIB associated with this
147 u_int32_t cm_fibphys; /* bus address of the FIB */
148 struct bio *cm_data; /* pointer to data in kernel
150 u_int32_t cm_datalen; /* data length */
151 bus_dmamap_t cm_datamap; /* DMA map for bio data */
152 struct aac_sg_table *cm_sgtable; /* pointer to s/g table in
155 #define AAC_CMD_MAPPED (1<<0) /* command has had its data
157 #define AAC_CMD_DATAIN (1<<1) /* command involves data moving
158 * from controller to host */
159 #define AAC_CMD_DATAOUT (1<<2) /* command involves data moving
160 * from host to controller */
161 #define AAC_CMD_COMPLETED (1<<3) /* command has been completed */
162 #define AAC_CMD_TIMEDOUT (1<<4) /* command taken too long */
163 #define AAC_ON_AACQ_FREE (1<<5)
164 #define AAC_ON_AACQ_READY (1<<6)
165 #define AAC_ON_AACQ_BUSY (1<<7)
166 #define AAC_ON_AACQ_COMPLETE (1<<8)
167 #define AAC_ON_AACQ_MASK ((1<<5)|(1<<6)|(1<<7)|(1<<8))
169 void (* cm_complete)(struct aac_command *cm);
171 time_t cm_timestamp; /* command creation time */
176 * We gather a number of adapter-visible items into a single structure.
178 * The ordering of this strucure may be important; we copy the Linux driver:
182 * Queue headers (Comm Area)
185 * In addition, we add:
189 /* fibs for the controller to send us messages */
190 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS];
192 /* the init structure */
193 struct aac_adapter_init ac_init;
195 /* arena within which the queue structures are kept */
196 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) +
199 /* buffer for text messages from the controller */
200 char ac_printf[AAC_PRINTF_BUFSIZE];
202 /* fib for synchronous commands */
203 struct aac_fib ac_sync_fib;
207 * Interface operations
211 int (*aif_get_fwstatus)(struct aac_softc *sc);
212 void (*aif_qnotify)(struct aac_softc *sc, int qbit);
213 int (*aif_get_istatus)(struct aac_softc *sc);
214 void (*aif_clr_istatus)(struct aac_softc *sc, int mask);
215 void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command,
216 u_int32_t arg0, u_int32_t arg1,
217 u_int32_t arg2, u_int32_t arg3);
218 int (*aif_get_mailbox)(struct aac_softc *sc, int mb);
219 void (*aif_set_interrupts)(struct aac_softc *sc, int enable);
221 extern struct aac_interface aac_rx_interface;
222 extern struct aac_interface aac_sa_interface;
223 extern struct aac_interface aac_fa_interface;
225 #define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc)))
226 #define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit)))
227 #define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc)))
228 #define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \
230 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \
231 ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \
233 #define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \
235 #define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
237 #define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
240 #define AAC_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag, \
241 sc->aac_bhandle, reg, val)
242 #define AAC_GETREG4(sc, reg) bus_space_read_4 (sc->aac_btag, \
243 sc->aac_bhandle, reg)
244 #define AAC_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag, \
245 sc->aac_bhandle, reg, val)
246 #define AAC_GETREG2(sc, reg) bus_space_read_2 (sc->aac_btag, \
247 sc->aac_bhandle, reg)
248 #define AAC_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag, \
249 sc->aac_bhandle, reg, val)
250 #define AAC_GETREG1(sc, reg) bus_space_read_1 (sc->aac_btag, \
251 sc->aac_bhandle, reg)
253 TAILQ_HEAD(aac_container_tq, aac_container);
255 /* Define the OS version specific locks */
256 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
257 #include <sys/lock.h>
258 #include <sys/mutex.h>
259 typedef struct mtx aac_lock_t;
260 #define AAC_LOCK_INIT(l, s) mtx_init(l, s, MTX_DEF)
261 #define AAC_LOCK_ACQUIRE(l) mtx_lock(l)
262 #define AAC_LOCK_RELEASE(l) mtx_unlock(l)
264 typedef struct lwkt_rwlock aac_lock_t;
265 #define AAC_LOCK_INIT(l, s) lwkt_rwlock_init(l)
266 #define AAC_LOCK_ACQUIRE(l) lwkt_exlock(l, "aac")
267 #define AAC_LOCK_RELEASE(l) lwkt_exunlock(l)
270 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
271 #include <sys/selinfo.h>
273 #include <sys/select.h>
277 * Per-controller structure.
281 /* bus connections */
283 struct callout aac_watchdog;
284 struct resource *aac_regs_resource; /* register interface
286 int aac_regs_rid; /* resource ID */
287 bus_space_handle_t aac_bhandle; /* bus space handle */
288 bus_space_tag_t aac_btag; /* bus space tag */
289 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */
290 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command
292 struct resource *aac_irq; /* interrupt */
294 void *aac_intr; /* interrupt handle */
296 /* controller features, limits and status */
298 #define AAC_STATE_SUSPEND (1<<0)
299 #define AAC_STATE_OPEN (1<<1)
300 #define AAC_STATE_INTERRUPTS_ON (1<<2)
301 #define AAC_STATE_AIF_SLEEPER (1<<3)
302 struct FsaRevision aac_revision;
304 /* controller hardware interface */
306 #define AAC_HWIF_I960RX 0
307 #define AAC_HWIF_STRONGARM 1
308 #define AAC_HWIF_FALCON 2
309 #define AAC_HWIF_UNKNOWN -1
310 bus_dma_tag_t aac_common_dmat; /* common structure
312 bus_dmamap_t aac_common_dmamap; /* common structure
314 struct aac_common *aac_common;
315 u_int32_t aac_common_busaddr;
316 struct aac_interface aac_if;
318 /* command/fib resources */
319 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */
320 struct aac_fib *aac_fibs;
321 bus_dmamap_t aac_fibmap;
322 u_int32_t aac_fibphys;
323 struct aac_command aac_command[AAC_FIB_COUNT];
325 /* command management */
326 TAILQ_HEAD(,aac_command) aac_free; /* command structures
327 * available for reuse */
328 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for
329 * controller resources */
330 TAILQ_HEAD(,aac_command) aac_busy;
331 TAILQ_HEAD(,aac_command) aac_complete; /* commands which have been
332 * returned by the controller */
333 struct bio_queue_head aac_bioq;
334 struct aac_queue_table *aac_queues;
335 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT];
337 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */
339 /* connected containters */
340 struct aac_container_tq aac_container_tqh;
341 aac_lock_t aac_container_lock;
343 /* Protect the sync fib */
344 #define AAC_SYNC_LOCK_FORCE (1 << 0)
345 aac_lock_t aac_sync_lock;
347 /* delayed activity infrastructure */
348 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
349 struct task aac_task_complete; /* deferred-completion
352 struct intr_config_hook aac_ich;
354 /* management interface */
356 aac_lock_t aac_aifq_lock;
357 struct aac_aif_command aac_aifq[AAC_AIFQ_LENGTH];
360 struct selinfo rcv_select;
361 struct thread *aifthread;
363 #define AAC_AIFFLAGS_RUNNING (1 << 0)
364 #define AAC_AIFFLAGS_PENDING (1 << 1)
365 #define AAC_AIFFLAGS_EXIT (1 << 2)
366 #define AAC_AIFFLAGS_EXITED (1 << 3)
368 #define AAC_FLAGS_PERC2QC (1 << 0)
369 #define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */
370 #define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */
371 #define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */
372 #define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem
374 #define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */
375 #define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */
377 u_int32_t supported_options;
378 u_int32_t scsi_method_id;
385 extern void aac_free(struct aac_softc *sc);
386 extern int aac_attach(struct aac_softc *sc);
387 extern int aac_detach(device_t dev);
388 extern int aac_shutdown(device_t dev);
389 extern int aac_suspend(device_t dev);
390 extern int aac_resume(device_t dev);
391 extern void aac_intr(void *arg);
392 extern devclass_t aac_devclass;
393 extern void aac_submit_bio(struct bio *bp);
394 extern void aac_biodone(struct bio *bp);
395 extern int aac_dump_enqueue(struct aac_disk *ad, u_int32_t lba,
396 void *data, int nblks);
397 extern void aac_dump_complete(struct aac_softc *sc);
398 extern void aac_startio(struct aac_softc *sc);
399 extern int aac_alloc_command(struct aac_softc *sc,
400 struct aac_command **cmp);
401 extern void aac_release_command(struct aac_command *cm);
402 extern int aac_alloc_sync_fib(struct aac_softc *sc,
403 struct aac_fib **fib, int flags);
404 extern void aac_release_sync_fib(struct aac_softc *sc);
405 extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command,
406 u_int32_t xferstate, struct aac_fib *fib,
411 * 0 - quiet, only emit warnings
412 * 1 - noisy, emit major function points and things done
413 * 2 - extremely noisy, emit trace items in loops, etc.
416 # define debug(level, fmt, args...) \
418 if (level <=AAC_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \
420 # define debug_called(level) \
422 if (level <= AAC_DEBUG) printf(__func__ ": called\n"); \
425 extern void aac_print_queues(struct aac_softc *sc);
426 extern void aac_panic(struct aac_softc *sc, char *reason);
427 extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib,
429 extern void aac_print_aif(struct aac_softc *sc,
430 struct aac_aif_command *aif);
432 # define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__)
435 # define debug(level, fmt, args...)
436 # define debug_called(level)
438 # define aac_print_queues(sc)
439 # define aac_panic(sc, reason)
441 # define AAC_PRINT_FIB(sc, fib)
442 # define aac_print_aif(sc, aac_aif_command)
445 struct aac_code_lookup {
451 * Queue primitives for driver queues.
453 #define AACQ_ADD(sc, qname) \
455 struct aac_qstat *qs; \
457 qs = &(sc)->aac_qstat[qname]; \
460 if (qs->q_length > qs->q_max) \
461 qs->q_max = qs->q_length; \
464 #define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length--
465 #define AACQ_INIT(sc, qname) \
467 sc->aac_qstat[qname].q_length = 0; \
468 sc->aac_qstat[qname].q_max = 0; \
472 #define AACQ_COMMAND_QUEUE(name, index) \
473 static __inline void \
474 aac_initq_ ## name (struct aac_softc *sc) \
476 TAILQ_INIT(&sc->aac_ ## name); \
477 AACQ_INIT(sc, index); \
479 static __inline void \
480 aac_enqueue_ ## name (struct aac_command *cm) \
483 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \
484 printf("command %p is on another queue, flags = %#x\n", \
486 panic("command is on another queue"); \
488 TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \
489 cm->cm_flags |= AAC_ON_ ## index; \
490 AACQ_ADD(cm->cm_sc, index); \
493 static __inline void \
494 aac_requeue_ ## name (struct aac_command *cm) \
497 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \
498 printf("command %p is on another queue, flags = %#x\n", \
500 panic("command is on another queue"); \
502 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \
503 cm->cm_flags |= AAC_ON_ ## index; \
504 AACQ_ADD(cm->cm_sc, index); \
507 static __inline struct aac_command * \
508 aac_dequeue_ ## name (struct aac_softc *sc) \
510 struct aac_command *cm; \
513 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \
514 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
515 printf("command %p not in queue, flags = %#x, " \
516 "bit = %#x\n", cm, cm->cm_flags, \
518 panic("command not in queue"); \
520 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \
521 cm->cm_flags &= ~AAC_ON_ ## index; \
522 AACQ_REMOVE(sc, index); \
527 static __inline void \
528 aac_remove_ ## name (struct aac_command *cm) \
531 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
532 printf("command %p not in queue, flags = %#x, " \
533 "bit = %#x\n", cm, cm->cm_flags, \
535 panic("command not in queue"); \
537 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \
538 cm->cm_flags &= ~AAC_ON_ ## index; \
539 AACQ_REMOVE(cm->cm_sc, index); \
544 AACQ_COMMAND_QUEUE(free, AACQ_FREE);
545 AACQ_COMMAND_QUEUE(ready, AACQ_READY);
546 AACQ_COMMAND_QUEUE(busy, AACQ_BUSY);
547 AACQ_COMMAND_QUEUE(complete, AACQ_COMPLETE);
550 * outstanding bio queue
553 aac_initq_bio(struct aac_softc *sc)
555 bioq_init(&sc->aac_bioq);
556 AACQ_INIT(sc, AACQ_BIO);
560 aac_enqueue_bio(struct aac_softc *sc, struct bio *bp)
563 bioq_insert_tail(&sc->aac_bioq, bp);
564 AACQ_ADD(sc, AACQ_BIO);
568 static __inline struct bio *
569 aac_dequeue_bio(struct aac_softc *sc)
574 if ((bp = bioq_first(&sc->aac_bioq)) != NULL) {
575 bioq_remove(&sc->aac_bioq, bp);
576 AACQ_REMOVE(sc, AACQ_BIO);
583 aac_print_printf(struct aac_softc *sc)
586 * XXX We have the ability to read the length of the printf string
587 * from out of the mailboxes.
589 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE,
590 sc->aac_common->ac_printf);
591 AAC_QNOTIFY(sc, AAC_DB_PRINTF);