sys/dev/mps/mpsvar.h

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