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