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