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.8 2005/02/17 13:59:36 joerg Exp $
34 * Driver Parameter Definitions
38 * The firmware interface allows for a 16-bit s/g list length. We limit
39 * ourselves to a reasonable maximum and ensure alignment.
41 #define AAC_MAXSGENTRIES 64 /* max S/G entries, limit 65535 */
44 * We allocate a small set of FIBs for the adapter to use to send us messages.
46 #define AAC_ADAPTER_FIBS 8
49 * FIBs are allocated up-front, and the pool isn't grown. We should allocate
50 * enough here to let us keep the adapter busy without wasting large amounts
51 * of kernel memory. The current interface implementation limits us to 512
52 * FIBs queued for the adapter at any one time.
54 #define AAC_FIB_COUNT 128
57 * The controller reports status events in AIFs. We hang on to a number of
58 * these in order to pass them out to user-space management tools.
60 #define AAC_AIFQ_LENGTH 64
63 * Firmware messages are passed in the printf buffer.
65 #define AAC_PRINTF_BUFSIZE 256
68 * We wait this many seconds for the adapter to come ready if it is still
71 #define AAC_BOOT_TIMEOUT (3 * 60)
74 * Timeout for immediate commands.
76 #define AAC_IMMEDIATE_TIMEOUT 30 /* seconds */
79 * Timeout for normal commands
81 #define AAC_CMD_TIMEOUT 30 /* seconds */
84 * Rate at which we periodically check for timed out commands and kick the
87 #define AAC_PERIODIC_INTERVAL 20 /* seconds */
90 * Character device major numbers.
92 #define AAC_DISK_MAJOR 200
95 * Driver Variable Definitions
98 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
99 # include <sys/taskqueue.h>
103 * Per-container data structure
107 struct aac_mntobj co_mntobj;
110 TAILQ_ENTRY(aac_container) co_link;
120 struct aac_softc *ad_controller;
121 struct aac_container *ad_container;
123 struct devstat ad_stats;
124 struct disklabel ad_label;
126 #define AAC_DISK_OPEN (1<<0)
135 * Per-command control structure.
139 TAILQ_ENTRY(aac_command) cm_link; /* list linkage */
141 struct aac_softc *cm_sc; /* controller that owns us */
143 struct aac_fib *cm_fib; /* FIB associated with this
145 u_int32_t cm_fibphys; /* bus address of the FIB */
146 struct bio *cm_data; /* pointer to data in kernel
148 u_int32_t cm_datalen; /* data length */
149 bus_dmamap_t cm_datamap; /* DMA map for bio data */
150 struct aac_sg_table *cm_sgtable; /* pointer to s/g table in
153 #define AAC_CMD_MAPPED (1<<0) /* command has had its data
155 #define AAC_CMD_DATAIN (1<<1) /* command involves data moving
156 * from controller to host */
157 #define AAC_CMD_DATAOUT (1<<2) /* command involves data moving
158 * from host to controller */
159 #define AAC_CMD_COMPLETED (1<<3) /* command has been completed */
160 #define AAC_CMD_TIMEDOUT (1<<4) /* command taken too long */
161 #define AAC_ON_AACQ_FREE (1<<5)
162 #define AAC_ON_AACQ_READY (1<<6)
163 #define AAC_ON_AACQ_BUSY (1<<7)
164 #define AAC_ON_AACQ_COMPLETE (1<<8)
165 #define AAC_ON_AACQ_MASK ((1<<5)|(1<<6)|(1<<7)|(1<<8))
167 void (* cm_complete)(struct aac_command *cm);
169 time_t cm_timestamp; /* command creation time */
174 * We gather a number of adapter-visible items into a single structure.
176 * The ordering of this strucure may be important; we copy the Linux driver:
180 * Queue headers (Comm Area)
183 * In addition, we add:
187 /* fibs for the controller to send us messages */
188 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS];
190 /* the init structure */
191 struct aac_adapter_init ac_init;
193 /* arena within which the queue structures are kept */
194 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) +
197 /* buffer for text messages from the controller */
198 char ac_printf[AAC_PRINTF_BUFSIZE];
200 /* fib for synchronous commands */
201 struct aac_fib ac_sync_fib;
205 * Interface operations
209 int (*aif_get_fwstatus)(struct aac_softc *sc);
210 void (*aif_qnotify)(struct aac_softc *sc, int qbit);
211 int (*aif_get_istatus)(struct aac_softc *sc);
212 void (*aif_clr_istatus)(struct aac_softc *sc, int mask);
213 void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command,
214 u_int32_t arg0, u_int32_t arg1,
215 u_int32_t arg2, u_int32_t arg3);
216 int (*aif_get_mailbox)(struct aac_softc *sc, int mb);
217 void (*aif_set_interrupts)(struct aac_softc *sc, int enable);
219 extern struct aac_interface aac_rx_interface;
220 extern struct aac_interface aac_sa_interface;
221 extern struct aac_interface aac_fa_interface;
223 #define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc)))
224 #define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit)))
225 #define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc)))
226 #define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \
228 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \
229 ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \
231 #define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \
233 #define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
235 #define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
238 #define AAC_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag, \
239 sc->aac_bhandle, reg, val)
240 #define AAC_GETREG4(sc, reg) bus_space_read_4 (sc->aac_btag, \
241 sc->aac_bhandle, reg)
242 #define AAC_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag, \
243 sc->aac_bhandle, reg, val)
244 #define AAC_GETREG2(sc, reg) bus_space_read_2 (sc->aac_btag, \
245 sc->aac_bhandle, reg)
246 #define AAC_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag, \
247 sc->aac_bhandle, reg, val)
248 #define AAC_GETREG1(sc, reg) bus_space_read_1 (sc->aac_btag, \
249 sc->aac_bhandle, reg)
251 TAILQ_HEAD(aac_container_tq, aac_container);
253 /* Define the OS version specific locks */
254 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
255 #include <sys/lock.h>
256 #include <sys/mutex.h>
257 typedef struct mtx aac_lock_t;
258 #define AAC_LOCK_INIT(l, s) mtx_init(l, s, MTX_DEF)
259 #define AAC_LOCK_ACQUIRE(l) mtx_lock(l)
260 #define AAC_LOCK_RELEASE(l) mtx_unlock(l)
262 typedef struct lwkt_rwlock aac_lock_t;
263 #define AAC_LOCK_INIT(l, s) lwkt_rwlock_init(l)
264 #define AAC_LOCK_ACQUIRE(l) lwkt_exlock(l, "aac")
265 #define AAC_LOCK_RELEASE(l) lwkt_exunlock(l)
268 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
269 #include <sys/selinfo.h>
271 #include <sys/select.h>
275 * Per-controller structure.
279 /* bus connections */
281 struct callout aac_watchdog;
282 struct resource *aac_regs_resource; /* register interface
284 int aac_regs_rid; /* resource ID */
285 bus_space_handle_t aac_bhandle; /* bus space handle */
286 bus_space_tag_t aac_btag; /* bus space tag */
287 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */
288 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command
290 struct resource *aac_irq; /* interrupt */
292 void *aac_intr; /* interrupt handle */
294 /* controller features, limits and status */
296 #define AAC_STATE_SUSPEND (1<<0)
297 #define AAC_STATE_OPEN (1<<1)
298 #define AAC_STATE_INTERRUPTS_ON (1<<2)
299 #define AAC_STATE_AIF_SLEEPER (1<<3)
300 struct FsaRevision aac_revision;
302 /* controller hardware interface */
304 #define AAC_HWIF_I960RX 0
305 #define AAC_HWIF_STRONGARM 1
306 #define AAC_HWIF_FALCON 2
307 #define AAC_HWIF_UNKNOWN -1
308 bus_dma_tag_t aac_common_dmat; /* common structure
310 bus_dmamap_t aac_common_dmamap; /* common structure
312 struct aac_common *aac_common;
313 u_int32_t aac_common_busaddr;
314 struct aac_interface aac_if;
316 /* command/fib resources */
317 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */
318 struct aac_fib *aac_fibs;
319 bus_dmamap_t aac_fibmap;
320 u_int32_t aac_fibphys;
321 struct aac_command aac_command[AAC_FIB_COUNT];
323 /* command management */
324 TAILQ_HEAD(,aac_command) aac_free; /* command structures
325 * available for reuse */
326 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for
327 * controller resources */
328 TAILQ_HEAD(,aac_command) aac_busy;
329 TAILQ_HEAD(,aac_command) aac_complete; /* commands which have been
330 * returned by the controller */
331 struct bio_queue_head aac_bioq;
332 struct aac_queue_table *aac_queues;
333 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT];
335 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */
337 /* connected containters */
338 struct aac_container_tq aac_container_tqh;
339 aac_lock_t aac_container_lock;
341 /* Protect the sync fib */
342 #define AAC_SYNC_LOCK_FORCE (1 << 0)
343 aac_lock_t aac_sync_lock;
345 /* delayed activity infrastructure */
346 #if defined(__FreeBSD__) && __FreeBSD_version >= 500005
347 struct task aac_task_complete; /* deferred-completion
350 struct intr_config_hook aac_ich;
352 /* management interface */
354 aac_lock_t aac_aifq_lock;
355 struct aac_aif_command aac_aifq[AAC_AIFQ_LENGTH];
358 struct selinfo rcv_select;
359 struct thread *aifthread;
361 #define AAC_AIFFLAGS_RUNNING (1 << 0)
362 #define AAC_AIFFLAGS_PENDING (1 << 1)
363 #define AAC_AIFFLAGS_EXIT (1 << 2)
364 #define AAC_AIFFLAGS_EXITED (1 << 3)
366 #define AAC_FLAGS_PERC2QC (1 << 0)
367 #define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */
368 #define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */
369 #define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */
370 #define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem
372 #define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */
373 #define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */
375 u_int32_t supported_options;
376 u_int32_t scsi_method_id;
383 extern void aac_free(struct aac_softc *sc);
384 extern int aac_attach(struct aac_softc *sc);
385 extern int aac_detach(device_t dev);
386 extern int aac_shutdown(device_t dev);
387 extern int aac_suspend(device_t dev);
388 extern int aac_resume(device_t dev);
389 extern void aac_intr(void *arg);
390 extern devclass_t aac_devclass;
391 extern void aac_submit_bio(struct bio *bp);
392 extern void aac_biodone(struct bio *bp);
393 extern int aac_dump_enqueue(struct aac_disk *ad, u_int32_t lba,
394 void *data, int nblks);
395 extern void aac_dump_complete(struct aac_softc *sc);
396 extern void aac_startio(struct aac_softc *sc);
397 extern int aac_alloc_command(struct aac_softc *sc,
398 struct aac_command **cmp);
399 extern void aac_release_command(struct aac_command *cm);
400 extern int aac_alloc_sync_fib(struct aac_softc *sc,
401 struct aac_fib **fib, int flags);
402 extern void aac_release_sync_fib(struct aac_softc *sc);
403 extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command,
404 u_int32_t xferstate, struct aac_fib *fib,
409 * 0 - quiet, only emit warnings
410 * 1 - noisy, emit major function points and things done
411 * 2 - extremely noisy, emit trace items in loops, etc.
414 # define debug(level, fmt, args...) \
416 if (level <=AAC_DEBUG) printf("%s: " fmt "\n", __func__ , ##args); \
418 # define debug_called(level) \
420 if (level <= AAC_DEBUG) printf(__func__ ": called\n"); \
423 extern void aac_print_queues(struct aac_softc *sc);
424 extern void aac_panic(struct aac_softc *sc, char *reason);
425 extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib,
427 extern void aac_print_aif(struct aac_softc *sc,
428 struct aac_aif_command *aif);
430 # define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__)
433 # define debug(level, fmt, args...)
434 # define debug_called(level)
436 # define aac_print_queues(sc)
437 # define aac_panic(sc, reason)
439 # define AAC_PRINT_FIB(sc, fib)
440 # define aac_print_aif(sc, aac_aif_command)
443 struct aac_code_lookup {
449 * Queue primitives for driver queues.
451 #define AACQ_ADD(sc, qname) \
453 struct aac_qstat *qs; \
455 qs = &(sc)->aac_qstat[qname]; \
458 if (qs->q_length > qs->q_max) \
459 qs->q_max = qs->q_length; \
462 #define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length--
463 #define AACQ_INIT(sc, qname) \
465 sc->aac_qstat[qname].q_length = 0; \
466 sc->aac_qstat[qname].q_max = 0; \
470 #define AACQ_COMMAND_QUEUE(name, index) \
471 static __inline void \
472 aac_initq_ ## name (struct aac_softc *sc) \
474 TAILQ_INIT(&sc->aac_ ## name); \
475 AACQ_INIT(sc, index); \
477 static __inline void \
478 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) \
499 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \
500 printf("command %p is on another queue, flags = %#x\n", \
502 panic("command is on another queue"); \
504 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \
505 cm->cm_flags |= AAC_ON_ ## index; \
506 AACQ_ADD(cm->cm_sc, index); \
509 static __inline struct aac_command * \
510 aac_dequeue_ ## name (struct aac_softc *sc) \
512 struct aac_command *cm; \
516 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \
517 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
518 printf("command %p not in queue, flags = %#x, " \
519 "bit = %#x\n", cm, cm->cm_flags, \
521 panic("command not in queue"); \
523 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \
524 cm->cm_flags &= ~AAC_ON_ ## index; \
525 AACQ_REMOVE(sc, index); \
530 static __inline void \
531 aac_remove_ ## name (struct aac_command *cm) \
536 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
537 printf("command %p not in queue, flags = %#x, " \
538 "bit = %#x\n", cm, cm->cm_flags, \
540 panic("command not in queue"); \
542 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \
543 cm->cm_flags &= ~AAC_ON_ ## index; \
544 AACQ_REMOVE(cm->cm_sc, index); \
549 AACQ_COMMAND_QUEUE(free, AACQ_FREE);
550 AACQ_COMMAND_QUEUE(ready, AACQ_READY);
551 AACQ_COMMAND_QUEUE(busy, AACQ_BUSY);
552 AACQ_COMMAND_QUEUE(complete, AACQ_COMPLETE);
555 * outstanding bio queue
558 aac_initq_bio(struct aac_softc *sc)
560 bioq_init(&sc->aac_bioq);
561 AACQ_INIT(sc, AACQ_BIO);
565 aac_enqueue_bio(struct aac_softc *sc, struct bio *bp)
570 bioq_insert_tail(&sc->aac_bioq, bp);
571 AACQ_ADD(sc, AACQ_BIO);
575 static __inline struct bio *
576 aac_dequeue_bio(struct aac_softc *sc)
582 if ((bp = bioq_first(&sc->aac_bioq)) != NULL) {
583 bioq_remove(&sc->aac_bioq, bp);
584 AACQ_REMOVE(sc, AACQ_BIO);
591 aac_print_printf(struct aac_softc *sc)
594 * XXX We have the ability to read the length of the printf string
595 * from out of the mailboxes.
597 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE,
598 sc->aac_common->ac_printf);
599 AAC_QNOTIFY(sc, AAC_DB_PRINTF);