2 * Adaptec AIC7xxx device driver for Linux.
4 * Copyright (c) 1994 John Aycock
5 * The University of Calgary Department of Computer Science.
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)
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.
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.
21 * Copyright (c) 2000-2003 Adaptec Inc.
22 * All rights reserved.
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
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.
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.
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.
56 * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic7xxx_osm.h#151 $
59 #ifndef _AIC7XXX_LINUX_H_
60 #define _AIC7XXX_LINUX_H_
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/interrupt.h>
68 #include <linux/module.h>
69 #include <linux/slab.h>
70 #include <asm/byteorder.h>
73 #include <scsi/scsi.h>
74 #include <scsi/scsi_cmnd.h>
75 #include <scsi/scsi_eh.h>
76 #include <scsi/scsi_device.h>
77 #include <scsi/scsi_host.h>
78 #include <scsi/scsi_tcq.h>
79 #include <scsi/scsi_transport.h>
80 #include <scsi/scsi_transport_spi.h>
82 /* Core SCSI definitions */
83 #define AIC_LIB_PREFIX ahc
85 /* Name space conflict with BSD queue macros */
92 #include "scsi_message.h"
95 /*********************************** Debugging ********************************/
96 #ifdef CONFIG_AIC7XXX_DEBUG_ENABLE
97 #ifdef CONFIG_AIC7XXX_DEBUG_MASK
99 #define AHC_DEBUG_OPTS CONFIG_AIC7XXX_DEBUG_MASK
102 * Compile in debugging code, but do not enable any printfs.
106 /* No debugging code. */
109 /************************* Forward Declarations *******************************/
111 typedef struct pci_dev *ahc_dev_softc_t;
112 typedef struct scsi_cmnd *ahc_io_ctx_t;
114 /******************************* Byte Order ***********************************/
115 #define ahc_htobe16(x) cpu_to_be16(x)
116 #define ahc_htobe32(x) cpu_to_be32(x)
117 #define ahc_htobe64(x) cpu_to_be64(x)
118 #define ahc_htole16(x) cpu_to_le16(x)
119 #define ahc_htole32(x) cpu_to_le32(x)
120 #define ahc_htole64(x) cpu_to_le64(x)
122 #define ahc_be16toh(x) be16_to_cpu(x)
123 #define ahc_be32toh(x) be32_to_cpu(x)
124 #define ahc_be64toh(x) be64_to_cpu(x)
125 #define ahc_le16toh(x) le16_to_cpu(x)
126 #define ahc_le32toh(x) le32_to_cpu(x)
127 #define ahc_le64toh(x) le64_to_cpu(x)
129 /************************* Configuration Data *********************************/
130 extern u_int aic7xxx_no_probe;
131 extern u_int aic7xxx_allow_memio;
132 extern struct scsi_host_template aic7xxx_driver_template;
134 /***************************** Bus Space/DMA **********************************/
136 typedef uint32_t bus_size_t;
145 volatile uint8_t __iomem *maddr;
146 } bus_space_handle_t;
148 typedef struct bus_dma_segment
154 struct ahc_linux_dma_tag
156 bus_size_t alignment;
160 typedef struct ahc_linux_dma_tag* bus_dma_tag_t;
162 typedef dma_addr_t bus_dmamap_t;
164 typedef int bus_dma_filter_t(void*, dma_addr_t);
165 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
167 #define BUS_DMA_WAITOK 0x0
168 #define BUS_DMA_NOWAIT 0x1
169 #define BUS_DMA_ALLOCNOW 0x2
170 #define BUS_DMA_LOAD_SEGS 0x4 /*
171 * Argument is an S/G list not
175 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
176 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
177 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
179 int ahc_dma_tag_create(struct ahc_softc *, bus_dma_tag_t /*parent*/,
180 bus_size_t /*alignment*/, bus_size_t /*boundary*/,
181 dma_addr_t /*lowaddr*/, dma_addr_t /*highaddr*/,
182 bus_dma_filter_t*/*filter*/, void */*filterarg*/,
183 bus_size_t /*maxsize*/, int /*nsegments*/,
184 bus_size_t /*maxsegsz*/, int /*flags*/,
185 bus_dma_tag_t */*dma_tagp*/);
187 void ahc_dma_tag_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/);
189 int ahc_dmamem_alloc(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
190 void** /*vaddr*/, int /*flags*/,
191 bus_dmamap_t* /*mapp*/);
193 void ahc_dmamem_free(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
194 void* /*vaddr*/, bus_dmamap_t /*map*/);
196 void ahc_dmamap_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/,
197 bus_dmamap_t /*map*/);
199 int ahc_dmamap_load(struct ahc_softc *ahc, bus_dma_tag_t /*dmat*/,
200 bus_dmamap_t /*map*/, void * /*buf*/,
201 bus_size_t /*buflen*/, bus_dmamap_callback_t *,
202 void */*callback_arg*/, int /*flags*/);
204 int ahc_dmamap_unload(struct ahc_softc *, bus_dma_tag_t, bus_dmamap_t);
207 * Operations performed by ahc_dmamap_sync().
209 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */
210 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */
211 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */
212 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */
216 * ahc_dmamap_sync is only used on buffers allocated with
217 * the pci_alloc_consistent() API. Although I'm not sure how
218 * this works on architectures with a write buffer, Linux does
219 * not have an API to sync "coherent" memory. Perhaps we need
222 #define ahc_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op)
224 /********************************** Includes **********************************/
225 #ifdef CONFIG_AIC7XXX_REG_PRETTY_PRINT
226 #define AIC_DEBUG_REGISTERS 1
228 #define AIC_DEBUG_REGISTERS 0
232 /***************************** Timer Facilities *******************************/
234 ahc_scb_timer_reset(struct scb *scb, u_int usec)
238 /***************************** SMP support ************************************/
239 #include <linux/spinlock.h>
241 #define AIC7XXX_DRIVER_VERSION "7.0"
243 /*************************** Device Data Structures ***************************/
245 * A per probed device structure used to deal with some error recovery
246 * scenarios that the Linux mid-layer code just doesn't know how to
247 * handle. The structure allocated for a device only becomes persistent
248 * after a successfully completed inquiry command to the target when
249 * that inquiry data indicates a lun is present.
252 AHC_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
253 AHC_DEV_Q_BASIC = 0x10, /* Allow basic device queuing */
254 AHC_DEV_Q_TAGGED = 0x20, /* Allow full SCSI2 command queueing */
255 AHC_DEV_PERIODIC_OTAG = 0x40, /* Send OTAG to prevent starvation */
256 } ahc_linux_dev_flags;
258 struct ahc_linux_device {
260 * The number of transactions currently
261 * queued to the device.
266 * The currently allowed number of
267 * transactions that can be queued to
268 * the device. Must be signed for
269 * conversion from tagged to untagged
270 * mode where the device may have more
271 * than one outstanding active transaction.
276 * A positive count indicates that this
277 * device's queue is halted.
282 * Cumulative command counter.
284 u_long commands_issued;
287 * The number of tagged transactions when
288 * running at our current opening level
289 * that have been successfully received by
290 * this device since the last QUEUE FULL.
292 u_int tag_success_count;
293 #define AHC_TAG_SUCCESS_INTERVAL 50
295 ahc_linux_dev_flags flags;
298 * The high limit for the tags variable.
303 * The computed number of tags outstanding
304 * at the time of the last QUEUE FULL event.
306 u_int tags_on_last_queuefull;
309 * How many times we have seen a queue full
310 * with the same number of tags. This is used
311 * to stop our adaptive queue depth algorithm
312 * on devices with a fixed number of tags.
314 u_int last_queuefull_same_count;
315 #define AHC_LOCK_TAGS_COUNT 50
318 * How many transactions have been queued
319 * without the device going idle. We use
320 * this statistic to determine when to issue
321 * an ordered tag to prevent transaction
322 * starvation. This statistic is only updated
323 * if the AHC_DEV_PERIODIC_OTAG flag is set
326 u_int commands_since_idle_or_otag;
327 #define AHC_OTAG_THRESH 500
330 /********************* Definitions Required by the Core ***********************/
332 * Number of SG segments we require. So long as the S/G segments for
333 * a particular transaction are allocated in a physically contiguous
334 * manner and are allocated below 4GB, the number of S/G segments is
340 * Per-SCB OSM storage.
342 struct scb_platform_data {
343 struct ahc_linux_device *dev;
344 dma_addr_t buf_busaddr;
346 uint32_t sense_resid; /* Auto-Sense residual */
350 * Define a structure used for each host adapter. All members are
351 * aligned on a boundary >= the size of the member to honor the
352 * alignment restrictions of the various platforms supported by
355 struct ahc_platform_data {
357 * Fields accessed from interrupt context.
359 struct scsi_target *starget[AHC_NUM_TARGETS];
361 spinlock_t spin_lock;
363 struct completion *eh_done;
364 struct Scsi_Host *host; /* pointer to scsi host */
365 #define AHC_LINUX_NOIRQ ((uint32_t)~0)
366 uint32_t irq; /* IRQ for this adapter */
367 uint32_t bios_address;
368 resource_size_t mem_busaddr; /* Mem Base Addr */
371 /************************** OS Utility Wrappers *******************************/
372 #define printf printk
373 #define M_NOWAIT GFP_ATOMIC
375 #define malloc(size, type, flags) kmalloc(size, flags)
376 #define free(ptr, type) kfree(ptr)
378 void ahc_delay(long);
381 /***************************** Low Level I/O **********************************/
382 uint8_t ahc_inb(struct ahc_softc * ahc, long port);
383 void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
384 void ahc_outsb(struct ahc_softc * ahc, long port,
385 uint8_t *, int count);
386 void ahc_insb(struct ahc_softc * ahc, long port,
387 uint8_t *, int count);
389 /**************************** Initialization **********************************/
390 int ahc_linux_register_host(struct ahc_softc *,
391 struct scsi_host_template *);
393 /*************************** Pretty Printing **********************************/
401 /******************************** Locking *************************************/
402 /* Lock protecting internal data structures */
405 ahc_lockinit(struct ahc_softc *ahc)
407 spin_lock_init(&ahc->platform_data->spin_lock);
411 ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
413 spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
417 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
419 spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
422 /******************************* PCI Definitions ******************************/
424 * PCIM_xxx: mask to locate subfield in register
425 * PCIR_xxx: config register offset
426 * PCIC_xxx: device class
427 * PCIS_xxx: device subclass
428 * PCIP_xxx: device programming interface
429 * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
430 * PCID_xxx: device ID
432 #define PCIR_DEVVENDOR 0x00
433 #define PCIR_VENDOR 0x00
434 #define PCIR_DEVICE 0x02
435 #define PCIR_COMMAND 0x04
436 #define PCIM_CMD_PORTEN 0x0001
437 #define PCIM_CMD_MEMEN 0x0002
438 #define PCIM_CMD_BUSMASTEREN 0x0004
439 #define PCIM_CMD_MWRICEN 0x0010
440 #define PCIM_CMD_PERRESPEN 0x0040
441 #define PCIM_CMD_SERRESPEN 0x0100
442 #define PCIR_STATUS 0x06
443 #define PCIR_REVID 0x08
444 #define PCIR_PROGIF 0x09
445 #define PCIR_SUBCLASS 0x0a
446 #define PCIR_CLASS 0x0b
447 #define PCIR_CACHELNSZ 0x0c
448 #define PCIR_LATTIMER 0x0d
449 #define PCIR_HEADERTYPE 0x0e
450 #define PCIM_MFDEV 0x80
451 #define PCIR_BIST 0x0f
452 #define PCIR_CAP_PTR 0x34
454 /* config registers for header type 0 devices */
455 #define PCIR_MAPS 0x10
456 #define PCIR_SUBVEND_0 0x2c
457 #define PCIR_SUBDEV_0 0x2e
467 /**************************** VL/EISA Routines ********************************/
469 int ahc_linux_eisa_init(void);
470 void ahc_linux_eisa_exit(void);
471 int aic7770_map_registers(struct ahc_softc *ahc,
473 int aic7770_map_int(struct ahc_softc *ahc, u_int irq);
475 static inline int ahc_linux_eisa_init(void) {
478 static inline void ahc_linux_eisa_exit(void) {
482 /******************************* PCI Routines *********************************/
484 int ahc_linux_pci_init(void);
485 void ahc_linux_pci_exit(void);
486 int ahc_pci_map_registers(struct ahc_softc *ahc);
487 int ahc_pci_map_int(struct ahc_softc *ahc);
489 uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
492 void ahc_pci_write_config(ahc_dev_softc_t pci,
493 int reg, uint32_t value,
496 static inline int ahc_get_pci_function(ahc_dev_softc_t);
498 ahc_get_pci_function(ahc_dev_softc_t pci)
500 return (PCI_FUNC(pci->devfn));
503 static inline int ahc_get_pci_slot(ahc_dev_softc_t);
505 ahc_get_pci_slot(ahc_dev_softc_t pci)
507 return (PCI_SLOT(pci->devfn));
510 static inline int ahc_get_pci_bus(ahc_dev_softc_t);
512 ahc_get_pci_bus(ahc_dev_softc_t pci)
514 return (pci->bus->number);
517 static inline int ahc_linux_pci_init(void) {
520 static inline void ahc_linux_pci_exit(void) {
524 static inline void ahc_flush_device_writes(struct ahc_softc *);
526 ahc_flush_device_writes(struct ahc_softc *ahc)
528 /* XXX Is this sufficient for all architectures??? */
529 ahc_inb(ahc, INTSTAT);
532 /**************************** Proc FS Support *********************************/
533 int ahc_linux_proc_info(struct Scsi_Host *, char *, char **,
536 /*************************** Domain Validation ********************************/
537 /*********************** Transaction Access Wrappers *************************/
538 static inline void ahc_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
539 static inline void ahc_set_transaction_status(struct scb *, uint32_t);
540 static inline void ahc_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
541 static inline void ahc_set_scsi_status(struct scb *, uint32_t);
542 static inline uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd);
543 static inline uint32_t ahc_get_transaction_status(struct scb *);
544 static inline uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd);
545 static inline uint32_t ahc_get_scsi_status(struct scb *);
546 static inline void ahc_set_transaction_tag(struct scb *, int, u_int);
547 static inline u_long ahc_get_transfer_length(struct scb *);
548 static inline int ahc_get_transfer_dir(struct scb *);
549 static inline void ahc_set_residual(struct scb *, u_long);
550 static inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
551 static inline u_long ahc_get_residual(struct scb *);
552 static inline u_long ahc_get_sense_residual(struct scb *);
553 static inline int ahc_perform_autosense(struct scb *);
554 static inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
556 static inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
557 struct ahc_devinfo *);
558 static inline void ahc_platform_scb_free(struct ahc_softc *ahc,
560 static inline void ahc_freeze_scb(struct scb *scb);
563 void ahc_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
565 cmd->result &= ~(CAM_STATUS_MASK << 16);
566 cmd->result |= status << 16;
570 void ahc_set_transaction_status(struct scb *scb, uint32_t status)
572 ahc_cmd_set_transaction_status(scb->io_ctx,status);
576 void ahc_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
578 cmd->result &= ~0xFFFF;
579 cmd->result |= status;
583 void ahc_set_scsi_status(struct scb *scb, uint32_t status)
585 ahc_cmd_set_scsi_status(scb->io_ctx, status);
589 uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd)
591 return ((cmd->result >> 16) & CAM_STATUS_MASK);
595 uint32_t ahc_get_transaction_status(struct scb *scb)
597 return (ahc_cmd_get_transaction_status(scb->io_ctx));
601 uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd)
603 return (cmd->result & 0xFFFF);
607 uint32_t ahc_get_scsi_status(struct scb *scb)
609 return (ahc_cmd_get_scsi_status(scb->io_ctx));
613 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
616 * Nothing to do for linux as the incoming transaction
617 * has no concept of tag/non tagged, etc.
622 u_long ahc_get_transfer_length(struct scb *scb)
624 return (scb->platform_data->xfer_len);
628 int ahc_get_transfer_dir(struct scb *scb)
630 return (scb->io_ctx->sc_data_direction);
634 void ahc_set_residual(struct scb *scb, u_long resid)
636 scsi_set_resid(scb->io_ctx, resid);
640 void ahc_set_sense_residual(struct scb *scb, u_long resid)
642 scb->platform_data->sense_resid = resid;
646 u_long ahc_get_residual(struct scb *scb)
648 return scsi_get_resid(scb->io_ctx);
652 u_long ahc_get_sense_residual(struct scb *scb)
654 return (scb->platform_data->sense_resid);
658 int ahc_perform_autosense(struct scb *scb)
661 * We always perform autosense in Linux.
662 * On other platforms this is set on a
663 * per-transaction basis.
668 static inline uint32_t
669 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
671 return (sizeof(struct scsi_sense_data));
675 ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
676 struct ahc_devinfo *devinfo)
678 /* Nothing to do here for linux */
682 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
686 int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
687 void ahc_platform_free(struct ahc_softc *ahc);
688 void ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
691 ahc_freeze_scb(struct scb *scb)
693 if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
694 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
695 scb->platform_data->dev->qfrozen++;
699 void ahc_platform_set_tags(struct ahc_softc *ahc, struct scsi_device *sdev,
700 struct ahc_devinfo *devinfo, ahc_queue_alg);
701 int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
702 char channel, int lun, u_int tag,
703 role_t role, uint32_t status);
705 ahc_linux_isr(int irq, void *dev_id);
706 void ahc_platform_flushwork(struct ahc_softc *ahc);
707 void ahc_done(struct ahc_softc*, struct scb*);
708 void ahc_send_async(struct ahc_softc *, char channel,
709 u_int target, u_int lun, ac_code);
710 void ahc_print_path(struct ahc_softc *, struct scb *);
711 void ahc_platform_dump_card_state(struct ahc_softc *ahc);
714 #define AHC_PCI_CONFIG 1
716 #define AHC_PCI_CONFIG 0
718 #define bootverbose aic7xxx_verbose
719 extern u_int aic7xxx_verbose;
720 #endif /* _AIC7XXX_LINUX_H_ */