659 lines · c
1/*2 * Adaptec AIC79xx device driver for Linux.3 *4 * Copyright (c) 2000-2001 Adaptec Inc.5 * All rights reserved.6 *7 * Redistribution and use in source and binary forms, with or without8 * modification, are permitted provided that the following conditions9 * are met:10 * 1. Redistributions of source code must retain the above copyright11 * notice, this list of conditions, and the following disclaimer,12 * without modification.13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer14 * substantially similar to the "NO WARRANTY" disclaimer below15 * ("Disclaimer") and any redistribution must be conditioned upon16 * including a substantially similar Disclaimer requirement for further17 * binary redistribution.18 * 3. Neither the names of the above-listed copyright holders nor the names19 * of any contributors may be used to endorse or promote products derived20 * from this software without specific prior written permission.21 *22 * Alternatively, this software may be distributed under the terms of the23 * GNU General Public License ("GPL") version 2 as published by the Free24 * Software Foundation.25 *26 * NO WARRANTY27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT31 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS33 * 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) ARISING36 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE37 * POSSIBILITY OF SUCH DAMAGES.38 *39 * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic79xx_osm.h#166 $40 *41 */42#ifndef _AIC79XX_LINUX_H_43#define _AIC79XX_LINUX_H_44 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>54#include <asm/io.h>55 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>64 65/* Core SCSI definitions */66#define AIC_LIB_PREFIX ahd67 68#include "cam.h"69#include "queue.h"70#include "scsi_message.h"71#include "scsi_iu.h"72#include "aiclib.h"73 74/*********************************** Debugging ********************************/75#ifdef CONFIG_AIC79XX_DEBUG_ENABLE76#ifdef CONFIG_AIC79XX_DEBUG_MASK77#define AHD_DEBUG 178#define AHD_DEBUG_OPTS CONFIG_AIC79XX_DEBUG_MASK79#else80/*81 * Compile in debugging code, but do not enable any printfs.82 */83#define AHD_DEBUG 184#define AHD_DEBUG_OPTS 085#endif86/* No debugging code. */87#endif88 89/********************************** Misc Macros *******************************/90#define powerof2(x) ((((x)-1)&(x))==0)91 92/************************* Forward Declarations *******************************/93struct ahd_softc;94typedef struct pci_dev *ahd_dev_softc_t;95typedef struct scsi_cmnd *ahd_io_ctx_t;96 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)104 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)111 112/************************* Configuration Data *********************************/113extern uint32_t aic79xx_allow_memio;114extern struct scsi_host_template aic79xx_driver_template;115 116/***************************** Bus Space/DMA **********************************/117 118typedef uint32_t bus_size_t;119 120typedef enum {121 BUS_SPACE_MEMIO,122 BUS_SPACE_PIO123} bus_space_tag_t;124 125typedef union {126 u_long ioport;127 volatile uint8_t __iomem *maddr;128} bus_space_handle_t;129 130typedef struct bus_dma_segment131{132 dma_addr_t ds_addr;133 bus_size_t ds_len;134} bus_dma_segment_t;135 136struct ahd_linux_dma_tag137{138 bus_size_t alignment;139 bus_size_t boundary;140 bus_size_t maxsize;141};142typedef struct ahd_linux_dma_tag* bus_dma_tag_t;143 144typedef dma_addr_t bus_dmamap_t;145 146typedef int bus_dma_filter_t(void*, dma_addr_t);147typedef void bus_dmamap_callback_t(void *, bus_dma_segment_t *, int, int);148 149#define BUS_DMA_WAITOK 0x0150#define BUS_DMA_NOWAIT 0x1151#define BUS_DMA_ALLOCNOW 0x2152#define BUS_DMA_LOAD_SEGS 0x4 /*153 * Argument is an S/G list not154 * a single buffer.155 */156 157#define BUS_SPACE_MAXADDR 0xFFFFFFFF158#define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF159#define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF160 161int 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*/);168 169void ahd_dma_tag_destroy(struct ahd_softc *, bus_dma_tag_t /*tag*/);170 171int ahd_dmamem_alloc(struct ahd_softc *, bus_dma_tag_t /*dmat*/,172 void** /*vaddr*/, int /*flags*/,173 bus_dmamap_t* /*mapp*/);174 175void ahd_dmamem_free(struct ahd_softc *, bus_dma_tag_t /*dmat*/,176 void* /*vaddr*/, bus_dmamap_t /*map*/);177 178void ahd_dmamap_destroy(struct ahd_softc *, bus_dma_tag_t /*tag*/,179 bus_dmamap_t /*map*/);180 181int 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*/);185 186int ahd_dmamap_unload(struct ahd_softc *, bus_dma_tag_t, bus_dmamap_t);187 188/*189 * Operations performed by ahd_dmamap_sync().190 */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 */195 196/*197 * XXX198 * ahd_dmamap_sync is only used on buffers allocated with199 * the dma_alloc_coherent() API. Although I'm not sure how200 * this works on architectures with a write buffer, Linux does201 * not have an API to sync "coherent" memory. Perhaps we need202 * to do an mb()?203 */204#define ahd_dmamap_sync(ahd, dma_tag, dmamap, offset, len, op)205 206/********************************** Includes **********************************/207#ifdef CONFIG_AIC79XX_REG_PRETTY_PRINT208#define AIC_DEBUG_REGISTERS 1209#else210#define AIC_DEBUG_REGISTERS 0211#endif212#include "aic79xx.h"213 214/***************************** SMP support ************************************/215#include <linux/spinlock.h>216 217#define AIC79XX_DRIVER_VERSION "3.0"218 219/*************************** Device Data Structures ***************************/220/*221 * A per probed device structure used to deal with some error recovery222 * scenarios that the Linux mid-layer code just doesn't know how to223 * handle. The structure allocated for a device only becomes persistent224 * after a successfully completed inquiry command to the target when225 * that inquiry data indicates a lun is present.226 */227 228typedef enum {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;234 235struct ahd_linux_device {236 TAILQ_ENTRY(ahd_linux_device) links;237 238 /*239 * The number of transactions currently240 * queued to the device.241 */242 int active;243 244 /*245 * The currently allowed number of246 * transactions that can be queued to247 * the device. Must be signed for248 * conversion from tagged to untagged249 * mode where the device may have more250 * than one outstanding active transaction.251 */252 int openings;253 254 /*255 * A positive count indicates that this256 * device's queue is halted.257 */258 u_int qfrozen;259 260 /*261 * Cumulative command counter.262 */263 u_long commands_issued;264 265 /*266 * The number of tagged transactions when267 * running at our current opening level268 * that have been successfully received by269 * this device since the last QUEUE FULL.270 */271 u_int tag_success_count;272#define AHD_TAG_SUCCESS_INTERVAL 50273 274 ahd_linux_dev_flags flags;275 276 /*277 * Per device timer.278 */279 struct timer_list timer;280 281 /*282 * The high limit for the tags variable.283 */284 u_int maxtags;285 286 /*287 * The computed number of tags outstanding288 * at the time of the last QUEUE FULL event.289 */290 u_int tags_on_last_queuefull;291 292 /*293 * How many times we have seen a queue full294 * with the same number of tags. This is used295 * to stop our adaptive queue depth algorithm296 * on devices with a fixed number of tags.297 */298 u_int last_queuefull_same_count;299#define AHD_LOCK_TAGS_COUNT 50300 301 /*302 * How many transactions have been queued303 * without the device going idle. We use304 * this statistic to determine when to issue305 * an ordered tag to prevent transaction306 * starvation. This statistic is only updated307 * if the AHD_DEV_PERIODIC_OTAG flag is set308 * on this device.309 */310 u_int commands_since_idle_or_otag;311#define AHD_OTAG_THRESH 500312};313 314/********************* Definitions Required by the Core ***********************/315/*316 * Number of SG segments we require. So long as the S/G segments for317 * a particular transaction are allocated in a physically contiguous318 * manner and are allocated below 4GB, the number of S/G segments is319 * unrestricted.320 */321#define AHD_NSEG 128322 323/*324 * Per-SCB OSM storage.325 */326struct scb_platform_data {327 struct ahd_linux_device *dev;328 dma_addr_t buf_busaddr;329 uint32_t xfer_len;330 uint32_t sense_resid; /* Auto-Sense residual */331};332 333/*334 * Define a structure used for each host adapter. All members are335 * aligned on a boundary >= the size of the member to honor the336 * alignment restrictions of the various platforms supported by337 * this driver.338 */339struct ahd_platform_data {340 /*341 * Fields accessed from interrupt context.342 */343 struct scsi_target *starget[AHD_NUM_TARGETS];344 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 */352};353 354void ahd_delay(long);355 356/***************************** Low Level I/O **********************************/357uint8_t ahd_inb(struct ahd_softc * ahd, long port);358void ahd_outb(struct ahd_softc * ahd, long port, uint8_t val);359void ahd_outw_atomic(struct ahd_softc * ahd,360 long port, uint16_t val);361void ahd_outsb(struct ahd_softc * ahd, long port,362 uint8_t *, int count);363void ahd_insb(struct ahd_softc * ahd, long port,364 uint8_t *, int count);365 366/**************************** Initialization **********************************/367int ahd_linux_register_host(struct ahd_softc *,368 struct scsi_host_template *);369 370/******************************** Locking *************************************/371static inline void372ahd_lockinit(struct ahd_softc *ahd)373{374 spin_lock_init(&ahd->platform_data->spin_lock);375}376 377static inline void378ahd_lock(struct ahd_softc *ahd, unsigned long *flags)379{380 spin_lock_irqsave(&ahd->platform_data->spin_lock, *flags);381}382 383static inline void384ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)385{386 spin_unlock_irqrestore(&ahd->platform_data->spin_lock, *flags);387}388 389/******************************* PCI Definitions ******************************/390/*391 * PCIM_xxx: mask to locate subfield in register392 * PCIR_xxx: config register offset393 * PCIC_xxx: device class394 * PCIS_xxx: device subclass395 * PCIP_xxx: device programming interface396 * PCIV_xxx: PCI vendor ID (only required to fixup ancient devices)397 * PCID_xxx: device ID398 */399#define PCIR_DEVVENDOR 0x00400#define PCIR_VENDOR 0x00401#define PCIR_DEVICE 0x02402#define PCIR_COMMAND 0x04403#define PCIM_CMD_PORTEN 0x0001404#define PCIM_CMD_MEMEN 0x0002405#define PCIM_CMD_BUSMASTEREN 0x0004406#define PCIM_CMD_MWRICEN 0x0010407#define PCIM_CMD_PERRESPEN 0x0040408#define PCIM_CMD_SERRESPEN 0x0100409#define PCIR_STATUS 0x06410#define PCIR_REVID 0x08411#define PCIR_PROGIF 0x09412#define PCIR_SUBCLASS 0x0a413#define PCIR_CLASS 0x0b414#define PCIR_CACHELNSZ 0x0c415#define PCIR_LATTIMER 0x0d416#define PCIR_HEADERTYPE 0x0e417#define PCIM_MFDEV 0x80418#define PCIR_BIST 0x0f419#define PCIR_CAP_PTR 0x34420 421/* config registers for header type 0 devices */422#define PCIR_MAPS 0x10423 424/****************************** PCI-X definitions *****************************/425#define PCIXR_COMMAND 0x96426#define PCIXR_DEVADDR 0x98427#define PCIXM_DEVADDR_FNUM 0x0003 /* Function Number */428#define PCIXM_DEVADDR_DNUM 0x00F8 /* Device Number */429#define PCIXM_DEVADDR_BNUM 0xFF00 /* Bus Number */430#define PCIXR_STATUS 0x9A431#define PCIXM_STATUS_64BIT 0x0001 /* Active 64bit connection to device. */432#define PCIXM_STATUS_133CAP 0x0002 /* Device is 133MHz capable */433#define PCIXM_STATUS_SCDISC 0x0004 /* Split Completion Discarded */434#define PCIXM_STATUS_UNEXPSC 0x0008 /* Unexpected Split Completion */435#define PCIXM_STATUS_CMPLEXDEV 0x0010 /* Device Complexity (set == bridge) */436#define PCIXM_STATUS_MAXMRDBC 0x0060 /* Maximum Burst Read Count */437#define PCIXM_STATUS_MAXSPLITS 0x0380 /* Maximum Split Transactions */438#define PCIXM_STATUS_MAXCRDS 0x1C00 /* Maximum Cumulative Read Size */439#define PCIXM_STATUS_RCVDSCEM 0x2000 /* Received a Split Comp w/Error msg */440 441typedef enum442{443 AHD_POWER_STATE_D0,444 AHD_POWER_STATE_D1,445 AHD_POWER_STATE_D2,446 AHD_POWER_STATE_D3447} ahd_power_state;448 449void ahd_power_state_change(struct ahd_softc *ahd,450 ahd_power_state new_state);451 452/******************************* PCI Routines *********************************/453int ahd_linux_pci_init(void);454void ahd_linux_pci_exit(void);455int ahd_pci_map_registers(struct ahd_softc *ahd);456int ahd_pci_map_int(struct ahd_softc *ahd);457 458uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,459 int reg, int width);460void ahd_pci_write_config(ahd_dev_softc_t pci,461 int reg, uint32_t value,462 int width);463 464static inline int ahd_get_pci_function(ahd_dev_softc_t);465static inline int466ahd_get_pci_function(ahd_dev_softc_t pci)467{468 return (PCI_FUNC(pci->devfn));469}470 471static inline int ahd_get_pci_slot(ahd_dev_softc_t);472static inline int473ahd_get_pci_slot(ahd_dev_softc_t pci)474{475 return (PCI_SLOT(pci->devfn));476}477 478static inline int ahd_get_pci_bus(ahd_dev_softc_t);479static inline int480ahd_get_pci_bus(ahd_dev_softc_t pci)481{482 return (pci->bus->number);483}484 485static inline void ahd_flush_device_writes(struct ahd_softc *);486static inline void487ahd_flush_device_writes(struct ahd_softc *ahd)488{489 /* XXX Is this sufficient for all architectures??? */490 ahd_inb(ahd, INTSTAT);491}492 493/**************************** Proc FS Support *********************************/494int ahd_proc_write_seeprom(struct Scsi_Host *, char *, int);495int ahd_linux_show_info(struct seq_file *,struct Scsi_Host *);496 497/*********************** Transaction Access Wrappers **************************/498 499static inline500void ahd_cmd_set_transaction_status(struct scsi_cmnd *cmd, uint32_t status)501{502 cmd->result &= ~(CAM_STATUS_MASK << 16);503 cmd->result |= status << 16;504}505 506static inline507void ahd_set_transaction_status(struct scb *scb, uint32_t status)508{509 ahd_cmd_set_transaction_status(scb->io_ctx,status);510}511 512static inline513void ahd_cmd_set_scsi_status(struct scsi_cmnd *cmd, uint32_t status)514{515 cmd->result &= ~0xFFFF;516 cmd->result |= status;517}518 519static inline520void ahd_set_scsi_status(struct scb *scb, uint32_t status)521{522 ahd_cmd_set_scsi_status(scb->io_ctx, status);523}524 525static inline526uint32_t ahd_cmd_get_transaction_status(struct scsi_cmnd *cmd)527{528 return ((cmd->result >> 16) & CAM_STATUS_MASK);529}530 531static inline532uint32_t ahd_get_transaction_status(struct scb *scb)533{534 return (ahd_cmd_get_transaction_status(scb->io_ctx));535}536 537static inline538uint32_t ahd_cmd_get_scsi_status(struct scsi_cmnd *cmd)539{540 return (cmd->result & 0xFFFF);541}542 543static inline544uint32_t ahd_get_scsi_status(struct scb *scb)545{546 return (ahd_cmd_get_scsi_status(scb->io_ctx));547}548 549static inline550void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)551{552 /*553 * Nothing to do for linux as the incoming transaction554 * has no concept of tag/non tagged, etc.555 */556}557 558static inline559u_long ahd_get_transfer_length(struct scb *scb)560{561 return (scb->platform_data->xfer_len);562}563 564static inline565int ahd_get_transfer_dir(struct scb *scb)566{567 return (scb->io_ctx->sc_data_direction);568}569 570static inline571void ahd_set_residual(struct scb *scb, u_long resid)572{573 scsi_set_resid(scb->io_ctx, resid);574}575 576static inline577void ahd_set_sense_residual(struct scb *scb, u_long resid)578{579 scb->platform_data->sense_resid = resid;580}581 582static inline583u_long ahd_get_residual(struct scb *scb)584{585 return scsi_get_resid(scb->io_ctx);586}587 588static inline589u_long ahd_get_sense_residual(struct scb *scb)590{591 return (scb->platform_data->sense_resid);592}593 594static inline595int ahd_perform_autosense(struct scb *scb)596{597 /*598 * We always perform autosense in Linux.599 * On other platforms this is set on a600 * per-transaction basis.601 */602 return (1);603}604 605static inline uint32_t606ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)607{608 return (sizeof(struct scsi_sense_data));609}610 611static inline void612ahd_notify_xfer_settings_change(struct ahd_softc *ahd,613 struct ahd_devinfo *devinfo)614{615 /* Nothing to do here for linux */616}617 618static inline void619ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)620{621 ahd->flags &= ~AHD_RESOURCE_SHORTAGE;622}623 624int ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);625void ahd_platform_free(struct ahd_softc *ahd);626void ahd_platform_init(struct ahd_softc *ahd);627void ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb);628 629static inline void630ahd_freeze_scb(struct scb *scb)631{632 if ((scb->io_ctx->result & (CAM_DEV_QFRZN << 16)) == 0) {633 scb->io_ctx->result |= CAM_DEV_QFRZN << 16;634 scb->platform_data->dev->qfrozen++;635 }636}637 638void ahd_platform_set_tags(struct ahd_softc *ahd, struct scsi_device *sdev,639 struct ahd_devinfo *devinfo, ahd_queue_alg);640int ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,641 char channel, int lun, u_int tag,642 role_t role, uint32_t status);643irqreturn_t644 ahd_linux_isr(int irq, void *dev_id);645void ahd_done(struct ahd_softc*, struct scb*);646void ahd_send_async(struct ahd_softc *, char channel,647 u_int target, u_int lun, ac_code);648void ahd_print_path(struct ahd_softc *, struct scb *);649 650#ifdef CONFIG_PCI651#define AHD_PCI_CONFIG 1652#else653#define AHD_PCI_CONFIG 0654#endif655#define bootverbose aic79xx_verbose656extern uint32_t aic79xx_verbose;657 658#endif /* _AIC79XX_LINUX_H_ */659