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