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