xref: /dragonfly/sys/dev/disk/isp/isp_freebsd.h (revision 030b0c8c4cf27c560ccec70410c8e21934ae677d)
1 /* $FreeBSD: src/sys/dev/isp/isp_freebsd.h,v 1.120 2011/11/06 00:44:40 mjacob Exp $ */
2 /*-
3  * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions
4  *
5  * Copyright (c) 1997-2008 by Matthew Jacob
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice immediately at the beginning of the file, without modification,
13  *    this list of conditions, and the following disclaimer.
14  * 2. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 #ifndef   _ISP_FREEBSD_H
30 #define   _ISP_FREEBSD_H
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/endian.h>
35 #include <sys/lock.h>
36 #include <sys/kernel.h>
37 #include <sys/queue.h>
38 #include <sys/malloc.h>
39 #include <sys/condvar.h>
40 #include <sys/sysctl.h>
41 
42 #include <sys/proc.h>
43 #include <sys/bus.h>
44 #include <sys/taskqueue.h>
45 
46 #include <machine/cpu.h>
47 #include <machine/stdarg.h>
48 
49 #include <bus/cam/cam.h>
50 #include <bus/cam/cam_debug.h>
51 #include <bus/cam/cam_ccb.h>
52 #include <bus/cam/cam_sim.h>
53 #include <bus/cam/cam_xpt.h>
54 #include <bus/cam/cam_xpt_sim.h>
55 #include <bus/cam/scsi/scsi_all.h>
56 #include <bus/cam/scsi/scsi_message.h>
57 
58 #include "opt_isp.h"
59 
60 #define   ISP_PLATFORM_VERSION_MAJOR    7
61 #define   ISP_PLATFORM_VERSION_MINOR    0
62 
63 /*
64  * Efficiency- get rid of SBus code && tests unless we need them.
65  */
66 #define   ISP_SBUS_SUPPORTED  0
67 
68 #define   ISP_IFLAGS          INTR_MPSAFE
69 
70 #ifdef    ISP_TARGET_MODE
71 #define   ISP_TARGET_FUNCTIONS          1
72 #define   ATPDPSIZE 4096
73 
74 #include <dev/disk/isp/isp_target.h>
75 
76 typedef struct {
77           void *              next;
78           uint32_t  orig_datalen;
79           uint32_t  bytes_xfered;
80           uint32_t  last_xframt;
81           uint32_t  tag;
82           uint32_t  lun;
83           uint32_t  nphdl;
84           uint32_t  sid;
85           uint32_t  portid;
86           uint32_t
87                               oxid      : 16,
88                               cdb0      : 8,
89                                         : 1,
90                               dead      : 1,
91                               tattr     : 3,
92                               state     : 3;
93 } atio_private_data_t;
94 #define   ATPD_STATE_FREE                         0
95 #define   ATPD_STATE_ATIO                         1
96 #define   ATPD_STATE_CAM                          2
97 #define   ATPD_STATE_CTIO                         3
98 #define   ATPD_STATE_LAST_CTIO                    4
99 #define   ATPD_STATE_PDON                         5
100 
101 typedef union inot_private_data inot_private_data_t;
102 union inot_private_data {
103           inot_private_data_t *next;
104           struct {
105                     isp_notify_t nt;    /* must be first! */
106                     uint8_t data[64];   /* sb QENTRY_LEN, but order of definitions is wrong */
107                     uint32_t tag_id, seq_id;
108           } rd;
109 };
110 
111 typedef struct tstate {
112           SLIST_ENTRY(tstate) next;
113           struct cam_path *owner;
114           struct ccb_hdr_slist atios;
115           struct ccb_hdr_slist inots;
116           uint32_t hold;
117           int atio_count;
118           int inot_count;
119           inot_private_data_t *         restart_queue;
120           inot_private_data_t *         ntfree;
121           inot_private_data_t ntpool[ATPDPSIZE];
122           atio_private_data_t *         atfree;
123           atio_private_data_t atpool[ATPDPSIZE];
124 } tstate_t;
125 
126 #define   LUN_HASH_SIZE                 32
127 #define   LUN_HASH_FUNC(lun)  ((lun) & (LUN_HASH_SIZE - 1))
128 
129 #endif
130 
131 /*
132  * Per command info.
133  */
134 struct isp_pcmd {
135           struct isp_pcmd *   next;
136           bus_dmamap_t                  dmap;     /* dma map for this command */
137           struct ispsoftc *   isp;      /* containing isp */
138           struct callout                wdog;     /* watchdog timer */
139 };
140 #define   ISP_PCMD(ccb)                 (ccb)->ccb_h.spriv_ptr1
141 #define   PISP_PCMD(ccb)                ((struct isp_pcmd *)ISP_PCMD(ccb))
142 
143 /*
144  * Per channel information
145  */
146 SLIST_HEAD(tslist, tstate);
147 
148 struct isp_fc {
149           struct cam_sim *sim;
150           struct cam_path *path;
151           struct ispsoftc *isp;
152           struct thread *kthread;
153           bus_dma_tag_t tdmat;
154           bus_dmamap_t tdmap;
155           uint64_t def_wwpn;
156           uint64_t def_wwnn;
157           uint32_t loop_down_time;
158           uint32_t loop_down_limit;
159           uint32_t gone_device_time;
160           uint32_t
161 #ifdef    ISP_TARGET_MODE
162 #ifdef    ISP_INTERNAL_TARGET
163                     proc_active         : 1,
164 #endif
165                     tm_luns_enabled     : 1,
166                     tm_enable_defer     : 1,
167                     tm_enabled          : 1,
168 #endif
169                     simqfrozen          : 3,
170                     default_id          : 8,
171                     hysteresis          : 8,
172                     def_role  : 2,      /* default role */
173                     gdt_running         : 1,
174                     loop_dead : 1,
175                     fcbsy               : 1,
176                     ready               : 1;
177           struct callout ldt; /* loop down timer */
178           struct callout gdt; /* gone device timer */
179           struct task ltask;
180           struct task gtask;
181 #ifdef    ISP_TARGET_MODE
182           struct tslist lun_hash[LUN_HASH_SIZE];
183 #ifdef    ISP_INTERNAL_TARGET
184           struct proc *                 target_proc;
185 #endif
186 #endif
187 };
188 
189 struct isp_spi {
190           struct cam_sim *sim;
191           struct cam_path *path;
192           uint32_t
193 #ifdef    ISP_TARGET_MODE
194 #ifdef    ISP_INTERNAL_TARGET
195                     proc_active         : 1,
196 #endif
197                     tm_luns_enabled     : 1,
198                     tm_enable_defer     : 1,
199                     tm_enabled          : 1,
200 #endif
201                     simqfrozen          : 3,
202                     def_role  : 2,
203                     iid                 : 4;
204 #ifdef    ISP_TARGET_MODE
205           struct tslist lun_hash[LUN_HASH_SIZE];
206 #ifdef    ISP_INTERNAL_TARGET
207           struct proc *                 target_proc;
208 #endif
209 #endif
210 };
211 
212 struct isposinfo {
213           /*
214            * Linkage, locking, and identity
215            */
216           struct lock                   lock;
217           device_t            dev;
218           struct cdev *                 cdev;
219           struct intr_config_hook       ehook;
220           struct cam_devq *   devq;
221 
222           /*
223            * Firmware pointer
224            */
225           const struct firmware *       fw;
226 
227           /*
228            * DMA related sdtuff
229            */
230           bus_space_tag_t               bus_tag;
231           bus_dma_tag_t                 dmat;
232           bus_space_handle_t  bus_handle;
233           bus_dma_tag_t                 cdmat;
234           bus_dmamap_t                  cdmap;
235 
236           /*
237            * Command and transaction related related stuff
238            */
239           struct isp_pcmd *   pcmd_pool;
240           struct isp_pcmd *   pcmd_free;
241 
242           uint32_t
243 #ifdef    ISP_TARGET_MODE
244                     tmwanted  : 1,
245                     tmbusy              : 1,
246 #else
247                                         : 2,
248 #endif
249                     forcemulti          : 1,
250                     timer_active        : 1,
251                     autoconf  : 1,
252                     ehook_active        : 1,
253                     disabled  : 1,
254                     mbox_sleeping       : 1,
255                     mbox_sleep_ok       : 1,
256                     mboxcmd_done        : 1,
257                     mboxbsy             : 1;
258 
259           struct callout                tmo;      /* general timer */
260 
261           /*
262            * misc- needs to be sorted better XXXXXX
263            */
264           int                           framesize;
265           int                           exec_throttle;
266           int                           cont_max;
267 
268 #ifdef    ISP_TARGET_MODE
269           cam_status *                  rptr;
270 #endif
271 
272           /*
273            * Per-type private storage...
274            */
275           union {
276                     struct isp_fc *fc;
277                     struct isp_spi *spi;
278                     void *ptr;
279           } pc;
280 };
281 #define   ISP_FC_PC(isp, chan)          (&(isp)->isp_osinfo.pc.fc[(chan)])
282 #define   ISP_SPI_PC(isp, chan)         (&(isp)->isp_osinfo.pc.spi[(chan)])
283 #define   ISP_GET_PC(isp, chan, tag, rslt)                  \
284           if (IS_SCSI(isp)) {                               \
285                     rslt = ISP_SPI_PC(isp, chan)-> tag;     \
286           } else {                                          \
287                     rslt = ISP_FC_PC(isp, chan)-> tag;      \
288           }
289 #define   ISP_GET_PC_ADDR(isp, chan, tag, rp)               \
290           if (IS_SCSI(isp)) {                               \
291                     rp = &ISP_SPI_PC(isp, chan)-> tag;      \
292           } else {                                          \
293                     rp = &ISP_FC_PC(isp, chan)-> tag;       \
294           }
295 #define   ISP_SET_PC(isp, chan, tag, val)                             \
296           if (IS_SCSI(isp)) {                               \
297                     ISP_SPI_PC(isp, chan)-> tag = val;      \
298           } else {                                          \
299                     ISP_FC_PC(isp, chan)-> tag = val;       \
300           }
301 
302 #define   isp_lock  isp_osinfo.lock
303 #define   isp_bus_tag         isp_osinfo.bus_tag
304 #define   isp_bus_handle      isp_osinfo.bus_handle
305 
306 /*
307  * Locking macros...
308  */
309 #define   ISP_LOCK(isp)       lockmgr(&isp->isp_osinfo.lock, LK_EXCLUSIVE)
310 #define   ISP_UNLOCK(isp)     lockmgr(&isp->isp_osinfo.lock, LK_RELEASE)
311 
312 /*
313  * Required Macros/Defines
314  */
315 
316 #define   ISP_FC_SCRLEN                 0x1000
317 
318 #define   ISP_MEMZERO(a, b)   memset(a, 0, b)
319 #define   ISP_MEMCPY                    memcpy
320 #define   ISP_SNPRINTF                  ksnprintf
321 #define   ISP_DELAY           DELAY
322 #define   ISP_SLEEP(isp, x)   DELAY(x)
323 
324 #define   ISP_MIN                       imin
325 
326 #ifndef   DIAGNOSTIC
327 #define   ISP_INLINE                    __inline
328 #else
329 #define   ISP_INLINE
330 #endif
331 
332 #define   NANOTIME_T                    struct timespec
333 #define   GET_NANOTIME                  nanotime
334 #define   GET_NANOSEC(x)                ((x)->tv_sec * 1000000000 + (x)->tv_nsec)
335 #define   NANOTIME_SUB                  isp_nanotime_sub
336 
337 #define   MAXISPREQUEST(isp)  ((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
338 
339 #define   MEMORYBARRIER(isp, type, offset, size, chan)                \
340 switch (type) {                                                                 \
341 case SYNC_SFORDEV:                                                    \
342 {                                                                               \
343           struct isp_fc *fc = ISP_FC_PC(isp, chan);                   \
344           bus_dmamap_sync(fc->tdmat, fc->tdmap,                       \
345              BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);             \
346           break;                                                                \
347 }                                                                               \
348 case SYNC_REQUEST:                                                    \
349           bus_dmamap_sync(isp->isp_osinfo.cdmat,                      \
350              isp->isp_osinfo.cdmap,                                   \
351              BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);             \
352           break;                                                                \
353 case SYNC_SFORCPU:                                                    \
354 {                                                                               \
355           struct isp_fc *fc = ISP_FC_PC(isp, chan);                   \
356           bus_dmamap_sync(fc->tdmat, fc->tdmap,                       \
357              BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \
358           break;                                                                \
359 }                                                                               \
360 case SYNC_RESULT:                                                     \
361           bus_dmamap_sync(isp->isp_osinfo.cdmat,                      \
362              isp->isp_osinfo.cdmap,                                   \
363              BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); \
364           break;                                                                \
365 case SYNC_REG:                                                                  \
366           bus_space_barrier(isp->isp_osinfo.bus_tag,                  \
367               isp->isp_osinfo.bus_handle, offset, size,               \
368               BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);      \
369           break;                                                                \
370 default:                                                              \
371           break;                                                                \
372 }
373 
374 #define   MBOX_ACQUIRE                            isp_mbox_acquire
375 #define   MBOX_WAIT_COMPLETE            isp_mbox_wait_complete
376 #define   MBOX_NOTIFY_COMPLETE                    isp_mbox_notify_done
377 #define   MBOX_RELEASE                            isp_mbox_release
378 
379 #define   FC_SCRATCH_ACQUIRE            isp_fc_scratch_acquire
380 #define   FC_SCRATCH_RELEASE(isp, chan) isp->isp_osinfo.pc.fc[chan].fcbsy = 0
381 
382 #ifndef   SCSI_GOOD
383 #define   SCSI_GOOD SCSI_STATUS_OK
384 #endif
385 #ifndef   SCSI_CHECK
386 #define   SCSI_CHECK          SCSI_STATUS_CHECK_COND
387 #endif
388 #ifndef   SCSI_BUSY
389 #define   SCSI_BUSY SCSI_STATUS_BUSY
390 #endif
391 #ifndef   SCSI_QFULL
392 #define   SCSI_QFULL          SCSI_STATUS_QUEUE_FULL
393 #endif
394 
395 #define   XS_T                          struct ccb_scsiio
396 #define   XS_DMA_ADDR_T                 bus_addr_t
397 #define XS_GET_DMA64_SEG(a, b, c)                 \
398 {                                                           \
399           ispds64_t *d = a;                       \
400           bus_dma_segment_t *e = b;               \
401           uint32_t f = c;                                   \
402           e += f;                                           \
403         d->ds_base = DMA_LO32(e->ds_addr);        \
404         d->ds_basehi = DMA_HI32(e->ds_addr);      \
405         d->ds_count = e->ds_len;                  \
406 }
407 #define XS_GET_DMA_SEG(a, b, c)                             \
408 {                                                           \
409           ispds_t *d = a;                                   \
410           bus_dma_segment_t *e = b;               \
411           uint32_t f = c;                                   \
412           e += f;                                           \
413         d->ds_base = DMA_LO32(e->ds_addr);        \
414         d->ds_count = e->ds_len;                  \
415 }
416 #define   XS_ISP(ccb)                   cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
417 #define   XS_CHANNEL(ccb)               cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
418 #define   XS_TGT(ccb)                   (ccb)->ccb_h.target_id
419 #define   XS_LUN(ccb)                   (ccb)->ccb_h.target_lun
420 
421 #define   XS_CDBP(ccb)        \
422           (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
423            (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
424 
425 #define   XS_CDBLEN(ccb)                (ccb)->cdb_len
426 #define   XS_XFRLEN(ccb)                (ccb)->dxfer_len
427 #define   XS_TIME(ccb)                  (ccb)->ccb_h.timeout
428 #define   XS_GET_RESID(ccb)   (ccb)->resid
429 #define   XS_SET_RESID(ccb, r)          (ccb)->resid = r
430 #define   XS_STSP(ccb)                  (&(ccb)->scsi_status)
431 #define   XS_SNSP(ccb)                  (&(ccb)->sense_data)
432 
433 #define   XS_SNSLEN(ccb)                \
434           imin((sizeof((ccb)->sense_data)), ccb->sense_len - ccb->sense_resid)
435 
436 #define   XS_SNSKEY(ccb)                (scsi_get_sense_key(&(ccb)->sense_data, \
437                                          ccb->sense_len - ccb->sense_resid,     \
438                                          /*show_errors*/ 1))
439 
440 #define   XS_SNSASC(ccb)                (scsi_get_asc(&(ccb)->sense_data,       \
441                                          ccb->sense_len - ccb->sense_resid,     \
442                                          /*show_errors*/ 1))
443 
444 #define   XS_SNSASCQ(ccb)               (scsi_get_ascq(&(ccb)->sense_data,      \
445                                          ccb->sense_len - ccb->sense_resid,     \
446                                          /*show_errors*/ 1))
447 #define   XS_TAG_P(ccb)       \
448           (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
449            (ccb)->tag_action != CAM_TAG_ACTION_NONE)
450 
451 #define   XS_TAG_TYPE(ccb)    \
452           ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
453            ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
454 
455 
456 #define   XS_SETERR(ccb, v)   (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
457                                         (ccb)->ccb_h.status |= v, \
458                                         (ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
459 
460 #         define    HBA_NOERROR                   CAM_REQ_INPROG
461 #         define    HBA_BOTCH           CAM_UNREC_HBA_ERROR
462 #         define    HBA_CMDTIMEOUT                CAM_CMD_TIMEOUT
463 #         define    HBA_SELTIMEOUT                CAM_SEL_TIMEOUT
464 #         define    HBA_TGTBSY                    CAM_SCSI_STATUS_ERROR
465 #         define    HBA_BUSRESET                  CAM_SCSI_BUS_RESET
466 #         define    HBA_ABORTED                   CAM_REQ_ABORTED
467 #         define    HBA_DATAOVR                   CAM_DATA_RUN_ERR
468 #         define    HBA_ARQFAIL                   CAM_AUTOSENSE_FAIL
469 
470 
471 #define   XS_ERR(ccb)                   ((ccb)->ccb_h.status & CAM_STATUS_MASK)
472 
473 #define   XS_NOERR(ccb)                 \
474           (((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
475            ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
476 
477 #define   XS_INITERR(ccb)               \
478           XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
479 
480 #define   XS_SAVE_SENSE(xs, sense_ptr, slen)      do {                          \
481                     (xs)->ccb_h.status |= CAM_AUTOSNS_VALID;                    \
482                     memset(&(xs)->sense_data, 0, sizeof((xs)->sense_data));     \
483                     memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs),\
484                            slen));                                                        \
485                     if (slen < (xs)->sense_len)                                 \
486                               (xs)->sense_resid = (xs)->sense_len - slen;       \
487           } while (0);
488 
489 #define   XS_SENSE_VALID(xs)  (((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
490 
491 #define   DEFAULT_FRAMESIZE(isp)                  isp->isp_osinfo.framesize
492 #define   DEFAULT_EXEC_THROTTLE(isp)    isp->isp_osinfo.exec_throttle
493 
494 #define   GET_DEFAULT_ROLE(isp, chan)   \
495           (IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_SPI_PC(isp, chan)->def_role)
496 #define   SET_DEFAULT_ROLE(isp, chan, val)                  \
497           if (IS_FC(isp)) {                                 \
498                     ISP_FC_PC(isp, chan)->def_role = val;   \
499           } else {                                          \
500                     ISP_SPI_PC(isp, chan)->def_role = val;  \
501           }
502 
503 #define   DEFAULT_IID(isp, chan)                  isp->isp_osinfo.pc.spi[chan].iid
504 
505 #define   DEFAULT_LOOPID(x, chan)                 isp->isp_osinfo.pc.fc[chan].default_id
506 
507 #define DEFAULT_NODEWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 1)
508 #define DEFAULT_PORTWWN(isp, chan)      isp_default_wwn(isp, chan, 0, 0)
509 #define ACTIVE_NODEWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 1)
510 #define ACTIVE_PORTWWN(isp, chan)       isp_default_wwn(isp, chan, 1, 0)
511 
512 
513 #if       BYTE_ORDER == BIG_ENDIAN
514 #ifdef    ISP_SBUS_SUPPORTED
515 #define   ISP_IOXPUT_8(isp, s, d)                 *(d) = s
516 #define   ISP_IOXPUT_16(isp, s, d)                                    \
517           *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
518 #define   ISP_IOXPUT_32(isp, s, d)                                    \
519           *(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
520 #define   ISP_IOXGET_8(isp, s, d)                 d = (*((uint8_t *)s))
521 #define   ISP_IOXGET_16(isp, s, d)                                    \
522           d = (isp->isp_bustype == ISP_BT_SBUS)?                      \
523           *((uint16_t *)s) : bswap16(*((uint16_t *)s))
524 #define   ISP_IOXGET_32(isp, s, d)                                    \
525           d = (isp->isp_bustype == ISP_BT_SBUS)?                      \
526           *((uint32_t *)s) : bswap32(*((uint32_t *)s))
527 
528 #else     /* ISP_SBUS_SUPPORTED */
529 #define   ISP_IOXPUT_8(isp, s, d)                 *(d) = s
530 #define   ISP_IOXPUT_16(isp, s, d)      *(d) = bswap16(s)
531 #define   ISP_IOXPUT_32(isp, s, d)      *(d) = bswap32(s)
532 #define   ISP_IOXGET_8(isp, s, d)                 d = (*((uint8_t *)s))
533 #define   ISP_IOXGET_16(isp, s, d)      d = bswap16(*((uint16_t *)s))
534 #define   ISP_IOXGET_32(isp, s, d)      d = bswap32(*((uint32_t *)s))
535 #endif
536 #define   ISP_SWIZZLE_NVRAM_WORD(isp, rp)         *rp = bswap16(*rp)
537 #define   ISP_SWIZZLE_NVRAM_LONG(isp, rp)         *rp = bswap32(*rp)
538 
539 #define   ISP_IOZGET_8(isp, s, d)                 d = (*((uint8_t *)s))
540 #define   ISP_IOZGET_16(isp, s, d)      d = (*((uint16_t *)s))
541 #define   ISP_IOZGET_32(isp, s, d)      d = (*((uint32_t *)s))
542 #define   ISP_IOZPUT_8(isp, s, d)                 *(d) = s
543 #define   ISP_IOZPUT_16(isp, s, d)      *(d) = s
544 #define   ISP_IOZPUT_32(isp, s, d)      *(d) = s
545 
546 
547 #else
548 #define   ISP_IOXPUT_8(isp, s, d)                 *(d) = s
549 #define   ISP_IOXPUT_16(isp, s, d)      *(d) = s
550 #define   ISP_IOXPUT_32(isp, s, d)      *(d) = s
551 #define   ISP_IOXGET_8(isp, s, d)                 d = *(s)
552 #define   ISP_IOXGET_16(isp, s, d)      d = *(s)
553 #define   ISP_IOXGET_32(isp, s, d)      d = *(s)
554 #define   ISP_SWIZZLE_NVRAM_WORD(isp, rp)
555 #define   ISP_SWIZZLE_NVRAM_LONG(isp, rp)
556 
557 #define   ISP_IOZPUT_8(isp, s, d)                 *(d) = s
558 #define   ISP_IOZPUT_16(isp, s, d)      *(d) = bswap16(s)
559 #define   ISP_IOZPUT_32(isp, s, d)      *(d) = bswap32(s)
560 
561 #define   ISP_IOZGET_8(isp, s, d)                 d = (*((uint8_t *)(s)))
562 #define   ISP_IOZGET_16(isp, s, d)      d = bswap16(*((uint16_t *)(s)))
563 #define   ISP_IOZGET_32(isp, s, d)      d = bswap32(*((uint32_t *)(s)))
564 
565 #endif
566 
567 #define   ISP_SWAP16(isp, s)  bswap16(s)
568 #define   ISP_SWAP32(isp, s)  bswap32(s)
569 
570 /*
571  * Includes of common header files
572  */
573 
574 #include <dev/disk/isp/ispreg.h>
575 #include <dev/disk/isp/ispvar.h>
576 #include <dev/disk/isp/ispmbox.h>
577 
578 /*
579  * isp_osinfo definiitions && shorthand
580  */
581 #define   SIMQFRZ_RESOURCE    0x1
582 #define   SIMQFRZ_LOOPDOWN    0x2
583 #define   SIMQFRZ_TIMED                 0x4
584 
585 #define   isp_dev             isp_osinfo.dev
586 
587 /*
588  * prototypes for isp_pci && isp_freebsd to share
589  */
590 extern int isp_attach(ispsoftc_t *);
591 extern int isp_detach(ispsoftc_t *);
592 extern void isp_uninit(ispsoftc_t *);
593 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
594 
595 /*
596  * driver global data
597  */
598 extern int isp_announced;
599 extern int isp_fabric_hysteresis;
600 extern int isp_loop_down_limit;
601 extern int isp_gone_device_time;
602 extern int isp_quickboot_time;
603 extern int isp_autoconfig;
604 
605 /*
606  * Platform private flags
607  */
608 #define   ISP_SPRIV_ERRSET    0x1
609 #define   ISP_SPRIV_TACTIVE   0x2
610 #define   ISP_SPRIV_DONE                0x8
611 #define   ISP_SPRIV_WPEND               0x10
612 
613 #define   XS_S_TACTIVE(sccb)  (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_TACTIVE
614 #define   XS_C_TACTIVE(sccb)  (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_TACTIVE
615 #define   XS_TACTIVE_P(sccb)  ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_TACTIVE)
616 
617 #define   XS_CMD_S_DONE(sccb) (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
618 #define   XS_CMD_C_DONE(sccb) (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
619 #define   XS_CMD_DONE_P(sccb) ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
620 
621 #define   XS_CMD_S_WPEND(sccb)          (sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_WPEND
622 #define   XS_CMD_C_WPEND(sccb)          (sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_WPEND
623 #define   XS_CMD_WPEND_P(sccb)          ((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_WPEND)
624 
625 
626 #define   XS_CMD_S_CLEAR(sccb)          (sccb)->ccb_h.spriv_field0 = 0
627 
628 /*
629  * Platform Library Functions
630  */
631 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
632 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
633 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
634 int isp_mbox_acquire(ispsoftc_t *);
635 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
636 void isp_mbox_notify_done(ispsoftc_t *);
637 void isp_mbox_release(ispsoftc_t *);
638 int isp_fc_scratch_acquire(ispsoftc_t *, int);
639 int isp_mstohz(int);
640 void isp_platform_intr(void *);
641 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
642 
643 /*
644  * Platform Version specific defines
645  */
646 #define   BUS_DMA_ROOTARG(x)  bus_get_dma_tag(x)
647 #define   isp_dma_tag_create(parent_tag, alignment, boundary, \
648                               lowaddr, highaddr, _filter, _filterarg, \
649                               maxsize, nsegments, maxsegsz, flags, dma_tagp)    \
650         bus_dma_tag_create(parent_tag, alignment, boundary, \
651                               lowaddr, highaddr, maxsize, nsegments, maxsegsz, \
652                               flags, dma_tagp)
653 
654 #define   isp_setup_intr      bus_setup_intr
655 
656 #define   isp_sim_alloc(a, b, c, d, e, f, g, h)   \
657           cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
658 
659 /* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
660 #define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
661 
662 #define   ISP_PATH_PRT(i, l, p, ...)                                            \
663           if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {                \
664                 xpt_print(p, __VA_ARGS__);                                      \
665         }
666 
667 /*
668  * Platform specific inline functions
669  */
670 
671 /*
672  * ISP General Library functions
673  */
674 
675 #include <dev/disk/isp/isp_library.h>
676 
677 #endif    /* _ISP_FREEBSD_H */
678