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