sys/dev/disk/aic7xxx/aic79xx.h

   1 /*
   2  * Core definitions and data structures shareable across OS platforms.
   3  *
   4  * Copyright (c) 1994-2002 Justin T. Gibbs.
   5  * Copyright (c) 2000-2002 Adaptec Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions, and the following disclaimer,
  13  *    without modification.
  14  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  15  *    substantially similar to the "NO WARRANTY" disclaimer below
  16  *    ("Disclaimer") and any redistribution must be conditioned upon
  17  *    including a substantially similar Disclaimer requirement for further
  18  *    binary redistribution.
  19  * 3. Neither the names of the above-listed copyright holders nor the names
  20  *    of any contributors may be used to endorse or promote products derived
  21  *    from this software without specific prior written permission.
  22  *
  23  * Alternatively, this software may be distributed under the terms of the
  24  * GNU General Public License ("GPL") version 2 as published by the Free
  25  * Software Foundation.
  26  *
  27  * NO WARRANTY
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  37  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGES.
  39  *
  40  * $Id: //depot/aic7xxx/aic7xxx/aic79xx.h#107 $
  41  *
  42  * $FreeBSD: src/sys/dev/aic7xxx/aic79xx.h,v 1.27 2007/04/19 18:53:52 scottl Exp $
  43  * $DragonFly: src/sys/dev/disk/aic7xxx/aic79xx.h,v 1.13 2007/07/19 00:23:04 pavalos Exp $
  44  */
  45
  46 #ifndef _AIC79XX_H_
  47 #define _AIC79XX_H_
  48
  49 /* Register Definitions */
  50 #include "aic79xx_reg.h"
  51
  52 /************************* Forward Declarations *******************************/
  53 struct ahd_platform_data;
  54 struct scb_platform_data;
  55
  56 /****************************** Useful Macros *********************************/
  57 #ifndef MAX
  58 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
  59 #endif
  60
  61 #ifndef MIN
  62 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
  63 #endif
  64
  65 #ifndef TRUE
  66 #define TRUE 1
  67 #endif
  68 #ifndef FALSE
  69 #define FALSE 0
  70 #endif
  71
  72 #define NUM_ELEMENTS(array) (sizeof(array) / sizeof(*array))
  73
  74 #define ALL_CHANNELS '\0'
  75 #define ALL_TARGETS_MASK 0xFFFF
  76 #define INITIATOR_WILDCARD      (~0)
  77 #define SCB_LIST_NULL           0xFF00
  78 #define SCB_LIST_NULL_LE        (aic_htole16(SCB_LIST_NULL))
  79 #define QOUTFIFO_ENTRY_VALID 0x80
  80 #define SCBID_IS_NULL(scbid) (((scbid) & 0xFF00 ) == SCB_LIST_NULL)
  81
  82 #define SCSIID_TARGET(ahd, scsiid)      \
  83         (((scsiid) & TID) >> TID_SHIFT)
  84 #define SCSIID_OUR_ID(scsiid)           \
  85         ((scsiid) & OID)
  86 #define SCSIID_CHANNEL(ahd, scsiid) ('A')
  87 #define SCB_IS_SCSIBUS_B(ahd, scb) (0)
  88 #define SCB_GET_OUR_ID(scb) \
  89         SCSIID_OUR_ID((scb)->hscb->scsiid)
  90 #define SCB_GET_TARGET(ahd, scb) \
  91         SCSIID_TARGET((ahd), (scb)->hscb->scsiid)
  92 #define SCB_GET_CHANNEL(ahd, scb) \
  93         SCSIID_CHANNEL(ahd, (scb)->hscb->scsiid)
  94 #define SCB_GET_LUN(scb) \
  95         ((scb)->hscb->lun)
  96 #define SCB_GET_TARGET_OFFSET(ahd, scb) \
  97         SCB_GET_TARGET(ahd, scb)
  98 #define SCB_GET_TARGET_MASK(ahd, scb) \
  99         (0x01 << (SCB_GET_TARGET_OFFSET(ahd, scb)))
 100 #ifdef AHD_DEBUG
 101 #define SCB_IS_SILENT(scb)                                      \
 102         ((ahd_debug & AHD_SHOW_MASKED_ERRORS) == 0              \
 103       && (((scb)->flags & SCB_SILENT) != 0))
 104 #else
 105 #define SCB_IS_SILENT(scb)                                      \
 106         (((scb)->flags & SCB_SILENT) != 0)
 107 #endif
 108 /*
 109  * TCLs have the following format: TTTTLLLLLLLL
 110  */
 111 #define TCL_TARGET_OFFSET(tcl) \
 112         ((((tcl) >> 4) & TID) >> 4)
 113 #define TCL_LUN(tcl) \
 114         (tcl & (AHD_NUM_LUNS - 1))
 115 #define BUILD_TCL(scsiid, lun) \
 116         ((lun) | (((scsiid) & TID) << 4))
 117 #define BUILD_TCL_RAW(target, channel, lun) \
 118         ((lun) | ((target) << 8))
 119
 120 #define SCB_GET_TAG(scb) \
 121         aic_le16toh(scb->hscb->tag)
 122
 123 #ifndef AHD_TARGET_MODE
 124 #undef  AHD_TMODE_ENABLE
 125 #define AHD_TMODE_ENABLE 0
 126 #endif
 127
 128 #define AHD_BUILD_COL_IDX(target, lun)                          \
 129         (((lun) << 4) | target)
 130
 131 #define AHD_GET_SCB_COL_IDX(ahd, scb)                           \
 132         ((SCB_GET_LUN(scb) << 4) | SCB_GET_TARGET(ahd, scb))
 133
 134 #define AHD_SET_SCB_COL_IDX(scb, col_idx)                               \
 135 do {                                                                    \
 136         (scb)->hscb->scsiid = ((col_idx) << TID_SHIFT) & TID;           \
 137         (scb)->hscb->lun = ((col_idx) >> 4) & (AHD_NUM_LUNS_NONPKT-1);  \
 138 } while (0)
 139
 140 #define AHD_COPY_SCB_COL_IDX(dst, src)                          \
 141 do {                                                            \
 142         dst->hscb->scsiid = src->hscb->scsiid;                  \
 143         dst->hscb->lun = src->hscb->lun;                        \
 144 } while (0)
 145
 146 #define AHD_NEVER_COL_IDX 0xFFFF
 147
 148 /**************************** Driver Constants ********************************/
 149 /*
 150  * The maximum number of supported targets.
 151  */
 152 #define AHD_NUM_TARGETS 16
 153
 154 /*
 155  * The maximum number of supported luns.
 156  * The identify message only supports 64 luns in non-packetized transfers.
 157  * You can have 2^64 luns when information unit transfers are enabled,
 158  * but until we see a need to support that many, we support 256.
 159  */
 160 #define AHD_NUM_LUNS_NONPKT 64
 161 #define AHD_NUM_LUNS 256
 162
 163 /*
 164  * The maximum transfer per S/G segment.
 165  */
 166 #define AHD_MAXTRANSFER_SIZE     0x00ffffff     /* limited by 24bit counter */
 167
 168 /*
 169  * The maximum amount of SCB storage in hardware on a controller.
 170  * This value represents an upper bound.  Due to software design,
 171  * we may not be able to use this number.
 172  */
 173 #define AHD_SCB_MAX     512
 174
 175 /*
 176  * The maximum number of concurrent transactions supported per driver instance.
 177  * Sequencer Control Blocks (SCBs) store per-transaction information.
 178  */
 179 #define AHD_MAX_QUEUE   AHD_SCB_MAX
 180
 181 /*
 182  * Define the size of our QIN and QOUT FIFOs.  They must be a power of 2
 183  * in size and accommodate as many transactions as can be queued concurrently.
 184  */
 185 #define AHD_QIN_SIZE    AHD_MAX_QUEUE
 186 #define AHD_QOUT_SIZE   AHD_MAX_QUEUE
 187
 188 #define AHD_QIN_WRAP(x) ((x) & (AHD_QIN_SIZE-1))
 189 /*
 190  * The maximum amount of SCB storage we allocate in host memory.
 191  */
 192 #define AHD_SCB_MAX_ALLOC AHD_MAX_QUEUE
 193
 194 /*
 195  * Ring Buffer of incoming target commands.
 196  * We allocate 256 to simplify the logic in the sequencer
 197  * by using the natural wrap point of an 8bit counter.
 198  */
 199 #define AHD_TMODE_CMDS  256
 200
 201 /* Reset line assertion time in us */
 202 #define AHD_BUSRESET_DELAY      25
 203
 204 /******************* Chip Characteristics/Operating Settings  *****************/
 205 extern uint32_t ahd_attach_to_HostRAID_controllers;
 206
 207 /*
 208  * Chip Type
 209  * The chip order is from least sophisticated to most sophisticated.
 210  */
 211 typedef enum {
 212         AHD_NONE        = 0x0000,
 213         AHD_CHIPID_MASK = 0x00FF,
 214         AHD_AIC7901     = 0x0001,
 215         AHD_AIC7902     = 0x0002,
 216         AHD_AIC7901A    = 0x0003,
 217         AHD_PCI         = 0x0100,       /* Bus type PCI */
 218         AHD_PCIX        = 0x0200,       /* Bus type PCIX */
 219         AHD_BUS_MASK    = 0x0F00
 220 } ahd_chip;
 221
 222 /*
 223  * Features available in each chip type.
 224  */
 225 typedef enum {
 226         AHD_FENONE              = 0x00000,
 227         AHD_WIDE                = 0x00001,/* Wide Channel */
 228         AHD_MULTI_FUNC          = 0x00100,/* Multi-Function/Channel Device */
 229         AHD_TARGETMODE          = 0x01000,/* Has tested target mode support */
 230         AHD_MULTIROLE           = 0x02000,/* Space for two roles at a time */
 231         AHD_RTI                 = 0x04000,/* Retained Training Support */
 232         AHD_NEW_IOCELL_OPTS     = 0x08000,/* More Signal knobs in the IOCELL */
 233         AHD_NEW_DFCNTRL_OPTS    = 0x10000,/* SCSIENWRDIS bit */
 234         AHD_FAST_CDB_DELIVERY   = 0x20000,/* CDB acks released to Output Sync */
 235         AHD_REMOVABLE           = 0x00000,/* Hot-Swap supported - None so far*/
 236         AHD_AIC7901_FE          = AHD_FENONE,
 237         AHD_AIC7901A_FE         = AHD_FENONE,
 238         AHD_AIC7902_FE          = AHD_MULTI_FUNC
 239 } ahd_feature;
 240
 241 /*
 242  * Bugs in the silicon that we work around in software.
 243  */
 244 typedef enum {
 245         AHD_BUGNONE             = 0x0000,
 246         /*
 247          * Rev A hardware fails to update LAST/CURR/NEXTSCB
 248          * correctly in certain packetized selection cases.
 249          */
 250         AHD_SENT_SCB_UPDATE_BUG = 0x0001,
 251         /* The wrong SCB is accessed to check the abort pending bit. */
 252         AHD_ABORT_LQI_BUG       = 0x0002,
 253         /* Packetized bitbucket crosses packet boundaries. */
 254         AHD_PKT_BITBUCKET_BUG   = 0x0004,
 255         /* The selection timer runs twice as long as its setting. */
 256         AHD_LONG_SETIMO_BUG     = 0x0008,
 257         /* The Non-LQ CRC error status is delayed until phase change. */
 258         AHD_NLQICRC_DELAYED_BUG = 0x0010,
 259         /* The chip must be reset for all outgoing bus resets.  */
 260         AHD_SCSIRST_BUG         = 0x0020,
 261         /* Some PCIX fields must be saved and restored across chip reset. */
 262         AHD_PCIX_CHIPRST_BUG    = 0x0040,
 263         /* MMAPIO is not functional in PCI-X mode.  */
 264         AHD_PCIX_MMAPIO_BUG     = 0x0080,
 265         /* Reads to SCBRAM fail to reset the discard timer. */
 266         AHD_PCIX_SCBRAM_RD_BUG  = 0x0100,
 267         /* Bug workarounds that can be disabled on non-PCIX busses. */
 268         AHD_PCIX_BUG_MASK       = AHD_PCIX_CHIPRST_BUG
 269                                 | AHD_PCIX_MMAPIO_BUG
 270                                 | AHD_PCIX_SCBRAM_RD_BUG,
 271         /*
 272          * LQOSTOP0 status set even for forced selections with ATN
 273          * to perform non-packetized message delivery.
 274          */
 275         AHD_LQO_ATNO_BUG        = 0x0200,
 276         /* FIFO auto-flush does not always trigger.  */
 277         AHD_AUTOFLUSH_BUG       = 0x0400,
 278         /* The CLRLQO registers are not self-clearing. */
 279         AHD_CLRLQO_AUTOCLR_BUG  = 0x0800,
 280         /* The PACKETIZED status bit refers to the previous connection. */
 281         AHD_PKTIZED_STATUS_BUG  = 0x1000,
 282         /* "Short Luns" are not placed into outgoing LQ packets correctly. */
 283         AHD_PKT_LUN_BUG         = 0x2000,
 284         /*
 285          * Only the FIFO allocated to the non-packetized connection may
 286          * be in use during a non-packetzied connection.
 287          */
 288         AHD_NONPACKFIFO_BUG     = 0x4000,
 289         /*
 290          * Writing to a DFF SCBPTR register may fail if concurent with
 291          * a hardware write to the other DFF SCBPTR register.  This is
 292          * not currently a concern in our sequencer since all chips with
 293          * this bug have the AHD_NONPACKFIFO_BUG and all writes of concern
 294          * occur in non-packetized connections.
 295          */
 296         AHD_MDFF_WSCBPTR_BUG    = 0x8000,
 297         /* SGHADDR updates are slow. */
 298         AHD_REG_SLOW_SETTLE_BUG = 0x10000,
 299         /*
 300          * Changing the MODE_PTR coincident with an interrupt that
 301          * switches to a different mode will cause the interrupt to
 302          * be in the mode written outside of interrupt context.
 303          */
 304         AHD_SET_MODE_BUG        = 0x20000,
 305         /* Non-packetized busfree revision does not work. */
 306         AHD_BUSFREEREV_BUG      = 0x40000,
 307         /*
 308          * Paced transfers are indicated with a non-standard PPR
 309          * option bit in the neg table, 160MHz is indicated by
 310          * sync factor 0x7, and the offset if off by a factor of 2.
 311          */
 312         AHD_PACED_NEGTABLE_BUG  = 0x80000,
 313         /* LQOOVERRUN false positives. */
 314         AHD_LQOOVERRUN_BUG      = 0x100000,
 315         /*
 316          * Controller write to INTSTAT will lose to a host
 317          * write to CLRINT.
 318          */
 319         AHD_INTCOLLISION_BUG    = 0x200000,
 320         /*
 321          * The GEM318 violates the SCSI spec by not waiting
 322          * the mandated bus settle delay between phase changes
 323          * in some situations.  Some aic79xx chip revs. are more
 324          * strict in this regard and will treat REQ assertions
 325          * that fall within the bus settle delay window as
 326          * glitches.  This flag tells the firmware to tolerate
 327          * early REQ assertions.
 328          */
 329         AHD_EARLY_REQ_BUG       = 0x400000,
 330         /*
 331          * The LED does not stay on long enough in packetized modes.
 332          */
 333         AHD_FAINT_LED_BUG       = 0x800000
 334 } ahd_bug;
 335
 336 /*
 337  * Configuration specific settings.
 338  * The driver determines these settings by probing the
 339  * chip/controller's configuration.
 340  */
 341 typedef enum {
 342         AHD_FNONE             = 0x00000,
 343         AHD_BOOT_CHANNEL      = 0x00001,/* We were set as the boot channel. */
 344         AHD_USEDEFAULTS       = 0x00004,/*
 345                                          * For cards without an seeprom
 346                                          * or a BIOS to initialize the chip's
 347                                          * SRAM, we use the default target
 348                                          * settings.
 349                                          */
 350         AHD_SEQUENCER_DEBUG   = 0x00008,
 351         AHD_RESET_BUS_A       = 0x00010,
 352         AHD_EXTENDED_TRANS_A  = 0x00020,
 353         AHD_TERM_ENB_A        = 0x00040,
 354         AHD_SPCHK_ENB_A       = 0x00080,
 355         AHD_STPWLEVEL_A       = 0x00100,
 356         AHD_INITIATORROLE     = 0x00200,/*
 357                                          * Allow initiator operations on
 358                                          * this controller.
 359                                          */
 360         AHD_TARGETROLE        = 0x00400,/*
 361                                          * Allow target operations on this
 362                                          * controller.
 363                                          */
 364         AHD_RESOURCE_SHORTAGE = 0x00800,
 365         AHD_TQINFIFO_BLOCKED  = 0x01000,/* Blocked waiting for ATIOs */
 366         AHD_INT50_SPEEDFLEX   = 0x02000,/*
 367                                          * Internal 50pin connector
 368                                          * sits behind an aic3860
 369                                          */
 370         AHD_BIOS_ENABLED      = 0x04000,
 371         AHD_ALL_INTERRUPTS    = 0x08000,
 372         AHD_39BIT_ADDRESSING  = 0x10000,/* Use 39 bit addressing scheme. */
 373         AHD_64BIT_ADDRESSING  = 0x20000,/* Use 64 bit addressing scheme. */
 374         AHD_CURRENT_SENSING   = 0x40000,
 375         AHD_SCB_CONFIG_USED   = 0x80000,/* No SEEPROM but SCB had info. */
 376         AHD_HP_BOARD          = 0x100000,
 377         AHD_RESET_POLL_ACTIVE = 0x200000,
 378         AHD_UPDATE_PEND_CMDS  = 0x400000,
 379         AHD_RUNNING_QOUTFIFO  = 0x800000,
 380         AHD_HAD_FIRST_SEL     = 0x1000000,
 381         AHD_SHUTDOWN_RECOVERY = 0x2000000, /* Terminate recovery thread. */
 382         AHD_HOSTRAID_BOARD    = 0x4000000
 383 } ahd_flag;
 384
 385 /************************* Hardware  SCB Definition ***************************/
 386
 387 /*
 388  * The driver keeps up to MAX_SCB scb structures per card in memory.  The SCB
 389  * consists of a "hardware SCB" mirroring the fields available on the card
 390  * and additional information the kernel stores for each transaction.
 391  *
 392  * To minimize space utilization, a portion of the hardware scb stores
 393  * different data during different portions of a SCSI transaction.
 394  * As initialized by the host driver for the initiator role, this area
 395  * contains the SCSI cdb (or a pointer to the  cdb) to be executed.  After
 396  * the cdb has been presented to the target, this area serves to store
 397  * residual transfer information and the SCSI status byte.
 398  * For the target role, the contents of this area do not change, but
 399  * still serve a different purpose than for the initiator role.  See
 400  * struct target_data for details.
 401  */
 402
 403 /*
 404  * Status information embedded in the shared poriton of
 405  * an SCB after passing the cdb to the target.  The kernel
 406  * driver will only read this data for transactions that
 407  * complete abnormally.
 408  */
 409 struct initiator_status {
 410         uint32_t residual_datacnt;      /* Residual in the current S/G seg */
 411         uint32_t residual_sgptr;        /* The next S/G for this transfer */
 412         uint8_t  scsi_status;           /* Standard SCSI status byte */
 413 };
 414
 415 struct target_status {
 416         uint32_t residual_datacnt;      /* Residual in the current S/G seg */
 417         uint32_t residual_sgptr;        /* The next S/G for this transfer */
 418         uint8_t  scsi_status;           /* SCSI status to give to initiator */
 419         uint8_t  target_phases;         /* Bitmap of phases to execute */
 420         uint8_t  data_phase;            /* Data-In or Data-Out */
 421         uint8_t  initiator_tag;         /* Initiator's transaction tag */
 422 };
 423
 424 /*
 425  * Initiator mode SCB shared data area.
 426  * If the embedded CDB is 12 bytes or less, we embed
 427  * the sense buffer address in the SCB.  This allows
 428  * us to retrieve sense information without interrupting
 429  * the host in packetized mode.
 430  */
 431 typedef uint32_t sense_addr_t;
 432 #define MAX_CDB_LEN 16
 433 #define MAX_CDB_LEN_WITH_SENSE_ADDR (MAX_CDB_LEN - sizeof(sense_addr_t))
 434 union initiator_data {
 435         struct {
 436                 uint64_t cdbptr;
 437                 uint8_t  cdblen;
 438         } cdb_from_host;
 439         uint8_t  cdb[MAX_CDB_LEN];
 440         struct {
 441                 uint8_t  cdb[MAX_CDB_LEN_WITH_SENSE_ADDR];
 442                 sense_addr_t sense_addr;
 443         } cdb_plus_saddr;
 444 };
 445
 446 /*
 447  * Target mode version of the shared data SCB segment.
 448  */
 449 struct target_data {
 450         uint32_t spare[2];
 451         uint8_t  scsi_status;           /* SCSI status to give to initiator */
 452         uint8_t  target_phases;         /* Bitmap of phases to execute */
 453         uint8_t  data_phase;            /* Data-In or Data-Out */
 454         uint8_t  initiator_tag;         /* Initiator's transaction tag */
 455 };
 456
 457 struct hardware_scb {
 458 /*0*/   union {
 459                 union   initiator_data idata;
 460                 struct  target_data tdata;
 461                 struct  initiator_status istatus;
 462                 struct  target_status tstatus;
 463         } shared_data;
 464 /*
 465  * A word about residuals.
 466  * The scb is presented to the sequencer with the dataptr and datacnt
 467  * fields initialized to the contents of the first S/G element to
 468  * transfer.  The sgptr field is initialized to the bus address for
 469  * the S/G element that follows the first in the in core S/G array
 470  * or'ed with the SG_FULL_RESID flag.  Sgptr may point to an invalid
 471  * S/G entry for this transfer (single S/G element transfer with the
 472  * first elements address and length preloaded in the dataptr/datacnt
 473  * fields).  If no transfer is to occur, sgptr is set to SG_LIST_NULL.
 474  * The SG_FULL_RESID flag ensures that the residual will be correctly
 475  * noted even if no data transfers occur.  Once the data phase is entered,
 476  * the residual sgptr and datacnt are loaded from the sgptr and the
 477  * datacnt fields.  After each S/G element's dataptr and length are
 478  * loaded into the hardware, the residual sgptr is advanced.  After
 479  * each S/G element is expired, its datacnt field is checked to see
 480  * if the LAST_SEG flag is set.  If so, SG_LIST_NULL is set in the
 481  * residual sg ptr and the transfer is considered complete.  If the
 482  * sequencer determines that there is a residual in the tranfer, or
 483  * there is non-zero status, it will set the SG_STATUS_VALID flag in
 484  * sgptr and dma the scb back into host memory.  To sumarize:
 485  *
 486  * Sequencer:
 487  *      o A residual has occurred if SG_FULL_RESID is set in sgptr,
 488  *        or residual_sgptr does not have SG_LIST_NULL set.
 489  *
 490  *      o We are transfering the last segment if residual_datacnt has
 491  *        the SG_LAST_SEG flag set.
 492  *
 493  * Host:
 494  *      o A residual can only have occurred if a completed scb has the
 495  *        SG_STATUS_VALID flag set.  Inspection of the SCSI status field,
 496  *        the residual_datacnt, and the residual_sgptr field will tell
 497  *        for sure.
 498  *
 499  *      o residual_sgptr and sgptr refer to the "next" sg entry
 500  *        and so may point beyond the last valid sg entry for the
 501  *        transfer.
 502  */
 503 #define SG_PTR_MASK     0xFFFFFFF8
 504 /*16*/  uint16_t tag;           /* Reused by Sequencer. */
 505 /*18*/  uint8_t  control;       /* See SCB_CONTROL in aic79xx.reg for details */
 506 /*19*/  uint8_t  scsiid;        /*
 507                                  * Selection out Id
 508                                  * Our Id (bits 0-3) Their ID (bits 4-7)
 509                                  */
 510 /*20*/  uint8_t  lun;
 511 /*21*/  uint8_t  task_attribute;
 512 /*22*/  uint8_t  cdb_len;
 513 /*23*/  uint8_t  task_management;
 514 /*24*/  uint64_t dataptr;
 515 /*32*/  uint32_t datacnt;       /* Byte 3 is spare. */
 516 /*36*/  uint32_t sgptr;
 517 /*40*/  uint32_t hscb_busaddr;
 518 /*44*/  uint32_t next_hscb_busaddr;
 519 /********** Long lun field only downloaded for full 8 byte lun support ********/
 520 /*48*/  uint8_t  pkt_long_lun[8];
 521 /******* Fields below are not Downloaded (Sequencer may use for scratch) ******/
 522 /*56*/  uint8_t  spare[8];
 523 };
 524
 525 /************************ Kernel SCB Definitions ******************************/
 526 /*
 527  * Some fields of the SCB are OS dependent.  Here we collect the
 528  * definitions for elements that all OS platforms need to include
 529  * in there SCB definition.
 530  */
 531
 532 /*
 533  * Definition of a scatter/gather element as transfered to the controller.
 534  * The aic7xxx chips only support a 24bit length.  We use the top byte of
 535  * the length to store additional address bits and a flag to indicate
 536  * that a given segment terminates the transfer.  This gives us an
 537  * addressable range of 512GB on machines with 64bit PCI or with chips
 538  * that can support dual address cycles on 32bit PCI busses.
 539  */
 540 struct ahd_dma_seg {
 541         uint32_t        addr;
 542         uint32_t        len;
 543 #define AHD_DMA_LAST_SEG        0x80000000
 544 #define AHD_SG_HIGH_ADDR_MASK   0x7F000000
 545 #define AHD_SG_LEN_MASK         0x00FFFFFF
 546 };
 547
 548 struct ahd_dma64_seg {
 549         uint64_t        addr;
 550         uint32_t        len;
 551         uint32_t        pad;
 552 };
 553
 554 struct map_node {
 555         bus_dmamap_t             dmamap;
 556         bus_addr_t               busaddr;
 557         uint8_t                 *vaddr;
 558         SLIST_ENTRY(map_node)    links;
 559 };
 560
 561 /*
 562  * The current state of this SCB.
 563  */
 564 typedef enum {
 565         SCB_FLAG_NONE           = 0x00000,
 566         SCB_TRANSMISSION_ERROR  = 0x00001,/*
 567                                            * We detected a parity or CRC
 568                                            * error that has effected the
 569                                            * payload of the command.  This
 570                                            * flag is checked when normal
 571                                            * status is returned to catch
 572                                            * the case of a target not
 573                                            * responding to our attempt
 574                                            * to report the error.
 575                                            */
 576         SCB_OTHERTCL_TIMEOUT    = 0x00002,/*
 577                                            * Another device was active
 578                                            * during the first timeout for
 579                                            * this SCB so we gave ourselves
 580                                            * an additional timeout period
 581                                            * in case it was hogging the
 582                                            * bus.
 583                                            */
 584         SCB_DEVICE_RESET        = 0x00004,
 585         SCB_SENSE               = 0x00008,
 586         SCB_CDB32_PTR           = 0x00010,
 587         SCB_RECOVERY_SCB        = 0x00020,
 588         SCB_AUTO_NEGOTIATE      = 0x00040,/* Negotiate to achieve goal. */
 589         SCB_NEGOTIATE           = 0x00080,/* Negotiation forced for command. */
 590         SCB_ABORT               = 0x00100,
 591         SCB_ACTIVE              = 0x00200,
 592         SCB_TARGET_IMMEDIATE    = 0x00400,
 593         SCB_PACKETIZED          = 0x00800,
 594         SCB_EXPECT_PPR_BUSFREE  = 0x01000,
 595         SCB_PKT_SENSE           = 0x02000,
 596         SCB_CMDPHASE_ABORT      = 0x04000,
 597         SCB_ON_COL_LIST         = 0x08000,
 598         SCB_SILENT              = 0x10000,/*
 599                                            * Be quiet about transmission type
 600                                            * errors.  They are expected and we
 601                                            * don't want to upset the user.  This
 602                                            * flag is typically used during DV.
 603                                            */
 604         SCB_TIMEDOUT            = 0x20000/*
 605                                           * SCB has timed out and is on the
 606                                           * timedout list.
 607                                           */
 608 } scb_flag;
 609
 610 struct scb {
 611         struct  hardware_scb     *hscb;
 612         union {
 613                 SLIST_ENTRY(scb)  sle;
 614                 LIST_ENTRY(scb)   le;
 615                 TAILQ_ENTRY(scb)  tqe;
 616         } links;
 617         union {
 618                 SLIST_ENTRY(scb)  sle;
 619                 LIST_ENTRY(scb)   le;
 620                 TAILQ_ENTRY(scb)  tqe;
 621         } links2;
 622 #define pending_links links2.le
 623 #define collision_links links2.le
 624         LIST_ENTRY(scb)           timedout_links;
 625         struct scb               *col_scb;
 626         aic_io_ctx_t              io_ctx;
 627         struct ahd_softc         *ahd_softc;
 628         scb_flag                  flags;
 629 #ifndef __linux__
 630         bus_dmamap_t              dmamap;
 631 #endif
 632         struct scb_platform_data *platform_data;
 633         struct map_node          *hscb_map;
 634         struct map_node          *sg_map;
 635         struct map_node          *sense_map;
 636         void                     *sg_list;
 637         uint8_t                  *sense_data;
 638         bus_addr_t                sg_list_busaddr;
 639         bus_addr_t                sense_busaddr;
 640         u_int                     sg_count;/* How full ahd_dma_seg is */
 641 #define AHD_MAX_LQ_CRC_ERRORS 5
 642         u_int                     crc_retry_count;
 643 };
 644
 645 TAILQ_HEAD(scb_tailq, scb);
 646 LIST_HEAD(scb_list, scb);
 647
 648 struct scb_data {
 649         /*
 650          * TAILQ of lists of free SCBs grouped by device
 651          * collision domains.
 652          */
 653         struct scb_tailq free_scbs;
 654
 655         /*
 656          * Per-device lists of SCBs whose tag ID would collide
 657          * with an already active tag on the device.
 658          */
 659         struct scb_list free_scb_lists[AHD_NUM_TARGETS * AHD_NUM_LUNS_NONPKT];
 660
 661         /*
 662          * SCBs that will not collide with any active device.
 663          */
 664         struct scb_list any_dev_free_scb_list;
 665
 666         /*
 667          * Mapping from tag to SCB.
 668          */
 669         struct  scb *scbindex[AHD_SCB_MAX];
 670
 671         u_int            recovery_scbs; /* Transactions currently in recovery */
 672
 673         /*
 674          * "Bus" addresses of our data structures.
 675          */
 676         bus_dma_tag_t    hscb_dmat;     /* dmat for our hardware SCB array */
 677         bus_dma_tag_t    sg_dmat;       /* dmat for our sg segments */
 678         bus_dma_tag_t    sense_dmat;    /* dmat for our sense buffers */
 679
 680         SLIST_HEAD(, map_node) hscb_maps;
 681         SLIST_HEAD(, map_node) sg_maps;
 682         SLIST_HEAD(, map_node) sense_maps;
 683         int              scbs_left;     /* unallocated scbs in head map_node */
 684         int              sgs_left;      /* unallocated sgs in head map_node */
 685         int              sense_left;    /* unallocated sense in head map_node */
 686         uint16_t         numscbs;
 687         uint16_t         maxhscbs;      /* Number of SCBs on the card */
 688         uint8_t          init_level;    /*
 689                                          * How far we've initialized
 690                                          * this structure.
 691                                          */
 692 };
 693
 694 /************************ Target Mode Definitions *****************************/
 695
 696 /*
 697  * Connection desciptor for select-in requests in target mode.
 698  */
 699 struct target_cmd {
 700         uint8_t scsiid;         /* Our ID and the initiator's ID */
 701         uint8_t identify;       /* Identify message */
 702         uint8_t bytes[22];      /*
 703                                  * Bytes contains any additional message
 704                                  * bytes terminated by 0xFF.  The remainder
 705                                  * is the cdb to execute.
 706                                  */
 707         uint8_t cmd_valid;      /*
 708                                  * When a command is complete, the firmware
 709                                  * will set cmd_valid to all bits set.
 710                                  * After the host has seen the command,
 711                                  * the bits are cleared.  This allows us
 712                                  * to just peek at host memory to determine
 713                                  * if more work is complete. cmd_valid is on
 714                                  * an 8 byte boundary to simplify setting
 715                                  * it on aic7880 hardware which only has
 716                                  * limited direct access to the DMA FIFO.
 717                                  */
 718         uint8_t pad[7];
 719 };
 720
 721 /*
 722  * Number of events we can buffer up if we run out
 723  * of immediate notify ccbs.
 724  */
 725 #define AHD_TMODE_EVENT_BUFFER_SIZE 8
 726 struct ahd_tmode_event {
 727         uint8_t initiator_id;
 728         uint8_t event_type;     /* MSG type or EVENT_TYPE_BUS_RESET */
 729 #define EVENT_TYPE_BUS_RESET 0xFF
 730         uint8_t event_arg;
 731 };
 732
 733 /*
 734  * Per enabled lun target mode state.
 735  * As this state is directly influenced by the host OS'es target mode
 736  * environment, we let the OS module define it.  Forward declare the
 737  * structure here so we can store arrays of them, etc. in OS neutral
 738  * data structures.
 739  */
 740 #ifdef AHD_TARGET_MODE
 741 struct ahd_tmode_lstate {
 742         struct cam_path *path;
 743         struct ccb_hdr_slist accept_tios;
 744         struct ccb_hdr_slist immed_notifies;
 745         struct ahd_tmode_event event_buffer[AHD_TMODE_EVENT_BUFFER_SIZE];
 746         uint8_t event_r_idx;
 747         uint8_t event_w_idx;
 748 };
 749 #else
 750 struct ahd_tmode_lstate;
 751 #endif
 752
 753 /******************** Transfer Negotiation Datastructures *********************/
 754 #define AHD_TRANS_CUR           0x01    /* Modify current neogtiation status */
 755 #define AHD_TRANS_ACTIVE        0x03    /* Assume this target is on the bus */
 756 #define AHD_TRANS_GOAL          0x04    /* Modify negotiation goal */
 757 #define AHD_TRANS_USER          0x08    /* Modify user negotiation settings */
 758 #define AHD_PERIOD_10MHz        0x19
 759
 760 #define AHD_WIDTH_UNKNOWN       0xFF
 761 #define AHD_PERIOD_UNKNOWN      0xFF
 762 #define AHD_OFFSET_UNKNOWN      0xFF
 763 #define AHD_PPR_OPTS_UNKNOWN    0xFF
 764
 765 /*
 766  * Transfer Negotiation Information.
 767  */
 768 struct ahd_transinfo {
 769         uint8_t protocol_version;       /* SCSI Revision level */
 770         uint8_t transport_version;      /* SPI Revision level */
 771         uint8_t width;                  /* Bus width */
 772         uint8_t period;                 /* Sync rate factor */
 773         uint8_t offset;                 /* Sync offset */
 774         uint8_t ppr_options;            /* Parallel Protocol Request options */
 775 };
 776
 777 /*
 778  * Per-initiator current, goal and user transfer negotiation information. */
 779 struct ahd_initiator_tinfo {
 780         struct ahd_transinfo curr;
 781         struct ahd_transinfo goal;
 782         struct ahd_transinfo user;
 783 };
 784
 785 /*
 786  * Per enabled target ID state.
 787  * Pointers to lun target state as well as sync/wide negotiation information
 788  * for each initiator<->target mapping.  For the initiator role we pretend
 789  * that we are the target and the targets are the initiators since the
 790  * negotiation is the same regardless of role.
 791  */
 792 struct ahd_tmode_tstate {
 793         struct ahd_tmode_lstate*        enabled_luns[AHD_NUM_LUNS];
 794         struct ahd_initiator_tinfo      transinfo[AHD_NUM_TARGETS];
 795
 796         /*
 797          * Per initiator state bitmasks.
 798          */
 799         uint16_t         auto_negotiate;/* Auto Negotiation Required */
 800         uint16_t         discenable;    /* Disconnection allowed  */
 801         uint16_t         tagenable;     /* Tagged Queuing allowed */
 802 };
 803
 804 /*
 805  * Points of interest along the negotiated transfer scale.
 806  */
 807 #define AHD_SYNCRATE_160        0x8
 808 #define AHD_SYNCRATE_PACED      0x8
 809 #define AHD_SYNCRATE_DT         0x9
 810 #define AHD_SYNCRATE_ULTRA2     0xa
 811 #define AHD_SYNCRATE_ULTRA      0xc
 812 #define AHD_SYNCRATE_FAST       0x19
 813 #define AHD_SYNCRATE_MIN_DT     AHD_SYNCRATE_FAST
 814 #define AHD_SYNCRATE_SYNC       0x32
 815 #define AHD_SYNCRATE_MIN        0x60
 816 #define AHD_SYNCRATE_ASYNC      0xFF
 817 #define AHD_SYNCRATE_MAX        AHD_SYNCRATE_160
 818
 819 /* Safe and valid period for async negotiations. */
 820 #define AHD_ASYNC_XFER_PERIOD   0x44
 821
 822 /*
 823  * In RevA, the synctable uses a 120MHz rate for the period
 824  * factor 8 and 160MHz for the period factor 7.  The 120MHz
 825  * rate never made it into the official SCSI spec, so we must
 826  * compensate when setting the negotiation table for Rev A
 827  * parts.
 828  */
 829 #define AHD_SYNCRATE_REVA_120   0x8
 830 #define AHD_SYNCRATE_REVA_160   0x7
 831
 832 /***************************** Lookup Tables **********************************/
 833 /*
 834  * Phase -> name and message out response
 835  * to parity errors in each phase table.
 836  */
 837 struct ahd_phase_table_entry {
 838         uint8_t phase;
 839         uint8_t mesg_out; /* Message response to parity errors */
 840         char *phasemsg;
 841 };
 842
 843 /************************** Serial EEPROM Format ******************************/
 844
 845 struct seeprom_config {
 846 /*
 847  * Per SCSI ID Configuration Flags
 848  */
 849         uint16_t device_flags[16];      /* words 0-15 */
 850 #define         CFXFER          0x003F  /* synchronous transfer rate */
 851 #define                 CFXFER_ASYNC    0x3F
 852 #define         CFQAS           0x0040  /* Negotiate QAS */
 853 #define         CFPACKETIZED    0x0080  /* Negotiate Packetized Transfers */
 854 #define         CFSTART         0x0100  /* send start unit SCSI command */
 855 #define         CFINCBIOS       0x0200  /* include in BIOS scan */
 856 #define         CFDISC          0x0400  /* enable disconnection */
 857 #define         CFMULTILUNDEV   0x0800  /* Probe multiple luns in BIOS scan */
 858 #define         CFWIDEB         0x1000  /* wide bus device */
 859 #define         CFHOSTMANAGED   0x8000  /* Managed by a RAID controller */
 860
 861 /*
 862  * BIOS Control Bits
 863  */
 864         uint16_t bios_control;          /* word 16 */
 865 #define         CFSUPREM        0x0001  /* support all removeable drives */
 866 #define         CFSUPREMB       0x0002  /* support removeable boot drives */
 867 #define         CFBIOSSTATE     0x000C  /* BIOS Action State */
 868 #define             CFBS_DISABLED       0x00
 869 #define             CFBS_ENABLED        0x04
 870 #define             CFBS_DISABLED_SCAN  0x08
 871 #define         CFENABLEDV      0x0010  /* Perform Domain Validation */
 872 #define         CFCTRL_A        0x0020  /* BIOS displays Ctrl-A message */
 873 #define         CFSPARITY       0x0040  /* SCSI parity */
 874 #define         CFEXTEND        0x0080  /* extended translation enabled */
 875 #define         CFBOOTCD        0x0100  /* Support Bootable CD-ROM */
 876 #define         CFMSG_LEVEL     0x0600  /* BIOS Message Level */
 877 #define                 CFMSG_VERBOSE   0x0000
 878 #define                 CFMSG_SILENT    0x0200
 879 #define                 CFMSG_DIAG      0x0400
 880 #define         CFRESETB        0x0800  /* reset SCSI bus at boot */
 881 /*              UNUSED          0xf000  */
 882
 883 /*
 884  * Host Adapter Control Bits
 885  */
 886         uint16_t adapter_control;       /* word 17 */
 887 #define         CFAUTOTERM      0x0001  /* Perform Auto termination */
 888 #define         CFSTERM         0x0002  /* SCSI low byte termination */
 889 #define         CFWSTERM        0x0004  /* SCSI high byte termination */
 890 #define         CFSEAUTOTERM    0x0008  /* Ultra2 Perform secondary Auto Term*/
 891 #define         CFSELOWTERM     0x0010  /* Ultra2 secondary low term */
 892 #define         CFSEHIGHTERM    0x0020  /* Ultra2 secondary high term */
 893 #define         CFSTPWLEVEL     0x0040  /* Termination level control */
 894 #define         CFBIOSAUTOTERM  0x0080  /* Perform Auto termination */
 895 #define         CFTERM_MENU     0x0100  /* BIOS displays termination menu */
 896 #define         CFCLUSTERENB    0x8000  /* Cluster Enable */
 897
 898 /*
 899  * Bus Release Time, Host Adapter ID
 900  */
 901         uint16_t brtime_id;             /* word 18 */
 902 #define         CFSCSIID        0x000f  /* host adapter SCSI ID */
 903 /*              UNUSED          0x00f0  */
 904 #define         CFBRTIME        0xff00  /* bus release time/PCI Latency Time */
 905
 906 /*
 907  * Maximum targets
 908  */
 909         uint16_t max_targets;           /* word 19 */
 910 #define         CFMAXTARG       0x00ff  /* maximum targets */
 911 #define         CFBOOTLUN       0x0f00  /* Lun to boot from */
 912 #define         CFBOOTID        0xf000  /* Target to boot from */
 913         uint16_t res_1[10];             /* words 20-29 */
 914         uint16_t signature;             /* BIOS Signature */
 915 #define         CFSIGNATURE     0x400
 916         uint16_t checksum;              /* word 31 */
 917 };
 918
 919 /*
 920  * Vital Product Data used during POST and by the BIOS.
 921  */
 922 struct vpd_config {
 923         uint8_t  bios_flags;
 924 #define         VPDMASTERBIOS   0x0001
 925 #define         VPDBOOTHOST     0x0002
 926         uint8_t  reserved_1[21];
 927         uint8_t  resource_type;
 928         uint8_t  resource_len[2];
 929         uint8_t  resource_data[8];
 930         uint8_t  vpd_tag;
 931         uint16_t vpd_len;
 932         uint8_t  vpd_keyword[2];
 933         uint8_t  length;
 934         uint8_t  revision;
 935         uint8_t  device_flags;
 936         uint8_t  termnation_menus[2];
 937         uint8_t  fifo_threshold;
 938         uint8_t  end_tag;
 939         uint8_t  vpd_checksum;
 940         uint16_t default_target_flags;
 941         uint16_t default_bios_flags;
 942         uint16_t default_ctrl_flags;
 943         uint8_t  default_irq;
 944         uint8_t  pci_lattime;
 945         uint8_t  max_target;
 946         uint8_t  boot_lun;
 947         uint16_t signature;
 948         uint8_t  reserved_2;
 949         uint8_t  checksum;
 950         uint8_t  reserved_3[4];
 951 };
 952
 953 /****************************** Flexport Logic ********************************/
 954 #define FLXADDR_TERMCTL                 0x0
 955 #define         FLX_TERMCTL_ENSECHIGH   0x8
 956 #define         FLX_TERMCTL_ENSECLOW    0x4
 957 #define         FLX_TERMCTL_ENPRIHIGH   0x2
 958 #define         FLX_TERMCTL_ENPRILOW    0x1
 959 #define FLXADDR_ROMSTAT_CURSENSECTL     0x1
 960 #define         FLX_ROMSTAT_SEECFG      0xF0
 961 #define         FLX_ROMSTAT_EECFG       0x0F
 962 #define         FLX_ROMSTAT_SEE_93C66   0x00
 963 #define         FLX_ROMSTAT_SEE_NONE    0xF0
 964 #define         FLX_ROMSTAT_EE_512x8    0x0
 965 #define         FLX_ROMSTAT_EE_1MBx8    0x1
 966 #define         FLX_ROMSTAT_EE_2MBx8    0x2
 967 #define         FLX_ROMSTAT_EE_4MBx8    0x3
 968 #define         FLX_ROMSTAT_EE_16MBx8   0x4
 969 #define                 CURSENSE_ENB    0x1
 970 #define FLXADDR_FLEXSTAT                0x2
 971 #define         FLX_FSTAT_BUSY          0x1
 972 #define FLXADDR_CURRENT_STAT            0x4
 973 #define         FLX_CSTAT_SEC_HIGH      0xC0
 974 #define         FLX_CSTAT_SEC_LOW       0x30
 975 #define         FLX_CSTAT_PRI_HIGH      0x0C
 976 #define         FLX_CSTAT_PRI_LOW       0x03
 977 #define         FLX_CSTAT_MASK          0x03
 978 #define         FLX_CSTAT_SHIFT         2
 979 #define         FLX_CSTAT_OKAY          0x0
 980 #define         FLX_CSTAT_OVER          0x1
 981 #define         FLX_CSTAT_UNDER         0x2
 982 #define         FLX_CSTAT_INVALID       0x3
 983
 984 int             ahd_read_seeprom(struct ahd_softc *ahd, uint16_t *buf,
 985                                  u_int start_addr, u_int count, int bstream);
 986
 987 int             ahd_write_seeprom(struct ahd_softc *ahd, uint16_t *buf,
 988                                   u_int start_addr, u_int count);
 989 int             ahd_wait_seeprom(struct ahd_softc *ahd);
 990 int             ahd_verify_vpd_cksum(struct vpd_config *vpd);
 991 int             ahd_verify_cksum(struct seeprom_config *sc);
 992 int             ahd_acquire_seeprom(struct ahd_softc *ahd);
 993 void            ahd_release_seeprom(struct ahd_softc *ahd);
 994
 995 /****************************  Message Buffer *********************************/
 996 typedef enum {
 997         MSG_FLAG_NONE                   = 0x00,
 998         MSG_FLAG_EXPECT_PPR_BUSFREE     = 0x01,
 999         MSG_FLAG_IU_REQ_CHANGED         = 0x02,
1000         MSG_FLAG_EXPECT_IDE_BUSFREE     = 0x04,
1001         MSG_FLAG_EXPECT_QASREJ_BUSFREE  = 0x08,
1002         MSG_FLAG_PACKETIZED             = 0x10
1003 } ahd_msg_flags;
1004
1005 typedef enum {
1006         MSG_TYPE_NONE                   = 0x00,
1007         MSG_TYPE_INITIATOR_MSGOUT       = 0x01,
1008         MSG_TYPE_INITIATOR_MSGIN        = 0x02,
1009         MSG_TYPE_TARGET_MSGOUT          = 0x03,
1010         MSG_TYPE_TARGET_MSGIN           = 0x04
1011 } ahd_msg_type;
1012
1013 typedef enum {
1014         MSGLOOP_IN_PROG,
1015         MSGLOOP_MSGCOMPLETE,
1016         MSGLOOP_TERMINATED
1017 } msg_loop_stat;
1018
1019 /*********************** Software Configuration Structure *********************/
1020 struct ahd_suspend_channel_state {
1021         uint8_t scsiseq;
1022         uint8_t sxfrctl0;
1023         uint8_t sxfrctl1;
1024         uint8_t simode0;
1025         uint8_t simode1;
1026         uint8_t seltimer;
1027         uint8_t seqctl;
1028 };
1029
1030 struct ahd_suspend_state {
1031         struct  ahd_suspend_channel_state channel[2];
1032         uint8_t optionmode;
1033         uint8_t dscommand0;
1034         uint8_t dspcistatus;
1035         /* hsmailbox */
1036         uint8_t crccontrol1;
1037         uint8_t scbbaddr;
1038         /* Host and sequencer SCB counts */
1039         uint8_t dff_thrsh;
1040         uint8_t *scratch_ram;
1041         uint8_t *btt;
1042 };
1043
1044 typedef void (*ahd_bus_intr_t)(struct ahd_softc *);
1045
1046 typedef enum {
1047         AHD_MODE_DFF0,
1048         AHD_MODE_DFF1,
1049         AHD_MODE_CCHAN,
1050         AHD_MODE_SCSI,
1051         AHD_MODE_CFG,
1052         AHD_MODE_UNKNOWN
1053 } ahd_mode;
1054
1055 #define AHD_MK_MSK(x) (0x01 << (x))
1056 #define AHD_MODE_DFF0_MSK       AHD_MK_MSK(AHD_MODE_DFF0)
1057 #define AHD_MODE_DFF1_MSK       AHD_MK_MSK(AHD_MODE_DFF1)
1058 #define AHD_MODE_CCHAN_MSK      AHD_MK_MSK(AHD_MODE_CCHAN)
1059 #define AHD_MODE_SCSI_MSK       AHD_MK_MSK(AHD_MODE_SCSI)
1060 #define AHD_MODE_CFG_MSK        AHD_MK_MSK(AHD_MODE_CFG)
1061 #define AHD_MODE_UNKNOWN_MSK    AHD_MK_MSK(AHD_MODE_UNKNOWN)
1062 #define AHD_MODE_ANY_MSK (~0)
1063
1064 typedef uint8_t ahd_mode_state;
1065
1066 typedef void ahd_callback_t (void *);
1067
1068 struct ahd_completion
1069 {
1070         uint16_t        tag;
1071         uint8_t         sg_status;
1072         uint8_t         valid_tag;
1073 };
1074
1075 #define AIC_SCB_DATA(softc) (&(softc)->scb_data)
1076
1077 struct ahd_softc {
1078         bus_space_tag_t           tags[2];
1079         bus_space_handle_t        bshs[2];
1080 #ifndef __linux__
1081         bus_dma_tag_t             buffer_dmat;   /* dmat for buffer I/O */
1082 #endif
1083         struct scb_data           scb_data;
1084
1085         struct hardware_scb      *next_queued_hscb;
1086         struct map_node          *next_queued_hscb_map;
1087
1088         /*
1089          * SCBs that have been sent to the controller
1090          */
1091         LIST_HEAD(, scb)          pending_scbs;
1092
1093         /*
1094          * SCBs whose timeout routine has been called.
1095          */
1096         LIST_HEAD(, scb)          timedout_scbs;
1097
1098         /*
1099          * Current register window mode information.
1100          */
1101         ahd_mode                  dst_mode;
1102         ahd_mode                  src_mode;
1103
1104         /*
1105          * Saved register window mode information
1106          * used for restore on next unpause.
1107          */
1108         ahd_mode                  saved_dst_mode;
1109         ahd_mode                  saved_src_mode;
1110
1111         /*
1112          * Platform specific data.
1113          */
1114         struct ahd_platform_data *platform_data;
1115
1116         /*
1117          * Platform specific device information.
1118          */
1119         aic_dev_softc_t           dev_softc;
1120
1121         /*
1122          * Bus specific device information.
1123          */
1124         ahd_bus_intr_t            bus_intr;
1125
1126         /*
1127          * Target mode related state kept on a per enabled lun basis.
1128          * Targets that are not enabled will have null entries.
1129          * As an initiator, we keep one target entry for our initiator
1130          * ID to store our sync/wide transfer settings.
1131          */
1132         struct ahd_tmode_tstate  *enabled_targets[AHD_NUM_TARGETS];
1133
1134         /*
1135          * The black hole device responsible for handling requests for
1136          * disabled luns on enabled targets.
1137          */
1138         struct ahd_tmode_lstate  *black_hole;
1139
1140         /*
1141          * Device instance currently on the bus awaiting a continue TIO
1142          * for a command that was not given the disconnect priveledge.
1143          */
1144         struct ahd_tmode_lstate  *pending_device;
1145
1146         /*
1147          * Timer handles for timer driven callbacks.
1148          */
1149         aic_timer_t               reset_timer;
1150         aic_timer_t               stat_timer;
1151
1152         /*
1153          * Statistics.
1154          */
1155 #define AHD_STAT_UPDATE_MS      250
1156 #define AHD_STAT_BUCKETS        4
1157         u_int                     cmdcmplt_bucket;
1158         uint32_t                  cmdcmplt_counts[AHD_STAT_BUCKETS];
1159         uint32_t                  cmdcmplt_total;
1160
1161         /*
1162          * Card characteristics
1163          */
1164         ahd_chip                  chip;
1165         ahd_feature               features;
1166         ahd_bug                   bugs;
1167         ahd_flag                  flags;
1168         struct seeprom_config    *seep_config;
1169
1170         /* Command Queues */
1171         struct ahd_completion    *qoutfifo;
1172         uint16_t                  qoutfifonext;
1173         uint16_t                  qoutfifonext_valid_tag;
1174         uint16_t                  qinfifonext;
1175         uint16_t                  qinfifo[AHD_SCB_MAX];
1176
1177         /*
1178          * Our qfreeze count.  The sequencer compares
1179          * this value with its own counter to determine
1180          * whether to allow selections to occur.
1181          */
1182         uint16_t                  qfreeze_cnt;
1183
1184         /* Values to store in the SEQCTL register for pause and unpause */
1185         uint8_t                   unpause;
1186         uint8_t                   pause;
1187
1188         /* Critical Section Data */
1189         struct cs                *critical_sections;
1190         u_int                     num_critical_sections;
1191
1192         /* Buffer for handling packetized bitbucket. */
1193         uint8_t                  *overrun_buf;
1194
1195         /* Links for chaining softcs */
1196         TAILQ_ENTRY(ahd_softc)    links;
1197
1198         /* Channel Names ('A', 'B', etc.) */
1199         char                      channel;
1200
1201         /* Initiator Bus ID */
1202         uint8_t                   our_id;
1203
1204         /*
1205          * Target incoming command FIFO.
1206          */
1207         struct target_cmd        *targetcmds;
1208         uint8_t                   tqinfifonext;
1209
1210         /*
1211          * Cached verson of the hs_mailbox so we can avoid
1212          * pausing the sequencer during mailbox updates.
1213          */
1214         uint8_t                   hs_mailbox;
1215
1216         /*
1217          * Incoming and outgoing message handling.
1218          */
1219         uint8_t                   send_msg_perror;
1220         ahd_msg_flags             msg_flags;
1221         ahd_msg_type              msg_type;
1222         uint8_t                   msgout_buf[12];/* Message we are sending */
1223         uint8_t                   msgin_buf[12];/* Message we are receiving */
1224         u_int                     msgout_len;   /* Length of message to send */
1225         u_int                     msgout_index; /* Current index in msgout */
1226         u_int                     msgin_index;  /* Current index in msgin */
1227
1228         /*
1229          * Mapping information for data structures shared
1230          * between the sequencer and kernel.
1231          */
1232         bus_dma_tag_t             parent_dmat;
1233         bus_dma_tag_t             shared_data_dmat;
1234         struct map_node           shared_data_map;
1235
1236         /* Information saved through suspend/resume cycles */
1237         struct ahd_suspend_state  suspend_state;
1238
1239         /* Number of enabled target mode device on this card */
1240         u_int                     enabled_luns;
1241
1242         /* Initialization level of this data structure */
1243         u_int                     init_level;
1244
1245         /* PCI cacheline size. */
1246         u_int                     pci_cachesize;
1247
1248         /* IO Cell Parameters */
1249         uint8_t                   iocell_opts[AHD_NUM_PER_DEV_ANNEXCOLS];
1250
1251         u_int                     stack_size;
1252         uint16_t                 *saved_stack;
1253
1254         /* Per-Unit descriptive information */
1255         const char               *description;
1256         const char               *bus_description;
1257         char                     *name;
1258         int                       unit;
1259
1260         /* Selection Timer settings */
1261         int                       seltime;
1262
1263         /*
1264          * Interrupt coalescing settings.
1265          */
1266 #define AHD_INT_COALESCING_TIMER_DEFAULT                250 /*us*/
1267 #define AHD_INT_COALESCING_MAXCMDS_DEFAULT              10
1268 #define AHD_INT_COALESCING_MAXCMDS_MAX                  127
1269 #define AHD_INT_COALESCING_MINCMDS_DEFAULT              5
1270 #define AHD_INT_COALESCING_MINCMDS_MAX                  127
1271 #define AHD_INT_COALESCING_THRESHOLD_DEFAULT            2000
1272 #define AHD_INT_COALESCING_STOP_THRESHOLD_DEFAULT       1000
1273         u_int                     int_coalescing_timer;
1274         u_int                     int_coalescing_maxcmds;
1275         u_int                     int_coalescing_mincmds;
1276         u_int                     int_coalescing_threshold;
1277         u_int                     int_coalescing_stop_threshold;
1278
1279         uint16_t                  user_discenable;/* Disconnection allowed  */
1280         uint16_t                  user_tagenable;/* Tagged Queuing allowed */
1281 };
1282
1283 TAILQ_HEAD(ahd_softc_tailq, ahd_softc);
1284 extern struct ahd_softc_tailq ahd_tailq;
1285
1286 /*************************** IO Cell Configuration ****************************/
1287 #define AHD_PRECOMP_SLEW_INDEX                                          \
1288     (AHD_ANNEXCOL_PRECOMP_SLEW - AHD_ANNEXCOL_PER_DEV0)
1289
1290 #define AHD_AMPLITUDE_INDEX                                             \
1291     (AHD_ANNEXCOL_AMPLITUDE - AHD_ANNEXCOL_PER_DEV0)
1292
1293 #define AHD_SET_SLEWRATE(ahd, new_slew)                                 \
1294 do {                                                                    \
1295     (ahd)->iocell_opts[AHD_PRECOMP_SLEW_INDEX] &= ~AHD_SLEWRATE_MASK;   \
1296     (ahd)->iocell_opts[AHD_PRECOMP_SLEW_INDEX] |=                       \
1297         (((new_slew) << AHD_SLEWRATE_SHIFT) & AHD_SLEWRATE_MASK);       \
1298 } while (0)
1299
1300 #define AHD_SET_PRECOMP(ahd, new_pcomp)                                 \
1301 do {                                                                    \
1302     (ahd)->iocell_opts[AHD_PRECOMP_SLEW_INDEX] &= ~AHD_PRECOMP_MASK;    \
1303     (ahd)->iocell_opts[AHD_PRECOMP_SLEW_INDEX] |=                       \
1304         (((new_pcomp) << AHD_PRECOMP_SHIFT) & AHD_PRECOMP_MASK);        \
1305 } while (0)
1306
1307 #define AHD_SET_AMPLITUDE(ahd, new_amp)                                 \
1308 do {                                                                    \
1309     (ahd)->iocell_opts[AHD_AMPLITUDE_INDEX] &= ~AHD_AMPLITUDE_MASK;     \
1310     (ahd)->iocell_opts[AHD_AMPLITUDE_INDEX] |=                          \
1311         (((new_amp) << AHD_AMPLITUDE_SHIFT) & AHD_AMPLITUDE_MASK);      \
1312 } while (0)
1313
1314 /************************ Active Device Information ***************************/
1315 typedef enum {
1316         ROLE_UNKNOWN,
1317         ROLE_INITIATOR,
1318         ROLE_TARGET
1319 } role_t;
1320
1321 struct ahd_devinfo {
1322         int      our_scsiid;
1323         int      target_offset;
1324         uint16_t target_mask;
1325         u_int    target;
1326         u_int    lun;
1327         char     channel;
1328         role_t   role;          /*
1329                                  * Only guaranteed to be correct if not
1330                                  * in the busfree state.
1331                                  */
1332 };
1333
1334 /****************************** PCI Structures ********************************/
1335 #define AHD_PCI_IOADDR0 PCIR_BAR(0)     /* I/O BAR*/
1336 #define AHD_PCI_MEMADDR PCIR_BAR(1)     /* Memory BAR */
1337 #define AHD_PCI_IOADDR1 PCIR_BAR(3)     /* Second I/O BAR */
1338
1339 typedef int (ahd_device_setup_t)(struct ahd_softc *);
1340
1341 struct ahd_pci_identity {
1342         uint64_t                 full_id;
1343         uint64_t                 id_mask;
1344         char                    *name;
1345         ahd_device_setup_t      *setup;
1346 };
1347 extern struct ahd_pci_identity ahd_pci_ident_table [];
1348 extern const u_int ahd_num_pci_devs;
1349
1350 /*************************** Function Declarations ****************************/
1351 /******************************************************************************/
1352 void                    ahd_reset_cmds_pending(struct ahd_softc *ahd);
1353 u_int                   ahd_find_busy_tcl(struct ahd_softc *ahd, u_int tcl);
1354 void                    ahd_busy_tcl(struct ahd_softc *ahd,
1355                                      u_int tcl, u_int busyid);
1356 static __inline void    ahd_unbusy_tcl(struct ahd_softc *ahd, u_int tcl);
1357 static __inline void
1358 ahd_unbusy_tcl(struct ahd_softc *ahd, u_int tcl)
1359 {
1360         ahd_busy_tcl(ahd, tcl, SCB_LIST_NULL);
1361 }
1362
1363 /***************************** PCI Front End *********************************/
1364 struct  ahd_pci_identity *ahd_find_pci_device(aic_dev_softc_t);
1365 int                       ahd_pci_config(struct ahd_softc *,
1366                                          struct ahd_pci_identity *);
1367 int     ahd_pci_test_register_access(struct ahd_softc *);
1368
1369 /************************** SCB and SCB queue management **********************/
1370 int             ahd_probe_scbs(struct ahd_softc *);
1371 void            ahd_qinfifo_requeue_tail(struct ahd_softc *ahd,
1372                                          struct scb *scb);
1373 int             ahd_match_scb(struct ahd_softc *ahd, struct scb *scb,
1374                               int target, char channel, int lun,
1375                               u_int tag, role_t role);
1376
1377 /****************************** Initialization ********************************/
1378 struct ahd_softc        *ahd_alloc(void *platform_arg, char *name);
1379 int                      ahd_softc_init(struct ahd_softc *);
1380 void                     ahd_controller_info(struct ahd_softc *ahd, char *buf);
1381 int                      ahd_init(struct ahd_softc *ahd);
1382 int                      ahd_default_config(struct ahd_softc *ahd);
1383 int                      ahd_parse_vpddata(struct ahd_softc *ahd,
1384                                            struct vpd_config *vpd);
1385 int                      ahd_parse_cfgdata(struct ahd_softc *ahd,
1386                                            struct seeprom_config *sc);
1387 void                     ahd_intr_enable(struct ahd_softc *ahd, int enable);
1388 void                     ahd_update_coalescing_values(struct ahd_softc *ahd,
1389                                                       u_int timer,
1390                                                       u_int maxcmds,
1391                                                       u_int mincmds);
1392 void                     ahd_enable_coalescing(struct ahd_softc *ahd,
1393                                                int enable);
1394 void                     ahd_pause_and_flushwork(struct ahd_softc *ahd);
1395 int                      ahd_suspend(struct ahd_softc *ahd);
1396 int                      ahd_resume(struct ahd_softc *ahd);
1397 void                     ahd_softc_insert(struct ahd_softc *);
1398 struct ahd_softc        *ahd_find_softc(struct ahd_softc *ahd);
1399 void                     ahd_set_unit(struct ahd_softc *, int);
1400 void                     ahd_set_name(struct ahd_softc *, char *);
1401 struct scb              *ahd_get_scb(struct ahd_softc *ahd, u_int col_idx);
1402 void                     ahd_free_scb(struct ahd_softc *ahd, struct scb *scb);
1403 int                      ahd_alloc_scbs(struct ahd_softc *ahd);
1404 void                     ahd_free(struct ahd_softc *ahd);
1405 int                      ahd_reset(struct ahd_softc *ahd, int reinit);
1406 void                     ahd_shutdown(void *arg);
1407 int                      ahd_write_flexport(struct ahd_softc *ahd,
1408                                             u_int addr, u_int value);
1409 int                      ahd_read_flexport(struct ahd_softc *ahd, u_int addr,
1410                                            uint8_t *value);
1411 int                      ahd_wait_flexport(struct ahd_softc *ahd);
1412
1413 /*************************** Interrupt Services *******************************/
1414 void                    ahd_pci_intr(struct ahd_softc *ahd);
1415 void                    ahd_clear_intstat(struct ahd_softc *ahd);
1416 void                    ahd_flush_qoutfifo(struct ahd_softc *ahd);
1417 void                    ahd_run_qoutfifo(struct ahd_softc *ahd);
1418 #ifdef AHD_TARGET_MODE
1419 void                    ahd_run_tqinfifo(struct ahd_softc *ahd, int paused);
1420 #endif
1421 void                    ahd_handle_hwerrint(struct ahd_softc *ahd);
1422 void                    ahd_handle_seqint(struct ahd_softc *ahd, u_int intstat);
1423 void                    ahd_handle_scsiint(struct ahd_softc *ahd,
1424                                            u_int intstat);
1425 void                    ahd_clear_critical_section(struct ahd_softc *ahd);
1426
1427 /***************************** Error Recovery *********************************/
1428 typedef enum {
1429         SEARCH_COMPLETE,
1430         SEARCH_COUNT,
1431         SEARCH_REMOVE,
1432         SEARCH_PRINT
1433 } ahd_search_action;
1434 void                    ahd_done_with_status(struct ahd_softc *ahd,
1435                                              struct scb *scb, uint32_t status);
1436 int                     ahd_search_qinfifo(struct ahd_softc *ahd, int target,
1437                                            char channel, int lun, u_int tag,
1438                                            role_t role, uint32_t status,
1439                                            ahd_search_action action);
1440 int                     ahd_search_disc_list(struct ahd_softc *ahd, int target,
1441                                              char channel, int lun, u_int tag,
1442                                              int stop_on_first, int remove,
1443                                              int save_state);
1444 void                    ahd_freeze_devq(struct ahd_softc *ahd, struct scb *scb);
1445 int                     ahd_reset_channel(struct ahd_softc *ahd, char channel,
1446                                           int initiate_reset);
1447 int                     ahd_abort_scbs(struct ahd_softc *ahd, int target,
1448                                        char channel, int lun, u_int tag,
1449                                        role_t role, uint32_t status);
1450 void                    ahd_restart(struct ahd_softc *ahd);
1451 void                    ahd_clear_fifo(struct ahd_softc *ahd, u_int fifo);
1452 void                    ahd_handle_scb_status(struct ahd_softc *ahd,
1453                                               struct scb *scb);
1454 void                    ahd_handle_scsi_status(struct ahd_softc *ahd,
1455                                                struct scb *scb);
1456 void                    ahd_calc_residual(struct ahd_softc *ahd,
1457                                           struct scb *scb);
1458 void                    ahd_timeout(struct scb *scb);
1459 void                    ahd_recover_commands(struct ahd_softc *ahd);
1460 /*************************** Utility Functions ********************************/
1461 struct ahd_phase_table_entry*
1462                         ahd_lookup_phase_entry(int phase);
1463 void                    ahd_compile_devinfo(struct ahd_devinfo *devinfo,
1464                                             u_int our_id, u_int target,
1465                                             u_int lun, char channel,
1466                                             role_t role);
1467 /************************** Transfer Negotiation ******************************/
1468 void                    ahd_find_syncrate(struct ahd_softc *ahd, u_int *period,
1469                                           u_int *ppr_options, u_int maxsync);
1470 void                    ahd_validate_offset(struct ahd_softc *ahd,
1471                                             struct ahd_initiator_tinfo *tinfo,
1472                                             u_int period, u_int *offset,
1473                                             int wide, role_t role);
1474 void                    ahd_validate_width(struct ahd_softc *ahd,
1475                                            struct ahd_initiator_tinfo *tinfo,
1476                                            u_int *bus_width,
1477                                            role_t role);
1478 /*
1479  * Negotiation types.  These are used to qualify if we should renegotiate
1480  * even if our goal and current transport parameters are identical.
1481  */
1482 typedef enum {
1483         AHD_NEG_TO_GOAL,        /* Renegotiate only if goal and curr differ. */
1484         AHD_NEG_IF_NON_ASYNC,   /* Renegotiate so long as goal is non-async. */
1485         AHD_NEG_ALWAYS          /* Renegotiat even if goal is async. */
1486 } ahd_neg_type;
1487 int                     ahd_update_neg_request(struct ahd_softc*,
1488                                                struct ahd_devinfo*,
1489                                                struct ahd_tmode_tstate*,
1490                                                struct ahd_initiator_tinfo*,
1491                                                ahd_neg_type);
1492 void                    ahd_set_width(struct ahd_softc *ahd,
1493                                       struct ahd_devinfo *devinfo,
1494                                       u_int width, u_int type, int paused);
1495 void                    ahd_set_syncrate(struct ahd_softc *ahd,
1496                                          struct ahd_devinfo *devinfo,
1497                                          u_int period, u_int offset,
1498                                          u_int ppr_options,
1499                                          u_int type, int paused);
1500 typedef enum {
1501         AHD_QUEUE_NONE,
1502         AHD_QUEUE_BASIC,
1503         AHD_QUEUE_TAGGED
1504 } ahd_queue_alg;
1505
1506 void                    ahd_set_tags(struct ahd_softc *ahd,
1507                                      struct ahd_devinfo *devinfo,
1508                                      ahd_queue_alg alg);
1509
1510 /**************************** Target Mode *************************************/
1511 #ifdef AHD_TARGET_MODE
1512 void            ahd_send_lstate_events(struct ahd_softc *,
1513                                        struct ahd_tmode_lstate *);
1514 void            ahd_handle_en_lun(struct ahd_softc *ahd,
1515                                   struct cam_sim *sim, union ccb *ccb);
1516 cam_status      ahd_find_tmode_devs(struct ahd_softc *ahd,
1517                                     struct cam_sim *sim, union ccb *ccb,
1518                                     struct ahd_tmode_tstate **tstate,
1519                                     struct ahd_tmode_lstate **lstate,
1520                                     int notfound_failure);
1521 #ifndef AHD_TMODE_ENABLE
1522 #define AHD_TMODE_ENABLE 0
1523 #endif
1524 #endif
1525 /******************************* Debug ***************************************/
1526 #ifdef AHD_DEBUG
1527 extern uint32_t ahd_debug;
1528 #define AHD_SHOW_MISC           0x00001
1529 #define AHD_SHOW_SENSE          0x00002
1530 #define AHD_SHOW_RECOVERY       0x00004
1531 #define AHD_DUMP_SEEPROM        0x00008
1532 #define AHD_SHOW_TERMCTL        0x00010
1533 #define AHD_SHOW_MEMORY         0x00020
1534 #define AHD_SHOW_MESSAGES       0x00040
1535 #define AHD_SHOW_MODEPTR        0x00080
1536 #define AHD_SHOW_SELTO          0x00100
1537 #define AHD_SHOW_FIFOS          0x00200
1538 #define AHD_SHOW_QFULL          0x00400
1539 #define AHD_SHOW_DV             0x00800
1540 #define AHD_SHOW_MASKED_ERRORS  0x01000
1541 #define AHD_SHOW_QUEUE          0x02000
1542 #define AHD_SHOW_TQIN           0x04000
1543 #define AHD_SHOW_SG             0x08000
1544 #define AHD_SHOW_INT_COALESCING 0x10000
1545 #define AHD_DEBUG_SEQUENCER     0x20000
1546 #endif
1547 void                    ahd_print_scb(struct scb *scb);
1548 void                    ahd_print_devinfo(struct ahd_softc *ahd,
1549                                           struct ahd_devinfo *devinfo);
1550 void                    ahd_dump_sglist(struct scb *scb);
1551 void                    ahd_dump_all_cards_state(void);
1552 void                    ahd_dump_card_state(struct ahd_softc *ahd);
1553 int                     ahd_print_register(ahd_reg_parse_entry_t *table,
1554                                            u_int num_entries,
1555                                            const char *name,
1556                                            u_int address,
1557                                            u_int value,
1558                                            u_int *cur_column,
1559                                            u_int wrap_point);
1560 void                    ahd_dump_scbs(struct ahd_softc *ahd);
1561 #endif /* _AIC79XX_H_ */