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