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#19 $ 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/queue.h> 53 54 #define AHD_PCI_CONFIG 1 55 #include <machine/bus_memio.h> 56 #include <machine/bus_pio.h> 57 #include <machine/bus.h> 58 #include <machine/endian.h> 59 #include <machine/clock.h> 60 #include <machine/resource.h> 61 62 #include <sys/rman.h> 63 64 #include <pci/pcireg.h> 65 #include <pci/pcivar.h> 66 67 #include <cam/cam.h> 68 #include <cam/cam_ccb.h> 69 #include <cam/cam_debug.h> 70 #include <cam/cam_sim.h> 71 #include <cam/cam_xpt_sim.h> 72 73 #include <cam/scsi/scsi_all.h> 74 #include <cam/scsi/scsi_message.h> 75 #include <cam/scsi/scsi_iu.h> 76 77 #ifdef CAM_NEW_TRAN_CODE 78 #define AHD_NEW_TRAN_SETTINGS 79 #endif /* CAM_NEW_TRAN_CODE */ 80 81 /****************************** Platform Macros *******************************/ 82 #define SIM_IS_SCSIBUS_B(ahd, sim) \ 83 (0) 84 #define SIM_CHANNEL(ahd, sim) \ 85 ('A') 86 #define SIM_SCSI_ID(ahd, sim) \ 87 (ahd->our_id) 88 #define SIM_PATH(ahd, sim) \ 89 (ahd->platform_data->path) 90 #define BUILD_SCSIID(ahd, sim, target_id, our_id) \ 91 ((((target_id) << TID_SHIFT) & TID) | (our_id)) 92 93 94 #define SCB_GET_SIM(ahd, scb) \ 95 ((ahd)->platform_data->sim) 96 97 #ifndef offsetof 98 #define offsetof(type, member) ((size_t)(&((type *)0)->member)) 99 #endif 100 /************************* Forward Declarations *******************************/ 101 typedef device_t ahd_dev_softc_t; 102 typedef union ccb *ahd_io_ctx_t; 103 104 /***************************** Bus Space/DMA **********************************/ 105 #define ahd_dma_tag_create(ahd, parent_tag, alignment, boundary, \ 106 lowaddr, highaddr, filter, filterarg, \ 107 maxsize, nsegments, maxsegsz, flags, \ 108 dma_tagp) \ 109 bus_dma_tag_create(parent_tag, alignment, boundary, \ 110 lowaddr, highaddr, filter, filterarg, \ 111 maxsize, nsegments, maxsegsz, flags, \ 112 dma_tagp) 113 114 #define ahd_dma_tag_destroy(ahd, tag) \ 115 bus_dma_tag_destroy(tag) 116 117 #define ahd_dmamem_alloc(ahd, dmat, vaddr, flags, mapp) \ 118 bus_dmamem_alloc(dmat, vaddr, flags, mapp) 119 120 #define ahd_dmamem_free(ahd, dmat, vaddr, map) \ 121 bus_dmamem_free(dmat, vaddr, map) 122 123 #define ahd_dmamap_create(ahd, tag, flags, mapp) \ 124 bus_dmamap_create(tag, flags, mapp) 125 126 #define ahd_dmamap_destroy(ahd, tag, map) \ 127 bus_dmamap_destroy(tag, map) 128 129 #define ahd_dmamap_load(ahd, dmat, map, addr, buflen, callback, \ 130 callback_arg, flags) \ 131 bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags) 132 133 #define ahd_dmamap_unload(ahd, tag, map) \ 134 bus_dmamap_unload(tag, map) 135 136 /* XXX Need to update Bus DMA for partial map syncs */ 137 #define ahd_dmamap_sync(ahd, dma_tag, dmamap, offset, len, op) \ 138 bus_dmamap_sync(dma_tag, dmamap, op) 139 140 /************************ Tunable Driver Parameters **************************/ 141 /* 142 * The number of dma segments supported. The sequencer can handle any number 143 * of physically contiguous S/G entrys. To reduce the driver's memory 144 * consumption, we limit the number supported to be sufficient to handle 145 * the largest mapping supported by the kernel, MAXPHYS. Assuming the 146 * transfer is as fragmented as possible and unaligned, this turns out to 147 * be the number of paged sized transfers in MAXPHYS plus an extra element 148 * to handle any unaligned residual. The sequencer fetches SG elements 149 * in cacheline sized chucks, so make the number per-transaction an even 150 * multiple of 16 which should align us on even the largest of cacheline 151 * boundaries. 152 */ 153 #define AHD_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) 154 155 /* This driver supports target mode */ 156 #if NOT_YET 157 #define AHD_TARGET_MODE 1 158 #endif 159 160 /************************** Softc/SCB Platform Data ***************************/ 161 struct ahd_platform_data { 162 /* 163 * Hooks into the XPT. 164 */ 165 struct cam_sim *sim; 166 struct cam_sim *sim_b; 167 struct cam_path *path; 168 struct cam_path *path_b; 169 170 int regs_res_type[2]; 171 int regs_res_id[2]; 172 int irq_res_type; 173 struct resource *regs[2]; 174 struct resource *irq; 175 void *ih; 176 eventhandler_tag eh; 177 }; 178 179 struct scb_platform_data { 180 }; 181 182 /********************************* Byte Order *********************************/ 183 #if __FreeBSD_version >= 500000 184 #define ahd_htobe16(x) htobe16(x) 185 #define ahd_htobe32(x) htobe32(x) 186 #define ahd_htobe64(x) htobe64(x) 187 #define ahd_htole16(x) htole16(x) 188 #define ahd_htole32(x) htole32(x) 189 #define ahd_htole64(x) htole64(x) 190 191 #define ahd_be16toh(x) be16toh(x) 192 #define ahd_be32toh(x) be32toh(x) 193 #define ahd_be64toh(x) be64toh(x) 194 #define ahd_le16toh(x) le16toh(x) 195 #define ahd_le32toh(x) le32toh(x) 196 #define ahd_le64toh(x) le64toh(x) 197 #else 198 #define ahd_htobe16(x) (x) 199 #define ahd_htobe32(x) (x) 200 #define ahd_htobe64(x) (x) 201 #define ahd_htole16(x) (x) 202 #define ahd_htole32(x) (x) 203 #define ahd_htole64(x) (x) 204 205 #define ahd_be16toh(x) (x) 206 #define ahd_be32toh(x) (x) 207 #define ahd_be64toh(x) (x) 208 #define ahd_le16toh(x) (x) 209 #define ahd_le32toh(x) (x) 210 #define ahd_le64toh(x) (x) 211 #endif 212 213 /************************** Timer DataStructures ******************************/ 214 typedef struct callout ahd_timer_t; 215 216 /***************************** Core Includes **********************************/ 217 #if AHD_REG_PRETTY_PRINT 218 #define AIC_DEBUG_REGISTERS 1 219 #else 220 #define AIC_DEBUG_REGISTERS 0 221 #endif 222 #include <dev/aic7xxx/aic79xx.h> 223 224 /***************************** Timer Facilities *******************************/ 225 timeout_t ahd_timeout; 226 #if __FreeBSD_version >= 500000 227 #define ahd_timer_init(timer) callout_init(timer, /*mpsafe*/0) 228 #else 229 #define ahd_timer_init callout_init 230 #endif 231 #define ahd_timer_stop callout_stop 232 233 static __inline void 234 ahd_timer_reset(ahd_timer_t *timer, u_int usec, ahd_callback_t *func, void *arg) 235 { 236 callout_reset(timer, (usec * hz)/1000000, func, arg); 237 } 238 239 static __inline void 240 ahd_scb_timer_reset(struct scb *scb, u_int usec) 241 { 242 untimeout(ahd_timeout, (caddr_t)scb, scb->io_ctx->ccb_h.timeout_ch); 243 scb->io_ctx->ccb_h.timeout_ch = 244 timeout(ahd_timeout, scb, (usec * hz)/1000000); 245 } 246 247 /*************************** Device Access ************************************/ 248 #define ahd_inb(ahd, port) \ 249 bus_space_read_1((ahd)->tags[(port) >> 8], \ 250 (ahd)->bshs[(port) >> 8], (port) & 0xFF) 251 252 #define ahd_outb(ahd, port, value) \ 253 bus_space_write_1((ahd)->tags[(port) >> 8], \ 254 (ahd)->bshs[(port) >> 8], (port) & 0xFF, value) 255 256 #define ahd_inw_atomic(ahd, port) \ 257 ahd_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8], \ 258 (ahd)->bshs[(port) >> 8], (port) & 0xFF)) 259 260 #define ahd_outw_atomic(ahd, port, value) \ 261 bus_space_write_2((ahd)->tags[(port) >> 8], \ 262 (ahd)->bshs[(port) >> 8], \ 263 (port & 0xFF), ahd_htole16(value)) 264 265 #define ahd_outsb(ahd, port, valp, count) \ 266 bus_space_write_multi_1((ahd)->tags[(port) >> 8], \ 267 (ahd)->bshs[(port) >> 8], \ 268 (port & 0xFF), valp, count) 269 270 #define ahd_insb(ahd, port, valp, count) \ 271 bus_space_read_multi_1((ahd)->tags[(port) >> 8], \ 272 (ahd)->bshs[(port) >> 8], \ 273 (port & 0xFF), valp, count) 274 275 static __inline void ahd_flush_device_writes(struct ahd_softc *); 276 277 static __inline void 278 ahd_flush_device_writes(struct ahd_softc *ahd) 279 { 280 /* XXX Is this sufficient for all architectures??? */ 281 ahd_inb(ahd, INTSTAT); 282 } 283 284 /**************************** Locking Primitives ******************************/ 285 /* Lock protecting internal data structures */ 286 static __inline void ahd_lockinit(struct ahd_softc *); 287 static __inline void ahd_lock(struct ahd_softc *, unsigned long *flags); 288 static __inline void ahd_unlock(struct ahd_softc *, unsigned long *flags); 289 290 /* Lock held during command compeletion to the upper layer */ 291 static __inline void ahd_done_lockinit(struct ahd_softc *); 292 static __inline void ahd_done_lock(struct ahd_softc *, unsigned long *flags); 293 static __inline void ahd_done_unlock(struct ahd_softc *, unsigned long *flags); 294 295 /* Lock held during ahd_list manipulation and ahd softc frees */ 296 static __inline void ahd_list_lockinit(void); 297 static __inline void ahd_list_lock(unsigned long *flags); 298 static __inline void ahd_list_unlock(unsigned long *flags); 299 300 static __inline void 301 ahd_lockinit(struct ahd_softc *ahd) 302 { 303 } 304 305 static __inline void 306 ahd_lock(struct ahd_softc *ahd, unsigned long *flags) 307 { 308 *flags = splcam(); 309 } 310 311 static __inline void 312 ahd_unlock(struct ahd_softc *ahd, unsigned long *flags) 313 { 314 splx(*flags); 315 } 316 317 /* Lock held during command compeletion to the upper layer */ 318 static __inline void 319 ahd_done_lockinit(struct ahd_softc *ahd) 320 { 321 } 322 323 static __inline void 324 ahd_done_lock(struct ahd_softc *ahd, unsigned long *flags) 325 { 326 } 327 328 static __inline void 329 ahd_done_unlock(struct ahd_softc *ahd, unsigned long *flags) 330 { 331 } 332 333 /* Lock held during ahd_list manipulation and ahd softc frees */ 334 static __inline void 335 ahd_list_lockinit() 336 { 337 } 338 339 static __inline void 340 ahd_list_lock(unsigned long *flags) 341 { 342 } 343 344 static __inline void 345 ahd_list_unlock(unsigned long *flags) 346 { 347 } 348 /****************************** OS Primitives *********************************/ 349 #define ahd_delay DELAY 350 351 /************************** Transaction Operations ****************************/ 352 static __inline void ahd_set_transaction_status(struct scb *, uint32_t); 353 static __inline void ahd_set_scsi_status(struct scb *, uint32_t); 354 static __inline uint32_t ahd_get_transaction_status(struct scb *); 355 static __inline uint32_t ahd_get_scsi_status(struct scb *); 356 static __inline void ahd_set_transaction_tag(struct scb *, int, u_int); 357 static __inline u_long ahd_get_transfer_length(struct scb *); 358 static __inline int ahd_get_transfer_dir(struct scb *); 359 static __inline void ahd_set_residual(struct scb *, u_long); 360 static __inline void ahd_set_sense_residual(struct scb *, u_long); 361 static __inline u_long ahd_get_residual(struct scb *); 362 static __inline int ahd_perform_autosense(struct scb *); 363 static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc*, struct scb*); 364 static __inline void ahd_freeze_simq(struct ahd_softc *); 365 static __inline void ahd_release_simq(struct ahd_softc *); 366 static __inline void ahd_freeze_ccb(union ccb *ccb); 367 static __inline void ahd_freeze_scb(struct scb *scb); 368 static __inline void ahd_platform_freeze_devq(struct ahd_softc *, struct scb *); 369 static __inline int ahd_platform_abort_scbs(struct ahd_softc *ahd, int target, 370 char channel, int lun, u_int tag, 371 role_t role, uint32_t status); 372 373 static __inline 374 void ahd_set_transaction_status(struct scb *scb, uint32_t status) 375 { 376 scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK; 377 scb->io_ctx->ccb_h.status |= status; 378 } 379 380 static __inline 381 void ahd_set_scsi_status(struct scb *scb, uint32_t status) 382 { 383 scb->io_ctx->csio.scsi_status = status; 384 } 385 386 static __inline 387 uint32_t ahd_get_transaction_status(struct scb *scb) 388 { 389 return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK); 390 } 391 392 static __inline 393 uint32_t ahd_get_scsi_status(struct scb *scb) 394 { 395 return (scb->io_ctx->csio.scsi_status); 396 } 397 398 static __inline 399 void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type) 400 { 401 scb->io_ctx->csio.tag_action = type; 402 if (enabled) 403 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID; 404 else 405 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID; 406 } 407 408 static __inline 409 u_long ahd_get_transfer_length(struct scb *scb) 410 { 411 return (scb->io_ctx->csio.dxfer_len); 412 } 413 414 static __inline 415 int ahd_get_transfer_dir(struct scb *scb) 416 { 417 return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK); 418 } 419 420 static __inline 421 void ahd_set_residual(struct scb *scb, u_long resid) 422 { 423 scb->io_ctx->csio.resid = resid; 424 } 425 426 static __inline 427 void ahd_set_sense_residual(struct scb *scb, u_long resid) 428 { 429 scb->io_ctx->csio.sense_resid = resid; 430 } 431 432 static __inline 433 u_long ahd_get_residual(struct scb *scb) 434 { 435 return (scb->io_ctx->csio.resid); 436 } 437 438 static __inline 439 int ahd_perform_autosense(struct scb *scb) 440 { 441 return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE)); 442 } 443 444 static __inline uint32_t 445 ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb) 446 { 447 return (sizeof(struct scsi_sense_data)); 448 } 449 450 static __inline void 451 ahd_freeze_simq(struct ahd_softc *ahd) 452 { 453 xpt_freeze_simq(ahd->platform_data->sim, /*count*/1); 454 } 455 456 static __inline void 457 ahd_release_simq(struct ahd_softc *ahd) 458 { 459 xpt_release_simq(ahd->platform_data->sim, /*run queue*/TRUE); 460 } 461 462 static __inline void 463 ahd_freeze_ccb(union ccb *ccb) 464 { 465 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) { 466 ccb->ccb_h.status |= CAM_DEV_QFRZN; 467 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1); 468 } 469 } 470 471 static __inline void 472 ahd_freeze_scb(struct scb *scb) 473 { 474 ahd_freeze_ccb(scb->io_ctx); 475 } 476 477 static __inline void 478 ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb) 479 { 480 /* Nothing to do here for FreeBSD */ 481 } 482 483 static __inline int 484 ahd_platform_abort_scbs(struct ahd_softc *ahd, int target, 485 char channel, int lun, u_int tag, 486 role_t role, uint32_t status) 487 { 488 /* Nothing to do here for FreeBSD */ 489 return (0); 490 } 491 492 static __inline void 493 ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb) 494 { 495 /* What do we do to generically handle driver resource shortages??? */ 496 if ((ahd->flags & AHD_RESOURCE_SHORTAGE) != 0 497 && scb->io_ctx != NULL 498 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) { 499 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ; 500 ahd->flags &= ~AHD_RESOURCE_SHORTAGE; 501 } 502 scb->io_ctx = NULL; 503 } 504 505 /********************************** PCI ***************************************/ 506 #ifdef AHD_PCI_CONFIG 507 static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci, 508 int reg, int width); 509 static __inline void ahd_pci_write_config(ahd_dev_softc_t pci, 510 int reg, uint32_t value, 511 int width); 512 static __inline int ahd_get_pci_function(ahd_dev_softc_t); 513 static __inline int ahd_get_pci_slot(ahd_dev_softc_t); 514 static __inline int ahd_get_pci_bus(ahd_dev_softc_t); 515 516 int ahd_pci_map_registers(struct ahd_softc *ahd); 517 int ahd_pci_map_int(struct ahd_softc *ahd); 518 519 static __inline uint32_t 520 ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width) 521 { 522 return (pci_read_config(pci, reg, width)); 523 } 524 525 static __inline void 526 ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width) 527 { 528 pci_write_config(pci, reg, value, width); 529 } 530 531 static __inline int 532 ahd_get_pci_function(ahd_dev_softc_t pci) 533 { 534 return (pci_get_function(pci)); 535 } 536 537 static __inline int 538 ahd_get_pci_slot(ahd_dev_softc_t pci) 539 { 540 return (pci_get_slot(pci)); 541 } 542 543 static __inline int 544 ahd_get_pci_bus(ahd_dev_softc_t pci) 545 { 546 return (pci_get_bus(pci)); 547 } 548 549 typedef enum 550 { 551 AHD_POWER_STATE_D0, 552 AHD_POWER_STATE_D1, 553 AHD_POWER_STATE_D2, 554 AHD_POWER_STATE_D3 555 } ahd_power_state; 556 557 void ahd_power_state_change(struct ahd_softc *ahd, 558 ahd_power_state new_state); 559 #endif 560 /******************************** VL/EISA *************************************/ 561 int aic7770_map_registers(struct ahd_softc *ahd); 562 int aic7770_map_int(struct ahd_softc *ahd, int irq); 563 564 /********************************* Debug **************************************/ 565 static __inline void ahd_print_path(struct ahd_softc *, struct scb *); 566 static __inline void ahd_platform_dump_card_state(struct ahd_softc *ahd); 567 568 static __inline void 569 ahd_print_path(struct ahd_softc *ahd, struct scb *scb) 570 { 571 xpt_print_path(scb->io_ctx->ccb_h.path); 572 } 573 574 static __inline void 575 ahd_platform_dump_card_state(struct ahd_softc *ahd) 576 { 577 /* Nothing to do here for FreeBSD */ 578 } 579 /**************************** Transfer Settings *******************************/ 580 void ahd_notify_xfer_settings_change(struct ahd_softc *, 581 struct ahd_devinfo *); 582 void ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *, 583 int /*enable*/); 584 585 /************************* Initialization/Teardown ****************************/ 586 int ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg); 587 void ahd_platform_free(struct ahd_softc *ahd); 588 int ahd_map_int(struct ahd_softc *ahd); 589 int ahd_attach(struct ahd_softc *); 590 int ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd); 591 int ahd_detach(device_t); 592 #define ahd_platform_init(arg) 593 594 595 /****************************** Interrupts ************************************/ 596 void ahd_platform_intr(void *); 597 static __inline void ahd_platform_flushwork(struct ahd_softc *ahd); 598 static __inline void 599 ahd_platform_flushwork(struct ahd_softc *ahd) 600 { 601 } 602 603 /************************ Misc Function Declarations **************************/ 604 void ahd_done(struct ahd_softc *ahd, struct scb *scb); 605 void ahd_send_async(struct ahd_softc *, char /*channel*/, 606 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 607 #endif /* _AIC79XX_FREEBSD_H_ */ 608