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