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