sys/dev/mpt/mpt.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Generic defines for LSI '909 FC  adapters.
   4  * FreeBSD Version.
   5  *
   6  * Copyright (c)  2000, 2001 by Greg Ansley
   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 /*-
  30  * Copyright (c) 2002, 2006 by Matthew Jacob
  31  * All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions are
  35  * met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  39  *    substantially similar to the "NO WARRANTY" disclaimer below
  40  *    ("Disclaimer") and any redistribution must be conditioned upon including
  41  *    a substantially similar Disclaimer requirement for further binary
  42  *    redistribution.
  43  * 3. Neither the names of the above listed copyright holders nor the names
  44  *    of any contributors may be used to endorse or promote products derived
  45  *    from this software without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  48  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  51  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  52  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  53  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  54  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  55  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  56  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
  57  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  58  *
  59  * Support from Chris Ellsworth in order to make SAS adapters work
  60  * is gratefully acknowledged.
  61  *
  62  *
  63  * Support from LSI-Logic has also gone a great deal toward making this a
  64  * workable subsystem and is gratefully acknowledged.
  65  */
  66 /*
  67  * Copyright (c) 2004, Avid Technology, Inc. and its contributors.
  68  * Copyright (c) 2004, 2005 Justin T. Gibbs
  69  * Copyright (c) 2005, WHEEL Sp. z o.o.
  70  * All rights reserved.
  71  *
  72  * Redistribution and use in source and binary forms, with or without
  73  * modification, are permitted provided that the following conditions are
  74  * met:
  75  * 1. Redistributions of source code must retain the above copyright
  76  *    notice, this list of conditions and the following disclaimer.
  77  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  78  *    substantially similar to the "NO WARRANTY" disclaimer below
  79  *    ("Disclaimer") and any redistribution must be conditioned upon including
  80  *    a substantially similar Disclaimer requirement for further binary
  81  *    redistribution.
  82  * 3. Neither the names of the above listed copyright holders nor the names
  83  *    of any contributors may be used to endorse or promote products derived
  84  *    from this software without specific prior written permission.
  85  *
  86  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  87  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  89  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  90  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  91  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  92  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  93  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  94  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  95  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
  96  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  97  */
  98
  99 #ifndef _MPT_H_
 100 #define _MPT_H_
 101
 102 /********************************* OS Includes ********************************/
 103 #include <sys/types.h>
 104 #include <sys/param.h>
 105 #include <sys/systm.h>
 106 #include <sys/endian.h>
 107 #include <sys/eventhandler.h>
 108 #if __FreeBSD_version < 500000
 109 #include <sys/kernel.h>
 110 #include <sys/queue.h>
 111 #include <sys/malloc.h>
 112 #include <sys/devicestat.h>
 113 #else
 114 #include <sys/lock.h>
 115 #include <sys/kernel.h>
 116 #include <sys/queue.h>
 117 #include <sys/malloc.h>
 118 #include <sys/mutex.h>
 119 #include <sys/condvar.h>
 120 #endif
 121 #include <sys/proc.h>
 122 #include <sys/bus.h>
 123 #include <sys/module.h>
 124
 125 #include <machine/cpu.h>
 126 #include <machine/resource.h>
 127
 128 #if __FreeBSD_version < 500000
 129 #include <machine/bus.h>
 130 #include <machine/clock.h>
 131 #endif
 132
 133 #include <sys/rman.h>
 134
 135 #if __FreeBSD_version < 500000
 136 #include <pci/pcireg.h>
 137 #include <pci/pcivar.h>
 138 #else
 139 #include <dev/pci/pcireg.h>
 140 #include <dev/pci/pcivar.h>
 141 #endif
 142
 143 #include <machine/bus.h>
 144 #include "opt_ddb.h"
 145
 146 /**************************** Register Definitions ****************************/
 147 #include <dev/mpt/mpt_reg.h>
 148
 149 /******************************* MPI Definitions ******************************/
 150 #include <dev/mpt/mpilib/mpi_type.h>
 151 #include <dev/mpt/mpilib/mpi.h>
 152 #include <dev/mpt/mpilib/mpi_cnfg.h>
 153 #include <dev/mpt/mpilib/mpi_ioc.h>
 154 #include <dev/mpt/mpilib/mpi_raid.h>
 155
 156 /* XXX For mpt_debug.c */
 157 #include <dev/mpt/mpilib/mpi_init.h>
 158
 159 #define MPT_S64_2_SCALAR(y)     ((((int64_t)y.High) << 32) | (y.Low))
 160 #define MPT_U64_2_SCALAR(y)     ((((uint64_t)y.High) << 32) | (y.Low))
 161
 162 /****************************** Misc Definitions ******************************/
 163 /* #define MPT_TEST_MULTIPATH   1 */
 164 #define MPT_OK (0)
 165 #define MPT_FAIL (0x10000)
 166
 167 #define NUM_ELEMENTS(array) (sizeof(array) / sizeof(*array))
 168
 169 #define MPT_ROLE_NONE           0
 170 #define MPT_ROLE_INITIATOR      1
 171 #define MPT_ROLE_TARGET         2
 172 #define MPT_ROLE_BOTH           3
 173 #define MPT_ROLE_DEFAULT        MPT_ROLE_INITIATOR
 174
 175 /**************************** Forward Declarations ****************************/
 176 struct mpt_softc;
 177 struct mpt_personality;
 178 typedef struct req_entry request_t;
 179
 180 /************************* Personality Module Support *************************/
 181 typedef int mpt_load_handler_t(struct mpt_personality *);
 182 typedef int mpt_probe_handler_t(struct mpt_softc *);
 183 typedef int mpt_attach_handler_t(struct mpt_softc *);
 184 typedef int mpt_enable_handler_t(struct mpt_softc *);
 185 typedef void mpt_ready_handler_t(struct mpt_softc *);
 186 typedef int mpt_event_handler_t(struct mpt_softc *, request_t *,
 187                                 MSG_EVENT_NOTIFY_REPLY *);
 188 typedef void mpt_reset_handler_t(struct mpt_softc *, int /*type*/);
 189 /* XXX Add return value and use for veto? */
 190 typedef void mpt_shutdown_handler_t(struct mpt_softc *);
 191 typedef void mpt_detach_handler_t(struct mpt_softc *);
 192 typedef int mpt_unload_handler_t(struct mpt_personality *);
 193
 194 struct mpt_personality
 195 {
 196         const char              *name;
 197         uint32_t                 id;            /* Assigned identifier. */
 198         u_int                    use_count;     /* Instances using personality*/
 199         mpt_load_handler_t      *load;          /* configure personailty */
 200 #define MPT_PERS_FIRST_HANDLER(pers) (&(pers)->load)
 201         mpt_probe_handler_t     *probe;         /* configure personailty */
 202         mpt_attach_handler_t    *attach;        /* initialize device instance */
 203         mpt_enable_handler_t    *enable;        /* enable device */
 204         mpt_ready_handler_t     *ready;         /* final open for business */
 205         mpt_event_handler_t     *event;         /* Handle MPI event. */
 206         mpt_reset_handler_t     *reset;         /* Re-init after reset. */
 207         mpt_shutdown_handler_t  *shutdown;      /* Shutdown instance. */
 208         mpt_detach_handler_t    *detach;        /* release device instance */
 209         mpt_unload_handler_t    *unload;        /* Shutdown personality */
 210 #define MPT_PERS_LAST_HANDLER(pers) (&(pers)->unload)
 211 };
 212
 213 int mpt_modevent(module_t, int, void *);
 214
 215 /* Maximum supported number of personalities. */
 216 #define MPT_MAX_PERSONALITIES   (15)
 217
 218 #define MPT_PERSONALITY_DEPEND(name, dep, vmin, vpref, vmax) \
 219         MODULE_DEPEND(name, dep, vmin, vpref, vmax)
 220
 221 #define DECLARE_MPT_PERSONALITY(name, order)                              \
 222         static moduledata_t name##_mod = {                                \
 223                 #name, mpt_modevent, &name##_personality                  \
 224         };                                                                \
 225         DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, order);          \
 226         MODULE_VERSION(name, 1);                                          \
 227         MPT_PERSONALITY_DEPEND(name, mpt_core, 1, 1, 1)
 228
 229 /******************************* Bus DMA Support ******************************/
 230 /* XXX Need to update bus_dmamap_sync to take a range argument. */
 231 #define bus_dmamap_sync_range(dma_tag, dmamap, offset, len, op) \
 232         bus_dmamap_sync(dma_tag, dmamap, op)
 233
 234 #if __FreeBSD_version < 600000
 235 #define bus_get_dma_tag(x)      NULL
 236 #endif
 237 #if __FreeBSD_version >= 501102
 238 #define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,        \
 239                            lowaddr, highaddr, filter, filterarg,        \
 240                            maxsize, nsegments, maxsegsz, flags,         \
 241                            dma_tagp)                                    \
 242         bus_dma_tag_create(parent_tag, alignment, boundary,             \
 243                            lowaddr, highaddr, filter, filterarg,        \
 244                            maxsize, nsegments, maxsegsz, flags,         \
 245                            busdma_lock_mutex, &(mpt)->mpt_lock,         \
 246                            dma_tagp)
 247 #else
 248 #define mpt_dma_tag_create(mpt, parent_tag, alignment, boundary,        \
 249                            lowaddr, highaddr, filter, filterarg,        \
 250                            maxsize, nsegments, maxsegsz, flags,         \
 251                            dma_tagp)                                    \
 252         bus_dma_tag_create(parent_tag, alignment, boundary,             \
 253                            lowaddr, highaddr, filter, filterarg,        \
 254                            maxsize, nsegments, maxsegsz, flags,         \
 255                            dma_tagp)
 256 #endif
 257
 258 struct mpt_map_info {
 259         struct mpt_softc *mpt;
 260         int               error;
 261         uint32_t          phys;
 262 };
 263
 264 void mpt_map_rquest(void *, bus_dma_segment_t *, int, int);
 265 /* **************************** NewBUS interrupt Crock ************************/
 266 #if __FreeBSD_version < 700031
 267 #define mpt_setup_intr(d, i, f, U, if, ifa, hp) \
 268         bus_setup_intr(d, i, f, if, ifa, hp)
 269 #else
 270 #define mpt_setup_intr  bus_setup_intr
 271 #endif
 272
 273 /* **************************** NewBUS CAM Support ****************************/
 274 #if __FreeBSD_version < 700049
 275 #define mpt_xpt_bus_register(sim, parent, bus)  \
 276         xpt_bus_register(sim, bus)
 277 #else
 278 #define mpt_xpt_bus_register    xpt_bus_register
 279 #endif
 280
 281 /**************************** Kernel Thread Support ***************************/
 282 #if __FreeBSD_version > 800001
 283 #define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 284         kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 285 #define mpt_kthread_exit(status)        \
 286         kproc_exit(status)
 287 #elif __FreeBSD_version > 500005
 288 #define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 289         kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 290 #define mpt_kthread_exit(status)        \
 291         kthread_exit(status)
 292 #else
 293 #define mpt_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 294         kthread_create(func, farg, proc_ptr, fmtstr, arg)
 295 #define mpt_kthread_exit(status)        \
 296         kthread_exit(status)
 297 #endif
 298
 299 /****************************** Timer Facilities ******************************/
 300 #if __FreeBSD_version > 500000
 301 #define mpt_callout_init(c)     callout_init(c, /*mpsafe*/1);
 302 #else
 303 #define mpt_callout_init(c)     callout_init(c);
 304 #endif
 305
 306 /********************************** Endianess *********************************/
 307 #define MPT_2_HOST64(ptr, tag)  ptr->tag = le64toh(ptr->tag)
 308 #define MPT_2_HOST32(ptr, tag)  ptr->tag = le32toh(ptr->tag)
 309 #define MPT_2_HOST16(ptr, tag)  ptr->tag = le16toh(ptr->tag)
 310
 311 #define HOST_2_MPT64(ptr, tag)  ptr->tag = htole64(ptr->tag)
 312 #define HOST_2_MPT32(ptr, tag)  ptr->tag = htole32(ptr->tag)
 313 #define HOST_2_MPT16(ptr, tag)  ptr->tag = htole16(ptr->tag)
 314
 315 #if     _BYTE_ORDER == _BIG_ENDIAN
 316 void mpt2host_sge_simple_union(SGE_SIMPLE_UNION *);
 317 void mpt2host_iocfacts_reply(MSG_IOC_FACTS_REPLY *);
 318 void mpt2host_portfacts_reply(MSG_PORT_FACTS_REPLY *);
 319 void mpt2host_config_page_ioc2(CONFIG_PAGE_IOC_2 *);
 320 void mpt2host_config_page_ioc3(CONFIG_PAGE_IOC_3 *);
 321 void mpt2host_config_page_scsi_port_0(CONFIG_PAGE_SCSI_PORT_0 *);
 322 void mpt2host_config_page_scsi_port_1(CONFIG_PAGE_SCSI_PORT_1 *);
 323 void host2mpt_config_page_scsi_port_1(CONFIG_PAGE_SCSI_PORT_1 *);
 324 void mpt2host_config_page_scsi_port_2(CONFIG_PAGE_SCSI_PORT_2 *);
 325 void mpt2host_config_page_scsi_device_0(CONFIG_PAGE_SCSI_DEVICE_0 *);
 326 void mpt2host_config_page_scsi_device_1(CONFIG_PAGE_SCSI_DEVICE_1 *);
 327 void host2mpt_config_page_scsi_device_1(CONFIG_PAGE_SCSI_DEVICE_1 *);
 328 void mpt2host_config_page_fc_port_0(CONFIG_PAGE_FC_PORT_0 *);
 329 void mpt2host_config_page_fc_port_1(CONFIG_PAGE_FC_PORT_1 *);
 330 void host2mpt_config_page_fc_port_1(CONFIG_PAGE_FC_PORT_1 *);
 331 void mpt2host_config_page_raid_vol_0(CONFIG_PAGE_RAID_VOL_0 *);
 332 void mpt2host_config_page_raid_phys_disk_0(CONFIG_PAGE_RAID_PHYS_DISK_0 *);
 333 void mpt2host_mpi_raid_vol_indicator(MPI_RAID_VOL_INDICATOR *);
 334 #else
 335 #define mpt2host_sge_simple_union(x)            do { ; } while (0)
 336 #define mpt2host_iocfacts_reply(x)              do { ; } while (0)
 337 #define mpt2host_portfacts_reply(x)             do { ; } while (0)
 338 #define mpt2host_config_page_ioc2(x)            do { ; } while (0)
 339 #define mpt2host_config_page_ioc3(x)            do { ; } while (0)
 340 #define mpt2host_config_page_scsi_port_0(x)     do { ; } while (0)
 341 #define mpt2host_config_page_scsi_port_1(x)     do { ; } while (0)
 342 #define host2mpt_config_page_scsi_port_1(x)     do { ; } while (0)
 343 #define mpt2host_config_page_scsi_port_2(x)     do { ; } while (0)
 344 #define mpt2host_config_page_scsi_device_0(x)   do { ; } while (0)
 345 #define mpt2host_config_page_scsi_device_1(x)   do { ; } while (0)
 346 #define host2mpt_config_page_scsi_device_1(x)   do { ; } while (0)
 347 #define mpt2host_config_page_fc_port_0(x)       do { ; } while (0)
 348 #define mpt2host_config_page_fc_port_1(x)       do { ; } while (0)
 349 #define host2mpt_config_page_fc_port_1(x)       do { ; } while (0)
 350 #define mpt2host_config_page_raid_vol_0(x)      do { ; } while (0)
 351 #define mpt2host_config_page_raid_phys_disk_0(x)                        \
 352         do { ; } while (0)
 353 #define mpt2host_mpi_raid_vol_indicator(x)      do { ; } while (0)
 354 #endif
 355
 356 /**************************** MPI Transaction State ***************************/
 357 typedef enum {
 358         REQ_STATE_NIL           = 0x00,
 359         REQ_STATE_FREE          = 0x01,
 360         REQ_STATE_ALLOCATED     = 0x02,
 361         REQ_STATE_QUEUED        = 0x04,
 362         REQ_STATE_DONE          = 0x08,
 363         REQ_STATE_TIMEDOUT      = 0x10,
 364         REQ_STATE_NEED_WAKEUP   = 0x20,
 365         REQ_STATE_LOCKED        = 0x80, /* can't be freed */
 366         REQ_STATE_MASK          = 0xFF
 367 } mpt_req_state_t;
 368
 369 struct req_entry {
 370         TAILQ_ENTRY(req_entry) links;   /* Pointer to next in list */
 371         mpt_req_state_t state;          /* Request State Information */
 372         uint16_t        index;          /* Index of this entry */
 373         uint16_t        IOCStatus;      /* Completion status */
 374         uint16_t        ResponseCode;   /* TMF Reponse Code */
 375         uint16_t        serno;          /* serial number */
 376         union ccb      *ccb;            /* CAM request */
 377         void           *req_vbuf;       /* Virtual Address of Entry */
 378         void           *sense_vbuf;     /* Virtual Address of sense data */
 379         bus_addr_t      req_pbuf;       /* Physical Address of Entry */
 380         bus_addr_t      sense_pbuf;     /* Physical Address of sense data */
 381         bus_dmamap_t    dmap;           /* DMA map for data buffers */
 382         struct req_entry *chain;        /* for SGE overallocations */
 383         struct callout  callout;        /* Timeout for the request */
 384 };
 385
 386 typedef struct mpt_config_params {
 387         u_int           Action;
 388         u_int           PageVersion;
 389         u_int           PageLength;
 390         u_int           PageNumber;
 391         u_int           PageType;
 392         u_int           PageAddress;
 393         u_int           ExtPageLength;
 394         u_int           ExtPageType;
 395 } cfgparms_t;
 396
 397 /**************************** MPI Target State Info ***************************/
 398
 399 typedef struct {
 400         uint32_t reply_desc;    /* current reply descriptor */
 401         uint32_t resid;         /* current data residual */
 402         uint32_t bytes_xfered;  /* current relative offset */
 403         union ccb *ccb;         /* pointer to currently active ccb */
 404         request_t *req;         /* pointer to currently active assist request */
 405         uint32_t
 406                 is_local : 1,
 407                 nxfers   : 31;
 408         uint32_t tag_id;
 409         enum {
 410                 TGT_STATE_NIL,
 411                 TGT_STATE_LOADING,
 412                 TGT_STATE_LOADED,
 413                 TGT_STATE_IN_CAM,
 414                 TGT_STATE_SETTING_UP_FOR_DATA,
 415                 TGT_STATE_MOVING_DATA,
 416                 TGT_STATE_MOVING_DATA_AND_STATUS,
 417                 TGT_STATE_SENDING_STATUS
 418         } state;
 419 } mpt_tgt_state_t;
 420
 421 /*
 422  * When we get an incoming command it has its own tag which is called the
 423  * IoIndex. This is the value we gave that particular command buffer when
 424  * we originally assigned it. It's just a number, really. The FC card uses
 425  * it as an RX_ID. We can use it to index into mpt->tgt_cmd_ptrs, which
 426  * contains pointers the request_t structures related to that IoIndex.
 427  *
 428  * What *we* do is construct a tag out of the index for the target command
 429  * which owns the incoming ATIO plus a rolling sequence number.
 430  */
 431 #define MPT_MAKE_TAGID(mpt, req, ioindex)       \
 432  ((ioindex << 18) | (((mpt->sequence++) & 0x3f) << 12) | (req->index & 0xfff))
 433
 434 #ifdef  INVARIANTS
 435 #define MPT_TAG_2_REQ(a, b)             mpt_tag_2_req(a, (uint32_t) b)
 436 #else
 437 #define MPT_TAG_2_REQ(mpt, tag)         mpt->tgt_cmd_ptrs[tag >> 18]
 438 #endif
 439
 440 #define MPT_TGT_STATE(mpt, req) ((mpt_tgt_state_t *) \
 441     (&((uint8_t *)req->req_vbuf)[MPT_RQSL(mpt) - sizeof (mpt_tgt_state_t)]))
 442
 443 STAILQ_HEAD(mpt_hdr_stailq, ccb_hdr);
 444 #define MPT_MAX_LUNS    256
 445 typedef struct {
 446         struct mpt_hdr_stailq   atios;
 447         struct mpt_hdr_stailq   inots;
 448         int enabled;
 449 } tgt_resource_t;
 450 #define MPT_MAX_ELS     64
 451
 452 /**************************** Handler Registration ****************************/
 453 /*
 454  * Global table of registered reply handlers.  The
 455  * handler is indicated by byte 3 of the request
 456  * index submitted to the IOC.  This allows the
 457  * driver core to perform generic processing without
 458  * any knowledge of per-personality behavior.
 459  *
 460  * MPT_NUM_REPLY_HANDLERS must be a power of 2
 461  * to allow the easy generation of a mask.
 462  *
 463  * The handler offsets used by the core are hard coded
 464  * allowing faster code generation when assigning a handler
 465  * to a request.  All "personalities" must use the
 466  * the handler registration mechanism.
 467  *
 468  * The IOC handlers that are rarely executed are placed
 469  * at the tail of the table to make it more likely that
 470  * all commonly executed handlers fit in a single cache
 471  * line.
 472  */
 473 #define MPT_NUM_REPLY_HANDLERS          (32)
 474 #define MPT_REPLY_HANDLER_EVENTS        MPT_CBI_TO_HID(0)
 475 #define MPT_REPLY_HANDLER_CONFIG        MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-1)
 476 #define MPT_REPLY_HANDLER_HANDSHAKE     MPT_CBI_TO_HID(MPT_NUM_REPLY_HANDLERS-2)
 477 typedef int mpt_reply_handler_t(struct mpt_softc *mpt, request_t *request,
 478     uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame);
 479 typedef union {
 480         mpt_reply_handler_t     *reply_handler;
 481 } mpt_handler_t;
 482
 483 typedef enum {
 484         MPT_HANDLER_REPLY,
 485         MPT_HANDLER_EVENT,
 486         MPT_HANDLER_RESET,
 487         MPT_HANDLER_SHUTDOWN
 488 } mpt_handler_type;
 489
 490 struct mpt_handler_record
 491 {
 492         LIST_ENTRY(mpt_handler_record)  links;
 493         mpt_handler_t                   handler;
 494 };
 495
 496 LIST_HEAD(mpt_handler_list, mpt_handler_record);
 497
 498 /*
 499  * The handler_id is currently unused but would contain the
 500  * handler ID used in the MsgContext field to allow direction
 501  * of replies to the handler.  Registrations that don't require
 502  * a handler id can pass in NULL for the handler_id.
 503  *
 504  * Deregistrations for handlers without a handler id should
 505  * pass in MPT_HANDLER_ID_NONE.
 506  */
 507 #define MPT_HANDLER_ID_NONE             (0xFFFFFFFF)
 508 int mpt_register_handler(struct mpt_softc *, mpt_handler_type,
 509                          mpt_handler_t, uint32_t *);
 510 int mpt_deregister_handler(struct mpt_softc *, mpt_handler_type,
 511                            mpt_handler_t, uint32_t);
 512
 513 /******************* Per-Controller Instance Data Structures ******************/
 514 TAILQ_HEAD(req_queue, req_entry);
 515
 516 /* Structure for saving proper values for modifyable PCI config registers */
 517 struct mpt_pci_cfg {
 518         uint16_t Command;
 519         uint16_t LatencyTimer_LineSize;
 520         uint32_t IO_BAR;
 521         uint32_t Mem0_BAR[2];
 522         uint32_t Mem1_BAR[2];
 523         uint32_t ROM_BAR;
 524         uint8_t  IntLine;
 525         uint32_t PMCSR;
 526 };
 527
 528 typedef enum {
 529         MPT_RVF_NONE            = 0x0,
 530         MPT_RVF_ACTIVE          = 0x1,
 531         MPT_RVF_ANNOUNCED       = 0x2,
 532         MPT_RVF_UP2DATE         = 0x4,
 533         MPT_RVF_REFERENCED      = 0x8,
 534         MPT_RVF_WCE_CHANGED     = 0x10
 535 } mpt_raid_volume_flags;
 536
 537 struct mpt_raid_volume {
 538         CONFIG_PAGE_RAID_VOL_0         *config_page;
 539         MPI_RAID_VOL_INDICATOR          sync_progress;
 540         mpt_raid_volume_flags           flags;
 541         u_int                           quiesced_disks;
 542 };
 543
 544 typedef enum {
 545         MPT_RDF_NONE            = 0x00,
 546         MPT_RDF_ACTIVE          = 0x01,
 547         MPT_RDF_ANNOUNCED       = 0x02,
 548         MPT_RDF_UP2DATE         = 0x04,
 549         MPT_RDF_REFERENCED      = 0x08,
 550         MPT_RDF_QUIESCING       = 0x10,
 551         MPT_RDF_QUIESCED        = 0x20
 552 } mpt_raid_disk_flags;
 553
 554 struct mpt_raid_disk {
 555         CONFIG_PAGE_RAID_PHYS_DISK_0    config_page;
 556         struct mpt_raid_volume         *volume;
 557         u_int                           member_number;
 558         u_int                           pass_thru_active;
 559         mpt_raid_disk_flags             flags;
 560 };
 561
 562 struct mpt_evtf_record {
 563         MSG_EVENT_NOTIFY_REPLY          reply;
 564         uint32_t                        context;
 565         LIST_ENTRY(mpt_evtf_record)     links;
 566 };
 567
 568 LIST_HEAD(mpt_evtf_list, mpt_evtf_record);
 569
 570 struct mptsas_devinfo {
 571         uint16_t        dev_handle;
 572         uint16_t        parent_dev_handle;
 573         uint16_t        enclosure_handle;
 574         uint16_t        slot;
 575         uint8_t         phy_num;
 576         uint8_t         physical_port;
 577         uint8_t         target_id;
 578         uint8_t         bus;
 579         uint64_t        sas_address;
 580         uint32_t        device_info;
 581 };
 582
 583 struct mptsas_phyinfo {
 584         uint16_t        handle;
 585         uint8_t         phy_num;
 586         uint8_t         port_id;
 587         uint8_t         negotiated_link_rate;
 588         uint8_t         hw_link_rate;
 589         uint8_t         programmed_link_rate;
 590         uint8_t         sas_port_add_phy;
 591         struct mptsas_devinfo identify;
 592         struct mptsas_devinfo attached;
 593 };
 594
 595 struct mptsas_portinfo {
 596         uint16_t                        num_phys;
 597         struct mptsas_phyinfo           *phy_info;
 598 };
 599
 600 struct mpt_softc {
 601         device_t                dev;
 602 #if __FreeBSD_version < 500000
 603         uint32_t                mpt_islocked;
 604         int                     mpt_splsaved;
 605 #else
 606         struct mtx              mpt_lock;
 607         int                     mpt_locksetup;
 608 #endif
 609         uint32_t                mpt_pers_mask;
 610         uint32_t
 611                                 : 8,
 612                 unit            : 8,
 613                 ready           : 1,
 614                 fw_uploaded     : 1,
 615                 msi_enable      : 1,
 616                 twildcard       : 1,
 617                 tenabled        : 1,
 618                 do_cfg_role     : 1,
 619                 raid_enabled    : 1,
 620                 raid_mwce_set   : 1,
 621                 getreqwaiter    : 1,
 622                 shutdwn_raid    : 1,
 623                 shutdwn_recovery: 1,
 624                 outofbeer       : 1,
 625                 disabled        : 1,
 626                 is_spi          : 1,
 627                 is_sas          : 1,
 628                 is_fc           : 1;
 629
 630         u_int                   cfg_role;
 631         u_int                   role;   /* role: none, ini, target, both */
 632
 633         u_int                   verbose;
 634 #ifdef  MPT_TEST_MULTIPATH
 635         int                     failure_id;
 636 #endif
 637
 638         /*
 639          * IOC Facts
 640          */
 641         MSG_IOC_FACTS_REPLY     ioc_facts;
 642
 643         /*
 644          * Port Facts
 645          */
 646         MSG_PORT_FACTS_REPLY *  port_facts;
 647 #define mpt_ini_id      port_facts[0].PortSCSIID
 648 #define mpt_max_tgtcmds port_facts[0].MaxPostedCmdBuffers
 649
 650         /*
 651          * Device Configuration Information
 652          */
 653         union {
 654                 struct mpt_spi_cfg {
 655                         CONFIG_PAGE_SCSI_PORT_0         _port_page0;
 656                         CONFIG_PAGE_SCSI_PORT_1         _port_page1;
 657                         CONFIG_PAGE_SCSI_PORT_2         _port_page2;
 658                         CONFIG_PAGE_SCSI_DEVICE_0       _dev_page0[16];
 659                         CONFIG_PAGE_SCSI_DEVICE_1       _dev_page1[16];
 660                         uint16_t                        _tag_enable;
 661                         uint16_t                        _disc_enable;
 662                 } spi;
 663 #define mpt_port_page0          cfg.spi._port_page0
 664 #define mpt_port_page1          cfg.spi._port_page1
 665 #define mpt_port_page2          cfg.spi._port_page2
 666 #define mpt_dev_page0           cfg.spi._dev_page0
 667 #define mpt_dev_page1           cfg.spi._dev_page1
 668 #define mpt_tag_enable          cfg.spi._tag_enable
 669 #define mpt_disc_enable         cfg.spi._disc_enable
 670                 struct mpi_fc_cfg {
 671                         CONFIG_PAGE_FC_PORT_0 _port_page0;
 672                         uint32_t _port_speed;
 673 #define mpt_fcport_page0        cfg.fc._port_page0
 674 #define mpt_fcport_speed        cfg.fc._port_speed
 675                 } fc;
 676         } cfg;
 677 #if __FreeBSD_version >= 500000
 678         /*
 679          * Device config information stored up for sysctl to access
 680          */
 681         union {
 682                 struct {
 683                         unsigned int initiator_id;
 684                 } spi;
 685                 struct {
 686                         char wwnn[19];
 687                         char wwpn[19];
 688                 } fc;
 689         } scinfo;
 690 #endif
 691
 692         /* Controller Info for RAID information */
 693         CONFIG_PAGE_IOC_2 *     ioc_page2;
 694         CONFIG_PAGE_IOC_3 *     ioc_page3;
 695
 696         /* Raid Data */
 697         struct mpt_raid_volume* raid_volumes;
 698         struct mpt_raid_disk*   raid_disks;
 699         u_int                   raid_max_volumes;
 700         u_int                   raid_max_disks;
 701         u_int                   raid_page0_len;
 702         u_int                   raid_wakeup;
 703         u_int                   raid_rescan;
 704         u_int                   raid_resync_rate;
 705         u_int                   raid_mwce_setting;
 706         u_int                   raid_queue_depth;
 707         u_int                   raid_nonopt_volumes;
 708         struct proc            *raid_thread;
 709         struct callout          raid_timer;
 710
 711         /*
 712          * PCI Hardware info
 713          */
 714         int                     pci_msi_count;
 715         struct resource *       pci_irq;        /* Interrupt map for chip */
 716         void *                  ih;             /* Interupt handle */
 717         struct mpt_pci_cfg      pci_cfg;        /* saved PCI conf registers */
 718
 719         /*
 720          * DMA Mapping Stuff
 721          */
 722         struct resource *       pci_reg;        /* Register map for chip */
 723         int                     pci_mem_rid;    /* Resource ID */
 724         bus_space_tag_t         pci_st;         /* Bus tag for registers */
 725         bus_space_handle_t      pci_sh;         /* Bus handle for registers */
 726         /* PIO versions of above. */
 727         int                     pci_pio_rid;
 728         struct resource *       pci_pio_reg;
 729         bus_space_tag_t         pci_pio_st;
 730         bus_space_handle_t      pci_pio_sh;
 731
 732         bus_dma_tag_t           parent_dmat;    /* DMA tag for parent PCI bus */
 733         bus_dma_tag_t           reply_dmat;     /* DMA tag for reply memory */
 734         bus_dmamap_t            reply_dmap;     /* DMA map for reply memory */
 735         uint8_t                *reply;          /* KVA of reply memory */
 736         bus_addr_t              reply_phys;     /* BusAddr of reply memory */
 737
 738         bus_dma_tag_t           buffer_dmat;    /* DMA tag for buffers */
 739         bus_dma_tag_t           request_dmat;   /* DMA tag for request memroy */
 740         bus_dmamap_t            request_dmap;   /* DMA map for request memroy */
 741         uint8_t                *request;        /* KVA of Request memory */
 742         bus_addr_t              request_phys;   /* BusAddr of request memory */
 743
 744         uint32_t                max_seg_cnt;    /* calculated after IOC facts */
 745
 746         /*
 747          * Hardware management
 748          */
 749         u_int                   reset_cnt;
 750
 751         /*
 752          * CAM && Software Management
 753          */
 754         request_t              *request_pool;
 755         struct req_queue        request_free_list;
 756         struct req_queue        request_pending_list;
 757         struct req_queue        request_timeout_list;
 758
 759
 760         struct cam_sim         *sim;
 761         struct cam_path        *path;
 762
 763         struct cam_sim         *phydisk_sim;
 764         struct cam_path        *phydisk_path;
 765
 766         struct proc            *recovery_thread;
 767         request_t              *tmf_req;
 768
 769         /*
 770          * Deferred frame acks due to resource shortage.
 771          */
 772         struct mpt_evtf_list    ack_frames;
 773
 774         /*
 775          * Target Mode Support
 776          */
 777         uint32_t                scsi_tgt_handler_id;
 778         request_t **            tgt_cmd_ptrs;
 779         request_t **            els_cmd_ptrs;   /* FC only */
 780
 781         /*
 782          * *snork*- this is chosen to be here *just in case* somebody
 783          * forgets to point to it exactly and we index off of trt with
 784          * CAM_LUN_WILDCARD.
 785          */
 786         tgt_resource_t          trt_wildcard;           /* wildcard luns */
 787         tgt_resource_t          trt[MPT_MAX_LUNS];
 788         uint16_t                tgt_cmds_allocated;
 789         uint16_t                els_cmds_allocated;     /* FC only */
 790
 791         uint16_t                timeouts;       /* timeout count */
 792         uint16_t                success;        /* successes afer timeout */
 793         uint16_t                sequence;       /* Sequence Number */
 794         uint16_t                pad3;
 795
 796
 797         /* Paired port in some dual adapters configurations */
 798         struct mpt_softc *      mpt2;
 799
 800         /* FW Image management */
 801         uint32_t                fw_image_size;
 802         uint8_t                *fw_image;
 803         bus_dma_tag_t           fw_dmat;        /* DMA tag for firmware image */
 804         bus_dmamap_t            fw_dmap;        /* DMA map for firmware image */
 805         bus_addr_t              fw_phys;        /* BusAddr of firmware image */
 806
 807         /* SAS Topology */
 808         struct mptsas_portinfo  *sas_portinfo;
 809
 810         /* Shutdown Event Handler. */
 811         eventhandler_tag         eh;
 812
 813         /* Userland management interface. */
 814         struct cdev             *cdev;
 815
 816         TAILQ_ENTRY(mpt_softc)  links;
 817 };
 818
 819 static __inline void mpt_assign_serno(struct mpt_softc *, request_t *);
 820
 821 static __inline void
 822 mpt_assign_serno(struct mpt_softc *mpt, request_t *req)
 823 {
 824         if ((req->serno = mpt->sequence++) == 0) {
 825                 req->serno = mpt->sequence++;
 826         }
 827 }
 828
 829 /***************************** Locking Primitives *****************************/
 830 #if __FreeBSD_version < 500000
 831 #define MPT_IFLAGS              INTR_TYPE_CAM
 832 #define MPT_LOCK(mpt)           mpt_lockspl(mpt)
 833 #define MPT_UNLOCK(mpt)         mpt_unlockspl(mpt)
 834 #define MPT_OWNED(mpt)          mpt->mpt_islocked
 835 #define MPT_LOCK_ASSERT(mpt)
 836 #define MPTLOCK_2_CAMLOCK       MPT_UNLOCK
 837 #define CAMLOCK_2_MPTLOCK       MPT_LOCK
 838 #define MPT_LOCK_SETUP(mpt)
 839 #define MPT_LOCK_DESTROY(mpt)
 840
 841 static __inline void mpt_lockspl(struct mpt_softc *mpt);
 842 static __inline void mpt_unlockspl(struct mpt_softc *mpt);
 843
 844 static __inline void
 845 mpt_lockspl(struct mpt_softc *mpt)
 846 {
 847        int s;
 848
 849        s = splcam();
 850        if (mpt->mpt_islocked++ == 0) {
 851                mpt->mpt_splsaved = s;
 852        } else {
 853                splx(s);
 854                panic("Recursed lock with mask: 0x%x\n", s);
 855        }
 856 }
 857
 858 static __inline void
 859 mpt_unlockspl(struct mpt_softc *mpt)
 860 {
 861        if (mpt->mpt_islocked) {
 862                if (--mpt->mpt_islocked == 0) {
 863                        splx(mpt->mpt_splsaved);
 864                }
 865        } else
 866                panic("Negative lock count\n");
 867 }
 868
 869 static __inline int
 870 mpt_sleep(struct mpt_softc *mpt, void *ident, int priority,
 871            const char *wmesg, int timo)
 872 {
 873         int saved_cnt;
 874         int saved_spl;
 875         int error;
 876
 877         KASSERT(mpt->mpt_islocked <= 1, ("Invalid lock count on tsleep"));
 878         saved_cnt = mpt->mpt_islocked;
 879         saved_spl = mpt->mpt_splsaved;
 880         mpt->mpt_islocked = 0;
 881         error = tsleep(ident, priority, wmesg, timo);
 882         KASSERT(mpt->mpt_islocked == 0, ("Invalid lock count on wakeup"));
 883         mpt->mpt_islocked = saved_cnt;
 884         mpt->mpt_splsaved = saved_spl;
 885         return (error);
 886 }
 887
 888 #define mpt_req_timeout(req, ticks, func, arg) \
 889         callout_reset(&(req)->callout, (ticks), (func), (arg));
 890 #define mpt_req_untimeout(req, func, arg) \
 891         callout_stop(&(req)->callout)
 892
 893 #else
 894 #if 1
 895 #define MPT_IFLAGS              INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
 896 #define MPT_LOCK_SETUP(mpt)                                             \
 897                 mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF);         \
 898                 mpt->mpt_locksetup = 1
 899 #define MPT_LOCK_DESTROY(mpt)                                           \
 900         if (mpt->mpt_locksetup) {                                       \
 901                 mtx_destroy(&mpt->mpt_lock);                            \
 902                 mpt->mpt_locksetup = 0;                                 \
 903         }
 904
 905 #define MPT_LOCK(mpt)           mtx_lock(&(mpt)->mpt_lock)
 906 #define MPT_UNLOCK(mpt)         mtx_unlock(&(mpt)->mpt_lock)
 907 #define MPT_OWNED(mpt)          mtx_owned(&(mpt)->mpt_lock)
 908 #define MPT_LOCK_ASSERT(mpt)    mtx_assert(&(mpt)->mpt_lock, MA_OWNED)
 909 #define MPTLOCK_2_CAMLOCK(mpt)
 910 #define CAMLOCK_2_MPTLOCK(mpt)
 911 #define mpt_sleep(mpt, ident, priority, wmesg, timo) \
 912         msleep(ident, &(mpt)->mpt_lock, priority, wmesg, timo)
 913 #define mpt_req_timeout(req, ticks, func, arg) \
 914         callout_reset(&(req)->callout, (ticks), (func), (arg));
 915 #define mpt_req_untimeout(req, func, arg) \
 916         callout_stop(&(req)->callout)
 917
 918 #else
 919
 920 #define MPT_IFLAGS              INTR_TYPE_CAM | INTR_ENTROPY
 921 #define MPT_LOCK_SETUP(mpt)     do { } while (0)
 922 #define MPT_LOCK_DESTROY(mpt)   do { } while (0)
 923 #define MPT_LOCK_ASSERT(mpt)    mtx_assert(&Giant, MA_OWNED)
 924 #define MPT_LOCK(mpt)           mtx_lock(&Giant)
 925 #define MPT_UNLOCK(mpt)         mtx_unlock(&Giant)
 926 #define MPTLOCK_2_CAMLOCK(mpt)
 927 #define CAMLOCK_2_MPTLOCK(mpt)
 928
 929 static __inline int
 930 mpt_sleep(struct mpt_softc *, void *, int, const char *, int);
 931
 932 #define mpt_ccb_timeout(ccb, ticks, func, arg) \
 933         do {    \
 934                 (ccb)->ccb_h.timeout_ch = timeout((func), (arg), (ticks)); \
 935         } while (0)
 936 #define mpt_ccb_untimeout(ccb, func, arg) \
 937         untimeout((func), (arg), (ccb)->ccb_h.timeout_ch)
 938 #define mpt_ccb_timeout_init(ccb) \
 939         callout_handle_init(&(ccb)->ccb_h.timeout_ch)
 940
 941 static __inline int
 942 mpt_sleep(struct mpt_softc *mpt, void *i, int p, const char *w, int t)
 943 {
 944         int r;
 945         r = tsleep(i, p, w, t);
 946         return (r);
 947 }
 948 #endif
 949 #endif
 950
 951 /******************************* Register Access ******************************/
 952 static __inline void mpt_write(struct mpt_softc *, size_t, uint32_t);
 953 static __inline uint32_t mpt_read(struct mpt_softc *, int);
 954 static __inline void mpt_pio_write(struct mpt_softc *, size_t, uint32_t);
 955 static __inline uint32_t mpt_pio_read(struct mpt_softc *, int);
 956
 957 static __inline void
 958 mpt_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
 959 {
 960         bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
 961 }
 962
 963 static __inline uint32_t
 964 mpt_read(struct mpt_softc *mpt, int offset)
 965 {
 966         return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
 967 }
 968
 969 /*
 970  * Some operations (e.g. diagnostic register writes while the ARM proccessor
 971  * is disabled), must be performed using "PCI pio" operations.  On non-PCI
 972  * busses, these operations likely map to normal register accesses.
 973  */
 974 static __inline void
 975 mpt_pio_write(struct mpt_softc *mpt, size_t offset, uint32_t val)
 976 {
 977         bus_space_write_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset, val);
 978 }
 979
 980 static __inline uint32_t
 981 mpt_pio_read(struct mpt_softc *mpt, int offset)
 982 {
 983         return (bus_space_read_4(mpt->pci_pio_st, mpt->pci_pio_sh, offset));
 984 }
 985 /*********************** Reply Frame/Request Management ***********************/
 986 /* Max MPT Reply we are willing to accept (must be power of 2) */
 987 #define MPT_REPLY_SIZE          256
 988
 989 /*
 990  * Must be less than 16384 in order for target mode to work
 991  */
 992 #define MPT_MAX_REQUESTS(mpt)   512
 993 #define MPT_REQUEST_AREA        512
 994 #define MPT_SENSE_SIZE          32      /* included in MPT_REQUEST_AREA */
 995 #define MPT_REQ_MEM_SIZE(mpt)   (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
 996
 997 #define MPT_CONTEXT_CB_SHIFT    (16)
 998 #define MPT_CBI(handle)         (handle >> MPT_CONTEXT_CB_SHIFT)
 999 #define MPT_CBI_TO_HID(cbi)     ((cbi) << MPT_CONTEXT_CB_SHIFT)
