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