sys/dev/mps/mpsvar.h

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