drivers/scsi/aic7xxx/aic7xxx_osm.h

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