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/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
 232 static __inline void
 233 ahd_timer_reset(ahd_timer_t *timer, int usec, ahd_callback_t *func, void *arg)
 234 {
 235         struct ahd_softc *ahd;
 236
 237         ahd = (struct ahd_softc *)arg;
 238         del_timer(timer);
 239         timer->data = (u_long)arg;
 240         timer->expires = jiffies + (usec * HZ)/1000000;
 241         timer->function = (ahd_linux_callback_t*)func;
 242         add_timer(timer);
 243 }
 244
 245 /***************************** SMP support ************************************/
 246 #include <linux/spinlock.h>
 247
 248 #define AIC79XX_DRIVER_VERSION "3.0"
 249
 250 /*************************** Device Data Structures ***************************/
 251 /*
 252  * A per probed device structure used to deal with some error recovery
 253  * scenarios that the Linux mid-layer code just doesn't know how to
 254  * handle.  The structure allocated for a device only becomes persistent
 255  * after a successfully completed inquiry command to the target when
 256  * that inquiry data indicates a lun is present.
 257  */
 258
 259 typedef enum {
 260         AHD_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
 261         AHD_DEV_Q_BASIC          = 0x10, /* Allow basic device queuing */
 262         AHD_DEV_Q_TAGGED         = 0x20, /* Allow full SCSI2 command queueing */
 263         AHD_DEV_PERIODIC_OTAG    = 0x40, /* Send OTAG to prevent starvation */
 264 } ahd_linux_dev_flags;
 265
 266 struct ahd_linux_target;
 267 struct ahd_linux_device {
 268         TAILQ_ENTRY(ahd_linux_device) links;
 269
 270         /*
 271          * The number of transactions currently
 272          * queued to the device.
 273          */
 274         int                     active;
 275
 276         /*
 277          * The currently allowed number of
 278          * transactions that can be queued to
 279          * the device.  Must be signed for
 280          * conversion from tagged to untagged
 281          * mode where the device may have more
 282          * than one outstanding active transaction.
 283          */
 284         int                     openings;
 285
 286         /*
 287          * A positive count indicates that this
 288          * device's queue is halted.
 289          */
 290         u_int                   qfrozen;
 291
 292         /*
 293          * Cumulative command counter.
 294          */
 295         u_long                  commands_issued;
 296
 297         /*
 298          * The number of tagged transactions when
 299          * running at our current opening level
 300          * that have been successfully received by
 301          * this device since the last QUEUE FULL.
 302          */
 303         u_int                   tag_success_count;
 304 #define AHD_TAG_SUCCESS_INTERVAL 50
 305
 306         ahd_linux_dev_flags     flags;
 307
 308         /*
 309          * Per device timer.
 310          */
 311         struct timer_list       timer;
 312
 313         /*
 314          * The high limit for the tags variable.
 315          */
 316         u_int                   maxtags;
 317
 318         /*
 319          * The computed number of tags outstanding
 320          * at the time of the last QUEUE FULL event.
 321          */
 322         u_int                   tags_on_last_queuefull;
 323
 324         /*
 325          * How many times we have seen a queue full
 326          * with the same number of tags.  This is used
 327          * to stop our adaptive queue depth algorithm
 328          * on devices with a fixed number of tags.
 329          */
 330         u_int                   last_queuefull_same_count;
 331 #define AHD_LOCK_TAGS_COUNT 50
 332
 333         /*
 334          * How many transactions have been queued
 335          * without the device going idle.  We use
 336          * this statistic to determine when to issue
 337          * an ordered tag to prevent transaction
 338          * starvation.  This statistic is only updated
 339          * if the AHD_DEV_PERIODIC_OTAG flag is set
 340          * on this device.
 341          */
 342         u_int                   commands_since_idle_or_otag;
 343 #define AHD_OTAG_THRESH 500
 344 };
 345
 346 struct ahd_linux_target {
 347         struct scsi_device       *sdev[AHD_NUM_LUNS];
 348         struct ahd_transinfo      last_tinfo;
 349         struct ahd_softc         *ahd;
 350 };
 351
 352 /********************* Definitions Required by the Core ***********************/
 353 /*
 354  * Number of SG segments we require.  So long as the S/G segments for
 355  * a particular transaction are allocated in a physically contiguous
 356  * manner and are allocated below 4GB, the number of S/G segments is
 357  * unrestricted.
 358  */
 359 #define AHD_NSEG 128
 360
 361 /*
 362  * Per-SCB OSM storage.
 363  */
 364 struct scb_platform_data {
 365         struct ahd_linux_device *dev;
 366         dma_addr_t               buf_busaddr;
 367         uint32_t                 xfer_len;
 368         uint32_t                 sense_resid;   /* Auto-Sense residual */
 369 };
 370
 371 /*
 372  * Define a structure used for each host adapter.  All members are
 373  * aligned on a boundary >= the size of the member to honor the
 374  * alignment restrictions of the various platforms supported by
 375  * this driver.
 376  */
 377 struct ahd_platform_data {
 378         /*
 379          * Fields accessed from interrupt context.
 380          */
 381         struct scsi_target *starget[AHD_NUM_TARGETS];
 382
 383         spinlock_t               spin_lock;
 384         u_int                    qfrozen;
 385         struct semaphore         eh_sem;
 386         struct Scsi_Host        *host;          /* pointer to scsi host */
 387 #define AHD_LINUX_NOIRQ ((uint32_t)~0)
 388         uint32_t                 irq;           /* IRQ for this adapter */
 389         uint32_t                 bios_address;
 390         uint32_t                 mem_busaddr;   /* Mem Base Addr */
 391 #define AHD_SCB_UP_EH_SEM 0x1
 392         uint32_t                 flags;
 393 };
 394
 395 /************************** OS Utility Wrappers *******************************/
 396 #define printf printk
 397 #define M_NOWAIT GFP_ATOMIC
 398 #define M_WAITOK 0
 399 #define malloc(size, type, flags) kmalloc(size, flags)
 400 #define free(ptr, type) kfree(ptr)
 401
 402 static __inline void ahd_delay(long);
 403 static __inline void
 404 ahd_delay(long usec)
 405 {
 406         /*
 407          * udelay on Linux can have problems for
 408          * multi-millisecond waits.  Wait at most
 409          * 1024us per call.
 410          */
 411         while (usec > 0) {
 412                 udelay(usec % 1024);
 413                 usec -= 1024;
 414         }
 415 }
 416
 417
 418 /***************************** Low Level I/O **********************************/
 419 static __inline uint8_t ahd_inb(struct ahd_softc * ahd, long port);
 420 static __inline uint16_t ahd_inw_atomic(struct ahd_softc * ahd, long port);
 421 static __inline void ahd_outb(struct ahd_softc * ahd, long port, uint8_t val);
 422 static __inline void ahd_outw_atomic(struct ahd_softc * ahd,
 423                                      long port, uint16_t val);
 424 static __inline void ahd_outsb(struct ahd_softc * ahd, long port,
 425                                uint8_t *, int count);
 426 static __inline void ahd_insb(struct ahd_softc * ahd, long port,
 427                                uint8_t *, int count);
 428
 429 static __inline uint8_t
 430 ahd_inb(struct ahd_softc * ahd, long port)
 431 {
 432         uint8_t x;
 433
 434         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 435                 x = readb(ahd->bshs[0].maddr + port);
 436         } else {
 437                 x = inb(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 438         }
 439         mb();
 440         return (x);
 441 }
 442
 443 static __inline uint16_t
 444 ahd_inw_atomic(struct ahd_softc * ahd, long port)
 445 {
 446         uint8_t x;
 447
 448         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 449                 x = readw(ahd->bshs[0].maddr + port);
 450         } else {
 451                 x = inw(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 452         }
 453         mb();
 454         return (x);
 455 }
 456
 457 static __inline void
 458 ahd_outb(struct ahd_softc * ahd, long port, uint8_t val)
 459 {
 460         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 461                 writeb(val, ahd->bshs[0].maddr + port);
 462         } else {
 463                 outb(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 464         }
 465         mb();
 466 }
 467
 468 static __inline void
 469 ahd_outw_atomic(struct ahd_softc * ahd, long port, uint16_t val)
 470 {
 471         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 472                 writew(val, ahd->bshs[0].maddr + port);
 473         } else {
 474                 outw(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 475         }
 476         mb();
 477 }
 478
 479 static __inline void
 480 ahd_outsb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 481 {
 482         int i;
 483
 484         /*
 485          * There is probably a more efficient way to do this on Linux
 486          * but we don't use this for anything speed critical and this
 487          * should work.
 488          */
 489         for (i = 0; i < count; i++)
 490                 ahd_outb(ahd, port, *array++);
 491 }
 492
 493 static __inline void
 494 ahd_insb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 495 {
 496         int i;
 497
 498         /*
 499          * There is probably a more efficient way to do this on Linux
 500          * but we don't use this for anything speed critical and this
 501          * should work.
 502          */
 503         for (i = 0; i < count; i++)
 504                 *array++ = ahd_inb(ahd, port);
 505 }
 506
 507 /**************************** Initialization **********************************/
 508 int             ahd_linux_register_host(struct ahd_softc *,
 509                                         struct scsi_host_template *);
 510
 511 uint64_t        ahd_linux_get_memsize(void);
 512
 513 /*************************** Pretty Printing **********************************/
 514 struct info_str {
 515         char *buffer;
 516         int length;
 517         off_t offset;
 518         int pos;
 519 };
 520
 521 void    ahd_format_transinfo(struct info_str *info,
 522                              struct ahd_transinfo *tinfo);
 523
 524 /******************************** Locking *************************************/
 525 static __inline void
 526 ahd_lockinit(struct ahd_softc *ahd)
 527 {
 528         spin_lock_init(&ahd->platform_data->spin_lock);
 529 }
 530
 531 static __inline void
 532 ahd_lock(struct ahd_softc *ahd, unsigned long *flags)
 533 {
 534         spin_lock_irqsave(&ahd->platform_data->spin_lock, *flags);
 535 }
 536
 537 static __inline void
 538 ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)
 539 {
 540         spin_unlock_irqrestore(&ahd->platform_data->spin_lock, *flags);
 541 }
 542
 543 /******************************* PCI Definitions ******************************/
 544 /*
 545  * PCIM_xxx: mask to locate subfield in register
 546  * PCIR_xxx: config register offset
 547  * PCIC_xxx: device class
 548  * PCIS_xxx: device subclass
 549  * PCIP_xxx: device programming interface
 550  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
 551  * PCID_xxx: device ID
 552  */
 553 #define PCIR_DEVVENDOR          0x00
 554 #define PCIR_VENDOR             0x00
 555 #define PCIR_DEVICE             0x02
 556 #define PCIR_COMMAND            0x04
 557 #define PCIM_CMD_PORTEN         0x0001
 558 #define PCIM_CMD_MEMEN          0x0002
 559 #define PCIM_CMD_BUSMASTEREN    0x0004
 560 #define PCIM_CMD_MWRICEN        0x0010
 561 #define PCIM_CMD_PERRESPEN      0x0040
 562 #define PCIM_CMD_SERRESPEN      0x0100
 563 #define PCIR_STATUS             0x06
 564 #define PCIR_REVID              0x08
 565 #define PCIR_PROGIF             0x09
 566 #define PCIR_SUBCLASS           0x0a
 567 #define PCIR_CLASS              0x0b
 568 #define PCIR_CACHELNSZ          0x0c
 569 #define PCIR_LATTIMER           0x0d
 570 #define PCIR_HEADERTYPE         0x0e
 571 #define PCIM_MFDEV              0x80
 572 #define PCIR_BIST               0x0f
 573 #define PCIR_CAP_PTR            0x34
 574
 575 /* config registers for header type 0 devices */
 576 #define PCIR_MAPS       0x10
 577 #define PCIR_SUBVEND_0  0x2c
 578 #define PCIR_SUBDEV_0   0x2e
 579
 580 /****************************** PCI-X definitions *****************************/
 581 #define PCIXR_COMMAND   0x96
 582 #define PCIXR_DEVADDR   0x98
 583 #define PCIXM_DEVADDR_FNUM      0x0003  /* Function Number */
 584 #define PCIXM_DEVADDR_DNUM      0x00F8  /* Device Number */
 585 #define PCIXM_DEVADDR_BNUM      0xFF00  /* Bus Number */
 586 #define PCIXR_STATUS    0x9A
 587 #define PCIXM_STATUS_64BIT      0x0001  /* Active 64bit connection to device. */
 588 #define PCIXM_STATUS_133CAP     0x0002  /* Device is 133MHz capable */
 589 #define PCIXM_STATUS_SCDISC     0x0004  /* Split Completion Discarded */
 590 #define PCIXM_STATUS_UNEXPSC    0x0008  /* Unexpected Split Completion */
 591 #define PCIXM_STATUS_CMPLEXDEV  0x0010  /* Device Complexity (set == bridge) */
 592 #define PCIXM_STATUS_MAXMRDBC   0x0060  /* Maximum Burst Read Count */
 593 #define PCIXM_STATUS_MAXSPLITS  0x0380  /* Maximum Split Transactions */
 594 #define PCIXM_STATUS_MAXCRDS    0x1C00  /* Maximum Cumulative Read Size */
 595 #define PCIXM_STATUS_RCVDSCEM   0x2000  /* Received a Split Comp w/Error msg */
 596
 597 extern struct pci_driver aic79xx_pci_driver;
 598
 599 typedef enum
 600 {
 601         AHD_POWER_STATE_D0,
 602         AHD_POWER_STATE_D1,
 603         AHD_POWER_STATE_D2,
 604         AHD_POWER_STATE_D3
 605 } ahd_power_state;
 606
 607 void ahd_power_state_change(struct ahd_softc *ahd,
 608                             ahd_power_state new_state);
 609
 610 /******************************* PCI Routines *********************************/
 611 int                      ahd_linux_pci_init(void);
 612 void                     ahd_linux_pci_exit(void);
 613 int                      ahd_pci_map_registers(struct ahd_softc *ahd);
 614 int                      ahd_pci_map_int(struct ahd_softc *ahd);
 615
 616 static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,
 617                                              int reg, int width);
 618
 619 static __inline uint32_t
 620 ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width)
 621 {
 622         switch (width) {
 623         case 1:
 624         {
 625                 uint8_t retval;
 626
 627                 pci_read_config_byte(pci, reg, &retval);
 628                 return (retval);
 629         }
 630         case 2:
 631         {
 632                 uint16_t retval;
 633                 pci_read_config_word(pci, reg, &retval);
 634                 return (retval);
 635         }
 636         case 4:
 637         {
 638                 uint32_t retval;
 639                 pci_read_config_dword(pci, reg, &retval);
 640                 return (retval);
 641         }
 642         default:
 643                 panic("ahd_pci_read_config: Read size too big");
 644                 /* NOTREACHED */
 645                 return (0);
 646         }
 647 }
 648
 649 static __inline void ahd_pci_write_config(ahd_dev_softc_t pci,
 650                                           int reg, uint32_t value,
 651                                           int width);
 652
 653 static __inline void
 654 ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width)
 655 {
 656         switch (width) {
 657         case 1:
 658                 pci_write_config_byte(pci, reg, value);
 659                 break;
 660         case 2:
 661                 pci_write_config_word(pci, reg, value);
 662                 break;
 663         case 4:
 664                 pci_write_config_dword(pci, reg, value);
 665                 break;
 666         default:
 667                 panic("ahd_pci_write_config: Write size too big");
 668                 /* NOTREACHED */
 669         }
 670 }
 671
 672 static __inline int ahd_get_pci_function(ahd_dev_softc_t);
 673 static __inline int
 674 ahd_get_pci_function(ahd_dev_softc_t pci)
 675 {
 676         return (PCI_FUNC(pci->devfn));
 677 }
 678
 679 static __inline int ahd_get_pci_slot(ahd_dev_softc_t);
 680 static __inline int
 681 ahd_get_pci_slot(ahd_dev_softc_t pci)
 682 {
 683         return (PCI_SLOT(pci->devfn));
 684 }
 685
 686 static __inline int ahd_get_pci_bus(ahd_dev_softc_t);
 687 static __inline int
 688 ahd_get_pci_bus(ahd_dev_softc_t pci)
 689 {
 690         return (pci->bus->number);
 691 }
 692
 693 static __inline void ahd_flush_device_writes(struct ahd_softc *);
 694 static __inline void
 695 ahd_flush_device_writes(struct ahd_softc *ahd)
 696 {
 697         /* XXX Is this sufficient for all architectures??? */
 698         ahd_inb(ahd, INTSTAT);
 699 }
 700
 701 /**************************** Proc FS Support *********************************/
 702 int     ahd_linux_proc_info(struct Scsi_Host *, char *, char **,
 703                             off_t, int, int);
 704
 705 /*********************** Transaction Access Wrappers **************************/
 706 static __inline void ahd_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
 707 static __inline void ahd_set_transaction_status(struct scb *, uint32_t);
 708 static __inline void ahd_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
 709 static __inline void ahd_set_scsi_status(struct scb *, uint32_t);
 710 static __inline uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd);
 711 static __inline uint32_t ahd_get_transaction_status(struct scb *);
 712 static __inline uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd);
 713 static __inline uint32_t ahd_get_scsi_status(struct scb *);
 714 static __inline void ahd_set_transaction_tag(struct scb *, int, u_int);
 715 static __inline u_long ahd_get_transfer_length(struct scb *);
 716 static __inline int ahd_get_transfer_dir(struct scb *);
 717 static __inline void ahd_set_residual(struct scb *, u_long);
 718 static __inline void ahd_set_sense_residual(struct scb *scb, u_long resid);
 719 static __inline u_long ahd_get_residual(struct scb *);
 720 static __inline u_long ahd_get_sense_residual(struct scb *);
 721 static __inline int ahd_perform_autosense(struct scb *);
 722 static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc *,
 723                                                struct scb *);
 724 static __inline void ahd_notify_xfer_settings_change(struct ahd_softc *,
 725                                                      struct ahd_devinfo *);
 726 static __inline void ahd_platform_scb_free(struct ahd_softc *ahd,
 727                                            struct scb *scb);
 728 static __inline void ahd_freeze_scb(struct scb *scb);
 729
 730 static __inline
 731 void ahd_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
 732 {
 733         cmd->result &= ~(CAM_STATUS_MASK << 16);
 734         cmd->result |= status << 16;
 735 }
 736
 737 static __inline
 738 void ahd_set_transaction_status(struct scb *scb, uint32_t status)
 739 {
 740         ahd_cmd_set_transaction_status(scb->io_ctx,status);
 741 }
 742
 743 static __inline
 744 void ahd_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
 745 {
 746         cmd->result &= ~0xFFFF;
 747         cmd->result |= status;
 748 }
 749
 750 static __inline
 751 void ahd_set_scsi_status(struct scb *scb, uint32_t status)
 752 {
 753         ahd_cmd_set_scsi_status(scb->io_ctx, status);
 754 }
 755
 756 static __inline
 757 uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd)
 758 {
 759         return ((cmd->result >> 16) & CAM_STATUS_MASK);
 760 }
 761
 762 static __inline
 763 uint32_t ahd_get_transaction_status(struct scb *scb)
 764 {
 765         return (ahd_cmd_get_transaction_status(scb->io_ctx));
 766 }
 767
 768 static __inline
 769 uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd)
 770 {
 771         return (cmd->result & 0xFFFF);
 772 }
 773
 774 static __inline
 775 uint32_t ahd_get_scsi_status(struct scb *scb)
 776 {
 777         return (ahd_cmd_get_scsi_status(scb->io_ctx));
 778 }
 779
 780 static __inline
 781 void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)
 782 {
 783         /*
 784          * Nothing to do for linux as the incoming transaction
 785          * has no concept of tag/non tagged, etc.
 786          */
 787 }
 788
 789 static __inline
 790 u_long ahd_get_transfer_length(struct scb *scb)
 791 {
 792         return (scb->platform_data->xfer_len);
 793 }
 794
 795 static __inline
 796 int ahd_get_transfer_dir(struct scb *scb)
 797 {
 798         return (scb->io_ctx->sc_data_direction);
 799 }
 800
 801 static __inline
 802 void ahd_set_residual(struct scb *scb, u_long resid)
 803 {
 804         scb->io_ctx->resid = resid;
 805 }
 806
 807 static __inline
 808 void ahd_set_sense_residual(struct scb *scb, u_long resid)
 809 {
 810         scb->platform_data->sense_resid = resid;
 811 }
 812
 813 static __inline
 814 u_long ahd_get_residual(struct scb *scb)
 815 {
 816         return (scb->io_ctx->resid);
 817 }
 818
 819 static __inline
 820 u_long ahd_get_sense_residual(struct scb *scb)
 821 {
 822         return (scb->platform_data->sense_resid);
 823 }
 824
 825 static __inline
 826 int ahd_perform_autosense(struct scb *scb)
 827 {
 828         /*
 829          * We always perform autosense in Linux.
 830          * On other platforms this is set on a
 831          * per-transaction basis.
 832          */
 833         return (1);
 834 }
 835
 836 static __inline uint32_t
 837 ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)
 838 {
 839         return (sizeof(struct scsi_sense_data));
 840 }
 841
 842 static __inline void
 843 ahd_notify_xfer_settings_change(struct ahd_softc *ahd,
 844                                 struct ahd_devinfo *devinfo)
 845 {
 846         /* Nothing to do here for linux */
 847 }
 848
 849 static __inline void
 850 ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)
 851 {
 852         ahd->flags &= ~AHD_RESOURCE_SHORTAGE;
 853 }
 854
 855 int     ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);
 856 void    ahd_platform_free(struct ahd_softc *ahd);
 857 void    ahd_platform_init(struct ahd_softc *ahd);
 858 void    ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb);
 859 void    ahd_freeze_simq(struct ahd_softc *ahd);
 860 void    ahd_release_simq(struct ahd_softc *ahd);
 861
 862 static __inline void
 863 ahd_freeze_scb(struct scb *scb)
 864 {
 865         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
 866                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
 867                 scb->platform_data->dev->qfrozen++;
 868         }
 869 }
 870
 871 void    ahd_platform_set_tags(struct ahd_softc *ahd,
 872                               struct ahd_devinfo *devinfo, ahd_queue_alg);
 873 int     ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
 874                                 char channel, int lun, u_int tag,
 875                                 role_t role, uint32_t status);
 876 irqreturn_t
 877         ahd_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
 878 void    ahd_platform_flushwork(struct ahd_softc *ahd);
 879 int     ahd_softc_comp(struct ahd_softc *, struct ahd_softc *);
 880 void    ahd_done(struct ahd_softc*, struct scb*);
 881 void    ahd_send_async(struct ahd_softc *, char channel,
 882                        u_int target, u_int lun, ac_code, void *);
 883 void    ahd_print_path(struct ahd_softc *, struct scb *);
 884
 885 #ifdef CONFIG_PCI
 886 #define AHD_PCI_CONFIG 1
 887 #else
 888 #define AHD_PCI_CONFIG 0
 889 #endif
 890 #define bootverbose aic79xx_verbose
 891 extern uint32_t aic79xx_verbose;
 892
 893 #endif /* _AIC79XX_LINUX_H_ */