]> err.no Git - linux-2.6/blob - drivers/scsi/aic7xxx/aic7xxx_osm.h
Merge /spare/repo/linux-2.6/
[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 /*************************** Device Data Structures ***************************/
272 /*
273  * A per probed device structure used to deal with some error recovery
274  * scenarios that the Linux mid-layer code just doesn't know how to
275  * handle.  The structure allocated for a device only becomes persistent
276  * after a successfully completed inquiry command to the target when
277  * that inquiry data indicates a lun is present.
278  */
279 typedef enum {
280         AHC_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
281         AHC_DEV_Q_BASIC          = 0x10, /* Allow basic device queuing */
282         AHC_DEV_Q_TAGGED         = 0x20, /* Allow full SCSI2 command queueing */
283         AHC_DEV_PERIODIC_OTAG    = 0x40, /* Send OTAG to prevent starvation */
284 } ahc_linux_dev_flags;
285
286 struct ahc_linux_target;
287 struct ahc_linux_device {
288         /*
289          * The number of transactions currently
290          * queued to the device.
291          */
292         int                     active;
293
294         /*
295          * The currently allowed number of 
296          * transactions that can be queued to
297          * the device.  Must be signed for
298          * conversion from tagged to untagged
299          * mode where the device may have more
300          * than one outstanding active transaction.
301          */
302         int                     openings;
303
304         /*
305          * A positive count indicates that this
306          * device's queue is halted.
307          */
308         u_int                   qfrozen;
309         
310         /*
311          * Cumulative command counter.
312          */
313         u_long                  commands_issued;
314
315         /*
316          * The number of tagged transactions when
317          * running at our current opening level
318          * that have been successfully received by
319          * this device since the last QUEUE FULL.
320          */
321         u_int                   tag_success_count;
322 #define AHC_TAG_SUCCESS_INTERVAL 50
323
324         ahc_linux_dev_flags     flags;
325
326         /*
327          * The high limit for the tags variable.
328          */
329         u_int                   maxtags;
330
331         /*
332          * The computed number of tags outstanding
333          * at the time of the last QUEUE FULL event.
334          */
335         u_int                   tags_on_last_queuefull;
336
337         /*
338          * How many times we have seen a queue full
339          * with the same number of tags.  This is used
340          * to stop our adaptive queue depth algorithm
341          * on devices with a fixed number of tags.
342          */
343         u_int                   last_queuefull_same_count;
344 #define AHC_LOCK_TAGS_COUNT 50
345
346         /*
347          * How many transactions have been queued
348          * without the device going idle.  We use
349          * this statistic to determine when to issue
350          * an ordered tag to prevent transaction
351          * starvation.  This statistic is only updated
352          * if the AHC_DEV_PERIODIC_OTAG flag is set
353          * on this device.
354          */
355         u_int                   commands_since_idle_or_otag;
356 #define AHC_OTAG_THRESH 500
357 };
358
359 struct ahc_linux_target {
360         struct scsi_device       *sdev[AHC_NUM_LUNS];
361         struct ahc_transinfo      last_tinfo;
362         struct ahc_softc         *ahc;
363 };
364
365 /********************* Definitions Required by the Core ***********************/
366 /*
367  * Number of SG segments we require.  So long as the S/G segments for
368  * a particular transaction are allocated in a physically contiguous
369  * manner and are allocated below 4GB, the number of S/G segments is
370  * unrestricted.
371  */
372 #define AHC_NSEG 128
373
374 /*
375  * Per-SCB OSM storage.
376  */
377 struct scb_platform_data {
378         struct ahc_linux_device *dev;
379         dma_addr_t               buf_busaddr;
380         uint32_t                 xfer_len;
381         uint32_t                 sense_resid;   /* Auto-Sense residual */
382 };
383
384 /*
385  * Define a structure used for each host adapter.  All members are
386  * aligned on a boundary >= the size of the member to honor the
387  * alignment restrictions of the various platforms supported by
388  * this driver.
389  */
390 struct ahc_platform_data {
391         /*
392          * Fields accessed from interrupt context.
393          */
394         struct scsi_target *starget[AHC_NUM_TARGETS]; 
395
396         spinlock_t               spin_lock;
397         u_int                    qfrozen;
398         struct timer_list        reset_timer;
399         struct semaphore         eh_sem;
400         struct Scsi_Host        *host;          /* pointer to scsi host */
401 #define AHC_LINUX_NOIRQ ((uint32_t)~0)
402         uint32_t                 irq;           /* IRQ for this adapter */
403         uint32_t                 bios_address;
404         uint32_t                 mem_busaddr;   /* Mem Base Addr */
405
406 #define AHC_UP_EH_SEMAPHORE      0x1
407         uint32_t                 flags;
408 };
409
410 /************************** OS Utility Wrappers *******************************/
411 #define printf printk
412 #define M_NOWAIT GFP_ATOMIC
413 #define M_WAITOK 0
414 #define malloc(size, type, flags) kmalloc(size, flags)
415 #define free(ptr, type) kfree(ptr)
416
417 static __inline void ahc_delay(long);
418 static __inline void
419 ahc_delay(long usec)
420 {
421         /*
422          * udelay on Linux can have problems for
423          * multi-millisecond waits.  Wait at most
424          * 1024us per call.
425          */
426         while (usec > 0) {
427                 udelay(usec % 1024);
428                 usec -= 1024;
429         }
430 }
431
432
433 /***************************** Low Level I/O **********************************/
434 static __inline uint8_t ahc_inb(struct ahc_softc * ahc, long port);
435 static __inline void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
436 static __inline void ahc_outsb(struct ahc_softc * ahc, long port,
437                                uint8_t *, int count);
438 static __inline void ahc_insb(struct ahc_softc * ahc, long port,
439                                uint8_t *, int count);
440
441 static __inline uint8_t
442 ahc_inb(struct ahc_softc * ahc, long port)
443 {
444         uint8_t x;
445
446         if (ahc->tag == BUS_SPACE_MEMIO) {
447                 x = readb(ahc->bsh.maddr + port);
448         } else {
449                 x = inb(ahc->bsh.ioport + port);
450         }
451         mb();
452         return (x);
453 }
454
455 static __inline void
456 ahc_outb(struct ahc_softc * ahc, long port, uint8_t val)
457 {
458         if (ahc->tag == BUS_SPACE_MEMIO) {
459                 writeb(val, ahc->bsh.maddr + port);
460         } else {
461                 outb(val, ahc->bsh.ioport + port);
462         }
463         mb();
464 }
465
466 static __inline void
467 ahc_outsb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
468 {
469         int i;
470
471         /*
472          * There is probably a more efficient way to do this on Linux
473          * but we don't use this for anything speed critical and this
474          * should work.
475          */
476         for (i = 0; i < count; i++)
477                 ahc_outb(ahc, port, *array++);
478 }
479
480 static __inline void
481 ahc_insb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
482 {
483         int i;
484
485         /*
486          * There is probably a more efficient way to do this on Linux
487          * but we don't use this for anything speed critical and this
488          * should work.
489          */
490         for (i = 0; i < count; i++)
491                 *array++ = ahc_inb(ahc, port);
492 }
493
494 /**************************** Initialization **********************************/
495 int             ahc_linux_register_host(struct ahc_softc *,
496                                         struct scsi_host_template *);
497
498 uint64_t        ahc_linux_get_memsize(void);
499
500 /*************************** Pretty Printing **********************************/
501 struct info_str {
502         char *buffer;
503         int length;
504         off_t offset;
505         int pos;
506 };
507
508 void    ahc_format_transinfo(struct info_str *info,
509                              struct ahc_transinfo *tinfo);
510
511 /******************************** Locking *************************************/
512 /* Lock protecting internal data structures */
513 static __inline void ahc_lockinit(struct ahc_softc *);
514 static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags);
515 static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags);
516
517 /* Lock held during ahc_list manipulation and ahc softc frees */
518 extern spinlock_t ahc_list_spinlock;
519 static __inline void ahc_list_lockinit(void);
520 static __inline void ahc_list_lock(unsigned long *flags);
521 static __inline void ahc_list_unlock(unsigned long *flags);
522
523 static __inline void
524 ahc_lockinit(struct ahc_softc *ahc)
525 {
526         spin_lock_init(&ahc->platform_data->spin_lock);
527 }
528
529 static __inline void
530 ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
531 {
532         spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
533 }
534
535 static __inline void
536 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
537 {
538         spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
539 }
540
541 static __inline void
542 ahc_list_lockinit(void)
543 {
544         spin_lock_init(&ahc_list_spinlock);
545 }
546
547 static __inline void
548 ahc_list_lock(unsigned long *flags)
549 {
550         spin_lock_irqsave(&ahc_list_spinlock, *flags);
551 }
552
553 static __inline void
554 ahc_list_unlock(unsigned long *flags)
555 {
556         spin_unlock_irqrestore(&ahc_list_spinlock, *flags);
557 }
558
559 /******************************* PCI Definitions ******************************/
560 /*
561  * PCIM_xxx: mask to locate subfield in register
562  * PCIR_xxx: config register offset
563  * PCIC_xxx: device class
564  * PCIS_xxx: device subclass
565  * PCIP_xxx: device programming interface
566  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
567  * PCID_xxx: device ID
568  */
569 #define PCIR_DEVVENDOR          0x00
570 #define PCIR_VENDOR             0x00
571 #define PCIR_DEVICE             0x02
572 #define PCIR_COMMAND            0x04
573 #define PCIM_CMD_PORTEN         0x0001
574 #define PCIM_CMD_MEMEN          0x0002
575 #define PCIM_CMD_BUSMASTEREN    0x0004
576 #define PCIM_CMD_MWRICEN        0x0010
577 #define PCIM_CMD_PERRESPEN      0x0040
578 #define PCIM_CMD_SERRESPEN      0x0100
579 #define PCIR_STATUS             0x06
580 #define PCIR_REVID              0x08
581 #define PCIR_PROGIF             0x09
582 #define PCIR_SUBCLASS           0x0a
583 #define PCIR_CLASS              0x0b
584 #define PCIR_CACHELNSZ          0x0c
585 #define PCIR_LATTIMER           0x0d
586 #define PCIR_HEADERTYPE         0x0e
587 #define PCIM_MFDEV              0x80
588 #define PCIR_BIST               0x0f
589 #define PCIR_CAP_PTR            0x34
590
591 /* config registers for header type 0 devices */
592 #define PCIR_MAPS       0x10
593 #define PCIR_SUBVEND_0  0x2c
594 #define PCIR_SUBDEV_0   0x2e
595
596 extern struct pci_driver aic7xxx_pci_driver;
597
598 typedef enum
599 {
600         AHC_POWER_STATE_D0,
601         AHC_POWER_STATE_D1,
602         AHC_POWER_STATE_D2,
603         AHC_POWER_STATE_D3
604 } ahc_power_state;
605
606 /**************************** VL/EISA Routines ********************************/
607 #ifdef CONFIG_EISA
608 int                      ahc_linux_eisa_init(void);
609 void                     ahc_linux_eisa_exit(void);
610 int                      aic7770_map_registers(struct ahc_softc *ahc,
611                                                u_int port);
612 int                      aic7770_map_int(struct ahc_softc *ahc, u_int irq);
613 #else
614 static inline int       ahc_linux_eisa_init(void) {
615         return -ENODEV;
616 }
617 static inline void      ahc_linux_eisa_exit(void) {
618 }
619 #endif
620
621 /******************************* PCI Routines *********************************/
622 #ifdef CONFIG_PCI
623 int                      ahc_linux_pci_init(void);
624 void                     ahc_linux_pci_exit(void);
625 int                      ahc_pci_map_registers(struct ahc_softc *ahc);
626 int                      ahc_pci_map_int(struct ahc_softc *ahc);
627
628 static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
629                                              int reg, int width);
630
631 static __inline uint32_t
632 ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width)
633 {
634         switch (width) {
635         case 1:
636         {
637                 uint8_t retval;
638
639                 pci_read_config_byte(pci, reg, &retval);
640                 return (retval);
641         }
642         case 2:
643         {
644                 uint16_t retval;
645                 pci_read_config_word(pci, reg, &retval);
646                 return (retval);
647         }
648         case 4:
649         {
650                 uint32_t retval;
651                 pci_read_config_dword(pci, reg, &retval);
652                 return (retval);
653         }
654         default:
655                 panic("ahc_pci_read_config: Read size too big");
656                 /* NOTREACHED */
657                 return (0);
658         }
659 }
660
661 static __inline void ahc_pci_write_config(ahc_dev_softc_t pci,
662                                           int reg, uint32_t value,
663                                           int width);
664
665 static __inline void
666 ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width)
667 {
668         switch (width) {
669         case 1:
670                 pci_write_config_byte(pci, reg, value);
671                 break;
672         case 2:
673                 pci_write_config_word(pci, reg, value);
674                 break;
675         case 4:
676                 pci_write_config_dword(pci, reg, value);
677                 break;
678         default:
679                 panic("ahc_pci_write_config: Write size too big");
680                 /* NOTREACHED */
681         }
682 }
683
684 static __inline int ahc_get_pci_function(ahc_dev_softc_t);
685 static __inline int
686 ahc_get_pci_function(ahc_dev_softc_t pci)
687 {
688         return (PCI_FUNC(pci->devfn));
689 }
690
691 static __inline int ahc_get_pci_slot(ahc_dev_softc_t);
692 static __inline int
693 ahc_get_pci_slot(ahc_dev_softc_t pci)
694 {
695         return (PCI_SLOT(pci->devfn));
696 }
697
698 static __inline int ahc_get_pci_bus(ahc_dev_softc_t);
699 static __inline int
700 ahc_get_pci_bus(ahc_dev_softc_t pci)
701 {
702         return (pci->bus->number);
703 }
704 #else
705 static inline int ahc_linux_pci_init(void) {
706         return 0;
707 }
708 static inline void ahc_linux_pci_exit(void) {
709 }
710 #endif
711
712 static __inline void ahc_flush_device_writes(struct ahc_softc *);
713 static __inline void
714 ahc_flush_device_writes(struct ahc_softc *ahc)
715 {
716         /* XXX Is this sufficient for all architectures??? */
717         ahc_inb(ahc, INTSTAT);
718 }
719
720 /**************************** Proc FS Support *********************************/
721 int     ahc_linux_proc_info(struct Scsi_Host *, char *, char **,
722                             off_t, int, int);
723
724 /*************************** Domain Validation ********************************/
725 /*********************** Transaction Access Wrappers *************************/
726 static __inline void ahc_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
727 static __inline void ahc_set_transaction_status(struct scb *, uint32_t);
728 static __inline void ahc_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
729 static __inline void ahc_set_scsi_status(struct scb *, uint32_t);
730 static __inline uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd);
731 static __inline uint32_t ahc_get_transaction_status(struct scb *);
732 static __inline uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd);
733 static __inline uint32_t ahc_get_scsi_status(struct scb *);
734 static __inline void ahc_set_transaction_tag(struct scb *, int, u_int);
735 static __inline u_long ahc_get_transfer_length(struct scb *);
736 static __inline int ahc_get_transfer_dir(struct scb *);
737 static __inline void ahc_set_residual(struct scb *, u_long);
738 static __inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
739 static __inline u_long ahc_get_residual(struct scb *);
740 static __inline u_long ahc_get_sense_residual(struct scb *);
741 static __inline int ahc_perform_autosense(struct scb *);
742 static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
743                                                struct scb *);
744 static __inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
745                                                      struct ahc_devinfo *);
746 static __inline void ahc_platform_scb_free(struct ahc_softc *ahc,
747                                            struct scb *scb);
748 static __inline void ahc_freeze_scb(struct scb *scb);
749
750 static __inline
751 void ahc_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
752 {
753         cmd->result &= ~(CAM_STATUS_MASK << 16);
754         cmd->result |= status << 16;
755 }
756
757 static __inline
758 void ahc_set_transaction_status(struct scb *scb, uint32_t status)
759 {
760         ahc_cmd_set_transaction_status(scb->io_ctx,status);
761 }
762
763 static __inline
764 void ahc_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
765 {
766         cmd->result &= ~0xFFFF;
767         cmd->result |= status;
768 }
769
770 static __inline
771 void ahc_set_scsi_status(struct scb *scb, uint32_t status)
772 {
773         ahc_cmd_set_scsi_status(scb->io_ctx, status);
774 }
775
776 static __inline
777 uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd)
778 {
779         return ((cmd->result >> 16) & CAM_STATUS_MASK);
780 }
781
782 static __inline
783 uint32_t ahc_get_transaction_status(struct scb *scb)
784 {
785         return (ahc_cmd_get_transaction_status(scb->io_ctx));
786 }
787
788 static __inline
789 uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd)
790 {
791         return (cmd->result & 0xFFFF);
792 }
793
794 static __inline
795 uint32_t ahc_get_scsi_status(struct scb *scb)
796 {
797         return (ahc_cmd_get_scsi_status(scb->io_ctx));
798 }
799
800 static __inline
801 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
802 {
803         /*
804          * Nothing to do for linux as the incoming transaction
805          * has no concept of tag/non tagged, etc.
806          */
807 }
808
809 static __inline
810 u_long ahc_get_transfer_length(struct scb *scb)
811 {
812         return (scb->platform_data->xfer_len);
813 }
814
815 static __inline
816 int ahc_get_transfer_dir(struct scb *scb)
817 {
818         return (scb->io_ctx->sc_data_direction);
819 }
820
821 static __inline
822 void ahc_set_residual(struct scb *scb, u_long resid)
823 {
824         scb->io_ctx->resid = resid;
825 }
826
827 static __inline
828 void ahc_set_sense_residual(struct scb *scb, u_long resid)
829 {
830         scb->platform_data->sense_resid = resid;
831 }
832
833 static __inline
834 u_long ahc_get_residual(struct scb *scb)
835 {
836         return (scb->io_ctx->resid);
837 }
838
839 static __inline
840 u_long ahc_get_sense_residual(struct scb *scb)
841 {
842         return (scb->platform_data->sense_resid);
843 }
844
845 static __inline
846 int ahc_perform_autosense(struct scb *scb)
847 {
848         /*
849          * We always perform autosense in Linux.
850          * On other platforms this is set on a
851          * per-transaction basis.
852          */
853         return (1);
854 }
855
856 static __inline uint32_t
857 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
858 {
859         return (sizeof(struct scsi_sense_data));
860 }
861
862 static __inline void
863 ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
864                                 struct ahc_devinfo *devinfo)
865 {
866         /* Nothing to do here for linux */
867 }
868
869 static __inline void
870 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
871 {
872 }
873
874 int     ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
875 void    ahc_platform_free(struct ahc_softc *ahc);
876 void    ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
877
878 static __inline void
879 ahc_freeze_scb(struct scb *scb)
880 {
881         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
882                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
883                 scb->platform_data->dev->qfrozen++;
884         }
885 }
886
887 void    ahc_platform_set_tags(struct ahc_softc *ahc,
888                               struct ahc_devinfo *devinfo, ahc_queue_alg);
889 int     ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
890                                 char channel, int lun, u_int tag,
891                                 role_t role, uint32_t status);
892 irqreturn_t
893         ahc_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
894 void    ahc_platform_flushwork(struct ahc_softc *ahc);
895 int     ahc_softc_comp(struct ahc_softc *, struct ahc_softc *);
896 void    ahc_done(struct ahc_softc*, struct scb*);
897 void    ahc_send_async(struct ahc_softc *, char channel,
898                        u_int target, u_int lun, ac_code, void *);
899 void    ahc_print_path(struct ahc_softc *, struct scb *);
900 void    ahc_platform_dump_card_state(struct ahc_softc *ahc);
901
902 #ifdef CONFIG_PCI
903 #define AHC_PCI_CONFIG 1
904 #else
905 #define AHC_PCI_CONFIG 0
906 #endif
907 #define bootverbose aic7xxx_verbose
908 extern u_int aic7xxx_verbose;
909 #endif /* _AIC7XXX_LINUX_H_ */