1/* 2 * Core definitions and data structures shareable across OS platforms. 3 * 4 * Copyright (c) 1994-2001 Justin T. Gibbs. 5 * Copyright (c) 2000-2001 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: aic7xxx.h,v 1.1.1.1 2007/08/03 18:52:58 Exp $ 41 * 42 * $FreeBSD$ 43 */ 44 45#ifndef _AIC7XXX_H_ 46#define _AIC7XXX_H_ 47 48/* Register Definitions */ 49#include "aic7xxx_reg.h" 50 51/************************* Forward Declarations *******************************/ 52struct ahc_platform_data; 53struct scb_platform_data; 54struct seeprom_descriptor; 55 56/****************************** Useful Macros *********************************/ 57#ifndef TRUE 58#define TRUE 1 59#endif 60#ifndef FALSE 61#define FALSE 0 62#endif 63 64#define ALL_CHANNELS '\0' 65#define ALL_TARGETS_MASK 0xFFFF 66#define INITIATOR_WILDCARD (~0) 67 68#define SCSIID_TARGET(ahc, scsiid) \ 69 (((scsiid) & ((((ahc)->features & AHC_TWIN) != 0) ? TWIN_TID : TID)) \ 70 >> TID_SHIFT) 71#define SCSIID_OUR_ID(scsiid) \ 72 ((scsiid) & OID) 73#define SCSIID_CHANNEL(ahc, scsiid) \ 74 ((((ahc)->features & AHC_TWIN) != 0) \ 75 ? ((((scsiid) & TWIN_CHNLB) != 0) ? 'B' : 'A') \ 76 : 'A') 77#define SCB_IS_SCSIBUS_B(ahc, scb) \ 78 (SCSIID_CHANNEL(ahc, (scb)->hscb->scsiid) == 'B') 79#define SCB_GET_OUR_ID(scb) \ 80 SCSIID_OUR_ID((scb)->hscb->scsiid) 81#define SCB_GET_TARGET(ahc, scb) \ 82 SCSIID_TARGET((ahc), (scb)->hscb->scsiid) 83#define SCB_GET_CHANNEL(ahc, scb) \ 84 SCSIID_CHANNEL(ahc, (scb)->hscb->scsiid) 85#define SCB_GET_LUN(scb) \ 86 ((scb)->hscb->lun & LID) 87#define SCB_GET_TARGET_OFFSET(ahc, scb) \ 88 (SCB_GET_TARGET(ahc, scb) + (SCB_IS_SCSIBUS_B(ahc, scb) ? 8 : 0)) 89#define SCB_GET_TARGET_MASK(ahc, scb) \ 90 (0x01 << (SCB_GET_TARGET_OFFSET(ahc, scb))) 91#ifdef AHC_DEBUG 92#define SCB_IS_SILENT(scb) \ 93 ((ahc_debug & AHC_SHOW_MASKED_ERRORS) == 0 \ 94 && (((scb)->flags & SCB_SILENT) != 0)) 95#else 96#define SCB_IS_SILENT(scb) \ 97 (((scb)->flags & SCB_SILENT) != 0) 98#endif 99#define TCL_TARGET_OFFSET(tcl) \ 100 ((((tcl) >> 4) & TID) >> 4) 101#define TCL_LUN(tcl) \ 102 (tcl & (AHC_NUM_LUNS - 1)) 103#define BUILD_TCL(scsiid, lun) \ 104 ((lun) | (((scsiid) & TID) << 4)) 105 106#ifndef AHC_TARGET_MODE 107#undef AHC_TMODE_ENABLE 108#define AHC_TMODE_ENABLE 0 109#endif 110 111/**************************** Driver Constants ********************************/ 112/* 113 * The maximum number of supported targets. 114 */ 115#define AHC_NUM_TARGETS 16 116 117/* 118 * The maximum number of supported luns. 119 * The identify message only supports 64 luns in SPI3. 120 * You can have 2^64 luns when information unit transfers are enabled, 121 * but it is doubtful this driver will ever support IUTs. 122 */ 123#define AHC_NUM_LUNS 64 124 125/* 126 * The maximum transfer per S/G segment. 127 */ 128#define AHC_MAXTRANSFER_SIZE 0x00ffffff /* limited by 24bit counter */ 129 130/* 131 * The maximum amount of SCB storage in hardware on a controller. 132 * This value represents an upper bound. Controllers vary in the number 133 * they actually support. 134 */ 135#define AHC_SCB_MAX 255 136 137/* 138 * The maximum number of concurrent transactions supported per driver instance. 139 * Sequencer Control Blocks (SCBs) store per-transaction information. Although 140 * the space for SCBs on the host adapter varies by model, the driver will 141 * page the SCBs between host and controller memory as needed. We are limited 142 * to 253 because: 143 * 1) The 8bit nature of the RISC engine holds us to an 8bit value. 144 * 2) We reserve one value, 255, to represent the invalid element. 145 * 3) Our input queue scheme requires one SCB to always be reserved 146 * in advance of queuing any SCBs. This takes us down to 254. 147 * 4) To handle our output queue correctly on machines that only 148 * support 32bit stores, we must clear the array 4 bytes at a 149 * time. To avoid colliding with a DMA write from the sequencer, 150 * we must be sure that 4 slots are empty when we write to clear 151 * the queue. This reduces us to 253 SCBs: 1 that just completed 152 * and the known three additional empty slots in the queue that 153 * precede it. 154 */ 155#define AHC_MAX_QUEUE 253 156 157/* 158 * The maximum amount of SCB storage we allocate in host memory. This 159 * number should reflect the 1 additional SCB we require to handle our 160 * qinfifo mechanism. 161 */ 162#define AHC_SCB_MAX_ALLOC (AHC_MAX_QUEUE+1) 163 164/* 165 * Ring Buffer of incoming target commands. 166 * We allocate 256 to simplify the logic in the sequencer 167 * by using the natural wrap point of an 8bit counter. 168 */ 169#define AHC_TMODE_CMDS 256 170 171/* Reset line assertion time in us */ 172#define AHC_BUSRESET_DELAY 25 173 174/******************* Chip Characteristics/Operating Settings *****************/ 175/* 176 * Chip Type 177 * The chip order is from least sophisticated to most sophisticated. 178 */ 179typedef enum { 180 AHC_NONE = 0x0000, 181 AHC_CHIPID_MASK = 0x00FF, 182 AHC_AIC7770 = 0x0001, 183 AHC_AIC7850 = 0x0002, 184 AHC_AIC7855 = 0x0003, 185 AHC_AIC7859 = 0x0004, 186 AHC_AIC7860 = 0x0005, 187 AHC_AIC7870 = 0x0006, 188 AHC_AIC7880 = 0x0007, 189 AHC_AIC7895 = 0x0008, 190 AHC_AIC7895C = 0x0009, 191 AHC_AIC7890 = 0x000a, 192 AHC_AIC7896 = 0x000b, 193 AHC_AIC7892 = 0x000c, 194 AHC_AIC7899 = 0x000d, 195 AHC_VL = 0x0100, /* Bus type VL */ 196 AHC_EISA = 0x0200, /* Bus type EISA */ 197 AHC_PCI = 0x0400, /* Bus type PCI */ 198 AHC_BUS_MASK = 0x0F00 199} ahc_chip; 200 201/* 202 * Features available in each chip type. 203 */ 204typedef enum { 205 AHC_FENONE = 0x00000, 206 AHC_ULTRA = 0x00001, /* Supports 20MHz Transfers */ 207 AHC_ULTRA2 = 0x00002, /* Supports 40MHz Transfers */ 208 AHC_WIDE = 0x00004, /* Wide Channel */ 209 AHC_TWIN = 0x00008, /* Twin Channel */ 210 AHC_MORE_SRAM = 0x00010, /* 80 bytes instead of 64 */ 211 AHC_CMD_CHAN = 0x00020, /* Has a Command DMA Channel */ 212 AHC_QUEUE_REGS = 0x00040, /* Has Queue management registers */ 213 AHC_SG_PRELOAD = 0x00080, /* Can perform auto-SG preload */ 214 AHC_SPIOCAP = 0x00100, /* Has a Serial Port I/O Cap Register */ 215 AHC_MULTI_TID = 0x00200, /* Has bitmask of TIDs for select-in */ 216 AHC_HS_MAILBOX = 0x00400, /* Has HS_MAILBOX register */ 217 AHC_DT = 0x00800, /* Double Transition transfers */ 218 AHC_NEW_TERMCTL = 0x01000, /* Newer termination scheme */ 219 AHC_MULTI_FUNC = 0x02000, /* Multi-Function Twin Channel Device */ 220 AHC_LARGE_SCBS = 0x04000, /* 64byte SCBs */ 221 AHC_AUTORATE = 0x08000, /* Automatic update of SCSIRATE/OFFSET*/ 222 AHC_AUTOPAUSE = 0x10000, /* Automatic pause on register access */ 223 AHC_TARGETMODE = 0x20000, /* Has tested target mode support */ 224 AHC_MULTIROLE = 0x40000, /* Space for two roles at a time */ 225 AHC_REMOVABLE = 0x80000, /* Hot-Swap supported */ 226 AHC_HVD = 0x100000, /* HVD rather than SE */ 227 AHC_AIC7770_FE = AHC_FENONE, 228 /* 229 * The real 7850 does not support Ultra modes, but there are 230 * several cards that use the generic 7850 PCI ID even though 231 * they are using an Ultra capable chip (7859/7860). We start 232 * out with the AHC_ULTRA feature set and then check the DEVSTATUS 233 * register to determine if the capability is really present. 234 */ 235 AHC_AIC7850_FE = AHC_SPIOCAP|AHC_AUTOPAUSE|AHC_TARGETMODE|AHC_ULTRA, 236 AHC_AIC7860_FE = AHC_AIC7850_FE, 237 AHC_AIC7870_FE = AHC_TARGETMODE|AHC_AUTOPAUSE, 238 AHC_AIC7880_FE = AHC_AIC7870_FE|AHC_ULTRA, 239 /* 240 * Although we have space for both the initiator and 241 * target roles on ULTRA2 chips, we currently disable 242 * the initiator role to allow multi-scsi-id target mode 243 * configurations. We can only respond on the same SCSI 244 * ID as our initiator role if we allow initiator operation. 245 * At some point, we should add a configuration knob to 246 * allow both roles to be loaded. 247 */ 248 AHC_AIC7890_FE = AHC_MORE_SRAM|AHC_CMD_CHAN|AHC_ULTRA2 249 |AHC_QUEUE_REGS|AHC_SG_PRELOAD|AHC_MULTI_TID 250 |AHC_HS_MAILBOX|AHC_NEW_TERMCTL|AHC_LARGE_SCBS 251 |AHC_TARGETMODE, 252 AHC_AIC7892_FE = AHC_AIC7890_FE|AHC_DT|AHC_AUTORATE|AHC_AUTOPAUSE, 253 AHC_AIC7895_FE = AHC_AIC7880_FE|AHC_MORE_SRAM|AHC_AUTOPAUSE 254 |AHC_CMD_CHAN|AHC_MULTI_FUNC|AHC_LARGE_SCBS, 255 AHC_AIC7895C_FE = AHC_AIC7895_FE|AHC_MULTI_TID, 256 AHC_AIC7896_FE = AHC_AIC7890_FE|AHC_MULTI_FUNC, 257 AHC_AIC7899_FE = AHC_AIC7892_FE|AHC_MULTI_FUNC 258} ahc_feature; 259 260typedef enum { 261 AHC_BUGNONE = 0x00, 262 /* 263 * On all chips prior to the U2 product line, 264 * the WIDEODD S/G segment feature does not 265 * work during scsi->HostBus transfers. 266 */ 267 AHC_TMODE_WIDEODD_BUG = 0x01, 268 /* 269 * On the aic7890/91 Rev 0 chips, the autoflush 270 * feature does not work. A manual flush of 271 * the DMA FIFO is required. 272 */ 273 AHC_AUTOFLUSH_BUG = 0x02, 274 /* 275 * On many chips, cacheline streaming does not work. 276 */ 277 AHC_CACHETHEN_BUG = 0x04, 278 /* 279 * On the aic7896/97 chips, cacheline 280 * streaming must be enabled. 281 */ 282 AHC_CACHETHEN_DIS_BUG = 0x08, 283 /* 284 * PCI 2.1 Retry failure on non-empty data fifo. 285 */ 286 AHC_PCI_2_1_RETRY_BUG = 0x10, 287 /* 288 * Controller does not handle cacheline residuals 289 * properly on S/G segments if PCI MWI instructions 290 * are allowed. 291 */ 292 AHC_PCI_MWI_BUG = 0x20, 293 /* 294 * An SCB upload using the SCB channel's 295 * auto array entry copy feature may 296 * corrupt data. This appears to only 297 * occur on 66MHz systems. 298 */ 299 AHC_SCBCHAN_UPLOAD_BUG = 0x40 300} ahc_bug; 301 302/* 303 * Configuration specific settings. 304 * The driver determines these settings by probing the 305 * chip/controller's configuration. 306 */ 307typedef enum { 308 AHC_FNONE = 0x000, 309 AHC_PRIMARY_CHANNEL = 0x003, /* 310 * The channel that should 311 * be probed first. 312 */ 313 AHC_USEDEFAULTS = 0x004, /* 314 * For cards without an seeprom 315 * or a BIOS to initialize the chip's 316 * SRAM, we use the default target 317 * settings. 318 */ 319 AHC_SEQUENCER_DEBUG = 0x008, 320 AHC_SHARED_SRAM = 0x010, 321 AHC_LARGE_SEEPROM = 0x020, /* Uses C56_66 not C46 */ 322 AHC_RESET_BUS_A = 0x040, 323 AHC_RESET_BUS_B = 0x080, 324 AHC_EXTENDED_TRANS_A = 0x100, 325 AHC_EXTENDED_TRANS_B = 0x200, 326 AHC_TERM_ENB_A = 0x400, 327 AHC_TERM_ENB_B = 0x800, 328 AHC_INITIATORROLE = 0x1000, /* 329 * Allow initiator operations on 330 * this controller. 331 */ 332 AHC_TARGETROLE = 0x2000, /* 333 * Allow target operations on this 334 * controller. 335 */ 336 AHC_NEWEEPROM_FMT = 0x4000, 337 AHC_TQINFIFO_BLOCKED = 0x10000, /* Blocked waiting for ATIOs */ 338 AHC_INT50_SPEEDFLEX = 0x20000, /* 339 * Internal 50pin connector 340 * sits behind an aic3860 341 */ 342 AHC_SCB_BTT = 0x40000, /* 343 * The busy targets table is 344 * stored in SCB space rather 345 * than SRAM. 346 */ 347 AHC_BIOS_ENABLED = 0x80000, 348 AHC_ALL_INTERRUPTS = 0x100000, 349 AHC_PAGESCBS = 0x400000, /* Enable SCB paging */ 350 AHC_EDGE_INTERRUPT = 0x800000, /* Device uses edge triggered ints */ 351 AHC_39BIT_ADDRESSING = 0x1000000, /* Use 39 bit addressing scheme. */ 352 AHC_LSCBS_ENABLED = 0x2000000, /* 64Byte SCBs enabled */ 353 AHC_SCB_CONFIG_USED = 0x4000000, /* No SEEPROM but SCB2 had info. */ 354 AHC_NO_BIOS_INIT = 0x8000000, /* No BIOS left over settings. */ 355 AHC_DISABLE_PCI_PERR = 0x10000000, 356 AHC_HAS_TERM_LOGIC = 0x20000000 357} ahc_flag; 358 359/************************* Hardware SCB Definition ***************************/ 360 361/* 362 * The driver keeps up to MAX_SCB scb structures per card in memory. The SCB 363 * consists of a "hardware SCB" mirroring the fields available on the card 364 * and additional information the kernel stores for each transaction. 365 * 366 * To minimize space utilization, a portion of the hardware scb stores 367 * different data during different portions of a SCSI transaction. 368 * As initialized by the host driver for the initiator role, this area 369 * contains the SCSI cdb (or a pointer to the cdb) to be executed. After 370 * the cdb has been presented to the target, this area serves to store 371 * residual transfer information and the SCSI status byte. 372 * For the target role, the contents of this area do not change, but 373 * still serve a different purpose than for the initiator role. See 374 * struct target_data for details. 375 */ 376 377/* 378 * Status information embedded in the shared poriton of 379 * an SCB after passing the cdb to the target. The kernel 380 * driver will only read this data for transactions that 381 * complete abnormally (non-zero status byte). 382 */ 383struct status_pkt { 384 uint32_t residual_datacnt; /* Residual in the current S/G seg */ 385 uint32_t residual_sg_ptr; /* The next S/G for this transfer */ 386 uint8_t scsi_status; /* Standard SCSI status byte */ 387}; 388 389/* 390 * Target mode version of the shared data SCB segment. 391 */ 392struct target_data { 393 uint32_t residual_datacnt; /* Residual in the current S/G seg */ 394 uint32_t residual_sg_ptr; /* The next S/G for this transfer */ 395 uint8_t scsi_status; /* SCSI status to give to initiator */ 396 uint8_t target_phases; /* Bitmap of phases to execute */ 397 uint8_t data_phase; /* Data-In or Data-Out */ 398 uint8_t initiator_tag; /* Initiator's transaction tag */ 399}; 400 401struct hardware_scb { 402/*0*/ union { 403 /* 404 * If the cdb is 12 bytes or less, we embed it directly 405 * in the SCB. For longer cdbs, we embed the address 406 * of the cdb payload as seen by the chip and a DMA 407 * is used to pull it in. 408 */ 409 uint8_t cdb[12]; 410 uint32_t cdb_ptr; 411 struct status_pkt status; 412 struct target_data tdata; 413 } shared_data; 414/* 415 * A word about residuals. 416 * The scb is presented to the sequencer with the dataptr and datacnt 417 * fields initialized to the contents of the first S/G element to 418 * transfer. The sgptr field is initialized to the bus address for 419 * the S/G element that follows the first in the in core S/G array 420 * or'ed with the SG_FULL_RESID flag. Sgptr may point to an invalid 421 * S/G entry for this transfer (single S/G element transfer with the 422 * first elements address and length preloaded in the dataptr/datacnt 423 * fields). If no transfer is to occur, sgptr is set to SG_LIST_NULL. 424 * The SG_FULL_RESID flag ensures that the residual will be correctly 425 * noted even if no data transfers occur. Once the data phase is entered, 426 * the residual sgptr and datacnt are loaded from the sgptr and the 427 * datacnt fields. After each S/G element's dataptr and length are 428 * loaded into the hardware, the residual sgptr is advanced. After 429 * each S/G element is expired, its datacnt field is checked to see 430 * if the LAST_SEG flag is set. If so, SG_LIST_NULL is set in the 431 * residual sg ptr and the transfer is considered complete. If the 432 * sequencer determines that there is a residual in the tranfer, it 433 * will set the SG_RESID_VALID flag in sgptr and dma the scb back into 434 * host memory. To sumarize: 435 * 436 * Sequencer: 437 * o A residual has occurred if SG_FULL_RESID is set in sgptr, 438 * or residual_sgptr does not have SG_LIST_NULL set. 439 * 440 * o We are transfering the last segment if residual_datacnt has 441 * the SG_LAST_SEG flag set. 442 * 443 * Host: 444 * o A residual has occurred if a completed scb has the 445 * SG_RESID_VALID flag set. 446 * 447 * o residual_sgptr and sgptr refer to the "next" sg entry 448 * and so may point beyond the last valid sg entry for the 449 * transfer. 450 */ 451/*12*/ uint32_t dataptr; 452/*16*/ uint32_t datacnt; /* 453 * Byte 3 (numbered from 0) of 454 * the datacnt is really the 455 * 4th byte in that data address. 456 */ 457/*20*/ uint32_t sgptr; 458#define SG_PTR_MASK 0xFFFFFFF8 459/*24*/ uint8_t control; /* See SCB_CONTROL in aic7xxx.reg for details */ 460/*25*/ uint8_t scsiid; /* what to load in the SCSIID register */ 461/*26*/ uint8_t lun; 462/*27*/ uint8_t tag; /* 463 * Index into our kernel SCB array. 464 * Also used as the tag for tagged I/O 465 */ 466/*28*/ uint8_t cdb_len; 467/*29*/ uint8_t scsirate; /* Value for SCSIRATE register */ 468/*30*/ uint8_t scsioffset; /* Value for SCSIOFFSET register */ 469/*31*/ uint8_t next; /* 470 * Used for threading SCBs in the 471 * "Waiting for Selection" and 472 * "Disconnected SCB" lists down 473 * in the sequencer. 474 */ 475/*32*/ uint8_t cdb32[32]; /* 476 * CDB storage for cdbs of size 477 * 13->32. We store them here 478 * because hardware scbs are 479 * allocated from DMA safe 480 * memory so we are guaranteed 481 * the controller can access 482 * this data. 483 */ 484}; 485 486/************************ Kernel SCB Definitions ******************************/ 487/* 488 * Some fields of the SCB are OS dependent. Here we collect the 489 * definitions for elements that all OS platforms need to include 490 * in there SCB definition. 491 */ 492 493/* 494 * Definition of a scatter/gather element as transfered to the controller. 495 * The aic7xxx chips only support a 24bit length. We use the top byte of 496 * the length to store additional address bits and a flag to indicate 497 * that a given segment terminates the transfer. This gives us an 498 * addressable range of 512GB on machines with 64bit PCI or with chips 499 * that can support dual address cycles on 32bit PCI busses. 500 */ 501struct ahc_dma_seg { 502 uint32_t addr; 503 uint32_t len; 504#define AHC_DMA_LAST_SEG 0x80000000 505#define AHC_SG_HIGH_ADDR_MASK 0x7F000000 506#define AHC_SG_LEN_MASK 0x00FFFFFF 507}; 508 509struct sg_map_node { 510 bus_dmamap_t sg_dmamap; 511 dma_addr_t sg_physaddr; 512 struct ahc_dma_seg* sg_vaddr; 513 SLIST_ENTRY(sg_map_node) links; 514}; 515 516/* 517 * The current state of this SCB. 518 */ 519typedef enum { 520 SCB_FREE = 0x0000, 521 SCB_OTHERTCL_TIMEOUT = 0x0002,/* 522 * Another device was active 523 * during the first timeout for 524 * this SCB so we gave ourselves 525 * an additional timeout period 526 * in case it was hogging the 527 * bus. 528 */ 529 SCB_DEVICE_RESET = 0x0004, 530 SCB_SENSE = 0x0008, 531 SCB_CDB32_PTR = 0x0010, 532 SCB_RECOVERY_SCB = 0x0020, 533 SCB_AUTO_NEGOTIATE = 0x0040,/* Negotiate to achieve goal. */ 534 SCB_NEGOTIATE = 0x0080,/* Negotiation forced for command. */ 535 SCB_ABORT = 0x0100, 536 SCB_UNTAGGEDQ = 0x0200, 537 SCB_ACTIVE = 0x0400, 538 SCB_TARGET_IMMEDIATE = 0x0800, 539 SCB_TRANSMISSION_ERROR = 0x1000,/* 540 * We detected a parity or CRC 541 * error that has effected the 542 * payload of the command. This 543 * flag is checked when normal 544 * status is returned to catch 545 * the case of a target not 546 * responding to our attempt 547 * to report the error. 548 */ 549 SCB_TARGET_SCB = 0x2000, 550 SCB_SILENT = 0x4000 /* 551 * Be quiet about transmission type 552 * errors. They are expected and we 553 * don't want to upset the user. This 554 * flag is typically used during DV. 555 */ 556} scb_flag; 557 558struct scb { 559 struct hardware_scb *hscb; 560 union { 561 SLIST_ENTRY(scb) sle; 562 TAILQ_ENTRY(scb) tqe; 563 } links; 564 LIST_ENTRY(scb) pending_links; 565 ahc_io_ctx_t io_ctx; 566 struct ahc_softc *ahc_softc; 567 scb_flag flags; 568#ifndef __linux__ 569 bus_dmamap_t dmamap; 570#endif 571 struct scb_platform_data *platform_data; 572 struct sg_map_node *sg_map; 573 struct ahc_dma_seg *sg_list; 574 dma_addr_t sg_list_phys; 575 u_int sg_count;/* How full ahc_dma_seg is */ 576}; 577 578struct scb_data { 579 SLIST_HEAD(, scb) free_scbs; /* 580 * Pool of SCBs ready to be assigned 581 * commands to execute. 582 */ 583 struct scb *scbindex[256]; /* 584 * Mapping from tag to SCB. 585 * As tag identifiers are an 586 * 8bit value, we provide space 587 * for all possible tag values. 588 * Any lookups to entries at or 589 * above AHC_SCB_MAX_ALLOC will 590 * always fail. 591 */ 592 struct hardware_scb *hscbs; /* Array of hardware SCBs */ 593 struct scb *scbarray; /* Array of kernel SCBs */ 594 struct scsi_sense_data *sense; /* Per SCB sense data */ 595 596 /* 597 * "Bus" addresses of our data structures. 598 */ 599 bus_dma_tag_t hscb_dmat; /* dmat for our hardware SCB array */ 600 bus_dmamap_t hscb_dmamap; 601 dma_addr_t hscb_busaddr; 602 bus_dma_tag_t sense_dmat; 603 bus_dmamap_t sense_dmamap; 604 dma_addr_t sense_busaddr; 605 bus_dma_tag_t sg_dmat; /* dmat for our sg segments */ 606 SLIST_HEAD(, sg_map_node) sg_maps; 607 uint8_t numscbs; 608 uint8_t maxhscbs; /* Number of SCBs on the card */ 609 uint8_t init_level; /* 610 * How far we've initialized 611 * this structure. 612 */ 613}; 614 615/************************ Target Mode Definitions *****************************/ 616 617/* 618 * Connection desciptor for select-in requests in target mode. 619 */ 620struct target_cmd { 621 uint8_t scsiid; /* Our ID and the initiator's ID */ 622 uint8_t identify; /* Identify message */ 623 uint8_t bytes[22]; /* 624 * Bytes contains any additional message 625 * bytes terminated by 0xFF. The remainder 626 * is the cdb to execute. 627 */ 628 uint8_t cmd_valid; /* 629 * When a command is complete, the firmware 630 * will set cmd_valid to all bits set. 631 * After the host has seen the command, 632 * the bits are cleared. This allows us 633 * to just peek at host memory to determine 634 * if more work is complete. cmd_valid is on 635 * an 8 byte boundary to simplify setting 636 * it on aic7880 hardware which only has 637 * limited direct access to the DMA FIFO. 638 */ 639 uint8_t pad[7]; 640}; 641 642/* 643 * Number of events we can buffer up if we run out 644 * of immediate notify ccbs. 645 */ 646#define AHC_TMODE_EVENT_BUFFER_SIZE 8 647struct ahc_tmode_event { 648 uint8_t initiator_id; 649 uint8_t event_type; /* MSG type or EVENT_TYPE_BUS_RESET */ 650#define EVENT_TYPE_BUS_RESET 0xFF 651 uint8_t event_arg; 652}; 653 654/* 655 * Per enabled lun target mode state. 656 * As this state is directly influenced by the host OS'es target mode 657 * environment, we let the OS module define it. Forward declare the 658 * structure here so we can store arrays of them, etc. in OS neutral 659 * data structures. 660 */ 661#ifdef AHC_TARGET_MODE 662struct ahc_tmode_lstate { 663 struct cam_path *path; 664 struct ccb_hdr_slist accept_tios; 665 struct ccb_hdr_slist immed_notifies; 666 struct ahc_tmode_event event_buffer[AHC_TMODE_EVENT_BUFFER_SIZE]; 667 uint8_t event_r_idx; 668 uint8_t event_w_idx; 669}; 670#else 671struct ahc_tmode_lstate; 672#endif 673 674/******************** Transfer Negotiation Datastructures *********************/ 675#define AHC_TRANS_CUR 0x01 /* Modify current neogtiation status */ 676#define AHC_TRANS_ACTIVE 0x03 /* Assume this target is on the bus */ 677#define AHC_TRANS_GOAL 0x04 /* Modify negotiation goal */ 678#define AHC_TRANS_USER 0x08 /* Modify user negotiation settings */ 679 680#define AHC_WIDTH_UNKNOWN 0xFF 681#define AHC_PERIOD_UNKNOWN 0xFF 682#define AHC_OFFSET_UNKNOWN 0xFF 683#define AHC_PPR_OPTS_UNKNOWN 0xFF 684 685/* 686 * Transfer Negotiation Information. 687 */ 688struct ahc_transinfo { 689 uint8_t protocol_version; /* SCSI Revision level */ 690 uint8_t transport_version; /* SPI Revision level */ 691 uint8_t width; /* Bus width */ 692 uint8_t period; /* Sync rate factor */ 693 uint8_t offset; /* Sync offset */ 694 uint8_t ppr_options; /* Parallel Protocol Request options */ 695}; 696 697/* 698 * Per-initiator current, goal and user transfer negotiation information. */ 699struct ahc_initiator_tinfo { 700 uint8_t scsirate; /* Computed value for SCSIRATE reg */ 701 struct ahc_transinfo curr; 702 struct ahc_transinfo goal; 703 struct ahc_transinfo user; 704}; 705 706/* 707 * Per enabled target ID state. 708 * Pointers to lun target state as well as sync/wide negotiation information 709 * for each initiator<->target mapping. For the initiator role we pretend 710 * that we are the target and the targets are the initiators since the 711 * negotiation is the same regardless of role. 712 */ 713struct ahc_tmode_tstate { 714 struct ahc_tmode_lstate* enabled_luns[AHC_NUM_LUNS]; 715 struct ahc_initiator_tinfo transinfo[AHC_NUM_TARGETS]; 716 717 /* 718 * Per initiator state bitmasks. 719 */ 720 uint16_t auto_negotiate;/* Auto Negotiation Required */ 721 uint16_t ultraenb; /* Using ultra sync rate */ 722 uint16_t discenable; /* Disconnection allowed */ 723 uint16_t tagenable; /* Tagged Queuing allowed */ 724}; 725 726/* 727 * Data structure for our table of allowed synchronous transfer rates. 728 */ 729struct ahc_syncrate { 730 u_int sxfr_u2; /* Value of the SXFR parameter for Ultra2+ Chips */ 731 u_int sxfr; /* Value of the SXFR parameter for <= Ultra Chips */ 732#define ULTRA_SXFR 0x100 /* Rate Requires Ultra Mode set */ 733#define ST_SXFR 0x010 /* Rate Single Transition Only */ 734#define DT_SXFR 0x040 /* Rate Double Transition Only */ 735 uint8_t period; /* Period to send to SCSI target */ 736 char *rate; 737}; 738 739/* Safe and valid period for async negotiations. */ 740#define AHC_ASYNC_XFER_PERIOD 0x45 741#define AHC_ULTRA2_XFER_PERIOD 0x0a 742 743/* 744 * Indexes into our table of syncronous transfer rates. 745 */ 746#define AHC_SYNCRATE_DT 0 747#define AHC_SYNCRATE_ULTRA2 1 748#define AHC_SYNCRATE_ULTRA 3 749#define AHC_SYNCRATE_FAST 6 750#define AHC_SYNCRATE_MAX AHC_SYNCRATE_DT 751#define AHC_SYNCRATE_MIN 13 752 753/***************************** Lookup Tables **********************************/ 754/* 755 * Phase -> name and message out response 756 * to parity errors in each phase table. 757 */ 758struct ahc_phase_table_entry { 759 uint8_t phase; 760 uint8_t mesg_out; /* Message response to parity errors */ 761 char *phasemsg; 762}; 763 764/************************** Serial EEPROM Format ******************************/ 765 766struct seeprom_config { 767/* 768 * Per SCSI ID Configuration Flags 769 */ 770 uint16_t device_flags[16]; /* words 0-15 */ 771#define CFXFER 0x0007 /* synchronous transfer rate */ 772#define CFSYNCH 0x0008 /* enable synchronous transfer */ 773#define CFDISC 0x0010 /* enable disconnection */ 774#define CFWIDEB 0x0020 /* wide bus device */ 775#define CFSYNCHISULTRA 0x0040 /* CFSYNCH is an ultra offset (2940AU)*/ 776#define CFSYNCSINGLE 0x0080 /* Single-Transition signalling */ 777#define CFSTART 0x0100 /* send start unit SCSI command */ 778#define CFINCBIOS 0x0200 /* include in BIOS scan */ 779#define CFRNFOUND 0x0400 /* report even if not found */ 780#define CFMULTILUNDEV 0x0800 /* Probe multiple luns in BIOS scan */ 781#define CFWBCACHEENB 0x4000 /* Enable W-Behind Cache on disks */ 782#define CFWBCACHENOP 0xc000 /* Don't touch W-Behind Cache */ 783 784/* 785 * BIOS Control Bits 786 */ 787 uint16_t bios_control; /* word 16 */ 788#define CFSUPREM 0x0001 /* support all removeable drives */ 789#define CFSUPREMB 0x0002 /* support removeable boot drives */ 790#define CFBIOSEN 0x0004 /* BIOS enabled */ 791#define CFBIOS_BUSSCAN 0x0008 /* Have the BIOS Scan the Bus */ 792#define CFSM2DRV 0x0010 /* support more than two drives */ 793#define CFSTPWLEVEL 0x0010 /* Termination level control */ 794#define CF284XEXTEND 0x0020 /* extended translation (284x cards) */ 795#define CFCTRL_A 0x0020 /* BIOS displays Ctrl-A message */ 796#define CFTERM_MENU 0x0040 /* BIOS displays termination menu */ 797#define CFEXTEND 0x0080 /* extended translation enabled */ 798#define CFSCAMEN 0x0100 /* SCAM enable */ 799#define CFMSG_LEVEL 0x0600 /* BIOS Message Level */ 800#define CFMSG_VERBOSE 0x0000 801#define CFMSG_SILENT 0x0200 802#define CFMSG_DIAG 0x0400 803#define CFBOOTCD 0x0800 /* Support Bootable CD-ROM */ 804/* UNUSED 0xff00 */ 805 806/* 807 * Host Adapter Control Bits 808 */ 809 uint16_t adapter_control; /* word 17 */ 810#define CFAUTOTERM 0x0001 /* Perform Auto termination */ 811#define CFULTRAEN 0x0002 /* Ultra SCSI speed enable */ 812#define CF284XSELTO 0x0003 /* Selection timeout (284x cards) */ 813#define CF284XFIFO 0x000C /* FIFO Threshold (284x cards) */ 814#define CFSTERM 0x0004 /* SCSI low byte termination */ 815#define CFWSTERM 0x0008 /* SCSI high byte termination */ 816#define CFSPARITY 0x0010 /* SCSI parity */ 817#define CF284XSTERM 0x0020 /* SCSI low byte term (284x cards) */ 818#define CFMULTILUN 0x0020 819#define CFRESETB 0x0040 /* reset SCSI bus at boot */ 820#define CFCLUSTERENB 0x0080 /* Cluster Enable */ 821#define CFBOOTCHAN 0x0300 /* probe this channel first */ 822#define CFBOOTCHANSHIFT 8 823#define CFSEAUTOTERM 0x0400 /* Ultra2 Perform secondary Auto Term*/ 824#define CFSELOWTERM 0x0800 /* Ultra2 secondary low term */ 825#define CFSEHIGHTERM 0x1000 /* Ultra2 secondary high term */ 826#define CFENABLEDV 0x4000 /* Perform Domain Validation*/ 827 828/* 829 * Bus Release Time, Host Adapter ID 830 */ 831 uint16_t brtime_id; /* word 18 */ 832#define CFSCSIID 0x000f /* host adapter SCSI ID */ 833/* UNUSED 0x00f0 */ 834#define CFBRTIME 0xff00 /* bus release time */ 835 836/* 837 * Maximum targets 838 */ 839 uint16_t max_targets; /* word 19 */ 840#define CFMAXTARG 0x00ff /* maximum targets */ 841#define CFBOOTLUN 0x0f00 /* Lun to boot from */ 842#define CFBOOTID 0xf000 /* Target to boot from */ 843 uint16_t res_1[10]; /* words 20-29 */ 844 uint16_t signature; /* Signature == 0x250 */ 845#define CFSIGNATURE 0x250 846#define CFSIGNATURE2 0x300 847 uint16_t checksum; /* word 31 */ 848}; 849 850/**************************** Message Buffer *********************************/ 851typedef enum { 852 MSG_TYPE_NONE = 0x00, 853 MSG_TYPE_INITIATOR_MSGOUT = 0x01, 854 MSG_TYPE_INITIATOR_MSGIN = 0x02, 855 MSG_TYPE_TARGET_MSGOUT = 0x03, 856 MSG_TYPE_TARGET_MSGIN = 0x04 857} ahc_msg_type; 858 859typedef enum { 860 MSGLOOP_IN_PROG, 861 MSGLOOP_MSGCOMPLETE, 862 MSGLOOP_TERMINATED 863} msg_loop_stat; 864 865/*********************** Software Configuration Structure *********************/ 866TAILQ_HEAD(scb_tailq, scb); 867 868struct ahc_aic7770_softc { 869 /* 870 * Saved register state used for chip_init(). 871 */ 872 uint8_t busspd; 873 uint8_t bustime; 874}; 875 876struct ahc_pci_softc { 877 /* 878 * Saved register state used for chip_init(). 879 */ 880 uint32_t devconfig; 881 uint16_t targcrccnt; 882 uint8_t command; 883 uint8_t csize_lattime; 884 uint8_t optionmode; 885 uint8_t crccontrol1; 886 uint8_t dscommand0; 887 uint8_t dspcistatus; 888 uint8_t scbbaddr; 889 uint8_t dff_thrsh; 890}; 891 892union ahc_bus_softc { 893 struct ahc_aic7770_softc aic7770_softc; 894 struct ahc_pci_softc pci_softc; 895}; 896 897typedef void (*ahc_bus_intr_t)(struct ahc_softc *); 898typedef int (*ahc_bus_chip_init_t)(struct ahc_softc *); 899typedef int (*ahc_bus_suspend_t)(struct ahc_softc *); 900typedef int (*ahc_bus_resume_t)(struct ahc_softc *); 901typedef void ahc_callback_t (void *); 902 903struct ahc_softc { 904 bus_space_tag_t tag; 905 bus_space_handle_t bsh; 906#ifndef __linux__ 907 bus_dma_tag_t buffer_dmat; /* dmat for buffer I/O */ 908#endif 909 struct scb_data *scb_data; 910 911 struct scb *next_queued_scb; 912 913 /* 914 * SCBs that have been sent to the controller 915 */ 916 LIST_HEAD(, scb) pending_scbs; 917 918 /* 919 * Counting lock for deferring the release of additional 920 * untagged transactions from the untagged_queues. When 921 * the lock is decremented to 0, all queues in the 922 * untagged_queues array are run. 923 */ 924 u_int untagged_queue_lock; 925 926 /* 927 * Per-target queue of untagged-transactions. The 928 * transaction at the head of the queue is the 929 * currently pending untagged transaction for the 930 * target. The driver only allows a single untagged 931 * transaction per target. 932 */ 933 struct scb_tailq untagged_queues[AHC_NUM_TARGETS]; 934 935 /* 936 * Bus attachment specific data. 937 */ 938 union ahc_bus_softc bus_softc; 939 940 /* 941 * Platform specific data. 942 */ 943 struct ahc_platform_data *platform_data; 944 945 /* 946 * Platform specific device information. 947 */ 948 ahc_dev_softc_t dev_softc; 949 950 /* 951 * Bus specific device information. 952 */ 953 ahc_bus_intr_t bus_intr; 954 955 /* 956 * Bus specific initialization required 957 * after a chip reset. 958 */ 959 ahc_bus_chip_init_t bus_chip_init; 960 961 /* 962 * Bus specific suspend routine. 963 */ 964 ahc_bus_suspend_t bus_suspend; 965 966 /* 967 * Bus specific resume routine. 968 */ 969 ahc_bus_resume_t bus_resume; 970 971 /* 972 * Target mode related state kept on a per enabled lun basis. 973 * Targets that are not enabled will have null entries. 974 * As an initiator, we keep one target entry for our initiator 975 * ID to store our sync/wide transfer settings. 976 */ 977 struct ahc_tmode_tstate *enabled_targets[AHC_NUM_TARGETS]; 978 979 /* 980 * The black hole device responsible for handling requests for 981 * disabled luns on enabled targets. 982 */ 983 struct ahc_tmode_lstate *black_hole; 984 985 /* 986 * Device instance currently on the bus awaiting a continue TIO 987 * for a command that was not given the disconnect priveledge. 988 */ 989 struct ahc_tmode_lstate *pending_device; 990 991 /* 992 * Card characteristics 993 */ 994 ahc_chip chip; 995 ahc_feature features; 996 ahc_bug bugs; 997 ahc_flag flags; 998 struct seeprom_config *seep_config; 999 1000 /* Values to store in the SEQCTL register for pause and unpause */ 1001 uint8_t unpause; 1002 uint8_t pause; 1003 1004 /* Command Queues */ 1005 uint8_t qoutfifonext; 1006 uint8_t qinfifonext; 1007 uint8_t *qoutfifo; 1008 uint8_t *qinfifo; 1009 1010 /* Critical Section Data */ 1011 struct cs *critical_sections; 1012 u_int num_critical_sections; 1013 1014 /* Channel Names ('A', 'B', etc.) */ 1015 char channel; 1016 char channel_b; 1017 1018 /* Initiator Bus ID */ 1019 uint8_t our_id; 1020 uint8_t our_id_b; 1021 1022 /* 1023 * PCI error detection. 1024 */ 1025 int unsolicited_ints; 1026 1027 /* 1028 * Target incoming command FIFO. 1029 */ 1030 struct target_cmd *targetcmds; 1031 uint8_t tqinfifonext; 1032 1033 /* 1034 * Cached copy of the sequencer control register. 1035 */ 1036 uint8_t seqctl; 1037 1038 /* 1039 * Incoming and outgoing message handling. 1040 */ 1041 uint8_t send_msg_perror; 1042 ahc_msg_type msg_type; 1043 uint8_t msgout_buf[12];/* Message we are sending */ 1044 uint8_t msgin_buf[12];/* Message we are receiving */ 1045 u_int msgout_len; /* Length of message to send */ 1046 u_int msgout_index; /* Current index in msgout */ 1047 u_int msgin_index; /* Current index in msgin */ 1048 1049 /* 1050 * Mapping information for data structures shared 1051 * between the sequencer and kernel. 1052 */ 1053 bus_dma_tag_t parent_dmat; 1054 bus_dma_tag_t shared_data_dmat; 1055 bus_dmamap_t shared_data_dmamap; 1056 dma_addr_t shared_data_busaddr; 1057 1058 dma_addr_t dma_bug_buf; 1059 1060 /* Number of enabled target mode device on this card */ 1061 u_int enabled_luns; 1062 1063 /* Initialization level of this data structure */ 1064 u_int init_level; 1065 1066 /* PCI cacheline size. */ 1067 u_int pci_cachesize; 1068 1069 /* 1070 * Count of parity errors we have seen as a target. 1071 * We auto-disable parity error checking after seeing 1072 * AHC_PCI_TARGET_PERR_THRESH number of errors. 1073 */ 1074 u_int pci_target_perr_count; 1075#define AHC_PCI_TARGET_PERR_THRESH 10 1076 1077 /* Maximum number of sequencer instructions supported. */ 1078 u_int instruction_ram_size; 1079 1080 /* Per-Unit descriptive information */ 1081 const char *description; 1082 char *name; 1083 int unit; 1084 1085 /* Selection Timer settings */ 1086 int seltime; 1087 int seltime_b; 1088 1089 uint16_t user_discenable;/* Disconnection allowed */ 1090 uint16_t user_tagenable;/* Tagged Queuing allowed */ 1091}; 1092 1093/************************ Active Device Information ***************************/ 1094typedef enum { 1095 ROLE_UNKNOWN, 1096 ROLE_INITIATOR, 1097 ROLE_TARGET 1098} role_t; 1099 1100struct ahc_devinfo { 1101 int our_scsiid; 1102 int target_offset; 1103 uint16_t target_mask; 1104 u_int target; 1105 u_int lun; 1106 char channel; 1107 role_t role; /* 1108 * Only guaranteed to be correct if not 1109 * in the busfree state. 1110 */ 1111}; 1112 1113/****************************** PCI Structures ********************************/ 1114typedef int (ahc_device_setup_t)(struct ahc_softc *); 1115 1116struct ahc_pci_identity { 1117 uint64_t full_id; 1118 uint64_t id_mask; 1119 char *name; 1120 ahc_device_setup_t *setup; 1121}; 1122 1123/***************************** VL/EISA Declarations ***************************/ 1124struct aic7770_identity { 1125 uint32_t full_id; 1126 uint32_t id_mask; 1127 const char *name; 1128 ahc_device_setup_t *setup; 1129}; 1130extern struct aic7770_identity aic7770_ident_table[]; 1131extern const int ahc_num_aic7770_devs; 1132 1133#define AHC_EISA_SLOT_OFFSET 0xc00 1134#define AHC_EISA_IOSIZE 0x100 1135 1136/*************************** Function Declarations ****************************/ 1137/******************************************************************************/ 1138u_int ahc_index_busy_tcl(struct ahc_softc *ahc, u_int tcl); 1139void ahc_unbusy_tcl(struct ahc_softc *ahc, u_int tcl); 1140void ahc_busy_tcl(struct ahc_softc *ahc, 1141 u_int tcl, u_int busyid); 1142 1143/***************************** PCI Front End *********************************/ 1144struct ahc_pci_identity *ahc_find_pci_device(ahc_dev_softc_t); 1145int ahc_pci_config(struct ahc_softc *, 1146 struct ahc_pci_identity *); 1147int ahc_pci_test_register_access(struct ahc_softc *); 1148 1149/*************************** EISA/VL Front End ********************************/ 1150struct aic7770_identity *aic7770_find_device(uint32_t); 1151int aic7770_config(struct ahc_softc *ahc, 1152 struct aic7770_identity *, 1153 u_int port); 1154 1155/************************** SCB and SCB queue management **********************/ 1156int ahc_probe_scbs(struct ahc_softc *); 1157void ahc_run_untagged_queues(struct ahc_softc *ahc); 1158void ahc_run_untagged_queue(struct ahc_softc *ahc, 1159 struct scb_tailq *queue); 1160void ahc_qinfifo_requeue_tail(struct ahc_softc *ahc, 1161 struct scb *scb); 1162int ahc_match_scb(struct ahc_softc *ahc, struct scb *scb, 1163 int target, char channel, int lun, 1164 u_int tag, role_t role); 1165 1166/****************************** Initialization ********************************/ 1167struct ahc_softc *ahc_alloc(void *platform_arg, char *name); 1168int ahc_softc_init(struct ahc_softc *); 1169void ahc_controller_info(struct ahc_softc *ahc, char *buf); 1170int ahc_chip_init(struct ahc_softc *ahc); 1171int ahc_init(struct ahc_softc *ahc); 1172void ahc_intr_enable(struct ahc_softc *ahc, int enable); 1173void ahc_pause_and_flushwork(struct ahc_softc *ahc); 1174int ahc_suspend(struct ahc_softc *ahc); 1175int ahc_resume(struct ahc_softc *ahc); 1176void ahc_set_unit(struct ahc_softc *, int); 1177void ahc_set_name(struct ahc_softc *, char *); 1178void ahc_alloc_scbs(struct ahc_softc *ahc); 1179void ahc_free(struct ahc_softc *ahc); 1180int ahc_reset(struct ahc_softc *ahc, int reinit); 1181void ahc_shutdown(void *arg); 1182 1183/*************************** Interrupt Services *******************************/ 1184void ahc_clear_intstat(struct ahc_softc *ahc); 1185void ahc_run_qoutfifo(struct ahc_softc *ahc); 1186#ifdef AHC_TARGET_MODE 1187void ahc_run_tqinfifo(struct ahc_softc *ahc, int paused); 1188#endif 1189void ahc_handle_brkadrint(struct ahc_softc *ahc); 1190void ahc_handle_seqint(struct ahc_softc *ahc, u_int intstat); 1191void ahc_handle_scsiint(struct ahc_softc *ahc, 1192 u_int intstat); 1193void ahc_clear_critical_section(struct ahc_softc *ahc); 1194 1195/***************************** Error Recovery *********************************/ 1196typedef enum { 1197 SEARCH_COMPLETE, 1198 SEARCH_COUNT, 1199 SEARCH_REMOVE 1200} ahc_search_action; 1201int ahc_search_qinfifo(struct ahc_softc *ahc, int target, 1202 char channel, int lun, u_int tag, 1203 role_t role, uint32_t status, 1204 ahc_search_action action); 1205int ahc_search_untagged_queues(struct ahc_softc *ahc, 1206 ahc_io_ctx_t ctx, 1207 int target, char channel, 1208 int lun, uint32_t status, 1209 ahc_search_action action); 1210int ahc_search_disc_list(struct ahc_softc *ahc, int target, 1211 char channel, int lun, u_int tag, 1212 int stop_on_first, int remove, 1213 int save_state); 1214void ahc_freeze_devq(struct ahc_softc *ahc, struct scb *scb); 1215int ahc_reset_channel(struct ahc_softc *ahc, char channel, 1216 int initiate_reset); 1217int ahc_abort_scbs(struct ahc_softc *ahc, int target, 1218 char channel, int lun, u_int tag, 1219 role_t role, uint32_t status); 1220void ahc_restart(struct ahc_softc *ahc); 1221void ahc_calc_residual(struct ahc_softc *ahc, 1222 struct scb *scb); 1223/*************************** Utility Functions ********************************/ 1224struct ahc_phase_table_entry* 1225 ahc_lookup_phase_entry(int phase); 1226void ahc_compile_devinfo(struct ahc_devinfo *devinfo, 1227 u_int our_id, u_int target, 1228 u_int lun, char channel, 1229 role_t role); 1230/************************** Transfer Negotiation ******************************/ 1231struct ahc_syncrate* ahc_find_syncrate(struct ahc_softc *ahc, u_int *period, 1232 u_int *ppr_options, u_int maxsync); 1233u_int ahc_find_period(struct ahc_softc *ahc, 1234 u_int scsirate, u_int maxsync); 1235void ahc_validate_offset(struct ahc_softc *ahc, 1236 struct ahc_initiator_tinfo *tinfo, 1237 struct ahc_syncrate *syncrate, 1238 u_int *offset, int wide, 1239 role_t role); 1240void ahc_validate_width(struct ahc_softc *ahc, 1241 struct ahc_initiator_tinfo *tinfo, 1242 u_int *bus_width, 1243 role_t role); 1244/* 1245 * Negotiation types. These are used to qualify if we should renegotiate 1246 * even if our goal and current transport parameters are identical. 1247 */ 1248typedef enum { 1249 AHC_NEG_TO_GOAL, /* Renegotiate only if goal and curr differ. */ 1250 AHC_NEG_IF_NON_ASYNC, /* Renegotiate so long as goal is non-async. */ 1251 AHC_NEG_ALWAYS /* Renegotiat even if goal is async. */ 1252} ahc_neg_type; 1253int ahc_update_neg_request(struct ahc_softc*, 1254 struct ahc_devinfo*, 1255 struct ahc_tmode_tstate*, 1256 struct ahc_initiator_tinfo*, 1257 ahc_neg_type); 1258void ahc_set_width(struct ahc_softc *ahc, 1259 struct ahc_devinfo *devinfo, 1260 u_int width, u_int type, int paused); 1261void ahc_set_syncrate(struct ahc_softc *ahc, 1262 struct ahc_devinfo *devinfo, 1263 struct ahc_syncrate *syncrate, 1264 u_int period, u_int offset, 1265 u_int ppr_options, 1266 u_int type, int paused); 1267typedef enum { 1268 AHC_QUEUE_NONE, 1269 AHC_QUEUE_BASIC, 1270 AHC_QUEUE_TAGGED 1271} ahc_queue_alg; 1272 1273/**************************** Target Mode *************************************/ 1274#ifdef AHC_TARGET_MODE 1275void ahc_send_lstate_events(struct ahc_softc *, 1276 struct ahc_tmode_lstate *); 1277void ahc_handle_en_lun(struct ahc_softc *ahc, 1278 struct cam_sim *sim, union ccb *ccb); 1279cam_status ahc_find_tmode_devs(struct ahc_softc *ahc, 1280 struct cam_sim *sim, union ccb *ccb, 1281 struct ahc_tmode_tstate **tstate, 1282 struct ahc_tmode_lstate **lstate, 1283 int notfound_failure); 1284#ifndef AHC_TMODE_ENABLE 1285#define AHC_TMODE_ENABLE 0 1286#endif 1287#endif 1288/******************************* Debug ***************************************/ 1289#ifdef AHC_DEBUG 1290extern uint32_t ahc_debug; 1291#define AHC_SHOW_MISC 0x0001 1292#define AHC_SHOW_SENSE 0x0002 1293#define AHC_DUMP_SEEPROM 0x0004 1294#define AHC_SHOW_TERMCTL 0x0008 1295#define AHC_SHOW_MEMORY 0x0010 1296#define AHC_SHOW_MESSAGES 0x0020 1297#define AHC_SHOW_DV 0x0040 1298#define AHC_SHOW_SELTO 0x0080 1299#define AHC_SHOW_QFULL 0x0200 1300#define AHC_SHOW_QUEUE 0x0400 1301#define AHC_SHOW_TQIN 0x0800 1302#define AHC_SHOW_MASKED_ERRORS 0x1000 1303#define AHC_DEBUG_SEQUENCER 0x2000 1304#endif 1305void ahc_print_scb(struct scb *scb); 1306void ahc_print_devinfo(struct ahc_softc *ahc, 1307 struct ahc_devinfo *dev); 1308void ahc_dump_card_state(struct ahc_softc *ahc); 1309int ahc_print_register(ahc_reg_parse_entry_t *table, 1310 u_int num_entries, 1311 const char *name, 1312 u_int address, 1313 u_int value, 1314 u_int *cur_column, 1315 u_int wrap_point); 1316/******************************* SEEPROM *************************************/ 1317int ahc_acquire_seeprom(struct ahc_softc *ahc, 1318 struct seeprom_descriptor *sd); 1319void ahc_release_seeprom(struct seeprom_descriptor *sd); 1320#endif /* _AIC7XXX_H_ */ 1321