drivers/scsi/aic7xxx/aic79xx_osm.h

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