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