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