aacraid_var.h revision 250963
1250963Sachim/*- 2250963Sachim * Copyright (c) 2000 Michael Smith 3250963Sachim * Copyright (c) 2001 Scott Long 4250963Sachim * Copyright (c) 2000 BSDi 5250963Sachim * Copyright (c) 2001-2010 Adaptec, Inc. 6250963Sachim * Copyright (c) 2010-2012 PMC-Sierra, Inc. 7250963Sachim * All rights reserved. 8250963Sachim * 9250963Sachim * Redistribution and use in source and binary forms, with or without 10250963Sachim * modification, are permitted provided that the following conditions 11250963Sachim * are met: 12250963Sachim * 1. Redistributions of source code must retain the above copyright 13250963Sachim * notice, this list of conditions and the following disclaimer. 14250963Sachim * 2. Redistributions in binary form must reproduce the above copyright 15250963Sachim * notice, this list of conditions and the following disclaimer in the 16250963Sachim * documentation and/or other materials provided with the distribution. 17250963Sachim * 18250963Sachim * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19250963Sachim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20250963Sachim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21250963Sachim * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22250963Sachim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23250963Sachim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24250963Sachim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25250963Sachim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26250963Sachim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27250963Sachim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28250963Sachim * SUCH DAMAGE. 29250963Sachim * 30250963Sachim * $FreeBSD: head/sys/dev/aacraid/aacraid_var.h 250963 2013-05-24 09:22:43Z achim $ 31250963Sachim */ 32250963Sachim 33250963Sachim#include <sys/bio.h> 34250963Sachim#if __FreeBSD_version >= 800000 35250963Sachim#include <sys/callout.h> 36250963Sachim#endif 37250963Sachim#include <sys/lock.h> 38250963Sachim#include <sys/mutex.h> 39250963Sachim#include <sys/taskqueue.h> 40250963Sachim#include <sys/selinfo.h> 41250963Sachim#include <geom/geom_disk.h> 42250963Sachim 43250963Sachim#define AAC_TYPE_DEVO 1 44250963Sachim#define AAC_TYPE_ALPHA 2 45250963Sachim#define AAC_TYPE_BETA 3 46250963Sachim#define AAC_TYPE_RELEASE 4 47250963Sachim 48250963Sachim#define AAC_DRIVER_MAJOR_VERSION 3 49250963Sachim#define AAC_DRIVER_MINOR_VERSION 1 50250963Sachim#define AAC_DRIVER_BUGFIX_LEVEL 1 51250963Sachim#define AAC_DRIVER_TYPE AAC_TYPE_RELEASE 52250963Sachim 53250963Sachim#ifndef AAC_DRIVER_BUILD 54250963Sachim# define AAC_DRIVER_BUILD 1 55250963Sachim#endif 56250963Sachim 57250963Sachim#if __FreeBSD_version <= 601000 58250963Sachim#define bus_get_dma_tag(x) NULL 59250963Sachim#endif 60250963Sachim 61250963Sachim/* **************************** NewBUS interrupt Crock ************************/ 62250963Sachim#if __FreeBSD_version < 700031 63250963Sachim#define aac_bus_setup_intr(d, i, f, U, if, ifa, hp) \ 64250963Sachim bus_setup_intr(d, i, f, if, ifa, hp) 65250963Sachim#else 66250963Sachim#define aac_bus_setup_intr bus_setup_intr 67250963Sachim#endif 68250963Sachim 69250963Sachim/* **************************** NewBUS CAM Support ****************************/ 70250963Sachim#if __FreeBSD_version < 700049 71250963Sachim#define aac_xpt_bus_register(sim, parent, bus) \ 72250963Sachim xpt_bus_register(sim, bus) 73250963Sachim#else 74250963Sachim#define aac_xpt_bus_register xpt_bus_register 75250963Sachim#endif 76250963Sachim 77250963Sachim/**************************** Kernel Thread Support ***************************/ 78250963Sachim#if __FreeBSD_version > 800001 79250963Sachim#define aac_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 80250963Sachim kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 81250963Sachim#define aac_kthread_exit(status) \ 82250963Sachim kproc_exit(status) 83250963Sachim#else 84250963Sachim#define aac_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 85250963Sachim kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 86250963Sachim#define aac_kthread_exit(status) \ 87250963Sachim kthread_exit(status) 88250963Sachim#endif 89250963Sachim 90250963Sachim/* 91250963Sachim * Driver Parameter Definitions 92250963Sachim */ 93250963Sachim 94250963Sachim/* 95250963Sachim * We allocate a small set of FIBs for the adapter to use to send us messages. 96250963Sachim */ 97250963Sachim#define AAC_ADAPTER_FIBS 8 98250963Sachim 99250963Sachim/* 100250963Sachim * The controller reports status events in AIFs. We hang on to a number of 101250963Sachim * these in order to pass them out to user-space management tools. 102250963Sachim */ 103250963Sachim#define AAC_AIFQ_LENGTH 64 104250963Sachim 105250963Sachim/* 106250963Sachim * Firmware messages are passed in the printf buffer. 107250963Sachim */ 108250963Sachim#define AAC_PRINTF_BUFSIZE 256 109250963Sachim 110250963Sachim/* 111250963Sachim * We wait this many seconds for the adapter to come ready if it is still 112250963Sachim * booting 113250963Sachim */ 114250963Sachim#define AAC_BOOT_TIMEOUT (3 * 60) 115250963Sachim 116250963Sachim/* 117250963Sachim * Timeout for immediate commands. 118250963Sachim */ 119250963Sachim#define AAC_IMMEDIATE_TIMEOUT 30 /* seconds */ 120250963Sachim 121250963Sachim/* 122250963Sachim * Timeout for normal commands 123250963Sachim */ 124250963Sachim#define AAC_CMD_TIMEOUT 120 /* seconds */ 125250963Sachim 126250963Sachim/* 127250963Sachim * Rate at which we periodically check for timed out commands and kick the 128250963Sachim * controller. 129250963Sachim */ 130250963Sachim#define AAC_PERIODIC_INTERVAL 20 /* seconds */ 131250963Sachim 132250963Sachim#define PASSTHROUGH_BUS 0 133250963Sachim#define CONTAINER_BUS 1 134250963Sachim/* 135250963Sachim * Per-container data structure 136250963Sachim */ 137250963Sachimstruct aac_container 138250963Sachim{ 139250963Sachim struct aac_mntobj co_mntobj; 140250963Sachim int co_found; 141250963Sachim u_int32_t co_uid; 142250963Sachim TAILQ_ENTRY(aac_container) co_link; 143250963Sachim}; 144250963Sachim 145250963Sachim/* 146250963Sachim * Per-SIM data structure 147250963Sachim */ 148250963Sachimstruct aac_cam; 149250963Sachimstruct aac_sim 150250963Sachim{ 151250963Sachim device_t sim_dev; 152250963Sachim int TargetsPerBus; 153250963Sachim int BusNumber; 154250963Sachim int BusType; 155250963Sachim int InitiatorBusId; 156250963Sachim struct aac_softc *aac_sc; 157250963Sachim struct aac_cam *aac_cam; 158250963Sachim TAILQ_ENTRY(aac_sim) sim_link; 159250963Sachim}; 160250963Sachim 161250963Sachim/* 162250963Sachim * Per-disk structure 163250963Sachim */ 164250963Sachimstruct aac_disk 165250963Sachim{ 166250963Sachim device_t ad_dev; 167250963Sachim struct aac_softc *ad_controller; 168250963Sachim struct aac_container *ad_container; 169250963Sachim struct disk *ad_disk; 170250963Sachim int ad_flags; 171250963Sachim#define AAC_DISK_OPEN (1<<0) 172250963Sachim int ad_cylinders; 173250963Sachim int ad_heads; 174250963Sachim int ad_sectors; 175250963Sachim u_int64_t ad_size; 176250963Sachim int unit; 177250963Sachim}; 178250963Sachim 179250963Sachim/* 180250963Sachim * Per-command control structure. 181250963Sachim */ 182250963Sachimstruct aac_command 183250963Sachim{ 184250963Sachim TAILQ_ENTRY(aac_command) cm_link; /* list linkage */ 185250963Sachim 186250963Sachim struct aac_softc *cm_sc; /* controller that owns us */ 187250963Sachim 188250963Sachim struct aac_fib *cm_fib; /* FIB associated with this 189250963Sachim * command */ 190250963Sachim u_int64_t cm_fibphys; /* bus address of the FIB */ 191250963Sachim struct bio *cm_data; /* pointer to data in kernel 192250963Sachim * space */ 193250963Sachim u_int32_t cm_datalen; /* data length */ 194250963Sachim bus_dmamap_t cm_datamap; /* DMA map for bio data */ 195250963Sachim struct aac_sg_table *cm_sgtable; /* pointer to s/g table in 196250963Sachim * command */ 197250963Sachim int cm_flags; 198250963Sachim#define AAC_CMD_MAPPED (1<<0) /* command has had its data 199250963Sachim * mapped */ 200250963Sachim#define AAC_CMD_DATAIN (1<<1) /* command involves data moving 201250963Sachim * from controller to host */ 202250963Sachim#define AAC_CMD_DATAOUT (1<<2) /* command involves data moving 203250963Sachim * from host to controller */ 204250963Sachim#define AAC_CMD_COMPLETED (1<<3) /* command has been completed */ 205250963Sachim#define AAC_CMD_TIMEDOUT (1<<4) /* command taken too long */ 206250963Sachim#define AAC_ON_AACQ_FREE (1<<5) 207250963Sachim#define AAC_ON_AACQ_READY (1<<6) 208250963Sachim#define AAC_ON_AACQ_BUSY (1<<7) 209250963Sachim#define AAC_ON_AACQ_AIF (1<<8) 210250963Sachim#define AAC_ON_AACQ_NORM (1<<10) 211250963Sachim#define AAC_ON_AACQ_MASK ((1<<5)|(1<<6)|(1<<7)|(1<<8)|(1<<10)) 212250963Sachim#define AAC_CMD_RESET (1<<9) 213250963Sachim#define AAC_CMD_FASTRESP (1<<11) 214250963Sachim#define AAC_CMD_WAIT (1<<12) 215250963Sachim 216250963Sachim void (* cm_complete)(struct aac_command *cm); 217250963Sachim union ccb *cm_ccb; 218250963Sachim time_t cm_timestamp; /* command creation time */ 219250963Sachim int cm_index; 220250963Sachim bus_dma_tag_t cm_passthr_dmat; /* passthrough buffer/command 221250963Sachim * DMA tag */ 222250963Sachim}; 223250963Sachim 224250963Sachimstruct aac_fibmap { 225250963Sachim TAILQ_ENTRY(aac_fibmap) fm_link; /* list linkage */ 226250963Sachim struct aac_fib *aac_fibs; 227250963Sachim bus_dmamap_t aac_fibmap; 228250963Sachim struct aac_command *aac_commands; 229250963Sachim}; 230250963Sachim 231250963Sachim/* 232250963Sachim * We gather a number of adapter-visible items into a single structure. 233250963Sachim * 234250963Sachim * The ordering of this strucure may be important; we copy the Linux driver: 235250963Sachim * 236250963Sachim * Adapter FIBs 237250963Sachim * Init struct 238250963Sachim * Queue headers (Comm Area) 239250963Sachim * Printf buffer 240250963Sachim * 241250963Sachim * In addition, we add: 242250963Sachim * Sync Fib 243250963Sachim */ 244250963Sachimstruct aac_common { 245250963Sachim /* fibs for the controller to send us messages */ 246250963Sachim struct aac_fib ac_fibs[AAC_ADAPTER_FIBS]; 247250963Sachim 248250963Sachim /* the init structure */ 249250963Sachim struct aac_adapter_init ac_init; 250250963Sachim 251250963Sachim /* buffer for text messages from the controller */ 252250963Sachim char ac_printf[AAC_PRINTF_BUFSIZE]; 253250963Sachim 254250963Sachim /* fib for synchronous commands */ 255250963Sachim struct aac_fib ac_sync_fib; 256250963Sachim 257250963Sachim /* response buffer for SRC (new comm. type1) - must be last element */ 258250963Sachim u_int32_t ac_host_rrq[0]; 259250963Sachim}; 260250963Sachim 261250963Sachim/* 262250963Sachim * Interface operations 263250963Sachim */ 264250963Sachimstruct aac_interface 265250963Sachim{ 266250963Sachim int (*aif_get_fwstatus)(struct aac_softc *sc); 267250963Sachim void (*aif_qnotify)(struct aac_softc *sc, int qbit); 268250963Sachim int (*aif_get_istatus)(struct aac_softc *sc); 269250963Sachim void (*aif_clr_istatus)(struct aac_softc *sc, int mask); 270250963Sachim void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command, 271250963Sachim u_int32_t arg0, u_int32_t arg1, 272250963Sachim u_int32_t arg2, u_int32_t arg3); 273250963Sachim int (*aif_get_mailbox)(struct aac_softc *sc, int mb); 274250963Sachim void (*aif_set_interrupts)(struct aac_softc *sc, int enable); 275250963Sachim int (*aif_send_command)(struct aac_softc *sc, struct aac_command *cm); 276250963Sachim int (*aif_get_outb_queue)(struct aac_softc *sc); 277250963Sachim void (*aif_set_outb_queue)(struct aac_softc *sc, int index); 278250963Sachim}; 279250963Sachimextern struct aac_interface aacraid_src_interface; 280250963Sachimextern struct aac_interface aacraid_srcv_interface; 281250963Sachim 282250963Sachim#define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc))) 283250963Sachim#define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit))) 284250963Sachim#define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc))) 285250963Sachim#define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \ 286250963Sachim (mask))) 287250963Sachim#define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \ 288250963Sachim ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \ 289250963Sachim (arg3))) 290250963Sachim#define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \ 291250963Sachim (mb))) 292250963Sachim#define AAC_MASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 293250963Sachim 0)) 294250963Sachim#define AAC_UNMASK_INTERRUPTS(sc) ((sc)->aac_if.aif_set_interrupts((sc), \ 295250963Sachim 1)) 296250963Sachim#define AAC_SEND_COMMAND(sc, cm) ((sc)->aac_if.aif_send_command((sc), (cm))) 297250963Sachim#define AAC_GET_OUTB_QUEUE(sc) ((sc)->aac_if.aif_get_outb_queue((sc))) 298250963Sachim#define AAC_SET_OUTB_QUEUE(sc, idx) ((sc)->aac_if.aif_set_outb_queue((sc), (idx))) 299250963Sachim 300250963Sachim#define AAC_MEM0_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag0, \ 301250963Sachim sc->aac_bhandle0, reg, val) 302250963Sachim#define AAC_MEM0_GETREG4(sc, reg) bus_space_read_4(sc->aac_btag0, \ 303250963Sachim sc->aac_bhandle0, reg) 304250963Sachim#define AAC_MEM0_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag0, \ 305250963Sachim sc->aac_bhandle0, reg, val) 306250963Sachim#define AAC_MEM0_GETREG2(sc, reg) bus_space_read_2(sc->aac_btag0, \ 307250963Sachim sc->aac_bhandle0, reg) 308250963Sachim#define AAC_MEM0_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag0, \ 309250963Sachim sc->aac_bhandle0, reg, val) 310250963Sachim#define AAC_MEM0_GETREG1(sc, reg) bus_space_read_1(sc->aac_btag0, \ 311250963Sachim sc->aac_bhandle0, reg) 312250963Sachim 313250963Sachim#define AAC_MEM1_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag1, \ 314250963Sachim sc->aac_bhandle1, reg, val) 315250963Sachim#define AAC_MEM1_GETREG4(sc, reg) bus_space_read_4(sc->aac_btag1, \ 316250963Sachim sc->aac_bhandle1, reg) 317250963Sachim#define AAC_MEM1_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag1, \ 318250963Sachim sc->aac_bhandle1, reg, val) 319250963Sachim#define AAC_MEM1_GETREG2(sc, reg) bus_space_read_2(sc->aac_btag1, \ 320250963Sachim sc->aac_bhandle1, reg) 321250963Sachim#define AAC_MEM1_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag1, \ 322250963Sachim sc->aac_bhandle1, reg, val) 323250963Sachim#define AAC_MEM1_GETREG1(sc, reg) bus_space_read_1(sc->aac_btag1, \ 324250963Sachim sc->aac_bhandle1, reg) 325250963Sachim 326250963Sachim/* fib context (IOCTL) */ 327250963Sachimstruct aac_fib_context { 328250963Sachim u_int32_t unique; 329250963Sachim int ctx_idx; 330250963Sachim int ctx_wrap; 331250963Sachim struct aac_fib_context *next, *prev; 332250963Sachim}; 333250963Sachim 334250963Sachim/* 335250963Sachim * Per-controller structure. 336250963Sachim */ 337250963Sachimstruct aac_softc 338250963Sachim{ 339250963Sachim /* bus connections */ 340250963Sachim device_t aac_dev; 341250963Sachim struct resource *aac_regs_res0, *aac_regs_res1; /* reg. if. window */ 342250963Sachim int aac_regs_rid0, aac_regs_rid1; /* resource ID */ 343250963Sachim bus_space_handle_t aac_bhandle0, aac_bhandle1; /* bus space handle */ 344250963Sachim bus_space_tag_t aac_btag0, aac_btag1; /* bus space tag */ 345250963Sachim bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */ 346250963Sachim bus_dma_tag_t aac_buffer_dmat; /* data buffer/command 347250963Sachim * DMA tag */ 348250963Sachim struct resource *aac_irq; /* interrupt */ 349250963Sachim int aac_irq_rid; 350250963Sachim void *aac_intr; /* interrupt handle */ 351250963Sachim eventhandler_tag eh; 352250963Sachim#if __FreeBSD_version >= 800000 353250963Sachim struct callout aac_daemontime; /* clock daemon callout */ 354250963Sachim#else 355250963Sachim struct callout_handle timeout_id; /* timeout handle */ 356250963Sachim#endif 357250963Sachim 358250963Sachim /* controller features, limits and status */ 359250963Sachim int aac_state; 360250963Sachim#define AAC_STATE_SUSPEND (1<<0) 361250963Sachim#define AAC_STATE_UNUSED0 (1<<1) 362250963Sachim#define AAC_STATE_INTERRUPTS_ON (1<<2) 363250963Sachim#define AAC_STATE_AIF_SLEEPER (1<<3) 364250963Sachim#define AAC_STATE_RESET (1<<4) 365250963Sachim struct FsaRevision aac_revision; 366250963Sachim 367250963Sachim /* controller hardware interface */ 368250963Sachim int aac_hwif; 369250963Sachim#define AAC_HWIF_SRC 5 370250963Sachim#define AAC_HWIF_SRCV 6 371250963Sachim#define AAC_HWIF_UNKNOWN -1 372250963Sachim bus_dma_tag_t aac_common_dmat; /* common structure 373250963Sachim * DMA tag */ 374250963Sachim bus_dmamap_t aac_common_dmamap; /* common structure 375250963Sachim * DMA map */ 376250963Sachim struct aac_common *aac_common; 377250963Sachim u_int32_t aac_common_busaddr; 378250963Sachim u_int32_t aac_host_rrq_idx; 379250963Sachim struct aac_interface aac_if; 380250963Sachim 381250963Sachim /* command/fib resources */ 382250963Sachim bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */ 383250963Sachim TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh; 384250963Sachim u_int total_fibs; 385250963Sachim struct aac_command *aac_commands; 386250963Sachim 387250963Sachim /* command management */ 388250963Sachim TAILQ_HEAD(,aac_command) aac_free; /* command structures 389250963Sachim * available for reuse */ 390250963Sachim TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for 391250963Sachim * controller resources */ 392250963Sachim TAILQ_HEAD(,aac_command) aac_busy; 393250963Sachim TAILQ_HEAD(,aac_event) aac_ev_cmfree; 394250963Sachim struct bio_queue_head aac_bioq; 395250963Sachim 396250963Sachim struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */ 397250963Sachim 398250963Sachim /* connected containters */ 399250963Sachim TAILQ_HEAD(,aac_container) aac_container_tqh; 400250963Sachim struct mtx aac_container_lock; 401250963Sachim 402250963Sachim /* 403250963Sachim * The general I/O lock. This protects the sync fib, the lists, the 404250963Sachim * queues, and the registers. 405250963Sachim */ 406250963Sachim struct mtx aac_io_lock; 407250963Sachim 408250963Sachim struct intr_config_hook aac_ich; 409250963Sachim 410250963Sachim /* sync. transfer mode */ 411250963Sachim struct aac_command *aac_sync_cm; 412250963Sachim 413250963Sachim /* management interface */ 414250963Sachim struct cdev *aac_dev_t; 415250963Sachim struct mtx aac_aifq_lock; 416250963Sachim struct aac_fib aac_aifq[AAC_AIFQ_LENGTH]; 417250963Sachim int aifq_idx; 418250963Sachim int aifq_filled; 419250963Sachim int aif_pending; 420250963Sachim struct aac_fib_context *fibctx; 421250963Sachim struct selinfo rcv_select; 422250963Sachim struct proc *aifthread; 423250963Sachim int aifflags; 424250963Sachim#define AAC_AIFFLAGS_RUNNING (1 << 0) 425250963Sachim#define AAC_AIFFLAGS_AIF (1 << 1) 426250963Sachim#define AAC_AIFFLAGS_EXIT (1 << 2) 427250963Sachim#define AAC_AIFFLAGS_EXITED (1 << 3) 428250963Sachim#define AAC_AIFFLAGS_PRINTF (1 << 4) 429250963Sachim#define AAC_AIFFLAGS_ALLOCFIBS (1 << 5) 430250963Sachim#define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \ 431250963Sachim AAC_AIFFLAGS_ALLOCFIBS) 432250963Sachim u_int32_t flags; 433250963Sachim#define AAC_FLAGS_PERC2QC (1 << 0) 434250963Sachim#define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */ 435250963Sachim#define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */ 436250963Sachim#define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */ 437250963Sachim#define AAC_FLAGS_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */ 438250963Sachim#define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem 439250963Sachim * 2GB-4GB range */ 440250963Sachim#define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */ 441250963Sachim#define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */ 442250963Sachim#define AAC_FLAGS_BROKEN_MEMMAP (1 << 8) /* Broken HostPhysMemPages */ 443250963Sachim#define AAC_FLAGS_SLAVE (1 << 9) 444250963Sachim#define AAC_FLAGS_MASTER (1 << 10) 445250963Sachim#define AAC_FLAGS_NEW_COMM (1 << 11) /* New comm. interface supported */ 446250963Sachim#define AAC_FLAGS_RAW_IO (1 << 12) /* Raw I/O interface */ 447250963Sachim#define AAC_FLAGS_ARRAY_64BIT (1 << 13) /* 64-bit array size */ 448250963Sachim#define AAC_FLAGS_LBA_64BIT (1 << 14) /* 64-bit LBA support */ 449250963Sachim#define AAC_QUEUE_FRZN (1 << 15) /* Freeze the processing of 450250963Sachim * commands on the queue. */ 451250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE1 (1 << 16) /* New comm. type1 supported */ 452250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE2 (1 << 17) /* New comm. type2 supported */ 453250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE34 (1 << 18) /* New comm. type3/4 */ 454250963Sachim#define AAC_FLAGS_SYNC_MODE (1 << 18) /* Sync. transfer mode */ 455250963Sachim u_int32_t hint_flags; /* driver parameters */ 456250963Sachim int sim_freezed; /* flag for sim_freeze/release */ 457250963Sachim u_int32_t supported_options; 458250963Sachim u_int32_t scsi_method_id; 459250963Sachim TAILQ_HEAD(,aac_sim) aac_sim_tqh; 460250963Sachim 461250963Sachim u_int32_t aac_max_fibs; /* max. FIB count */ 462250963Sachim u_int32_t aac_max_fibs_alloc; /* max. alloc. per alloc_commands() */ 463250963Sachim u_int32_t aac_max_fib_size; /* max. FIB size */ 464250963Sachim u_int32_t aac_sg_tablesize; /* max. sg count from host */ 465250963Sachim u_int32_t aac_max_sectors; /* max. I/O size from host (blocks) */ 466250963Sachim u_int32_t aac_feature_bits; /* feature bits from suppl. info */ 467250963Sachim u_int32_t aac_support_opt2; /* supp. options from suppl. info */ 468250963Sachim u_int32_t aac_max_aif; /* max. AIF count */ 469250963Sachim#define AAC_CAM_TARGET_WILDCARD ~0 470250963Sachim void (*cam_rescan_cb)(struct aac_softc *, uint32_t, 471250963Sachim uint32_t); 472250963Sachim u_int32_t DebugFlags; /* Debug print flags bitmap */ 473250963Sachim u_int32_t DebugOffset; /* Offset from DPMEM start */ 474250963Sachim u_int32_t DebugHeaderSize; /* Size of debug header */ 475250963Sachim u_int32_t FwDebugFlags; /* FW Debug Flags */ 476250963Sachim u_int32_t FwDebugBufferSize; /* FW Debug Buffer size */ 477250963Sachim}; 478250963Sachim 479250963Sachim/* 480250963Sachim * Event callback mechanism for the driver 481250963Sachim */ 482250963Sachim#define AAC_EVENT_NONE 0x00 483250963Sachim#define AAC_EVENT_CMFREE 0x01 484250963Sachim#define AAC_EVENT_MASK 0xff 485250963Sachim#define AAC_EVENT_REPEAT 0x100 486250963Sachim 487250963Sachimtypedef void aac_event_cb_t(struct aac_softc *sc, struct aac_event *event, 488250963Sachim void *arg); 489250963Sachimstruct aac_event { 490250963Sachim TAILQ_ENTRY(aac_event) ev_links; 491250963Sachim int ev_type; 492250963Sachim aac_event_cb_t *ev_callback; 493250963Sachim void *ev_arg; 494250963Sachim}; 495250963Sachim 496250963Sachim/* 497250963Sachim * Public functions 498250963Sachim */ 499250963Sachimextern void aacraid_free(struct aac_softc *sc); 500250963Sachimextern int aacraid_attach(struct aac_softc *sc); 501250963Sachimextern int aacraid_detach(device_t dev); 502250963Sachimextern int aacraid_shutdown(device_t dev); 503250963Sachimextern int aacraid_suspend(device_t dev); 504250963Sachimextern int aacraid_resume(device_t dev); 505250963Sachimextern void aacraid_new_intr_type1(void *arg); 506250963Sachimextern void aacraid_submit_bio(struct bio *bp); 507250963Sachimextern void aacraid_biodone(struct bio *bp); 508250963Sachimextern void aacraid_startio(struct aac_softc *sc); 509250963Sachimextern int aacraid_alloc_command(struct aac_softc *sc, 510250963Sachim struct aac_command **cmp); 511250963Sachimextern void aacraid_release_command(struct aac_command *cm); 512250963Sachimextern void aacraid_add_event(struct aac_softc *sc, struct aac_event 513250963Sachim *event); 514250963Sachimextern void aacraid_map_command_sg(void *arg, bus_dma_segment_t *segs, 515250963Sachim int nseg, int error); 516250963Sachimextern int aacraid_wait_command(struct aac_command *cmp); 517250963Sachim 518250963Sachim/* #define AACRAID_DEBUG */ 519250963Sachim 520250963Sachim#ifdef AACRAID_DEBUG 521250963Sachim# define fwprintf(sc, flags, fmt, args...) \ 522250963Sachim aacraid_fw_printf(sc, flags, "%s: " fmt, __func__, ##args); 523250963Sachim 524250963Sachimextern void aacraid_print_queues(struct aac_softc *sc); 525250963Sachimextern void aacraid_print_fib(struct aac_softc *sc, struct aac_fib *fib, 526250963Sachim const char *caller); 527250963Sachimextern void aacraid_print_aif(struct aac_softc *sc, 528250963Sachim struct aac_aif_command *aif); 529250963Sachim 530250963Sachim#define AAC_PRINT_FIB(sc, fib) aacraid_print_fib(sc, fib, __func__) 531250963Sachim 532250963Sachim#else 533250963Sachim# define fwprintf(sc, flags, fmt, args...) 534250963Sachim 535250963Sachim# define aacraid_print_queues(sc) 536250963Sachim 537250963Sachim# define AAC_PRINT_FIB(sc, fib) 538250963Sachim# define aacraid_print_aif(sc, aac_aif_command) 539250963Sachim#endif 540250963Sachim 541250963Sachimstruct aac_code_lookup { 542250963Sachim char *string; 543250963Sachim u_int32_t code; 544250963Sachim}; 545250963Sachim 546250963Sachim/* 547250963Sachim * Queue primitives for driver queues. 548250963Sachim */ 549250963Sachim#define AACQ_ADD(sc, qname) \ 550250963Sachim do { \ 551250963Sachim struct aac_qstat *qs; \ 552250963Sachim \ 553250963Sachim qs = &(sc)->aac_qstat[qname]; \ 554250963Sachim \ 555250963Sachim qs->q_length++; \ 556250963Sachim if (qs->q_length > qs->q_max) \ 557250963Sachim qs->q_max = qs->q_length; \ 558250963Sachim } while (0) 559250963Sachim 560250963Sachim#define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length-- 561250963Sachim#define AACQ_INIT(sc, qname) \ 562250963Sachim do { \ 563250963Sachim sc->aac_qstat[qname].q_length = 0; \ 564250963Sachim sc->aac_qstat[qname].q_max = 0; \ 565250963Sachim } while (0) 566250963Sachim 567250963Sachim 568250963Sachim#define AACQ_COMMAND_QUEUE(name, index) \ 569250963Sachimstatic __inline void \ 570250963Sachimaac_initq_ ## name (struct aac_softc *sc) \ 571250963Sachim{ \ 572250963Sachim TAILQ_INIT(&sc->aac_ ## name); \ 573250963Sachim AACQ_INIT(sc, index); \ 574250963Sachim} \ 575250963Sachimstatic __inline void \ 576250963Sachimaac_enqueue_ ## name (struct aac_command *cm) \ 577250963Sachim{ \ 578250963Sachim if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 579250963Sachim printf("command %p is on another queue, flags = %#x\n", \ 580250963Sachim cm, cm->cm_flags); \ 581250963Sachim panic("command is on another queue"); \ 582250963Sachim } \ 583250963Sachim TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 584250963Sachim cm->cm_flags |= AAC_ON_ ## index; \ 585250963Sachim AACQ_ADD(cm->cm_sc, index); \ 586250963Sachim} \ 587250963Sachimstatic __inline void \ 588250963Sachimaac_requeue_ ## name (struct aac_command *cm) \ 589250963Sachim{ \ 590250963Sachim if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 591250963Sachim printf("command %p is on another queue, flags = %#x\n", \ 592250963Sachim cm, cm->cm_flags); \ 593250963Sachim panic("command is on another queue"); \ 594250963Sachim } \ 595250963Sachim TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 596250963Sachim cm->cm_flags |= AAC_ON_ ## index; \ 597250963Sachim AACQ_ADD(cm->cm_sc, index); \ 598250963Sachim} \ 599250963Sachimstatic __inline struct aac_command * \ 600250963Sachimaac_dequeue_ ## name (struct aac_softc *sc) \ 601250963Sachim{ \ 602250963Sachim struct aac_command *cm; \ 603250963Sachim \ 604250963Sachim if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \ 605250963Sachim if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 606250963Sachim printf("command %p not in queue, flags = %#x, " \ 607250963Sachim "bit = %#x\n", cm, cm->cm_flags, \ 608250963Sachim AAC_ON_ ## index); \ 609250963Sachim panic("command not in queue"); \ 610250963Sachim } \ 611250963Sachim TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \ 612250963Sachim cm->cm_flags &= ~AAC_ON_ ## index; \ 613250963Sachim AACQ_REMOVE(sc, index); \ 614250963Sachim } \ 615250963Sachim return(cm); \ 616250963Sachim} \ 617250963Sachimstatic __inline void \ 618250963Sachimaac_remove_ ## name (struct aac_command *cm) \ 619250963Sachim{ \ 620250963Sachim if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 621250963Sachim printf("command %p not in queue, flags = %#x, " \ 622250963Sachim "bit = %#x\n", cm, cm->cm_flags, \ 623250963Sachim AAC_ON_ ## index); \ 624250963Sachim panic("command not in queue"); \ 625250963Sachim } \ 626250963Sachim TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 627250963Sachim cm->cm_flags &= ~AAC_ON_ ## index; \ 628250963Sachim AACQ_REMOVE(cm->cm_sc, index); \ 629250963Sachim} \ 630250963Sachimstruct hack 631250963Sachim 632250963SachimAACQ_COMMAND_QUEUE(free, AACQ_FREE); 633250963SachimAACQ_COMMAND_QUEUE(ready, AACQ_READY); 634250963SachimAACQ_COMMAND_QUEUE(busy, AACQ_BUSY); 635250963Sachim 636250963Sachimstatic __inline void 637250963Sachimaac_print_printf(struct aac_softc *sc) 638250963Sachim{ 639250963Sachim /* 640250963Sachim * XXX We have the ability to read the length of the printf string 641250963Sachim * from out of the mailboxes. 642250963Sachim */ 643250963Sachim device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE, 644250963Sachim sc->aac_common->ac_printf); 645250963Sachim sc->aac_common->ac_printf[0] = 0; 646250963Sachim AAC_QNOTIFY(sc, AAC_DB_PRINTF); 647250963Sachim} 648250963Sachim 649250963Sachimstatic __inline int 650250963Sachimaac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib) 651250963Sachim{ 652250963Sachim 653250963Sachim mtx_assert(&sc->aac_io_lock, MA_OWNED); 654250963Sachim *fib = &sc->aac_common->ac_sync_fib; 655250963Sachim return (0); 656250963Sachim} 657250963Sachim 658250963Sachimstatic __inline void 659250963Sachimaac_release_sync_fib(struct aac_softc *sc) 660250963Sachim{ 661250963Sachim 662250963Sachim mtx_assert(&sc->aac_io_lock, MA_OWNED); 663250963Sachim} 664