]> nv-tegra.nvidia Code Review - linux-2.6.git/blob - drivers/scsi/aic7xxx/aic7xxx_osm.h
752022e4d4d419f10449267d5b0d37744fca5817
[linux-2.6.git] / 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/types.h>
63 #include <linux/blkdev.h>
64 #include <linux/delay.h>
65 #include <linux/ioport.h>
66 #include <linux/pci.h>
67 #include <linux/smp_lock.h>
68 #include <linux/version.h>
69 #include <linux/interrupt.h>
70 #include <linux/module.h>
71 #include <asm/byteorder.h>
72 #include <asm/io.h>
73
74 #include <linux/config.h>
75 #include <linux/slab.h>
76
77 /* Core SCSI definitions */
78 #define AIC_LIB_PREFIX ahc
79 #include "scsi.h"
80 #include <scsi/scsi_host.h>
81
82 /* Name space conflict with BSD queue macros */
83 #ifdef LIST_HEAD
84 #undef LIST_HEAD
85 #endif
86
87 #include "cam.h"
88 #include "queue.h"
89 #include "scsi_message.h"
90 #include "aiclib.h"
91
92 /*********************************** Debugging ********************************/
93 #ifdef CONFIG_AIC7XXX_DEBUG_ENABLE
94 #ifdef CONFIG_AIC7XXX_DEBUG_MASK
95 #define AHC_DEBUG 1
96 #define AHC_DEBUG_OPTS CONFIG_AIC7XXX_DEBUG_MASK
97 #else
98 /*
99  * Compile in debugging code, but do not enable any printfs.
100  */
101 #define AHC_DEBUG 1
102 #endif
103 /* No debugging code. */
104 #endif
105
106 /************************* Forward Declarations *******************************/
107 struct ahc_softc;
108 typedef struct pci_dev *ahc_dev_softc_t;
109 typedef Scsi_Cmnd      *ahc_io_ctx_t;
110
111 /******************************* Byte Order ***********************************/
112 #define ahc_htobe16(x)  cpu_to_be16(x)
113 #define ahc_htobe32(x)  cpu_to_be32(x)
114 #define ahc_htobe64(x)  cpu_to_be64(x)
115 #define ahc_htole16(x)  cpu_to_le16(x)
116 #define ahc_htole32(x)  cpu_to_le32(x)
117 #define ahc_htole64(x)  cpu_to_le64(x)
118
119 #define ahc_be16toh(x)  be16_to_cpu(x)
120 #define ahc_be32toh(x)  be32_to_cpu(x)
121 #define ahc_be64toh(x)  be64_to_cpu(x)
122 #define ahc_le16toh(x)  le16_to_cpu(x)
123 #define ahc_le32toh(x)  le32_to_cpu(x)
124 #define ahc_le64toh(x)  le64_to_cpu(x)
125
126 #ifndef LITTLE_ENDIAN
127 #define LITTLE_ENDIAN 1234
128 #endif
129
130 #ifndef BIG_ENDIAN
131 #define BIG_ENDIAN 4321
132 #endif
133
134 #ifndef BYTE_ORDER
135 #if defined(__BIG_ENDIAN)
136 #define BYTE_ORDER BIG_ENDIAN
137 #endif
138 #if defined(__LITTLE_ENDIAN)
139 #define BYTE_ORDER LITTLE_ENDIAN
140 #endif
141 #endif /* BYTE_ORDER */
142
143 /************************* Configuration Data *********************************/
144 extern u_int aic7xxx_no_probe;
145 extern u_int aic7xxx_allow_memio;
146 extern int aic7xxx_detect_complete;
147 extern Scsi_Host_Template aic7xxx_driver_template;
148
149 /***************************** Bus Space/DMA **********************************/
150
151 typedef uint32_t bus_size_t;
152
153 typedef enum {
154         BUS_SPACE_MEMIO,
155         BUS_SPACE_PIO
156 } bus_space_tag_t;
157
158 typedef union {
159         u_long            ioport;
160         volatile uint8_t __iomem *maddr;
161 } bus_space_handle_t;
162
163 typedef struct bus_dma_segment
164 {
165         dma_addr_t      ds_addr;
166         bus_size_t      ds_len;
167 } bus_dma_segment_t;
168
169 struct ahc_linux_dma_tag
170 {
171         bus_size_t      alignment;
172         bus_size_t      boundary;
173         bus_size_t      maxsize;
174 };
175 typedef struct ahc_linux_dma_tag* bus_dma_tag_t;
176
177 struct ahc_linux_dmamap
178 {
179         dma_addr_t      bus_addr;
180 };
181 typedef struct ahc_linux_dmamap* 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         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         uint64_t                 hw_dma_mask;
483         ahc_linux_softc_flags    flags;
484 };
485
486 /************************** OS Utility Wrappers *******************************/
487 #define printf printk
488 #define M_NOWAIT GFP_ATOMIC
489 #define M_WAITOK 0
490 #define malloc(size, type, flags) kmalloc(size, flags)
491 #define free(ptr, type) kfree(ptr)
492
493 static __inline void ahc_delay(long);
494 static __inline void
495 ahc_delay(long usec)
496 {
497         /*
498          * udelay on Linux can have problems for
499          * multi-millisecond waits.  Wait at most
500          * 1024us per call.
501          */
502         while (usec > 0) {
503                 udelay(usec % 1024);
504                 usec -= 1024;
505         }
506 }
507
508
509 /***************************** Low Level I/O **********************************/
510 static __inline uint8_t ahc_inb(struct ahc_softc * ahc, long port);
511 static __inline void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
512 static __inline void ahc_outsb(struct ahc_softc * ahc, long port,
513                                uint8_t *, int count);
514 static __inline void ahc_insb(struct ahc_softc * ahc, long port,
515                                uint8_t *, int count);
516
517 static __inline uint8_t
518 ahc_inb(struct ahc_softc * ahc, long port)
519 {
520         uint8_t x;
521
522         if (ahc->tag == BUS_SPACE_MEMIO) {
523                 x = readb(ahc->bsh.maddr + port);
524         } else {
525                 x = inb(ahc->bsh.ioport + port);
526         }
527         mb();
528         return (x);
529 }
530
531 static __inline void
532 ahc_outb(struct ahc_softc * ahc, long port, uint8_t val)
533 {
534         if (ahc->tag == BUS_SPACE_MEMIO) {
535                 writeb(val, ahc->bsh.maddr + port);
536         } else {
537                 outb(val, ahc->bsh.ioport + port);
538         }
539         mb();
540 }
541
542 static __inline void
543 ahc_outsb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
544 {
545         int i;
546
547         /*
548          * There is probably a more efficient way to do this on Linux
549          * but we don't use this for anything speed critical and this
550          * should work.
551          */
552         for (i = 0; i < count; i++)
553                 ahc_outb(ahc, port, *array++);
554 }
555
556 static __inline void
557 ahc_insb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
558 {
559         int i;
560
561         /*
562          * There is probably a more efficient way to do this on Linux
563          * but we don't use this for anything speed critical and this
564          * should work.
565          */
566         for (i = 0; i < count; i++)
567                 *array++ = ahc_inb(ahc, port);
568 }
569
570 /**************************** Initialization **********************************/
571 int             ahc_linux_register_host(struct ahc_softc *,
572                                         Scsi_Host_Template *);
573
574 uint64_t        ahc_linux_get_memsize(void);
575
576 /*************************** Pretty Printing **********************************/
577 struct info_str {
578         char *buffer;
579         int length;
580         off_t offset;
581         int pos;
582 };
583
584 void    ahc_format_transinfo(struct info_str *info,
585                              struct ahc_transinfo *tinfo);
586
587 /******************************** Locking *************************************/
588 /* Lock protecting internal data structures */
589 static __inline void ahc_lockinit(struct ahc_softc *);
590 static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags);
591 static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags);
592
593 /* Lock held during ahc_list manipulation and ahc softc frees */
594 extern spinlock_t ahc_list_spinlock;
595 static __inline void ahc_list_lockinit(void);
596 static __inline void ahc_list_lock(unsigned long *flags);
597 static __inline void ahc_list_unlock(unsigned long *flags);
598
599 static __inline void
600 ahc_lockinit(struct ahc_softc *ahc)
601 {
602         spin_lock_init(&ahc->platform_data->spin_lock);
603 }
604
605 static __inline void
606 ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
607 {
608         spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
609 }
610
611 static __inline void
612 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
613 {
614         spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
615 }
616
617 static __inline void
618 ahc_list_lockinit(void)
619 {
620         spin_lock_init(&ahc_list_spinlock);
621 }
622
623 static __inline void
624 ahc_list_lock(unsigned long *flags)
625 {
626         spin_lock_irqsave(&ahc_list_spinlock, *flags);
627 }
628
629 static __inline void
630 ahc_list_unlock(unsigned long *flags)
631 {
632         spin_unlock_irqrestore(&ahc_list_spinlock, *flags);
633 }
634
635 /******************************* PCI Definitions ******************************/
636 /*
637  * PCIM_xxx: mask to locate subfield in register
638  * PCIR_xxx: config register offset
639  * PCIC_xxx: device class
640  * PCIS_xxx: device subclass
641  * PCIP_xxx: device programming interface
642  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
643  * PCID_xxx: device ID
644  */
645 #define PCIR_DEVVENDOR          0x00
646 #define PCIR_VENDOR             0x00
647 #define PCIR_DEVICE             0x02
648 #define PCIR_COMMAND            0x04
649 #define PCIM_CMD_PORTEN         0x0001
650 #define PCIM_CMD_MEMEN          0x0002
651 #define PCIM_CMD_BUSMASTEREN    0x0004
652 #define PCIM_CMD_MWRICEN        0x0010
653 #define PCIM_CMD_PERRESPEN      0x0040
654 #define PCIM_CMD_SERRESPEN      0x0100
655 #define PCIR_STATUS             0x06
656 #define PCIR_REVID              0x08
657 #define PCIR_PROGIF             0x09
658 #define PCIR_SUBCLASS           0x0a
659 #define PCIR_CLASS              0x0b
660 #define PCIR_CACHELNSZ          0x0c
661 #define PCIR_LATTIMER           0x0d
662 #define PCIR_HEADERTYPE         0x0e
663 #define PCIM_MFDEV              0x80
664 #define PCIR_BIST               0x0f
665 #define PCIR_CAP_PTR            0x34
666
667 /* config registers for header type 0 devices */
668 #define PCIR_MAPS       0x10
669 #define PCIR_SUBVEND_0  0x2c
670 #define PCIR_SUBDEV_0   0x2e
671
672 extern struct pci_driver aic7xxx_pci_driver;
673
674 typedef enum
675 {
676         AHC_POWER_STATE_D0,
677         AHC_POWER_STATE_D1,
678         AHC_POWER_STATE_D2,
679         AHC_POWER_STATE_D3
680 } ahc_power_state;
681
682 /**************************** VL/EISA Routines ********************************/
683 #ifdef CONFIG_EISA
684 extern uint32_t aic7xxx_probe_eisa_vl;
685 int                      ahc_linux_eisa_init(void);
686 void                     ahc_linux_eisa_exit(void);
687 int                      aic7770_map_registers(struct ahc_softc *ahc,
688                                                u_int port);
689 int                      aic7770_map_int(struct ahc_softc *ahc, u_int irq);
690 #else
691 static inline int       ahc_linux_eisa_init(void) {
692         return -ENODEV;
693 }
694 static inline void      ahc_linux_eisa_exit(void) {
695 }
696 #endif
697
698 /******************************* PCI Routines *********************************/
699 #ifdef CONFIG_PCI
700 int                      ahc_linux_pci_init(void);
701 void                     ahc_linux_pci_exit(void);
702 int                      ahc_pci_map_registers(struct ahc_softc *ahc);
703 int                      ahc_pci_map_int(struct ahc_softc *ahc);
704
705 static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
706                                              int reg, int width);
707
708 static __inline uint32_t
709 ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width)
710 {
711         switch (width) {
712         case 1:
713         {
714                 uint8_t retval;
715
716                 pci_read_config_byte(pci, reg, &retval);
717                 return (retval);
718         }
719         case 2:
720         {
721                 uint16_t retval;
722                 pci_read_config_word(pci, reg, &retval);
723                 return (retval);
724         }
725         case 4:
726         {
727                 uint32_t retval;
728                 pci_read_config_dword(pci, reg, &retval);
729                 return (retval);
730         }
731         default:
732                 panic("ahc_pci_read_config: Read size too big");
733                 /* NOTREACHED */
734                 return (0);
735         }
736 }
737
738 static __inline void ahc_pci_write_config(ahc_dev_softc_t pci,
739                                           int reg, uint32_t value,
740                                           int width);
741
742 static __inline void
743 ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width)
744 {
745         switch (width) {
746         case 1:
747                 pci_write_config_byte(pci, reg, value);
748                 break;
749         case 2:
750                 pci_write_config_word(pci, reg, value);
751                 break;
752         case 4:
753                 pci_write_config_dword(pci, reg, value);
754                 break;
755         default:
756                 panic("ahc_pci_write_config: Write size too big");
757                 /* NOTREACHED */
758         }
759 }
760
761 static __inline int ahc_get_pci_function(ahc_dev_softc_t);
762 static __inline int
763 ahc_get_pci_function(ahc_dev_softc_t pci)
764 {
765         return (PCI_FUNC(pci->devfn));
766 }
767
768 static __inline int ahc_get_pci_slot(ahc_dev_softc_t);
769 static __inline int
770 ahc_get_pci_slot(ahc_dev_softc_t pci)
771 {
772         return (PCI_SLOT(pci->devfn));
773 }
774
775 static __inline int ahc_get_pci_bus(ahc_dev_softc_t);
776 static __inline int
777 ahc_get_pci_bus(ahc_dev_softc_t pci)
778 {
779         return (pci->bus->number);
780 }
781 #else
782 static inline int ahc_linux_pci_init(void) {
783         return 0;
784 }
785 static inline void ahc_linux_pci_exit(void) {
786 }
787 #endif
788
789 static __inline void ahc_flush_device_writes(struct ahc_softc *);
790 static __inline void
791 ahc_flush_device_writes(struct ahc_softc *ahc)
792 {
793         /* XXX Is this sufficient for all architectures??? */
794         ahc_inb(ahc, INTSTAT);
795 }
796
797 /**************************** Proc FS Support *********************************/
798 int     ahc_linux_proc_info(struct Scsi_Host *, char *, char **,
799                             off_t, int, int);
800
801 /*************************** Domain Validation ********************************/
802 /*********************** Transaction Access Wrappers *************************/
803 static __inline void ahc_cmd_set_transaction_status(Scsi_Cmnd *, uint32_t);
804 static __inline void ahc_set_transaction_status(struct scb *, uint32_t);
805 static __inline void ahc_cmd_set_scsi_status(Scsi_Cmnd *, uint32_t);
806 static __inline void ahc_set_scsi_status(struct scb *, uint32_t);
807 static __inline uint32_t ahc_cmd_get_transaction_status(Scsi_Cmnd *cmd);
808 static __inline uint32_t ahc_get_transaction_status(struct scb *);
809 static __inline uint32_t ahc_cmd_get_scsi_status(Scsi_Cmnd *cmd);
810 static __inline uint32_t ahc_get_scsi_status(struct scb *);
811 static __inline void ahc_set_transaction_tag(struct scb *, int, u_int);
812 static __inline u_long ahc_get_transfer_length(struct scb *);
813 static __inline int ahc_get_transfer_dir(struct scb *);
814 static __inline void ahc_set_residual(struct scb *, u_long);
815 static __inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
816 static __inline u_long ahc_get_residual(struct scb *);
817 static __inline u_long ahc_get_sense_residual(struct scb *);
818 static __inline int ahc_perform_autosense(struct scb *);
819 static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
820                                                struct scb *);
821 static __inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
822                                                      struct ahc_devinfo *);
823 static __inline void ahc_platform_scb_free(struct ahc_softc *ahc,
824                                            struct scb *scb);
825 static __inline void ahc_freeze_scb(struct scb *scb);
826
827 static __inline
828 void ahc_cmd_set_transaction_status(Scsi_Cmnd *cmd, uint32_t status)
829 {
830         cmd->result &= ~(CAM_STATUS_MASK << 16);
831         cmd->result |= status << 16;
832 }
833
834 static __inline
835 void ahc_set_transaction_status(struct scb *scb, uint32_t status)
836 {
837         ahc_cmd_set_transaction_status(scb->io_ctx,status);
838 }
839
840 static __inline
841 void ahc_cmd_set_scsi_status(Scsi_Cmnd *cmd, uint32_t status)
842 {
843         cmd->result &= ~0xFFFF;
844         cmd->result |= status;
845 }
846
847 static __inline
848 void ahc_set_scsi_status(struct scb *scb, uint32_t status)
849 {
850         ahc_cmd_set_scsi_status(scb->io_ctx, status);
851 }
852
853 static __inline
854 uint32_t ahc_cmd_get_transaction_status(Scsi_Cmnd *cmd)
855 {
856         return ((cmd->result >> 16) & CAM_STATUS_MASK);
857 }
858
859 static __inline
860 uint32_t ahc_get_transaction_status(struct scb *scb)
861 {
862         return (ahc_cmd_get_transaction_status(scb->io_ctx));
863 }
864
865 static __inline
866 uint32_t ahc_cmd_get_scsi_status(Scsi_Cmnd *cmd)
867 {
868         return (cmd->result & 0xFFFF);
869 }
870
871 static __inline
872 uint32_t ahc_get_scsi_status(struct scb *scb)
873 {
874         return (ahc_cmd_get_scsi_status(scb->io_ctx));
875 }
876
877 static __inline
878 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
879 {
880         /*
881          * Nothing to do for linux as the incoming transaction
882          * has no concept of tag/non tagged, etc.
883          */
884 }
885
886 static __inline
887 u_long ahc_get_transfer_length(struct scb *scb)
888 {
889         return (scb->platform_data->xfer_len);
890 }
891
892 static __inline
893 int ahc_get_transfer_dir(struct scb *scb)
894 {
895         return (scb->io_ctx->sc_data_direction);
896 }
897
898 static __inline
899 void ahc_set_residual(struct scb *scb, u_long resid)
900 {
901         scb->io_ctx->resid = resid;
902 }
903
904 static __inline
905 void ahc_set_sense_residual(struct scb *scb, u_long resid)
906 {
907         scb->platform_data->sense_resid = resid;
908 }
909
910 static __inline
911 u_long ahc_get_residual(struct scb *scb)
912 {
913         return (scb->io_ctx->resid);
914 }
915
916 static __inline
917 u_long ahc_get_sense_residual(struct scb *scb)
918 {
919         return (scb->platform_data->sense_resid);
920 }
921
922 static __inline
923 int ahc_perform_autosense(struct scb *scb)
924 {
925         /*
926          * We always perform autosense in Linux.
927          * On other platforms this is set on a
928          * per-transaction basis.
929          */
930         return (1);
931 }
932
933 static __inline uint32_t
934 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
935 {
936         return (sizeof(struct scsi_sense_data));
937 }
938
939 static __inline void
940 ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
941                                 struct ahc_devinfo *devinfo)
942 {
943         /* Nothing to do here for linux */
944 }
945
946 static __inline void
947 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
948 {
949         ahc->flags &= ~AHC_RESOURCE_SHORTAGE;
950 }
951
952 int     ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
953 void    ahc_platform_free(struct ahc_softc *ahc);
954 void    ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
955
956 static __inline void
957 ahc_freeze_scb(struct scb *scb)
958 {
959         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
960                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
961                 scb->platform_data->dev->qfrozen++;
962         }
963 }
964
965 void    ahc_platform_set_tags(struct ahc_softc *ahc,
966                               struct ahc_devinfo *devinfo, ahc_queue_alg);
967 int     ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
968                                 char channel, int lun, u_int tag,
969                                 role_t role, uint32_t status);
970 irqreturn_t
971         ahc_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
972 void    ahc_platform_flushwork(struct ahc_softc *ahc);
973 int     ahc_softc_comp(struct ahc_softc *, struct ahc_softc *);
974 void    ahc_done(struct ahc_softc*, struct scb*);
975 void    ahc_send_async(struct ahc_softc *, char channel,
976                        u_int target, u_int lun, ac_code, void *);
977 void    ahc_print_path(struct ahc_softc *, struct scb *);
978 void    ahc_platform_dump_card_state(struct ahc_softc *ahc);
979
980 #ifdef CONFIG_PCI
981 #define AHC_PCI_CONFIG 1
982 #else
983 #define AHC_PCI_CONFIG 0
984 #endif
985 #define bootverbose aic7xxx_verbose
986 extern u_int aic7xxx_verbose;
987 #endif /* _AIC7XXX_LINUX_H_ */