aic_osm_lib.h revision 172836
1/*- 2 * FreeBSD platform specific, shared driver option settings, data structures, 3 * function declarations and includes. 4 * 5 * Copyright (c) 1994-2001 Justin T. Gibbs. 6 * Copyright (c) 2001-2003 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/aic_osm_lib.h#5 $ 34 * 35 * $FreeBSD: head/sys/dev/aic7xxx/aic_osm_lib.h 172836 2007-10-20 23:23:23Z julian $ 36 */ 37 38/******************************** OS Includes *********************************/ 39#if __FreeBSD_version >= 500000 40#include <sys/mutex.h> 41#endif 42 43/*************************** Library Symbol Mapping ***************************/ 44#define AIC_LIB_ENTRY_CONCAT(x, prefix) prefix ## x 45#define AIC_LIB_ENTRY_EXPAND(x, prefix) AIC_LIB_ENTRY_CONCAT(x, prefix) 46#define AIC_LIB_ENTRY(x) AIC_LIB_ENTRY_EXPAND(x, AIC_LIB_PREFIX) 47#define AIC_CONST_ENTRY(x) AIC_LIB_ENTRY_EXPAND(x,AIC_CONST_PREFIX) 48 49#define aic_softc AIC_LIB_ENTRY(_softc) 50#define aic_tailq AIC_LIB_ENTRY(_tailq) 51#define aic_transinfo AIC_LIB_ENTRY(_transinfo) 52#define aic_platform_data AIC_LIB_ENTRY(_platform_data) 53#define aic_devinfo AIC_LIB_ENTRY(_devinfo) 54#define aic_lock AIC_LIB_ENTRY(_lock) 55#define aic_unlock AIC_LIB_ENTRY(_unlock) 56#define aic_callback_t AIC_LIB_ENTRY(_callback_t) 57#define aic_platform_freeze_devq AIC_LIB_ENTRY(_platform_freeze_devq) 58#define aic_platform_abort_scbs AIC_LIB_ENTRY(_platform_abort_scbs) 59#define aic_platform_timeout AIC_LIB_ENTRY(_platform_timeout) 60#define aic_timeout AIC_LIB_ENTRY(_timeout) 61#define aic_set_recoveryscb AIC_LIB_ENTRY(_set_recoveryscb) 62#define aic_spawn_recovery_thread AIC_LIB_ENTRY(_spawn_recovery_thread) 63#define aic_wakeup_recovery_thread AIC_LIB_ENTRY(_wakeup_recovery_thread) 64#define aic_terminate_recovery_thread \ 65 AIC_LIB_ENTRY(_terminate_recovery_thread) 66#define aic_recovery_thread AIC_LIB_ENTRY(_recovery_thread) 67#define aic_recover_commands AIC_LIB_ENTRY(_recover_commands) 68#define aic_calc_geometry AIC_LIB_ENTRY(_calc_geometry) 69 70#define AIC_RESOURCE_SHORTAGE AIC_CONST_ENTRY(_RESOURCE_SHORTAGE) 71#define AIC_SHUTDOWN_RECOVERY AIC_CONST_ENTRY(_SHUTDOWN_RECOVERY) 72 73/********************************* Byte Order *********************************/ 74#if __FreeBSD_version >= 500000 75#define aic_htobe16(x) htobe16(x) 76#define aic_htobe32(x) htobe32(x) 77#define aic_htobe64(x) htobe64(x) 78#define aic_htole16(x) htole16(x) 79#define aic_htole32(x) htole32(x) 80#define aic_htole64(x) htole64(x) 81 82#define aic_be16toh(x) be16toh(x) 83#define aic_be32toh(x) be32toh(x) 84#define aic_be64toh(x) be64toh(x) 85#define aic_le16toh(x) le16toh(x) 86#define aic_le32toh(x) le32toh(x) 87#define aic_le64toh(x) le64toh(x) 88#else 89#define aic_htobe16(x) (x) 90#define aic_htobe32(x) (x) 91#define aic_htobe64(x) (x) 92#define aic_htole16(x) (x) 93#define aic_htole32(x) (x) 94#define aic_htole64(x) (x) 95 96#define aic_be16toh(x) (x) 97#define aic_be32toh(x) (x) 98#define aic_be64toh(x) (x) 99#define aic_le16toh(x) (x) 100#define aic_le32toh(x) (x) 101#define aic_le64toh(x) (x) 102#endif 103 104/************************* Forward Declarations *******************************/ 105typedef device_t aic_dev_softc_t; 106typedef union ccb *aic_io_ctx_t; 107struct aic_softc; 108struct scb; 109 110/*************************** Timer DataStructures *****************************/ 111typedef struct callout aic_timer_t; 112 113/****************************** Error Recovery ********************************/ 114void aic_set_recoveryscb(struct aic_softc *aic, struct scb *scb); 115timeout_t aic_platform_timeout; 116int aic_spawn_recovery_thread(struct aic_softc *aic); 117void aic_terminate_recovery_thread(struct aic_softc *aic); 118 119static __inline void aic_wakeup_recovery_thread(struct aic_softc *aic); 120 121static __inline void 122aic_wakeup_recovery_thread(struct aic_softc *aic) 123{ 124 wakeup(aic); 125} 126 127/****************************** Kernel Threads ********************************/ 128#if __FreeBSD_version > 500005 129#define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 130 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 131#else 132#define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 133 kproc_create(func, farg, proc_ptr, fmtstr, arg) 134#endif 135 136/******************************* Bus Space/DMA ********************************/ 137 138#if __FreeBSD_version >= 501102 139#define aic_dma_tag_create(aic, parent_tag, alignment, boundary, \ 140 lowaddr, highaddr, filter, filterarg, \ 141 maxsize, nsegments, maxsegsz, flags, \ 142 dma_tagp) \ 143 bus_dma_tag_create(parent_tag, alignment, boundary, \ 144 lowaddr, highaddr, filter, filterarg, \ 145 maxsize, nsegments, maxsegsz, flags, \ 146 busdma_lock_mutex, &aic->platform_data->mtx, \ 147 dma_tagp) 148#else 149#define aic_dma_tag_create(aic, parent_tag, alignment, boundary, \ 150 lowaddr, highaddr, filter, filterarg, \ 151 maxsize, nsegments, maxsegsz, flags, \ 152 dma_tagp) \ 153 bus_dma_tag_create(parent_tag, alignment, boundary, \ 154 lowaddr, highaddr, filter, filterarg, \ 155 maxsize, nsegments, maxsegsz, flags, \ 156 dma_tagp) 157#endif 158 159#define aic_dma_tag_destroy(aic, tag) \ 160 bus_dma_tag_destroy(tag) 161 162#define aic_dmamem_alloc(aic, dmat, vaddr, flags, mapp) \ 163 bus_dmamem_alloc(dmat, vaddr, flags, mapp) 164 165#define aic_dmamem_free(aic, dmat, vaddr, map) \ 166 bus_dmamem_free(dmat, vaddr, map) 167 168#define aic_dmamap_create(aic, tag, flags, mapp) \ 169 bus_dmamap_create(tag, flags, mapp) 170 171#define aic_dmamap_destroy(aic, tag, map) \ 172 bus_dmamap_destroy(tag, map) 173 174#define aic_dmamap_load(aic, dmat, map, addr, buflen, callback, \ 175 callback_arg, flags) \ 176 bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags) 177 178#define aic_dmamap_unload(aic, tag, map) \ 179 bus_dmamap_unload(tag, map) 180 181/* XXX Need to update Bus DMA for partial map syncs */ 182#define aic_dmamap_sync(aic, dma_tag, dmamap, offset, len, op) \ 183 bus_dmamap_sync(dma_tag, dmamap, op) 184 185/***************************** Core Includes **********************************/ 186#include AIC_CORE_INCLUDE 187 188/***************************** Timer Facilities *******************************/ 189#if __FreeBSD_version >= 500000 190#define aic_timer_init(timer) callout_init(timer, /*mpsafe*/1) 191#else 192#define aic_timer_init callout_init 193#endif 194#define aic_timer_stop callout_stop 195 196static __inline void aic_timer_reset(aic_timer_t *, u_int, 197 aic_callback_t *, void *); 198static __inline u_int aic_get_timeout(struct scb *); 199static __inline void aic_scb_timer_reset(struct scb *, u_int); 200 201static __inline void 202aic_timer_reset(aic_timer_t *timer, u_int msec, aic_callback_t *func, void *arg) 203{ 204 uint64_t time; 205 206 time = msec; 207 time *= hz; 208 time /= 1000; 209 callout_reset(timer, time, func, arg); 210} 211 212static __inline u_int 213aic_get_timeout(struct scb *scb) 214{ 215 return (scb->io_ctx->ccb_h.timeout); 216} 217 218static __inline void 219aic_scb_timer_reset(struct scb *scb, u_int msec) 220{ 221 uint64_t time; 222 223 time = msec; 224 time *= hz; 225 time /= 1000; 226 callout_reset(&scb->io_timer, time, aic_platform_timeout, scb); 227} 228 229static __inline void 230aic_scb_timer_start(struct scb *scb) 231{ 232 233 if (AIC_SCB_DATA(scb->aic_softc)->recovery_scbs == 0 234 && scb->io_ctx->ccb_h.timeout != CAM_TIME_INFINITY) { 235 aic_scb_timer_reset(scb, scb->io_ctx->ccb_h.timeout); 236 } 237} 238 239/************************** Transaction Operations ****************************/ 240static __inline void aic_set_transaction_status(struct scb *, uint32_t); 241static __inline void aic_set_scsi_status(struct scb *, uint32_t); 242static __inline uint32_t aic_get_transaction_status(struct scb *); 243static __inline uint32_t aic_get_scsi_status(struct scb *); 244static __inline void aic_set_transaction_tag(struct scb *, int, u_int); 245static __inline u_long aic_get_transfer_length(struct scb *); 246static __inline int aic_get_transfer_dir(struct scb *); 247static __inline void aic_set_residual(struct scb *, u_long); 248static __inline void aic_set_sense_residual(struct scb *, u_long); 249static __inline u_long aic_get_residual(struct scb *); 250static __inline int aic_perform_autosense(struct scb *); 251static __inline uint32_t aic_get_sense_bufsize(struct aic_softc*, struct scb*); 252static __inline void aic_freeze_ccb(union ccb *ccb); 253static __inline void aic_freeze_scb(struct scb *scb); 254static __inline void aic_platform_freeze_devq(struct aic_softc *, struct scb *); 255static __inline int aic_platform_abort_scbs(struct aic_softc *aic, int target, 256 char channel, int lun, u_int tag, 257 role_t role, uint32_t status); 258 259static __inline 260void aic_set_transaction_status(struct scb *scb, uint32_t status) 261{ 262 scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK; 263 scb->io_ctx->ccb_h.status |= status; 264} 265 266static __inline 267void aic_set_scsi_status(struct scb *scb, uint32_t status) 268{ 269 scb->io_ctx->csio.scsi_status = status; 270} 271 272static __inline 273uint32_t aic_get_transaction_status(struct scb *scb) 274{ 275 return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK); 276} 277 278static __inline 279uint32_t aic_get_scsi_status(struct scb *scb) 280{ 281 return (scb->io_ctx->csio.scsi_status); 282} 283 284static __inline 285void aic_set_transaction_tag(struct scb *scb, int enabled, u_int type) 286{ 287 scb->io_ctx->csio.tag_action = type; 288 if (enabled) 289 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID; 290 else 291 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID; 292} 293 294static __inline 295u_long aic_get_transfer_length(struct scb *scb) 296{ 297 return (scb->io_ctx->csio.dxfer_len); 298} 299 300static __inline 301int aic_get_transfer_dir(struct scb *scb) 302{ 303 return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK); 304} 305 306static __inline 307void aic_set_residual(struct scb *scb, u_long resid) 308{ 309 scb->io_ctx->csio.resid = resid; 310} 311 312static __inline 313void aic_set_sense_residual(struct scb *scb, u_long resid) 314{ 315 scb->io_ctx->csio.sense_resid = resid; 316} 317 318static __inline 319u_long aic_get_residual(struct scb *scb) 320{ 321 return (scb->io_ctx->csio.resid); 322} 323 324static __inline 325int aic_perform_autosense(struct scb *scb) 326{ 327 return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE)); 328} 329 330static __inline uint32_t 331aic_get_sense_bufsize(struct aic_softc *aic, struct scb *scb) 332{ 333 return (sizeof(struct scsi_sense_data)); 334} 335 336static __inline void 337aic_freeze_ccb(union ccb *ccb) 338{ 339 if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) { 340 ccb->ccb_h.status |= CAM_DEV_QFRZN; 341 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1); 342 } 343} 344 345static __inline void 346aic_freeze_scb(struct scb *scb) 347{ 348 aic_freeze_ccb(scb->io_ctx); 349} 350 351static __inline void 352aic_platform_freeze_devq(struct aic_softc *aic, struct scb *scb) 353{ 354 /* Nothing to do here for FreeBSD */ 355} 356 357static __inline int 358aic_platform_abort_scbs(struct aic_softc *aic, int target, 359 char channel, int lun, u_int tag, 360 role_t role, uint32_t status) 361{ 362 /* Nothing to do here for FreeBSD */ 363 return (0); 364} 365 366static __inline void 367aic_platform_scb_free(struct aic_softc *aic, struct scb *scb) 368{ 369 /* What do we do to generically handle driver resource shortages??? */ 370 if ((aic->flags & AIC_RESOURCE_SHORTAGE) != 0 371 && scb->io_ctx != NULL 372 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) { 373 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ; 374 aic->flags &= ~AIC_RESOURCE_SHORTAGE; 375 } 376 scb->io_ctx = NULL; 377} 378 379/*************************** CAM CCB Operations *******************************/ 380void aic_calc_geometry(struct ccb_calc_geometry *ccg, int extended); 381 382/****************************** OS Primitives *********************************/ 383#define aic_delay DELAY 384 385/********************************** PCI ***************************************/ 386#ifdef AIC_PCI_CONFIG 387static __inline uint32_t aic_pci_read_config(aic_dev_softc_t pci, 388 int reg, int width); 389static __inline void aic_pci_write_config(aic_dev_softc_t pci, 390 int reg, uint32_t value, 391 int width); 392static __inline int aic_get_pci_function(aic_dev_softc_t); 393static __inline int aic_get_pci_slot(aic_dev_softc_t); 394static __inline int aic_get_pci_bus(aic_dev_softc_t); 395 396 397static __inline uint32_t 398aic_pci_read_config(aic_dev_softc_t pci, int reg, int width) 399{ 400 return (pci_read_config(pci, reg, width)); 401} 402 403static __inline void 404aic_pci_write_config(aic_dev_softc_t pci, int reg, uint32_t value, int width) 405{ 406 pci_write_config(pci, reg, value, width); 407} 408 409static __inline int 410aic_get_pci_function(aic_dev_softc_t pci) 411{ 412 return (pci_get_function(pci)); 413} 414 415static __inline int 416aic_get_pci_slot(aic_dev_softc_t pci) 417{ 418 return (pci_get_slot(pci)); 419} 420 421static __inline int 422aic_get_pci_bus(aic_dev_softc_t pci) 423{ 424 return (pci_get_bus(pci)); 425} 426 427typedef enum 428{ 429 AIC_POWER_STATE_D0 = PCI_POWERSTATE_D0, 430 AIC_POWER_STATE_D1 = PCI_POWERSTATE_D1, 431 AIC_POWER_STATE_D2 = PCI_POWERSTATE_D2, 432 AIC_POWER_STATE_D3 = PCI_POWERSTATE_D3 433} aic_power_state; 434 435static __inline int aic_power_state_change(struct aic_softc *aic, 436 aic_power_state new_state); 437 438static __inline int 439aic_power_state_change(struct aic_softc *aic, aic_power_state new_state) 440{ 441 return (pci_set_powerstate(aic->dev_softc, new_state)); 442} 443#endif 444