aic79xx_openbsd.h revision 1.8
1/* $OpenBSD: aic79xx_openbsd.h,v 1.8 2004/11/18 01:33:28 krw Exp $ */ 2 3/* 4 * Copyright (c) 2004 Milos Urbanek, Kenneth R. Westerback & Marco Peereboom 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 */ 29 30/* 31 * FreeBSD platform specific driver option settings, data structures, 32 * function declarations and includes. 33 * 34 * Copyright (c) 1994-2001 Justin T. Gibbs. 35 * Copyright (c) 2001-2002 Adaptec Inc. 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions, and the following disclaimer, 43 * without modification. 44 * 2. The name of the author may not be used to endorse or promote products 45 * derived from this software without specific prior written permission. 46 * 47 * Alternatively, this software may be distributed under the terms of the 48 * GNU Public License ("GPL"). 49 * 50 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 53 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 54 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 60 * SUCH DAMAGE. 61 * 62 * $FreeBSD: src/sys/dev/aic7xxx/aic79xx_osm.h,v 1.13 2003/12/17 00:02:09 gibbs Exp $ 63 * 64 */ 65 66#ifndef _AIC79XX_OPENBSD_H_ 67#define _AIC79XX_OPENBSD_H_ 68 69#include "pci.h" /* for config options */ 70 71#include <sys/param.h> 72#include <sys/kernel.h> 73#include <sys/systm.h> 74#include <sys/device.h> 75#include <sys/malloc.h> 76#include <sys/buf.h> 77#include <sys/proc.h> 78#include <sys/queue.h> 79 80#define AIC_PCI_CONFIG 1 81#include <dev/pci/pcireg.h> 82#include <dev/pci/pcivar.h> 83 84#include <machine/bus.h> 85#include <machine/intr.h> 86 87#include <scsi/scsi_all.h> 88#include <scsi/scsi_message.h> 89#include <scsi/scsi_debug.h> 90#include <scsi/scsiconf.h> 91 92#include <uvm/uvm_extern.h> 93 94#ifdef DEBUG 95#define bootverbose 1 96#else 97#define bootverbose 0 98#endif 99/****************************** Platform Macros *******************************/ 100#define SCSI_IS_SCSIBUS_B(ahd, sc_link) \ 101 (0) 102#define SCSI_CHANNEL(ahd, sc_link) \ 103 ('A') 104#define SCSI_SCSI_ID(ahd, sc_link) \ 105 (ahd->our_id) 106#define BUILD_SCSIID(ahd, sc_link, target_id, our_id) \ 107 ((((target_id) << TID_SHIFT) & TID) | (our_id)) 108 109#ifndef offsetof 110#define offsetof(type, member) ((size_t)(&((type *)0)->member)) 111#endif 112 113/************************* Forward Declarations *******************************/ 114typedef struct pci_attach_args * ahd_dev_softc_t; 115 116/***************************** Bus Space/DMA **********************************/ 117 118/* XXX Need to update Bus DMA for partial map syncs */ 119#define ahd_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op) \ 120 bus_dmamap_sync(dma_tag, dmamap, offset, len, op) 121 122/************************ Tunable Driver Parameters **************************/ 123/* 124 * The number of dma segments supported. The sequencer can handle any number 125 * of physically contiguous S/G entrys. To reduce the driver's memory 126 * consumption, we limit the number supported to be sufficient to handle 127 * the largest mapping supported by the kernel, MAXPHYS. Assuming the 128 * transfer is as fragmented as possible and unaligned, this turns out to 129 * be the number of paged sized transfers in MAXPHYS plus an extra element 130 * to handle any unaligned residual. The sequencer fetches SG elements 131 * in cacheline sized chucks, so make the number per-transaction an even 132 * multiple of 16 which should align us on even the largest of cacheline 133 * boundaries. 134 */ 135#define AHD_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) 136 137/* This driver supports target mode */ 138// #define AHD_TARGET_MODE 1 139 140/************************** Softc/SCB Platform Data ***************************/ 141struct ahd_platform_data { 142}; 143 144struct scb_platform_data { 145}; 146 147/************************** Timer DataStructures ******************************/ 148typedef struct timeout ahd_timer_t; 149 150/***************************** Core Includes **********************************/ 151 152#if AHD_REG_PRETTY_PRINT 153#define AIC_DEBUG_REGISTERS 1 154#else 155#define AIC_DEBUG_REGISTERS 0 156#endif 157#include <dev/ic/aic79xx.h> 158 159/***************************** Timer Facilities *******************************/ 160void ahd_timeout(void*); 161void ahd_timer_reset(ahd_timer_t *, u_int, ahd_callback_t *, void *); 162void ahd_scb_timer_reset(struct scb *, u_int); 163 164#define ahd_timer_init callout_init 165#define ahd_timer_stop callout_stop 166 167/*************************** Device Access ************************************/ 168#define ahd_inb(ahd, port) \ 169 bus_space_read_1((ahd)->tags[(port) >> 8], \ 170 (ahd)->bshs[(port) >> 8], (port) & 0xFF) 171 172#define ahd_outb(ahd, port, value) \ 173 bus_space_write_1((ahd)->tags[(port) >> 8], \ 174 (ahd)->bshs[(port) >> 8], (port) & 0xFF, value) 175 176#define ahd_inw_atomic(ahd, port) \ 177 aic_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8], \ 178 (ahd)->bshs[(port) >> 8], (port) & 0xFF)) 179 180#define ahd_outw_atomic(ahd, port, value) \ 181 bus_space_write_2((ahd)->tags[(port) >> 8], \ 182 (ahd)->bshs[(port) >> 8], \ 183 (port & 0xFF), aic_htole16(value)) 184 185#define ahd_outsb(ahd, port, valp, count) \ 186 bus_space_write_multi_1((ahd)->tags[(port) >> 8], \ 187 (ahd)->bshs[(port) >> 8], \ 188 (port & 0xFF), valp, count) 189 190#define ahd_insb(ahd, port, valp, count) \ 191 bus_space_read_multi_1((ahd)->tags[(port) >> 8], \ 192 (ahd)->bshs[(port) >> 8], \ 193 (port & 0xFF), valp, count) 194 195void ahd_flush_device_writes(struct ahd_softc *); 196 197/**************************** Locking Primitives ******************************/ 198/* Lock protecting internal data structures */ 199void ahd_lockinit(struct ahd_softc *); 200void ahd_lock(struct ahd_softc *, int *flags); 201void ahd_unlock(struct ahd_softc *, int *flags); 202 203/* Lock held during command compeletion to the upper layer */ 204void ahd_done_lockinit(struct ahd_softc *); 205void ahd_done_lock(struct ahd_softc *, int *flags); 206void ahd_done_unlock(struct ahd_softc *, int *flags); 207 208/* Lock held during ahd_list manipulation and ahd softc frees */ 209void ahd_list_lockinit(void); 210void ahd_list_lock(int *flags); 211void ahd_list_unlock(int *flags); 212 213/****************************** OS Primitives *********************************/ 214 215/************************** Transaction Operations ****************************/ 216void ahd_set_transaction_status(struct scb *, uint32_t); 217void ahd_set_scsi_status(struct scb *, uint32_t); 218uint32_t ahd_get_transaction_status(struct scb *); 219uint32_t ahd_get_scsi_status(struct scb *); 220void ahd_set_transaction_tag(struct scb *, int, u_int); 221u_long ahd_get_transfer_length(struct scb *); 222int ahd_get_transfer_dir(struct scb *); 223void ahd_set_residual(struct scb *, u_long); 224void ahd_set_sense_residual(struct scb *, u_long); 225u_long ahd_get_residual(struct scb *); 226int ahd_perform_autosense(struct scb *); 227uint32_t ahd_get_sense_bufsize(struct ahd_softc*, struct scb*); 228void ahd_freeze_simq(struct ahd_softc *); 229void ahd_release_simq(struct ahd_softc *); 230void ahd_freeze_scb(struct scb *); 231void ahd_platform_freeze_devq(struct ahd_softc *, struct scb *); 232int ahd_platform_abort_scbs(struct ahd_softc *, int, 233 char, int, u_int, role_t, uint32_t); 234void ahd_platform_scb_free(struct ahd_softc *, struct scb *); 235 236/********************************** PCI ***************************************/ 237/*#if AHD_PCI_CONFIG > 0*/ 238int ahd_get_pci_function(ahd_dev_softc_t); 239int ahd_get_pci_slot(ahd_dev_softc_t); 240int ahd_get_pci_bus(ahd_dev_softc_t); 241 242int ahd_pci_map_registers(struct ahd_softc *); 243int ahd_pci_map_int(struct ahd_softc *); 244/*#endif*/ 245 246typedef enum 247{ 248 AHD_POWER_STATE_D0, 249 AHD_POWER_STATE_D1, 250 AHD_POWER_STATE_D2, 251 AHD_POWER_STATE_D3 252} ahd_power_state; 253 254void ahd_power_state_change(struct ahd_softc *, ahd_power_state); 255 256/******************************** VL/EISA *************************************/ 257int aic7770_map_registers(struct ahd_softc *); 258int aic7770_map_int(struct ahd_softc *, int); 259 260/********************************* Debug **************************************/ 261void ahd_print_path(struct ahd_softc *, struct scb *); 262void ahd_platform_dump_card_state(struct ahd_softc *ahd); 263 264/**************************** Transfer Settings *******************************/ 265void ahd_notify_xfer_settings_change(struct ahd_softc *, 266 struct ahd_devinfo *); 267void ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *, 268 ahd_queue_alg); 269 270/************************* Initialization/Teardown ****************************/ 271int ahd_platform_alloc(struct ahd_softc *, void *); 272void ahd_platform_free(struct ahd_softc *); 273int ahd_attach(struct ahd_softc *); 274int ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd); 275int ahd_detach(struct device *, int); 276#define ahd_platform_init 277 278/****************************** Interrupts ************************************/ 279int ahd_platform_intr(void *); 280void ahd_platform_flushwork(struct ahd_softc *ahd); 281/************************ Misc Function Declarations **************************/ 282void ahd_done(struct ahd_softc *, struct scb *); 283void ahd_send_async(struct ahd_softc *, char /*channel*/, 284 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 285/************************ SCSI task management **************************/ 286#define SIU_TASKMGMT_NONE 0x00 287#define SIU_TASKMGMT_ABORT_TASK 0x01 288#define SIU_TASKMGMT_ABORT_TASK_SET 0x02 289#define SIU_TASKMGMT_CLEAR_TASK_SET 0x04 290#define SIU_TASKMGMT_LUN_RESET 0x08 291#define SIU_TASKMGMT_TARGET_RESET 0x20 292#define SIU_TASKMGMT_CLEAR_ACA 0x40 293#endif /* _AIC79XX_OPENBSD_H_ */ 294