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