ed9027bd8a40917ed2a8788ac7246e0be10219d5
[linux-2.6.git] / drivers / scsi / aic7xxx / aic7xxx_osm.h
1 /*
2  * Adaptec AIC7xxx device driver for Linux.
3  *
4  * Copyright (c) 1994 John Aycock
5  *   The University of Calgary Department of Computer Science.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; see the file COPYING.  If not, write to
19  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20  * 
21  * Copyright (c) 2000-2003 Adaptec Inc.
22  * All rights reserved.
23  *
24  * Redistribution and use in source and binary forms, with or without
25  * modification, are permitted provided that the following conditions
26  * are met:
27  * 1. Redistributions of source code must retain the above copyright
28  *    notice, this list of conditions, and the following disclaimer,
29  *    without modification.
30  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
31  *    substantially similar to the "NO WARRANTY" disclaimer below
32  *    ("Disclaimer") and any redistribution must be conditioned upon
33  *    including a substantially similar Disclaimer requirement for further
34  *    binary redistribution.
35  * 3. Neither the names of the above-listed copyright holders nor the names
36  *    of any contributors may be used to endorse or promote products derived
37  *    from this software without specific prior written permission.
38  *
39  * Alternatively, this software may be distributed under the terms of the
40  * GNU General Public License ("GPL") version 2 as published by the Free
41  * Software Foundation.
42  *
43  * NO WARRANTY
44  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
47  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
52  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
53  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
54  * POSSIBILITY OF SUCH DAMAGES.
55  *
56  * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic7xxx_osm.h#151 $
57  *
58  */
59 #ifndef _AIC7XXX_LINUX_H_
60 #define _AIC7XXX_LINUX_H_
61
62 #include <linux/types.h>
63 #include <linux/blkdev.h>
64 #include <linux/delay.h>
65 #include <linux/ioport.h>
66 #include <linux/pci.h>
67 #include <linux/smp_lock.h>
68 #include <linux/version.h>
69 #include <linux/module.h>
70 #include <asm/byteorder.h>
71 #include <asm/io.h>
72
73 #include <linux/interrupt.h> /* For tasklet support. */
74 #include <linux/config.h>
75 #include <linux/slab.h>
76
77 /* Core SCSI definitions */
78 #define AIC_LIB_PREFIX ahc
79 #include "scsi.h"
80 #include <scsi/scsi_host.h>
81
82 /* Name space conflict with BSD queue macros */
83 #ifdef LIST_HEAD
84 #undef LIST_HEAD
85 #endif
86
87 #include "cam.h"
88 #include "queue.h"
89 #include "scsi_message.h"
90 #include "aiclib.h"
91
92 /*********************************** Debugging ********************************/
93 #ifdef CONFIG_AIC7XXX_DEBUG_ENABLE
94 #ifdef CONFIG_AIC7XXX_DEBUG_MASK
95 #define AHC_DEBUG 1
96 #define AHC_DEBUG_OPTS CONFIG_AIC7XXX_DEBUG_MASK
97 #else
98 /*
99  * Compile in debugging code, but do not enable any printfs.
100  */
101 #define AHC_DEBUG 1
102 #endif
103 /* No debugging code. */
104 #endif
105
106 /************************* Forward Declarations *******************************/
107 struct ahc_softc;
108 typedef struct pci_dev *ahc_dev_softc_t;
109 typedef Scsi_Cmnd      *ahc_io_ctx_t;
110
111 /******************************* Byte Order ***********************************/
112 #define ahc_htobe16(x)  cpu_to_be16(x)
113 #define ahc_htobe32(x)  cpu_to_be32(x)
114 #define ahc_htobe64(x)  cpu_to_be64(x)
115 #define ahc_htole16(x)  cpu_to_le16(x)
116 #define ahc_htole32(x)  cpu_to_le32(x)
117 #define ahc_htole64(x)  cpu_to_le64(x)
118
119 #define ahc_be16toh(x)  be16_to_cpu(x)
120 #define ahc_be32toh(x)  be32_to_cpu(x)
121 #define ahc_be64toh(x)  be64_to_cpu(x)
122 #define ahc_le16toh(x)  le16_to_cpu(x)
123 #define ahc_le32toh(x)  le32_to_cpu(x)
124 #define ahc_le64toh(x)  le64_to_cpu(x)
125
126 #ifndef LITTLE_ENDIAN
127 #define LITTLE_ENDIAN 1234
128 #endif
129
130 #ifndef BIG_ENDIAN
131 #define BIG_ENDIAN 4321
132 #endif
133
134 #ifndef BYTE_ORDER
135 #if defined(__BIG_ENDIAN)
136 #define BYTE_ORDER BIG_ENDIAN
137 #endif
138 #if defined(__LITTLE_ENDIAN)
139 #define BYTE_ORDER LITTLE_ENDIAN
140 #endif
141 #endif /* BYTE_ORDER */
142
143 /************************* Configuration Data *********************************/
144 extern u_int aic7xxx_no_probe;
145 extern u_int aic7xxx_allow_memio;
146 extern int aic7xxx_detect_complete;
147 extern Scsi_Host_Template aic7xxx_driver_template;
148
149 /***************************** Bus Space/DMA **********************************/
150
151 typedef uint32_t bus_size_t;
152
153 typedef enum {
154         BUS_SPACE_MEMIO,
155         BUS_SPACE_PIO
156 } bus_space_tag_t;
157
158 typedef union {
159         u_long            ioport;
160         volatile uint8_t __iomem *maddr;
161 } bus_space_handle_t;
162
163 typedef struct bus_dma_segment
164 {
165         dma_addr_t      ds_addr;
166         bus_size_t      ds_len;
167 } bus_dma_segment_t;
168
169 struct ahc_linux_dma_tag
170 {
171         bus_size_t      alignment;
172         bus_size_t      boundary;
173         bus_size_t      maxsize;
174 };
175 typedef struct ahc_linux_dma_tag* bus_dma_tag_t;
176
177 struct ahc_linux_dmamap
178 {
179         dma_addr_t      bus_addr;
180 };
181 typedef struct ahc_linux_dmamap* bus_dmamap_t;
182
183 typedef int bus_dma_filter_t(void*, dma_addr_t);
184 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
185
186 #define BUS_DMA_WAITOK          0x0
187 #define BUS_DMA_NOWAIT          0x1
188 #define BUS_DMA_ALLOCNOW        0x2
189 #define BUS_DMA_LOAD_SEGS       0x4     /*
190                                          * Argument is an S/G list not
191                                          * a single buffer.
192                                          */
193
194 #define BUS_SPACE_MAXADDR       0xFFFFFFFF
195 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
196 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
197
198 int     ahc_dma_tag_create(struct ahc_softc *, bus_dma_tag_t /*parent*/,
199                            bus_size_t /*alignment*/, bus_size_t /*boundary*/,
200                            dma_addr_t /*lowaddr*/, dma_addr_t /*highaddr*/,
201                            bus_dma_filter_t*/*filter*/, void */*filterarg*/,
202                            bus_size_t /*maxsize*/, int /*nsegments*/,
203                            bus_size_t /*maxsegsz*/, int /*flags*/,
204                            bus_dma_tag_t */*dma_tagp*/);
205
206 void    ahc_dma_tag_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/);
207
208 int     ahc_dmamem_alloc(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
209                          void** /*vaddr*/, int /*flags*/,
210                          bus_dmamap_t* /*mapp*/);
211
212 void    ahc_dmamem_free(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
213                         void* /*vaddr*/, bus_dmamap_t /*map*/);
214
215 void    ahc_dmamap_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/,
216                            bus_dmamap_t /*map*/);
217
218 int     ahc_dmamap_load(struct ahc_softc *ahc, bus_dma_tag_t /*dmat*/,
219                         bus_dmamap_t /*map*/, void * /*buf*/,
220                         bus_size_t /*buflen*/, bus_dmamap_callback_t *,
221                         void */*callback_arg*/, int /*flags*/);
222
223 int     ahc_dmamap_unload(struct ahc_softc *, bus_dma_tag_t, bus_dmamap_t);
224
225 /*
226  * Operations performed by ahc_dmamap_sync().
227  */
228 #define BUS_DMASYNC_PREREAD     0x01    /* pre-read synchronization */
229 #define BUS_DMASYNC_POSTREAD    0x02    /* post-read synchronization */
230 #define BUS_DMASYNC_PREWRITE    0x04    /* pre-write synchronization */
231 #define BUS_DMASYNC_POSTWRITE   0x08    /* post-write synchronization */
232
233 /*
234  * XXX
235  * ahc_dmamap_sync is only used on buffers allocated with
236  * the pci_alloc_consistent() API.  Although I'm not sure how
237  * this works on architectures with a write buffer, Linux does
238  * not have an API to sync "coherent" memory.  Perhaps we need
239  * to do an mb()?
240  */
241 #define ahc_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op)
242
243 /************************** Timer DataStructures ******************************/
244 typedef struct timer_list ahc_timer_t;
245
246 /********************************** Includes **********************************/
247 #ifdef CONFIG_AIC7XXX_REG_PRETTY_PRINT
248 #define AIC_DEBUG_REGISTERS 1
249 #else
250 #define AIC_DEBUG_REGISTERS 0
251 #endif
252 #include "aic7xxx.h"
253
254 /***************************** Timer Facilities *******************************/
255 #define ahc_timer_init init_timer
256 #define ahc_timer_stop del_timer_sync
257 typedef void ahc_linux_callback_t (u_long);  
258 static __inline void ahc_timer_reset(ahc_timer_t *timer, int usec,
259                                      ahc_callback_t *func, void *arg);
260 static __inline void ahc_scb_timer_reset(struct scb *scb, u_int usec);
261
262 static __inline void
263 ahc_timer_reset(ahc_timer_t *timer, int usec, ahc_callback_t *func, void *arg)
264 {
265         struct ahc_softc *ahc;
266
267         ahc = (struct ahc_softc *)arg;
268         del_timer(timer);
269         timer->data = (u_long)arg;
270         timer->expires = jiffies + (usec * HZ)/1000000;
271         timer->function = (ahc_linux_callback_t*)func;
272         add_timer(timer);
273 }
274
275 static __inline void
276 ahc_scb_timer_reset(struct scb *scb, u_int usec)
277 {
278         mod_timer(&scb->io_ctx->eh_timeout, jiffies + (usec * HZ)/1000000);
279 }
280
281 /***************************** SMP support ************************************/
282 #include <linux/spinlock.h>
283
284 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0) || defined(SCSI_HAS_HOST_LOCK))
285 #define AHC_SCSI_HAS_HOST_LOCK 1
286 #else
287 #define AHC_SCSI_HAS_HOST_LOCK 0
288 #endif
289
290 #define AIC7XXX_DRIVER_VERSION "6.2.36"
291
292 /**************************** Front End Queues ********************************/
293 /*
294  * Data structure used to cast the Linux struct scsi_cmnd to something
295  * that allows us to use the queue macros.  The linux structure has
296  * plenty of space to hold the links fields as required by the queue
297  * macros, but the queue macors require them to have the correct type.
298  */
299 struct ahc_cmd_internal {
300         /* Area owned by the Linux scsi layer. */
301         uint8_t private[offsetof(struct scsi_cmnd, SCp.Status)];
302         union {
303                 STAILQ_ENTRY(ahc_cmd)   ste;
304                 LIST_ENTRY(ahc_cmd)     le;
305                 TAILQ_ENTRY(ahc_cmd)    tqe;
306         } links;
307         uint32_t                        end;
308 };
309
310 struct ahc_cmd {
311         union {
312                 struct ahc_cmd_internal icmd;
313                 struct scsi_cmnd        scsi_cmd;
314         } un;
315 };
316
317 #define acmd_icmd(cmd) ((cmd)->un.icmd)
318 #define acmd_scsi_cmd(cmd) ((cmd)->un.scsi_cmd)
319 #define acmd_links un.icmd.links
320
321 /*************************** Device Data Structures ***************************/
322 /*
323  * A per probed device structure used to deal with some error recovery
324  * scenarios that the Linux mid-layer code just doesn't know how to
325  * handle.  The structure allocated for a device only becomes persistent
326  * after a successfully completed inquiry command to the target when
327  * that inquiry data indicates a lun is present.
328  */
329 TAILQ_HEAD(ahc_busyq, ahc_cmd);
330 typedef enum {
331         AHC_DEV_UNCONFIGURED     = 0x01,
332         AHC_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
333         AHC_DEV_TIMER_ACTIVE     = 0x04, /* Our timer is active */
334         AHC_DEV_ON_RUN_LIST      = 0x08, /* Queued to be run later */
335         AHC_DEV_Q_BASIC          = 0x10, /* Allow basic device queuing */
336         AHC_DEV_Q_TAGGED         = 0x20, /* Allow full SCSI2 command queueing */
337         AHC_DEV_PERIODIC_OTAG    = 0x40, /* Send OTAG to prevent starvation */
338         AHC_DEV_SLAVE_CONFIGURED = 0x80  /* slave_configure() has been called */
339 } ahc_linux_dev_flags;
340
341 struct ahc_linux_target;
342 struct ahc_linux_device {
343         TAILQ_ENTRY(ahc_linux_device) links;
344         struct          ahc_busyq busyq;
345
346         /*
347          * The number of transactions currently
348          * queued to the device.
349          */
350         int                     active;
351
352         /*
353          * The currently allowed number of 
354          * transactions that can be queued to
355          * the device.  Must be signed for
356          * conversion from tagged to untagged
357          * mode where the device may have more
358          * than one outstanding active transaction.
359          */
360         int                     openings;
361
362         /*
363          * A positive count indicates that this
364          * device's queue is halted.
365          */
366         u_int                   qfrozen;
367         
368         /*
369          * Cumulative command counter.
370          */
371         u_long                  commands_issued;
372
373         /*
374          * The number of tagged transactions when
375          * running at our current opening level
376          * that have been successfully received by
377          * this device since the last QUEUE FULL.
378          */
379         u_int                   tag_success_count;
380 #define AHC_TAG_SUCCESS_INTERVAL 50
381
382         ahc_linux_dev_flags     flags;
383
384         /*
385          * Per device timer.
386          */
387         struct timer_list       timer;
388
389         /*
390          * The high limit for the tags variable.
391          */
392         u_int                   maxtags;
393
394         /*
395          * The computed number of tags outstanding
396          * at the time of the last QUEUE FULL event.
397          */
398         u_int                   tags_on_last_queuefull;
399
400         /*
401          * How many times we have seen a queue full
402          * with the same number of tags.  This is used
403          * to stop our adaptive queue depth algorithm
404          * on devices with a fixed number of tags.
405          */
406         u_int                   last_queuefull_same_count;
407 #define AHC_LOCK_TAGS_COUNT 50
408
409         /*
410          * How many transactions have been queued
411          * without the device going idle.  We use
412          * this statistic to determine when to issue
413          * an ordered tag to prevent transaction
414          * starvation.  This statistic is only updated
415          * if the AHC_DEV_PERIODIC_OTAG flag is set
416          * on this device.
417          */
418         u_int                   commands_since_idle_or_otag;
419 #define AHC_OTAG_THRESH 500
420
421         int                     lun;
422         Scsi_Device            *scsi_device;
423         struct                  ahc_linux_target *target;
424 };
425
426 struct ahc_linux_target {
427         struct ahc_linux_device  *devices[AHC_NUM_LUNS];
428         int                       channel;
429         int                       target;
430         int                       refcount;
431         struct ahc_transinfo      last_tinfo;
432         struct ahc_softc         *ahc;
433 };
434
435 /********************* Definitions Required by the Core ***********************/
436 /*
437  * Number of SG segments we require.  So long as the S/G segments for
438  * a particular transaction are allocated in a physically contiguous
439  * manner and are allocated below 4GB, the number of S/G segments is
440  * unrestricted.
441  */
442 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
443 /*
444  * We dynamically adjust the number of segments in pre-2.5 kernels to
445  * avoid fragmentation issues in the SCSI mid-layer's private memory
446  * allocator.  See aic7xxx_osm.c ahc_linux_size_nseg() for details.
447  */
448 extern u_int ahc_linux_nseg;
449 #define AHC_NSEG ahc_linux_nseg
450 #define AHC_LINUX_MIN_NSEG 64
451 #else
452 #define AHC_NSEG 128
453 #endif
454
455 /*
456  * Per-SCB OSM storage.
457  */
458 typedef enum {
459         AHC_UP_EH_SEMAPHORE = 0x1
460 } ahc_linux_scb_flags;
461
462 struct scb_platform_data {
463         struct ahc_linux_device *dev;
464         dma_addr_t               buf_busaddr;
465         uint32_t                 xfer_len;
466         uint32_t                 sense_resid;   /* Auto-Sense residual */
467         ahc_linux_scb_flags      flags;
468 };
469
470 /*
471  * Define a structure used for each host adapter.  All members are
472  * aligned on a boundary >= the size of the member to honor the
473  * alignment restrictions of the various platforms supported by
474  * this driver.
475  */
476 typedef enum {
477         AHC_RUN_CMPLT_Q_TIMER    = 0x10
478 } ahc_linux_softc_flags;
479
480 TAILQ_HEAD(ahc_completeq, ahc_cmd);
481
482 struct ahc_platform_data {
483         /*
484          * Fields accessed from interrupt context.
485          */
486         struct ahc_linux_target *targets[AHC_NUM_TARGETS]; 
487         TAILQ_HEAD(, ahc_linux_device) device_runq;
488         struct ahc_completeq     completeq;
489
490         spinlock_t               spin_lock;
491         struct tasklet_struct    runq_tasklet;
492         u_int                    qfrozen;
493         pid_t                    dv_pid;
494         struct timer_list        completeq_timer;
495         struct timer_list        reset_timer;
496         struct semaphore         eh_sem;
497         struct semaphore         dv_sem;
498         struct semaphore         dv_cmd_sem;    /* XXX This needs to be in
499                                                  * the target struct
500                                                  */
501         struct scsi_device      *dv_scsi_dev;
502         struct Scsi_Host        *host;          /* pointer to scsi host */
503 #define AHC_LINUX_NOIRQ ((uint32_t)~0)
504         uint32_t                 irq;           /* IRQ for this adapter */
505         uint32_t                 bios_address;
506         uint32_t                 mem_busaddr;   /* Mem Base Addr */
507         uint64_t                 hw_dma_mask;
508         ahc_linux_softc_flags    flags;
509 };
510
511 /************************** OS Utility Wrappers *******************************/
512 #define printf printk
513 #define M_NOWAIT GFP_ATOMIC
514 #define M_WAITOK 0
515 #define malloc(size, type, flags) kmalloc(size, flags)
516 #define free(ptr, type) kfree(ptr)
517
518 static __inline void ahc_delay(long);
519 static __inline void
520 ahc_delay(long usec)
521 {
522         /*
523          * udelay on Linux can have problems for
524          * multi-millisecond waits.  Wait at most
525          * 1024us per call.
526          */
527         while (usec > 0) {
528                 udelay(usec % 1024);
529                 usec -= 1024;
530         }
531 }
532
533
534 /***************************** Low Level I/O **********************************/
535 static __inline uint8_t ahc_inb(struct ahc_softc * ahc, long port);
536 static __inline void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
537 static __inline void ahc_outsb(struct ahc_softc * ahc, long port,
538                                uint8_t *, int count);
539 static __inline void ahc_insb(struct ahc_softc * ahc, long port,
540                                uint8_t *, int count);
541
542 static __inline uint8_t
543 ahc_inb(struct ahc_softc * ahc, long port)
544 {
545         uint8_t x;
546
547         if (ahc->tag == BUS_SPACE_MEMIO) {
548                 x = readb(ahc->bsh.maddr + port);
549         } else {
550                 x = inb(ahc->bsh.ioport + port);
551         }
552         mb();
553         return (x);
554 }
555
556 static __inline void
557 ahc_outb(struct ahc_softc * ahc, long port, uint8_t val)
558 {
559         if (ahc->tag == BUS_SPACE_MEMIO) {
560                 writeb(val, ahc->bsh.maddr + port);
561         } else {
562                 outb(val, ahc->bsh.ioport + port);
563         }
564         mb();
565 }
566
567 static __inline void
568 ahc_outsb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
569 {
570         int i;
571
572         /*
573          * There is probably a more efficient way to do this on Linux
574          * but we don't use this for anything speed critical and this
575          * should work.
576          */
577         for (i = 0; i < count; i++)
578                 ahc_outb(ahc, port, *array++);
579 }
580
581 static __inline void
582 ahc_insb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
583 {
584         int i;
585
586         /*
587          * There is probably a more efficient way to do this on Linux
588          * but we don't use this for anything speed critical and this
589          * should work.
590          */
591         for (i = 0; i < count; i++)
592                 *array++ = ahc_inb(ahc, port);
593 }
594
595 /**************************** Initialization **********************************/
596 int             ahc_linux_register_host(struct ahc_softc *,
597                                         Scsi_Host_Template *);
598
599 uint64_t        ahc_linux_get_memsize(void);
600
601 /*************************** Pretty Printing **********************************/
602 struct info_str {
603         char *buffer;
604         int length;
605         off_t offset;
606         int pos;
607 };
608
609 void    ahc_format_transinfo(struct info_str *info,
610                              struct ahc_transinfo *tinfo);
611
612 /******************************** Locking *************************************/
613 /* Lock protecting internal data structures */
614 static __inline void ahc_lockinit(struct ahc_softc *);
615 static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags);
616 static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags);
617
618 /* Lock acquisition and release of the above lock in midlayer entry points. */
619 static __inline void ahc_midlayer_entrypoint_lock(struct ahc_softc *,
620                                                   unsigned long *flags);
621 static __inline void ahc_midlayer_entrypoint_unlock(struct ahc_softc *,
622                                                     unsigned long *flags);
623
624 /* Lock held during command compeletion to the upper layer */
625 static __inline void ahc_done_lockinit(struct ahc_softc *);
626 static __inline void ahc_done_lock(struct ahc_softc *, unsigned long *flags);
627 static __inline void ahc_done_unlock(struct ahc_softc *, unsigned long *flags);
628
629 /* Lock held during ahc_list manipulation and ahc softc frees */
630 extern spinlock_t ahc_list_spinlock;
631 static __inline void ahc_list_lockinit(void);
632 static __inline void ahc_list_lock(unsigned long *flags);
633 static __inline void ahc_list_unlock(unsigned long *flags);
634
635 static __inline void
636 ahc_lockinit(struct ahc_softc *ahc)
637 {
638         spin_lock_init(&ahc->platform_data->spin_lock);
639 }
640
641 static __inline void
642 ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
643 {
644         spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
645 }
646
647 static __inline void
648 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
649 {
650         spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
651 }
652
653 static __inline void
654 ahc_midlayer_entrypoint_lock(struct ahc_softc *ahc, unsigned long *flags)
655 {
656         /*
657          * In 2.5.X and some 2.4.X versions, the midlayer takes our
658          * lock just before calling us, so we avoid locking again.
659          * For other kernel versions, the io_request_lock is taken
660          * just before our entry point is called.  In this case, we
661          * trade the io_request_lock for our per-softc lock.
662          */
663 #if AHC_SCSI_HAS_HOST_LOCK == 0
664         spin_unlock(&io_request_lock);
665         spin_lock(&ahc->platform_data->spin_lock);
666 #endif
667 }
668
669 static __inline void
670 ahc_midlayer_entrypoint_unlock(struct ahc_softc *ahc, unsigned long *flags)
671 {
672 #if AHC_SCSI_HAS_HOST_LOCK == 0
673         spin_unlock(&ahc->platform_data->spin_lock);
674         spin_lock(&io_request_lock);
675 #endif
676 }
677
678 static __inline void
679 ahc_done_lockinit(struct ahc_softc *ahc)
680 {
681         /*
682          * In 2.5.X, our own lock is held during completions.
683          * In previous versions, the io_request_lock is used.
684          * In either case, we can't initialize this lock again.
685          */
686 }
687
688 static __inline void
689 ahc_done_lock(struct ahc_softc *ahc, unsigned long *flags)
690 {
691 #if AHC_SCSI_HAS_HOST_LOCK == 0
692         spin_lock_irqsave(&io_request_lock, *flags);
693 #endif
694 }
695
696 static __inline void
697 ahc_done_unlock(struct ahc_softc *ahc, unsigned long *flags)
698 {
699 #if AHC_SCSI_HAS_HOST_LOCK == 0
700         spin_unlock_irqrestore(&io_request_lock, *flags);
701 #endif
702 }
703
704 static __inline void
705 ahc_list_lockinit(void)
706 {
707         spin_lock_init(&ahc_list_spinlock);
708 }
709
710 static __inline void
711 ahc_list_lock(unsigned long *flags)
712 {
713         spin_lock_irqsave(&ahc_list_spinlock, *flags);
714 }
715
716 static __inline void
717 ahc_list_unlock(unsigned long *flags)
718 {
719         spin_unlock_irqrestore(&ahc_list_spinlock, *flags);
720 }
721
722 /******************************* PCI Definitions ******************************/
723 /*
724  * PCIM_xxx: mask to locate subfield in register
725  * PCIR_xxx: config register offset
726  * PCIC_xxx: device class
727  * PCIS_xxx: device subclass
728  * PCIP_xxx: device programming interface
729  * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
730  * PCID_xxx: device ID
731  */
732 #define PCIR_DEVVENDOR          0x00
733 #define PCIR_VENDOR             0x00
734 #define PCIR_DEVICE             0x02
735 #define PCIR_COMMAND            0x04
736 #define PCIM_CMD_PORTEN         0x0001
737 #define PCIM_CMD_MEMEN          0x0002
738 #define PCIM_CMD_BUSMASTEREN    0x0004
739 #define PCIM_CMD_MWRICEN        0x0010
740 #define PCIM_CMD_PERRESPEN      0x0040
741 #define PCIM_CMD_SERRESPEN      0x0100
742 #define PCIR_STATUS             0x06
743 #define PCIR_REVID              0x08
744 #define PCIR_PROGIF             0x09
745 #define PCIR_SUBCLASS           0x0a
746 #define PCIR_CLASS              0x0b
747 #define PCIR_CACHELNSZ          0x0c
748 #define PCIR_LATTIMER           0x0d
749 #define PCIR_HEADERTYPE         0x0e
750 #define PCIM_MFDEV              0x80
751 #define PCIR_BIST               0x0f
752 #define PCIR_CAP_PTR            0x34
753
754 /* config registers for header type 0 devices */
755 #define PCIR_MAPS       0x10
756 #define PCIR_SUBVEND_0  0x2c
757 #define PCIR_SUBDEV_0   0x2e
758
759 extern struct pci_driver aic7xxx_pci_driver;
760
761 typedef enum
762 {
763         AHC_POWER_STATE_D0,
764         AHC_POWER_STATE_D1,
765         AHC_POWER_STATE_D2,
766         AHC_POWER_STATE_D3
767 } ahc_power_state;
768
769 /**************************** VL/EISA Routines ********************************/
770 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0) \
771   && (defined(__i386__) || defined(__alpha__)) \
772   && (!defined(CONFIG_EISA)))
773 #define CONFIG_EISA
774 #endif
775
776 #ifdef CONFIG_EISA
777 extern uint32_t aic7xxx_probe_eisa_vl;
778 int                      ahc_linux_eisa_init(void);
779 void                     ahc_linux_eisa_exit(void);
780 int                      aic7770_map_registers(struct ahc_softc *ahc,
781                                                u_int port);
782 int                      aic7770_map_int(struct ahc_softc *ahc, u_int irq);
783 #else
784 static inline int       ahc_linux_eisa_init(void) {
785         return -ENODEV;
786 }
787 static inline void      ahc_linux_eisa_exit(void) {
788 }
789 #endif
790
791 /******************************* PCI Routines *********************************/
792 #ifdef CONFIG_PCI
793 int                      ahc_linux_pci_init(void);
794 void                     ahc_linux_pci_exit(void);
795 int                      ahc_pci_map_registers(struct ahc_softc *ahc);
796 int                      ahc_pci_map_int(struct ahc_softc *ahc);
797
798 static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
799                                              int reg, int width);
800
801 static __inline uint32_t
802 ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width)
803 {
804         switch (width) {
805         case 1:
806         {
807                 uint8_t retval;
808
809                 pci_read_config_byte(pci, reg, &retval);
810                 return (retval);
811         }
812         case 2:
813         {
814                 uint16_t retval;
815                 pci_read_config_word(pci, reg, &retval);
816                 return (retval);
817         }
818         case 4:
819         {
820                 uint32_t retval;
821                 pci_read_config_dword(pci, reg, &retval);
822                 return (retval);
823         }
824         default:
825                 panic("ahc_pci_read_config: Read size too big");
826                 /* NOTREACHED */
827                 return (0);
828         }
829 }
830
831 static __inline void ahc_pci_write_config(ahc_dev_softc_t pci,
832                                           int reg, uint32_t value,
833                                           int width);
834
835 static __inline void
836 ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width)
837 {
838         switch (width) {
839         case 1:
840                 pci_write_config_byte(pci, reg, value);
841                 break;
842         case 2:
843                 pci_write_config_word(pci, reg, value);
844                 break;
845         case 4:
846                 pci_write_config_dword(pci, reg, value);
847                 break;
848         default:
849                 panic("ahc_pci_write_config: Write size too big");
850                 /* NOTREACHED */
851         }
852 }
853
854 static __inline int ahc_get_pci_function(ahc_dev_softc_t);
855 static __inline int
856 ahc_get_pci_function(ahc_dev_softc_t pci)
857 {
858         return (PCI_FUNC(pci->devfn));
859 }
860
861 static __inline int ahc_get_pci_slot(ahc_dev_softc_t);
862 static __inline int
863 ahc_get_pci_slot(ahc_dev_softc_t pci)
864 {
865         return (PCI_SLOT(pci->devfn));
866 }
867
868 static __inline int ahc_get_pci_bus(ahc_dev_softc_t);
869 static __inline int
870 ahc_get_pci_bus(ahc_dev_softc_t pci)
871 {
872         return (pci->bus->number);
873 }
874 #else
875 static inline int ahc_linux_pci_init(void) {
876         return 0;
877 }
878 static inline void ahc_linux_pci_exit(void) {
879 }
880 #endif
881
882 static __inline void ahc_flush_device_writes(struct ahc_softc *);
883 static __inline void
884 ahc_flush_device_writes(struct ahc_softc *ahc)
885 {
886         /* XXX Is this sufficient for all architectures??? */
887         ahc_inb(ahc, INTSTAT);
888 }
889
890 /**************************** Proc FS Support *********************************/
891 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)
892 int     ahc_linux_proc_info(char *, char **, off_t, int, int, int);
893 #else
894 int     ahc_linux_proc_info(struct Scsi_Host *, char *, char **,
895                             off_t, int, int);
896 #endif
897
898 /*************************** Domain Validation ********************************/
899 /*********************** Transaction Access Wrappers *************************/
900 static __inline void ahc_cmd_set_transaction_status(Scsi_Cmnd *, uint32_t);
901 static __inline void ahc_set_transaction_status(struct scb *, uint32_t);
902 static __inline void ahc_cmd_set_scsi_status(Scsi_Cmnd *, uint32_t);
903 static __inline void ahc_set_scsi_status(struct scb *, uint32_t);
904 static __inline uint32_t ahc_cmd_get_transaction_status(Scsi_Cmnd *cmd);
905 static __inline uint32_t ahc_get_transaction_status(struct scb *);
906 static __inline uint32_t ahc_cmd_get_scsi_status(Scsi_Cmnd *cmd);
907 static __inline uint32_t ahc_get_scsi_status(struct scb *);
908 static __inline void ahc_set_transaction_tag(struct scb *, int, u_int);
909 static __inline u_long ahc_get_transfer_length(struct scb *);
910 static __inline int ahc_get_transfer_dir(struct scb *);
911 static __inline void ahc_set_residual(struct scb *, u_long);
912 static __inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
913 static __inline u_long ahc_get_residual(struct scb *);
914 static __inline u_long ahc_get_sense_residual(struct scb *);
915 static __inline int ahc_perform_autosense(struct scb *);
916 static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
917                                                struct scb *);
918 static __inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
919                                                      struct ahc_devinfo *);
920 static __inline void ahc_platform_scb_free(struct ahc_softc *ahc,
921                                            struct scb *scb);
922 static __inline void ahc_freeze_scb(struct scb *scb);
923
924 static __inline
925 void ahc_cmd_set_transaction_status(Scsi_Cmnd *cmd, uint32_t status)
926 {
927         cmd->result &= ~(CAM_STATUS_MASK << 16);
928         cmd->result |= status << 16;
929 }
930
931 static __inline
932 void ahc_set_transaction_status(struct scb *scb, uint32_t status)
933 {
934         ahc_cmd_set_transaction_status(scb->io_ctx,status);
935 }
936
937 static __inline
938 void ahc_cmd_set_scsi_status(Scsi_Cmnd *cmd, uint32_t status)
939 {
940         cmd->result &= ~0xFFFF;
941         cmd->result |= status;
942 }
943
944 static __inline
945 void ahc_set_scsi_status(struct scb *scb, uint32_t status)
946 {
947         ahc_cmd_set_scsi_status(scb->io_ctx, status);
948 }
949
950 static __inline
951 uint32_t ahc_cmd_get_transaction_status(Scsi_Cmnd *cmd)
952 {
953         return ((cmd->result >> 16) & CAM_STATUS_MASK);
954 }
955
956 static __inline
957 uint32_t ahc_get_transaction_status(struct scb *scb)
958 {
959         return (ahc_cmd_get_transaction_status(scb->io_ctx));
960 }
961
962 static __inline
963 uint32_t ahc_cmd_get_scsi_status(Scsi_Cmnd *cmd)
964 {
965         return (cmd->result & 0xFFFF);
966 }
967
968 static __inline
969 uint32_t ahc_get_scsi_status(struct scb *scb)
970 {
971         return (ahc_cmd_get_scsi_status(scb->io_ctx));
972 }
973
974 static __inline
975 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
976 {
977         /*
978          * Nothing to do for linux as the incoming transaction
979          * has no concept of tag/non tagged, etc.
980          */
981 }
982
983 static __inline
984 u_long ahc_get_transfer_length(struct scb *scb)
985 {
986         return (scb->platform_data->xfer_len);
987 }
988
989 static __inline
990 int ahc_get_transfer_dir(struct scb *scb)
991 {
992         return (scb->io_ctx->sc_data_direction);
993 }
994
995 static __inline
996 void ahc_set_residual(struct scb *scb, u_long resid)
997 {
998         scb->io_ctx->resid = resid;
999 }
1000
1001 static __inline
1002 void ahc_set_sense_residual(struct scb *scb, u_long resid)
1003 {
1004         scb->platform_data->sense_resid = resid;
1005 }
1006
1007 static __inline
1008 u_long ahc_get_residual(struct scb *scb)
1009 {
1010         return (scb->io_ctx->resid);
1011 }
1012
1013 static __inline
1014 u_long ahc_get_sense_residual(struct scb *scb)
1015 {
1016         return (scb->platform_data->sense_resid);
1017 }
1018
1019 static __inline
1020 int ahc_perform_autosense(struct scb *scb)
1021 {
1022         /*
1023          * We always perform autosense in Linux.
1024          * On other platforms this is set on a
1025          * per-transaction basis.
1026          */
1027         return (1);
1028 }
1029
1030 static __inline uint32_t
1031 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
1032 {
1033         return (sizeof(struct scsi_sense_data));
1034 }
1035
1036 static __inline void
1037 ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
1038                                 struct ahc_devinfo *devinfo)
1039 {
1040         /* Nothing to do here for linux */
1041 }
1042
1043 static __inline void
1044 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
1045 {
1046         ahc->flags &= ~AHC_RESOURCE_SHORTAGE;
1047 }
1048
1049 int     ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
1050 void    ahc_platform_free(struct ahc_softc *ahc);
1051 void    ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
1052
1053 static __inline void
1054 ahc_freeze_scb(struct scb *scb)
1055 {
1056         if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
1057                 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
1058                 scb->platform_data->dev->qfrozen++;
1059         }
1060 }
1061
1062 void    ahc_platform_set_tags(struct ahc_softc *ahc,
1063                               struct ahc_devinfo *devinfo, ahc_queue_alg);
1064 int     ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
1065                                 char channel, int lun, u_int tag,
1066                                 role_t role, uint32_t status);
1067 irqreturn_t
1068         ahc_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
1069 void    ahc_platform_flushwork(struct ahc_softc *ahc);
1070 int     ahc_softc_comp(struct ahc_softc *, struct ahc_softc *);
1071 void    ahc_done(struct ahc_softc*, struct scb*);
1072 void    ahc_send_async(struct ahc_softc *, char channel,
1073                        u_int target, u_int lun, ac_code, void *);
1074 void    ahc_print_path(struct ahc_softc *, struct scb *);
1075 void    ahc_platform_dump_card_state(struct ahc_softc *ahc);
1076
1077 #ifdef CONFIG_PCI
1078 #define AHC_PCI_CONFIG 1
1079 #else
1080 #define AHC_PCI_CONFIG 0
1081 #endif
1082 #define bootverbose aic7xxx_verbose
1083 extern u_int aic7xxx_verbose;
1084 #endif /* _AIC7XXX_LINUX_H_ */