1 /* $NetBSD: isp_netbsd.h,v 1.73 2011/02/28 17:17:55 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_MIN imin 133 #define ISP_INLINE 134 135 #define NANOTIME_T struct timeval 136 #define GET_NANOTIME microtime 137 #define GET_NANOSEC(x) (((x)->tv_sec * 1000000 + (x)->tv_usec) * 1000) 138 #define NANOTIME_SUB isp_microtime_sub 139 140 #define MAXISPREQUEST(isp) 256 141 142 143 #define MEMORYBARRIER(isp, type, offset, size, c) \ 144 switch (type) { \ 145 case SYNC_REQUEST: \ 146 { \ 147 off_t off = (off_t) offset * QENTRY_LEN; \ 148 bus_dmamap_sync(isp->isp_dmatag, isp->isp_rqdmap, \ 149 off, size, BUS_DMASYNC_PREWRITE); \ 150 break; \ 151 } \ 152 case SYNC_RESULT: \ 153 { \ 154 off_t off = (off_t) offset * QENTRY_LEN; \ 155 bus_dmamap_sync(isp->isp_dmatag, isp->isp_rsdmap, \ 156 off, size, BUS_DMASYNC_POSTREAD); \ 157 break; \ 158 } \ 159 case SYNC_SFORDEV: \ 160 { \ 161 off_t off = (off_t) offset; \ 162 bus_dmamap_sync(isp->isp_dmatag, isp->isp_scdmap, \ 163 off, size, BUS_DMASYNC_PREWRITE); \ 164 break; \ 165 } \ 166 case SYNC_SFORCPU: \ 167 { \ 168 off_t off = (off_t) offset; \ 169 bus_dmamap_sync(isp->isp_dmatag, isp->isp_scdmap, \ 170 off, size, BUS_DMASYNC_POSTREAD); \ 171 break; \ 172 } \ 173 default: \ 174 break; \ 175 } 176 177 #define MBOX_ACQUIRE isp_mbox_acquire 178 #define MBOX_WAIT_COMPLETE isp_mbox_wait_complete 179 #define MBOX_NOTIFY_COMPLETE isp_mbox_notify_done 180 #define MBOX_RELEASE isp_mbox_release 181 182 #define FC_SCRATCH_ACQUIRE(isp, chan) 0 183 #define FC_SCRATCH_RELEASE(isp, chan) do { } while (0) 184 185 #ifndef SCSI_GOOD 186 #define SCSI_GOOD 0x0 187 #endif 188 #ifndef SCSI_CHECK 189 #define SCSI_CHECK 0x2 190 #endif 191 #ifndef SCSI_BUSY 192 #define SCSI_BUSY 0x8 193 #endif 194 #ifndef SCSI_QFULL 195 #define SCSI_QFULL 0x28 196 #endif 197 198 #define XS_T struct scsipi_xfer 199 #define XS_DMA_ADDR_T bus_addr_t 200 #define XS_DMA_ADDR_T bus_addr_t 201 #define XS_GET_DMA64_SEG(a, b, c) \ 202 { \ 203 ispds64_t *d = a; \ 204 bus_dma_segment_t *e = b; \ 205 uint32_t f = c; \ 206 e += f; \ 207 d->ds_base = DMA_LO32(e->ds_addr); \ 208 d->ds_basehi = DMA_HI32(e->ds_addr); \ 209 d->ds_count = e->ds_len; \ 210 } 211 #define XS_GET_DMA_SEG(a, b, c) \ 212 { \ 213 ispds_t *d = a; \ 214 bus_dma_segment_t *e = b; \ 215 uint32_t f = c; \ 216 e += f; \ 217 d->ds_base = DMA_LO32(e->ds_addr); \ 218 d->ds_count = e->ds_len; \ 219 } 220 #define XS_CHANNEL(xs) \ 221 ((int) (xs)->xs_periph->periph_channel->chan_channel) 222 #define XS_ISP(xs) \ 223 device_private((xs)->xs_periph->periph_channel->chan_adapter->adapt_dev) 224 #define XS_LUN(xs) ((int) (xs)->xs_periph->periph_lun) 225 #define XS_TGT(xs) ((int) (xs)->xs_periph->periph_target) 226 #define XS_CDBP(xs) ((uint8_t *) (xs)->cmd) 227 #define XS_CDBLEN(xs) (xs)->cmdlen 228 #define XS_XFRLEN(xs) (xs)->datalen 229 #define XS_TIME(xs) (xs)->timeout 230 #define XS_GET_RESID(xs) (xs)->resid 231 #define XS_SET_RESID(xs, r) (xs)->resid = r 232 #define XS_STSP(xs) (&(xs)->status) 233 #define XS_SNSP(xs) (&(xs)->sense.scsi_sense) 234 #define XS_SNSLEN(xs) (sizeof (xs)->sense) 235 #define XS_SNSKEY(xs) SSD_SENSE_KEY((xs)->sense.scsi_sense.flags) 236 #define XS_SNSASC(xs) ((xs)->sense.scsi_sense.asc) 237 #define XS_SNSASCQ(xs) ((xs)->sense.scsi_sense.ascq) 238 /* PORTING NOTES: check to see if there's a better way of checking for tagged */ 239 #define XS_TAG_P(ccb) (((xs)->xs_control & XS_CTL_POLL) != 0) 240 /* PORTING NOTES: We elimited OTAG option for performance */ 241 #define XS_TAG_TYPE(xs) \ 242 (((xs)->xs_control & XS_CTL_URGENT) ? REQFLAG_HTAG : REQFLAG_STAG) 243 244 #define XS_SETERR(xs, v) (xs)->error = v 245 246 # define HBA_NOERROR XS_NOERROR 247 # define HBA_BOTCH XS_DRIVER_STUFFUP 248 # define HBA_CMDTIMEOUT XS_TIMEOUT 249 # define HBA_SELTIMEOUT XS_SELTIMEOUT 250 # define HBA_TGTBSY XS_BUSY 251 # define HBA_BUSRESET XS_RESET 252 # define HBA_ABORTED XS_DRIVER_STUFFUP 253 # define HBA_DATAOVR XS_DRIVER_STUFFUP 254 # define HBA_ARQFAIL XS_DRIVER_STUFFUP 255 256 #define XS_ERR(xs) (xs)->error 257 #define XS_NOERR(xs) (xs)->error == XS_NOERROR 258 #define XS_INITERR(xs) (xs)->error = 0, XS_CMD_S_CLEAR(xs) 259 260 #define XS_SAVE_SENSE(xs, ptr, len) \ 261 if (xs->error == XS_NOERROR) { \ 262 xs->error = XS_SENSE; \ 263 } \ 264 memcpy(&(xs)->sense, ptr, imin(XS_SNSLEN(xs), len)) 265 266 #define XS_SENSE_VALID(xs) (xs)->error == XS_SENSE 267 268 #define DEFAULT_FRAMESIZE(isp) (isp)->isp_osinfo.framesize 269 #define DEFAULT_EXEC_THROTTLE(isp) (isp)->isp_osinfo.exec_throttle 270 #define GET_DEFAULT_ROLE(isp, chan) ISP_ROLE_INITIATOR 271 #define SET_DEFAULT_ROLE(isp, chan) do { } while (0) 272 #define DEFAULT_IID(x, chan) 7 273 #define DEFAULT_LOOPID(x, chan) 108 274 #define DEFAULT_NODEWWN(isp, chan) (isp)->isp_osinfo.wwn 275 #define DEFAULT_PORTWWN(isp, chan) (isp)->isp_osinfo.wwn 276 #define ACTIVE_NODEWWN(isp, chan) \ 277 ((isp)->isp_osinfo.wwn? (isp)->isp_osinfo.wwn : \ 278 (FCPARAM(isp, chan)->isp_wwnn_nvram? \ 279 FCPARAM(isp, chan)->isp_wwnn_nvram : 0x400000007F000008ull)) 280 #define ACTIVE_PORTWWN(isp, chan) \ 281 ((isp)->isp_osinfo.wwn? (isp)->isp_osinfo.wwn : \ 282 (FCPARAM(isp, chan)->isp_wwpn_nvram? \ 283 FCPARAM(isp, chan)->isp_wwpn_nvram : 0x400000007F000008ull)) 284 285 #if _BYTE_ORDER == _BIG_ENDIAN 286 #ifdef ISP_SBUS_SUPPORTED 287 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 288 #define ISP_IOXPUT_16(isp, s, d) \ 289 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s) 290 #define ISP_IOXPUT_32(isp, s, d) \ 291 *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s) 292 293 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 294 #define ISP_IOXGET_16(isp, s, d) \ 295 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 296 *((uint16_t *)s) : bswap16(*((uint16_t *)s)) 297 #define ISP_IOXGET_32(isp, s, d) \ 298 d = (isp->isp_bustype == ISP_BT_SBUS)? \ 299 *((uint32_t *)s) : bswap32(*((uint32_t *)s)) 300 301 #else /* ISP_SBUS_SUPPORTED */ 302 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 303 #define ISP_IOXPUT_16(isp, s, d) *(d) = bswap16(s) 304 #define ISP_IOXPUT_32(isp, s, d) *(d) = bswap32(s) 305 #define ISP_IOXGET_8(isp, s, d) d = (*((uint8_t *)s)) 306 #define ISP_IOXGET_16(isp, s, d) d = bswap16(*((uint16_t *)s)) 307 #define ISP_IOXGET_32(isp, s, d) d = bswap32(*((uint32_t *)s)) 308 #endif /* ISP_SBUS_SUPPORTED */ 309 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) *rp = bswap16(*rp) 310 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) *rp = bswap32(*rp) 311 312 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)s)) 313 #define ISP_IOZGET_16(isp, s, d) d = (*((uint16_t *)s)) 314 #define ISP_IOZGET_32(isp, s, d) d = (*((uint32_t *)s)) 315 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 316 #define ISP_IOZPUT_16(isp, s, d) *(d) = s 317 #define ISP_IOZPUT_32(isp, s, d) *(d) = s 318 319 #else 320 #define ISP_IOXPUT_8(isp, s, d) *(d) = s 321 #define ISP_IOXPUT_16(isp, s, d) *(d) = s 322 #define ISP_IOXPUT_32(isp, s, d) *(d) = s 323 #define ISP_IOXGET_8(isp, s, d) d = *(s) 324 #define ISP_IOXGET_16(isp, s, d) d = *(s) 325 #define ISP_IOXGET_32(isp, s, d) d = *(s) 326 #define ISP_SWIZZLE_NVRAM_WORD(isp, rp) 327 #define ISP_SWIZZLE_NVRAM_LONG(isp, rp) 328 329 #define ISP_IOZPUT_8(isp, s, d) *(d) = s 330 #define ISP_IOZPUT_16(isp, s, d) *(d) = bswap16(s) 331 #define ISP_IOZPUT_32(isp, s, d) *(d) = bswap32(s) 332 333 #define ISP_IOZGET_8(isp, s, d) d = (*((uint8_t *)(s))) 334 #define ISP_IOZGET_16(isp, s, d) d = bswap16(*((uint16_t *)(s))) 335 #define ISP_IOZGET_32(isp, s, d) d = bswap32(*((uint32_t *)(s))) 336 337 #endif 338 339 #define ISP_SWAP16(isp, x) bswap16(x) 340 #define ISP_SWAP32(isp, x) bswap32(x) 341 342 /* 343 * Includes of common header files 344 */ 345 346 #include <dev/ic/ispreg.h> 347 #include <dev/ic/ispvar.h> 348 #include <dev/ic/ispmbox.h> 349 350 /* 351 * isp_osinfo definitions, extensions and shorthand. 352 */ 353 #define isp_unit device_unit(isp_osinfo.dev) 354 355 356 /* 357 * Driver prototypes.. 358 */ 359 void isp_attach(ispsoftc_t *); 360 void isp_uninit(ispsoftc_t *); 361 362 /* 363 * Driver wide data... 364 */ 365 366 /* 367 * Locking macros... 368 */ 369 #define ISP_LOCK isp_lock 370 #define ISP_UNLOCK isp_unlock 371 #define ISP_ILOCK(x) isp_lock(x); isp->isp_osinfo.onintstack++ 372 #define ISP_IUNLOCK(x) isp->isp_osinfo.onintstack--; isp_unlock(x) 373 374 /* 375 * Platform private flags 376 */ 377 378 #define XS_PSTS_INWDOG 0x10000000 379 #define XS_PSTS_GRACE 0x20000000 380 #define XS_PSTS_ALL 0x30000000 381 382 #define XS_CMD_S_WDOG(xs) (xs)->xs_status |= XS_PSTS_INWDOG 383 #define XS_CMD_C_WDOG(xs) (xs)->xs_status &= ~XS_PSTS_INWDOG 384 #define XS_CMD_WDOG_P(xs) (((xs)->xs_status & XS_PSTS_INWDOG) != 0) 385 386 #define XS_CMD_S_GRACE(xs) (xs)->xs_status |= XS_PSTS_GRACE 387 #define XS_CMD_C_GRACE(xs) (xs)->xs_status &= ~XS_PSTS_GRACE 388 #define XS_CMD_GRACE_P(xs) (((xs)->xs_status & XS_PSTS_GRACE) != 0) 389 390 #define XS_CMD_S_DONE(xs) (xs)->xs_status |= XS_STS_DONE 391 #define XS_CMD_C_DONE(xs) (xs)->xs_status &= ~XS_STS_DONE 392 #define XS_CMD_DONE_P(xs) (((xs)->xs_status & XS_STS_DONE) != 0) 393 394 #define XS_CMD_S_CLEAR(xs) (xs)->xs_status &= ~XS_PSTS_ALL 395 396 /* 397 * Platform Library Functionw 398 */ 399 void isp_prt(ispsoftc_t *, int level, const char *, ...); 400 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...); 401 void isp_lock(ispsoftc_t *); 402 void isp_unlock(ispsoftc_t *); 403 uint64_t isp_microtime_sub(struct timeval *, struct timeval *); 404 int isp_mbox_acquire(ispsoftc_t *); 405 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *); 406 void isp_mbox_notify_done(ispsoftc_t *); 407 void isp_mbox_release(ispsoftc_t *); 408 409 /* 410 * Common Library functions 411 */ 412 #include <dev/ic/isp_library.h> 413 414 #if !defined(ISP_DISABLE_FW) && !defined(ISP_COMPILE_FW) 415 #define ISP_COMPILE_FW 1 416 #endif 417 #endif /* _ISP_NETBSD_H */ 418