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 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions, and the following disclaimer, 13 * without modification. 14 * 2. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * Alternatively, this software may be distributed under the terms of the 18 * GNU Public License ("GPL"). 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $Id$ 33 * 34 * $FreeBSD$ 35 */ 36 37 #ifndef _AIC7XXX_FREEBSD_H_ 38 #define _AIC7XXX_FREEBSD_H_ 39 40 #include <opt_aic7xxx.h> /* for config options */ 41 #ifndef NPCI 42 #include <pci.h> 43 #endif 44 45 #include <sys/param.h> 46 #include <sys/systm.h> 47 #include <sys/bus.h> /* For device_t */ 48 #include <sys/eventhandler.h> 49 #include <sys/kernel.h> 50 #include <sys/malloc.h> 51 #include <sys/queue.h> 52 53 #if NPCI > 0 54 #define AHC_PCI_CONFIG 1 55 #ifdef AHC_ALLOW_MEMIO 56 #include <machine/bus_memio.h> 57 #endif 58 #endif 59 #include <machine/bus_pio.h> 60 #include <machine/bus.h> 61 #include <machine/clock.h> 62 #include <machine/resource.h> 63 64 #include <sys/rman.h> 65 66 #if NPCI > 0 67 #include <pci/pcireg.h> 68 #include <pci/pcivar.h> 69 #endif 70 71 #include <cam/cam.h> 72 #include <cam/cam_ccb.h> 73 #include <cam/cam_debug.h> 74 #include <cam/cam_sim.h> 75 #include <cam/cam_xpt_sim.h> 76 77 #include <cam/scsi/scsi_all.h> 78 #include <cam/scsi/scsi_message.h> 79 80 #ifdef CAM_NEW_TRAN_CODE 81 #define AHC_NEW_TRAN_SETTINGS 82 #endif /* CAM_NEW_TRAN_CODE */ 83 84 /****************************** Platform Macros *******************************/ 85 #define SIM_IS_SCSIBUS_B(ahc, sim) \ 86 ((sim) == ahc->platform_data->sim_b) 87 #define SIM_CHANNEL(ahc, sim) \ 88 (((sim) == ahc->platform_data->sim_b) ? 'B' : 'A') 89 #define SIM_SCSI_ID(ahc, sim) \ 90 (((sim) == ahc->platform_data->sim_b) ? ahc->our_id_b : ahc->our_id) 91 #define SIM_PATH(ahc, sim) \ 92 (((sim) == ahc->platform_data->sim_b) ? ahc->platform_data->path_b \ 93 : ahc->platform_data->path) 94 #define BUILD_SCSIID(ahc, sim, target_id, our_id) \ 95 ((((target_id) << TID_SHIFT) & TID) | (our_id) \ 96 | (SIM_IS_SCSIBUS_B(ahc, sim) ? TWIN_CHNLB : 0)) 97 98 #define SCB_GET_SIM(ahc, scb) \ 99 (SCB_GET_CHANNEL(ahc, scb) == 'A' ? (ahc)->platform_data->sim \ 100 : (ahc)->platform_data->sim_b) 101 102 #ifndef offsetof 103 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 104 #endif 105 /************************* Forward Declarations *******************************/ 106 typedef device_t ahc_dev_softc_t; 107 typedef union ccb *ahc_io_ctx_t; 108 109 /***************************** Bus Space/DMA **********************************/ 110 #define ahc_dma_tag_create(ahc, parent_tag, alignment, boundary, \ 111 lowaddr, highaddr, filter, filterarg, \ 112 maxsize, nsegments, maxsegsz, flags, \ 113 dma_tagp) \ 114 bus_dma_tag_create(parent_tag, alignment, boundary, \ 115 lowaddr, highaddr, filter, filterarg, \ 116 maxsize, nsegments, maxsegsz, flags, \ 117 dma_tagp) 118 119 #define ahc_dma_tag_destroy(ahc, tag) \ 120 bus_dma_tag_destroy(tag) 121 122 #define ahc_dmamem_alloc(ahc, dmat, vaddr, flags, mapp) \ 123 bus_dmamem_alloc(dmat, vaddr, flags, mapp) 124 125 #define ahc_dmamem_free(ahc, dmat, vaddr, map) \ 126 bus_dmamem_free(dmat, vaddr, map) 127 128 #define ahc_dmamap_create(ahc, tag, flags, mapp) \ 129 bus_dmamap_create(tag, flags, mapp) 130 131 #define ahc_dmamap_destroy(ahc, tag, map) \ 132 bus_dmamap_destroy(tag, map) 133 134 #define ahc_dmamap_load(ahc, dmat, map, addr, buflen, callback, \ 135 callback_arg, flags) \ 136 bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags) 137 138 #define ahc_dmamap_unload(ahc, tag, map) \ 139 bus_dmamap_unload(tag, map) 140 141 #define ahc_dmamap_sync(ahc, dma_tag, dmamap, op) \ 142 bus_dmamap_sync(dma_tag_dmamap, op) 143 144 /************************ Tunable Driver Parameters **************************/ 145 /* 146 * The number of dma segments supported. The sequencer can handle any number 147 * of physically contiguous S/G entrys. To reduce the driver's memory 148 * consumption, we limit the number supported to be sufficient to handle 149 * the largest mapping supported by the kernel, MAXPHYS. Assuming the 150 * transfer is as fragmented as possible and unaligned, this turns out to 151 * be the number of paged sized transfers in MAXPHYS plus an extra element 152 * to handle any unaligned residual. The sequencer fetches SG elements 153 * in cacheline sized chucks, so make the number per-transaction an even 154 * multiple of 16 which should align us on even the largest of cacheline 155 * boundaries. 156 */ 157 #define AHC_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) 158 159 /* This driver supports target mode */ 160 #define AHC_TARGET_MODE 1 161 162 /************************** Softc/SCB Platform Data ***************************/ 163 struct ahc_platform_data { 164 /* 165 * Hooks into the XPT. 166 */ 167 struct cam_sim *sim; 168 struct cam_sim *sim_b; 169 struct cam_path *path; 170 struct cam_path *path_b; 171 172 int regs_res_type; 173 int regs_res_id; 174 int irq_res_type; 175 struct resource *regs; 176 struct resource *irq; 177 void *ih; 178 eventhandler_tag eh; 179 }; 180 181 struct scb_platform_data { 182 }; 183 184 /********************************* Byte Order *********************************/ 185 /* 186 * XXX Waiting for FreeBSD byte swapping functions. 187 * For now assume host is Little Endian. 188 */ 189 #define ahc_htobe16(x) x 190 #define ahc_htobe32(x) x 191 #define ahc_htobe64(x) x 192 #define ahc_htole16(x) x 193 #define ahc_htole32(x) x 194 #define ahc_htole64(x) x 195 196 #define ahc_be16toh(x) x 197 #define ahc_be32toh(x) x 198 #define ahc_be64toh(x) x 199 #define ahc_le16toh(x) x 200 #define ahc_le32toh(x) x 201 #define ahc_le64toh(x) x 202 203 /***************************** Core Includes **********************************/ 204 #include <dev/aic7xxx/aic7xxx.h> 205 206 /*************************** Device Access ************************************/ 207 #define ahc_inb(ahc, port) \ 208 bus_space_read_1((ahc)->tag, (ahc)->bsh, port) 209 210 #define ahc_outb(ahc, port, value) \ 211 bus_space_write_1((ahc)->tag, (ahc)->bsh, port, value) 212 213 #define ahc_outsb(ahc, port, valp, count) \ 214 bus_space_write_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) 215 216 #define ahc_insb(ahc, port, valp, count) \ 217 bus_space_read_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) 218 219 static __inline void ahc_flush_device_writes(struct ahc_softc *); 220 221 static __inline void 222 ahc_flush_device_writes(struct ahc_softc *ahc) 223 { 224 /* XXX Is this sufficient for all architectures??? */ 225 ahc_inb(ahc, INTSTAT); 226 } 227 228 /**************************** Locking Primitives ******************************/ 229 /* Lock protecting internal data structures */ 230 static __inline void ahc_lockinit(struct ahc_softc *); 231 static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags); 232 static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags); 233 234 /* Lock held during command compeletion to the upper layer */ 235 static __inline void ahc_done_lockinit(struct ahc_softc *); 236 static __inline void ahc_done_lock(struct ahc_softc *, unsigned long *flags); 237 static __inline void ahc_done_unlock(struct ahc_softc *, unsigned long *flags); 238 239 static __inline void 240 ahc_lockinit(struct ahc_softc *ahc) 241 { 242 } 243 244 static __inline void 245 ahc_lock(struct ahc_softc *ahc, unsigned long *flags) 246 { 247 *flags = splcam(); 248 } 249 250 static __inline void 251 ahc_unlock(struct ahc_softc *ahc, unsigned long *flags) 252 { 253 splx(*flags); 254 } 255 256 /* Lock held during command compeletion to the upper layer */ 257 static __inline void 258 ahc_done_lockinit(struct ahc_softc *ahc) 259 { 260 } 261 262 static __inline void 263 ahc_done_lock(struct ahc_softc *ahc, unsigned long *flags) 264 { 265 } 266 267 static __inline void 268 ahc_done_unlock(struct ahc_softc *ahc, unsigned long *flags) 269 { 270 } 271 272 /****************************** OS Primitives *********************************/ 273 #define ahc_delay DELAY 274 275 /************************** Transaction Operations ****************************/ 276 static __inline void ahc_set_transaction_status(struct scb *, uint32_t); 277 static __inline void ahc_set_scsi_status(struct scb *, uint32_t); 278 static __inline uint32_t ahc_get_transaction_status(struct scb *); 279 static __inline uint32_t ahc_get_scsi_status(struct scb *); 280 static __inline void ahc_set_transaction_tag(struct scb *, int, u_int); 281 static __inline u_long ahc_get_transfer_length(struct scb *); 282 static __inline int ahc_get_transfer_dir(struct scb *); 283 static __inline void ahc_set_residual(struct scb *, u_long); 284 static __inline void ahc_set_sense_residual(struct scb *, u_long); 285 static __inline u_long ahc_get_residual(struct scb *); 286 static __inline int ahc_perform_autosense(struct scb *); 287 static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc*, struct scb*); 288 static __inline void ahc_freeze_ccb(union ccb *ccb); 289 static __inline void ahc_freeze_scb(struct scb *scb); 290 static __inline void ahc_platform_freeze_devq(struct ahc_softc *, struct scb *); 291 static __inline int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, 292 char channel, int lun, u_int tag, 293 role_t role, uint32_t status); 294 295 static __inline 296 void ahc_set_transaction_status(struct scb *scb, uint32_t status) 297 { 298 scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK; 299 scb->io_ctx->ccb_h.status |= status; 300 } 301 302 static __inline 303 void ahc_set_scsi_status(struct scb *scb, uint32_t status) 304 { 305 scb->io_ctx->csio.scsi_status = status; 306 } 307 308 static __inline 309 uint32_t ahc_get_transaction_status(struct scb *scb) 310 { 311 return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK); 312 } 313 314 static __inline 315 uint32_t ahc_get_scsi_status(struct scb *scb) 316 { 317 return (scb->io_ctx->csio.scsi_status); 318 } 319 320 static __inline 321 void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type) 322 { 323 scb->io_ctx->csio.tag_action = type; 324 if (enabled) 325 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID; 326 else 327 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID; 328 } 329 330 static __inline 331 u_long ahc_get_transfer_length(struct scb *scb) 332 { 333 return (scb->io_ctx->csio.dxfer_len); 334 } 335 336 static __inline 337 int ahc_get_transfer_dir(struct scb *scb) 338 { 339 return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK); 340 } 341 342 static __inline 343 void ahc_set_residual(struct scb *scb, u_long resid) 344 { 345 scb->io_ctx->csio.resid = resid; 346 } 347 348 static __inline 349 void ahc_set_sense_residual(struct scb *scb, u_long resid) 350 { 351 scb->io_ctx->csio.sense_resid = resid; 352 } 353 354 static __inline 355 u_long ahc_get_residual(struct scb *scb) 356 { 357 return (scb->io_ctx->csio.resid); 358 } 359 360 static __inline 361 int ahc_perform_autosense(struct scb *scb) 362 { 363 return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE)); 364 } 365 366 static __inline uint32_t 367 ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb) 368 { 369 return (sizeof(struct scsi_sense_data)); 370 } 371 372 static __inline void 373 ahc_freeze_ccb(union ccb *ccb) 374 { 375 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) { 376 ccb->ccb_h.status |= CAM_DEV_QFRZN; 377 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1); 378 } 379 } 380 381 static __inline void 382 ahc_freeze_scb(struct scb *scb) 383 { 384 ahc_freeze_ccb(scb->io_ctx); 385 } 386 387 static __inline void 388 ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb) 389 { 390 /* Nothing to do here for FreeBSD */ 391 } 392 393 static __inline int 394 ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, 395 char channel, int lun, u_int tag, 396 role_t role, uint32_t status) 397 { 398 /* Nothing to do here for FreeBSD */ 399 return (0); 400 } 401 402 static __inline void 403 ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb) 404 { 405 /* What do we do to generically handle driver resource shortages??? */ 406 if ((ahc->flags & AHC_RESOURCE_SHORTAGE) != 0 407 && scb->io_ctx != NULL 408 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) { 409 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ; 410 ahc->flags &= ~AHC_RESOURCE_SHORTAGE; 411 } 412 scb->io_ctx = NULL; 413 } 414 415 /********************************** PCI ***************************************/ 416 #ifdef AHC_PCI_CONFIG 417 static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci, 418 int reg, int width); 419 static __inline void ahc_pci_write_config(ahc_dev_softc_t pci, 420 int reg, uint32_t value, 421 int width); 422 static __inline int ahc_get_pci_function(ahc_dev_softc_t); 423 static __inline int ahc_get_pci_slot(ahc_dev_softc_t); 424 static __inline int ahc_get_pci_bus(ahc_dev_softc_t); 425 426 int ahc_pci_map_registers(struct ahc_softc *ahc); 427 int ahc_pci_map_int(struct ahc_softc *ahc); 428 429 static __inline uint32_t 430 ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width) 431 { 432 return (pci_read_config(pci, reg, width)); 433 } 434 435 static __inline void 436 ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width) 437 { 438 pci_write_config(pci, reg, value, width); 439 } 440 441 static __inline int 442 ahc_get_pci_function(ahc_dev_softc_t pci) 443 { 444 return (pci_get_function(pci)); 445 } 446 447 static __inline int 448 ahc_get_pci_slot(ahc_dev_softc_t pci) 449 { 450 return (pci_get_slot(pci)); 451 } 452 453 static __inline int 454 ahc_get_pci_bus(ahc_dev_softc_t pci) 455 { 456 return (pci_get_bus(pci)); 457 } 458 459 typedef enum 460 { 461 AHC_POWER_STATE_D0, 462 AHC_POWER_STATE_D1, 463 AHC_POWER_STATE_D2, 464 AHC_POWER_STATE_D3 465 } ahc_power_state; 466 467 void ahc_power_state_change(struct ahc_softc *ahc, 468 ahc_power_state new_state); 469 #endif 470 /******************************** VL/EISA *************************************/ 471 int aic7770_map_registers(struct ahc_softc *ahc); 472 int aic7770_map_int(struct ahc_softc *ahc, int irq); 473 474 /********************************* Debug **************************************/ 475 static __inline void ahc_print_path(struct ahc_softc *, struct scb *); 476 static __inline void ahc_platform_dump_card_state(struct ahc_softc *ahc); 477 478 static __inline void 479 ahc_print_path(struct ahc_softc *ahc, struct scb *scb) 480 { 481 xpt_print_path(scb->io_ctx->ccb_h.path); 482 } 483 484 static __inline void 485 ahc_platform_dump_card_state(struct ahc_softc *ahc) 486 { 487 /* Nothing to do here for FreeBSD */ 488 } 489 /**************************** Transfer Settings *******************************/ 490 void ahc_notify_xfer_settings_change(struct ahc_softc *, 491 struct ahc_devinfo *); 492 void ahc_platform_set_tags(struct ahc_softc *, struct ahc_devinfo *, 493 int /*enable*/); 494 495 /************************* Initialization/Teardown ****************************/ 496 int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg); 497 void ahc_platform_free(struct ahc_softc *ahc); 498 int ahc_attach(struct ahc_softc *); 499 int ahc_softc_comp(struct ahc_softc *lahc, struct ahc_softc *rahc); 500 int ahc_detach(device_t); 501 502 /****************************** Interrupts ************************************/ 503 void ahc_platform_intr(void *); 504 static __inline void ahc_platform_flushwork(struct ahc_softc *ahc); 505 static __inline void 506 ahc_platform_flushwork(struct ahc_softc *ahc) 507 { 508 } 509 510 /************************ Misc Function Declarations **************************/ 511 timeout_t ahc_timeout; 512 void ahc_done(struct ahc_softc *ahc, struct scb *scb); 513 void ahc_send_async(struct ahc_softc *, char /*channel*/, 514 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 515 #endif /* _AIC7XXX_FREEBSD_H_ */ 516