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 * $FreeBSD$ 36 */ 37 38 #ifndef _AIC79XX_FREEBSD_H_ 39 #define _AIC79XX_FREEBSD_H_ 40 41 #include <opt_aic79xx.h> /* for config options */ 42 43 #include <sys/param.h> 44 #include <sys/systm.h> 45 #include <sys/bus.h> /* For device_t */ 46 #if __FreeBSD_version >= 500000 47 #include <sys/endian.h> 48 #endif 49 #include <sys/eventhandler.h> 50 #include <sys/kernel.h> 51 #include <sys/malloc.h> 52 #include <sys/module.h> 53 #include <sys/queue.h> 54 55 #define AIC_PCI_CONFIG 1 56 #include <machine/bus.h> 57 #include <machine/endian.h> 58 #include <machine/resource.h> 59 60 #include <sys/rman.h> 61 62 #if __FreeBSD_version >= 500000 63 #include <dev/pci/pcireg.h> 64 #include <dev/pci/pcivar.h> 65 #else 66 #include <pci/pcireg.h> 67 #include <pci/pcivar.h> 68 #endif 69 70 #include <cam/cam.h> 71 #include <cam/cam_ccb.h> 72 #include <cam/cam_debug.h> 73 #include <cam/cam_sim.h> 74 #include <cam/cam_xpt_sim.h> 75 76 #include <cam/scsi/scsi_all.h> 77 #include <cam/scsi/scsi_message.h> 78 #include <cam/scsi/scsi_iu.h> 79 80 /****************************** Platform Macros *******************************/ 81 #define SIM_IS_SCSIBUS_B(ahd, sim) \ 82 (0) 83 #define SIM_CHANNEL(ahd, sim) \ 84 ('A') 85 #define SIM_SCSI_ID(ahd, sim) \ 86 (ahd->our_id) 87 #define SIM_PATH(ahd, sim) \ 88 (ahd->platform_data->path) 89 #define BUILD_SCSIID(ahd, sim, target_id, our_id) \ 90 ((((target_id) << TID_SHIFT) & TID) | (our_id)) 91 92 93 #define SCB_GET_SIM(ahd, scb) \ 94 ((ahd)->platform_data->sim) 95 96 #ifndef offsetof 97 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 98 #endif 99 100 /************************ Tunable Driver Parameters **************************/ 101 /* 102 * The number of dma segments supported. The sequencer can handle any number 103 * of physically contiguous S/G entrys. To reduce the driver's memory 104 * consumption, we limit the number supported to be sufficient to handle 105 * the largest mapping supported by the kernel, MAXPHYS. Assuming the 106 * transfer is as fragmented as possible and unaligned, this turns out to 107 * be the number of paged sized transfers in MAXPHYS plus an extra element 108 * to handle any unaligned residual. The sequencer fetches SG elements 109 * in cacheline sized chucks, so make the number per-transaction an even 110 * multiple of 16 which should align us on even the largest of cacheline 111 * boundaries. 112 */ 113 #define AHD_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) 114 115 /* This driver supports target mode */ 116 #ifdef NOT_YET 117 #define AHD_TARGET_MODE 1 118 #endif 119 120 /************************** Softc/SCB Platform Data ***************************/ 121 struct ahd_platform_data { 122 /* 123 * Hooks into the XPT. 124 */ 125 struct cam_sim *sim; 126 struct cam_path *path; 127 128 int regs_res_type[2]; 129 int regs_res_id[2]; 130 int irq_res_type; 131 struct resource *regs[2]; 132 struct resource *irq; 133 void *ih; 134 eventhandler_tag eh; 135 struct proc *recovery_thread; 136 }; 137 138 struct scb_platform_data { 139 }; 140 141 /***************************** Core Includes **********************************/ 142 #ifdef AHD_REG_PRETTY_PRINT 143 #define AIC_DEBUG_REGISTERS 1 144 #else 145 #define AIC_DEBUG_REGISTERS 0 146 #endif 147 #define AIC_CORE_INCLUDE <dev/aic7xxx/aic79xx.h> 148 #define AIC_LIB_PREFIX ahd 149 #define AIC_CONST_PREFIX AHD 150 #include <dev/aic7xxx/aic_osm_lib.h> 151 152 /*************************** Device Access ************************************/ 153 #define ahd_inb(ahd, port) \ 154 bus_space_read_1((ahd)->tags[(port) >> 8], \ 155 (ahd)->bshs[(port) >> 8], (port) & 0xFF) 156 157 #define ahd_outb(ahd, port, value) \ 158 bus_space_write_1((ahd)->tags[(port) >> 8], \ 159 (ahd)->bshs[(port) >> 8], (port) & 0xFF, value) 160 161 #define ahd_inw_atomic(ahd, port) \ 162 aic_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8], \ 163 (ahd)->bshs[(port) >> 8], (port) & 0xFF)) 164 165 #define ahd_outw_atomic(ahd, port, value) \ 166 bus_space_write_2((ahd)->tags[(port) >> 8], \ 167 (ahd)->bshs[(port) >> 8], \ 168 (port & 0xFF), aic_htole16(value)) 169 170 #define ahd_outsb(ahd, port, valp, count) \ 171 bus_space_write_multi_1((ahd)->tags[(port) >> 8], \ 172 (ahd)->bshs[(port) >> 8], \ 173 (port & 0xFF), valp, count) 174 175 #define ahd_insb(ahd, port, valp, count) \ 176 bus_space_read_multi_1((ahd)->tags[(port) >> 8], \ 177 (ahd)->bshs[(port) >> 8], \ 178 (port & 0xFF), valp, count) 179 180 static __inline void ahd_flush_device_writes(struct ahd_softc *); 181 182 static __inline void 183 ahd_flush_device_writes(struct ahd_softc *ahd) 184 { 185 /* XXX Is this sufficient for all architectures??? */ 186 ahd_inb(ahd, INTSTAT); 187 } 188 189 /**************************** Locking Primitives ******************************/ 190 /* Lock protecting internal data structures */ 191 static __inline void ahd_lockinit(struct ahd_softc *); 192 static __inline void ahd_lock(struct ahd_softc *, unsigned long *flags); 193 static __inline void ahd_unlock(struct ahd_softc *, unsigned long *flags); 194 195 /* Lock held during command compeletion to the upper layer */ 196 static __inline void ahd_done_lockinit(struct ahd_softc *); 197 static __inline void ahd_done_lock(struct ahd_softc *, unsigned long *flags); 198 static __inline void ahd_done_unlock(struct ahd_softc *, unsigned long *flags); 199 200 /* Lock held during ahd_list manipulation and ahd softc frees */ 201 static __inline void ahd_list_lockinit(void); 202 static __inline void ahd_list_lock(unsigned long *flags); 203 static __inline void ahd_list_unlock(unsigned long *flags); 204 205 static __inline void 206 ahd_lockinit(struct ahd_softc *ahd) 207 { 208 } 209 210 static __inline void 211 ahd_lock(struct ahd_softc *ahd, unsigned long *flags) 212 { 213 *flags = splcam(); 214 } 215 216 static __inline void 217 ahd_unlock(struct ahd_softc *ahd, unsigned long *flags) 218 { 219 splx(*flags); 220 } 221 222 /* Lock held during command compeletion to the upper layer */ 223 static __inline void 224 ahd_done_lockinit(struct ahd_softc *ahd) 225 { 226 } 227 228 static __inline void 229 ahd_done_lock(struct ahd_softc *ahd, unsigned long *flags) 230 { 231 } 232 233 static __inline void 234 ahd_done_unlock(struct ahd_softc *ahd, unsigned long *flags) 235 { 236 } 237 238 /* Lock held during ahd_list manipulation and ahd softc frees */ 239 static __inline void 240 ahd_list_lockinit(void) 241 { 242 } 243 244 static __inline void 245 ahd_list_lock(unsigned long *flags) 246 { 247 } 248 249 static __inline void 250 ahd_list_unlock(unsigned long *flags) 251 { 252 } 253 254 /********************************** PCI ***************************************/ 255 int ahd_pci_map_registers(struct ahd_softc *ahd); 256 int ahd_pci_map_int(struct ahd_softc *ahd); 257 258 /************************** Transaction Operations ****************************/ 259 static __inline void aic_freeze_simq(struct aic_softc*); 260 static __inline void aic_release_simq(struct aic_softc*); 261 262 static __inline void 263 aic_freeze_simq(struct aic_softc *aic) 264 { 265 xpt_freeze_simq(aic->platform_data->sim, /*count*/1); 266 } 267 268 static __inline void 269 aic_release_simq(struct aic_softc *aic) 270 { 271 xpt_release_simq(aic->platform_data->sim, /*run queue*/TRUE); 272 } 273 /********************************* Debug **************************************/ 274 static __inline void ahd_print_path(struct ahd_softc *, struct scb *); 275 static __inline void ahd_platform_dump_card_state(struct ahd_softc *ahd); 276 277 static __inline void 278 ahd_print_path(struct ahd_softc *ahd, struct scb *scb) 279 { 280 xpt_print_path(scb->io_ctx->ccb_h.path); 281 } 282 283 static __inline void 284 ahd_platform_dump_card_state(struct ahd_softc *ahd) 285 { 286 /* Nothing to do here for FreeBSD */ 287 } 288 /**************************** Transfer Settings *******************************/ 289 void ahd_notify_xfer_settings_change(struct ahd_softc *, 290 struct ahd_devinfo *); 291 void ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *, 292 int /*enable*/); 293 294 /************************* Initialization/Teardown ****************************/ 295 int ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg); 296 void ahd_platform_free(struct ahd_softc *ahd); 297 int ahd_map_int(struct ahd_softc *ahd); 298 int ahd_attach(struct ahd_softc *); 299 int ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd); 300 int ahd_detach(device_t); 301 #define ahd_platform_init(arg) 302 303 304 /****************************** Interrupts ************************************/ 305 void ahd_platform_intr(void *); 306 static __inline void ahd_platform_flushwork(struct ahd_softc *ahd); 307 static __inline void 308 ahd_platform_flushwork(struct ahd_softc *ahd) 309 { 310 } 311 312 /************************ Misc Function Declarations **************************/ 313 void ahd_done(struct ahd_softc *ahd, struct scb *scb); 314 void ahd_send_async(struct ahd_softc *, char /*channel*/, 315 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 316 #endif /* _AIC79XX_FREEBSD_H_ */ 317