2 * Adaptec AIC79xx device driver for Linux.
4 * Copyright (c) 2000-2001 Adaptec Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14 * substantially similar to the "NO WARRANTY" disclaimer below
15 * ("Disclaimer") and any redistribution must be conditioned upon
16 * including a substantially similar Disclaimer requirement for further
17 * binary redistribution.
18 * 3. Neither the names of the above-listed copyright holders nor the names
19 * of any contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * Alternatively, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2 as published by the Free
24 * Software Foundation.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
36 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGES.
39 * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic79xx_osm.h#166 $
42 #ifndef _AIC79XX_LINUX_H_
43 #define _AIC79XX_LINUX_H_
45 #include <linux/types.h>
46 #include <linux/blkdev.h>
47 #include <linux/delay.h>
48 #include <linux/ioport.h>
49 #include <linux/pci.h>
50 #include <linux/interrupt.h>
51 #include <linux/module.h>
52 #include <linux/slab.h>
53 #include <asm/byteorder.h>
56 #include <scsi/scsi.h>
57 #include <scsi/scsi_cmnd.h>
58 #include <scsi/scsi_eh.h>
59 #include <scsi/scsi_device.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_tcq.h>
62 #include <scsi/scsi_transport.h>
63 #include <scsi/scsi_transport_spi.h>
65 /* Core SCSI definitions */
66 #define AIC_LIB_PREFIX ahd
70 #include "scsi_message.h"
74 /*********************************** Debugging ********************************/
75 #ifdef CONFIG_AIC79XX_DEBUG_ENABLE
76 #ifdef CONFIG_AIC79XX_DEBUG_MASK
78 #define AHD_DEBUG_OPTS CONFIG_AIC79XX_DEBUG_MASK
81 * Compile in debugging code, but do not enable any printfs.
84 #define AHD_DEBUG_OPTS 0
86 /* No debugging code. */
89 /********************************** Misc Macros *******************************/
90 #define powerof2(x) ((((x)-1)&(x))==0)
92 /************************* Forward Declarations *******************************/
94 typedef struct pci_dev
*ahd_dev_softc_t
;
95 typedef struct scsi_cmnd
*ahd_io_ctx_t
;
97 /******************************* Byte Order ***********************************/
98 #define ahd_htobe16(x) cpu_to_be16(x)
99 #define ahd_htobe32(x) cpu_to_be32(x)
100 #define ahd_htobe64(x) cpu_to_be64(x)
101 #define ahd_htole16(x) cpu_to_le16(x)
102 #define ahd_htole32(x) cpu_to_le32(x)
103 #define ahd_htole64(x) cpu_to_le64(x)
105 #define ahd_be16toh(x) be16_to_cpu(x)
106 #define ahd_be32toh(x) be32_to_cpu(x)
107 #define ahd_be64toh(x) be64_to_cpu(x)
108 #define ahd_le16toh(x) le16_to_cpu(x)
109 #define ahd_le32toh(x) le32_to_cpu(x)
110 #define ahd_le64toh(x) le64_to_cpu(x)
112 /************************* Configuration Data *********************************/
113 extern uint32_t aic79xx_allow_memio
;
114 extern struct scsi_host_template aic79xx_driver_template
;
116 /***************************** Bus Space/DMA **********************************/
118 typedef uint32_t bus_size_t
;
127 volatile uint8_t __iomem
*maddr
;
128 } bus_space_handle_t
;
130 typedef struct bus_dma_segment
136 struct ahd_linux_dma_tag
138 bus_size_t alignment
;
142 typedef struct ahd_linux_dma_tag
* bus_dma_tag_t
;
144 typedef dma_addr_t bus_dmamap_t
;
146 typedef int bus_dma_filter_t(void*, dma_addr_t
);
147 typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t
*, int, int);
149 #define BUS_DMA_WAITOK 0x0
150 #define BUS_DMA_NOWAIT 0x1
151 #define BUS_DMA_ALLOCNOW 0x2
152 #define BUS_DMA_LOAD_SEGS 0x4 /*
153 * Argument is an S/G list not
157 #define BUS_SPACE_MAXADDR 0xFFFFFFFF
158 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
159 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
161 int ahd_dma_tag_create(struct ahd_softc
*, bus_dma_tag_t
/*parent*/,
162 bus_size_t
/*alignment*/, bus_size_t
/*boundary*/,
163 dma_addr_t
/*lowaddr*/, dma_addr_t
/*highaddr*/,
164 bus_dma_filter_t*/
*filter*/
, void */
*filterarg*/
,
165 bus_size_t
/*maxsize*/, int /*nsegments*/,
166 bus_size_t
/*maxsegsz*/, int /*flags*/,
167 bus_dma_tag_t */
*dma_tagp*/
);
169 void ahd_dma_tag_destroy(struct ahd_softc
*, bus_dma_tag_t
/*tag*/);
171 int ahd_dmamem_alloc(struct ahd_softc
*, bus_dma_tag_t
/*dmat*/,
172 void** /*vaddr*/, int /*flags*/,
173 bus_dmamap_t
* /*mapp*/);
175 void ahd_dmamem_free(struct ahd_softc
*, bus_dma_tag_t
/*dmat*/,
176 void* /*vaddr*/, bus_dmamap_t
/*map*/);
178 void ahd_dmamap_destroy(struct ahd_softc
*, bus_dma_tag_t
/*tag*/,
179 bus_dmamap_t
/*map*/);
181 int ahd_dmamap_load(struct ahd_softc
*ahd
, bus_dma_tag_t
/*dmat*/,
182 bus_dmamap_t
/*map*/, void * /*buf*/,
183 bus_size_t
/*buflen*/, bus_dmamap_callback_t
*,
184 void */
*callback_arg*/
, int /*flags*/);
186 int ahd_dmamap_unload(struct ahd_softc
*, bus_dma_tag_t
, bus_dmamap_t
);
189 * Operations performed by ahd_dmamap_sync().
191 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */
192 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */
193 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */
194 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */
198 * ahd_dmamap_sync is only used on buffers allocated with
199 * the pci_alloc_consistent() API. Although I'm not sure how
200 * this works on architectures with a write buffer, Linux does
201 * not have an API to sync "coherent" memory. Perhaps we need
204 #define ahd_dmamap_sync(ahd, dma_tag, dmamap, offset, len, op)
206 /********************************** Includes **********************************/
207 #ifdef CONFIG_AIC79XX_REG_PRETTY_PRINT
208 #define AIC_DEBUG_REGISTERS 1
210 #define AIC_DEBUG_REGISTERS 0
214 /***************************** SMP support ************************************/
215 #include <linux/spinlock.h>
217 #define AIC79XX_DRIVER_VERSION "3.0"
219 /*************************** Device Data Structures ***************************/
221 * A per probed device structure used to deal with some error recovery
222 * scenarios that the Linux mid-layer code just doesn't know how to
223 * handle. The structure allocated for a device only becomes persistent
224 * after a successfully completed inquiry command to the target when
225 * that inquiry data indicates a lun is present.
229 AHD_DEV_FREEZE_TIL_EMPTY
= 0x02, /* Freeze queue until active == 0 */
230 AHD_DEV_Q_BASIC
= 0x10, /* Allow basic device queuing */
231 AHD_DEV_Q_TAGGED
= 0x20, /* Allow full SCSI2 command queueing */
232 AHD_DEV_PERIODIC_OTAG
= 0x40, /* Send OTAG to prevent starvation */
233 } ahd_linux_dev_flags
;
235 struct ahd_linux_device
{
236 TAILQ_ENTRY(ahd_linux_device
) links
;
239 * The number of transactions currently
240 * queued to the device.
245 * The currently allowed number of
246 * transactions that can be queued to
247 * the device. Must be signed for
248 * conversion from tagged to untagged
249 * mode where the device may have more
250 * than one outstanding active transaction.
255 * A positive count indicates that this
256 * device's queue is halted.
261 * Cumulative command counter.
263 u_long commands_issued
;
266 * The number of tagged transactions when
267 * running at our current opening level
268 * that have been successfully received by
269 * this device since the last QUEUE FULL.
271 u_int tag_success_count
;
272 #define AHD_TAG_SUCCESS_INTERVAL 50
274 ahd_linux_dev_flags flags
;
279 struct timer_list timer
;
282 * The high limit for the tags variable.
287 * The computed number of tags outstanding
288 * at the time of the last QUEUE FULL event.
290 u_int tags_on_last_queuefull
;
293 * How many times we have seen a queue full
294 * with the same number of tags. This is used
295 * to stop our adaptive queue depth algorithm
296 * on devices with a fixed number of tags.
298 u_int last_queuefull_same_count
;
299 #define AHD_LOCK_TAGS_COUNT 50
302 * How many transactions have been queued
303 * without the device going idle. We use
304 * this statistic to determine when to issue
305 * an ordered tag to prevent transaction
306 * starvation. This statistic is only updated
307 * if the AHD_DEV_PERIODIC_OTAG flag is set
310 u_int commands_since_idle_or_otag
;
311 #define AHD_OTAG_THRESH 500
314 /********************* Definitions Required by the Core ***********************/
316 * Number of SG segments we require. So long as the S/G segments for
317 * a particular transaction are allocated in a physically contiguous
318 * manner and are allocated below 4GB, the number of S/G segments is
324 * Per-SCB OSM storage.
326 struct scb_platform_data
{
327 struct ahd_linux_device
*dev
;
328 dma_addr_t buf_busaddr
;
330 uint32_t sense_resid
; /* Auto-Sense residual */
334 * Define a structure used for each host adapter. All members are
335 * aligned on a boundary >= the size of the member to honor the
336 * alignment restrictions of the various platforms supported by
339 struct ahd_platform_data
{
341 * Fields accessed from interrupt context.
343 struct scsi_target
*starget
[AHD_NUM_TARGETS
];
345 spinlock_t spin_lock
;
346 struct completion
*eh_done
;
347 struct Scsi_Host
*host
; /* pointer to scsi host */
348 #define AHD_LINUX_NOIRQ ((uint32_t)~0)
349 uint32_t irq
; /* IRQ for this adapter */
350 uint32_t bios_address
;
351 resource_size_t mem_busaddr
; /* Mem Base Addr */
354 void ahd_delay(long);
356 /***************************** Low Level I/O **********************************/
357 uint8_t ahd_inb(struct ahd_softc
* ahd
, long port
);
358 void ahd_outb(struct ahd_softc
* ahd
, long port
, uint8_t val
);
359 void ahd_outw_atomic(struct ahd_softc
* ahd
,
360 long port
, uint16_t val
);
361 void ahd_outsb(struct ahd_softc
* ahd
, long port
,
362 uint8_t *, int count
);
363 void ahd_insb(struct ahd_softc
* ahd
, long port
,
364 uint8_t *, int count
);
366 /**************************** Initialization **********************************/
367 int ahd_linux_register_host(struct ahd_softc
*,
368 struct scsi_host_template
*);
370 /******************************** Locking *************************************/
372 ahd_lockinit(struct ahd_softc
*ahd
)
374 spin_lock_init(&ahd
->platform_data
->spin_lock
);
378 ahd_lock(struct ahd_softc
*ahd
, unsigned long *flags
)
380 spin_lock_irqsave(&ahd
->platform_data
->spin_lock
, *flags
);
384 ahd_unlock(struct ahd_softc
*ahd
, unsigned long *flags
)
386 spin_unlock_irqrestore(&ahd
->platform_data
->spin_lock
, *flags
);
389 /******************************* PCI Definitions ******************************/
391 * PCIM_xxx: mask to locate subfield in register
392 * PCIR_xxx: config register offset
393 * PCIC_xxx: device class
394 * PCIS_xxx: device subclass
395 * PCIP_xxx: device programming interface
396 * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)
397 * PCID_xxx: device ID
399 #define PCIR_DEVVENDOR 0x00
400 #define PCIR_VENDOR 0x00
401 #define PCIR_DEVICE 0x02
402 #define PCIR_COMMAND 0x04
403 #define PCIM_CMD_PORTEN 0x0001
404 #define PCIM_CMD_MEMEN 0x0002
405 #define PCIM_CMD_BUSMASTEREN 0x0004
406 #define PCIM_CMD_MWRICEN 0x0010
407 #define PCIM_CMD_PERRESPEN 0x0040
408 #define PCIM_CMD_SERRESPEN 0x0100
409 #define PCIR_STATUS 0x06
410 #define PCIR_REVID 0x08
411 #define PCIR_PROGIF 0x09
412 #define PCIR_SUBCLASS 0x0a
413 #define PCIR_CLASS 0x0b
414 #define PCIR_CACHELNSZ 0x0c
415 #define PCIR_LATTIMER 0x0d
416 #define PCIR_HEADERTYPE 0x0e
417 #define PCIM_MFDEV 0x80
418 #define PCIR_BIST 0x0f
419 #define PCIR_CAP_PTR 0x34
421 /* config registers for header type 0 devices */
422 #define PCIR_MAPS 0x10
423 #define PCIR_SUBVEND_0 0x2c
424 #define PCIR_SUBDEV_0 0x2e
426 /****************************** PCI-X definitions *****************************/
427 #define PCIXR_COMMAND 0x96
428 #define PCIXR_DEVADDR 0x98
429 #define PCIXM_DEVADDR_FNUM 0x0003 /* Function Number */
430 #define PCIXM_DEVADDR_DNUM 0x00F8 /* Device Number */
431 #define PCIXM_DEVADDR_BNUM 0xFF00 /* Bus Number */
432 #define PCIXR_STATUS 0x9A
433 #define PCIXM_STATUS_64BIT 0x0001 /* Active 64bit connection to device. */
434 #define PCIXM_STATUS_133CAP 0x0002 /* Device is 133MHz capable */
435 #define PCIXM_STATUS_SCDISC 0x0004 /* Split Completion Discarded */
436 #define PCIXM_STATUS_UNEXPSC 0x0008 /* Unexpected Split Completion */
437 #define PCIXM_STATUS_CMPLEXDEV 0x0010 /* Device Complexity (set == bridge) */
438 #define PCIXM_STATUS_MAXMRDBC 0x0060 /* Maximum Burst Read Count */
439 #define PCIXM_STATUS_MAXSPLITS 0x0380 /* Maximum Split Transactions */
440 #define PCIXM_STATUS_MAXCRDS 0x1C00 /* Maximum Cumulative Read Size */
441 #define PCIXM_STATUS_RCVDSCEM 0x2000 /* Received a Split Comp w/Error msg */
451 void ahd_power_state_change(struct ahd_softc
*ahd
,
452 ahd_power_state new_state
);
454 /******************************* PCI Routines *********************************/
455 int ahd_linux_pci_init(void);
456 void ahd_linux_pci_exit(void);
457 int ahd_pci_map_registers(struct ahd_softc
*ahd
);
458 int ahd_pci_map_int(struct ahd_softc
*ahd
);
460 uint32_t ahd_pci_read_config(ahd_dev_softc_t pci
,
462 void ahd_pci_write_config(ahd_dev_softc_t pci
,
463 int reg
, uint32_t value
,
466 static inline int ahd_get_pci_function(ahd_dev_softc_t
);
468 ahd_get_pci_function(ahd_dev_softc_t pci
)
470 return (PCI_FUNC(pci
->devfn
));
473 static inline int ahd_get_pci_slot(ahd_dev_softc_t
);
475 ahd_get_pci_slot(ahd_dev_softc_t pci
)
477 return (PCI_SLOT(pci
->devfn
));
480 static inline int ahd_get_pci_bus(ahd_dev_softc_t
);
482 ahd_get_pci_bus(ahd_dev_softc_t pci
)
484 return (pci
->bus
->number
);
487 static inline void ahd_flush_device_writes(struct ahd_softc
*);
489 ahd_flush_device_writes(struct ahd_softc
*ahd
)
491 /* XXX Is this sufficient for all architectures??? */
492 ahd_inb(ahd
, INTSTAT
);
495 /**************************** Proc FS Support *********************************/
496 int ahd_proc_write_seeprom(struct Scsi_Host
*, char *, int);
497 int ahd_linux_show_info(struct seq_file
*,struct Scsi_Host
*);
499 /*********************** Transaction Access Wrappers **************************/
500 static inline void ahd_cmd_set_transaction_status(struct scsi_cmnd
*, uint32_t);
501 static inline void ahd_set_transaction_status(struct scb
*, uint32_t);
502 static inline void ahd_cmd_set_scsi_status(struct scsi_cmnd
*, uint32_t);
503 static inline void ahd_set_scsi_status(struct scb
*, uint32_t);
504 static inline uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd
*cmd
);
505 static inline uint32_t ahd_get_transaction_status(struct scb
*);
506 static inline uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd
*cmd
);
507 static inline uint32_t ahd_get_scsi_status(struct scb
*);
508 static inline void ahd_set_transaction_tag(struct scb
*, int, u_int
);
509 static inline u_long
ahd_get_transfer_length(struct scb
*);
510 static inline int ahd_get_transfer_dir(struct scb
*);
511 static inline void ahd_set_residual(struct scb
*, u_long
);
512 static inline void ahd_set_sense_residual(struct scb
*scb
, u_long resid
);
513 static inline u_long
ahd_get_residual(struct scb
*);
514 static inline u_long
ahd_get_sense_residual(struct scb
*);
515 static inline int ahd_perform_autosense(struct scb
*);
516 static inline uint32_t ahd_get_sense_bufsize(struct ahd_softc
*,
518 static inline void ahd_notify_xfer_settings_change(struct ahd_softc
*,
519 struct ahd_devinfo
*);
520 static inline void ahd_platform_scb_free(struct ahd_softc
*ahd
,
522 static inline void ahd_freeze_scb(struct scb
*scb
);
525 void ahd_cmd_set_transaction_status(struct scsi_cmnd
*cmd
, uint32_t status
)
527 cmd
->result
&= ~(CAM_STATUS_MASK
<< 16);
528 cmd
->result
|= status
<< 16;
532 void ahd_set_transaction_status(struct scb
*scb
, uint32_t status
)
534 ahd_cmd_set_transaction_status(scb
->io_ctx
,status
);
538 void ahd_cmd_set_scsi_status(struct scsi_cmnd
*cmd
, uint32_t status
)
540 cmd
->result
&= ~0xFFFF;
541 cmd
->result
|= status
;
545 void ahd_set_scsi_status(struct scb
*scb
, uint32_t status
)
547 ahd_cmd_set_scsi_status(scb
->io_ctx
, status
);
551 uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd
*cmd
)
553 return ((cmd
->result
>> 16) & CAM_STATUS_MASK
);
557 uint32_t ahd_get_transaction_status(struct scb
*scb
)
559 return (ahd_cmd_get_transaction_status(scb
->io_ctx
));
563 uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd
*cmd
)
565 return (cmd
->result
& 0xFFFF);
569 uint32_t ahd_get_scsi_status(struct scb
*scb
)
571 return (ahd_cmd_get_scsi_status(scb
->io_ctx
));
575 void ahd_set_transaction_tag(struct scb
*scb
, int enabled
, u_int type
)
578 * Nothing to do for linux as the incoming transaction
579 * has no concept of tag/non tagged, etc.
584 u_long
ahd_get_transfer_length(struct scb
*scb
)
586 return (scb
->platform_data
->xfer_len
);
590 int ahd_get_transfer_dir(struct scb
*scb
)
592 return (scb
->io_ctx
->sc_data_direction
);
596 void ahd_set_residual(struct scb
*scb
, u_long resid
)
598 scsi_set_resid(scb
->io_ctx
, resid
);
602 void ahd_set_sense_residual(struct scb
*scb
, u_long resid
)
604 scb
->platform_data
->sense_resid
= resid
;
608 u_long
ahd_get_residual(struct scb
*scb
)
610 return scsi_get_resid(scb
->io_ctx
);
614 u_long
ahd_get_sense_residual(struct scb
*scb
)
616 return (scb
->platform_data
->sense_resid
);
620 int ahd_perform_autosense(struct scb
*scb
)
623 * We always perform autosense in Linux.
624 * On other platforms this is set on a
625 * per-transaction basis.
630 static inline uint32_t
631 ahd_get_sense_bufsize(struct ahd_softc
*ahd
, struct scb
*scb
)
633 return (sizeof(struct scsi_sense_data
));
637 ahd_notify_xfer_settings_change(struct ahd_softc
*ahd
,
638 struct ahd_devinfo
*devinfo
)
640 /* Nothing to do here for linux */
644 ahd_platform_scb_free(struct ahd_softc
*ahd
, struct scb
*scb
)
646 ahd
->flags
&= ~AHD_RESOURCE_SHORTAGE
;
649 int ahd_platform_alloc(struct ahd_softc
*ahd
, void *platform_arg
);
650 void ahd_platform_free(struct ahd_softc
*ahd
);
651 void ahd_platform_init(struct ahd_softc
*ahd
);
652 void ahd_platform_freeze_devq(struct ahd_softc
*ahd
, struct scb
*scb
);
655 ahd_freeze_scb(struct scb
*scb
)
657 if ((scb
->io_ctx
->result
& (CAM_DEV_QFRZN
<< 16)) == 0) {
658 scb
->io_ctx
->result
|= CAM_DEV_QFRZN
<< 16;
659 scb
->platform_data
->dev
->qfrozen
++;
663 void ahd_platform_set_tags(struct ahd_softc
*ahd
, struct scsi_device
*sdev
,
664 struct ahd_devinfo
*devinfo
, ahd_queue_alg
);
665 int ahd_platform_abort_scbs(struct ahd_softc
*ahd
, int target
,
666 char channel
, int lun
, u_int tag
,
667 role_t role
, uint32_t status
);
669 ahd_linux_isr(int irq
, void *dev_id
);
670 void ahd_done(struct ahd_softc
*, struct scb
*);
671 void ahd_send_async(struct ahd_softc
*, char channel
,
672 u_int target
, u_int lun
, ac_code
);
673 void ahd_print_path(struct ahd_softc
*, struct scb
*);
676 #define AHD_PCI_CONFIG 1
678 #define AHD_PCI_CONFIG 0
680 #define bootverbose aic79xx_verbose
681 extern uint32_t aic79xx_verbose
;
683 #endif /* _AIC79XX_LINUX_H_ */