isp_netbsd.h revision 1.72
1 /* $NetBSD: isp_netbsd.h,v 1.72 2010/03/26 20:52:00 mjacob Exp $ */ 2 /* 3 * NetBSD Specific definitions for the Qlogic ISP Host Adapter 4 */ 5 /* 6 * Copyright (C) 1997, 1998, 1999 National Aeronautics & Space Administration 7 * All rights reserved. 8 * 9 * Additional Copyright (C) 2000-2007 by Matthew Jacob 10 * All rights reserved. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. The name of the author may not be used to endorse or promote products 21 * derived from this software without specific prior written permission 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 #ifndef _ISP_NETBSD_H 35 #define _ISP_NETBSD_H 36 37 #include <sys/types.h> 38 #include <sys/param.h> 39 #include <sys/systm.h> 40 #include <sys/kernel.h> 41 #include <sys/errno.h> 42 #include <sys/ioctl.h> 43 #include <sys/device.h> 44 #include <sys/malloc.h> 45 #include <sys/buf.h> 46 #include <sys/proc.h> 47 #include <sys/kthread.h> 48 49 #include <sys/bus.h> 50 51 #include <dev/scsipi/scsi_all.h> 52 #include <dev/scsipi/scsipi_all.h> 53 #include <dev/scsipi/scsiconf.h> 54 55 #include <dev/scsipi/scsi_message.h> 56 #include <dev/scsipi/scsipi_debug.h> 57 58 #include <machine/stdarg.h> 59 60 #include "opt_isp.h" 61 62 /* 63 * Efficiency- get rid of SBus code && tests unless we need them. 64 */ 65 #if defined(__sparcv9__ ) || defined(__sparc__) 66 #define ISP_SBUS_SUPPORTED 1 67 #else 68 #define ISP_SBUS_SUPPORTED 0 69 #endif 70 71 #define ISP_PLATFORM_VERSION_MAJOR 5 72 #define ISP_PLATFORM_VERSION_MINOR 0 73 74 struct isposinfo { 75 device_t dev; 76 struct scsipi_adapter adapter; 77 struct scsipi_channel * chan; 78 bus_dma_tag_t dmatag; 79 bus_dmamap_t rqdmap; 80 bus_dmamap_t rsdmap; 81 bus_dmamap_t scdmap; /* FC only */ 82 uint64_t wwns[256]; /* FC only */ 83 int splsaved; 84 int mboxwaiting; 85 uint32_t islocked; 86 uint32_t onintstack; 87 uint32_t loop_down_time; 88 uint32_t loop_down_limit; 89 uint32_t gone_device_time; 90 unsigned int : 16, 91 : 8, 92 gdt_running : 1, 93 loop_checked : 1, 94 mbox_sleeping : 1, 95 mbox_sleep_ok : 1, 96 mboxcmd_done : 1, 97 mboxbsy : 1, 98 paused : 1, 99 blocked : 1; 100 struct callout ldt; /* loop down timer */ 101 struct callout gdt; /* gone device timer */ 102 uint64_t wwn; 103 uint16_t framesize; 104 uint16_t exec_throttle; 105 struct lwp * thread; 106 }; 107 #define isp_dmatag isp_osinfo.dmatag 108 #define isp_rqdmap isp_osinfo.rqdmap 109 #define isp_rsdmap isp_osinfo.rsdmap 110 #define isp_scdmap isp_osinfo.scdmap 111 112 #define ISP_MUSTPOLL(isp) \ 113 (isp->isp_osinfo.onintstack || isp->isp_osinfo.mbox_sleep_ok == 0) 114 115 /* 116 * Required Macros/Defines 117 */ 118 119 #define ISP_FC_SCRLEN 0x1000 120 121 #define ISP_MEMZERO(dst, a) memset((dst), 0, (a)) 122 #define ISP_MEMCPY(dst, src, a) memcpy((dst), (src), (a)) 123 #define ISP_SNPRINTF snprintf 124 #define ISP_DELAY DELAY 125 #define ISP_SLEEP(isp, x) \ 126 if (!ISP_MUSTPOLL(isp)) \ 127 ISP_UNLOCK(isp); \ 128 DELAY(x); \ 129 if (!ISP_MUSTPOLL(isp)) \ 130 ISP_LOCK(isp) 131 132 #define ISP_INLINE 133 134 #define NANOTIME_T struct timeval 135 #define GET_NANOTIME microtime 136 #define GET_NANOSEC(x) (((x)->tv_sec * 1000000 + (x)->tv_usec) * 1000) 137 #define NANOTIME_SUB isp_microtime_sub 138 139 #define MAXISPREQUEST(isp) 256 140 141 142 #define MEMORYBARRIER(isp, type, offset, size) \ 143 switch (type) { \ 144 case SYNC_REQUEST: \ 145 { \ 146 off_t off = (off_t) offset * QENTRY_LEN; \ 147 bus_dmamap_sync(isp->isp_dmatag, isp->isp_rqdmap, \ 148 off, size, BUS_DMASYNC_PREWRITE); \ 149 break; \ 150 } \ 151 case SYNC_RESULT: \ 152 { \ 153 off_t off = (off_t) offset * QENTRY_LEN; \ 154 bus_dmamap_sync(isp->isp_dmatag, isp->isp_rsdmap, \ 155 off, size, BUS_DMASYNC_POSTREAD); \ 156 break; \ 157 } \ 158 case SYNC_SFORDEV: \ 159 { \ 160 off_t off = (off_t) offset; \ 161 bus_dmamap_sync(isp->isp_dmatag, isp->isp_scdmap, \ 162 off, size, BUS_DMASYNC_PREWRITE); \ 163 break; \ 164 } \ 165 case SYNC_SFORCPU: \ 166 { \ 167 off_t off = (off_t) offset; \ 168 bus_dmamap_sync(isp->isp_dmatag, isp->isp_scdmap, \ 169 off, size, BUS_DMASYNC_POSTREAD); \ 170 break; \ 171 } \ 172 default: \ 173 break; \ 174 } 175 176 #define MBOX_ACQUIRE isp_mbox_acquire 177 #define MBOX_WAIT_COMPLETE isp_mbox_wait_complete 178 #define MBOX_NOTIFY_COMPLETE isp_mbox_notify_done 179 #define MBOX_RELEASE isp_mbox_release 180 181 #define FC_SCRATCH_ACQUIRE(isp, chan) 0 182 #define FC_SCRATCH_RELEASE(isp, chan) do { } while (0) 183 184 #ifndef SCSI_GOOD 185 #define SCSI_GOOD 0x0 186 #endif 187 #ifndef SCSI_CHECK 188 #define SCSI_CHECK 0x2 189 #endif 190 #ifndef SCSI_BUSY 191 #define SCSI_BUSY 0x8 192 #endif 193 #ifndef SCSI_QFULL 194 #define SCSI_QFULL 0x28 195 #endif 196 197 #define XS_T struct scsipi_xfer 198 #define XS_DMA_ADDR_T bus_addr_t 199 #define XS_DMA_ADDR_T bus_addr_t 200 #define XS_GET_DMA64_SEG(a, b, c) \ 201 { \ 202 ispds64_t *d = a; \ 203 bus_dma_segment_t *e = b; \ 204 uint32_t f = c; \ 205 e += f; \ 206 d->ds_base = DMA_LO32(e->ds_addr); \ 207 d->ds_basehi = DMA_HI32(e->ds_addr); \ 208 d->ds_count = e->ds_len; \ 209 } 210 #define XS_GET_DMA_SEG(a, b, c) \ 211 { \ 212 ispds_t *d = a; \ 213 bus_dma_segment_t *e = b; \ 214 uint32_t f = c; \ 215 e += f; \ 216 d->ds_base = DMA_LO32(e->ds_addr); \ 217 d->ds_count = e->ds_len; \ 218 } 219 #define XS_CHANNEL(xs) \ 220 ((int) (xs)->xs_periph->periph_channel->chan_channel) 221 #define XS_ISP(xs) \ 222 device_private((xs)->xs_periph->periph_channel->chan_adapter->adapt_dev) 223 #define XS_LUN(xs) ((int) (xs)->xs_periph->periph_lun) 224 #define XS_TGT(xs) ((int) (xs)->xs_periph->periph_target) 225 #define XS_CDBP(xs) ((uint8_t *) (xs)->cmd) 226 #define XS_CDBLEN(xs) (xs)->cmdlen 227 #define XS_XFRLEN(xs) (xs)->datalen 228 #define XS_TIME(xs) (xs)->timeout 229 #define XS_GET_RESID(xs) (xs)->resid 230 #define XS_SET_RESID(xs, r) (xs)->resid = r 231 #define XS_STSP(xs) (&(xs)->status) 232 #define XS_SNSP(xs) (&(xs)->sense.scsi_sense) 233 #define XS_SNSLEN(xs) (sizeof (xs)->sense) 234 #define XS_SNSKEY(xs) SSD_SENSE_KEY((xs)->sense.scsi_sense.flags) 235 #define XS_SNSASC(xs) ((xs)->sense.scsi_sense.asc) 236 #define XS_SNSASCQ(xs) ((xs)->sense.scsi_sense.ascq) 237 /* PORTING NOTES: check to see if there's a better way of checking for tagged */ 238 #define XS_TAG_P(ccb) (((xs)->xs_control & XS_CTL_POLL) != 0) 239 /* PORTING NOTES: We elimited OTAG option for performance */ 240 #define XS_TAG_TYPE(xs) \ 241 (((xs)->xs_control & XS_CTL_URGENT) ? REQFLAG_HTAG : REQFLAG_STAG) 242 243 #define XS_SETERR(xs, v) (xs)->error = v 244 245 # define HBA_NOERROR XS_NOERROR 246 # define HBA_BOTCH XS_DRIVER_STUFFUP 247 # define HBA_CMDTIMEOUT XS_TIMEOUT 248 # define HBA_SELTIMEOUT XS_SELTIMEOUT 249 # define HBA_TGTBSY XS_BUSY 250 # define HBA_BUSRESET XS_RESET 251 # define HBA_ABORTED XS_DRIVER_STUFFUP 252 # define HBA_DATAOVR XS_DRIVER_STUFFUP 253 # define HBA_ARQFAIL XS_DRIVER_STUFFUP 254 255 #define XS_ERR(xs) (xs)->error 256 #define XS_NOERR(xs) (xs)->error == XS_NOERROR 257 #define XS_INITERR(xs) (xs)->error = 0, XS_CMD_S_CLEAR(xs) 258 259 #define XS_SAVE_SENSE(xs, ptr, len) \ 260 if (xs->error == XS_NOERROR) { \ 261 xs->error = XS_SENSE; \ 262 } \ 263 memcpy(&(xs)->sense, ptr, imin(XS_SNSLEN(xs), len)) 264 265 #define XS_SENSE_VALID(xs) (xs)->error == XS_SENSE 266 267 #define DEFAULT_FRAMESIZE(isp) (isp)->isp_osinfo.framesize 268 #define DEFAULT_EXEC_THROTTLE(isp) (isp)->isp_osinfo.exec_throttle 269 #define GET_DEFAULT_ROLE(isp, chan) ISP_ROLE_INITIATOR 270 #define SET_DEFAULT_ROLE(isp, chan) do { } while (0) 271 #define DEFAULT_IID(x, chan) 7 272 #define DEFAULT_LOOPID(x, chan) 108 273 #define DEFAULT_NODEWWN(isp, chan) (isp)->isp_osinfo.wwn 274 #define DEFAULT_PORTWWN(isp, chan) (isp)->isp_osinfo.wwn 275 #define ACTIVE_NODEWWN(isp, chan) \ 276 ((isp)->isp_osinfo.wwn? (isp)->isp_osinfo.wwn : \ 277 (FCPARAM(isp, chan)->isp_wwnn_nvram? \ 278 FCPARAM(isp, chan)->isp_wwnn_nvram : 0x400000007F000008ull)) 279 #define ACTIVE_PORTWWN(isp, chan) \ 280 ((isp)->isp_osinfo.wwn? (isp)->isp_osinfo.wwn : \ 281 (FCPARAM(isp, chan)->isp_wwpn_nvram? \ 282 FCPARAM(isp, chan)->isp_wwpn_nvram : 0x400000007F000008ull)) 283 284 #if _BYTE_ORDER == _BIG_ENDIAN 285 #ifdef ISP_SBUS_SUPPORTED 286 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 287 #define ISP_IOXPUT_16(isp, s, d) \ 288 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s) 289 #define ISP_IOXPUT_32(isp, s, d) \ 290 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s) 291 292 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 293 #define ISP_IOXGET_16(isp, s, d) \ 294 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 295 *((uint16_t *)s) : bswap16(*((uint16_t *)s)) 296 #define ISP_IOXGET_32(isp, s, d) \ 297 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 298 *((uint32_t *)s) : bswap32(*((uint32_t *)s)) 299 300 #else /* ISP_SBUS_SUPPORTED */ 301 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 302 #define ISP_IOXPUT_16(isp, s, d) *(d) = bswap16(s) 303 #define ISP_IOXPUT_32(isp, s, d) *(d) = bswap32(s) 304 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 305 #define ISP_IOXGET_16(isp, s, d) d = bswap16(*((uint16_t *)s)) 306 #define ISP_IOXGET_32(isp, s, d) d = bswap32(*((uint32_t *)s)) 307 #endif /* ISP_SBUS_SUPPORTED */ 308 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp) 309 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp) 310 311 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)s)) 312 #define ISP_IOZGET_16(isp, s, d) d = (*((uint16_t *)s)) 313 #define ISP_IOZGET_32(isp, s, d) d = (*((uint32_t *)s)) 314 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 315 #define ISP_IOZPUT_16(isp, s, d) *(d) = s 316 #define ISP_IOZPUT_32(isp, s, d) *(d) = s 317 318 #else 319 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 320 #define ISP_IOXPUT_16(isp, s, d) *(d) = s 321 #define ISP_IOXPUT_32(isp, s, d) *(d) = s 322 #define ISP_IOXGET_8(isp, s, d) d = *(s) 323 #define ISP_IOXGET_16(isp, s, d) d = *(s) 324 #define ISP_IOXGET_32(isp, s, d) d = *(s) 325 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) 326 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) 327 328 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 329 #define ISP_IOZPUT_16(isp, s, d) *(d) = bswap16(s) 330 #define ISP_IOZPUT_32(isp, s, d) *(d) = bswap32(s) 331 332 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)(s))) 333 #define ISP_IOZGET_16(isp, s, d) d = bswap16(*((uint16_t *)(s))) 334 #define ISP_IOZGET_32(isp, s, d) d = bswap32(*((uint32_t *)(s))) 335 336 #endif 337 338 #define ISP_SWAP16(isp, x) bswap16(x) 339 #define ISP_SWAP32(isp, x) bswap32(x) 340 341 /* 342 * Includes of common header files 343 */ 344 345 #include <dev/ic/ispreg.h> 346 #include <dev/ic/ispvar.h> 347 #include <dev/ic/ispmbox.h> 348 349 /* 350 * isp_osinfo definitions, extensions and shorthand. 351 */ 352 #define isp_unit device_unit(isp_osinfo.dev) 353 354 355 /* 356 * Driver prototypes.. 357 */ 358 void isp_attach(ispsoftc_t *); 359 void isp_uninit(ispsoftc_t *); 360 361 /* 362 * Driver wide data... 363 */ 364 365 /* 366 * Locking macros... 367 */ 368 #define ISP_LOCK isp_lock 369 #define ISP_UNLOCK isp_unlock 370 #define ISP_ILOCK(x) isp_lock(x); isp->isp_osinfo.onintstack++ 371 #define ISP_IUNLOCK(x) isp->isp_osinfo.onintstack--; isp_unlock(x) 372 373 /* 374 * Platform private flags 375 */ 376 377 #define XS_PSTS_INWDOG 0x10000000 378 #define XS_PSTS_GRACE 0x20000000 379 #define XS_PSTS_ALL 0x30000000 380 381 #define XS_CMD_S_WDOG(xs) (xs)->xs_status |= XS_PSTS_INWDOG 382 #define XS_CMD_C_WDOG(xs) (xs)->xs_status &= ~XS_PSTS_INWDOG 383 #define XS_CMD_WDOG_P(xs) (((xs)->xs_status & XS_PSTS_INWDOG) != 0) 384 385 #define XS_CMD_S_GRACE(xs) (xs)->xs_status |= XS_PSTS_GRACE 386 #define XS_CMD_C_GRACE(xs) (xs)->xs_status &= ~XS_PSTS_GRACE 387 #define XS_CMD_GRACE_P(xs) (((xs)->xs_status & XS_PSTS_GRACE) != 0) 388 389 #define XS_CMD_S_DONE(xs) (xs)->xs_status |= XS_STS_DONE 390 #define XS_CMD_C_DONE(xs) (xs)->xs_status &= ~XS_STS_DONE 391 #define XS_CMD_DONE_P(xs) (((xs)->xs_status & XS_STS_DONE) != 0) 392 393 #define XS_CMD_S_CLEAR(xs) (xs)->xs_status &= ~XS_PSTS_ALL 394 395 /* 396 * Platform Library Functionw 397 */ 398 void isp_prt(ispsoftc_t *, int level, const char *, ...); 399 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...); 400 void isp_lock(ispsoftc_t *); 401 void isp_unlock(ispsoftc_t *); 402 uint64_t isp_microtime_sub(struct timeval *, struct timeval *); 403 int isp_mbox_acquire(ispsoftc_t *); 404 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *); 405 void isp_mbox_notify_done(ispsoftc_t *); 406 void isp_mbox_release(ispsoftc_t *); 407 408 /* 409 * Common Library functions 410 */ 411 #include <dev/ic/isp_library.h> 412 413 #if !defined(ISP_DISABLE_FW) && !defined(ISP_COMPILE_FW) 414 #define ISP_COMPILE_FW 1 415 #endif 416 #endif /* _ISP_NETBSD_H */ 417
Indexes created Mon Sep 22 13:09:51 GMT 2025