1 /*- 2 * FreeBSD platform specific driver option settings, data structures, 3 * function declarations and includes. 4 * 5 * Copyright (c) 1994-2001 Justin T. Gibbs. 6 * Copyright (c) 2001-2002 Adaptec Inc. 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions, and the following disclaimer, 14 * without modification. 15 * 2. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * Alternatively, this software may be distributed under the terms of the 19 * GNU Public License ("GPL"). 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic79xx_osm.h#23 $ 34 */ 35 36 #ifndef _AIC79XX_FREEBSD_H_ 37 #define _AIC79XX_FREEBSD_H_ 38 39 #include "opt_aic79xx.h" /* for config options */ 40 41 #include <sys/param.h> 42 #include <sys/systm.h> 43 #include <sys/bus.h> /* For device_t */ 44 #include <sys/endian.h> 45 #include <sys/eventhandler.h> 46 #include <sys/kernel.h> 47 #include <sys/malloc.h> 48 #include <sys/module.h> 49 #include <sys/queue.h> 50 #include <sys/sysctl.h> 51 52 #define AIC_PCI_CONFIG 1 53 #include <machine/bus.h> 54 #include <machine/endian.h> 55 #include <machine/resource.h> 56 57 #include <sys/rman.h> 58 59 #include <dev/pci/pcireg.h> 60 #include <dev/pci/pcivar.h> 61 62 #include <cam/cam.h> 63 #include <cam/cam_ccb.h> 64 #include <cam/cam_debug.h> 65 #include <cam/cam_sim.h> 66 #include <cam/cam_xpt_sim.h> 67 68 #include <cam/scsi/scsi_all.h> 69 #include <cam/scsi/scsi_message.h> 70 #include <cam/scsi/scsi_iu.h> 71 72 /****************************** Platform Macros *******************************/ 73 #define SIM_IS_SCSIBUS_B(ahd, sim) \ 74 (0) 75 #define SIM_CHANNEL(ahd, sim) \ 76 ('A') 77 #define SIM_SCSI_ID(ahd, sim) \ 78 (ahd->our_id) 79 #define SIM_PATH(ahd, sim) \ 80 (ahd->platform_data->path) 81 #define BUILD_SCSIID(ahd, sim, target_id, our_id) \ 82 ((((target_id) << TID_SHIFT) & TID) | (our_id)) 83 84 85 #define SCB_GET_SIM(ahd, scb) \ 86 ((ahd)->platform_data->sim) 87 88 #ifndef offsetof 89 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 90 #endif 91 92 /************************ Tunable Driver Parameters **************************/ 93 /* 94 * The number of dma segments supported. The sequencer can handle any number 95 * of physically contiguous S/G entrys. To reduce the driver's memory 96 * consumption, we limit the number supported to be sufficient to handle 97 * the largest mapping supported by the legacy kernel MAXPHYS setting of 98 * 128K. This can be increased once some testing is done. Assuming the 99 * transfer is as fragmented as possible and unaligned, this turns out to 100 * be the number of paged sized transfers in MAXPHYS plus an extra element 101 * to handle any unaligned residual. The sequencer fetches SG elements 102 * in cacheline sized chucks, so make the number per-transaction an even 103 * multiple of 16 which should align us on even the largest of cacheline 104 * boundaries. 105 */ 106 #define AHD_MAXPHYS (128 * 1024) 107 #define AHD_NSEG (roundup(btoc(AHD_MAXPHYS) + 1, 16)) 108 109 /* This driver supports target mode */ 110 #ifdef NOT_YET 111 #define AHD_TARGET_MODE 1 112 #endif 113 114 /************************** Softc/SCB Platform Data ***************************/ 115 struct ahd_platform_data { 116 /* 117 * Hooks into the XPT. 118 */ 119 struct cam_sim *sim; 120 struct cam_path *path; 121 122 int regs_res_type[2]; 123 int regs_res_id[2]; 124 int irq_res_type; 125 struct resource *regs[2]; 126 struct resource *irq; 127 void *ih; 128 eventhandler_tag eh; 129 struct proc *recovery_thread; 130 struct mtx mtx; 131 }; 132 133 struct scb_platform_data { 134 }; 135 136 /***************************** Core Includes **********************************/ 137 #ifdef AHD_REG_PRETTY_PRINT 138 #define AIC_DEBUG_REGISTERS 1 139 #else 140 #define AIC_DEBUG_REGISTERS 0 141 #endif 142 #define AIC_CORE_INCLUDE <dev/aic7xxx/aic79xx.h> 143 #define AIC_LIB_PREFIX ahd 144 #define AIC_CONST_PREFIX AHD 145 #include <dev/aic7xxx/aic_osm_lib.h> 146 147 /*************************** Device Access ************************************/ 148 #define ahd_inb(ahd, port) \ 149 bus_space_read_1((ahd)->tags[(port) >> 8], \ 150 (ahd)->bshs[(port) >> 8], (port) & 0xFF) 151 152 #define ahd_outb(ahd, port, value) \ 153 bus_space_write_1((ahd)->tags[(port) >> 8], \ 154 (ahd)->bshs[(port) >> 8], (port) & 0xFF, value) 155 156 #define ahd_inw_atomic(ahd, port) \ 157 aic_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8], \ 158 (ahd)->bshs[(port) >> 8], (port) & 0xFF)) 159 160 #define ahd_outw_atomic(ahd, port, value) \ 161 bus_space_write_2((ahd)->tags[(port) >> 8], \ 162 (ahd)->bshs[(port) >> 8], \ 163 (port & 0xFF), aic_htole16(value)) 164 165 #define ahd_outsb(ahd, port, valp, count) \ 166 bus_space_write_multi_1((ahd)->tags[(port) >> 8], \ 167 (ahd)->bshs[(port) >> 8], \ 168 (port & 0xFF), valp, count) 169 170 #define ahd_insb(ahd, port, valp, count) \ 171 bus_space_read_multi_1((ahd)->tags[(port) >> 8], \ 172 (ahd)->bshs[(port) >> 8], \ 173 (port & 0xFF), valp, count) 174 175 static __inline void ahd_flush_device_writes(struct ahd_softc *); 176 177 static __inline void 178 ahd_flush_device_writes(struct ahd_softc *ahd) 179 { 180 /* XXX Is this sufficient for all architectures??? */ 181 ahd_inb(ahd, INTSTAT); 182 } 183 184 /**************************** Locking Primitives ******************************/ 185 /* Lock protecting internal data structures */ 186 static __inline void ahd_lockinit(struct ahd_softc *); 187 static __inline void ahd_lock(struct ahd_softc *); 188 static __inline void ahd_unlock(struct ahd_softc *); 189 190 static __inline void 191 ahd_lockinit(struct ahd_softc *ahd) 192 { 193 mtx_init(&ahd->platform_data->mtx, "ahd_lock", NULL, MTX_DEF); 194 } 195 196 static __inline void 197 ahd_lock(struct ahd_softc *ahd) 198 { 199 mtx_lock(&ahd->platform_data->mtx); 200 } 201 202 static __inline void 203 ahd_unlock(struct ahd_softc *ahd) 204 { 205 mtx_unlock(&ahd->platform_data->mtx); 206 } 207 208 /********************************** PCI ***************************************/ 209 int ahd_pci_map_registers(struct ahd_softc *ahd); 210 int ahd_pci_map_int(struct ahd_softc *ahd); 211 212 /************************** Transaction Operations ****************************/ 213 static __inline void aic_freeze_simq(struct aic_softc*); 214 static __inline void aic_release_simq(struct aic_softc*); 215 216 static __inline void 217 aic_freeze_simq(struct aic_softc *aic) 218 { 219 xpt_freeze_simq(aic->platform_data->sim, /*count*/1); 220 } 221 222 static __inline void 223 aic_release_simq(struct aic_softc *aic) 224 { 225 xpt_release_simq(aic->platform_data->sim, /*run queue*/TRUE); 226 } 227 /********************************* Debug **************************************/ 228 static __inline void ahd_print_path(struct ahd_softc *, struct scb *); 229 static __inline void ahd_platform_dump_card_state(struct ahd_softc *ahd); 230 231 static __inline void 232 ahd_print_path(struct ahd_softc *ahd, struct scb *scb) 233 { 234 xpt_print_path(scb->io_ctx->ccb_h.path); 235 } 236 237 static __inline void 238 ahd_platform_dump_card_state(struct ahd_softc *ahd) 239 { 240 /* Nothing to do here for FreeBSD */ 241 } 242 /**************************** Transfer Settings *******************************/ 243 void ahd_notify_xfer_settings_change(struct ahd_softc *, 244 struct ahd_devinfo *); 245 void ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *, 246 int /*enable*/); 247 248 /************************* Initialization/Teardown ****************************/ 249 int ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg); 250 void ahd_platform_free(struct ahd_softc *ahd); 251 int ahd_map_int(struct ahd_softc *ahd); 252 int ahd_attach(struct ahd_softc *); 253 int ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd); 254 void ahd_sysctl(struct ahd_softc *ahd); 255 int ahd_detach(device_t); 256 #define ahd_platform_init(arg) 257 258 /****************************** Interrupts ************************************/ 259 void ahd_platform_intr(void *); 260 static __inline void ahd_platform_flushwork(struct ahd_softc *ahd); 261 static __inline void 262 ahd_platform_flushwork(struct ahd_softc *ahd) 263 { 264 } 265 266 /************************ Misc Function Declarations **************************/ 267 void ahd_done(struct ahd_softc *ahd, struct scb *scb); 268 void ahd_send_async(struct ahd_softc *, char /*channel*/, 269 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 270 #endif /* _AIC79XX_FREEBSD_H_ */ 271