blob: e70c1fa47db2ef954adc25d6b40730f39b6bee98 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Christoph Hellwig 013791e2005-05-16 18:52:39 +020062#include <linux/config.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#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>
James Bottomley e4e360c2005-05-16 16:39:38 -050070#include <linux/interrupt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#include <linux/module.h>
Christoph Hellwig 013791e2005-05-16 18:52:39 +020072#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#include <asm/byteorder.h>
74#include <asm/io.h>
75
Christoph Hellwig 013791e2005-05-16 18:52:39 +020076#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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/* Core SCSI definitions */
84#define AIC_LIB_PREFIX ahc
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
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 *******************************/
111struct ahc_softc;
112typedef struct pci_dev *ahc_dev_softc_t;
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200113typedef struct scsi_cmnd *ahc_io_ctx_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
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 *********************************/
148extern u_int aic7xxx_no_probe;
149extern u_int aic7xxx_allow_memio;
150extern int aic7xxx_detect_complete;
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200151extern struct scsi_host_template aic7xxx_driver_template;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
153/***************************** Bus Space/DMA **********************************/
154
155typedef uint32_t bus_size_t;
156
157typedef enum {
158 BUS_SPACE_MEMIO,
159 BUS_SPACE_PIO
160} bus_space_tag_t;
161
162typedef union {
163 u_long ioport;
164 volatile uint8_t __iomem *maddr;
165} bus_space_handle_t;
166
167typedef struct bus_dma_segment
168{
169 dma_addr_t ds_addr;
170 bus_size_t ds_len;
171} bus_dma_segment_t;
172
173struct ahc_linux_dma_tag
174{
175 bus_size_t alignment;
176 bus_size_t boundary;
177 bus_size_t maxsize;
178};
179typedef struct ahc_linux_dma_tag* bus_dma_tag_t;
180
Christoph Hellwig 7dfa0f22005-05-16 18:54:12 +0200181typedef dma_addr_t bus_dmamap_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183typedef int bus_dma_filter_t(void*, dma_addr_t);
184typedef 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
198int 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
206void ahc_dma_tag_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/);
207
208int ahc_dmamem_alloc(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
209 void** /*vaddr*/, int /*flags*/,
210 bus_dmamap_t* /*mapp*/);
211
212void ahc_dmamem_free(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
213 void* /*vaddr*/, bus_dmamap_t /*map*/);
214
215void ahc_dmamap_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/,
216 bus_dmamap_t /*map*/);
217
218int 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
223int 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 ******************************/
244typedef 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
257typedef void ahc_linux_callback_t (u_long);
258static __inline void ahc_timer_reset(ahc_timer_t *timer, int usec,
259 ahc_callback_t *func, void *arg);
260static __inline void ahc_scb_timer_reset(struct scb *scb, u_int usec);
261
262static __inline void
263ahc_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
275static __inline void
276ahc_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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#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 */
293struct 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
304struct 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 */
323TAILQ_HEAD(ahc_busyq, ahc_cmd);
324typedef enum {
325 AHC_DEV_UNCONFIGURED = 0x01,
326 AHC_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
327 AHC_DEV_TIMER_ACTIVE = 0x04, /* Our timer is active */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 AHC_DEV_Q_BASIC = 0x10, /* Allow basic device queuing */
329 AHC_DEV_Q_TAGGED = 0x20, /* Allow full SCSI2 command queueing */
330 AHC_DEV_PERIODIC_OTAG = 0x40, /* Send OTAG to prevent starvation */
331 AHC_DEV_SLAVE_CONFIGURED = 0x80 /* slave_configure() has been called */
332} ahc_linux_dev_flags;
333
334struct ahc_linux_target;
335struct ahc_linux_device {
336 TAILQ_ENTRY(ahc_linux_device) links;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 /*
339 * The number of transactions currently
340 * queued to the device.
341 */
342 int active;
343
344 /*
345 * The currently allowed number of
346 * transactions that can be queued to
347 * the device. Must be signed for
348 * conversion from tagged to untagged
349 * mode where the device may have more
350 * than one outstanding active transaction.
351 */
352 int openings;
353
354 /*
355 * A positive count indicates that this
356 * device's queue is halted.
357 */
358 u_int qfrozen;
359
360 /*
361 * Cumulative command counter.
362 */
363 u_long commands_issued;
364
365 /*
366 * The number of tagged transactions when
367 * running at our current opening level
368 * that have been successfully received by
369 * this device since the last QUEUE FULL.
370 */
371 u_int tag_success_count;
372#define AHC_TAG_SUCCESS_INTERVAL 50
373
374 ahc_linux_dev_flags flags;
375
376 /*
377 * Per device timer.
378 */
379 struct timer_list timer;
380
381 /*
382 * The high limit for the tags variable.
383 */
384 u_int maxtags;
385
386 /*
387 * The computed number of tags outstanding
388 * at the time of the last QUEUE FULL event.
389 */
390 u_int tags_on_last_queuefull;
391
392 /*
393 * How many times we have seen a queue full
394 * with the same number of tags. This is used
395 * to stop our adaptive queue depth algorithm
396 * on devices with a fixed number of tags.
397 */
398 u_int last_queuefull_same_count;
399#define AHC_LOCK_TAGS_COUNT 50
400
401 /*
402 * How many transactions have been queued
403 * without the device going idle. We use
404 * this statistic to determine when to issue
405 * an ordered tag to prevent transaction
406 * starvation. This statistic is only updated
407 * if the AHC_DEV_PERIODIC_OTAG flag is set
408 * on this device.
409 */
410 u_int commands_since_idle_or_otag;
411#define AHC_OTAG_THRESH 500
412
413 int lun;
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200414 struct scsi_device *scsi_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 struct ahc_linux_target *target;
416};
417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418struct ahc_linux_target {
419 struct ahc_linux_device *devices[AHC_NUM_LUNS];
420 int channel;
421 int target;
422 int refcount;
423 struct ahc_transinfo last_tinfo;
424 struct ahc_softc *ahc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426
427/********************* Definitions Required by the Core ***********************/
428/*
429 * Number of SG segments we require. So long as the S/G segments for
430 * a particular transaction are allocated in a physically contiguous
431 * manner and are allocated below 4GB, the number of S/G segments is
432 * unrestricted.
433 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434#define AHC_NSEG 128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
436/*
437 * Per-SCB OSM storage.
438 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439struct scb_platform_data {
440 struct ahc_linux_device *dev;
441 dma_addr_t buf_busaddr;
442 uint32_t xfer_len;
443 uint32_t sense_resid; /* Auto-Sense residual */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444};
445
446/*
447 * Define a structure used for each host adapter. All members are
448 * aligned on a boundary >= the size of the member to honor the
449 * alignment restrictions of the various platforms supported by
450 * this driver.
451 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452struct ahc_platform_data {
453 /*
454 * Fields accessed from interrupt context.
455 */
456 struct ahc_linux_target *targets[AHC_NUM_TARGETS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
458 spinlock_t spin_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 u_int qfrozen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 struct timer_list reset_timer;
461 struct semaphore eh_sem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 struct Scsi_Host *host; /* pointer to scsi host */
463#define AHC_LINUX_NOIRQ ((uint32_t)~0)
464 uint32_t irq; /* IRQ for this adapter */
465 uint32_t bios_address;
466 uint32_t mem_busaddr; /* Mem Base Addr */
James Bottomley 8e45ebc2005-05-17 00:06:08 -0500467
468#define AHC_UP_EH_SEMAPHORE 0x1
469 uint32_t flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470};
471
472/************************** OS Utility Wrappers *******************************/
473#define printf printk
474#define M_NOWAIT GFP_ATOMIC
475#define M_WAITOK 0
476#define malloc(size, type, flags) kmalloc(size, flags)
477#define free(ptr, type) kfree(ptr)
478
479static __inline void ahc_delay(long);
480static __inline void
481ahc_delay(long usec)
482{
483 /*
484 * udelay on Linux can have problems for
485 * multi-millisecond waits. Wait at most
486 * 1024us per call.
487 */
488 while (usec > 0) {
489 udelay(usec % 1024);
490 usec -= 1024;
491 }
492}
493
494
495/***************************** Low Level I/O **********************************/
496static __inline uint8_t ahc_inb(struct ahc_softc * ahc, long port);
497static __inline void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
498static __inline void ahc_outsb(struct ahc_softc * ahc, long port,
499 uint8_t *, int count);
500static __inline void ahc_insb(struct ahc_softc * ahc, long port,
501 uint8_t *, int count);
502
503static __inline uint8_t
504ahc_inb(struct ahc_softc * ahc, long port)
505{
506 uint8_t x;
507
508 if (ahc->tag == BUS_SPACE_MEMIO) {
509 x = readb(ahc->bsh.maddr + port);
510 } else {
511 x = inb(ahc->bsh.ioport + port);
512 }
513 mb();
514 return (x);
515}
516
517static __inline void
518ahc_outb(struct ahc_softc * ahc, long port, uint8_t val)
519{
520 if (ahc->tag == BUS_SPACE_MEMIO) {
521 writeb(val, ahc->bsh.maddr + port);
522 } else {
523 outb(val, ahc->bsh.ioport + port);
524 }
525 mb();
526}
527
528static __inline void
529ahc_outsb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
530{
531 int i;
532
533 /*
534 * There is probably a more efficient way to do this on Linux
535 * but we don't use this for anything speed critical and this
536 * should work.
537 */
538 for (i = 0; i < count; i++)
539 ahc_outb(ahc, port, *array++);
540}
541
542static __inline void
543ahc_insb(struct ahc_softc * ahc, long port, uint8_t *array, int count)
544{
545 int i;
546
547 /*
548 * There is probably a more efficient way to do this on Linux
549 * but we don't use this for anything speed critical and this
550 * should work.
551 */
552 for (i = 0; i < count; i++)
553 *array++ = ahc_inb(ahc, port);
554}
555
556/**************************** Initialization **********************************/
557int ahc_linux_register_host(struct ahc_softc *,
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200558 struct scsi_host_template *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
560uint64_t ahc_linux_get_memsize(void);
561
562/*************************** Pretty Printing **********************************/
563struct info_str {
564 char *buffer;
565 int length;
566 off_t offset;
567 int pos;
568};
569
570void ahc_format_transinfo(struct info_str *info,
571 struct ahc_transinfo *tinfo);
572
573/******************************** Locking *************************************/
574/* Lock protecting internal data structures */
575static __inline void ahc_lockinit(struct ahc_softc *);
576static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags);
577static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags);
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579/* Lock held during ahc_list manipulation and ahc softc frees */
580extern spinlock_t ahc_list_spinlock;
581static __inline void ahc_list_lockinit(void);
582static __inline void ahc_list_lock(unsigned long *flags);
583static __inline void ahc_list_unlock(unsigned long *flags);
584
585static __inline void
586ahc_lockinit(struct ahc_softc *ahc)
587{
588 spin_lock_init(&ahc->platform_data->spin_lock);
589}
590
591static __inline void
592ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
593{
594 spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
595}
596
597static __inline void
598ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
599{
600 spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
601}
602
603static __inline void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604ahc_list_lockinit(void)
605{
606 spin_lock_init(&ahc_list_spinlock);
607}
608
609static __inline void
610ahc_list_lock(unsigned long *flags)
611{
612 spin_lock_irqsave(&ahc_list_spinlock, *flags);
613}
614
615static __inline void
616ahc_list_unlock(unsigned long *flags)
617{
618 spin_unlock_irqrestore(&ahc_list_spinlock, *flags);
619}
620
621/******************************* PCI Definitions ******************************/
622/*
623 * PCIM_xxx: mask to locate subfield in register
624 * PCIR_xxx: config register offset
625 * PCIC_xxx: device class
626 * PCIS_xxx: device subclass
627 * PCIP_xxx: device programming interface
628 * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
629 * PCID_xxx: device ID
630 */
631#define PCIR_DEVVENDOR 0x00
632#define PCIR_VENDOR 0x00
633#define PCIR_DEVICE 0x02
634#define PCIR_COMMAND 0x04
635#define PCIM_CMD_PORTEN 0x0001
636#define PCIM_CMD_MEMEN 0x0002
637#define PCIM_CMD_BUSMASTEREN 0x0004
638#define PCIM_CMD_MWRICEN 0x0010
639#define PCIM_CMD_PERRESPEN 0x0040
640#define PCIM_CMD_SERRESPEN 0x0100
641#define PCIR_STATUS 0x06
642#define PCIR_REVID 0x08
643#define PCIR_PROGIF 0x09
644#define PCIR_SUBCLASS 0x0a
645#define PCIR_CLASS 0x0b
646#define PCIR_CACHELNSZ 0x0c
647#define PCIR_LATTIMER 0x0d
648#define PCIR_HEADERTYPE 0x0e
649#define PCIM_MFDEV 0x80
650#define PCIR_BIST 0x0f
651#define PCIR_CAP_PTR 0x34
652
653/* config registers for header type 0 devices */
654#define PCIR_MAPS 0x10
655#define PCIR_SUBVEND_0 0x2c
656#define PCIR_SUBDEV_0 0x2e
657
658extern struct pci_driver aic7xxx_pci_driver;
659
660typedef enum
661{
662 AHC_POWER_STATE_D0,
663 AHC_POWER_STATE_D1,
664 AHC_POWER_STATE_D2,
665 AHC_POWER_STATE_D3
666} ahc_power_state;
667
668/**************************** VL/EISA Routines ********************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669#ifdef CONFIG_EISA
670extern uint32_t aic7xxx_probe_eisa_vl;
671int ahc_linux_eisa_init(void);
672void ahc_linux_eisa_exit(void);
673int aic7770_map_registers(struct ahc_softc *ahc,
674 u_int port);
675int aic7770_map_int(struct ahc_softc *ahc, u_int irq);
676#else
677static inline int ahc_linux_eisa_init(void) {
678 return -ENODEV;
679}
680static inline void ahc_linux_eisa_exit(void) {
681}
682#endif
683
684/******************************* PCI Routines *********************************/
685#ifdef CONFIG_PCI
686int ahc_linux_pci_init(void);
687void ahc_linux_pci_exit(void);
688int ahc_pci_map_registers(struct ahc_softc *ahc);
689int ahc_pci_map_int(struct ahc_softc *ahc);
690
691static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
692 int reg, int width);
693
694static __inline uint32_t
695ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width)
696{
697 switch (width) {
698 case 1:
699 {
700 uint8_t retval;
701
702 pci_read_config_byte(pci, reg, &retval);
703 return (retval);
704 }
705 case 2:
706 {
707 uint16_t retval;
708 pci_read_config_word(pci, reg, &retval);
709 return (retval);
710 }
711 case 4:
712 {
713 uint32_t retval;
714 pci_read_config_dword(pci, reg, &retval);
715 return (retval);
716 }
717 default:
718 panic("ahc_pci_read_config: Read size too big");
719 /* NOTREACHED */
720 return (0);
721 }
722}
723
724static __inline void ahc_pci_write_config(ahc_dev_softc_t pci,
725 int reg, uint32_t value,
726 int width);
727
728static __inline void
729ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width)
730{
731 switch (width) {
732 case 1:
733 pci_write_config_byte(pci, reg, value);
734 break;
735 case 2:
736 pci_write_config_word(pci, reg, value);
737 break;
738 case 4:
739 pci_write_config_dword(pci, reg, value);
740 break;
741 default:
742 panic("ahc_pci_write_config: Write size too big");
743 /* NOTREACHED */
744 }
745}
746
747static __inline int ahc_get_pci_function(ahc_dev_softc_t);
748static __inline int
749ahc_get_pci_function(ahc_dev_softc_t pci)
750{
751 return (PCI_FUNC(pci->devfn));
752}
753
754static __inline int ahc_get_pci_slot(ahc_dev_softc_t);
755static __inline int
756ahc_get_pci_slot(ahc_dev_softc_t pci)
757{
758 return (PCI_SLOT(pci->devfn));
759}
760
761static __inline int ahc_get_pci_bus(ahc_dev_softc_t);
762static __inline int
763ahc_get_pci_bus(ahc_dev_softc_t pci)
764{
765 return (pci->bus->number);
766}
767#else
768static inline int ahc_linux_pci_init(void) {
769 return 0;
770}
771static inline void ahc_linux_pci_exit(void) {
772}
773#endif
774
775static __inline void ahc_flush_device_writes(struct ahc_softc *);
776static __inline void
777ahc_flush_device_writes(struct ahc_softc *ahc)
778{
779 /* XXX Is this sufficient for all architectures??? */
780 ahc_inb(ahc, INTSTAT);
781}
782
783/**************************** Proc FS Support *********************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784int ahc_linux_proc_info(struct Scsi_Host *, char *, char **,
785 off_t, int, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
787/*************************** Domain Validation ********************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788/*********************** Transaction Access Wrappers *************************/
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200789static __inline void ahc_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790static __inline void ahc_set_transaction_status(struct scb *, uint32_t);
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200791static __inline void ahc_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792static __inline void ahc_set_scsi_status(struct scb *, uint32_t);
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200793static __inline uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794static __inline uint32_t ahc_get_transaction_status(struct scb *);
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200795static __inline uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796static __inline uint32_t ahc_get_scsi_status(struct scb *);
797static __inline void ahc_set_transaction_tag(struct scb *, int, u_int);
798static __inline u_long ahc_get_transfer_length(struct scb *);
799static __inline int ahc_get_transfer_dir(struct scb *);
800static __inline void ahc_set_residual(struct scb *, u_long);
801static __inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
802static __inline u_long ahc_get_residual(struct scb *);
803static __inline u_long ahc_get_sense_residual(struct scb *);
804static __inline int ahc_perform_autosense(struct scb *);
805static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
806 struct scb *);
807static __inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
808 struct ahc_devinfo *);
809static __inline void ahc_platform_scb_free(struct ahc_softc *ahc,
810 struct scb *scb);
811static __inline void ahc_freeze_scb(struct scb *scb);
812
813static __inline
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200814void ahc_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815{
816 cmd->result &= ~(CAM_STATUS_MASK << 16);
817 cmd->result |= status << 16;
818}
819
820static __inline
821void ahc_set_transaction_status(struct scb *scb, uint32_t status)
822{
823 ahc_cmd_set_transaction_status(scb->io_ctx,status);
824}
825
826static __inline
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200827void ahc_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
829 cmd->result &= ~0xFFFF;
830 cmd->result |= status;
831}
832
833static __inline
834void ahc_set_scsi_status(struct scb *scb, uint32_t status)
835{
836 ahc_cmd_set_scsi_status(scb->io_ctx, status);
837}
838
839static __inline
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200840uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
842 return ((cmd->result >> 16) & CAM_STATUS_MASK);
843}
844
845static __inline
846uint32_t ahc_get_transaction_status(struct scb *scb)
847{
848 return (ahc_cmd_get_transaction_status(scb->io_ctx));
849}
850
851static __inline
Christoph Hellwig 013791e2005-05-16 18:52:39 +0200852uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853{
854 return (cmd->result & 0xFFFF);
855}
856
857static __inline
858uint32_t ahc_get_scsi_status(struct scb *scb)
859{
860 return (ahc_cmd_get_scsi_status(scb->io_ctx));
861}
862
863static __inline
864void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
865{
866 /*
867 * Nothing to do for linux as the incoming transaction
868 * has no concept of tag/non tagged, etc.
869 */
870}
871
872static __inline
873u_long ahc_get_transfer_length(struct scb *scb)
874{
875 return (scb->platform_data->xfer_len);
876}
877
878static __inline
879int ahc_get_transfer_dir(struct scb *scb)
880{
881 return (scb->io_ctx->sc_data_direction);
882}
883
884static __inline
885void ahc_set_residual(struct scb *scb, u_long resid)
886{
887 scb->io_ctx->resid = resid;
888}
889
890static __inline
891void ahc_set_sense_residual(struct scb *scb, u_long resid)
892{
893 scb->platform_data->sense_resid = resid;
894}
895
896static __inline
897u_long ahc_get_residual(struct scb *scb)
898{
899 return (scb->io_ctx->resid);
900}
901
902static __inline
903u_long ahc_get_sense_residual(struct scb *scb)
904{
905 return (scb->platform_data->sense_resid);
906}
907
908static __inline
909int ahc_perform_autosense(struct scb *scb)
910{
911 /*
912 * We always perform autosense in Linux.
913 * On other platforms this is set on a
914 * per-transaction basis.
915 */
916 return (1);
917}
918
919static __inline uint32_t
920ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
921{
922 return (sizeof(struct scsi_sense_data));
923}
924
925static __inline void
926ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
927 struct ahc_devinfo *devinfo)
928{
929 /* Nothing to do here for linux */
930}
931
932static __inline void
933ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
934{
935 ahc->flags &= ~AHC_RESOURCE_SHORTAGE;
936}
937
938int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
939void ahc_platform_free(struct ahc_softc *ahc);
940void ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
941
942static __inline void
943ahc_freeze_scb(struct scb *scb)
944{
945 if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
946 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
947 scb->platform_data->dev->qfrozen++;
948 }
949}
950
951void ahc_platform_set_tags(struct ahc_softc *ahc,
952 struct ahc_devinfo *devinfo, ahc_queue_alg);
953int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
954 char channel, int lun, u_int tag,
955 role_t role, uint32_t status);
956irqreturn_t
957 ahc_linux_isr(int irq, void *dev_id, struct pt_regs * regs);
958void ahc_platform_flushwork(struct ahc_softc *ahc);
959int ahc_softc_comp(struct ahc_softc *, struct ahc_softc *);
960void ahc_done(struct ahc_softc*, struct scb*);
961void ahc_send_async(struct ahc_softc *, char channel,
962 u_int target, u_int lun, ac_code, void *);
963void ahc_print_path(struct ahc_softc *, struct scb *);
964void ahc_platform_dump_card_state(struct ahc_softc *ahc);
965
966#ifdef CONFIG_PCI
967#define AHC_PCI_CONFIG 1
968#else
969#define AHC_PCI_CONFIG 0
970#endif
971#define bootverbose aic7xxx_verbose
972extern u_int aic7xxx_verbose;
973#endif /* _AIC7XXX_LINUX_H_ */