sys/dev/mps/mpsvar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2009 Yahoo! Inc.
   5  * Copyright (c) 2011-2015 LSI Corp.
   6  * Copyright (c) 2013-2015 Avago Technologies
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _MPSVAR_H
  36 #define _MPSVAR_H
  37
  38 #define MPS_DRIVER_VERSION      "21.02.00.00-fbsd"
  39
  40 #define MPS_DB_MAX_WAIT         2500
  41
  42 #define MPS_REQ_FRAMES          2048
  43 #define MPS_PRI_REQ_FRAMES      128
  44 #define MPS_EVT_REPLY_FRAMES    32
  45 #define MPS_REPLY_FRAMES        MPS_REQ_FRAMES
  46 #define MPS_CHAIN_FRAMES        2048
  47 #define MPS_MAXIO_PAGES         (-1)
  48 #define MPS_SENSE_LEN           SSD_FULL_SIZE
  49 #define MPS_MSI_MAX             1
  50 #define MPS_MSIX_MAX            16
  51 #define MPS_SGE64_SIZE          12
  52 #define MPS_SGE32_SIZE          8
  53 #define MPS_SGC_SIZE            8
  54
  55 #define  CAN_SLEEP                      1
  56 #define  NO_SLEEP                       0
  57
  58 #define MPS_PERIODIC_DELAY      1       /* 1 second heartbeat/watchdog check */
  59 #define MPS_ATA_ID_TIMEOUT      5       /* 5 second timeout for SATA ID cmd */
  60 #define MPS_MISSING_CHECK_DELAY 10      /* 10 seconds between missing check */
  61
  62 #define MPS_SCSI_RI_INVALID_FRAME       (0x00000002)
  63
  64 #define DEFAULT_SPINUP_WAIT     3       /* seconds to wait for spinup */
  65
  66 #include <sys/endian.h>
  67
  68 /*
  69  * host mapping related macro definitions
  70  */
  71 #define MPS_MAPTABLE_BAD_IDX    0xFFFFFFFF
  72 #define MPS_DPM_BAD_IDX         0xFFFF
  73 #define MPS_ENCTABLE_BAD_IDX    0xFF
  74 #define MPS_MAX_MISSING_COUNT   0x0F
  75 #define MPS_DEV_RESERVED        0x20000000
  76 #define MPS_MAP_IN_USE          0x10000000
  77 #define MPS_MAP_BAD_ID          0xFFFFFFFF
  78
  79 /*
  80  * WarpDrive controller
  81  */
  82 #define MPS_CHIP_WD_DEVICE_ID   0x007E
  83 #define MPS_WD_LSI_OEM          0x80
  84 #define MPS_WD_HIDE_EXPOSE_MASK 0x03
  85 #define MPS_WD_HIDE_ALWAYS      0x00
  86 #define MPS_WD_EXPOSE_ALWAYS    0x01
  87 #define MPS_WD_HIDE_IF_VOLUME   0x02
  88 #define MPS_WD_RETRY            0x01
  89 #define MPS_MAN_PAGE10_SIZE     0x5C    /* Hardcode for now */
  90 #define MPS_MAX_DISKS_IN_VOL    10
  91
  92 /*
  93  * WarpDrive Event Logging
  94  */
  95 #define MPI2_WD_LOG_ENTRY       0x8002
  96 #define MPI2_WD_SSD_THROTTLING  0x0041
  97 #define MPI2_WD_DRIVE_LIFE_WARN 0x0043
  98 #define MPI2_WD_DRIVE_LIFE_DEAD 0x0044
  99 #define MPI2_WD_RAIL_MON_FAIL   0x004D
 100
 101 typedef uint8_t u8;
 102 typedef uint16_t u16;
 103 typedef uint32_t u32;
 104 typedef uint64_t u64;
 105
 106 /**
 107  * struct dev_mapping_table - device mapping information
 108  * @physical_id: SAS address for drives or WWID for RAID volumes
 109  * @device_info: bitfield provides detailed info about the device
 110  * @phy_bits: bitfields indicating controller phys
 111  * @dpm_entry_num: index of this device in device persistent map table
 112  * @dev_handle: device handle for the device pointed by this entry
 113  * @id: target id
 114  * @missing_count: number of times the device not detected by driver
 115  * @hide_flag: Hide this physical disk/not (foreign configuration)
 116  * @init_complete: Whether the start of the day checks completed or not
 117  */
 118 struct dev_mapping_table {
 119         u64     physical_id;
 120         u32     device_info;
 121         u32     phy_bits;
 122         u16     dpm_entry_num;
 123         u16     dev_handle;
 124         u16     reserved1;
 125         u16     id;
 126         u8      missing_count;
 127         u8      init_complete;
 128         u8      TLR_bits;
 129         u8      reserved2;
 130 };
 131
 132 /**
 133  * struct enc_mapping_table -  mapping information about an enclosure
 134  * @enclosure_id: Logical ID of this enclosure
 135  * @start_index: index to the entry in dev_mapping_table
 136  * @phy_bits: bitfields indicating controller phys
 137  * @dpm_entry_num: index of this enclosure in device persistent map table
 138  * @enc_handle: device handle for the enclosure pointed by this entry
 139  * @num_slots: number of slots in the enclosure
 140  * @start_slot: Starting slot id
 141  * @missing_count: number of times the device not detected by driver
 142  * @removal_flag: used to mark the device for removal
 143  * @skip_search: used as a flag to include/exclude enclosure for search
 144  * @init_complete: Whether the start of the day checks completed or not
 145  */
 146 struct enc_mapping_table {
 147         u64     enclosure_id;
 148         u32     start_index;
 149         u32     phy_bits;
 150         u16     dpm_entry_num;
 151         u16     enc_handle;
 152         u16     num_slots;
 153         u16     start_slot;
 154         u8      missing_count;
 155         u8      removal_flag;
 156         u8      skip_search;
 157         u8      init_complete;
 158 };
 159
 160 /**
 161  * struct map_removal_table - entries to be removed from mapping table
 162  * @dpm_entry_num: index of this device in device persistent map table
 163  * @dev_handle: device handle for the device pointed by this entry
 164  */
 165 struct map_removal_table{
 166         u16     dpm_entry_num;
 167         u16     dev_handle;
 168 };
 169
 170 typedef struct mps_fw_diagnostic_buffer {
 171         size_t          size;
 172         uint8_t         extended_type;
 173         uint8_t         buffer_type;
 174         uint8_t         force_release;
 175         uint32_t        product_specific[23];
 176         uint8_t         immediate;
 177         uint8_t         enabled;
 178         uint8_t         valid_data;
 179         uint8_t         owned_by_firmware;
 180         uint32_t        unique_id;
 181 } mps_fw_diagnostic_buffer_t;
 182
 183 struct mps_softc;
 184 struct mps_command;
 185 struct mpssas_softc;
 186 union ccb;
 187 struct mpssas_target;
 188 struct mps_column_map;
 189
 190 MALLOC_DECLARE(M_MPT2);
 191
 192 typedef void mps_evt_callback_t(struct mps_softc *, uintptr_t,
 193     MPI2_EVENT_NOTIFICATION_REPLY *reply);
 194 typedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm);
 195
 196 struct mps_chain {
 197         TAILQ_ENTRY(mps_chain)          chain_link;
 198         MPI2_SGE_IO_UNION               *chain;
 199         uint32_t                        chain_busaddr;
 200 };
 201
 202 /*
 203  * This needs to be at least 2 to support SMP passthrough.
 204  */
 205 #define       MPS_IOVEC_COUNT 2
 206
 207 struct mps_command {
 208         TAILQ_ENTRY(mps_command)        cm_link;
 209         TAILQ_ENTRY(mps_command)        cm_recovery;
 210         struct mps_softc                *cm_sc;
 211         union ccb                       *cm_ccb;
 212         void                            *cm_data;
 213         u_int                           cm_length;
 214         u_int                           cm_out_len;
 215         struct uio                      cm_uio;
 216         struct iovec                    cm_iovec[MPS_IOVEC_COUNT];
 217         u_int                           cm_max_segs;
 218         u_int                           cm_sglsize;
 219         MPI2_SGE_IO_UNION               *cm_sge;
 220         uint8_t                         *cm_req;
 221         uint8_t                         *cm_reply;
 222         uint32_t                        cm_reply_data;
 223         mps_command_callback_t          *cm_complete;
 224         void                            *cm_complete_data;
 225         struct mpssas_target            *cm_targ;
 226         MPI2_REQUEST_DESCRIPTOR_UNION   cm_desc;
 227         u_int                           cm_lun;
 228         u_int                           cm_flags;
 229 #define MPS_CM_FLAGS_POLLED             (1 << 0)
 230 #define MPS_CM_FLAGS_COMPLETE           (1 << 1)
 231 #define MPS_CM_FLAGS_SGE_SIMPLE         (1 << 2)
 232 #define MPS_CM_FLAGS_DATAOUT            (1 << 3)
 233 #define MPS_CM_FLAGS_DATAIN             (1 << 4)
 234 #define MPS_CM_FLAGS_WAKEUP             (1 << 5)
 235 #define MPS_CM_FLAGS_DD_IO              (1 << 6)
 236 #define MPS_CM_FLAGS_USE_UIO            (1 << 7)
 237 #define MPS_CM_FLAGS_SMP_PASS           (1 << 8)
 238 #define MPS_CM_FLAGS_CHAIN_FAILED       (1 << 9)
 239 #define MPS_CM_FLAGS_ERROR_MASK         MPS_CM_FLAGS_CHAIN_FAILED
 240 #define MPS_CM_FLAGS_USE_CCB            (1 << 10)
 241 #define MPS_CM_FLAGS_SATA_ID_TIMEOUT    (1 << 11)
 242         u_int                           cm_state;
 243 #define MPS_CM_STATE_FREE               0
 244 #define MPS_CM_STATE_BUSY               1
 245 #define MPS_CM_STATE_TIMEDOUT           2
 246         bus_dmamap_t                    cm_dmamap;
 247         struct scsi_sense_data          *cm_sense;
 248         TAILQ_HEAD(, mps_chain)         cm_chain_list;
 249         uint32_t                        cm_req_busaddr;
 250         uint32_t                        cm_sense_busaddr;
 251         struct callout                  cm_callout;
 252 };
 253
 254 struct mps_column_map {
 255         uint16_t                        dev_handle;
 256         uint8_t                         phys_disk_num;
 257 };
 258
 259 struct mps_event_handle {
 260         TAILQ_ENTRY(mps_event_handle)   eh_list;
 261         mps_evt_callback_t              *callback;
 262         void                            *data;
 263         u32                             mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 264 };
 265
 266 struct mps_busdma_context {
 267         int                             completed;
 268         int                             abandoned;
 269         int                             error;
 270         bus_addr_t                      *addr;
 271         struct mps_softc                *softc;
 272         bus_dmamap_t                    buffer_dmamap;
 273         bus_dma_tag_t                   buffer_dmat;
 274 };
 275
 276 struct mps_queue {
 277         struct mps_softc                *sc;
 278         int                             qnum;
 279         MPI2_REPLY_DESCRIPTORS_UNION    *post_queue;
 280         int                             replypostindex;
 281 #ifdef notyet
 282         ck_ring_buffer_t                *ringmem;
 283         ck_ring_buffer_t                *chainmem;
 284         ck_ring_t                       req_ring;
 285         ck_ring_t                       chain_ring;
 286 #endif
 287         bus_dma_tag_t                   buffer_dmat;
 288         int                             io_cmds_highwater;
 289         int                             chain_free_lowwater;
 290         int                             chain_alloc_fail;
 291         struct resource                 *irq;
 292         void                            *intrhand;
 293         int                             irq_rid;
 294 };
 295
 296 struct mps_softc {
 297         device_t                        mps_dev;
 298         struct cdev                     *mps_cdev;
 299         u_int                           mps_flags;
 300 #define MPS_FLAGS_INTX          (1 << 0)
 301 #define MPS_FLAGS_MSI           (1 << 1)
 302 #define MPS_FLAGS_BUSY          (1 << 2)
 303 #define MPS_FLAGS_SHUTDOWN      (1 << 3)
 304 #define MPS_FLAGS_DIAGRESET     (1 << 4)
 305 #define MPS_FLAGS_ATTACH_DONE   (1 << 5)
 306 #define MPS_FLAGS_WD_AVAILABLE  (1 << 6)
 307 #define MPS_FLAGS_REALLOCATED   (1 << 7)
 308         u_int                           mps_debug;
 309         u_int                           msi_msgs;
 310         u_int                           reqframesz;
 311         u_int                           replyframesz;
 312         int                             tm_cmds_active;
 313         int                             io_cmds_active;
 314         int                             io_cmds_highwater;
 315         int                             chain_free;
 316         int                             max_chains;
 317         int                             max_io_pages;
 318         int                             chain_free_lowwater;
 319         u_int                           enable_ssu;
 320         int                             spinup_wait_time;
 321         int                             use_phynum;
 322         uint64_t                        chain_alloc_fail;
 323         struct sysctl_ctx_list          sysctl_ctx;
 324         struct sysctl_oid               *sysctl_tree;
 325         char                            fw_version[16];
 326         struct mps_command              *commands;
 327         struct mps_chain                *chains;
 328         struct callout                  periodic;
 329         struct callout                  device_check_callout;
 330         struct mps_queue                *queues;
 331
 332         struct mpssas_softc             *sassc;
 333         TAILQ_HEAD(, mps_command)       req_list;
 334         TAILQ_HEAD(, mps_command)       high_priority_req_list;
 335         TAILQ_HEAD(, mps_chain)         chain_list;
 336         TAILQ_HEAD(, mps_command)       tm_list;
 337         int                             replypostindex;
 338         int                             replyfreeindex;
 339
 340         struct resource                 *mps_regs_resource;
 341         bus_space_handle_t              mps_bhandle;
 342         bus_space_tag_t                 mps_btag;
 343         int                             mps_regs_rid;
 344
 345         bus_dma_tag_t                   mps_parent_dmat;
 346         bus_dma_tag_t                   buffer_dmat;
 347
 348         MPI2_IOC_FACTS_REPLY            *facts;
 349         int                             num_reqs;
 350         int                             num_prireqs;
 351         int                             num_replies;
 352         int                             fqdepth;        /* Free queue */
 353         int                             pqdepth;        /* Post queue */
 354
 355         u32             event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 356         TAILQ_HEAD(, mps_event_handle)  event_list;
 357         struct mps_event_handle         *mps_log_eh;
 358
 359         struct mtx                      mps_mtx;
 360         struct intr_config_hook         mps_ich;
 361
 362         uint8_t                         *req_frames;
 363         bus_addr_t                      req_busaddr;
 364         bus_dma_tag_t                   req_dmat;
 365         bus_dmamap_t                    req_map;
 366
 367         uint8_t                         *reply_frames;
 368         bus_addr_t                      reply_busaddr;
 369         bus_dma_tag_t                   reply_dmat;
 370         bus_dmamap_t                    reply_map;
 371
 372         struct scsi_sense_data          *sense_frames;
 373         bus_addr_t                      sense_busaddr;
 374         bus_dma_tag_t                   sense_dmat;
 375         bus_dmamap_t                    sense_map;
 376
 377         uint8_t                         *chain_frames;
 378         bus_addr_t                      chain_busaddr;
 379         bus_dma_tag_t                   chain_dmat;
 380         bus_dmamap_t                    chain_map;
 381
 382         MPI2_REPLY_DESCRIPTORS_UNION    *post_queue;
 383         bus_addr_t                      post_busaddr;
 384         uint32_t                        *free_queue;
 385         bus_addr_t                      free_busaddr;
 386         bus_dma_tag_t                   queues_dmat;
 387         bus_dmamap_t                    queues_map;
 388
 389         uint8_t                         *fw_diag_buffer;
 390         bus_addr_t                      fw_diag_busaddr;
 391         bus_dma_tag_t                   fw_diag_dmat;
 392         bus_dmamap_t                    fw_diag_map;
 393
 394         uint8_t                         ir_firmware;
 395
 396         /* static config pages */
 397         Mpi2IOCPage8_t                  ioc_pg8;
 398
 399         /* host mapping support */
 400         struct dev_mapping_table        *mapping_table;
 401         struct enc_mapping_table        *enclosure_table;
 402         struct map_removal_table        *removal_table;
 403         uint8_t                         *dpm_entry_used;
 404         uint8_t                         *dpm_flush_entry;
 405         Mpi2DriverMappingPage0_t        *dpm_pg0;
 406         uint16_t                        max_devices;
 407         uint16_t                        max_enclosures;
 408         uint16_t                        max_expanders;
 409         uint8_t                         max_volumes;
 410         uint8_t                         num_enc_table_entries;
 411         uint8_t                         num_rsvd_entries;
 412         uint16_t                        max_dpm_entries;
 413         uint8_t                         is_dpm_enable;
 414         uint8_t                         track_mapping_events;
 415         uint32_t                        pending_map_events;
 416
 417         /* FW diag Buffer List */
 418         mps_fw_diagnostic_buffer_t
 419                                 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT];
 420
 421         /* Event Recording IOCTL support */
 422         uint32_t                        events_to_record[4];
 423         mps_event_entry_t               recorded_events[MPS_EVENT_QUEUE_SIZE];
 424         uint8_t                         event_index;
 425         uint32_t                        event_number;
 426
 427         /* EEDP and TLR support */
 428         uint8_t                         eedp_enabled;
 429         uint8_t                         control_TLR;
 430
 431         /* Shutdown Event Handler */
 432         eventhandler_tag                shutdown_eh;
 433
 434         /* To track topo events during reset */
 435 #define MPS_DIAG_RESET_TIMEOUT  300000
 436         uint8_t                         wait_for_port_enable;
 437         uint8_t                         port_enable_complete;
 438         uint8_t                         msleep_fake_chan;
 439
 440         /* WD controller */
 441         uint8_t             WD_available;
 442         uint8_t                         WD_valid_config;
 443         uint8_t                         WD_hide_expose;
 444
 445         /* Direct Drive for WarpDrive */
 446         uint8_t                         DD_num_phys_disks;
 447         uint16_t                        DD_dev_handle;
 448         uint32_t                        DD_stripe_size;
 449         uint32_t                        DD_stripe_exponent;
 450         uint32_t                        DD_block_size;
 451         uint16_t                        DD_block_exponent;
 452         uint64_t                        DD_max_lba;
 453         struct mps_column_map           DD_column_map[MPS_MAX_DISKS_IN_VOL];
 454
 455         /* StartStopUnit command handling at shutdown */
 456         uint32_t                        SSU_refcount;
 457         uint8_t                         SSU_started;
 458
 459         /* Configuration tunables */
 460         u_int                           disable_msix;
 461         u_int                           disable_msi;
 462         u_int                           max_msix;
 463         u_int                           max_reqframes;
 464         u_int                           max_prireqframes;
 465         u_int                           max_replyframes;
 466         u_int                           max_evtframes;
 467         char                            exclude_ids[80];
 468
 469         struct timeval                  lastfail;
 470 };
 471
 472 struct mps_config_params {
 473         MPI2_CONFIG_EXT_PAGE_HEADER_UNION       hdr;
 474         u_int           action;
 475         u_int           page_address;   /* Attributes, not a phys address */
 476         u_int           status;
 477         void            *buffer;
 478         u_int           length;
 479         int             timeout;
 480         void            (*callback)(struct mps_softc *, struct mps_config_params *);
 481         void            *cbdata;
 482 };
 483
 484 struct scsi_read_capacity_eedp
 485 {
 486         uint8_t addr[8];
 487         uint8_t length[4];
 488         uint8_t protect;
 489 };
 490
 491 static __inline uint32_t
 492 mps_regread(struct mps_softc *sc, uint32_t offset)
 493 {
 494         return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset));
 495 }
 496
 497 static __inline void
 498 mps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val)
 499 {
 500         bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val);
 501 }
 502
 503 /* free_queue must have Little Endian address
 504  * TODO- cm_reply_data is unwanted. We can remove it.
 505  * */
 506 static __inline void
 507 mps_free_reply(struct mps_softc *sc, uint32_t busaddr)
 508 {
 509         if (++sc->replyfreeindex >= sc->fqdepth)
 510                 sc->replyfreeindex = 0;
 511         sc->free_queue[sc->replyfreeindex] = htole32(busaddr);
 512         mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
 513 }
 514
 515 static __inline struct mps_chain *
 516 mps_alloc_chain(struct mps_softc *sc)
 517 {
 518         struct mps_chain *chain;
 519
 520         if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) {
 521                 TAILQ_REMOVE(&sc->chain_list, chain, chain_link);
 522                 sc->chain_free--;
 523                 if (sc->chain_free < sc->chain_free_lowwater)
 524                         sc->chain_free_lowwater = sc->chain_free;
 525         } else
 526                 sc->chain_alloc_fail++;
 527         return (chain);
 528 }
 529
 530 static __inline void
 531 mps_free_chain(struct mps_softc *sc, struct mps_chain *chain)
 532 {
 533         sc->chain_free++;
 534         TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link);
 535 }
 536
 537 static __inline void
 538 mps_free_command(struct mps_softc *sc, struct mps_command *cm)
 539 {
 540         struct mps_chain *chain, *chain_temp;
 541
 542         if (cm->cm_reply != NULL)
 543                 mps_free_reply(sc, cm->cm_reply_data);
 544         cm->cm_reply = NULL;
 545         cm->cm_flags = 0;
 546         cm->cm_complete = NULL;
 547         cm->cm_complete_data = NULL;
 548         cm->cm_ccb = NULL;
 549         cm->cm_targ = NULL;
 550         cm->cm_max_segs = 0;
 551         cm->cm_lun = 0;
 552         cm->cm_state = MPS_CM_STATE_FREE;
 553         cm->cm_data = NULL;
 554         cm->cm_length = 0;
 555         cm->cm_out_len = 0;
 556         cm->cm_sglsize = 0;
 557         cm->cm_sge = NULL;
 558
 559         TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
 560                 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
 561                 mps_free_chain(sc, chain);
 562         }
 563         TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link);
 564 }
 565
 566 static __inline struct mps_command *
 567 mps_alloc_command(struct mps_softc *sc)
 568 {
 569         struct mps_command *cm;
 570
 571         cm = TAILQ_FIRST(&sc->req_list);
 572         if (cm == NULL)
 573                 return (NULL);
 574
 575         TAILQ_REMOVE(&sc->req_list, cm, cm_link);
 576         KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n"));
 577         cm->cm_state = MPS_CM_STATE_BUSY;
 578         return (cm);
 579 }
 580
 581 static __inline void
 582 mps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm)
 583 {
 584         struct mps_chain *chain, *chain_temp;
 585
 586         if (cm->cm_reply != NULL)
 587                 mps_free_reply(sc, cm->cm_reply_data);
 588         cm->cm_reply = NULL;
 589         cm->cm_flags = 0;
 590         cm->cm_complete = NULL;
 591         cm->cm_complete_data = NULL;
 592         cm->cm_ccb = NULL;
 593         cm->cm_targ = NULL;
 594         cm->cm_lun = 0;
 595         cm->cm_state = MPS_CM_STATE_FREE;
 596         TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
 597                 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
 598                 mps_free_chain(sc, chain);
 599         }
 600         TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link);
 601 }
 602
 603 static __inline struct mps_command *
 604 mps_alloc_high_priority_command(struct mps_softc *sc)
 605 {
 606         struct mps_command *cm;
 607
 608         cm = TAILQ_FIRST(&sc->high_priority_req_list);
 609         if (cm == NULL)
 610                 return (NULL);
 611
 612         TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link);
 613         KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n"));
 614         cm->cm_state = MPS_CM_STATE_BUSY;
 615         return (cm);
 616 }
 617
 618 static __inline void
 619 mps_lock(struct mps_softc *sc)
 620 {
 621         mtx_lock(&sc->mps_mtx);
 622 }
 623
 624 static __inline void
 625 mps_unlock(struct mps_softc *sc)
 626 {
 627         mtx_unlock(&sc->mps_mtx);
 628 }
 629
 630 #define MPS_INFO        (1 << 0)        /* Basic info */
 631 #define MPS_FAULT       (1 << 1)        /* Hardware faults */
 632 #define MPS_EVENT       (1 << 2)        /* Event data from the controller */
 633 #define MPS_LOG         (1 << 3)        /* Log data from the controller */
 634 #define MPS_RECOVERY    (1 << 4)        /* Command error recovery tracing */
 635 #define MPS_ERROR       (1 << 5)        /* Parameter errors, programming bugs */
 636 #define MPS_INIT        (1 << 6)        /* Things related to system init */
 637 #define MPS_XINFO       (1 << 7)        /* More detailed/noisy info */
 638 #define MPS_USER        (1 << 8)        /* Trace user-generated commands */
 639 #define MPS_MAPPING     (1 << 9)        /* Trace device mappings */
 640 #define MPS_TRACE       (1 << 10)       /* Function-by-function trace */
 641
 642 #define MPS_SSU_DISABLE_SSD_DISABLE_HDD 0
 643 #define MPS_SSU_ENABLE_SSD_DISABLE_HDD  1
 644 #define MPS_SSU_DISABLE_SSD_ENABLE_HDD  2
 645 #define MPS_SSU_ENABLE_SSD_ENABLE_HDD   3
 646
 647 #define mps_printf(sc, args...)                         \
 648         device_printf((sc)->mps_dev, ##args)
 649
 650 #define mps_print_field(sc, msg, args...)               \
 651         printf("\t" msg, ##args)
 652
 653 #define mps_vprintf(sc, args...)                        \
 654 do {                                                    \
 655         if (bootverbose)                                \
 656                 mps_printf(sc, ##args);                 \
 657 } while (0)
 658
 659 #define mps_dprint(sc, level, msg, args...)             \
 660 do {                                                    \
 661         if ((sc)->mps_debug & (level))                  \
 662                 device_printf((sc)->mps_dev, msg, ##args);      \
 663 } while (0)
 664
 665 #define MPS_PRINTFIELD_START(sc, tag...)        \
 666         mps_printf((sc), ##tag);                        \
 667         mps_print_field((sc), ":\n")
 668 #define MPS_PRINTFIELD_END(sc, tag)             \
 669         mps_printf((sc), tag "\n")
 670 #define MPS_PRINTFIELD(sc, facts, attr, fmt)    \
 671         mps_print_field((sc), #attr ": " #fmt "\n", (facts)->attr)
 672
 673 #define MPS_FUNCTRACE(sc)                       \
 674         mps_dprint((sc), MPS_TRACE, "%s\n", __func__)
 675
 676 #define  CAN_SLEEP                      1
 677 #define  NO_SLEEP                       0
 678
 679 static __inline void
 680 mps_from_u64(uint64_t data, U64 *mps)
 681 {
 682         (mps)->High = htole32((uint32_t)((data) >> 32));
 683         (mps)->Low = htole32((uint32_t)((data) & 0xffffffff));
 684 }
 685
 686 static __inline uint64_t
 687 mps_to_u64(U64 *data)
 688 {
 689
 690         return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low));
 691 }
 692
 693 static __inline void
 694 mps_mask_intr(struct mps_softc *sc)
 695 {
 696         uint32_t mask;
 697
 698         mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
 699         mask |= MPI2_HIM_REPLY_INT_MASK;
 700         mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
 701 }
 702
 703 static __inline void
 704 mps_unmask_intr(struct mps_softc *sc)
 705 {
 706         uint32_t mask;
 707
 708         mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
 709         mask &= ~MPI2_HIM_REPLY_INT_MASK;
 710         mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
 711 }
 712
 713 int mps_pci_setup_interrupts(struct mps_softc *sc);
 714 void mps_pci_free_interrupts(struct mps_softc *sc);
 715 int mps_pci_restore(struct mps_softc *sc);
 716
 717 void mps_get_tunables(struct mps_softc *sc);
 718 int mps_attach(struct mps_softc *sc);
 719 int mps_free(struct mps_softc *sc);
 720 void mps_intr(void *);
 721 void mps_intr_msi(void *);
 722 void mps_intr_locked(void *);
 723 int mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *,
 724     void *, struct mps_event_handle **);
 725 int mps_restart(struct mps_softc *);
 726 int mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *);
 727 void mps_deregister_events(struct mps_softc *, struct mps_event_handle *);
 728 int mps_push_sge(struct mps_command *, void *, size_t, int);
 729 int mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int);
 730 int mps_attach_sas(struct mps_softc *sc);
 731 int mps_detach_sas(struct mps_softc *sc);
 732 int mps_read_config_page(struct mps_softc *, struct mps_config_params *);
 733 int mps_write_config_page(struct mps_softc *, struct mps_config_params *);
 734 void mps_memaddr_cb(void *, bus_dma_segment_t *, int , int );
 735 void mps_memaddr_wait_cb(void *, bus_dma_segment_t *, int , int );
 736 void mpi_init_sge(struct mps_command *cm, void *req, void *sge);
 737 int mps_attach_user(struct mps_softc *);
 738 void mps_detach_user(struct mps_softc *);
 739 void mpssas_record_event(struct mps_softc *sc,
 740     MPI2_EVENT_NOTIFICATION_REPLY *event_reply);
 741
 742 int mps_map_command(struct mps_softc *sc, struct mps_command *cm);
 743 int mps_wait_command(struct mps_softc *sc, struct mps_command **cm, int timeout,
 744     int sleep_flag);
 745
 746 int mps_config_get_bios_pg3(struct mps_softc *sc, Mpi2ConfigReply_t
 747     *mpi_reply, Mpi2BiosPage3_t *config_page);
 748 int mps_config_get_raid_volume_pg0(struct mps_softc *sc, Mpi2ConfigReply_t
 749     *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address);
 750 int mps_config_get_ioc_pg8(struct mps_softc *sc, Mpi2ConfigReply_t *,
 751     Mpi2IOCPage8_t *);
 752 int mps_config_get_man_pg10(struct mps_softc *sc, Mpi2ConfigReply_t *mpi_reply);
 753 int mps_config_get_sas_device_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
 754     Mpi2SasDevicePage0_t *, u32 , u16 );
 755 int mps_config_get_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
 756     Mpi2DriverMappingPage0_t *, u16 );
 757 int mps_config_get_raid_volume_pg1(struct mps_softc *sc,
 758     Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
 759     u16 handle);
 760 int mps_config_get_volume_wwid(struct mps_softc *sc, u16 volume_handle,
 761     u64 *wwid);
 762 int mps_config_get_raid_pd_pg0(struct mps_softc *sc,
 763     Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
 764     u32 page_address);
 765 void mpssas_ir_shutdown(struct mps_softc *sc);
 766
 767 int mps_reinit(struct mps_softc *sc);
 768 void mpssas_handle_reinit(struct mps_softc *sc);
 769
 770 void mps_base_static_config_pages(struct mps_softc *sc);
 771 void mps_wd_config_pages(struct mps_softc *sc);
 772
 773 int mps_mapping_initialize(struct mps_softc *);
 774 void mps_mapping_topology_change_event(struct mps_softc *,
 775     Mpi2EventDataSasTopologyChangeList_t *);
 776 void mps_mapping_free_memory(struct mps_softc *sc);
 777 int mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *,
 778     Mpi2DriverMappingPage0_t *, u16 );
 779 void mps_mapping_exit(struct mps_softc *);
 780 void mps_mapping_check_devices(void *);
 781 int mps_mapping_allocate_memory(struct mps_softc *sc);
 782 unsigned int mps_mapping_get_tid(struct mps_softc *, uint64_t , u16);
 783 unsigned int mps_mapping_get_tid_from_handle(struct mps_softc *sc,
 784     u16 handle);
 785 unsigned int mps_mapping_get_raid_tid(struct mps_softc *sc, u64 wwid,
 786      u16 volHandle);
 787 unsigned int mps_mapping_get_raid_tid_from_handle(struct mps_softc *sc,
 788     u16 volHandle);
 789 void mps_mapping_enclosure_dev_status_change_event(struct mps_softc *,
 790     Mpi2EventDataSasEnclDevStatusChange_t *event_data);
 791 void mps_mapping_ir_config_change_event(struct mps_softc *sc,
 792     Mpi2EventDataIrConfigChangeList_t *event_data);
 793 int mps_mapping_dump(SYSCTL_HANDLER_ARGS);
 794 int mps_mapping_encl_dump(SYSCTL_HANDLER_ARGS);
 795
 796 void mpssas_evt_handler(struct mps_softc *sc, uintptr_t data,
 797     MPI2_EVENT_NOTIFICATION_REPLY *event);
 798 void mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle);
 799 void mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle);
 800 int mpssas_startup(struct mps_softc *sc);
 801 struct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t);
 802 void mpssas_realloc_targets(struct mps_softc *sc, int maxtargets);
 803 struct mps_command * mpssas_alloc_tm(struct mps_softc *sc);
 804 void mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm);
 805 void mpssas_release_simq_reinit(struct mpssas_softc *sassc);
 806 int mpssas_send_reset(struct mps_softc *sc, struct mps_command *tm,
 807     uint8_t type);
 808
 809 SYSCTL_DECL(_hw_mps);
 810
 811 /* Compatibility shims for different OS versions */
 812 #if __FreeBSD_version >= 800001
 813 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 814     kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 815 #define mps_kproc_exit(arg)     kproc_exit(arg)
 816 #else
 817 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 818     kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 819 #define mps_kproc_exit(arg)     kthread_exit(arg)
 820 #endif
 821
 822 #if defined(CAM_PRIORITY_XPT)
 823 #define MPS_PRIORITY_XPT        CAM_PRIORITY_XPT
 824 #else
 825 #define MPS_PRIORITY_XPT        5
 826 #endif
 827
 828 #if __FreeBSD_version < 800107
 829 // Prior to FreeBSD-8.0 scp3_flags was not defined.
 830 #define spc3_flags reserved
 831
 832 #define SPC3_SID_PROTECT    0x01
 833 #define SPC3_SID_3PC        0x08
 834 #define SPC3_SID_TPGS_MASK  0x30
 835 #define SPC3_SID_TPGS_IMPLICIT  0x10
 836 #define SPC3_SID_TPGS_EXPLICIT  0x20
 837 #define SPC3_SID_ACC        0x40
 838 #define SPC3_SID_SCCS       0x80
 839
 840 #define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE
 841 #endif
 842
 843 #endif
 844