aic7xxx_osm.h revision 115336
1239310Sdim/* 2239310Sdim * FreeBSD platform specific driver option settings, data structures, 3239310Sdim * function declarations and includes. 4239310Sdim * 5239310Sdim * Copyright (c) 1994-2001 Justin T. Gibbs. 6239310Sdim * All rights reserved. 7239310Sdim * 8239310Sdim * Redistribution and use in source and binary forms, with or without 9239310Sdim * modification, are permitted provided that the following conditions 10239310Sdim * are met: 11239310Sdim * 1. Redistributions of source code must retain the above copyright 12239310Sdim * notice, this list of conditions, and the following disclaimer, 13239310Sdim * without modification. 14239310Sdim * 2. The name of the author may not be used to endorse or promote products 15239310Sdim * derived from this software without specific prior written permission. 16263508Sdim * 17239310Sdim * Alternatively, this software may be distributed under the terms of the 18239310Sdim * GNU Public License ("GPL"). 19239310Sdim * 20239310Sdim * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 21239310Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22239310Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23239310Sdim * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 24239310Sdim * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25239310Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26239310Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27239310Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28239310Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29239310Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30239310Sdim * SUCH DAMAGE. 31239310Sdim * 32239310Sdim * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic7xxx_osm.h#14 $ 33239310Sdim * 34239310Sdim * $FreeBSD: head/sys/dev/aic7xxx/aic7xxx_osm.h 115336 2003-05-26 21:43:29Z gibbs $ 35239310Sdim */ 36239310Sdim 37239310Sdim#ifndef _AIC7XXX_FREEBSD_H_ 38239310Sdim#define _AIC7XXX_FREEBSD_H_ 39239310Sdim 40239310Sdim#include <opt_aic7xxx.h> /* for config options */ 41239310Sdim 42239310Sdim#include <sys/param.h> 43239310Sdim#include <sys/systm.h> 44239310Sdim#include <sys/bus.h> /* For device_t */ 45239310Sdim#if __FreeBSD_version >= 500000 46239310Sdim#include <sys/endian.h> 47249423Sdim#endif 48249423Sdim#include <sys/eventhandler.h> 49239310Sdim#include <sys/kernel.h> 50239310Sdim#include <sys/malloc.h> 51239310Sdim#include <sys/queue.h> 52239310Sdim 53239310Sdim#if __FreeBSD_version < 500000 54249423Sdim#include <pci.h> 55249423Sdim#else 56239310Sdim#define NPCI 1 57239310Sdim#endif 58239310Sdim 59239310Sdim#if NPCI > 0 60239310Sdim#define AHC_PCI_CONFIG 1 61263508Sdim#include <machine/bus_memio.h> 62263508Sdim#endif 63263508Sdim#include <machine/bus_pio.h> 64263508Sdim#include <machine/bus.h> 65263508Sdim#include <machine/endian.h> 66263508Sdim#include <machine/clock.h> 67263508Sdim#include <machine/resource.h> 68263508Sdim 69263508Sdim#include <sys/rman.h> 70263508Sdim 71263508Sdim#if NPCI > 0 72239310Sdim#include <pci/pcireg.h> 73239310Sdim#include <pci/pcivar.h> 74239310Sdim#endif 75239310Sdim 76239310Sdim#include <cam/cam.h> 77239310Sdim#include <cam/cam_ccb.h> 78239310Sdim#include <cam/cam_debug.h> 79239310Sdim#include <cam/cam_sim.h> 80239310Sdim#include <cam/cam_xpt_sim.h> 81239310Sdim 82239310Sdim#include <cam/scsi/scsi_all.h> 83239310Sdim#include <cam/scsi/scsi_message.h> 84239310Sdim 85239310Sdim#ifdef CAM_NEW_TRAN_CODE 86239310Sdim#define AHC_NEW_TRAN_SETTINGS 87239310Sdim#endif /* CAM_NEW_TRAN_CODE */ 88239310Sdim 89239310Sdim/*************************** Attachment Bookkeeping ***************************/ 90239310Sdimextern devclass_t ahc_devclass; 91239310Sdim 92239310Sdim/****************************** Platform Macros *******************************/ 93239310Sdim#define SIM_IS_SCSIBUS_B(ahc, sim) \ 94239310Sdim ((sim) == ahc->platform_data->sim_b) 95239310Sdim#define SIM_CHANNEL(ahc, sim) \ 96239310Sdim (((sim) == ahc->platform_data->sim_b) ? 'B' : 'A') 97239310Sdim#define SIM_SCSI_ID(ahc, sim) \ 98239310Sdim (((sim) == ahc->platform_data->sim_b) ? ahc->our_id_b : ahc->our_id) 99239310Sdim#define SIM_PATH(ahc, sim) \ 100263508Sdim (((sim) == ahc->platform_data->sim_b) ? ahc->platform_data->path_b \ 101263508Sdim : ahc->platform_data->path) 102263508Sdim#define BUILD_SCSIID(ahc, sim, target_id, our_id) \ 103263508Sdim ((((target_id) << TID_SHIFT) & TID) | (our_id) \ 104263508Sdim | (SIM_IS_SCSIBUS_B(ahc, sim) ? TWIN_CHNLB : 0)) 105239310Sdim 106#define SCB_GET_SIM(ahc, scb) \ 107 (SCB_GET_CHANNEL(ahc, scb) == 'A' ? (ahc)->platform_data->sim \ 108 : (ahc)->platform_data->sim_b) 109 110#ifndef offsetof 111#define offsetof(type, member) ((size_t)(&((type *)0)->member)) 112#endif 113/************************* Forward Declarations *******************************/ 114typedef device_t ahc_dev_softc_t; 115typedef union ccb *ahc_io_ctx_t; 116 117/***************************** Bus Space/DMA **********************************/ 118#define ahc_dma_tag_create(ahc, parent_tag, alignment, boundary, \ 119 lowaddr, highaddr, filter, filterarg, \ 120 maxsize, nsegments, maxsegsz, flags, \ 121 dma_tagp) \ 122 bus_dma_tag_create(parent_tag, alignment, boundary, \ 123 lowaddr, highaddr, filter, filterarg, \ 124 maxsize, nsegments, maxsegsz, flags, \ 125 dma_tagp) 126 127#define ahc_dma_tag_destroy(ahc, tag) \ 128 bus_dma_tag_destroy(tag) 129 130#define ahc_dmamem_alloc(ahc, dmat, vaddr, flags, mapp) \ 131 bus_dmamem_alloc(dmat, vaddr, flags, mapp) 132 133#define ahc_dmamem_free(ahc, dmat, vaddr, map) \ 134 bus_dmamem_free(dmat, vaddr, map) 135 136#define ahc_dmamap_create(ahc, tag, flags, mapp) \ 137 bus_dmamap_create(tag, flags, mapp) 138 139#define ahc_dmamap_destroy(ahc, tag, map) \ 140 bus_dmamap_destroy(tag, map) 141 142#define ahc_dmamap_load(ahc, dmat, map, addr, buflen, callback, \ 143 callback_arg, flags) \ 144 bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags) 145 146#define ahc_dmamap_unload(ahc, tag, map) \ 147 bus_dmamap_unload(tag, map) 148 149/* XXX Need to update Bus DMA for partial map syncs */ 150#define ahc_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op) \ 151 bus_dmamap_sync(dma_tag, dmamap, op) 152 153/************************ Tunable Driver Parameters **************************/ 154/* 155 * The number of dma segments supported. The sequencer can handle any number 156 * of physically contiguous S/G entrys. To reduce the driver's memory 157 * consumption, we limit the number supported to be sufficient to handle 158 * the largest mapping supported by the kernel, MAXPHYS. Assuming the 159 * transfer is as fragmented as possible and unaligned, this turns out to 160 * be the number of paged sized transfers in MAXPHYS plus an extra element 161 * to handle any unaligned residual. The sequencer fetches SG elements 162 * in cacheline sized chucks, so make the number per-transaction an even 163 * multiple of 16 which should align us on even the largest of cacheline 164 * boundaries. 165 */ 166#define AHC_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) 167 168/* This driver supports target mode */ 169#define AHC_TARGET_MODE 1 170 171/************************** Softc/SCB Platform Data ***************************/ 172struct ahc_platform_data { 173 /* 174 * Hooks into the XPT. 175 */ 176 struct cam_sim *sim; 177 struct cam_sim *sim_b; 178 struct cam_path *path; 179 struct cam_path *path_b; 180 181 int regs_res_type; 182 int regs_res_id; 183 int irq_res_type; 184 struct resource *regs; 185 struct resource *irq; 186 void *ih; 187 eventhandler_tag eh; 188}; 189 190struct scb_platform_data { 191}; 192 193/********************************* Byte Order *********************************/ 194#if __FreeBSD_version >= 500000 195#define ahc_htobe16(x) htobe16(x) 196#define ahc_htobe32(x) htobe32(x) 197#define ahc_htobe64(x) htobe64(x) 198#define ahc_htole16(x) htole16(x) 199#define ahc_htole32(x) htole32(x) 200#define ahc_htole64(x) htole64(x) 201 202#define ahc_be16toh(x) be16toh(x) 203#define ahc_be32toh(x) be32toh(x) 204#define ahc_be64toh(x) be64toh(x) 205#define ahc_le16toh(x) le16toh(x) 206#define ahc_le32toh(x) le32toh(x) 207#define ahc_le64toh(x) le64toh(x) 208#else 209#define ahc_htobe16(x) (x) 210#define ahc_htobe32(x) (x) 211#define ahc_htobe64(x) (x) 212#define ahc_htole16(x) (x) 213#define ahc_htole32(x) (x) 214#define ahc_htole64(x) (x) 215 216#define ahc_be16toh(x) (x) 217#define ahc_be32toh(x) (x) 218#define ahc_be64toh(x) (x) 219#define ahc_le16toh(x) (x) 220#define ahc_le32toh(x) (x) 221#define ahc_le64toh(x) (x) 222#endif 223 224/************************** Timer DataStructures ******************************/ 225typedef struct callout ahc_timer_t; 226 227/***************************** Core Includes **********************************/ 228#if AHC_REG_PRETTY_PRINT 229#define AIC_DEBUG_REGISTERS 1 230#else 231#define AIC_DEBUG_REGISTERS 0 232#endif 233#include <dev/aic7xxx/aic7xxx.h> 234 235/***************************** Timer Facilities *******************************/ 236timeout_t ahc_timeout; 237 238#if __FreeBSD_version >= 500000 239#define ahc_timer_init(timer) callout_init(timer, /*mpsafe*/0) 240#else 241#define ahc_timer_init callout_init 242#endif 243#define ahc_timer_stop callout_stop 244 245static __inline void 246ahc_timer_reset(ahc_timer_t *timer, u_int usec, ahc_callback_t *func, void *arg) 247{ 248 callout_reset(timer, (usec * hz)/1000000, func, arg); 249} 250 251static __inline void 252ahc_scb_timer_reset(struct scb *scb, u_int usec) 253{ 254 untimeout(ahc_timeout, (caddr_t)scb, scb->io_ctx->ccb_h.timeout_ch); 255 scb->io_ctx->ccb_h.timeout_ch = 256 timeout(ahc_timeout, scb, (usec * hz)/1000000); 257} 258 259/*************************** Device Access ************************************/ 260#define ahc_inb(ahc, port) \ 261 bus_space_read_1((ahc)->tag, (ahc)->bsh, port) 262 263#define ahc_outb(ahc, port, value) \ 264 bus_space_write_1((ahc)->tag, (ahc)->bsh, port, value) 265 266#define ahc_outsb(ahc, port, valp, count) \ 267 bus_space_write_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) 268 269#define ahc_insb(ahc, port, valp, count) \ 270 bus_space_read_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) 271 272static __inline void ahc_flush_device_writes(struct ahc_softc *); 273 274static __inline void 275ahc_flush_device_writes(struct ahc_softc *ahc) 276{ 277 /* XXX Is this sufficient for all architectures??? */ 278 ahc_inb(ahc, INTSTAT); 279} 280 281/**************************** Locking Primitives ******************************/ 282/* Lock protecting internal data structures */ 283static __inline void ahc_lockinit(struct ahc_softc *); 284static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags); 285static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags); 286 287/* Lock held during command compeletion to the upper layer */ 288static __inline void ahc_done_lockinit(struct ahc_softc *); 289static __inline void ahc_done_lock(struct ahc_softc *, unsigned long *flags); 290static __inline void ahc_done_unlock(struct ahc_softc *, unsigned long *flags); 291 292/* Lock held during ahc_list manipulation and ahc softc frees */ 293static __inline void ahc_list_lockinit(void); 294static __inline void ahc_list_lock(unsigned long *flags); 295static __inline void ahc_list_unlock(unsigned long *flags); 296 297static __inline void 298ahc_lockinit(struct ahc_softc *ahc) 299{ 300} 301 302static __inline void 303ahc_lock(struct ahc_softc *ahc, unsigned long *flags) 304{ 305 *flags = splcam(); 306} 307 308static __inline void 309ahc_unlock(struct ahc_softc *ahc, unsigned long *flags) 310{ 311 splx(*flags); 312} 313 314/* Lock held during command compeletion to the upper layer */ 315static __inline void 316ahc_done_lockinit(struct ahc_softc *ahc) 317{ 318} 319 320static __inline void 321ahc_done_lock(struct ahc_softc *ahc, unsigned long *flags) 322{ 323} 324 325static __inline void 326ahc_done_unlock(struct ahc_softc *ahc, unsigned long *flags) 327{ 328} 329 330/* Lock held during ahc_list manipulation and ahc softc frees */ 331static __inline void 332ahc_list_lockinit(void) 333{ 334} 335 336static __inline void 337ahc_list_lock(unsigned long *flags) 338{ 339} 340 341static __inline void 342ahc_list_unlock(unsigned long *flags) 343{ 344} 345/****************************** OS Primitives *********************************/ 346#define ahc_delay DELAY 347 348/************************** Transaction Operations ****************************/ 349static __inline void ahc_set_transaction_status(struct scb *, uint32_t); 350static __inline void ahc_set_scsi_status(struct scb *, uint32_t); 351static __inline uint32_t ahc_get_transaction_status(struct scb *); 352static __inline uint32_t ahc_get_scsi_status(struct scb *); 353static __inline void ahc_set_transaction_tag(struct scb *, int, u_int); 354static __inline u_long ahc_get_transfer_length(struct scb *); 355static __inline int ahc_get_transfer_dir(struct scb *); 356static __inline void ahc_set_residual(struct scb *, u_long); 357static __inline void ahc_set_sense_residual(struct scb *, u_long); 358static __inline u_long ahc_get_residual(struct scb *); 359static __inline int ahc_perform_autosense(struct scb *); 360static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc*, struct scb*); 361static __inline void ahc_freeze_ccb(union ccb *ccb); 362static __inline void ahc_freeze_scb(struct scb *scb); 363static __inline void ahc_platform_freeze_devq(struct ahc_softc *, struct scb *); 364static __inline int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, 365 char channel, int lun, u_int tag, 366 role_t role, uint32_t status); 367 368static __inline 369void ahc_set_transaction_status(struct scb *scb, uint32_t status) 370{ 371 scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK; 372 scb->io_ctx->ccb_h.status |= status; 373} 374 375static __inline 376void ahc_set_scsi_status(struct scb *scb, uint32_t status) 377{ 378 scb->io_ctx->csio.scsi_status = status; 379} 380 381static __inline 382uint32_t ahc_get_transaction_status(struct scb *scb) 383{ 384 return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK); 385} 386 387static __inline 388uint32_t ahc_get_scsi_status(struct scb *scb) 389{ 390 return (scb->io_ctx->csio.scsi_status); 391} 392 393static __inline 394void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type) 395{ 396 scb->io_ctx->csio.tag_action = type; 397 if (enabled) 398 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID; 399 else 400 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID; 401} 402 403static __inline 404u_long ahc_get_transfer_length(struct scb *scb) 405{ 406 return (scb->io_ctx->csio.dxfer_len); 407} 408 409static __inline 410int ahc_get_transfer_dir(struct scb *scb) 411{ 412 return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK); 413} 414 415static __inline 416void ahc_set_residual(struct scb *scb, u_long resid) 417{ 418 scb->io_ctx->csio.resid = resid; 419} 420 421static __inline 422void ahc_set_sense_residual(struct scb *scb, u_long resid) 423{ 424 scb->io_ctx->csio.sense_resid = resid; 425} 426 427static __inline 428u_long ahc_get_residual(struct scb *scb) 429{ 430 return (scb->io_ctx->csio.resid); 431} 432 433static __inline 434int ahc_perform_autosense(struct scb *scb) 435{ 436 return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE)); 437} 438 439static __inline uint32_t 440ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb) 441{ 442 return (sizeof(struct scsi_sense_data)); 443} 444 445static __inline void 446ahc_freeze_ccb(union ccb *ccb) 447{ 448 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) { 449 ccb->ccb_h.status |= CAM_DEV_QFRZN; 450 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1); 451 } 452} 453 454static __inline void 455ahc_freeze_scb(struct scb *scb) 456{ 457 ahc_freeze_ccb(scb->io_ctx); 458} 459 460static __inline void 461ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb) 462{ 463 /* Nothing to do here for FreeBSD */ 464} 465 466static __inline int 467ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, 468 char channel, int lun, u_int tag, 469 role_t role, uint32_t status) 470{ 471 /* Nothing to do here for FreeBSD */ 472 return (0); 473} 474 475static __inline void 476ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb) 477{ 478 /* What do we do to generically handle driver resource shortages??? */ 479 if ((ahc->flags & AHC_RESOURCE_SHORTAGE) != 0 480 && scb->io_ctx != NULL 481 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) { 482 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ; 483 ahc->flags &= ~AHC_RESOURCE_SHORTAGE; 484 } 485 scb->io_ctx = NULL; 486} 487 488/********************************** PCI ***************************************/ 489#ifdef AHC_PCI_CONFIG 490static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci, 491 int reg, int width); 492static __inline void ahc_pci_write_config(ahc_dev_softc_t pci, 493 int reg, uint32_t value, 494 int width); 495static __inline int ahc_get_pci_function(ahc_dev_softc_t); 496static __inline int ahc_get_pci_slot(ahc_dev_softc_t); 497static __inline int ahc_get_pci_bus(ahc_dev_softc_t); 498 499int ahc_pci_map_registers(struct ahc_softc *ahc); 500int ahc_pci_map_int(struct ahc_softc *ahc); 501 502static __inline uint32_t 503ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width) 504{ 505 return (pci_read_config(pci, reg, width)); 506} 507 508static __inline void 509ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width) 510{ 511 pci_write_config(pci, reg, value, width); 512} 513 514static __inline int 515ahc_get_pci_function(ahc_dev_softc_t pci) 516{ 517 return (pci_get_function(pci)); 518} 519 520static __inline int 521ahc_get_pci_slot(ahc_dev_softc_t pci) 522{ 523 return (pci_get_slot(pci)); 524} 525 526static __inline int 527ahc_get_pci_bus(ahc_dev_softc_t pci) 528{ 529 return (pci_get_bus(pci)); 530} 531 532typedef enum 533{ 534 AHC_POWER_STATE_D0, 535 AHC_POWER_STATE_D1, 536 AHC_POWER_STATE_D2, 537 AHC_POWER_STATE_D3 538} ahc_power_state; 539 540void ahc_power_state_change(struct ahc_softc *ahc, 541 ahc_power_state new_state); 542#endif 543/******************************** VL/EISA *************************************/ 544int aic7770_map_registers(struct ahc_softc *ahc, u_int port); 545int aic7770_map_int(struct ahc_softc *ahc, int irq); 546 547/********************************* Debug **************************************/ 548static __inline void ahc_print_path(struct ahc_softc *, struct scb *); 549static __inline void ahc_platform_dump_card_state(struct ahc_softc *ahc); 550 551static __inline void 552ahc_print_path(struct ahc_softc *ahc, struct scb *scb) 553{ 554 xpt_print_path(scb->io_ctx->ccb_h.path); 555} 556 557static __inline void 558ahc_platform_dump_card_state(struct ahc_softc *ahc) 559{ 560 /* Nothing to do here for FreeBSD */ 561} 562/**************************** Transfer Settings *******************************/ 563void ahc_notify_xfer_settings_change(struct ahc_softc *, 564 struct ahc_devinfo *); 565void ahc_platform_set_tags(struct ahc_softc *, struct ahc_devinfo *, 566 int /*enable*/); 567 568/************************* Initialization/Teardown ****************************/ 569int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg); 570void ahc_platform_free(struct ahc_softc *ahc); 571int ahc_map_int(struct ahc_softc *ahc); 572int ahc_attach(struct ahc_softc *); 573int ahc_softc_comp(struct ahc_softc *lahc, struct ahc_softc *rahc); 574int ahc_detach(device_t); 575 576/****************************** Interrupts ************************************/ 577void ahc_platform_intr(void *); 578static __inline void ahc_platform_flushwork(struct ahc_softc *ahc); 579static __inline void 580ahc_platform_flushwork(struct ahc_softc *ahc) 581{ 582} 583 584/************************ Misc Function Declarations **************************/ 585void ahc_done(struct ahc_softc *ahc, struct scb *scb); 586void ahc_send_async(struct ahc_softc *, char /*channel*/, 587 u_int /*target*/, u_int /*lun*/, ac_code, void *arg); 588#endif /* _AIC7XXX_FREEBSD_H_ */ 589