1000 #define MPT_CONTEXT_TO_CBI(x)   \
1001     (((x) >> MPT_CONTEXT_CB_SHIFT) & (MPT_NUM_REPLY_HANDLERS - 1))
1002 #define MPT_CONTEXT_REQI_MASK   0xFFFF
1003 #define MPT_CONTEXT_TO_REQI(x)  ((x) & MPT_CONTEXT_REQI_MASK)
1004
1005 /*
1006  * Convert a 32bit physical address returned from IOC to an
1007  * offset into our reply frame memory or the kvm address needed
1008  * to access the data.  The returned address is only the low
1009  * 32 bits, so mask our base physical address accordingly.
1010  */
1011 #define MPT_REPLY_BADDR(x)              \
1012         (x << 1)
1013 #define MPT_REPLY_OTOV(m, i)            \
1014         ((void *)(&m->reply[i]))
1015
1016 #define MPT_DUMP_REPLY_FRAME(mpt, reply_frame)          \
1017 do {                                                    \
1018         if (mpt->verbose > MPT_PRT_DEBUG)               \
1019                 mpt_dump_reply_frame(mpt, reply_frame); \
1020 } while(0)
1021
1022 static __inline uint32_t mpt_pop_reply_queue(struct mpt_softc *mpt);
1023 static __inline void mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr);
1024
1025 /*
1026  * Give the reply buffer back to the IOC after we have
1027  * finished processing it.
1028  */
1029 static __inline void
1030 mpt_free_reply(struct mpt_softc *mpt, uint32_t ptr)
1031 {
1032      mpt_write(mpt, MPT_OFFSET_REPLY_Q, ptr);
1033 }
1034
1035 /* Get a reply from the IOC */
1036 static __inline uint32_t
1037 mpt_pop_reply_queue(struct mpt_softc *mpt)
1038 {
1039      return mpt_read(mpt, MPT_OFFSET_REPLY_Q);
1040 }
1041
1042 void
1043 mpt_complete_request_chain(struct mpt_softc *, struct req_queue *, u_int);
1044
1045 /************************** Scatter Gather Managment **************************/
1046 /* MPT_RQSL- size of request frame, in bytes */
1047 #define MPT_RQSL(mpt)           (mpt->ioc_facts.RequestFrameSize << 2)
1048
1049 /* MPT_NSGL- how many SG entries can fit in a request frame size */
1050 #define MPT_NSGL(mpt)           (MPT_RQSL(mpt) / sizeof (SGE_IO_UNION))
1051
1052 /* MPT_NRFM- how many request frames can fit in each request alloc we make */
1053 #define MPT_NRFM(mpt)           (MPT_REQUEST_AREA / MPT_RQSL(mpt))
1054
1055 /*
1056  * MPT_NSGL_FIRST- # of SG elements that can fit after
1057  * an I/O request but still within the request frame.
1058  * Do this safely based upon SGE_IO_UNION.
1059  *
1060  * Note that the first element is *within* the SCSI request.
1061  */
1062 #define MPT_NSGL_FIRST(mpt)     \
1063     ((MPT_RQSL(mpt) - sizeof (MSG_SCSI_IO_REQUEST) + sizeof (SGE_IO_UNION)) / \
1064     sizeof (SGE_IO_UNION))
1065
1066 /***************************** IOC Initialization *****************************/
1067 int mpt_reset(struct mpt_softc *, int /*reinit*/);
1068
1069 /****************************** Debugging ************************************/
1070 typedef struct mpt_decode_entry {
1071         char    *name;
1072         u_int    value;
1073         u_int    mask;
1074 } mpt_decode_entry_t;
1075
1076 int mpt_decode_value(mpt_decode_entry_t *table, u_int num_entries,
1077                      const char *name, u_int value, u_int *cur_column,
1078                      u_int wrap_point);
1079
1080 void mpt_dump_data(struct mpt_softc *, const char *, void *, int);
1081 void mpt_dump_request(struct mpt_softc *, request_t *);
1082
1083 enum {
1084         MPT_PRT_ALWAYS,
1085         MPT_PRT_FATAL,
1086         MPT_PRT_ERROR,
1087         MPT_PRT_WARN,
1088         MPT_PRT_INFO,
1089         MPT_PRT_NEGOTIATION,
1090         MPT_PRT_DEBUG,
1091         MPT_PRT_DEBUG1,
1092         MPT_PRT_DEBUG2,
1093         MPT_PRT_DEBUG3,
1094         MPT_PRT_TRACE,
1095         MPT_PRT_NONE=100
1096 };
1097
1098 #if __FreeBSD_version > 500000
1099 #define mpt_lprt(mpt, level, ...)               \
1100 do {                                            \
1101         if (level <= (mpt)->verbose)            \
1102                 mpt_prt(mpt, __VA_ARGS__);      \
1103 } while (0)
1104
1105 #define mpt_lprtc(mpt, level, ...)               \
1106 do {                                             \
1107         if (level <= (mpt)->debug_level)         \
1108                 mpt_prtc(mpt, __VA_ARGS__);      \
1109 } while (0)
1110 #else
1111 void mpt_lprt(struct mpt_softc *, int, const char *, ...)
1112         __printflike(3, 4);
1113 void mpt_lprtc(struct mpt_softc *, int, const char *, ...)
1114         __printflike(3, 4);
1115 #endif
1116 void mpt_prt(struct mpt_softc *, const char *, ...)
1117         __printflike(2, 3);
1118 void mpt_prtc(struct mpt_softc *, const char *, ...)
1119         __printflike(2, 3);
1120
1121 /**************************** Target Mode Related ***************************/
1122 static __inline int mpt_cdblen(uint8_t, int);
1123 static __inline int
1124 mpt_cdblen(uint8_t cdb0, int maxlen)
1125 {
1126         int group = cdb0 >> 5;
1127         switch (group) {
1128         case 0:
1129                 return (6);
1130         case 1:
1131                 return (10);
1132         case 4:
1133         case 5:
1134                 return (12);
1135         default:
1136                 return (16);
1137         }
1138 }
1139 #ifdef  INVARIANTS
1140 static __inline request_t * mpt_tag_2_req(struct mpt_softc *, uint32_t);
1141 static __inline request_t *
1142 mpt_tag_2_req(struct mpt_softc *mpt, uint32_t tag)
1143 {
1144         uint16_t rtg = (tag >> 18);
1145         KASSERT(rtg < mpt->tgt_cmds_allocated, ("bad tag %d\n", tag));
1146         KASSERT(mpt->tgt_cmd_ptrs, ("no cmd backpointer array"));
1147         KASSERT(mpt->tgt_cmd_ptrs[rtg], ("no cmd backpointer"));
1148         return (mpt->tgt_cmd_ptrs[rtg]);
1149 }
1150
1151
1152 static __inline int
1153 mpt_req_on_free_list(struct mpt_softc *, request_t *);
1154 static __inline int
1155 mpt_req_on_pending_list(struct mpt_softc *, request_t *);
1156
1157 static __inline void
1158 mpt_req_spcl(struct mpt_softc *, request_t *, const char *, int);
1159 static __inline void
1160 mpt_req_not_spcl(struct mpt_softc *, request_t *, const char *, int);
1161
1162
1163 /*
1164  * Is request on freelist?
1165  */
1166 static __inline int
1167 mpt_req_on_free_list(struct mpt_softc *mpt, request_t *req)
1168 {
1169         request_t *lrq;
1170
1171         TAILQ_FOREACH(lrq, &mpt->request_free_list, links) {
1172                 if (lrq == req) {
1173                         return (1);
1174                 }
1175         }
1176         return (0);
1177 }
1178
1179 /*
1180  * Is request on pending list?
1181  */
1182 static __inline int
1183 mpt_req_on_pending_list(struct mpt_softc *mpt, request_t *req)
1184 {
1185         request_t *lrq;
1186
1187         TAILQ_FOREACH(lrq, &mpt->request_pending_list, links) {
1188                 if (lrq == req) {
1189                         return (1);
1190                 }
1191         }
1192         return (0);
1193 }
1194
1195 /*
1196  * Make sure that req *is* part of one of the special lists
1197  */
1198 static __inline void
1199 mpt_req_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1200 {
1201         int i;
1202         for (i = 0; i < mpt->els_cmds_allocated; i++) {
1203                 if (req == mpt->els_cmd_ptrs[i]) {
1204                         return;
1205                 }
1206         }
1207         for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1208                 if (req == mpt->tgt_cmd_ptrs[i]) {
1209                         return;
1210                 }
1211         }
1212         panic("%s(%d): req %p:%u function %x not in els or tgt ptrs\n",
1213             s, line, req, req->serno,
1214             ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function);
1215 }
1216
1217 /*
1218  * Make sure that req is *not* part of one of the special lists.
1219  */
1220 static __inline void
1221 mpt_req_not_spcl(struct mpt_softc *mpt, request_t *req, const char *s, int line)
1222 {
1223         int i;
1224         for (i = 0; i < mpt->els_cmds_allocated; i++) {
1225                 KASSERT(req != mpt->els_cmd_ptrs[i],
1226                     ("%s(%d): req %p:%u func %x in els ptrs at ioindex %d\n",
1227                     s, line, req, req->serno,
1228                     ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1229         }
1230         for (i = 0; i < mpt->tgt_cmds_allocated; i++) {
1231                 KASSERT(req != mpt->tgt_cmd_ptrs[i],
1232                     ("%s(%d): req %p:%u func %x in tgt ptrs at ioindex %d\n",
1233                     s, line, req, req->serno,
1234                     ((PTR_MSG_REQUEST_HEADER)req->req_vbuf)->Function, i));
1235         }
1236 }
1237 #endif
1238
1239 /*
1240  * Task Management Types, purely for internal consumption
1241  */
1242 typedef enum {
1243         MPT_ABORT_TASK_SET=1234,
1244         MPT_CLEAR_TASK_SET,
1245         MPT_TARGET_RESET,
1246         MPT_CLEAR_ACA,
1247         MPT_TERMINATE_TASK,
1248         MPT_NIL_TMT_VALUE=5678
1249 } mpt_task_mgmt_t;
1250
1251 /**************************** Unclassified Routines ***************************/
1252 void            mpt_send_cmd(struct mpt_softc *mpt, request_t *req);
1253 int             mpt_recv_handshake_reply(struct mpt_softc *mpt,
1254                                          size_t reply_len, void *reply);
1255 int             mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1256                              mpt_req_state_t state, mpt_req_state_t mask,
1257                              int sleep_ok, int time_ms);
1258 void            mpt_enable_ints(struct mpt_softc *mpt);
1259 void            mpt_disable_ints(struct mpt_softc *mpt);
1260 int             mpt_attach(struct mpt_softc *mpt);
1261 int             mpt_shutdown(struct mpt_softc *mpt);
1262 int             mpt_detach(struct mpt_softc *mpt);
1263 int             mpt_send_handshake_cmd(struct mpt_softc *mpt,
1264                                        size_t len, void *cmd);
1265 request_t *     mpt_get_request(struct mpt_softc *mpt, int sleep_ok);
1266 void            mpt_free_request(struct mpt_softc *mpt, request_t *req);
1267 void            mpt_intr(void *arg);
1268 void            mpt_check_doorbell(struct mpt_softc *mpt);
1269 void            mpt_dump_reply_frame(struct mpt_softc *mpt,
1270                                      MSG_DEFAULT_REPLY *reply_frame);
1271
1272 void            mpt_set_config_regs(struct mpt_softc *);
1273 int             mpt_issue_cfg_req(struct mpt_softc */*mpt*/, request_t */*req*/,
1274                                   cfgparms_t *params,
1275                                   bus_addr_t /*addr*/, bus_size_t/*len*/,
1276                                   int /*sleep_ok*/, int /*timeout_ms*/);
1277 int             mpt_read_extcfg_header(struct mpt_softc *mpt, int PageVersion,
1278                                        int PageNumber, uint32_t PageAddress,
1279                                        int ExtPageType,
1280                                        CONFIG_EXTENDED_PAGE_HEADER *rslt,
1281                                        int sleep_ok, int timeout_ms);
1282 int             mpt_read_extcfg_page(struct mpt_softc *mpt, int Action,
1283                                      uint32_t PageAddress,
1284                                      CONFIG_EXTENDED_PAGE_HEADER *hdr,
1285                                      void *buf, size_t len, int sleep_ok,
1286                                      int timeout_ms);
1287 int             mpt_read_cfg_header(struct mpt_softc *, int /*PageType*/,
1288                                     int /*PageNumber*/,
1289                                     uint32_t /*PageAddress*/,
1290                                     CONFIG_PAGE_HEADER *,
1291                                     int /*sleep_ok*/, int /*timeout_ms*/);
1292 int             mpt_read_cfg_page(struct mpt_softc *t, int /*Action*/,
1293                                   uint32_t /*PageAddress*/,
1294                                   CONFIG_PAGE_HEADER *, size_t /*len*/,
1295                                   int /*sleep_ok*/, int /*timeout_ms*/);
1296 int             mpt_write_cfg_page(struct mpt_softc *, int /*Action*/,
1297                                    uint32_t /*PageAddress*/,
1298                                    CONFIG_PAGE_HEADER *, size_t /*len*/,
1299                                    int /*sleep_ok*/, int /*timeout_ms*/);
1300 static __inline int
1301 mpt_read_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1302                       CONFIG_PAGE_HEADER *hdr, size_t len,
1303                       int sleep_ok, int timeout_ms)
1304 {
1305         return (mpt_read_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_READ_CURRENT,
1306                                   PageAddress, hdr, len, sleep_ok, timeout_ms));
1307 }
1308
1309 static __inline int
1310 mpt_write_cur_cfg_page(struct mpt_softc *mpt, uint32_t PageAddress,
1311                        CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1312                        int timeout_ms)
1313 {
1314         return (mpt_write_cfg_page(mpt, MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT,
1315                                    PageAddress, hdr, len, sleep_ok,
1316                                    timeout_ms));
1317 }
1318 /* mpt_debug.c functions */
1319 void mpt_print_reply(void *vmsg);
1320 void mpt_print_db(uint32_t mb);
1321 void mpt_print_config_reply(void *vmsg);
1322 char *mpt_ioc_diag(uint32_t diag);
1323 void mpt_req_state(mpt_req_state_t state);
1324 void mpt_print_config_request(void *vmsg);
1325 void mpt_print_request(void *vmsg);
1326 void mpt_print_scsi_io_request(MSG_SCSI_IO_REQUEST *msg);
1327 void mpt_dump_sgl(SGE_IO_UNION *se, int offset);
1328 #endif /* _MPT_H_ */