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         struct completion       *eh_done;
 385         struct Scsi_Host        *host;          /* pointer to scsi host */
 386 #define AHD_LINUX_NOIRQ ((uint32_t)~0)
 387         uint32_t                 irq;           /* IRQ for this adapter */
 388         uint32_t                 bios_address;
 389         uint32_t                 mem_busaddr;   /* Mem Base Addr */
 390 };
 391
 392 /************************** OS Utility Wrappers *******************************/
 393 #define printf printk
 394 #define M_NOWAIT GFP_ATOMIC
 395 #define M_WAITOK 0
 396 #define malloc(size, type, flags) kmalloc(size, flags)
 397 #define free(ptr, type) kfree(ptr)
 398
 399 static __inline void ahd_delay(long);
 400 static __inline void
 401 ahd_delay(long usec)
 402 {
 403         /*
 404          * udelay on Linux can have problems for
 405          * multi-millisecond waits.  Wait at most
 406          * 1024us per call.
 407          */
 408         while (usec > 0) {
 409                 udelay(usec % 1024);
 410                 usec -= 1024;
 411         }
 412 }
 413
 414
 415 /***************************** Low Level I/O **********************************/
 416 static __inline uint8_t ahd_inb(struct ahd_softc * ahd, long port);
 417 static __inline uint16_t ahd_inw_atomic(struct ahd_softc * ahd, long port);
 418 static __inline void ahd_outb(struct ahd_softc * ahd, long port, uint8_t val);
 419 static __inline void ahd_outw_atomic(struct ahd_softc * ahd,
 420                                      long port, uint16_t val);
 421 static __inline void ahd_outsb(struct ahd_softc * ahd, long port,
 422                                uint8_t *, int count);
 423 static __inline void ahd_insb(struct ahd_softc * ahd, long port,
 424                                uint8_t *, int count);
 425
 426 static __inline uint8_t
 427 ahd_inb(struct ahd_softc * ahd, long port)
 428 {
 429         uint8_t x;
 430
 431         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 432                 x = readb(ahd->bshs[0].maddr + port);
 433         } else {
 434                 x = inb(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 435         }
 436         mb();
 437         return (x);
 438 }
 439
 440 static __inline uint16_t
 441 ahd_inw_atomic(struct ahd_softc * ahd, long port)
 442 {
 443         uint8_t x;
 444
 445         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 446                 x = readw(ahd->bshs[0].maddr + port);
 447         } else {
 448                 x = inw(ahd->bshs[(port) >> 8].ioport + ((port) & 0xFF));
 449         }
 450         mb();
 451         return (x);
 452 }
 453
 454 static __inline void
 455 ahd_outb(struct ahd_softc * ahd, long port, uint8_t val)
 456 {
 457         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 458                 writeb(val, ahd->bshs[0].maddr + port);
 459         } else {
 460                 outb(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 461         }
 462         mb();
 463 }
 464
 465 static __inline void
 466 ahd_outw_atomic(struct ahd_softc * ahd, long port, uint16_t val)
 467 {
 468         if (ahd->tags[0] == BUS_SPACE_MEMIO) {
 469                 writew(val, ahd->bshs[0].maddr + port);
 470         } else {
 471                 outw(val, ahd->bshs[(port) >> 8].ioport + (port & 0xFF));
 472         }
 473         mb();
 474 }
 475
 476 static __inline void
 477 ahd_outsb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 478 {
 479         int i;
 480
 481         /*
 482          * There is probably a more efficient way to do this on Linux
 483          * but we don't use this for anything speed critical and this
 484          * should work.
 485          */
 486         for (i = 0; i < count; i++)
 487                 ahd_outb(ahd, port, *array++);
 488 }
 489
 490 static __inline void
 491 ahd_insb(struct ahd_softc * ahd, long port, uint8_t *array, int count)
 492 {
 493         int i;
 494
 495         /*
 496          * There is probably a more efficient way to do this on Linux
 497          * but we don't use this for anything speed critical and this
 498          * should work.
 499          */
 500         for (i = 0; i < count; i++)
 501                 *array++ = ahd_inb(ahd, port);
 502 }
 503
 504 /**************************** Initialization **********************************/
 505 int             ahd_linux_register_host(struct ahd_softc *,
 506                                         struct scsi_host_template *);
 507
 508 uint64_t        ahd_linux_get_memsize(void);
 509
 510 /*************************** Pretty Printing **********************************/
 511 struct info_str {
 512         char *buffer;
 513         int length;
 514         off_t offset;
 515         int pos;
 516 };
 517
 518 void    ahd_format_transinfo(struct info_str *info,
 519                              struct ahd_transinfo *tinfo);
 520
 521 /******************************** Locking *************************************/
 522 static __inline void
 523 ahd_lockinit(struct ahd_softc *ahd)
 524 {
 525         spin_lock_init(&ahd->platform_data->spin_lock);
 526 }
 527
 528 static __inline void
 529 ahd_lock(struct ahd_softc *ahd, unsigned long *flags)
 530 {
 531         spin_lock_irqsave(&ahd->platform_data->spin_lock, *flags);
 532 }
 533
 534 static __inline void
 535 ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)
 536 {
 537         spin_unlock_irqrestore(&ahd->platform_data->spin_lock, *flags);
 538 }
 539
 540 /******************************* PCI Definitions ******************************/
 541 /*
 542  * PCIM_xxx: mask to locate subfield in register
 543  * PCIR_xxx: config register offset
 544  * PCIC_xxx: device class
 545  * PCIS_xxx: device subclass
 546  * PCIP_xxx: device programming interface
 547  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
 548  * PCID_xxx: device ID
 549  */
 550 #define PCIR_DEVVENDOR          0x00
 551 #define PCIR_VENDOR             0x00
 552 #define PCIR_DEVICE             0x02
 553 #define PCIR_COMMAND            0x04
 554 #define PCIM_CMD_PORTEN         0x0001
 555 #define PCIM_CMD_MEMEN          0x0002
 556 #define PCIM_CMD_BUSMASTEREN    0x0004
 557 #define PCIM_CMD_MWRICEN        0x0010
 558 #define PCIM_CMD_PERRESPEN      0x0040
 559 #define PCIM_CMD_SERRESPEN      0x0100
 560 #define PCIR_STATUS             0x06
 561 #define PCIR_REVID              0x08
 562 #define PCIR_PROGIF             0x09
 563 #define PCIR_SUBCLASS           0x0a
 564 #define PCIR_CLASS              0x0b
 565 #define PCIR_CACHELNSZ          0x0c
 566 #define PCIR_LATTIMER           0x0d
 567 #define PCIR_HEADERTYPE         0x0e
 568 #define PCIM_MFDEV              0x80
 569 #define PCIR_BIST               0x0f
 570 #define PCIR_CAP_PTR            0x34
 571
 572 /* config registers for header type 0 devices */
 573 #define PCIR_MAPS       0x10
 574 #define PCIR_SUBVEND_0  0x2c
 575 #define PCIR_SUBDEV_0   0x2e
 576
 577 /****************************** PCI-X definitions *****************************/
 578 #define PCIXR_COMMAND   0x96
 579 #define PCIXR_DEVADDR   0x98
 580 #define PCIXM_DEVADDR_FNUM      0x0003  /* Function Number */
 581 #define PCIXM_DEVADDR_DNUM      0x00F8  /* Device Number */
 582 #define PCIXM_DEVADDR_BNUM      0xFF00  /* Bus Number */
 583 #define PCIXR_STATUS    0x9A
 584 #define PCIXM_STATUS_64BIT      0x0001  /* Active 64bit connection to device. */
 585 #define PCIXM_STATUS_133CAP     0x0002  /* Device is 133MHz capable */
 586 #define PCIXM_STATUS_SCDISC     0x0004  /* Split Completion Discarded */
 587 #define PCIXM_STATUS_UNEXPSC    0x0008  /* Unexpected Split Completion */
 588 #define PCIXM_STATUS_CMPLEXDEV  0x0010  /* Device Complexity (set == bridge) */
 589 #define PCIXM_STATUS_MAXMRDBC   0x0060  /* Maximum Burst Read Count */
 590 #define PCIXM_STATUS_MAXSPLITS  0x0380  /* Maximum Split Transactions */
 591 #define PCIXM_STATUS_MAXCRDS    0x1C00  /* Maximum Cumulative Read Size */
 592 #define PCIXM_STATUS_RCVDSCEM   0x2000  /* Received a Split Comp w/Error msg */
 593
 594 extern struct pci_driver aic79xx_pci_driver;
 595
 596 typedef enum
 597 {
 598         AHD_POWER_STATE_D0,
 599         AHD_POWER_STATE_D1,
 600         AHD_POWER_STATE_D2,
 601         AHD_POWER_STATE_D3
 602 } ahd_power_state;
 603
 604 void ahd_power_state_change(struct ahd_softc *ahd,
 605                             ahd_power_state new_state);
 606
 607 /******************************* PCI Routines *********************************/
 608 int                      ahd_linux_pci_init(void);
 609 void                     ahd_linux_pci_exit(void);
 610 int                      ahd_pci_map_registers(struct ahd_softc *ahd);
 611 int                      ahd_pci_map_int(struct ahd_softc *ahd);
 612
 613 static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,
 614                                              int reg, int width);
 615
 616 static __inline uint32_t
 617 ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width)
 618 {
 619         switch (width) {
 620         case 1:
 621         {
 622                 uint8_t retval;
 623
 624                 pci_read_config_byte(pci, reg, &retval);
 625                 return (retval);
 626         }
 627         case 2:
 628         {
 629                 uint16_t retval;
 630                 pci_read_config_word(pci, reg, &retval);
 631                 return (retval);
 632         }
 633         case 4:
 634         {
 635                 uint32_t retval;
 636                 pci_read_config_dword(pci, reg, &retval);
 637                 return (retval);
 638         }
 639         default:
 640                 panic("ahd_pci_read_config: Read size too big");
 641                 /* NOTREACHED */
 642                 return (0);
 643         }
 644 }
 645
 646 static __inline void ahd_pci_write_config(ahd_dev_softc_t pci,
 647                                           int reg, uint32_t value,
 648                                           int width);
 649
 650 static __inline void
 651 ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width)
 652 {
 653         switch (width) {
 654         case 1:
 655                 pci_write_config_byte(pci, reg, value);
 656                 break;
 657         case 2:
 658                 pci_write_config_word(pci, reg, value);
 659                 break;
 660         case 4:
 661                 pci_write_config_dword(pci, reg, value);
 662                 break;
 663         default:
 664                 panic("ahd_pci_write_config: Write size too big");
 665                 /* NOTREACHED */
 666         }
 667 }
 668
 669 static __inline int ahd_get_pci_function(ahd_dev_softc_t);
 670 static __inline int
 671 ahd_get_pci_function(ahd_dev_softc_t pci)
 672 {
 673         return (PCI_FUNC(pci->devfn));
 674 }
 675
 676 static __inline int ahd_get_pci_slot(ahd_dev_softc_t);
 677 static __inline int
 678 ahd_get_pci_slot(ahd_dev_softc_t pci)
 679 {
 680         return (PCI_SLOT(pci->devfn));
 681 }
 682
 683 static __inline int ahd_get_pci_bus(ahd_dev_softc_t);
 684 static __inline int
 685 ahd_get_pci_bus(ahd_dev_softc_t pci)
 686 {
 687         return (pci->bus->number);
 688 }
 689
 690 static __inline void ahd_flush_device_writes(struct ahd_softc *);
 691 static __inline void
 692 ahd_flush_device_writes(struct ahd_softc *ahd)
 693 {
 694         /* XXX Is this sufficient for all architectures??? */
 695         ahd_inb(ahd, INTSTAT);
 696 }
 697
 698 /**************************** Proc FS Support *********************************/
 699 int     ahd_linux_proc_info(struct Scsi_Host *, char *, char **,
 700                             off_t, int, int);
 701
 702 /*********************** Transaction Access Wrappers **************************/
 703 static __inline void ahd_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
 704 static __inline void ahd_set_transaction_status(struct scb *, uint32_t);
 705 static __inline void ahd_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
 706 static __inline void ahd_set_scsi_status(struct scb *, uint32_t);
 707 static __inline uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd);
 708 static __inline uint32_t ahd_get_transaction_status(struct scb *);
 709 static __inline uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd);
 710 static __inline uint32_t ahd_get_scsi_status(struct scb *);
 711 static __inline void ahd_set_transaction_tag(struct scb *, int, u_int);
 712 static __inline u_long ahd_get_transfer_length(struct scb *);
 713 static __inline int ahd_get_transfer_dir(struct scb *);
 714 static __inline void ahd_set_residual(struct scb *, u_long);
 715 static __inline void ahd_set_sense_residual(struct scb *scb, u_long resid);
 716 static __inline u_long ahd_get_residual(struct scb *);
 717 static __inline u_long ahd_get_sense_residual(struct scb *);
 718 static __inline int ahd_perform_autosense(struct scb *);
 719 static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc *,
 720                                                struct scb *);
 721 static __inline void ahd_notify_xfer_settings_change(struct ahd_softc *,
 722                                                      struct ahd_devinfo *);
 723 static __inline void ahd_platform_scb_free(struct ahd_softc *ahd,
 724                                            struct scb *scb);
 725 static __inline void ahd_freeze_scb(struct scb *scb);
 726
 727 static __inline
 728 void ahd_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
 729 {
 730         cmd->result &= ~(CAM_STATUS_MASK << 16);
 731         cmd->result |= status << 16;
 732 }
 733
 734 static __inline
 735 void ahd_set_transaction_status(struct scb *scb, uint32_t status)
 736 {
 737         ahd_cmd_set_transaction_status(scb->io_ctx,status);
 738 }
 739
 740 static __inline
 741 void ahd_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
 742 {
 743         cmd->result &= ~0xFFFF;
 744         cmd->result |= status;
 745 }
 746
 747 static __inline
 748 void ahd_set_scsi_status(struct scb *scb, uint32_t status)
 749 {
 750         ahd_cmd_set_scsi_status(scb->io_ctx, status);
 751 }
 752
 753 static __inline
 754 uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd)
 755 {
 756         return ((cmd->result >> 16) & CAM_STATUS_MASK);
 757 }
 758
 759 static __inline
 760 uint32_t ahd_get_transaction_status(struct scb *scb)
 761 {
 762         return (ahd_cmd_get_transaction_status(scb->io_ctx));
 763 }
 764
 765 static __inline
 766 uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd)
 767 {
 768         return (cmd->result & 0xFFFF);
 769 }
 770
 771 static __inline
 772 uint32_t ahd_get_scsi_status(struct scb *scb)
 773 {
 774         return (ahd_cmd_get_scsi_status(scb->io_ctx));
 775 }
 776
 777 static __inline
 778 void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)
 779 {
 780         /*
 781          * Nothing to do for linux as the incoming transaction
 782          * has no concept of tag/non tagged, etc.
 783          */
 784 }
 785
 786 static __inline
 787 u_long ahd_get_transfer_length(struct scb *scb)
 788 {
 789         return (scb->platform_data->xfer_len);
 790 }
 791
 792 static __inline
 793 int ahd_get_transfer_dir(struct scb *scb)
 794 {
 795         return (scb->io_ctx->sc_data_direction);
 796 }
 797
 798 static __inline
 799 void ahd_set_residual(struct scb *scb, u_long resid)
 800 {
 801         scb->io_ctx->resid = resid;
 802 }
 803
 804 static __inline
 805 void ahd_set_sense_residual(struct scb *scb, u_long resid)
 806 {
 807         scb->platform_data->sense_resid = resid;
 808 }
 809
 810 static __inline
 811 u_long ahd_get_residual(struct scb *scb)
 812 {
 813         return (scb->io_ctx->resid);
 814 }
 815
 816 static __inline
 817 u_long ahd_get_sense_residual(struct scb *scb)
 818 {
 819         return (scb->platform_data->sense_resid);
 820 }
 821
 822 static __inline
 823 int ahd_perform_autosense(struct scb *scb)
 824 {
 825         /*
 826          * We always perform autosense in Linux.
 827          * On other platforms this is set on a
 828          * per-transaction basis.
 829          */
 830         return (1);
 831 }
 832
 833 static __inline uint32_t
 834 ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)
 835 {
 836         return (sizeof(struct scsi_sense_data));
 837 }
 838
 839 static __inline void
 840 ahd_notify_xfer_settings_change(struct ahd_softc *ahd,
 841                                 struct ahd_devinfo *devinfo)
 842 {
 843         /* Nothing to do here for linux */
 844 }
 845
 846 static __inline void
 847 ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)
 848 {
 849         ahd->flags &= ~AHD_RESOURCE_SHORTAGE;
 850 }
 851
 852 int     ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);
 853 void    ahd_platform_free(struct ahd_softc *ahd);
 854 void    ahd_platform_init(struct ahd_softc *ahd);
 855 void    ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb);
 856 void    ahd_freeze_simq(struct ahd_softc *ahd);
 857 void    ahd_release_simq(struct ahd_softc *ahd);
 858
 859 static __inline void
 860 ahd_freeze_scb(struct scb *scb)
 861 {
 862         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
 863                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
 864                 scb->platform_data->dev->qfrozen++;
 865         }
 866 }
 867
 868 void    ahd_platform_set_tags(struct ahd_softc *ahd,
 869                               struct ahd_devinfo *devinfo, ahd_queue_alg);
 870 int     ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
 871                                 char channel, int lun, u_int tag,
 872                                 role_t role, uint32_t status);
 873 irqreturn_t
 874         ahd_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
 875 void    ahd_done(struct ahd_softc*, struct scb*);
 876 void    ahd_send_async(struct ahd_softc *, char channel,
 877                        u_int target, u_int lun, ac_code, void *);
 878 void    ahd_print_path(struct ahd_softc *, struct scb *);
 879
 880 #ifdef CONFIG_PCI
 881 #define AHD_PCI_CONFIG 1
 882 #else
 883 #define AHD_PCI_CONFIG 0
 884 #endif
 885 #define bootverbose aic79xx_verbose
 886 extern uint32_t aic79xx_verbose;
 887
 888 #endif /* _AIC79XX_LINUX_H_ */