drivers/scsi/aic7xxx/aic79xx_osm.h

   1 /*
   2  * Adaptec AIC79xx device driver for Linux.
   3  *
   4  * Copyright (c) 2000-2001 Adaptec Inc.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions, and the following disclaimer,
  12  *    without modification.
  13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  14  *    substantially similar to the "NO WARRANTY" disclaimer below
  15  *    ("Disclaimer") and any redistribution must be conditioned upon
  16  *    including a substantially similar Disclaimer requirement for further
  17  *    binary redistribution.
  18  * 3. Neither the names of the above-listed copyright holders nor the names
  19  *    of any contributors may be used to endorse or promote products derived
  20  *    from this software without specific prior written permission.
  21  *
  22  * Alternatively, this software may be distributed under the terms of the
  23  * GNU General Public License ("GPL") version 2 as published by the Free
  24  * Software Foundation.
  25  *
  26  * NO WARRANTY
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  35  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  36  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37  * POSSIBILITY OF SUCH DAMAGES.
  38  *
  39  * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic79xx_osm.h#137 $
  40  *
  41  */
  42 #ifndef _AIC79XX_LINUX_H_
  43 #define _AIC79XX_LINUX_H_
  44
  45 #include <linux/config.h>
  46 #include <linux/types.h>
  47 #include <linux/blkdev.h>
  48 #include <linux/delay.h>
  49 #include <linux/ioport.h>
  50 #include <linux/pci.h>
  51 #include <linux/smp_lock.h>
  52 #include <linux/interrupt.h>
  53 #include <linux/module.h>
  54 #include <linux/slab.h>
  55 #include <asm/byteorder.h>
  56 #include <asm/io.h>
  57
  58 #include <scsi/scsi.h>
  59 #include <scsi/scsi_cmnd.h>
  60 #include <scsi/scsi_eh.h>
  61 #include <scsi/scsi_device.h>
  62 #include <scsi/scsi_host.h>
  63 #include <scsi/scsi_tcq.h>
  64 #include <scsi/scsi_transport.h>
  65 #include <scsi/scsi_transport_spi.h>
  66
  67 /* Core SCSI definitions */
  68 #define AIC_LIB_PREFIX ahd
  69
  70 /* Name space conflict with BSD queue macros */
  71 #ifdef LIST_HEAD
  72 #undef LIST_HEAD
  73 #endif
  74
  75 #include "cam.h"
  76 #include "queue.h"
  77 #include "scsi_message.h"
  78 #include "scsi_iu.h"
  79 #include "aiclib.h"
  80
  81 /*********************************** Debugging ********************************/
  82 #ifdef CONFIG_AIC79XX_DEBUG_ENABLE
  83 #ifdef CONFIG_AIC79XX_DEBUG_MASK
  84 #define AHD_DEBUG 1
  85 #define AHD_DEBUG_OPTS CONFIG_AIC79XX_DEBUG_MASK
  86 #else
  87 /*
  88  * Compile in debugging code, but do not enable any printfs.
  89  */
  90 #define AHD_DEBUG 1
  91 #define AHD_DEBUG_OPTS 0
  92 #endif
  93 /* No debugging code. */
  94 #endif
  95
  96 /********************************** Misc Macros *******************************/
  97 #define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
  98 #define powerof2(x)     ((((x)-1)&(x))==0)
  99
 100 /************************* Forward Declarations *******************************/
 101 struct ahd_softc;
 102 typedef struct pci_dev *ahd_dev_softc_t;
 103 typedef struct scsi_cmnd      *ahd_io_ctx_t;
 104
 105 /******************************* Byte Order ***********************************/
 106 #define ahd_htobe16(x)  cpu_to_be16(x)
 107 #define ahd_htobe32(x)  cpu_to_be32(x)
 108 #define ahd_htobe64(x)  cpu_to_be64(x)
 109 #define ahd_htole16(x)  cpu_to_le16(x)
 110 #define ahd_htole32(x)  cpu_to_le32(x)
 111 #define ahd_htole64(x)  cpu_to_le64(x)
 112
 113 #define ahd_be16toh(x)  be16_to_cpu(x)
 114 #define ahd_be32toh(x)  be32_to_cpu(x)
 115 #define ahd_be64toh(x)  be64_to_cpu(x)
 116 #define ahd_le16toh(x)  le16_to_cpu(x)
 117 #define ahd_le32toh(x)  le32_to_cpu(x)
 118 #define ahd_le64toh(x)  le64_to_cpu(x)
 119
 120 /************************* Configuration Data *********************************/
 121 extern uint32_t aic79xx_allow_memio;
 122 extern struct scsi_host_template aic79xx_driver_template;
 123
 124 /***************************** Bus Space/DMA **********************************/
 125
 126 typedef uint32_t bus_size_t;
 127
 128 typedef enum {
 129         BUS_SPACE_MEMIO,
 130         BUS_SPACE_PIO
 131 } bus_space_tag_t;
 132
 133 typedef union {
 134         u_long            ioport;
 135         volatile uint8_t __iomem *maddr;
 136 } bus_space_handle_t;
 137
 138 typedef struct bus_dma_segment
 139 {
 140         dma_addr_t      ds_addr;
 141         bus_size_t      ds_len;
 142 } bus_dma_segment_t;
 143
 144 struct ahd_linux_dma_tag
 145 {
 146         bus_size_t      alignment;
 147         bus_size_t      boundary;
 148         bus_size_t      maxsize;
 149 };
 150 typedef struct ahd_linux_dma_tag* bus_dma_tag_t;
 151
 152 typedef dma_addr_t bus_dmamap_t;
 153
 154 typedef int bus_dma_filter_t(void*, dma_addr_t);
 155 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
 156
 157 #define BUS_DMA_WAITOK          0x0
 158 #define BUS_DMA_NOWAIT          0x1
 159 #define BUS_DMA_ALLOCNOW        0x2
 160 #define BUS_DMA_LOAD_SEGS       0x4     /*
 161                                          * Argument is an S/G list not
 162                                          * a single buffer.
 163                                          */
 164
 165 #define BUS_SPACE_MAXADDR       0xFFFFFFFF
 166 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
 167 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
 168
 169 int     ahd_dma_tag_create(struct ahd_softc *, bus_dma_tag_t /*parent*/,
 170                            bus_size_t /*alignment*/, bus_size_t /*boundary*/,
 171                            dma_addr_t /*lowaddr*/, dma_addr_t /*highaddr*/,
 172                            bus_dma_filter_t*/*filter*/, void */*filterarg*/,
 173                            bus_size_t /*maxsize*/, int /*nsegments*/,
 174                            bus_size_t /*maxsegsz*/, int /*flags*/,
 175                            bus_dma_tag_t */*dma_tagp*/);
 176
 177 void    ahd_dma_tag_destroy(struct ahd_softc *, bus_dma_tag_t /*tag*/);
 178
 179 int     ahd_dmamem_alloc(struct ahd_softc *, bus_dma_tag_t /*dmat*/,
 180                          void** /*vaddr*/, int /*flags*/,
 181                          bus_dmamap_t* /*mapp*/);
 182
 183 void    ahd_dmamem_free(struct ahd_softc *, bus_dma_tag_t /*dmat*/,
 184                         void* /*vaddr*/, bus_dmamap_t /*map*/);
 185
 186 void    ahd_dmamap_destroy(struct ahd_softc *, bus_dma_tag_t /*tag*/,
 187                            bus_dmamap_t /*map*/);
 188
 189 int     ahd_dmamap_load(struct ahd_softc *ahd, bus_dma_tag_t /*dmat*/,
 190                         bus_dmamap_t /*map*/, void * /*buf*/,
 191                         bus_size_t /*buflen*/, bus_dmamap_callback_t *,
 192                         void */*callback_arg*/, int /*flags*/);
 193
 194 int     ahd_dmamap_unload(struct ahd_softc *, bus_dma_tag_t, bus_dmamap_t);
 195
 196 /*
 197  * Operations performed by ahd_dmamap_sync().
 198  */
 199 #define BUS_DMASYNC_PREREAD     0x01    /* pre-read synchronization */
 200 #define BUS_DMASYNC_POSTREAD    0x02    /* post-read synchronization */
 201 #define BUS_DMASYNC_PREWRITE    0x04    /* pre-write synchronization */
 202 #define BUS_DMASYNC_POSTWRITE   0x08    /* post-write synchronization */
 203
 204 /*
 205  * XXX
 206  * ahd_dmamap_sync is only used on buffers allocated with
 207  * the pci_alloc_consistent() API.  Although I'm not sure how
 208  * this works on architectures with a write buffer, Linux does
 209  * not have an API to sync "coherent" memory.  Perhaps we need
 210  * to do an mb()?
 211  */
 212 #define ahd_dmamap_sync(ahd, dma_tag, dmamap, offset, len, op)
 213
 214 /************************** Timer DataStructures ******************************/
 215 typedef struct timer_list ahd_timer_t;
 216
 217 /********************************** Includes **********************************/
 218 #ifdef CONFIG_AIC79XX_REG_PRETTY_PRINT
 219 #define AIC_DEBUG_REGISTERS 1
 220 #else
 221 #define AIC_DEBUG_REGISTERS 0
 222 #endif
 223 #include "aic79xx.h"
 224
 225 /***************************** Timer Facilities *******************************/
 226 #define ahd_timer_init init_timer
 227 #define ahd_timer_stop del_timer_sync
 228 typedef void ahd_linux_callback_t (u_long);
 229 static __inline void ahd_timer_reset(ahd_timer_t *timer, int usec,
 230                                      ahd_callback_t *func, void *arg);
 231 static __inline void ahd_scb_timer_reset(struct scb *scb, u_int usec);
 232
 233 static __inline void
 234 ahd_timer_reset(ahd_timer_t *timer, int usec, ahd_callback_t *func, void *arg)
 235 {
 236         struct ahd_softc *ahd;
 237
 238         ahd = (struct ahd_softc *)arg;
 239         del_timer(timer);
 240         timer->data = (u_long)arg;
 241         timer->expires = jiffies + (usec * HZ)/1000000;
 242         timer->function = (ahd_linux_callback_t*)func;
 243         add_timer(timer);
 244 }
 245
 246 static __inline void
 247 ahd_scb_timer_reset(struct scb *scb, u_int usec)
 248 {
 249         mod_timer(&scb->io_ctx->eh_timeout, jiffies + (usec * HZ)/1000000);
 250 }
 251
 252 /***************************** SMP support ************************************/
 253 #include <linux/spinlock.h>
 254
 255 #define AIC79XX_DRIVER_VERSION "3.0"
 256
 257 /*************************** Device Data Structures ***************************/
 258 /*
 259  * A per probed device structure used to deal with some error recovery
 260  * scenarios that the Linux mid-layer code just doesn't know how to
 261  * handle.  The structure allocated for a device only becomes persistent
 262  * after a successfully completed inquiry command to the target when
 263  * that inquiry data indicates a lun is present.
 264  */
 265
 266 typedef enum {
 267         AHD_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
 268         AHD_DEV_Q_BASIC          = 0x10, /* Allow basic device queuing */
 269         AHD_DEV_Q_TAGGED         = 0x20, /* Allow full SCSI2 command queueing */
 270         AHD_DEV_PERIODIC_OTAG    = 0x40, /* Send OTAG to prevent starvation */
 271 } ahd_linux_dev_flags;
 272
 273 struct ahd_linux_target;
 274 struct ahd_linux_device {
 275         TAILQ_ENTRY(ahd_linux_device) links;
 276
 277         /*
 278          * The number of transactions currently
 279          * queued to the device.
 280          */
 281         int                     active;
 282
 283         /*
 284          * The currently allowed number of
 285          * transactions that can be queued to
 286          * the device.  Must be signed for
 287          * conversion from tagged to untagged
 288          * mode where the device may have more
 289          * than one outstanding active transaction.
 290          */
 291         int                     openings;
 292
 293         /*
 294          * A positive count indicates that this
 295          * device's queue is halted.
 296          */
 297         u_int                   qfrozen;
 298
 299         /*
 300          * Cumulative command counter.
 301          */
 302         u_long                  commands_issued;
 303
 304         /*
 305          * The number of tagged transactions when
 306          * running at our current opening level
 307          * that have been successfully received by
 308          * this device since the last QUEUE FULL.
 309          */
 310         u_int                   tag_success_count;
 311 #define AHD_TAG_SUCCESS_INTERVAL 50
 312
 313         ahd_linux_dev_flags     flags;
 314
 315         /*
 316          * Per device timer.
 317          */
 318         struct timer_list       timer;
 319
 320         /*
 321          * The high limit for the tags variable.
 322          */
 323         u_int                   maxtags;
 324
 325         /*
 326          * The computed number of tags outstanding
 327          * at the time of the last QUEUE FULL event.
 328          */
 329         u_int                   tags_on_last_queuefull;
 330
 331         /*
 332          * How many times we have seen a queue full
 333          * with the same number of tags.  This is used
 334          * to stop our adaptive queue depth algorithm
 335          * on devices with a fixed number of tags.
 336          */
 337         u_int                   last_queuefull_same_count;
 338 #define AHD_LOCK_TAGS_COUNT 50
 339
 340         /*
 341          * How many transactions have been queued
 342          * without the device going idle.  We use
 343          * this statistic to determine when to issue
 344          * an ordered tag to prevent transaction
 345          * starvation.  This statistic is only updated
 346          * if the AHD_DEV_PERIODIC_OTAG flag is set
 347          * on this device.
 348          */
 349         u_int                   commands_since_idle_or_otag;
 350 #define AHD_OTAG_THRESH 500
 351 };
 352
 353 struct ahd_linux_target {
 354         struct scsi_device       *sdev[AHD_NUM_LUNS];
 355         struct ahd_transinfo      last_tinfo;
 356         struct ahd_softc         *ahd;
 357 };
 358
 359 /********************* Definitions Required by the Core ***********************/
 360 /*
 361  * Number of SG segments we require.  So long as the S/G segments for
 362  * a particular transaction are allocated in a physically contiguous
 363  * manner and are allocated below 4GB, the number of S/G segments is
 364  * unrestricted.
 365  */
 366 #define AHD_NSEG 128
 367
 368 /*
 369  * Per-SCB OSM storage.
 370  */
 371 struct scb_platform_data {
 372         struct ahd_linux_device *dev;
 373         dma_addr_t               buf_busaddr;
 374         uint32_t                 xfer_len;
 375         uint32_t                 sense_resid;   /* Auto-Sense residual */
 376 };
 377
 378 /*
 379  * Define a structure used for each host adapter.  All members are
 380  * aligned on a boundary >= the size of the member to honor the
 381  * alignment restrictions of the various platforms supported by
 382  * this driver.
 383  */
 384 struct ahd_platform_data {
 385         /*
 386          * Fields accessed from interrupt context.
 387          */
 388         struct scsi_target *starget[AHD_NUM_TARGETS];
 389
 390         spinlock_t               spin_lock;
 391         u_int                    qfrozen;
 392         struct timer_list        reset_timer;
 393         struct semaphore         eh_sem;
 394         struct Scsi_Host        *host;          /* pointer to scsi host */
 395 #define AHD_LINUX_NOIRQ ((uint32_t)~0)
 396         uint32_t                 irq;           /* IRQ for this adapter */
 397         uint32_t                 bios_address;
 398         uint32_t                 mem_busaddr;   /* Mem Base Addr */
 399 #define AHD_SCB_UP_EH_SEM 0x1
 400         uint32_t                 flags;
 401 };
 402
 403 /************************** OS Utility Wrappers *******************************/
 404 #define printf printk
 405 #define M_NOWAIT GFP_ATOMIC
 406 #define M_WAITOK 0
 407 #define malloc(size, type, flags) kmalloc(size, flags)
 408 #define free(ptr, type) kfree(ptr)
 409
 410 static __inline void ahd_delay(long);
 411 static __inline void
 412 ahd_delay(long usec)
 413 {
 414         /*
 415          * udelay on Linux can have problems for
 416          * multi-millisecond waits.  Wait at most
 417          * 1024us per call.
 418          */
 419         while (usec > 0) {
 420                 udelay(usec % 1024);
 421                 usec -= 1024;
 422         }
 423 }
 424
 425
 426 /***************************** Low Level I/O **********************************/
 427 static __inline uint8_t ahd_inb(struct ahd_softc * ahd, long port);
 428 static __inline uint16_t ahd_inw_atomic(struct ahd_softc * ahd, long port);
 429 static __inline void ahd_outb(struct ahd_softc * ahd, long port, uint8_t val);
 430 static __inline void ahd_outw_atomic(struct ahd_softc * ahd,
 431                                      long port, uint16_t val);
 432 static __inline void ahd_outsb(struct ahd_softc * ahd, long port,
 433                                uint8_t *, int count);
 434 static __inline void ahd_insb(struct ahd_softc * ahd, long port,
 435                                uint8_t *, int count);
 436
 437 static __inline uint8_t
 438 ahd_inb(struct ahd_softc * ahd, long port)
 439 {
 440         uint8_t x;
 441
 442         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 443                 x = readb(ahd->bshs[0].maddr + port);
 444         } else {
 445                 x = inb(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 446         }
 447         mb();
 448         return (x);
 449 }
 450
 451 static __inline uint16_t
 452 ahd_inw_atomic(struct ahd_softc * ahd, long port)
 453 {
 454         uint8_t x;
 455
 456         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 457                 x = readw(ahd->bshs[0].maddr + port);
 458         } else {
 459                 x = inw(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 460         }
 461         mb();
 462         return (x);
 463 }
 464
 465 static __inline void
 466 ahd_outb(struct ahd_softc * ahd, long port, uint8_t val)
 467 {
 468         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 469                 writeb(val, ahd->bshs[0].maddr + port);
 470         } else {
 471                 outb(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 472         }
 473         mb();
 474 }
 475
 476 static __inline void
 477 ahd_outw_atomic(struct ahd_softc * ahd, long port, uint16_t val)
 478 {
 479         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 480                 writew(val, ahd->bshs[0].maddr + port);
 481         } else {
 482                 outw(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 483         }
 484         mb();
 485 }
 486
 487 static __inline void
 488 ahd_outsb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 489 {
 490         int i;
 491
 492         /*
 493          * There is probably a more efficient way to do this on Linux
 494          * but we don't use this for anything speed critical and this
 495          * should work.
 496          */
 497         for (i = 0; i < count; i++)
 498                 ahd_outb(ahd, port, *array++);
 499 }
 500
 501 static __inline void
 502 ahd_insb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 503 {
 504         int i;
 505
 506         /*
 507          * There is probably a more efficient way to do this on Linux
 508          * but we don't use this for anything speed critical and this
 509          * should work.
 510          */
 511         for (i = 0; i < count; i++)
 512                 *array++ = ahd_inb(ahd, port);
 513 }
 514
 515 /**************************** Initialization **********************************/
 516 int             ahd_linux_register_host(struct ahd_softc *,
 517                                         struct scsi_host_template *);
 518
 519 uint64_t        ahd_linux_get_memsize(void);
 520
 521 /*************************** Pretty Printing **********************************/
 522 struct info_str {
 523         char *buffer;
 524         int length;
 525         off_t offset;
 526         int pos;
 527 };
 528
 529 void    ahd_format_transinfo(struct info_str *info,
 530                              struct ahd_transinfo *tinfo);
 531
 532 /******************************** Locking *************************************/
 533 static __inline void
 534 ahd_lockinit(struct ahd_softc *ahd)
 535 {
 536         spin_lock_init(&ahd->platform_data->spin_lock);
 537 }
 538
 539 static __inline void
 540 ahd_lock(struct ahd_softc *ahd, unsigned long *flags)
 541 {
 542         spin_lock_irqsave(&ahd->platform_data->spin_lock, *flags);
 543 }
 544
 545 static __inline void
 546 ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)
 547 {
 548         spin_unlock_irqrestore(&ahd->platform_data->spin_lock, *flags);
 549 }
 550
 551 /******************************* PCI Definitions ******************************/
 552 /*
 553  * PCIM_xxx: mask to locate subfield in register
 554  * PCIR_xxx: config register offset
 555  * PCIC_xxx: device class
 556  * PCIS_xxx: device subclass
 557  * PCIP_xxx: device programming interface
 558  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
 559  * PCID_xxx: device ID
 560  */
 561 #define PCIR_DEVVENDOR          0x00
 562 #define PCIR_VENDOR             0x00
 563 #define PCIR_DEVICE             0x02
 564 #define PCIR_COMMAND            0x04
 565 #define PCIM_CMD_PORTEN         0x0001
 566 #define PCIM_CMD_MEMEN          0x0002
 567 #define PCIM_CMD_BUSMASTEREN    0x0004
 568 #define PCIM_CMD_MWRICEN        0x0010
 569 #define PCIM_CMD_PERRESPEN      0x0040
 570 #define PCIM_CMD_SERRESPEN      0x0100
 571 #define PCIR_STATUS             0x06
 572 #define PCIR_REVID              0x08
 573 #define PCIR_PROGIF             0x09
 574 #define PCIR_SUBCLASS           0x0a
 575 #define PCIR_CLASS              0x0b
 576 #define PCIR_CACHELNSZ          0x0c
 577 #define PCIR_LATTIMER           0x0d
 578 #define PCIR_HEADERTYPE         0x0e
 579 #define PCIM_MFDEV              0x80
 580 #define PCIR_BIST               0x0f
 581 #define PCIR_CAP_PTR            0x34
 582
 583 /* config registers for header type 0 devices */
 584 #define PCIR_MAPS       0x10
 585 #define PCIR_SUBVEND_0  0x2c
 586 #define PCIR_SUBDEV_0   0x2e
 587
 588 /****************************** PCI-X definitions *****************************/
 589 #define PCIXR_COMMAND   0x96
 590 #define PCIXR_DEVADDR   0x98
 591 #define PCIXM_DEVADDR_FNUM      0x0003  /* Function Number */
 592 #define PCIXM_DEVADDR_DNUM      0x00F8  /* Device Number */
 593 #define PCIXM_DEVADDR_BNUM      0xFF00  /* Bus Number */
 594 #define PCIXR_STATUS    0x9A
 595 #define PCIXM_STATUS_64BIT      0x0001  /* Active 64bit connection to device. */
 596 #define PCIXM_STATUS_133CAP     0x0002  /* Device is 133MHz capable */
 597 #define PCIXM_STATUS_SCDISC     0x0004  /* Split Completion Discarded */
 598 #define PCIXM_STATUS_UNEXPSC    0x0008  /* Unexpected Split Completion */
 599 #define PCIXM_STATUS_CMPLEXDEV  0x0010  /* Device Complexity (set == bridge) */
 600 #define PCIXM_STATUS_MAXMRDBC   0x0060  /* Maximum Burst Read Count */
 601 #define PCIXM_STATUS_MAXSPLITS  0x0380  /* Maximum Split Transactions */
 602 #define PCIXM_STATUS_MAXCRDS    0x1C00  /* Maximum Cumulative Read Size */
 603 #define PCIXM_STATUS_RCVDSCEM   0x2000  /* Received a Split Comp w/Error msg */
 604
 605 extern struct pci_driver aic79xx_pci_driver;
 606
 607 typedef enum
 608 {
 609         AHD_POWER_STATE_D0,
 610         AHD_POWER_STATE_D1,
 611         AHD_POWER_STATE_D2,
 612         AHD_POWER_STATE_D3
 613 } ahd_power_state;
 614
 615 void ahd_power_state_change(struct ahd_softc *ahd,
 616                             ahd_power_state new_state);
 617
 618 /******************************* PCI Routines *********************************/
 619 int                      ahd_linux_pci_init(void);
 620 void                     ahd_linux_pci_exit(void);
 621 int                      ahd_pci_map_registers(struct ahd_softc *ahd);
 622 int                      ahd_pci_map_int(struct ahd_softc *ahd);
 623
 624 static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,
 625                                              int reg, int width);
 626
 627 static __inline uint32_t
 628 ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width)
 629 {
 630         switch (width) {
 631         case 1:
 632         {
 633                 uint8_t retval;
 634
 635                 pci_read_config_byte(pci, reg, &retval);
 636                 return (retval);
 637         }
 638         case 2:
 639         {
 640                 uint16_t retval;
 641                 pci_read_config_word(pci, reg, &retval);
 642                 return (retval);
 643         }
 644         case 4:
 645         {
 646                 uint32_t retval;
 647                 pci_read_config_dword(pci, reg, &retval);
 648                 return (retval);
 649         }
 650         default:
 651                 panic("ahd_pci_read_config: Read size too big");
 652                 /* NOTREACHED */
 653                 return (0);
 654         }
 655 }
 656
 657 static __inline void ahd_pci_write_config(ahd_dev_softc_t pci,
 658                                           int reg, uint32_t value,
 659                                           int width);
 660
 661 static __inline void
 662 ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width)
 663 {
 664         switch (width) {
 665         case 1:
 666                 pci_write_config_byte(pci, reg, value);
 667                 break;
 668         case 2:
 669                 pci_write_config_word(pci, reg, value);
 670                 break;
 671         case 4:
 672                 pci_write_config_dword(pci, reg, value);
 673                 break;
 674         default:
 675                 panic("ahd_pci_write_config: Write size too big");
 676                 /* NOTREACHED */
 677         }
 678 }
 679
 680 static __inline int ahd_get_pci_function(ahd_dev_softc_t);
 681 static __inline int
 682 ahd_get_pci_function(ahd_dev_softc_t pci)
 683 {
 684         return (PCI_FUNC(pci->devfn));
 685 }
 686
 687 static __inline int ahd_get_pci_slot(ahd_dev_softc_t);
 688 static __inline int
 689 ahd_get_pci_slot(ahd_dev_softc_t pci)
 690 {
 691         return (PCI_SLOT(pci->devfn));
 692 }
 693
 694 static __inline int ahd_get_pci_bus(ahd_dev_softc_t);
 695 static __inline int
 696 ahd_get_pci_bus(ahd_dev_softc_t pci)
 697 {
 698         return (pci->bus->number);
 699 }
 700
 701 static __inline void ahd_flush_device_writes(struct ahd_softc *);
 702 static __inline void
 703 ahd_flush_device_writes(struct ahd_softc *ahd)
 704 {
 705         /* XXX Is this sufficient for all architectures??? */
 706         ahd_inb(ahd, INTSTAT);
 707 }
 708
 709 /**************************** Proc FS Support *********************************/
 710 int     ahd_linux_proc_info(struct Scsi_Host *, char *, char **,
 711                             off_t, int, int);
 712
 713 /*********************** Transaction Access Wrappers **************************/
 714 static __inline void ahd_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
 715 static __inline void ahd_set_transaction_status(struct scb *, uint32_t);
 716 static __inline void ahd_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
 717 static __inline void ahd_set_scsi_status(struct scb *, uint32_t);
 718 static __inline uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd);
 719 static __inline uint32_t ahd_get_transaction_status(struct scb *);
 720 static __inline uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd);
 721 static __inline uint32_t ahd_get_scsi_status(struct scb *);
 722 static __inline void ahd_set_transaction_tag(struct scb *, int, u_int);
 723 static __inline u_long ahd_get_transfer_length(struct scb *);
 724 static __inline int ahd_get_transfer_dir(struct scb *);
 725 static __inline void ahd_set_residual(struct scb *, u_long);
 726 static __inline void ahd_set_sense_residual(struct scb *scb, u_long resid);
 727 static __inline u_long ahd_get_residual(struct scb *);
 728 static __inline u_long ahd_get_sense_residual(struct scb *);
 729 static __inline int ahd_perform_autosense(struct scb *);
 730 static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc *,
 731                                                struct scb *);
 732 static __inline void ahd_notify_xfer_settings_change(struct ahd_softc *,
 733                                                      struct ahd_devinfo *);
 734 static __inline void ahd_platform_scb_free(struct ahd_softc *ahd,
 735                                            struct scb *scb);
 736 static __inline void ahd_freeze_scb(struct scb *scb);
 737
 738 static __inline
 739 void ahd_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
 740 {
 741         cmd->result &= ~(CAM_STATUS_MASK << 16);
 742         cmd->result |= status << 16;
 743 }
 744
 745 static __inline
 746 void ahd_set_transaction_status(struct scb *scb, uint32_t status)
 747 {
 748         ahd_cmd_set_transaction_status(scb->io_ctx,status);
 749 }
 750
 751 static __inline
 752 void ahd_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
 753 {
 754         cmd->result &= ~0xFFFF;
 755         cmd->result |= status;
 756 }
 757
 758 static __inline
 759 void ahd_set_scsi_status(struct scb *scb, uint32_t status)
 760 {
 761         ahd_cmd_set_scsi_status(scb->io_ctx, status);
 762 }
 763
 764 static __inline
 765 uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd)
 766 {
 767         return ((cmd->result >> 16) & CAM_STATUS_MASK);
 768 }
 769
 770 static __inline
 771 uint32_t ahd_get_transaction_status(struct scb *scb)
 772 {
 773         return (ahd_cmd_get_transaction_status(scb->io_ctx));
 774 }
 775
 776 static __inline
 777 uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd)
 778 {
 779         return (cmd->result & 0xFFFF);
 780 }
 781
 782 static __inline
 783 uint32_t ahd_get_scsi_status(struct scb *scb)
 784 {
 785         return (ahd_cmd_get_scsi_status(scb->io_ctx));
 786 }
 787
 788 static __inline
 789 void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)
 790 {
 791         /*
 792          * Nothing to do for linux as the incoming transaction
 793          * has no concept of tag/non tagged, etc.
 794          */
 795 }
 796
 797 static __inline
 798 u_long ahd_get_transfer_length(struct scb *scb)
 799 {
 800         return (scb->platform_data->xfer_len);
 801 }
 802
 803 static __inline
 804 int ahd_get_transfer_dir(struct scb *scb)
 805 {
 806         return (scb->io_ctx->sc_data_direction);
 807 }
 808
 809 static __inline
 810 void ahd_set_residual(struct scb *scb, u_long resid)
 811 {
 812         scb->io_ctx->resid = resid;
 813 }
 814
 815 static __inline
 816 void ahd_set_sense_residual(struct scb *scb, u_long resid)
 817 {
 818         scb->platform_data->sense_resid = resid;
 819 }
 820
 821 static __inline
 822 u_long ahd_get_residual(struct scb *scb)
 823 {
 824         return (scb->io_ctx->resid);
 825 }
 826
 827 static __inline
 828 u_long ahd_get_sense_residual(struct scb *scb)
 829 {
 830         return (scb->platform_data->sense_resid);
 831 }
 832
 833 static __inline
 834 int ahd_perform_autosense(struct scb *scb)
 835 {
 836         /*
 837          * We always perform autosense in Linux.
 838          * On other platforms this is set on a
 839          * per-transaction basis.
 840          */
 841         return (1);
 842 }
 843
 844 static __inline uint32_t
 845 ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)
 846 {
 847         return (sizeof(struct scsi_sense_data));
 848 }
 849
 850 static __inline void
 851 ahd_notify_xfer_settings_change(struct ahd_softc *ahd,
 852                                 struct ahd_devinfo *devinfo)
 853 {
 854         /* Nothing to do here for linux */
 855 }
 856
 857 static __inline void
 858 ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)
 859 {
 860         ahd->flags &= ~AHD_RESOURCE_SHORTAGE;
 861 }
 862
 863 int     ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);
 864 void    ahd_platform_free(struct ahd_softc *ahd);
 865 void    ahd_platform_init(struct ahd_softc *ahd);
 866 void    ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb);
 867 void    ahd_freeze_simq(struct ahd_softc *ahd);
 868 void    ahd_release_simq(struct ahd_softc *ahd);
 869
 870 static __inline void
 871 ahd_freeze_scb(struct scb *scb)
 872 {
 873         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
 874                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
 875                 scb->platform_data->dev->qfrozen++;
 876         }
 877 }
 878
 879 void    ahd_platform_set_tags(struct ahd_softc *ahd,
 880                               struct ahd_devinfo *devinfo, ahd_queue_alg);
 881 int     ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
 882                                 char channel, int lun, u_int tag,
 883                                 role_t role, uint32_t status);
 884 irqreturn_t
 885         ahd_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
 886 void    ahd_platform_flushwork(struct ahd_softc *ahd);
 887 int     ahd_softc_comp(struct ahd_softc *, struct ahd_softc *);
 888 void    ahd_done(struct ahd_softc*, struct scb*);
 889 void    ahd_send_async(struct ahd_softc *, char channel,
 890                        u_int target, u_int lun, ac_code, void *);
 891 void    ahd_print_path(struct ahd_softc *, struct scb *);
 892
 893 #ifdef CONFIG_PCI
 894 #define AHD_PCI_CONFIG 1
 895 #else
 896 #define AHD_PCI_CONFIG 0
 897 #endif
 898 #define bootverbose aic79xx_verbose
 899 extern uint32_t aic79xx_verbose;
 900
 901 #endif /* _AIC79XX_LINUX_H_ */