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: stable/11/sys/dev/aacraid/aacraid_var.h 354965 2019-11-21 14:55:27Z emaste $ 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 49257847Sachim#define AAC_DRIVER_MINOR_VERSION 2 50354965Semaste#define AAC_DRIVER_BUGFIX_LEVEL 10 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/* 117257847Sachim * We wait this many seconds for the adapter to come ready 118257847Sachim * after flash update 119250963Sachim */ 120257847Sachim#define AAC_FWUPD_TIMEOUT (5 * 60) 121250963Sachim 122250963Sachim/* 123257847Sachim * Timeout for sync. commands. 124257847Sachim */ 125257847Sachim#define AAC_SYNC_TIMEOUT 180 /* seconds */ 126257847Sachim 127257847Sachim/* 128250963Sachim * Timeout for normal commands 129250963Sachim */ 130257847Sachim#define AAC_CMD_TIMEOUT 180 /* seconds */ 131250963Sachim 132250963Sachim/* 133250963Sachim * Rate at which we periodically check for timed out commands and kick the 134250963Sachim * controller. 135250963Sachim */ 136250963Sachim#define AAC_PERIODIC_INTERVAL 20 /* seconds */ 137250963Sachim 138250963Sachim#define PASSTHROUGH_BUS 0 139250963Sachim#define CONTAINER_BUS 1 140250963Sachim/* 141250963Sachim * Per-container data structure 142250963Sachim */ 143250963Sachimstruct aac_container 144250963Sachim{ 145250963Sachim struct aac_mntobj co_mntobj; 146250963Sachim int co_found; 147250963Sachim u_int32_t co_uid; 148250963Sachim TAILQ_ENTRY(aac_container) co_link; 149250963Sachim}; 150250963Sachim 151250963Sachim/* 152250963Sachim * Per-SIM data structure 153250963Sachim */ 154250963Sachimstruct aac_cam; 155250963Sachimstruct aac_sim 156250963Sachim{ 157250963Sachim device_t sim_dev; 158250963Sachim int TargetsPerBus; 159250963Sachim int BusNumber; 160250963Sachim int BusType; 161250963Sachim int InitiatorBusId; 162250963Sachim struct aac_softc *aac_sc; 163250963Sachim struct aac_cam *aac_cam; 164250963Sachim TAILQ_ENTRY(aac_sim) sim_link; 165250963Sachim}; 166250963Sachim 167250963Sachim/* 168250963Sachim * Per-disk structure 169250963Sachim */ 170250963Sachimstruct aac_disk 171250963Sachim{ 172250963Sachim device_t ad_dev; 173250963Sachim struct aac_softc *ad_controller; 174250963Sachim struct aac_container *ad_container; 175250963Sachim struct disk *ad_disk; 176250963Sachim int ad_flags; 177250963Sachim#define AAC_DISK_OPEN (1<<0) 178250963Sachim int ad_cylinders; 179250963Sachim int ad_heads; 180250963Sachim int ad_sectors; 181250963Sachim u_int64_t ad_size; 182250963Sachim int unit; 183250963Sachim}; 184250963Sachim 185250963Sachim/* 186250963Sachim * Per-command control structure. 187250963Sachim */ 188250963Sachimstruct aac_command 189250963Sachim{ 190250963Sachim TAILQ_ENTRY(aac_command) cm_link; /* list linkage */ 191250963Sachim 192250963Sachim struct aac_softc *cm_sc; /* controller that owns us */ 193250963Sachim 194250963Sachim struct aac_fib *cm_fib; /* FIB associated with this 195250963Sachim * command */ 196250963Sachim u_int64_t cm_fibphys; /* bus address of the FIB */ 197250963Sachim struct bio *cm_data; /* pointer to data in kernel 198250963Sachim * space */ 199250963Sachim u_int32_t cm_datalen; /* data length */ 200250963Sachim bus_dmamap_t cm_datamap; /* DMA map for bio data */ 201250963Sachim struct aac_sg_table *cm_sgtable; /* pointer to s/g table in 202250963Sachim * command */ 203250963Sachim int cm_flags; 204250963Sachim#define AAC_CMD_MAPPED (1<<0) /* command has had its data 205250963Sachim * mapped */ 206250963Sachim#define AAC_CMD_DATAIN (1<<1) /* command involves data moving 207250963Sachim * from controller to host */ 208250963Sachim#define AAC_CMD_DATAOUT (1<<2) /* command involves data moving 209250963Sachim * from host to controller */ 210250963Sachim#define AAC_CMD_COMPLETED (1<<3) /* command has been completed */ 211250963Sachim#define AAC_CMD_TIMEDOUT (1<<4) /* command taken too long */ 212250963Sachim#define AAC_ON_AACQ_FREE (1<<5) 213250963Sachim#define AAC_ON_AACQ_READY (1<<6) 214250963Sachim#define AAC_ON_AACQ_BUSY (1<<7) 215250963Sachim#define AAC_ON_AACQ_AIF (1<<8) 216250963Sachim#define AAC_ON_AACQ_NORM (1<<10) 217250963Sachim#define AAC_ON_AACQ_MASK ((1<<5)|(1<<6)|(1<<7)|(1<<8)|(1<<10)) 218250963Sachim#define AAC_CMD_RESET (1<<9) 219250963Sachim#define AAC_CMD_FASTRESP (1<<11) 220250963Sachim#define AAC_CMD_WAIT (1<<12) 221250963Sachim 222250963Sachim void (* cm_complete)(struct aac_command *cm); 223250963Sachim union ccb *cm_ccb; 224250963Sachim time_t cm_timestamp; /* command creation time */ 225250963Sachim int cm_index; 226250963Sachim bus_dma_tag_t cm_passthr_dmat; /* passthrough buffer/command 227250963Sachim * DMA tag */ 228250963Sachim}; 229250963Sachim 230250963Sachimstruct aac_fibmap { 231250963Sachim TAILQ_ENTRY(aac_fibmap) fm_link; /* list linkage */ 232250963Sachim struct aac_fib *aac_fibs; 233250963Sachim bus_dmamap_t aac_fibmap; 234250963Sachim struct aac_command *aac_commands; 235250963Sachim}; 236250963Sachim 237250963Sachim/* 238250963Sachim * We gather a number of adapter-visible items into a single structure. 239250963Sachim * 240250963Sachim * The ordering of this strucure may be important; we copy the Linux driver: 241250963Sachim * 242250963Sachim * Adapter FIBs 243250963Sachim * Init struct 244250963Sachim * Queue headers (Comm Area) 245250963Sachim * Printf buffer 246250963Sachim * 247250963Sachim * In addition, we add: 248250963Sachim * Sync Fib 249250963Sachim */ 250250963Sachimstruct aac_common { 251250963Sachim /* fibs for the controller to send us messages */ 252250963Sachim struct aac_fib ac_fibs[AAC_ADAPTER_FIBS]; 253250963Sachim 254250963Sachim /* the init structure */ 255250963Sachim struct aac_adapter_init ac_init; 256250963Sachim 257250963Sachim /* buffer for text messages from the controller */ 258250963Sachim char ac_printf[AAC_PRINTF_BUFSIZE]; 259250963Sachim 260250963Sachim /* fib for synchronous commands */ 261250963Sachim struct aac_fib ac_sync_fib; 262250963Sachim 263250963Sachim /* response buffer for SRC (new comm. type1) - must be last element */ 264250963Sachim u_int32_t ac_host_rrq[0]; 265250963Sachim}; 266250963Sachim 267250963Sachim/* 268250963Sachim * Interface operations 269250963Sachim */ 270250963Sachimstruct aac_interface 271250963Sachim{ 272250963Sachim int (*aif_get_fwstatus)(struct aac_softc *sc); 273250963Sachim void (*aif_qnotify)(struct aac_softc *sc, int qbit); 274250963Sachim int (*aif_get_istatus)(struct aac_softc *sc); 275250963Sachim void (*aif_clr_istatus)(struct aac_softc *sc, int mask); 276250963Sachim void (*aif_set_mailbox)(struct aac_softc *sc, u_int32_t command, 277250963Sachim u_int32_t arg0, u_int32_t arg1, 278250963Sachim u_int32_t arg2, u_int32_t arg3); 279250963Sachim int (*aif_get_mailbox)(struct aac_softc *sc, int mb); 280257847Sachim void (*aif_access_devreg)(struct aac_softc *sc, int enable); 281250963Sachim int (*aif_send_command)(struct aac_softc *sc, struct aac_command *cm); 282250963Sachim int (*aif_get_outb_queue)(struct aac_softc *sc); 283250963Sachim void (*aif_set_outb_queue)(struct aac_softc *sc, int index); 284250963Sachim}; 285250963Sachimextern struct aac_interface aacraid_src_interface; 286250963Sachimextern struct aac_interface aacraid_srcv_interface; 287250963Sachim 288250963Sachim#define AAC_GET_FWSTATUS(sc) ((sc)->aac_if.aif_get_fwstatus((sc))) 289250963Sachim#define AAC_QNOTIFY(sc, qbit) ((sc)->aac_if.aif_qnotify((sc), (qbit))) 290250963Sachim#define AAC_GET_ISTATUS(sc) ((sc)->aac_if.aif_get_istatus((sc))) 291250963Sachim#define AAC_CLEAR_ISTATUS(sc, mask) ((sc)->aac_if.aif_clr_istatus((sc), \ 292250963Sachim (mask))) 293250963Sachim#define AAC_SET_MAILBOX(sc, command, arg0, arg1, arg2, arg3) \ 294250963Sachim ((sc)->aac_if.aif_set_mailbox((sc), (command), (arg0), (arg1), (arg2), \ 295250963Sachim (arg3))) 296250963Sachim#define AAC_GET_MAILBOX(sc, mb) ((sc)->aac_if.aif_get_mailbox((sc), \ 297250963Sachim (mb))) 298257847Sachim#define AAC_ACCESS_DEVREG(sc, mode) ((sc)->aac_if.aif_access_devreg((sc), \ 299257847Sachim mode)) 300250963Sachim#define AAC_SEND_COMMAND(sc, cm) ((sc)->aac_if.aif_send_command((sc), (cm))) 301250963Sachim#define AAC_GET_OUTB_QUEUE(sc) ((sc)->aac_if.aif_get_outb_queue((sc))) 302250963Sachim#define AAC_SET_OUTB_QUEUE(sc, idx) ((sc)->aac_if.aif_set_outb_queue((sc), (idx))) 303250963Sachim 304250963Sachim#define AAC_MEM0_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag0, \ 305250963Sachim sc->aac_bhandle0, reg, val) 306250963Sachim#define AAC_MEM0_GETREG4(sc, reg) bus_space_read_4(sc->aac_btag0, \ 307250963Sachim sc->aac_bhandle0, reg) 308250963Sachim#define AAC_MEM0_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag0, \ 309250963Sachim sc->aac_bhandle0, reg, val) 310250963Sachim#define AAC_MEM0_GETREG2(sc, reg) bus_space_read_2(sc->aac_btag0, \ 311250963Sachim sc->aac_bhandle0, reg) 312250963Sachim#define AAC_MEM0_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag0, \ 313250963Sachim sc->aac_bhandle0, reg, val) 314250963Sachim#define AAC_MEM0_GETREG1(sc, reg) bus_space_read_1(sc->aac_btag0, \ 315250963Sachim sc->aac_bhandle0, reg) 316250963Sachim 317250963Sachim#define AAC_MEM1_SETREG4(sc, reg, val) bus_space_write_4(sc->aac_btag1, \ 318250963Sachim sc->aac_bhandle1, reg, val) 319250963Sachim#define AAC_MEM1_GETREG4(sc, reg) bus_space_read_4(sc->aac_btag1, \ 320250963Sachim sc->aac_bhandle1, reg) 321250963Sachim#define AAC_MEM1_SETREG2(sc, reg, val) bus_space_write_2(sc->aac_btag1, \ 322250963Sachim sc->aac_bhandle1, reg, val) 323250963Sachim#define AAC_MEM1_GETREG2(sc, reg) bus_space_read_2(sc->aac_btag1, \ 324250963Sachim sc->aac_bhandle1, reg) 325250963Sachim#define AAC_MEM1_SETREG1(sc, reg, val) bus_space_write_1(sc->aac_btag1, \ 326250963Sachim sc->aac_bhandle1, reg, val) 327250963Sachim#define AAC_MEM1_GETREG1(sc, reg) bus_space_read_1(sc->aac_btag1, \ 328250963Sachim sc->aac_bhandle1, reg) 329250963Sachim 330250963Sachim/* fib context (IOCTL) */ 331250963Sachimstruct aac_fib_context { 332250963Sachim u_int32_t unique; 333250963Sachim int ctx_idx; 334250963Sachim int ctx_wrap; 335250963Sachim struct aac_fib_context *next, *prev; 336250963Sachim}; 337250963Sachim 338257847Sachim/* MSIX context */ 339257847Sachimstruct aac_msix_ctx { 340257847Sachim int vector_no; 341257847Sachim struct aac_softc *sc; 342257847Sachim}; 343257847Sachim 344250963Sachim/* 345250963Sachim * Per-controller structure. 346250963Sachim */ 347250963Sachimstruct aac_softc 348250963Sachim{ 349250963Sachim /* bus connections */ 350250963Sachim device_t aac_dev; 351250963Sachim struct resource *aac_regs_res0, *aac_regs_res1; /* reg. if. window */ 352250963Sachim int aac_regs_rid0, aac_regs_rid1; /* resource ID */ 353250963Sachim bus_space_handle_t aac_bhandle0, aac_bhandle1; /* bus space handle */ 354250963Sachim bus_space_tag_t aac_btag0, aac_btag1; /* bus space tag */ 355250963Sachim bus_dma_tag_t aac_parent_dmat; /* parent DMA tag */ 356250963Sachim bus_dma_tag_t aac_buffer_dmat; /* data buffer/command 357250963Sachim * DMA tag */ 358257847Sachim struct resource *aac_irq[AAC_MAX_MSIX]; /* interrupt */ 359257847Sachim int aac_irq_rid[AAC_MAX_MSIX]; 360257847Sachim void *aac_intr[AAC_MAX_MSIX]; /* interrupt handle */ 361257847Sachim struct aac_msix_ctx aac_msix[AAC_MAX_MSIX]; /* context */ 362250963Sachim eventhandler_tag eh; 363250963Sachim#if __FreeBSD_version >= 800000 364250963Sachim struct callout aac_daemontime; /* clock daemon callout */ 365250963Sachim#else 366250963Sachim struct callout_handle timeout_id; /* timeout handle */ 367250963Sachim#endif 368250963Sachim 369250963Sachim /* controller features, limits and status */ 370250963Sachim int aac_state; 371250963Sachim#define AAC_STATE_SUSPEND (1<<0) 372250963Sachim#define AAC_STATE_UNUSED0 (1<<1) 373250963Sachim#define AAC_STATE_INTERRUPTS_ON (1<<2) 374250963Sachim#define AAC_STATE_AIF_SLEEPER (1<<3) 375250963Sachim#define AAC_STATE_RESET (1<<4) 376250963Sachim struct FsaRevision aac_revision; 377250963Sachim 378250963Sachim /* controller hardware interface */ 379250963Sachim int aac_hwif; 380250963Sachim#define AAC_HWIF_SRC 5 381250963Sachim#define AAC_HWIF_SRCV 6 382250963Sachim#define AAC_HWIF_UNKNOWN -1 383250963Sachim bus_dma_tag_t aac_common_dmat; /* common structure 384250963Sachim * DMA tag */ 385250963Sachim bus_dmamap_t aac_common_dmamap; /* common structure 386250963Sachim * DMA map */ 387250963Sachim struct aac_common *aac_common; 388250963Sachim u_int32_t aac_common_busaddr; 389257847Sachim u_int32_t aac_host_rrq_idx[AAC_MAX_MSIX]; 390257847Sachim u_int32_t aac_rrq_outstanding[AAC_MAX_MSIX]; 391257847Sachim u_int32_t aac_fibs_pushed_no; 392250963Sachim struct aac_interface aac_if; 393250963Sachim 394250963Sachim /* command/fib resources */ 395250963Sachim bus_dma_tag_t aac_fib_dmat; /* DMA tag for allocing FIBs */ 396250963Sachim TAILQ_HEAD(,aac_fibmap) aac_fibmap_tqh; 397250963Sachim u_int total_fibs; 398250963Sachim struct aac_command *aac_commands; 399250963Sachim 400250963Sachim /* command management */ 401250963Sachim TAILQ_HEAD(,aac_command) aac_free; /* command structures 402250963Sachim * available for reuse */ 403250963Sachim TAILQ_HEAD(,aac_command) aac_ready; /* commands on hold for 404250963Sachim * controller resources */ 405250963Sachim TAILQ_HEAD(,aac_command) aac_busy; 406250963Sachim TAILQ_HEAD(,aac_event) aac_ev_cmfree; 407250963Sachim struct bio_queue_head aac_bioq; 408250963Sachim 409250963Sachim struct aac_qstat aac_qstat[AACQ_COUNT]; /* queue statistics */ 410250963Sachim 411250963Sachim /* connected containters */ 412250963Sachim TAILQ_HEAD(,aac_container) aac_container_tqh; 413250963Sachim struct mtx aac_container_lock; 414250963Sachim 415250963Sachim /* 416250963Sachim * The general I/O lock. This protects the sync fib, the lists, the 417250963Sachim * queues, and the registers. 418250963Sachim */ 419250963Sachim struct mtx aac_io_lock; 420250963Sachim 421250963Sachim struct intr_config_hook aac_ich; 422250963Sachim 423250963Sachim /* sync. transfer mode */ 424250963Sachim struct aac_command *aac_sync_cm; 425250963Sachim 426250963Sachim /* management interface */ 427250963Sachim struct cdev *aac_dev_t; 428250963Sachim struct mtx aac_aifq_lock; 429250963Sachim struct aac_fib aac_aifq[AAC_AIFQ_LENGTH]; 430250963Sachim int aifq_idx; 431250963Sachim int aifq_filled; 432250963Sachim int aif_pending; 433250963Sachim struct aac_fib_context *fibctx; 434250963Sachim struct selinfo rcv_select; 435250963Sachim struct proc *aifthread; 436250963Sachim int aifflags; 437250963Sachim#define AAC_AIFFLAGS_RUNNING (1 << 0) 438250963Sachim#define AAC_AIFFLAGS_AIF (1 << 1) 439250963Sachim#define AAC_AIFFLAGS_EXIT (1 << 2) 440250963Sachim#define AAC_AIFFLAGS_EXITED (1 << 3) 441250963Sachim#define AAC_AIFFLAGS_PRINTF (1 << 4) 442250963Sachim#define AAC_AIFFLAGS_ALLOCFIBS (1 << 5) 443250963Sachim#define AAC_AIFFLAGS_PENDING (AAC_AIFFLAGS_AIF | AAC_AIFFLAGS_PRINTF | \ 444250963Sachim AAC_AIFFLAGS_ALLOCFIBS) 445250963Sachim u_int32_t flags; 446250963Sachim#define AAC_FLAGS_PERC2QC (1 << 0) 447250963Sachim#define AAC_FLAGS_ENABLE_CAM (1 << 1) /* No SCSI passthrough */ 448250963Sachim#define AAC_FLAGS_CAM_NORESET (1 << 2) /* Fake SCSI resets */ 449250963Sachim#define AAC_FLAGS_CAM_PASSONLY (1 << 3) /* Only create pass devices */ 450250963Sachim#define AAC_FLAGS_SG_64BIT (1 << 4) /* Use 64-bit S/G addresses */ 451250963Sachim#define AAC_FLAGS_4GB_WINDOW (1 << 5) /* Device can access host mem 452250963Sachim * 2GB-4GB range */ 453250963Sachim#define AAC_FLAGS_NO4GB (1 << 6) /* Can't access host mem >2GB */ 454250963Sachim#define AAC_FLAGS_256FIBS (1 << 7) /* Can only do 256 commands */ 455250963Sachim#define AAC_FLAGS_BROKEN_MEMMAP (1 << 8) /* Broken HostPhysMemPages */ 456250963Sachim#define AAC_FLAGS_SLAVE (1 << 9) 457250963Sachim#define AAC_FLAGS_MASTER (1 << 10) 458250963Sachim#define AAC_FLAGS_NEW_COMM (1 << 11) /* New comm. interface supported */ 459250963Sachim#define AAC_FLAGS_RAW_IO (1 << 12) /* Raw I/O interface */ 460250963Sachim#define AAC_FLAGS_ARRAY_64BIT (1 << 13) /* 64-bit array size */ 461250963Sachim#define AAC_FLAGS_LBA_64BIT (1 << 14) /* 64-bit LBA support */ 462250963Sachim#define AAC_QUEUE_FRZN (1 << 15) /* Freeze the processing of 463250963Sachim * commands on the queue. */ 464250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE1 (1 << 16) /* New comm. type1 supported */ 465250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE2 (1 << 17) /* New comm. type2 supported */ 466250963Sachim#define AAC_FLAGS_NEW_COMM_TYPE34 (1 << 18) /* New comm. type3/4 */ 467250963Sachim#define AAC_FLAGS_SYNC_MODE (1 << 18) /* Sync. transfer mode */ 468250963Sachim u_int32_t hint_flags; /* driver parameters */ 469250963Sachim int sim_freezed; /* flag for sim_freeze/release */ 470250963Sachim u_int32_t supported_options; 471250963Sachim u_int32_t scsi_method_id; 472250963Sachim TAILQ_HEAD(,aac_sim) aac_sim_tqh; 473250963Sachim 474250963Sachim u_int32_t aac_max_fibs; /* max. FIB count */ 475250963Sachim u_int32_t aac_max_fibs_alloc; /* max. alloc. per alloc_commands() */ 476250963Sachim u_int32_t aac_max_fib_size; /* max. FIB size */ 477250963Sachim u_int32_t aac_sg_tablesize; /* max. sg count from host */ 478250963Sachim u_int32_t aac_max_sectors; /* max. I/O size from host (blocks) */ 479250963Sachim u_int32_t aac_feature_bits; /* feature bits from suppl. info */ 480250963Sachim u_int32_t aac_support_opt2; /* supp. options from suppl. info */ 481250963Sachim u_int32_t aac_max_aif; /* max. AIF count */ 482354965Semaste u_int32_t doorbell_mask; /* for IOP reset */ 483257847Sachim u_int32_t aac_max_msix; /* max. MSI-X vectors */ 484257847Sachim u_int32_t aac_vector_cap; /* MSI-X vector capab.*/ 485257847Sachim int msi_enabled; /* MSI/MSI-X enabled */ 486354965Semaste int msi_tupelo; /* Series 6 support for */ 487354965Semaste /* single MSI interrupt */ 488250963Sachim#define AAC_CAM_TARGET_WILDCARD ~0 489250963Sachim void (*cam_rescan_cb)(struct aac_softc *, uint32_t, 490250963Sachim uint32_t); 491250963Sachim u_int32_t DebugFlags; /* Debug print flags bitmap */ 492250963Sachim u_int32_t DebugOffset; /* Offset from DPMEM start */ 493250963Sachim u_int32_t DebugHeaderSize; /* Size of debug header */ 494250963Sachim u_int32_t FwDebugFlags; /* FW Debug Flags */ 495250963Sachim u_int32_t FwDebugBufferSize; /* FW Debug Buffer size */ 496250963Sachim}; 497250963Sachim 498250963Sachim/* 499250963Sachim * Event callback mechanism for the driver 500250963Sachim */ 501250963Sachim#define AAC_EVENT_NONE 0x00 502250963Sachim#define AAC_EVENT_CMFREE 0x01 503250963Sachim#define AAC_EVENT_MASK 0xff 504250963Sachim#define AAC_EVENT_REPEAT 0x100 505250963Sachim 506250963Sachimtypedef void aac_event_cb_t(struct aac_softc *sc, struct aac_event *event, 507250963Sachim void *arg); 508250963Sachimstruct aac_event { 509250963Sachim TAILQ_ENTRY(aac_event) ev_links; 510250963Sachim int ev_type; 511250963Sachim aac_event_cb_t *ev_callback; 512250963Sachim void *ev_arg; 513250963Sachim}; 514250963Sachim 515250963Sachim/* 516250963Sachim * Public functions 517250963Sachim */ 518250963Sachimextern void aacraid_free(struct aac_softc *sc); 519250963Sachimextern int aacraid_attach(struct aac_softc *sc); 520250963Sachimextern int aacraid_detach(device_t dev); 521250963Sachimextern int aacraid_shutdown(device_t dev); 522250963Sachimextern int aacraid_suspend(device_t dev); 523250963Sachimextern int aacraid_resume(device_t dev); 524250963Sachimextern void aacraid_new_intr_type1(void *arg); 525250963Sachimextern void aacraid_submit_bio(struct bio *bp); 526250963Sachimextern void aacraid_biodone(struct bio *bp); 527250963Sachimextern void aacraid_startio(struct aac_softc *sc); 528250963Sachimextern int aacraid_alloc_command(struct aac_softc *sc, 529250963Sachim struct aac_command **cmp); 530250963Sachimextern void aacraid_release_command(struct aac_command *cm); 531250963Sachimextern void aacraid_add_event(struct aac_softc *sc, struct aac_event 532250963Sachim *event); 533250963Sachimextern void aacraid_map_command_sg(void *arg, bus_dma_segment_t *segs, 534250963Sachim int nseg, int error); 535250963Sachimextern int aacraid_wait_command(struct aac_command *cmp); 536250963Sachim 537250963Sachim#ifdef AACRAID_DEBUG 538250963Sachim# define fwprintf(sc, flags, fmt, args...) \ 539250963Sachim aacraid_fw_printf(sc, flags, "%s: " fmt, __func__, ##args); 540250963Sachim 541250963Sachimextern void aacraid_print_queues(struct aac_softc *sc); 542250963Sachimextern void aacraid_print_fib(struct aac_softc *sc, struct aac_fib *fib, 543250963Sachim const char *caller); 544250963Sachimextern void aacraid_print_aif(struct aac_softc *sc, 545250963Sachim struct aac_aif_command *aif); 546250963Sachim 547250963Sachim#define AAC_PRINT_FIB(sc, fib) aacraid_print_fib(sc, fib, __func__) 548250963Sachim 549250963Sachim#else 550250963Sachim# define fwprintf(sc, flags, fmt, args...) 551250963Sachim 552250963Sachim# define aacraid_print_queues(sc) 553250963Sachim 554250963Sachim# define AAC_PRINT_FIB(sc, fib) 555250963Sachim# define aacraid_print_aif(sc, aac_aif_command) 556250963Sachim#endif 557250963Sachim 558250963Sachimstruct aac_code_lookup { 559250963Sachim char *string; 560250963Sachim u_int32_t code; 561250963Sachim}; 562250963Sachim 563250963Sachim/* 564250963Sachim * Queue primitives for driver queues. 565250963Sachim */ 566250963Sachim#define AACQ_ADD(sc, qname) \ 567250963Sachim do { \ 568250963Sachim struct aac_qstat *qs; \ 569250963Sachim \ 570250963Sachim qs = &(sc)->aac_qstat[qname]; \ 571250963Sachim \ 572250963Sachim qs->q_length++; \ 573250963Sachim if (qs->q_length > qs->q_max) \ 574250963Sachim qs->q_max = qs->q_length; \ 575250963Sachim } while (0) 576250963Sachim 577250963Sachim#define AACQ_REMOVE(sc, qname) (sc)->aac_qstat[qname].q_length-- 578250963Sachim#define AACQ_INIT(sc, qname) \ 579250963Sachim do { \ 580250963Sachim sc->aac_qstat[qname].q_length = 0; \ 581250963Sachim sc->aac_qstat[qname].q_max = 0; \ 582250963Sachim } while (0) 583250963Sachim 584250963Sachim 585250963Sachim#define AACQ_COMMAND_QUEUE(name, index) \ 586250963Sachimstatic __inline void \ 587250963Sachimaac_initq_ ## name (struct aac_softc *sc) \ 588250963Sachim{ \ 589250963Sachim TAILQ_INIT(&sc->aac_ ## name); \ 590250963Sachim AACQ_INIT(sc, index); \ 591250963Sachim} \ 592250963Sachimstatic __inline void \ 593250963Sachimaac_enqueue_ ## name (struct aac_command *cm) \ 594250963Sachim{ \ 595250963Sachim if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 596250963Sachim printf("command %p is on another queue, flags = %#x\n", \ 597250963Sachim cm, cm->cm_flags); \ 598250963Sachim panic("command is on another queue"); \ 599250963Sachim } \ 600250963Sachim TAILQ_INSERT_TAIL(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 601250963Sachim cm->cm_flags |= AAC_ON_ ## index; \ 602250963Sachim AACQ_ADD(cm->cm_sc, index); \ 603250963Sachim} \ 604250963Sachimstatic __inline void \ 605250963Sachimaac_requeue_ ## name (struct aac_command *cm) \ 606250963Sachim{ \ 607250963Sachim if ((cm->cm_flags & AAC_ON_AACQ_MASK) != 0) { \ 608250963Sachim printf("command %p is on another queue, flags = %#x\n", \ 609250963Sachim cm, cm->cm_flags); \ 610250963Sachim panic("command is on another queue"); \ 611250963Sachim } \ 612250963Sachim TAILQ_INSERT_HEAD(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 613250963Sachim cm->cm_flags |= AAC_ON_ ## index; \ 614250963Sachim AACQ_ADD(cm->cm_sc, index); \ 615250963Sachim} \ 616250963Sachimstatic __inline struct aac_command * \ 617250963Sachimaac_dequeue_ ## name (struct aac_softc *sc) \ 618250963Sachim{ \ 619250963Sachim struct aac_command *cm; \ 620250963Sachim \ 621250963Sachim if ((cm = TAILQ_FIRST(&sc->aac_ ## name)) != NULL) { \ 622250963Sachim if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 623250963Sachim printf("command %p not in queue, flags = %#x, " \ 624250963Sachim "bit = %#x\n", cm, cm->cm_flags, \ 625250963Sachim AAC_ON_ ## index); \ 626250963Sachim panic("command not in queue"); \ 627250963Sachim } \ 628250963Sachim TAILQ_REMOVE(&sc->aac_ ## name, cm, cm_link); \ 629250963Sachim cm->cm_flags &= ~AAC_ON_ ## index; \ 630250963Sachim AACQ_REMOVE(sc, index); \ 631250963Sachim } \ 632250963Sachim return(cm); \ 633250963Sachim} \ 634250963Sachimstatic __inline void \ 635250963Sachimaac_remove_ ## name (struct aac_command *cm) \ 636250963Sachim{ \ 637250963Sachim if ((cm->cm_flags & AAC_ON_ ## index) == 0) { \ 638250963Sachim printf("command %p not in queue, flags = %#x, " \ 639250963Sachim "bit = %#x\n", cm, cm->cm_flags, \ 640250963Sachim AAC_ON_ ## index); \ 641250963Sachim panic("command not in queue"); \ 642250963Sachim } \ 643250963Sachim TAILQ_REMOVE(&cm->cm_sc->aac_ ## name, cm, cm_link); \ 644250963Sachim cm->cm_flags &= ~AAC_ON_ ## index; \ 645250963Sachim AACQ_REMOVE(cm->cm_sc, index); \ 646250963Sachim} \ 647250963Sachimstruct hack 648250963Sachim 649250963SachimAACQ_COMMAND_QUEUE(free, AACQ_FREE); 650250963SachimAACQ_COMMAND_QUEUE(ready, AACQ_READY); 651250963SachimAACQ_COMMAND_QUEUE(busy, AACQ_BUSY); 652250963Sachim 653250963Sachimstatic __inline void 654250963Sachimaac_print_printf(struct aac_softc *sc) 655250963Sachim{ 656250963Sachim /* 657250963Sachim * XXX We have the ability to read the length of the printf string 658250963Sachim * from out of the mailboxes. 659250963Sachim */ 660250963Sachim device_printf(sc->aac_dev, "**Monitor** %.*s", AAC_PRINTF_BUFSIZE, 661250963Sachim sc->aac_common->ac_printf); 662250963Sachim sc->aac_common->ac_printf[0] = 0; 663250963Sachim AAC_QNOTIFY(sc, AAC_DB_PRINTF); 664250963Sachim} 665250963Sachim 666250963Sachimstatic __inline int 667250963Sachimaac_alloc_sync_fib(struct aac_softc *sc, struct aac_fib **fib) 668250963Sachim{ 669250963Sachim 670250963Sachim mtx_assert(&sc->aac_io_lock, MA_OWNED); 671250963Sachim *fib = &sc->aac_common->ac_sync_fib; 672250963Sachim return (0); 673250963Sachim} 674250963Sachim 675250963Sachimstatic __inline void 676250963Sachimaac_release_sync_fib(struct aac_softc *sc) 677250963Sachim{ 678250963Sachim 679250963Sachim mtx_assert(&sc->aac_io_lock, MA_OWNED); 680250963Sachim} 681