sys/dev/mpr/mprvar.h

   1 /*-
   2  * Copyright (c) 2009 Yahoo! Inc.
   3  * Copyright (c) 2011-2015 LSI Corp.
   4  * Copyright (c) 2013-2016 Avago Technologies
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _MPRVAR_H
  34 #define _MPRVAR_H
  35
  36 #define MPR_DRIVER_VERSION      "15.02.00.00-fbsd"
  37
  38 #define MPR_DB_MAX_WAIT         2500
  39
  40 #define MPR_REQ_FRAMES          1024
  41 #define MPR_EVT_REPLY_FRAMES    32
  42 #define MPR_REPLY_FRAMES        MPR_REQ_FRAMES
  43 #define MPR_CHAIN_FRAMES        2048
  44 #define MPR_MAXIO_PAGES         (-1)
  45 #define MPR_SENSE_LEN           SSD_FULL_SIZE
  46 #define MPR_MSI_COUNT           1
  47 #define MPR_SGE64_SIZE          12
  48 #define MPR_SGE32_SIZE          8
  49 #define MPR_SGC_SIZE            8
  50 #define MPR_DEFAULT_CHAIN_SEG_SIZE      8
  51 #define MPR_MAX_CHAIN_ELEMENT_SIZE      16
  52
  53 /*
  54  * PCIe NVMe Specific defines
  55  */
  56 //SLM-for now just use the same value as a SAS disk
  57 #define NVME_QDEPTH                     MPR_REQ_FRAMES
  58 #define PRP_ENTRY_SIZE                  8
  59 #define NVME_CMD_PRP1_OFFSET            24      /* PRP1 offset in NVMe cmd */
  60 #define NVME_CMD_PRP2_OFFSET            32      /* PRP2 offset in NVMe cmd */
  61 #define NVME_ERROR_RESPONSE_SIZE        16      /* Max NVME Error Response */
  62 #define HOST_PAGE_SIZE_4K               12
  63
  64 #define MPR_FUNCTRACE(sc)                       \
  65         mpr_dprint((sc), MPR_TRACE, "%s\n", __func__)
  66
  67 #define CAN_SLEEP                       1
  68 #define NO_SLEEP                        0
  69
  70 #define MPR_PERIODIC_DELAY      1       /* 1 second heartbeat/watchdog check */
  71 #define MPR_ATA_ID_TIMEOUT      5       /* 5 second timeout for SATA ID cmd */
  72
  73 #define IFAULT_IOP_OVER_TEMP_THRESHOLD_EXCEEDED 0x2810
  74
  75 #define MPR_SCSI_RI_INVALID_FRAME       (0x00000002)
  76 #define MPR_STRING_LENGTH               64
  77
  78 #define DEFAULT_SPINUP_WAIT     3       /* seconds to wait for spinup */
  79
  80 #include <sys/endian.h>
  81
  82 /*
  83  * host mapping related macro definitions
  84  */
  85 #define MPR_MAPTABLE_BAD_IDX    0xFFFFFFFF
  86 #define MPR_DPM_BAD_IDX         0xFFFF
  87 #define MPR_ENCTABLE_BAD_IDX    0xFF
  88 #define MPR_MAX_MISSING_COUNT   0x0F
  89 #define MPR_DEV_RESERVED        0x20000000
  90 #define MPR_MAP_IN_USE          0x10000000
  91 #define MPR_RAID_CHANNEL        1
  92 #define MPR_MAP_BAD_ID          0xFFFFFFFF
  93
  94 typedef uint8_t u8;
  95 typedef uint16_t u16;
  96 typedef uint32_t u32;
  97 typedef uint64_t u64;
  98
  99 /**
 100  * struct dev_mapping_table - device mapping information
 101  * @physical_id: SAS address for drives or WWID for RAID volumes
 102  * @device_info: bitfield provides detailed info about the device
 103  * @phy_bits: bitfields indicating controller phys
 104  * @dpm_entry_num: index of this device in device persistent map table
 105  * @dev_handle: device handle for the device pointed by this entry
 106  * @channel: target channel
 107  * @id: target id
 108  * @missing_count: number of times the device not detected by driver
 109  * @hide_flag: Hide this physical disk/not (foreign configuration)
 110  * @init_complete: Whether the start of the day checks completed or not
 111  * @TLR_bits: Turn TLR support on or off
 112  */
 113 struct dev_mapping_table {
 114         u64     physical_id;
 115         u32     device_info;
 116         u32     phy_bits;
 117         u16     dpm_entry_num;
 118         u16     dev_handle;
 119         u8      reserved1;
 120         u8      channel;
 121         u16     id;
 122         u8      missing_count;
 123         u8      init_complete;
 124         u8      TLR_bits;
 125         u8      reserved2;
 126 };
 127
 128 /**
 129  * struct enc_mapping_table -  mapping information about an enclosure
 130  * @enclosure_id: Logical ID of this enclosure
 131  * @start_index: index to the entry in dev_mapping_table
 132  * @phy_bits: bitfields indicating controller phys
 133  * @dpm_entry_num: index of this enclosure in device persistent map table
 134  * @enc_handle: device handle for the enclosure pointed by this entry
 135  * @num_slots: number of slots in the enclosure
 136  * @start_slot: Starting slot id
 137  * @missing_count: number of times the device not detected by driver
 138  * @removal_flag: used to mark the device for removal
 139  * @skip_search: used as a flag to include/exclude enclosure for search
 140  * @init_complete: Whether the start of the day checks completed or not
 141  */
 142 struct enc_mapping_table {
 143         u64     enclosure_id;
 144         u32     start_index;
 145         u32     phy_bits;
 146         u16     dpm_entry_num;
 147         u16     enc_handle;
 148         u16     num_slots;
 149         u16     start_slot;
 150         u8      missing_count;
 151         u8      removal_flag;
 152         u8      skip_search;
 153         u8      init_complete;
 154 };
 155
 156 /**
 157  * struct map_removal_table - entries to be removed from mapping table
 158  * @dpm_entry_num: index of this device in device persistent map table
 159  * @dev_handle: device handle for the device pointed by this entry
 160  */
 161 struct map_removal_table{
 162         u16     dpm_entry_num;
 163         u16     dev_handle;
 164 };
 165
 166 typedef struct mpr_fw_diagnostic_buffer {
 167         size_t          size;
 168         uint8_t         extended_type;
 169         uint8_t         buffer_type;
 170         uint8_t         force_release;
 171         uint32_t        product_specific[23];
 172         uint8_t         immediate;
 173         uint8_t         enabled;
 174         uint8_t         valid_data;
 175         uint8_t         owned_by_firmware;
 176         uint32_t        unique_id;
 177 } mpr_fw_diagnostic_buffer_t;
 178
 179 struct mpr_softc;
 180 struct mpr_command;
 181 struct mprsas_softc;
 182 union ccb;
 183 struct mprsas_target;
 184 struct mpr_column_map;
 185
 186 MALLOC_DECLARE(M_MPR);
 187
 188 typedef void mpr_evt_callback_t(struct mpr_softc *, uintptr_t,
 189     MPI2_EVENT_NOTIFICATION_REPLY *reply);
 190 typedef void mpr_command_callback_t(struct mpr_softc *, struct mpr_command *cm);
 191
 192 struct mpr_chain {
 193         TAILQ_ENTRY(mpr_chain)          chain_link;
 194         void                            *chain;
 195         uint64_t                        chain_busaddr;
 196 };
 197
 198 struct mpr_prp_page {
 199         TAILQ_ENTRY(mpr_prp_page)       prp_page_link;
 200         uint64_t                        *prp_page;
 201         uint64_t                        prp_page_busaddr;
 202 };
 203
 204 /*
 205  * This needs to be at least 2 to support SMP passthrough.
 206  */
 207 #define       MPR_IOVEC_COUNT 2
 208
 209 struct mpr_command {
 210         TAILQ_ENTRY(mpr_command)        cm_link;
 211         TAILQ_ENTRY(mpr_command)        cm_recovery;
 212         struct mpr_softc                *cm_sc;
 213         union ccb                       *cm_ccb;
 214         void                            *cm_data;
 215         u_int                           cm_length;
 216         u_int                           cm_out_len;
 217         struct uio                      cm_uio;
 218         struct iovec                    cm_iovec[MPR_IOVEC_COUNT];
 219         u_int                           cm_max_segs;
 220         u_int                           cm_sglsize;
 221         void                            *cm_sge;
 222         uint8_t                         *cm_req;
 223         uint8_t                         *cm_reply;
 224         uint32_t                        cm_reply_data;
 225         mpr_command_callback_t          *cm_complete;
 226         void                            *cm_complete_data;
 227         struct mprsas_target            *cm_targ;
 228         MPI2_REQUEST_DESCRIPTOR_UNION   cm_desc;
 229         u_int                           cm_lun;
 230         u_int                           cm_flags;
 231 #define MPR_CM_FLAGS_POLLED             (1 << 0)
 232 #define MPR_CM_FLAGS_COMPLETE           (1 << 1)
 233 #define MPR_CM_FLAGS_SGE_SIMPLE         (1 << 2)
 234 #define MPR_CM_FLAGS_DATAOUT            (1 << 3)
 235 #define MPR_CM_FLAGS_DATAIN             (1 << 4)
 236 #define MPR_CM_FLAGS_WAKEUP             (1 << 5)
 237 #define MPR_CM_FLAGS_USE_UIO            (1 << 6)
 238 #define MPR_CM_FLAGS_SMP_PASS           (1 << 7)
 239 #define MPR_CM_FLAGS_CHAIN_FAILED       (1 << 8)
 240 #define MPR_CM_FLAGS_ERROR_MASK         MPR_CM_FLAGS_CHAIN_FAILED
 241 #define MPR_CM_FLAGS_USE_CCB            (1 << 9)
 242 #define MPR_CM_FLAGS_SATA_ID_TIMEOUT    (1 << 10)
 243         u_int                           cm_state;
 244 #define MPR_CM_STATE_FREE               0
 245 #define MPR_CM_STATE_BUSY               1
 246 #define MPR_CM_STATE_TIMEDOUT           2
 247         bus_dmamap_t                    cm_dmamap;
 248         struct scsi_sense_data          *cm_sense;
 249         uint64_t                        *nvme_error_response;
 250         TAILQ_HEAD(, mpr_chain)         cm_chain_list;
 251         TAILQ_HEAD(, mpr_prp_page)      cm_prp_page_list;
 252         uint32_t                        cm_req_busaddr;
 253         bus_addr_t                      cm_sense_busaddr;
 254         struct callout                  cm_callout;
 255 };
 256
 257 struct mpr_column_map {
 258         uint16_t                        dev_handle;
 259         uint8_t                         phys_disk_num;
 260 };
 261
 262 struct mpr_event_handle {
 263         TAILQ_ENTRY(mpr_event_handle)   eh_list;
 264         mpr_evt_callback_t              *callback;
 265         void                            *data;
 266         uint8_t                         mask[16];
 267 };
 268
 269 struct mpr_softc {
 270         device_t                        mpr_dev;
 271         struct cdev                     *mpr_cdev;
 272         u_int                           mpr_flags;
 273 #define MPR_FLAGS_INTX          (1 << 0)
 274 #define MPR_FLAGS_MSI           (1 << 1)
 275 #define MPR_FLAGS_BUSY          (1 << 2)
 276 #define MPR_FLAGS_SHUTDOWN      (1 << 3)
 277 #define MPR_FLAGS_DIAGRESET     (1 << 4)
 278 #define MPR_FLAGS_ATTACH_DONE   (1 << 5)
 279 #define MPR_FLAGS_GEN35_IOC     (1 << 6)
 280         u_int                           mpr_debug;
 281         u_int                           disable_msix;
 282         u_int                           disable_msi;
 283         u_int                           atomic_desc_capable;
 284         int                             tm_cmds_active;
 285         int                             io_cmds_active;
 286         int                             io_cmds_highwater;
 287         int                             chain_free;
 288         int                             max_chains;
 289         int                             max_io_pages;
 290         u_int                           maxio;
 291         int                             chain_free_lowwater;
 292         uint32_t                        chain_frame_size;
 293         uint16_t                        chain_seg_size;
 294         int                             prp_buffer_size;
 295         int                             prp_pages_free;
 296         int                             prp_pages_free_lowwater;
 297         u_int                           enable_ssu;
 298         int                             spinup_wait_time;
 299         int                             use_phynum;
 300         uint64_t                        chain_alloc_fail;
 301         uint64_t                        prp_page_alloc_fail;
 302         struct sysctl_ctx_list          sysctl_ctx;
 303         struct sysctl_oid               *sysctl_tree;
 304         char                            fw_version[16];
 305         struct mpr_command              *commands;
 306         struct mpr_chain                *chains;
 307         struct mpr_prp_page             *prps;
 308         struct callout                  periodic;
 309
 310         struct mprsas_softc             *sassc;
 311         char            tmp_string[MPR_STRING_LENGTH];
 312         TAILQ_HEAD(, mpr_command)       req_list;
 313         TAILQ_HEAD(, mpr_command)       high_priority_req_list;
 314         TAILQ_HEAD(, mpr_chain)         chain_list;
 315         TAILQ_HEAD(, mpr_prp_page)      prp_page_list;
 316         TAILQ_HEAD(, mpr_command)       tm_list;
 317         int                             replypostindex;
 318         int                             replyfreeindex;
 319
 320         struct resource                 *mpr_regs_resource;
 321         bus_space_handle_t              mpr_bhandle;
 322         bus_space_tag_t                 mpr_btag;
 323         int                             mpr_regs_rid;
 324
 325         bus_dma_tag_t                   mpr_parent_dmat;
 326         bus_dma_tag_t                   buffer_dmat;
 327
 328         MPI2_IOC_FACTS_REPLY            *facts;
 329         int                             num_reqs;
 330         int                             num_replies;
 331         int                             fqdepth;        /* Free queue */
 332         int                             pqdepth;        /* Post queue */
 333
 334         uint8_t                         event_mask[16];
 335         TAILQ_HEAD(, mpr_event_handle)  event_list;
 336         struct mpr_event_handle         *mpr_log_eh;
 337
 338         struct mtx                      mpr_mtx;
 339         struct intr_config_hook         mpr_ich;
 340         struct resource                 *mpr_irq[MPR_MSI_COUNT];
 341         void                            *mpr_intrhand[MPR_MSI_COUNT];
 342         int                             mpr_irq_rid[MPR_MSI_COUNT];
 343
 344         uint8_t                         *req_frames;
 345         bus_addr_t                      req_busaddr;
 346         bus_dma_tag_t                   req_dmat;
 347         bus_dmamap_t                    req_map;
 348
 349         uint8_t                         *reply_frames;
 350         bus_addr_t                      reply_busaddr;
 351         bus_dma_tag_t                   reply_dmat;
 352         bus_dmamap_t                    reply_map;
 353
 354         struct scsi_sense_data          *sense_frames;
 355         bus_addr_t                      sense_busaddr;
 356         bus_dma_tag_t                   sense_dmat;
 357         bus_dmamap_t                    sense_map;
 358
 359         uint8_t                         *chain_frames;
 360         bus_addr_t                      chain_busaddr;
 361         bus_dma_tag_t                   chain_dmat;
 362         bus_dmamap_t                    chain_map;
 363
 364         uint8_t                         *prp_pages;
 365         bus_addr_t                      prp_page_busaddr;
 366         bus_dma_tag_t                   prp_page_dmat;
 367         bus_dmamap_t                    prp_page_map;
 368
 369         MPI2_REPLY_DESCRIPTORS_UNION    *post_queue;
 370         bus_addr_t                      post_busaddr;
 371         uint32_t                        *free_queue;
 372         bus_addr_t                      free_busaddr;
 373         bus_dma_tag_t                   queues_dmat;
 374         bus_dmamap_t                    queues_map;
 375
 376         uint8_t                         *fw_diag_buffer;
 377         bus_addr_t                      fw_diag_busaddr;
 378         bus_dma_tag_t                   fw_diag_dmat;
 379         bus_dmamap_t                    fw_diag_map;
 380
 381         uint8_t                         ir_firmware;
 382
 383         /* static config pages */
 384         Mpi2IOCPage8_t                  ioc_pg8;
 385         Mpi2IOUnitPage8_t               iounit_pg8;
 386
 387         /* host mapping support */
 388         struct dev_mapping_table        *mapping_table;
 389         struct enc_mapping_table        *enclosure_table;
 390         struct map_removal_table        *removal_table;
 391         uint8_t                         *dpm_entry_used;
 392         uint8_t                         *dpm_flush_entry;
 393         Mpi2DriverMappingPage0_t        *dpm_pg0;
 394         uint16_t                        max_devices;
 395         uint16_t                        max_enclosures;
 396         uint16_t                        max_expanders;
 397         uint8_t                         max_volumes;
 398         uint8_t                         num_enc_table_entries;
 399         uint8_t                         num_rsvd_entries;
 400         uint8_t                         num_channels;
 401         uint16_t                        max_dpm_entries;
 402         uint8_t                         is_dpm_enable;
 403         uint8_t                         track_mapping_events;
 404         uint32_t                        pending_map_events;
 405         uint8_t                         mt_full_retry;
 406         uint8_t                         mt_add_device_failed;
 407
 408         /* FW diag Buffer List */
 409         mpr_fw_diagnostic_buffer_t
 410                                 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT];
 411
 412         /* Event Recording IOCTL support */
 413         uint32_t                        events_to_record[4];
 414         mpr_event_entry_t               recorded_events[MPR_EVENT_QUEUE_SIZE];
 415         uint8_t                         event_index;
 416         uint32_t                        event_number;
 417
 418         /* EEDP and TLR support */
 419         uint8_t                         eedp_enabled;
 420         uint8_t                         control_TLR;
 421
 422         /* Shutdown Event Handler */
 423         eventhandler_tag                shutdown_eh;
 424
 425         /* To track topo events during reset */
 426 #define MPR_DIAG_RESET_TIMEOUT  300000
 427         uint8_t                         wait_for_port_enable;
 428         uint8_t                         port_enable_complete;
 429         uint8_t                         msleep_fake_chan;
 430
 431         /* StartStopUnit command handling at shutdown */
 432         uint32_t                        SSU_refcount;
 433         uint8_t                         SSU_started;
 434
 435         char                            exclude_ids[80];
 436         struct timeval                  lastfail;
 437 };
 438
 439 struct mpr_config_params {
 440         MPI2_CONFIG_EXT_PAGE_HEADER_UNION       hdr;
 441         u_int           action;
 442         u_int           page_address;   /* Attributes, not a phys address */
 443         u_int           status;
 444         void            *buffer;
 445         u_int           length;
 446         int             timeout;
 447         void            (*callback)(struct mpr_softc *, struct mpr_config_params *);
 448         void            *cbdata;
 449 };
 450
 451 struct scsi_read_capacity_eedp
 452 {
 453         uint8_t addr[8];
 454         uint8_t length[4];
 455         uint8_t protect;
 456 };
 457
 458 static __inline uint32_t
 459 mpr_regread(struct mpr_softc *sc, uint32_t offset)
 460 {
 461         return (bus_space_read_4(sc->mpr_btag, sc->mpr_bhandle, offset));
 462 }
 463
 464 static __inline void
 465 mpr_regwrite(struct mpr_softc *sc, uint32_t offset, uint32_t val)
 466 {
 467         bus_space_write_4(sc->mpr_btag, sc->mpr_bhandle, offset, val);
 468 }
 469
 470 /* free_queue must have Little Endian address
 471  * TODO- cm_reply_data is unwanted. We can remove it.
 472  * */
 473 static __inline void
 474 mpr_free_reply(struct mpr_softc *sc, uint32_t busaddr)
 475 {
 476         if (++sc->replyfreeindex >= sc->fqdepth)
 477                 sc->replyfreeindex = 0;
 478         sc->free_queue[sc->replyfreeindex] = htole32(busaddr);
 479         mpr_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
 480 }
 481
 482 static __inline struct mpr_chain *
 483 mpr_alloc_chain(struct mpr_softc *sc)
 484 {
 485         struct mpr_chain *chain;
 486
 487         if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) {
 488                 TAILQ_REMOVE(&sc->chain_list, chain, chain_link);
 489                 sc->chain_free--;
 490                 if (sc->chain_free < sc->chain_free_lowwater)
 491                         sc->chain_free_lowwater = sc->chain_free;
 492         } else
 493                 sc->chain_alloc_fail++;
 494         return (chain);
 495 }
 496
 497 static __inline void
 498 mpr_free_chain(struct mpr_softc *sc, struct mpr_chain *chain)
 499 {
 500 #if 0
 501         bzero(chain->chain, 128);
 502 #endif
 503         sc->chain_free++;
 504         TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link);
 505 }
 506
 507 static __inline struct mpr_prp_page *
 508 mpr_alloc_prp_page(struct mpr_softc *sc)
 509 {
 510         struct mpr_prp_page *prp_page;
 511
 512         if ((prp_page = TAILQ_FIRST(&sc->prp_page_list)) != NULL) {
 513                 TAILQ_REMOVE(&sc->prp_page_list, prp_page, prp_page_link);
 514                 sc->prp_pages_free--;
 515                 if (sc->prp_pages_free < sc->prp_pages_free_lowwater)
 516                         sc->prp_pages_free_lowwater = sc->prp_pages_free;
 517         } else
 518                 sc->prp_page_alloc_fail++;
 519         return (prp_page);
 520 }
 521
 522 static __inline void
 523 mpr_free_prp_page(struct mpr_softc *sc, struct mpr_prp_page *prp_page)
 524 {
 525         sc->prp_pages_free++;
 526         TAILQ_INSERT_TAIL(&sc->prp_page_list, prp_page, prp_page_link);
 527 }
 528
 529 static __inline void
 530 mpr_free_command(struct mpr_softc *sc, struct mpr_command *cm)
 531 {
 532         struct mpr_chain *chain, *chain_temp;
 533         struct mpr_prp_page *prp_page, *prp_page_temp;
 534
 535         if (cm->cm_reply != NULL)
 536                 mpr_free_reply(sc, cm->cm_reply_data);
 537         cm->cm_reply = NULL;
 538         cm->cm_flags = 0;
 539         cm->cm_complete = NULL;
 540         cm->cm_complete_data = NULL;
 541         cm->cm_ccb = NULL;
 542         cm->cm_targ = NULL;
 543         cm->cm_max_segs = 0;
 544         cm->cm_lun = 0;
 545         cm->cm_state = MPR_CM_STATE_FREE;
 546         cm->cm_data = NULL;
 547         cm->cm_length = 0;
 548         cm->cm_out_len = 0;
 549         cm->cm_sglsize = 0;
 550         cm->cm_sge = NULL;
 551
 552         TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
 553                 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
 554                 mpr_free_chain(sc, chain);
 555         }
 556         TAILQ_FOREACH_SAFE(prp_page, &cm->cm_prp_page_list, prp_page_link,
 557             prp_page_temp) {
 558                 TAILQ_REMOVE(&cm->cm_prp_page_list, prp_page, prp_page_link);
 559                 mpr_free_prp_page(sc, prp_page);
 560         }
 561         TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link);
 562 }
 563
 564 static __inline struct mpr_command *
 565 mpr_alloc_command(struct mpr_softc *sc)
 566 {
 567         struct mpr_command *cm;
 568
 569         cm = TAILQ_FIRST(&sc->req_list);
 570         if (cm == NULL)
 571                 return (NULL);
 572
 573         TAILQ_REMOVE(&sc->req_list, cm, cm_link);
 574         KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy "
 575             "command\n"));
 576         cm->cm_state = MPR_CM_STATE_BUSY;
 577         return (cm);
 578 }
 579
 580 static __inline void
 581 mpr_free_high_priority_command(struct mpr_softc *sc, struct mpr_command *cm)
 582 {
 583         struct mpr_chain *chain, *chain_temp;
 584
 585         if (cm->cm_reply != NULL)
 586                 mpr_free_reply(sc, cm->cm_reply_data);
 587         cm->cm_reply = NULL;
 588         cm->cm_flags = 0;
 589         cm->cm_complete = NULL;
 590         cm->cm_complete_data = NULL;
 591         cm->cm_ccb = NULL;
 592         cm->cm_targ = NULL;
 593         cm->cm_lun = 0;
 594         cm->cm_state = MPR_CM_STATE_FREE;
 595         TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
 596                 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
 597                 mpr_free_chain(sc, chain);
 598         }
 599         TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link);
 600 }
 601
 602 static __inline struct mpr_command *
 603 mpr_alloc_high_priority_command(struct mpr_softc *sc)
 604 {
 605         struct mpr_command *cm;
 606
 607         cm = TAILQ_FIRST(&sc->high_priority_req_list);
 608         if (cm == NULL)
 609                 return (NULL);
 610
 611         TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link);
 612         KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy "
 613             "command\n"));
 614         cm->cm_state = MPR_CM_STATE_BUSY;
 615         return (cm);
 616 }
 617
 618 static __inline void
 619 mpr_lock(struct mpr_softc *sc)
 620 {
 621         mtx_lock(&sc->mpr_mtx);
 622 }
 623
 624 static __inline void
 625 mpr_unlock(struct mpr_softc *sc)
 626 {
 627         mtx_unlock(&sc->mpr_mtx);
 628 }
 629
 630 #define MPR_INFO        (1 << 0)        /* Basic info */
 631 #define MPR_FAULT       (1 << 1)        /* Hardware faults */
 632 #define MPR_EVENT       (1 << 2)        /* Event data from the controller */
 633 #define MPR_LOG         (1 << 3)        /* Log data from the controller */
 634 #define MPR_RECOVERY    (1 << 4)        /* Command error recovery tracing */
 635 #define MPR_ERROR       (1 << 5)        /* Parameter errors, programming bugs */
 636 #define MPR_INIT        (1 << 6)        /* Things related to system init */
 637 #define MPR_XINFO       (1 << 7)        /* More detailed/noisy info */
 638 #define MPR_USER        (1 << 8)        /* Trace user-generated commands */
 639 #define MPR_MAPPING     (1 << 9)        /* Trace device mappings */
 640 #define MPR_TRACE       (1 << 10)       /* Function-by-function trace */
 641
 642 #define MPR_SSU_DISABLE_SSD_DISABLE_HDD 0
 643 #define MPR_SSU_ENABLE_SSD_DISABLE_HDD  1
 644 #define MPR_SSU_DISABLE_SSD_ENABLE_HDD  2
 645 #define MPR_SSU_ENABLE_SSD_ENABLE_HDD   3
 646
 647 #define mpr_printf(sc, args...)                         \
 648         device_printf((sc)->mpr_dev, ##args)
 649
 650 #define mpr_print_field(sc, msg, args...)               \
 651         printf("\t" msg, ##args)
 652
 653 #define mpr_vprintf(sc, args...)                        \
 654 do {                                                    \
 655         if (bootverbose)                                \
 656                 mpr_printf(sc, ##args);                 \
 657 } while (0)
 658
 659 #define mpr_dprint(sc, level, msg, args...)             \
 660 do {                                                    \
 661         if ((sc)->mpr_debug & (level))                  \
 662                 device_printf((sc)->mpr_dev, msg, ##args);      \
 663 } while (0)
 664
 665 #define MPR_PRINTFIELD_START(sc, tag...)        \
 666         mpr_printf((sc), ##tag);                \
 667         mpr_print_field((sc), ":\n")
 668 #define MPR_PRINTFIELD_END(sc, tag)             \
 669         mpr_printf((sc), tag "\n")
 670 #define MPR_PRINTFIELD(sc, facts, attr, fmt)    \
 671         mpr_print_field((sc), #attr ": " #fmt "\n", (facts)->attr)
 672
 673 static __inline void
 674 mpr_from_u64(uint64_t data, U64 *mpr)
 675 {
 676         (mpr)->High = htole32((uint32_t)((data) >> 32));
 677         (mpr)->Low = htole32((uint32_t)((data) & 0xffffffff));
 678 }
 679
 680 static __inline uint64_t
 681 mpr_to_u64(U64 *data)
 682 {
 683         return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low));
 684 }
 685
 686 static __inline void
 687 mpr_mask_intr(struct mpr_softc *sc)
 688 {
 689         uint32_t mask;
 690
 691         mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
 692         mask |= MPI2_HIM_REPLY_INT_MASK;
 693         mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
 694 }
 695
 696 static __inline void
 697 mpr_unmask_intr(struct mpr_softc *sc)
 698 {
 699         uint32_t mask;
 700
 701         mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
 702         mask &= ~MPI2_HIM_REPLY_INT_MASK;
 703         mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
 704 }
 705
 706 int mpr_pci_setup_interrupts(struct mpr_softc *sc);
 707 int mpr_pci_restore(struct mpr_softc *sc);
 708
 709 int mpr_attach(struct mpr_softc *sc);
 710 int mpr_free(struct mpr_softc *sc);
 711 void mpr_intr(void *);
 712 void mpr_intr_msi(void *);
 713 void mpr_intr_locked(void *);
 714 int mpr_register_events(struct mpr_softc *, uint8_t *, mpr_evt_callback_t *,
 715     void *, struct mpr_event_handle **);
 716 int mpr_restart(struct mpr_softc *);
 717 int mpr_update_events(struct mpr_softc *, struct mpr_event_handle *, uint8_t *);
 718 int mpr_deregister_events(struct mpr_softc *, struct mpr_event_handle *);
 719 void mpr_build_nvme_prp(struct mpr_softc *sc, struct mpr_command *cm,
 720     Mpi26NVMeEncapsulatedRequest_t *nvme_encap_request, void *data,
 721     uint32_t data_in_sz, uint32_t data_out_sz);
 722 int mpr_push_sge(struct mpr_command *, MPI2_SGE_SIMPLE64 *, size_t, int);
 723 int mpr_push_ieee_sge(struct mpr_command *, void *, int);
 724 int mpr_add_dmaseg(struct mpr_command *, vm_paddr_t, size_t, u_int, int);
 725 int mpr_attach_sas(struct mpr_softc *sc);
 726 int mpr_detach_sas(struct mpr_softc *sc);
 727 int mpr_read_config_page(struct mpr_softc *, struct mpr_config_params *);
 728 int mpr_write_config_page(struct mpr_softc *, struct mpr_config_params *);
 729 void mpr_memaddr_cb(void *, bus_dma_segment_t *, int , int );
 730 void mpr_init_sge(struct mpr_command *cm, void *req, void *sge);
 731 int mpr_attach_user(struct mpr_softc *);
 732 void mpr_detach_user(struct mpr_softc *);
 733 void mprsas_record_event(struct mpr_softc *sc,
 734     MPI2_EVENT_NOTIFICATION_REPLY *event_reply);
 735
 736 int mpr_map_command(struct mpr_softc *sc, struct mpr_command *cm);
 737 int mpr_wait_command(struct mpr_softc *sc, struct mpr_command *cm, int timeout,
 738     int sleep_flag);
 739 int mpr_request_polled(struct mpr_softc *sc, struct mpr_command *cm);
 740
 741 int mpr_config_get_bios_pg3(struct mpr_softc *sc, Mpi2ConfigReply_t
 742     *mpi_reply, Mpi2BiosPage3_t *config_page);
 743 int mpr_config_get_raid_volume_pg0(struct mpr_softc *sc, Mpi2ConfigReply_t
 744     *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address);
 745 int mpr_config_get_ioc_pg8(struct mpr_softc *sc, Mpi2ConfigReply_t *,
 746     Mpi2IOCPage8_t *);
 747 int mpr_config_get_iounit_pg8(struct mpr_softc *sc,
 748     Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage8_t *config_page);
 749 int mpr_config_get_sas_device_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
 750     Mpi2SasDevicePage0_t *, u32 , u16 );
 751 int mpr_config_get_pcie_device_pg0(struct mpr_softc *sc, Mpi2ConfigReply_t
 752     *mpi_reply, Mpi26PCIeDevicePage0_t *config_page, u32 form, u16 handle);
 753 int mpr_config_get_pcie_device_pg2(struct mpr_softc *sc, Mpi2ConfigReply_t
 754     *mpi_reply, Mpi26PCIeDevicePage2_t *config_page, u32 form, u16 handle);
 755 int mpr_config_get_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
 756     Mpi2DriverMappingPage0_t *, u16 );
 757 int mpr_config_get_raid_volume_pg1(struct mpr_softc *sc,
 758     Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
 759     u16 handle);
 760 int mpr_config_get_volume_wwid(struct mpr_softc *sc, u16 volume_handle,
 761     u64 *wwid);
 762 int mpr_config_get_raid_pd_pg0(struct mpr_softc *sc,
 763     Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
 764     u32 page_address);
 765 void mprsas_ir_shutdown(struct mpr_softc *sc);
 766
 767 int mpr_reinit(struct mpr_softc *sc);
 768 void mprsas_handle_reinit(struct mpr_softc *sc);
 769
 770 void mpr_base_static_config_pages(struct mpr_softc *sc);
 771
 772 int mpr_mapping_initialize(struct mpr_softc *);
 773 void mpr_mapping_topology_change_event(struct mpr_softc *,
 774     Mpi2EventDataSasTopologyChangeList_t *);
 775 void mpr_mapping_pcie_topology_change_event(struct mpr_softc *sc,
 776     Mpi26EventDataPCIeTopologyChangeList_t *event_data);
 777 int mpr_mapping_is_reinit_required(struct mpr_softc *);
 778 void mpr_mapping_free_memory(struct mpr_softc *sc);
 779 int mpr_config_set_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
 780     Mpi2DriverMappingPage0_t *, u16 );
 781 void mpr_mapping_exit(struct mpr_softc *);
 782 void mpr_mapping_check_devices(struct mpr_softc *, int);
 783 int mpr_mapping_allocate_memory(struct mpr_softc *sc);
 784 unsigned int mpr_mapping_get_sas_id(struct mpr_softc *, uint64_t , u16);
 785 unsigned int mpr_mapping_get_sas_id_from_handle(struct mpr_softc *sc,
 786     u16 handle);
 787 unsigned int mpr_mapping_get_raid_id(struct mpr_softc *sc, u64 wwid,
 788     u16 handle);
 789 unsigned int mpr_mapping_get_raid_id_from_handle(struct mpr_softc *sc,
 790     u16 volHandle);
 791 void mpr_mapping_enclosure_dev_status_change_event(struct mpr_softc *,
 792     Mpi2EventDataSasEnclDevStatusChange_t *event_data);
 793 void mpr_mapping_ir_config_change_event(struct mpr_softc *sc,
 794     Mpi2EventDataIrConfigChangeList_t *event_data);
 795
 796 void mprsas_evt_handler(struct mpr_softc *sc, uintptr_t data,
 797     MPI2_EVENT_NOTIFICATION_REPLY *event);
 798 void mprsas_prepare_remove(struct mprsas_softc *sassc, uint16_t handle);
 799 void mprsas_prepare_volume_remove(struct mprsas_softc *sassc, uint16_t handle);
 800 int mprsas_startup(struct mpr_softc *sc);
 801 struct mprsas_target * mprsas_find_target_by_handle(struct mprsas_softc *, int,
 802     uint16_t);
 803 void mprsas_realloc_targets(struct mpr_softc *sc, int maxtargets);
 804 struct mpr_command * mprsas_alloc_tm(struct mpr_softc *sc);
 805 void mprsas_free_tm(struct mpr_softc *sc, struct mpr_command *tm);
 806 void mprsas_release_simq_reinit(struct mprsas_softc *sassc);
 807 int mprsas_send_reset(struct mpr_softc *sc, struct mpr_command *tm,
 808     uint8_t type);
 809
 810 SYSCTL_DECL(_hw_mpr);
 811
 812 /* Compatibility shims for different OS versions */
 813 #if __FreeBSD_version >= 800001
 814 #define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 815     kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 816 #define mpr_kproc_exit(arg)     kproc_exit(arg)
 817 #else
 818 #define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
 819     kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
 820 #define mpr_kproc_exit(arg)     kthread_exit(arg)
 821 #endif
 822
 823 #if defined(CAM_PRIORITY_XPT)
 824 #define MPR_PRIORITY_XPT        CAM_PRIORITY_XPT
 825 #else
 826 #define MPR_PRIORITY_XPT        5
 827 #endif
 828
 829 #if __FreeBSD_version < 800107
 830 // Prior to FreeBSD-8.0 scp3_flags was not defined.
 831 #define spc3_flags reserved
 832
 833 #define SPC3_SID_PROTECT    0x01
 834 #define SPC3_SID_3PC        0x08
 835 #define SPC3_SID_TPGS_MASK  0x30
 836 #define SPC3_SID_TPGS_IMPLICIT  0x10
 837 #define SPC3_SID_TPGS_EXPLICIT  0x20
 838 #define SPC3_SID_ACC        0x40
 839 #define SPC3_SID_SCCS       0x80
 840
 841 #define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE
 842 #endif
 843
 844 /* Definitions for SCSI unmap translation to NVMe DSM command */
 845
 846 /* UNMAP block descriptor structure */
 847 struct unmap_blk_desc {
 848         uint64_t slba;
 849         uint32_t nlb;
 850         uint32_t resv;
 851 };
 852
 853 /* UNMAP command's data */
 854 struct unmap_parm_list {
 855         uint16_t unmap_data_len;
 856         uint16_t unmap_blk_desc_data_len;
 857         uint32_t resv;
 858         struct unmap_blk_desc desc[0];
 859 };
 860
 861 /* SCSI ADDITIONAL SENSE Codes */
 862 #define FIXED_SENSE_DATA                                0x70
 863 #define SCSI_ASC_NO_SENSE                               0x00
 864 #define SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT             0x03
 865 #define SCSI_ASC_LUN_NOT_READY                          0x04
 866 #define SCSI_ASC_WARNING                                0x0B
 867 #define SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED           0x10
 868 #define SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED          0x10
 869 #define SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED          0x10
 870 #define SCSI_ASC_UNRECOVERED_READ_ERROR                 0x11
 871 #define SCSI_ASC_MISCOMPARE_DURING_VERIFY               0x1D
 872 #define SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID           0x20
 873 #define SCSI_ASC_ILLEGAL_COMMAND                        0x20
 874 #define SCSI_ASC_ILLEGAL_BLOCK                          0x21
 875 #define SCSI_ASC_INVALID_CDB                            0x24
 876 #define SCSI_ASC_INVALID_LUN                            0x25
 877 #define SCSI_ASC_INVALID_PARAMETER                      0x26
 878 #define SCSI_ASC_FORMAT_COMMAND_FAILED                  0x31
 879 #define SCSI_ASC_INTERNAL_TARGET_FAILURE                0x44
 880
 881 /* SCSI ADDITIONAL SENSE Code Qualifiers */
 882 #define SCSI_ASCQ_CAUSE_NOT_REPORTABLE                  0x00
 883 #define SCSI_ASCQ_FORMAT_COMMAND_FAILED                 0x01
 884 #define SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED          0x01
 885 #define SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED         0x02
 886 #define SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED         0x03
 887 #define SCSI_ASCQ_FORMAT_IN_PROGRESS                    0x04
 888 #define SCSI_ASCQ_POWER_LOSS_EXPECTED                   0x08
 889 #define SCSI_ASCQ_INVALID_LUN_ID                        0x09
 890
 891 #endif
 892