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.60 2010/09/29 14:22:00 emaste Exp $
33 #include <sys/callout.h>
35 #include <sys/taskqueue.h>
37 #include <sys/devicestat.h>
39 #include <sys/eventhandler.h>
41 #define AAC_TYPE_DEVO 1
42 #define AAC_TYPE_ALPHA 2
43 #define AAC_TYPE_BETA 3
44 #define AAC_TYPE_RELEASE 4
46 #define AAC_DRIVER_MAJOR_VERSION 2
47 #define AAC_DRIVER_MINOR_VERSION 1
48 #define AAC_DRIVER_BUGFIX_LEVEL 9
49 #define AAC_DRIVER_TYPE AAC_TYPE_RELEASE
51 #ifndef AAC_DRIVER_BUILD
52 # define AAC_DRIVER_BUILD 1
56 * Driver Parameter Definitions
60 * The firmware interface allows for a 16-bit s/g list length. We limit
61 * ourselves to a reasonable maximum and ensure alignment.
63 #define AAC_MAXSGENTRIES 64 /* max S/G entries, limit 65535 */
66 * We allocate a small set of FIBs for the adapter to use to send us messages.
68 #define AAC_ADAPTER_FIBS 8
71 * The controller reports status events in AIFs. We hang on to a number of
72 * these in order to pass them out to user-space management tools.
74 #define AAC_AIFQ_LENGTH 64
77 * Firmware messages are passed in the kprintf buffer.
79 #define AAC_PRINTF_BUFSIZE 256
82 * We wait this many seconds for the adapter to come ready if it is still
85 #define AAC_BOOT_TIMEOUT (3 * 60)
88 * Timeout for immediate commands.
90 #define AAC_IMMEDIATE_TIMEOUT 30 /* seconds */
93 * Timeout for normal commands
95 #define AAC_CMD_TIMEOUT 120 /* seconds */
98 * Rate at which we periodically check for timed out commands and kick the
101 #define AAC_PERIODIC_INTERVAL 20 /* seconds */
104 * Per-container data structure
108 struct aac_mntobj co_mntobj;
111 TAILQ_ENTRY(aac_container) co_link;
115 * Per-SIM data structure
124 struct aac_softc *aac_sc;
125 struct aac_cam *aac_cam;
126 TAILQ_ENTRY(aac_sim) sim_link;
136 struct aac_softc *ad_controller;
137 struct aac_container *ad_container;
139 struct devstat ad_stats;
141 #define AAC_DISK_OPEN (1<<0)
150 * Per-command control structure.
154 TAILQ_ENTRY(aac_command) cm_link; /* list linkage */
156 struct aac_softc *cm_sc; /* controller that owns us */
158 struct aac_fib *cm_fib; /* FIB associated with this
160 u_int64_t cm_fibphys; /* bus address of the FIB */
161 struct bio *cm_data; /* pointer to data in kernel
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
168 #define AAC_CMD_MAPPED (1<<0) /* command has had its data
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. */
185 void (* cm_complete)(struct aac_command *cm);
187 time_t cm_timestamp; /* command creation time */
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;
200 * We gather a number of adapter-visible items into a single structure.
202 * The ordering of this strucure may be important; we copy the Linux driver:
206 * Queue headers (Comm Area)
209 * In addition, we add:
213 /* fibs for the controller to send us messages */
214 struct aac_fib ac_fibs[AAC_ADAPTER_FIBS];
216 /* the init structure */
217 struct aac_adapter_init ac_init;
219 /* arena within which the queue structures are kept */
220 u_int8_t ac_qbuf[sizeof(struct aac_queue_table) +
223 /* buffer for text messages from the controller */
224 char ac_printf[AAC_PRINTF_BUFSIZE];
226 /* fib for synchronous commands */
227 struct aac_fib ac_sync_fib;
231 * Interface operations
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);
248 extern struct aac_interface aac_rx_interface;
249 extern struct aac_interface aac_sa_interface;
250 extern struct aac_interface aac_fa_interface;
251 extern struct aac_interface aac_rkt_interface;
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), \
258 #define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \
259 ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \
261 #define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \
263 #define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
265 #define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \
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)))
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)
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)
297 /* fib context (IOCTL) */
298 struct aac_fib_context {
302 struct aac_fib_context *next, *prev;
306 * Per-controller structure.
310 /* bus connections */
312 struct resource *aac_regs_res0, *aac_regs_res1; /* reg. if. window */
313 int aac_regs_rid0, aac_regs_rid1; /* resource ID */
314 bus_space_handle_t aac_bhandle0, aac_bhandle1; /* bus space handle */
315 bus_space_tag_t aac_btag0, aac_btag1; /* bus space tag */
316 bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */
317 bus_dma_tag_t aac_buffer_dmat; /* data buffer/command
319 struct resource *aac_irq; /* interrupt */
321 void *aac_intr; /* interrupt handle */
324 /* controller features, limits and status */
326 #define AAC_STATE_SUSPEND (1<<0)
327 #define AAC_STATE_UNUSED0 (1<<1)
328 #define AAC_STATE_INTERRUPTS_ON (1<<2)
329 #define AAC_STATE_AIF_SLEEPER (1<<3)
330 struct FsaRevision aac_revision;
332 /* controller hardware interface */
334 #define AAC_HWIF_I960RX 0
335 #define AAC_HWIF_STRONGARM 1
336 #define AAC_HWIF_RKT 3
337 #define AAC_HWIF_NARK 4
338 #define AAC_HWIF_UNKNOWN -1
339 bus_dma_tag_t aac_common_dmat; /* common structure
341 bus_dmamap_t aac_common_dmamap; /* common structure
343 struct aac_common *aac_common;
344 u_int32_t aac_common_busaddr;
345 struct aac_interface aac_if;
347 /* command/fib resources */
348 bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */
349 TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh;
351 struct aac_command *aac_commands;
353 /* command management */
354 TAILQ_HEAD(,aac_command) aac_free; /* command structures
355 * available for reuse */
356 TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for
357 * controller resources */
358 TAILQ_HEAD(,aac_command) aac_busy;
359 TAILQ_HEAD(,aac_event) aac_ev_cmfree;
360 struct bio_queue_head aac_bioq;
361 struct aac_queue_table *aac_queues;
362 struct aac_queue_entry *aac_qentries[AAC_QUEUE_COUNT];
364 struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */
366 /* connected containters */
367 TAILQ_HEAD(,aac_container) aac_container_tqh;
368 struct lock aac_container_lock;
371 * The general I/O lock. This protects the sync fib, the lists, the
372 * queues, and the registers.
374 struct lock aac_io_lock;
376 /* delayed activity infrastructure */
377 struct task aac_task_complete; /* deferred-completion
379 struct intr_config_hook aac_ich;
381 /* management interface */
382 struct cdev *aac_dev_t;
383 struct lock aac_aifq_lock;
384 struct aac_fib aac_aifq[AAC_AIFQ_LENGTH];
387 struct aac_fib_context *fibctx;
388 struct kqinfo rcv_kq;
389 struct thread *aifthread;
391 #define AAC_AIFFLAGS_RUNNING (1 << 0)
392 #define AAC_AIFFLAGS_AIF (1 << 1)
393 #define AAC_AIFFLAGS_EXIT (1 << 2)
394 #define AAC_AIFFLAGS_EXITED (1 << 3)
395 #define AAC_AIFFLAGS_PRINTF (1 << 4)
396 #define AAC_AIFFLAGS_ALLOCFIBS (1 << 5)
397 #define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \
398 AAC_AIFFLAGS_ALLOCFIBS)
400 #define AAC_FLAGS_PERC2QC (1 << 0)
401 #define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */
402 #define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */
403 #define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */
404 #define AAC_FLAGS_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */
405 #define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem
407 #define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */
408 #define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */
409 #define AAC_FLAGS_BROKEN_MEMMAP (1 << 8) /* Broken HostPhysMemPages */
410 #define AAC_FLAGS_SLAVE (1 << 9)
411 #define AAC_FLAGS_MASTER (1 << 10)
412 #define AAC_FLAGS_NEW_COMM (1 << 11) /* New comm. interface supported */
413 #define AAC_FLAGS_RAW_IO (1 << 12) /* Raw I/O interface */
414 #define AAC_FLAGS_ARRAY_64BIT (1 << 13) /* 64-bit array size */
415 #define AAC_FLAGS_LBA_64BIT (1 << 14) /* 64-bit LBA support */
417 u_int32_t supported_options;
418 u_int32_t scsi_method_id;
419 TAILQ_HEAD(,aac_sim) aac_sim_tqh;
421 struct callout aac_daemontime; /* clock daemon callout */
423 u_int32_t aac_max_fibs; /* max. FIB count */
424 u_int32_t aac_max_fibs_alloc; /* max. alloc. per alloc_commands() */
425 u_int32_t aac_max_fib_size; /* max. FIB size */
426 u_int32_t aac_sg_tablesize; /* max. sg count from host */
427 u_int32_t aac_max_sectors; /* max. I/O size from host (blocks) */
428 #define AAC_CAM_TARGET_WILDCARD ~0
429 void (*cam_rescan_cb)(struct aac_softc *, uint32_t,
434 * Event callback mechanism for the driver
436 #define AAC_EVENT_NONE 0x00
437 #define AAC_EVENT_CMFREE 0x01
438 #define AAC_EVENT_MASK 0xff
439 #define AAC_EVENT_REPEAT 0x100
441 typedef void aac_event_cb_t(struct aac_softc *sc, struct aac_event *event,
444 TAILQ_ENTRY(aac_event) ev_links;
446 aac_event_cb_t *ev_callback;
453 extern void aac_free(struct aac_softc *sc);
454 extern int aac_attach(struct aac_softc *sc);
455 extern int aac_detach(device_t dev);
456 extern int aac_shutdown(device_t dev);
457 extern int aac_suspend(device_t dev);
458 extern int aac_resume(device_t dev);
459 extern void aac_new_intr(void *arg);
460 extern void aac_filter(void *arg);
461 extern void aac_submit_bio(struct aac_disk *ad, struct bio *bio);
462 extern void aac_biodone(struct bio *bio, const char *code);
463 extern void aac_startio(struct aac_softc *sc);
464 extern int aac_alloc_command(struct aac_softc *sc,
465 struct aac_command **cmp);
466 extern void aac_release_command(struct aac_command *cm);
467 extern int aac_sync_fib(struct aac_softc *sc, u_int32_t command,
468 u_int32_t xferstate, struct aac_fib *fib,
470 extern void aac_add_event(struct aac_softc *sc, struct aac_event
474 extern int aac_debug_enable;
475 # define fwprintf(sc, flags, fmt, args...) \
477 if (!aac_debug_enable) \
480 device_printf(((struct aac_softc *)sc)->aac_dev, \
481 "%s: " fmt "\n", __func__, ##args); \
483 kprintf("%s: " fmt "\n", __func__, ##args); \
486 extern void aac_print_queues(struct aac_softc *sc);
487 extern void aac_panic(struct aac_softc *sc, char *reason);
488 extern void aac_print_fib(struct aac_softc *sc, struct aac_fib *fib,
490 extern void aac_print_aif(struct aac_softc *sc,
491 struct aac_aif_command *aif);
493 #define AAC_PRINT_FIB(sc, fib) aac_print_fib(sc, fib, __func__)
496 # define fwprintf(sc, flags, fmt, args...)
498 # define aac_print_queues(sc)
499 # define aac_panic(sc, reason)
501 # define AAC_PRINT_FIB(sc, fib)
502 # define aac_print_aif(sc, aac_aif_command)
505 struct aac_code_lookup {
511 * Queue primitives for driver queues.
513 #define AACQ_ADD(sc, qname) \
515 struct aac_qstat *qs; \
517 qs = &(sc)->aac_qstat[qname]; \
520 if (qs->q_length > qs->q_max) \
521 qs->q_max = qs->q_length; \
524 #define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length--
525 #define AACQ_INIT(sc, qname) \
527 sc->aac_qstat[qname].q_length = 0; \
528 sc->aac_qstat[qname].q_max = 0; \
532 #define AACQ_COMMAND_QUEUE(name, index) \
533 static __inline void \
534 aac_initq_ ## name (struct aac_softc *sc) \
536 TAILQ_INIT(&sc->aac_ ## name); \
537 AACQ_INIT(sc, index); \
539 static __inline void \
540 aac_enqueue_ ## name (struct aac_command *cm) \
542 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \
543 kprintf("command %p is on another queue, flags = %#x\n", \
545 panic("command is on another queue"); \
547 TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \
548 cm->cm_flags |= AAC_ON_ ## index; \
549 AACQ_ADD(cm->cm_sc, index); \
551 static __inline void \
552 aac_requeue_ ## name (struct aac_command *cm) \
554 if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \
555 kprintf("command %p is on another queue, flags = %#x\n", \
557 panic("command is on another queue"); \
559 TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \
560 cm->cm_flags |= AAC_ON_ ## index; \
561 AACQ_ADD(cm->cm_sc, index); \
563 static __inline struct aac_command * \
564 aac_dequeue_ ## name (struct aac_softc *sc) \
566 struct aac_command *cm; \
568 if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \
569 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
570 kprintf("command %p not in queue, flags = %#x, " \
571 "bit = %#x\n", cm, cm->cm_flags, \
573 panic("command not in queue"); \
575 TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \
576 cm->cm_flags &= ~AAC_ON_ ## index; \
577 AACQ_REMOVE(sc, index); \
581 static __inline void \
582 aac_remove_ ## name (struct aac_command *cm) \
584 if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \
585 kprintf("command %p not in queue, flags = %#x, " \
586 "bit = %#x\n", cm, cm->cm_flags, \
588 panic("command not in queue"); \
590 TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \
591 cm->cm_flags &= ~AAC_ON_ ## index; \
592 AACQ_REMOVE(cm->cm_sc, index); \
596 AACQ_COMMAND_QUEUE(free, AACQ_FREE);
597 AACQ_COMMAND_QUEUE(ready, AACQ_READY);
598 AACQ_COMMAND_QUEUE(busy, AACQ_BUSY);
601 * outstanding bio queue
604 aac_initq_bio(struct aac_softc *sc)
606 bioq_init(&sc->aac_bioq);
607 AACQ_INIT(sc, AACQ_BIO);
611 aac_enqueue_bio(struct aac_softc *sc, struct bio *bio)
613 bioq_insert_tail(&sc->aac_bioq, bio);
614 AACQ_ADD(sc, AACQ_BIO);
617 static __inline struct bio *
618 aac_dequeue_bio(struct aac_softc *sc)
622 if ((bio = bioq_first(&sc->aac_bioq)) != NULL) {
623 bioq_remove(&sc->aac_bioq, bio);
624 AACQ_REMOVE(sc, AACQ_BIO);
630 aac_print_printf(struct aac_softc *sc)
633 * XXX We have the ability to read the length of the kprintf string
634 * from out of the mailboxes.
636 device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE,
637 sc->aac_common->ac_printf);
638 sc->aac_common->ac_printf[0] = 0;
639 AAC_QNOTIFY(sc, AAC_DB_PRINTF);
643 aac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib)
646 KKASSERT(lockstatus(&sc->aac_io_lock, curthread) != 0);
647 *fib = &sc->aac_common->ac_sync_fib;
652 aac_release_sync_fib(struct aac_softc *sc)
655 KKASSERT(lockstatus(&sc->aac_io_lock, curthread) != 0);