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
87 #include "scsi_message.h"
90 /*********************************** Debugging ********************************/
91 #ifdef CONFIG_AIC7XXX_DEBUG_ENABLE
92 #ifdef CONFIG_AIC7XXX_DEBUG_MASK
94 #define AHC_DEBUG_OPTS CONFIG_AIC7XXX_DEBUG_MASK
97 * Compile in debugging code, but do not enable any printfs.
101 /* No debugging code. */
104 /************************* Forward Declarations *******************************/
106 typedef struct pci_dev *ahc_dev_softc_t;
107 typedef struct scsi_cmnd *ahc_io_ctx_t;
109 /******************************* Byte Order ***********************************/
110 #define ahc_htobe16(x) cpu_to_be16(x)
111 #define ahc_htobe32(x) cpu_to_be32(x)
112 #define ahc_htobe64(x) cpu_to_be64(x)
113 #define ahc_htole16(x) cpu_to_le16(x)
114 #define ahc_htole32(x) cpu_to_le32(x)
115 #define ahc_htole64(x) cpu_to_le64(x)
117 #define ahc_be16toh(x) be16_to_cpu(x)
118 #define ahc_be32toh(x) be32_to_cpu(x)
119 #define ahc_be64toh(x) be64_to_cpu(x)
120 #define ahc_le16toh(x) le16_to_cpu(x)
121 #define ahc_le32toh(x) le32_to_cpu(x)
122 #define ahc_le64toh(x) le64_to_cpu(x)
124 /************************* Configuration Data *********************************/
125 extern u_int aic7xxx_no_probe;
126 extern u_int aic7xxx_allow_memio;
127 extern struct scsi_host_template aic7xxx_driver_template;
129 /***************************** Bus Space/DMA **********************************/
131 typedef uint32_t bus_size_t;
140 volatile uint8_t __iomem *maddr;
141 } bus_space_handle_t;
143 typedef struct bus_dma_segment
149 struct ahc_linux_dma_tag
151 bus_size_t alignment;
155 typedef struct ahc_linux_dma_tag* bus_dma_tag_t;
157 typedef dma_addr_t bus_dmamap_t;
159 typedef int bus_dma_filter_t(void*, dma_addr_t);
160 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);
162 #define BUS_DMA_WAITOK 0x0
163 #define BUS_DMA_NOWAIT 0x1
164 #define BUS_DMA_ALLOCNOW 0x2
165 #define BUS_DMA_LOAD_SEGS 0x4 /*
166 * Argument is an S/G list not
170 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
171 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
172 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
174 int ahc_dma_tag_create(struct ahc_softc *, bus_dma_tag_t /*parent*/,
175 bus_size_t /*alignment*/, bus_size_t /*boundary*/,
176 dma_addr_t /*lowaddr*/, dma_addr_t /*highaddr*/,
177 bus_dma_filter_t*/*filter*/, void */*filterarg*/,
178 bus_size_t /*maxsize*/, int /*nsegments*/,
179 bus_size_t /*maxsegsz*/, int /*flags*/,
180 bus_dma_tag_t */*dma_tagp*/);
182 void ahc_dma_tag_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/);
184 int ahc_dmamem_alloc(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
185 void** /*vaddr*/, int /*flags*/,
186 bus_dmamap_t* /*mapp*/);
188 void ahc_dmamem_free(struct ahc_softc *, bus_dma_tag_t /*dmat*/,
189 void* /*vaddr*/, bus_dmamap_t /*map*/);
191 void ahc_dmamap_destroy(struct ahc_softc *, bus_dma_tag_t /*tag*/,
192 bus_dmamap_t /*map*/);
194 int ahc_dmamap_load(struct ahc_softc *ahc, bus_dma_tag_t /*dmat*/,
195 bus_dmamap_t /*map*/, void * /*buf*/,
196 bus_size_t /*buflen*/, bus_dmamap_callback_t *,
197 void */*callback_arg*/, int /*flags*/);
199 int ahc_dmamap_unload(struct ahc_softc *, bus_dma_tag_t, bus_dmamap_t);
202 * Operations performed by ahc_dmamap_sync().
204 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */
205 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */
206 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */
207 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */
211 * ahc_dmamap_sync is only used on buffers allocated with
212 * the pci_alloc_consistent() API. Although I'm not sure how
213 * this works on architectures with a write buffer, Linux does
214 * not have an API to sync "coherent" memory. Perhaps we need
217 #define ahc_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op)
219 /********************************** Includes **********************************/
220 #ifdef CONFIG_AIC7XXX_REG_PRETTY_PRINT
221 #define AIC_DEBUG_REGISTERS 1
223 #define AIC_DEBUG_REGISTERS 0
227 /***************************** Timer Facilities *******************************/
229 ahc_scb_timer_reset(struct scb *scb, u_int usec)
233 /***************************** SMP support ************************************/
234 #include <linux/spinlock.h>
236 #define AIC7XXX_DRIVER_VERSION "7.0"
238 /*************************** Device Data Structures ***************************/
240 * A per probed device structure used to deal with some error recovery
241 * scenarios that the Linux mid-layer code just doesn't know how to
242 * handle. The structure allocated for a device only becomes persistent
243 * after a successfully completed inquiry command to the target when
244 * that inquiry data indicates a lun is present.
247 AHC_DEV_FREEZE_TIL_EMPTY = 0x02, /* Freeze queue until active == 0 */
248 AHC_DEV_Q_BASIC = 0x10, /* Allow basic device queuing */
249 AHC_DEV_Q_TAGGED = 0x20, /* Allow full SCSI2 command queueing */
250 AHC_DEV_PERIODIC_OTAG = 0x40, /* Send OTAG to prevent starvation */
251 } ahc_linux_dev_flags;
253 struct ahc_linux_device {
255 * The number of transactions currently
256 * queued to the device.
261 * The currently allowed number of
262 * transactions that can be queued to
263 * the device. Must be signed for
264 * conversion from tagged to untagged
265 * mode where the device may have more
266 * than one outstanding active transaction.
271 * A positive count indicates that this
272 * device's queue is halted.
277 * Cumulative command counter.
279 u_long commands_issued;
282 * The number of tagged transactions when
283 * running at our current opening level
284 * that have been successfully received by
285 * this device since the last QUEUE FULL.
287 u_int tag_success_count;
288 #define AHC_TAG_SUCCESS_INTERVAL 50
290 ahc_linux_dev_flags flags;
293 * The high limit for the tags variable.
298 * The computed number of tags outstanding
299 * at the time of the last QUEUE FULL event.
301 u_int tags_on_last_queuefull;
304 * How many times we have seen a queue full
305 * with the same number of tags. This is used
306 * to stop our adaptive queue depth algorithm
307 * on devices with a fixed number of tags.
309 u_int last_queuefull_same_count;
310 #define AHC_LOCK_TAGS_COUNT 50
313 * How many transactions have been queued
314 * without the device going idle. We use
315 * this statistic to determine when to issue
316 * an ordered tag to prevent transaction
317 * starvation. This statistic is only updated
318 * if the AHC_DEV_PERIODIC_OTAG flag is set
321 u_int commands_since_idle_or_otag;
322 #define AHC_OTAG_THRESH 500
325 /********************* Definitions Required by the Core ***********************/
327 * Number of SG segments we require. So long as the S/G segments for
328 * a particular transaction are allocated in a physically contiguous
329 * manner and are allocated below 4GB, the number of S/G segments is
335 * Per-SCB OSM storage.
337 struct scb_platform_data {
338 struct ahc_linux_device *dev;
339 dma_addr_t buf_busaddr;
341 uint32_t sense_resid; /* Auto-Sense residual */
345 * Define a structure used for each host adapter. All members are
346 * aligned on a boundary >= the size of the member to honor the
347 * alignment restrictions of the various platforms supported by
350 struct ahc_platform_data {
352 * Fields accessed from interrupt context.
354 struct scsi_target *starget[AHC_NUM_TARGETS];
356 spinlock_t spin_lock;
358 struct completion *eh_done;
359 struct Scsi_Host *host; /* pointer to scsi host */
360 #define AHC_LINUX_NOIRQ ((uint32_t)~0)
361 uint32_t irq; /* IRQ for this adapter */
362 uint32_t bios_address;
363 resource_size_t mem_busaddr; /* Mem Base Addr */
366 void ahc_delay(long);
369 /***************************** Low Level I/O **********************************/
370 uint8_t ahc_inb(struct ahc_softc * ahc, long port);
371 void ahc_outb(struct ahc_softc * ahc, long port, uint8_t val);
372 void ahc_outsb(struct ahc_softc * ahc, long port,
373 uint8_t *, int count);
374 void ahc_insb(struct ahc_softc * ahc, long port,
375 uint8_t *, int count);
377 /**************************** Initialization **********************************/
378 int ahc_linux_register_host(struct ahc_softc *,
379 struct scsi_host_template *);
381 /******************************** Locking *************************************/
382 /* Lock protecting internal data structures */
385 ahc_lockinit(struct ahc_softc *ahc)
387 spin_lock_init(&ahc->platform_data->spin_lock);
391 ahc_lock(struct ahc_softc *ahc, unsigned long *flags)
393 spin_lock_irqsave(&ahc->platform_data->spin_lock, *flags);
397 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags)
399 spin_unlock_irqrestore(&ahc->platform_data->spin_lock, *flags);
402 /******************************* PCI Definitions ******************************/
404 * PCIM_xxx: mask to locate subfield in register
405 * PCIR_xxx: config register offset
406 * PCIC_xxx: device class
407 * PCIS_xxx: device subclass
408 * PCIP_xxx: device programming interface
409 * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
410 * PCID_xxx: device ID
412 #define PCIR_DEVVENDOR 0x00
413 #define PCIR_VENDOR 0x00
414 #define PCIR_DEVICE 0x02
415 #define PCIR_COMMAND 0x04
416 #define PCIM_CMD_PORTEN 0x0001
417 #define PCIM_CMD_MEMEN 0x0002
418 #define PCIM_CMD_BUSMASTEREN 0x0004
419 #define PCIM_CMD_MWRICEN 0x0010
420 #define PCIM_CMD_PERRESPEN 0x0040
421 #define PCIM_CMD_SERRESPEN 0x0100
422 #define PCIR_STATUS 0x06
423 #define PCIR_REVID 0x08
424 #define PCIR_PROGIF 0x09
425 #define PCIR_SUBCLASS 0x0a
426 #define PCIR_CLASS 0x0b
427 #define PCIR_CACHELNSZ 0x0c
428 #define PCIR_LATTIMER 0x0d
429 #define PCIR_HEADERTYPE 0x0e
430 #define PCIM_MFDEV 0x80
431 #define PCIR_BIST 0x0f
432 #define PCIR_CAP_PTR 0x34
434 /* config registers for header type 0 devices */
435 #define PCIR_MAPS 0x10
436 #define PCIR_SUBVEND_0 0x2c
437 #define PCIR_SUBDEV_0 0x2e
447 /**************************** VL/EISA Routines ********************************/
449 int ahc_linux_eisa_init(void);
450 void ahc_linux_eisa_exit(void);
451 int aic7770_map_registers(struct ahc_softc *ahc,
453 int aic7770_map_int(struct ahc_softc *ahc, u_int irq);
455 static inline int ahc_linux_eisa_init(void) {
458 static inline void ahc_linux_eisa_exit(void) {
462 /******************************* PCI Routines *********************************/
464 int ahc_linux_pci_init(void);
465 void ahc_linux_pci_exit(void);
466 int ahc_pci_map_registers(struct ahc_softc *ahc);
467 int ahc_pci_map_int(struct ahc_softc *ahc);
469 uint32_t ahc_pci_read_config(ahc_dev_softc_t pci,
472 void ahc_pci_write_config(ahc_dev_softc_t pci,
473 int reg, uint32_t value,
476 static inline int ahc_get_pci_function(ahc_dev_softc_t);
478 ahc_get_pci_function(ahc_dev_softc_t pci)
480 return (PCI_FUNC(pci->devfn));
483 static inline int ahc_get_pci_slot(ahc_dev_softc_t);
485 ahc_get_pci_slot(ahc_dev_softc_t pci)
487 return (PCI_SLOT(pci->devfn));
490 static inline int ahc_get_pci_bus(ahc_dev_softc_t);
492 ahc_get_pci_bus(ahc_dev_softc_t pci)
494 return (pci->bus->number);
497 static inline int ahc_linux_pci_init(void) {
500 static inline void ahc_linux_pci_exit(void) {
504 static inline void ahc_flush_device_writes(struct ahc_softc *);
506 ahc_flush_device_writes(struct ahc_softc *ahc)
508 /* XXX Is this sufficient for all architectures??? */
509 ahc_inb(ahc, INTSTAT);
512 /**************************** Proc FS Support *********************************/
513 int ahc_proc_write_seeprom(struct Scsi_Host *, char *, int);
514 int ahc_linux_show_info(struct seq_file *, struct Scsi_Host *);
516 /*************************** Domain Validation ********************************/
517 /*********************** Transaction Access Wrappers *************************/
518 static inline void ahc_cmd_set_transaction_status(struct scsi_cmnd *, uint32_t);
519 static inline void ahc_set_transaction_status(struct scb *, uint32_t);
520 static inline void ahc_cmd_set_scsi_status(struct scsi_cmnd *, uint32_t);
521 static inline void ahc_set_scsi_status(struct scb *, uint32_t);
522 static inline uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd);
523 static inline uint32_t ahc_get_transaction_status(struct scb *);
524 static inline uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd);
525 static inline uint32_t ahc_get_scsi_status(struct scb *);
526 static inline void ahc_set_transaction_tag(struct scb *, int, u_int);
527 static inline u_long ahc_get_transfer_length(struct scb *);
528 static inline int ahc_get_transfer_dir(struct scb *);
529 static inline void ahc_set_residual(struct scb *, u_long);
530 static inline void ahc_set_sense_residual(struct scb *scb, u_long resid);
531 static inline u_long ahc_get_residual(struct scb *);
532 static inline u_long ahc_get_sense_residual(struct scb *);
533 static inline int ahc_perform_autosense(struct scb *);
534 static inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *,
536 static inline void ahc_notify_xfer_settings_change(struct ahc_softc *,
537 struct ahc_devinfo *);
538 static inline void ahc_platform_scb_free(struct ahc_softc *ahc,
540 static inline void ahc_freeze_scb(struct scb *scb);
543 void ahc_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)
545 cmd->result &= ~(CAM_STATUS_MASK << 16);
546 cmd->result |= status << 16;
550 void ahc_set_transaction_status(struct scb *scb, uint32_t status)
552 ahc_cmd_set_transaction_status(scb->io_ctx,status);
556 void ahc_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)
558 cmd->result &= ~0xFFFF;
559 cmd->result |= status;
563 void ahc_set_scsi_status(struct scb *scb, uint32_t status)
565 ahc_cmd_set_scsi_status(scb->io_ctx, status);
569 uint32_t ahc_cmd_get_transaction_status(struct scsi_cmnd *cmd)
571 return ((cmd->result >> 16) & CAM_STATUS_MASK);
575 uint32_t ahc_get_transaction_status(struct scb *scb)
577 return (ahc_cmd_get_transaction_status(scb->io_ctx));
581 uint32_t ahc_cmd_get_scsi_status(struct scsi_cmnd *cmd)
583 return (cmd->result & 0xFFFF);
587 uint32_t ahc_get_scsi_status(struct scb *scb)
589 return (ahc_cmd_get_scsi_status(scb->io_ctx));
593 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type)
596 * Nothing to do for linux as the incoming transaction
597 * has no concept of tag/non tagged, etc.
602 u_long ahc_get_transfer_length(struct scb *scb)
604 return (scb->platform_data->xfer_len);
608 int ahc_get_transfer_dir(struct scb *scb)
610 return (scb->io_ctx->sc_data_direction);
614 void ahc_set_residual(struct scb *scb, u_long resid)
616 scsi_set_resid(scb->io_ctx, resid);
620 void ahc_set_sense_residual(struct scb *scb, u_long resid)
622 scb->platform_data->sense_resid = resid;
626 u_long ahc_get_residual(struct scb *scb)
628 return scsi_get_resid(scb->io_ctx);
632 u_long ahc_get_sense_residual(struct scb *scb)
634 return (scb->platform_data->sense_resid);
638 int ahc_perform_autosense(struct scb *scb)
641 * We always perform autosense in Linux.
642 * On other platforms this is set on a
643 * per-transaction basis.
648 static inline uint32_t
649 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb)
651 return (sizeof(struct scsi_sense_data));
655 ahc_notify_xfer_settings_change(struct ahc_softc *ahc,
656 struct ahc_devinfo *devinfo)
658 /* Nothing to do here for linux */
662 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb)
666 int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
667 void ahc_platform_free(struct ahc_softc *ahc);
668 void ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb);
671 ahc_freeze_scb(struct scb *scb)
673 if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {
674 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;
675 scb->platform_data->dev->qfrozen++;
679 void ahc_platform_set_tags(struct ahc_softc *ahc, struct scsi_device *sdev,
680 struct ahc_devinfo *devinfo, ahc_queue_alg);
681 int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target,
682 char channel, int lun, u_int tag,
683 role_t role, uint32_t status);
685 ahc_linux_isr(int irq, void *dev_id);
686 void ahc_platform_flushwork(struct ahc_softc *ahc);
687 void ahc_done(struct ahc_softc*, struct scb*);
688 void ahc_send_async(struct ahc_softc *, char channel,
689 u_int target, u_int lun, ac_code);
690 void ahc_print_path(struct ahc_softc *, struct scb *);
691 void ahc_platform_dump_card_state(struct ahc_softc *ahc);
694 #define AHC_PCI_CONFIG 1
696 #define AHC_PCI_CONFIG 0
698 #define bootverbose aic7xxx_verbose
699 extern u_int aic7xxx_verbose;
700 #endif /* _AIC7XXX_LINUX_H_ */