drivers/scsi/mpi3mr/mpi3mr.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Driver for Broadcom MPI3 Storage Controllers
   4  *
   5  * Copyright (C) 2017-2022 Broadcom Inc.
   6  *  (mailto: mpi3mr-linuxdrv.pdl@broadcom.com)
   7  *
   8  */
   9
  10 #ifndef MPI3MR_H_INCLUDED
  11 #define MPI3MR_H_INCLUDED
  12
  13 #include <linux/blkdev.h>
  14 #include <linux/blk-mq.h>
  15 #include <linux/blk-mq-pci.h>
  16 #include <linux/delay.h>
  17 #include <linux/dmapool.h>
  18 #include <linux/errno.h>
  19 #include <linux/init.h>
  20 #include <linux/io.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/kernel.h>
  23 #include <linux/miscdevice.h>
  24 #include <linux/module.h>
  25 #include <linux/pci.h>
  26 #include <linux/poll.h>
  27 #include <linux/sched.h>
  28 #include <linux/slab.h>
  29 #include <linux/types.h>
  30 #include <linux/uaccess.h>
  31 #include <linux/utsname.h>
  32 #include <linux/version.h>
  33 #include <linux/workqueue.h>
  34 #include <asm/unaligned.h>
  35 #include <scsi/scsi.h>
  36 #include <scsi/scsi_cmnd.h>
  37 #include <scsi/scsi_dbg.h>
  38 #include <scsi/scsi_device.h>
  39 #include <scsi/scsi_host.h>
  40 #include <scsi/scsi_tcq.h>
  41 #include <uapi/scsi/scsi_bsg_mpi3mr.h>
  42 #include <scsi/scsi_transport_sas.h>
  43
  44 #include "mpi/mpi30_transport.h"
  45 #include "mpi/mpi30_cnfg.h"
  46 #include "mpi/mpi30_image.h"
  47 #include "mpi/mpi30_init.h"
  48 #include "mpi/mpi30_ioc.h"
  49 #include "mpi/mpi30_sas.h"
  50 #include "mpi/mpi30_pci.h"
  51 #include "mpi3mr_debug.h"
  52
  53 /* Global list and lock for storing multiple adapters managed by the driver */
  54 extern spinlock_t mrioc_list_lock;
  55 extern struct list_head mrioc_list;
  56 extern int prot_mask;
  57 extern atomic64_t event_counter;
  58
  59 #define MPI3MR_DRIVER_VERSION   "8.0.0.69.0"
  60 #define MPI3MR_DRIVER_RELDATE   "16-March-2022"
  61
  62 #define MPI3MR_DRIVER_NAME      "mpi3mr"
  63 #define MPI3MR_DRIVER_LICENSE   "GPL"
  64 #define MPI3MR_DRIVER_AUTHOR    "Broadcom Inc. <mpi3mr-linuxdrv.pdl@broadcom.com>"
  65 #define MPI3MR_DRIVER_DESC      "MPI3 Storage Controller Device Driver"
  66
  67 #define MPI3MR_NAME_LENGTH      32
  68 #define IOCNAME                 "%s: "
  69
  70 #define MPI3MR_MAX_SECTORS      2048
  71
  72 /* Definitions for internal SGL and Chain SGL buffers */
  73 #define MPI3MR_PAGE_SIZE_4K             4096
  74 #define MPI3MR_SG_DEPTH         (MPI3MR_PAGE_SIZE_4K / sizeof(struct mpi3_sge_common))
  75
  76 /* Definitions for MAX values for shost */
  77 #define MPI3MR_MAX_CMDS_LUN     128
  78 #define MPI3MR_MAX_CDB_LENGTH   32
  79
  80 /* Admin queue management definitions */
  81 #define MPI3MR_ADMIN_REQ_Q_SIZE         (2 * MPI3MR_PAGE_SIZE_4K)
  82 #define MPI3MR_ADMIN_REPLY_Q_SIZE       (4 * MPI3MR_PAGE_SIZE_4K)
  83 #define MPI3MR_ADMIN_REQ_FRAME_SZ       128
  84 #define MPI3MR_ADMIN_REPLY_FRAME_SZ     16
  85
  86 /* Operational queue management definitions */
  87 #define MPI3MR_OP_REQ_Q_QD              512
  88 #define MPI3MR_OP_REP_Q_QD              1024
  89 #define MPI3MR_OP_REP_Q_QD4K            4096
  90 #define MPI3MR_OP_REQ_Q_SEG_SIZE        4096
  91 #define MPI3MR_OP_REP_Q_SEG_SIZE        4096
  92 #define MPI3MR_MAX_SEG_LIST_SIZE        4096
  93
  94 /* Reserved Host Tag definitions */
  95 #define MPI3MR_HOSTTAG_INVALID          0xFFFF
  96 #define MPI3MR_HOSTTAG_INITCMDS         1
  97 #define MPI3MR_HOSTTAG_BSG_CMDS         2
  98 #define MPI3MR_HOSTTAG_PEL_ABORT        3
  99 #define MPI3MR_HOSTTAG_PEL_WAIT         4
 100 #define MPI3MR_HOSTTAG_BLK_TMS          5
 101 #define MPI3MR_HOSTTAG_CFG_CMDS         6
 102 #define MPI3MR_HOSTTAG_TRANSPORT_CMDS   7
 103
 104 #define MPI3MR_NUM_DEVRMCMD             16
 105 #define MPI3MR_HOSTTAG_DEVRMCMD_MIN     (MPI3MR_HOSTTAG_TRANSPORT_CMDS + 1)
 106 #define MPI3MR_HOSTTAG_DEVRMCMD_MAX     (MPI3MR_HOSTTAG_DEVRMCMD_MIN + \
 107                                                 MPI3MR_NUM_DEVRMCMD - 1)
 108
 109 #define MPI3MR_INTERNAL_CMDS_RESVD      MPI3MR_HOSTTAG_DEVRMCMD_MAX
 110 #define MPI3MR_NUM_EVTACKCMD            4
 111 #define MPI3MR_HOSTTAG_EVTACKCMD_MIN    (MPI3MR_HOSTTAG_DEVRMCMD_MAX + 1)
 112 #define MPI3MR_HOSTTAG_EVTACKCMD_MAX    (MPI3MR_HOSTTAG_EVTACKCMD_MIN + \
 113                                         MPI3MR_NUM_EVTACKCMD - 1)
 114
 115 /* Reduced resource count definition for crash kernel */
 116 #define MPI3MR_HOST_IOS_KDUMP           128
 117
 118 /* command/controller interaction timeout definitions in seconds */
 119 #define MPI3MR_INTADMCMD_TIMEOUT                60
 120 #define MPI3MR_PORTENABLE_TIMEOUT               300
 121 #define MPI3MR_PORTENABLE_POLL_INTERVAL         5
 122 #define MPI3MR_ABORTTM_TIMEOUT                  60
 123 #define MPI3MR_RESETTM_TIMEOUT                  60
 124 #define MPI3MR_RESET_HOST_IOWAIT_TIMEOUT        5
 125 #define MPI3MR_TSUPDATE_INTERVAL                900
 126 #define MPI3MR_DEFAULT_SHUTDOWN_TIME            120
 127 #define MPI3MR_RAID_ERRREC_RESET_TIMEOUT        180
 128 #define MPI3MR_PREPARE_FOR_RESET_TIMEOUT        180
 129 #define MPI3MR_RESET_ACK_TIMEOUT                30
 130
 131 #define MPI3MR_WATCHDOG_INTERVAL                1000 /* in milli seconds */
 132
 133 #define MPI3MR_DEFAULT_CFG_PAGE_SZ              1024 /* in bytes */
 134
 135 #define MPI3MR_SCMD_TIMEOUT    (60 * HZ)
 136 #define MPI3MR_EH_SCMD_TIMEOUT (60 * HZ)
 137
 138 /* Internal admin command state definitions*/
 139 #define MPI3MR_CMD_NOTUSED      0x8000
 140 #define MPI3MR_CMD_COMPLETE     0x0001
 141 #define MPI3MR_CMD_PENDING      0x0002
 142 #define MPI3MR_CMD_REPLY_VALID  0x0004
 143 #define MPI3MR_CMD_RESET        0x0008
 144
 145 /* Definitions for Event replies and sense buffer allocated per controller */
 146 #define MPI3MR_NUM_EVT_REPLIES  64
 147 #define MPI3MR_SENSE_BUF_SZ     256
 148 #define MPI3MR_SENSEBUF_FACTOR  3
 149 #define MPI3MR_CHAINBUF_FACTOR  3
 150 #define MPI3MR_CHAINBUFDIX_FACTOR       2
 151
 152 /* Invalid target device handle */
 153 #define MPI3MR_INVALID_DEV_HANDLE       0xFFFF
 154
 155 /* Controller Reset related definitions */
 156 #define MPI3MR_HOSTDIAG_UNLOCK_RETRY_COUNT      5
 157 #define MPI3MR_MAX_RESET_RETRY_COUNT            3
 158
 159 /* ResponseCode definitions */
 160 #define MPI3MR_RI_MASK_RESPCODE         (0x000000FF)
 161 #define MPI3MR_RSP_IO_QUEUED_ON_IOC \
 162                         MPI3_SCSITASKMGMT_RSPCODE_IO_QUEUED_ON_IOC
 163
 164 #define MPI3MR_DEFAULT_MDTS     (128 * 1024)
 165 #define MPI3MR_DEFAULT_PGSZEXP         (12)
 166
 167 /* Command retry count definitions */
 168 #define MPI3MR_DEV_RMHS_RETRY_COUNT 3
 169 #define MPI3MR_PEL_RETRY_COUNT 3
 170
 171 /* Default target device queue depth */
 172 #define MPI3MR_DEFAULT_SDEV_QD  32
 173
 174 /* Definitions for Threaded IRQ poll*/
 175 #define MPI3MR_IRQ_POLL_SLEEP                   2
 176 #define MPI3MR_IRQ_POLL_TRIGGER_IOCOUNT         8
 177
 178 /* Definitions for the controller security status*/
 179 #define MPI3MR_CTLR_SECURITY_STATUS_MASK        0x0C
 180 #define MPI3MR_CTLR_SECURE_DBG_STATUS_MASK      0x02
 181
 182 #define MPI3MR_INVALID_DEVICE                   0x00
 183 #define MPI3MR_CONFIG_SECURE_DEVICE             0x04
 184 #define MPI3MR_HARD_SECURE_DEVICE               0x08
 185 #define MPI3MR_TAMPERED_DEVICE                  0x0C
 186
 187 /* SGE Flag definition */
 188 #define MPI3MR_SGEFLAGS_SYSTEM_SIMPLE_END_OF_LIST \
 189         (MPI3_SGE_FLAGS_ELEMENT_TYPE_SIMPLE | MPI3_SGE_FLAGS_DLAS_SYSTEM | \
 190         MPI3_SGE_FLAGS_END_OF_LIST)
 191
 192 /* MSI Index from Reply Queue Index */
 193 #define REPLY_QUEUE_IDX_TO_MSIX_IDX(qidx, offset)       (qidx + offset)
 194
 195 /*
 196  * Maximum data transfer size definitions for management
 197  * application commands
 198  */
 199 #define MPI3MR_MAX_APP_XFER_SIZE        (1 * 1024 * 1024)
 200 #define MPI3MR_MAX_APP_XFER_SEGMENTS    512
 201 /*
 202  * 2048 sectors are for data buffers and additional 512 sectors for
 203  * other buffers
 204  */
 205 #define MPI3MR_MAX_APP_XFER_SECTORS     (2048 + 512)
 206
 207 /**
 208  * struct mpi3mr_nvme_pt_sge -  Structure to store SGEs for NVMe
 209  * Encapsulated commands.
 210  *
 211  * @base_addr: Physical address
 212  * @length: SGE length
 213  * @rsvd: Reserved
 214  * @rsvd1: Reserved
 215  * @sgl_type: sgl type
 216  */
 217 struct mpi3mr_nvme_pt_sge {
 218         u64 base_addr;
 219         u32 length;
 220         u16 rsvd;
 221         u8 rsvd1;
 222         u8 sgl_type;
 223 };
 224
 225 /**
 226  * struct mpi3mr_buf_map -  local structure to
 227  * track kernel and user buffers associated with an BSG
 228  * structure.
 229  *
 230  * @bsg_buf: BSG buffer virtual address
 231  * @bsg_buf_len:  BSG buffer length
 232  * @kern_buf: Kernel buffer virtual address
 233  * @kern_buf_len: Kernel buffer length
 234  * @kern_buf_dma: Kernel buffer DMA address
 235  * @data_dir: Data direction.
 236  */
 237 struct mpi3mr_buf_map {
 238         void *bsg_buf;
 239         u32 bsg_buf_len;
 240         void *kern_buf;
 241         u32 kern_buf_len;
 242         dma_addr_t kern_buf_dma;
 243         u8 data_dir;
 244 };
 245
 246 /* IOC State definitions */
 247 enum mpi3mr_iocstate {
 248         MRIOC_STATE_READY = 1,
 249         MRIOC_STATE_RESET,
 250         MRIOC_STATE_FAULT,
 251         MRIOC_STATE_BECOMING_READY,
 252         MRIOC_STATE_RESET_REQUESTED,
 253         MRIOC_STATE_UNRECOVERABLE,
 254 };
 255
 256 /* Reset reason code definitions*/
 257 enum mpi3mr_reset_reason {
 258         MPI3MR_RESET_FROM_BRINGUP = 1,
 259         MPI3MR_RESET_FROM_FAULT_WATCH = 2,
 260         MPI3MR_RESET_FROM_APP = 3,
 261         MPI3MR_RESET_FROM_EH_HOS = 4,
 262         MPI3MR_RESET_FROM_TM_TIMEOUT = 5,
 263         MPI3MR_RESET_FROM_APP_TIMEOUT = 6,
 264         MPI3MR_RESET_FROM_MUR_FAILURE = 7,
 265         MPI3MR_RESET_FROM_CTLR_CLEANUP = 8,
 266         MPI3MR_RESET_FROM_CIACTIV_FAULT = 9,
 267         MPI3MR_RESET_FROM_PE_TIMEOUT = 10,
 268         MPI3MR_RESET_FROM_TSU_TIMEOUT = 11,
 269         MPI3MR_RESET_FROM_DELREQQ_TIMEOUT = 12,
 270         MPI3MR_RESET_FROM_DELREPQ_TIMEOUT = 13,
 271         MPI3MR_RESET_FROM_CREATEREPQ_TIMEOUT = 14,
 272         MPI3MR_RESET_FROM_CREATEREQQ_TIMEOUT = 15,
 273         MPI3MR_RESET_FROM_IOCFACTS_TIMEOUT = 16,
 274         MPI3MR_RESET_FROM_IOCINIT_TIMEOUT = 17,
 275         MPI3MR_RESET_FROM_EVTNOTIFY_TIMEOUT = 18,
 276         MPI3MR_RESET_FROM_EVTACK_TIMEOUT = 19,
 277         MPI3MR_RESET_FROM_CIACTVRST_TIMER = 20,
 278         MPI3MR_RESET_FROM_GETPKGVER_TIMEOUT = 21,
 279         MPI3MR_RESET_FROM_PELABORT_TIMEOUT = 22,
 280         MPI3MR_RESET_FROM_SYSFS = 23,
 281         MPI3MR_RESET_FROM_SYSFS_TIMEOUT = 24,
 282         MPI3MR_RESET_FROM_FIRMWARE = 27,
 283         MPI3MR_RESET_FROM_CFG_REQ_TIMEOUT = 29,
 284         MPI3MR_RESET_FROM_SAS_TRANSPORT_TIMEOUT = 30,
 285 };
 286
 287 /* Queue type definitions */
 288 enum queue_type {
 289         MPI3MR_DEFAULT_QUEUE = 0,
 290         MPI3MR_POLL_QUEUE,
 291 };
 292
 293 /**
 294  * struct mpi3mr_compimg_ver - replica of component image
 295  * version defined in mpi30_image.h in host endianness
 296  *
 297  */
 298 struct mpi3mr_compimg_ver {
 299         u16 build_num;
 300         u16 cust_id;
 301         u8 ph_minor;
 302         u8 ph_major;
 303         u8 gen_minor;
 304         u8 gen_major;
 305 };
 306
 307 /**
 308  * struct mpi3mr_ioc_facs - replica of component image version
 309  * defined in mpi30_ioc.h in host endianness
 310  *
 311  */
 312 struct mpi3mr_ioc_facts {
 313         u32 ioc_capabilities;
 314         struct mpi3mr_compimg_ver fw_ver;
 315         u32 mpi_version;
 316         u16 max_reqs;
 317         u16 product_id;
 318         u16 op_req_sz;
 319         u16 reply_sz;
 320         u16 exceptions;
 321         u16 max_perids;
 322         u16 max_pds;
 323         u16 max_sasexpanders;
 324         u16 max_sasinitiators;
 325         u16 max_enclosures;
 326         u16 max_pcie_switches;
 327         u16 max_nvme;
 328         u16 max_vds;
 329         u16 max_hpds;
 330         u16 max_advhpds;
 331         u16 max_raid_pds;
 332         u16 min_devhandle;
 333         u16 max_devhandle;
 334         u16 max_op_req_q;
 335         u16 max_op_reply_q;
 336         u16 shutdown_timeout;
 337         u8 ioc_num;
 338         u8 who_init;
 339         u16 max_msix_vectors;
 340         u8 personality;
 341         u8 dma_mask;
 342         u8 protocol_flags;
 343         u8 sge_mod_mask;
 344         u8 sge_mod_value;
 345         u8 sge_mod_shift;
 346         u8 max_dev_per_tg;
 347         u16 max_io_throttle_group;
 348         u16 io_throttle_data_length;
 349         u16 io_throttle_low;
 350         u16 io_throttle_high;
 351
 352 };
 353
 354 /**
 355  * struct segments - memory descriptor structure to store
 356  * virtual and dma addresses for operational queue segments.
 357  *
 358  * @segment: virtual address
 359  * @segment_dma: dma address
 360  */
 361 struct segments {
 362         void *segment;
 363         dma_addr_t segment_dma;
 364 };
 365
 366 /**
 367  * struct op_req_qinfo -  Operational Request Queue Information
 368  *
 369  * @ci: consumer index
 370  * @pi: producer index
 371  * @num_request: Maximum number of entries in the queue
 372  * @qid: Queue Id starting from 1
 373  * @reply_qid: Associated reply queue Id
 374  * @num_segments: Number of discontiguous memory segments
 375  * @segment_qd: Depth of each segments
 376  * @q_lock: Concurrent queue access lock
 377  * @q_segments: Segment descriptor pointer
 378  * @q_segment_list: Segment list base virtual address
 379  * @q_segment_list_dma: Segment list base DMA address
 380  */
 381 struct op_req_qinfo {
 382         u16 ci;
 383         u16 pi;
 384         u16 num_requests;
 385         u16 qid;
 386         u16 reply_qid;
 387         u16 num_segments;
 388         u16 segment_qd;
 389         spinlock_t q_lock;
 390         struct segments *q_segments;
 391         void *q_segment_list;
 392         dma_addr_t q_segment_list_dma;
 393 };
 394
 395 /**
 396  * struct op_reply_qinfo -  Operational Reply Queue Information
 397  *
 398  * @ci: consumer index
 399  * @qid: Queue Id starting from 1
 400  * @num_replies: Maximum number of entries in the queue
 401  * @num_segments: Number of discontiguous memory segments
 402  * @segment_qd: Depth of each segments
 403  * @q_segments: Segment descriptor pointer
 404  * @q_segment_list: Segment list base virtual address
 405  * @q_segment_list_dma: Segment list base DMA address
 406  * @ephase: Expected phased identifier for the reply queue
 407  * @pend_ios: Number of IOs pending in HW for this queue
 408  * @enable_irq_poll: Flag to indicate polling is enabled
 409  * @in_use: Queue is handled by poll/ISR
 410  * @qtype: Type of queue (types defined in enum queue_type)
 411  */
 412 struct op_reply_qinfo {
 413         u16 ci;
 414         u16 qid;
 415         u16 num_replies;
 416         u16 num_segments;
 417         u16 segment_qd;
 418         struct segments *q_segments;
 419         void *q_segment_list;
 420         dma_addr_t q_segment_list_dma;
 421         u8 ephase;
 422         atomic_t pend_ios;
 423         bool enable_irq_poll;
 424         atomic_t in_use;
 425         enum queue_type qtype;
 426 };
 427
 428 /**
 429  * struct mpi3mr_intr_info -  Interrupt cookie information
 430  *
 431  * @mrioc: Adapter instance reference
 432  * @msix_index: MSIx index
 433  * @op_reply_q: Associated operational reply queue
 434  * @name: Dev name for the irq claiming device
 435  */
 436 struct mpi3mr_intr_info {
 437         struct mpi3mr_ioc *mrioc;
 438         u16 msix_index;
 439         struct op_reply_qinfo *op_reply_q;
 440         char name[MPI3MR_NAME_LENGTH];
 441 };
 442
 443 /**
 444  * struct mpi3mr_throttle_group_info - Throttle group info
 445  *
 446  * @io_divert: Flag indicates io divert is on or off for the TG
 447  * @need_qd_reduction: Flag to indicate QD reduction is needed
 448  * @qd_reduction: Queue Depth reduction in units of 10%
 449  * @fw_qd: QueueDepth value reported by the firmware
 450  * @modified_qd: Modified QueueDepth value due to throttling
 451  * @id: Throttle Group ID.
 452  * @high: High limit to turn on throttling in 512 byte blocks
 453  * @low: Low limit to turn off throttling in 512 byte blocks
 454  * @pend_large_data_sz: Counter to track pending large data
 455  */
 456 struct mpi3mr_throttle_group_info {
 457         u8 io_divert;
 458         u8 need_qd_reduction;
 459         u8 qd_reduction;
 460         u16 fw_qd;
 461         u16 modified_qd;
 462         u16 id;
 463         u32 high;
 464         u32 low;
 465         atomic_t pend_large_data_sz;
 466 };
 467
 468 /* HBA port flags */
 469 #define MPI3MR_HBA_PORT_FLAG_DIRTY      0x01
 470
 471 /**
 472  * struct mpi3mr_hba_port - HBA's port information
 473  * @port_id: Port number
 474  * @flags: HBA port flags
 475  */
 476 struct mpi3mr_hba_port {
 477         struct list_head list;
 478         u8 port_id;
 479         u8 flags;
 480 };
 481
 482 /**
 483  * struct mpi3mr_sas_port - Internal SAS port information
 484  * @port_list: List of ports belonging to a SAS node
 485  * @num_phys: Number of phys associated with port
 486  * @marked_responding: used while refresing the sas ports
 487  * @lowest_phy: lowest phy ID of current sas port
 488  * @phy_mask: phy_mask of current sas port
 489  * @hba_port: HBA port entry
 490  * @remote_identify: Attached device identification
 491  * @rphy: SAS transport layer rphy object
 492  * @port: SAS transport layer port object
 493  * @phy_list: mpi3mr_sas_phy objects belonging to this port
 494  */
 495 struct mpi3mr_sas_port {
 496         struct list_head port_list;
 497         u8 num_phys;
 498         u8 marked_responding;
 499         int lowest_phy;
 500         u32 phy_mask;
 501         struct mpi3mr_hba_port *hba_port;
 502         struct sas_identify remote_identify;
 503         struct sas_rphy *rphy;
 504         struct sas_port *port;
 505         struct list_head phy_list;
 506 };
 507
 508 /**
 509  * struct mpi3mr_sas_phy - Internal SAS Phy information
 510  * @port_siblings: List of phys belonging to a port
 511  * @identify: Phy identification
 512  * @remote_identify: Attached device identification
 513  * @phy: SAS transport layer Phy object
 514  * @phy_id: Unique phy id within a port
 515  * @handle: Firmware device handle for this phy
 516  * @attached_handle: Firmware device handle for attached device
 517  * @phy_belongs_to_port: Flag to indicate phy belongs to port
 518    @hba_port: HBA port entry
 519  */
 520 struct mpi3mr_sas_phy {
 521         struct list_head port_siblings;
 522         struct sas_identify identify;
 523         struct sas_identify remote_identify;
 524         struct sas_phy *phy;
 525         u8 phy_id;
 526         u16 handle;
 527         u16 attached_handle;
 528         u8 phy_belongs_to_port;
 529         struct mpi3mr_hba_port *hba_port;
 530 };
 531
 532 /**
 533  * struct mpi3mr_sas_node - SAS host/expander information
 534  * @list: List of sas nodes in a controller
 535  * @parent_dev: Parent device class
 536  * @num_phys: Number phys belonging to sas_node
 537  * @sas_address: SAS address of sas_node
 538  * @handle: Firmware device handle for this sas_host/expander
 539  * @sas_address_parent: SAS address of parent expander or host
 540  * @enclosure_handle: Firmware handle of enclosure of this node
 541  * @device_info: Capabilities of this sas_host/expander
 542  * @non_responding: used to refresh the expander devices during reset
 543  * @host_node: Flag to indicate this is a host_node
 544  * @hba_port: HBA port entry
 545  * @phy: A list of phys that make up this sas_host/expander
 546  * @sas_port_list: List of internal ports of this node
 547  * @rphy: sas_rphy object of this expander node
 548  */
 549 struct mpi3mr_sas_node {
 550         struct list_head list;
 551         struct device *parent_dev;
 552         u8 num_phys;
 553         u64 sas_address;
 554         u16 handle;
 555         u64 sas_address_parent;
 556         u16 enclosure_handle;
 557         u64 enclosure_logical_id;
 558         u8 non_responding;
 559         u8 host_node;
 560         struct mpi3mr_hba_port *hba_port;
 561         struct mpi3mr_sas_phy *phy;
 562         struct list_head sas_port_list;
 563         struct sas_rphy *rphy;
 564 };
 565
 566 /**
 567  * struct mpi3mr_enclosure_node - enclosure information
 568  * @list: List of enclosures
 569  * @pg0: Enclosure page 0;
 570  */
 571 struct mpi3mr_enclosure_node {
 572         struct list_head list;
 573         struct mpi3_enclosure_page0 pg0;
 574 };
 575
 576 /**
 577  * struct tgt_dev_sas_sata - SAS/SATA device specific
 578  * information cached from firmware given data
 579  *
 580  * @sas_address: World wide unique SAS address
 581  * @sas_address_parent: Sas address of parent expander or host
 582  * @dev_info: Device information bits
 583  * @phy_id: Phy identifier provided in device page 0
 584  * @attached_phy_id: Attached phy identifier provided in device page 0
 585  * @sas_transport_attached: Is this device exposed to transport
 586  * @pend_sas_rphy_add: Flag to check device is in process of add
 587  * @hba_port: HBA port entry
 588  * @rphy: SAS transport layer rphy object
 589  */
 590 struct tgt_dev_sas_sata {
 591         u64 sas_address;
 592         u64 sas_address_parent;
 593         u16 dev_info;
 594         u8 phy_id;
 595         u8 attached_phy_id;
 596         u8 sas_transport_attached;
 597         u8 pend_sas_rphy_add;
 598         struct mpi3mr_hba_port *hba_port;
 599         struct sas_rphy *rphy;
 600 };
 601
 602 /**
 603  * struct tgt_dev_pcie - PCIe device specific information cached
 604  * from firmware given data
 605  *
 606  * @mdts: Maximum data transfer size
 607  * @capb: Device capabilities
 608  * @pgsz: Device page size
 609  * @abort_to: Timeout for abort TM
 610  * @reset_to: Timeout for Target/LUN reset TM
 611  * @dev_info: Device information bits
 612  */
 613 struct tgt_dev_pcie {
 614         u32 mdts;
 615         u16 capb;
 616         u8 pgsz;
 617         u8 abort_to;
 618         u8 reset_to;
 619         u16 dev_info;
 620 };
 621
 622 /**
 623  * struct tgt_dev_vd - virtual device specific information
 624  * cached from firmware given data
 625  *
 626  * @state: State of the VD
 627  * @tg_qd_reduction: Queue Depth reduction in units of 10%
 628  * @tg_id: VDs throttle group ID
 629  * @high: High limit to turn on throttling in 512 byte blocks
 630  * @low: Low limit to turn off throttling in 512 byte blocks
 631  * @tg: Pointer to throttle group info
 632  */
 633 struct tgt_dev_vd {
 634         u8 state;
 635         u8 tg_qd_reduction;
 636         u16 tg_id;
 637         u32 tg_high;
 638         u32 tg_low;
 639         struct mpi3mr_throttle_group_info *tg;
 640 };
 641
 642
 643 /**
 644  * union _form_spec_inf - union of device specific information
 645  */
 646 union _form_spec_inf {
 647         struct tgt_dev_sas_sata sas_sata_inf;
 648         struct tgt_dev_pcie pcie_inf;
 649         struct tgt_dev_vd vd_inf;
 650 };
 651
 652
 653
 654 /**
 655  * struct mpi3mr_tgt_dev - target device data structure
 656  *
 657  * @list: List pointer
 658  * @starget: Scsi_target pointer
 659  * @dev_handle: FW device handle
 660  * @parent_handle: FW parent device handle
 661  * @slot: Slot number
 662  * @encl_handle: FW enclosure handle
 663  * @perst_id: FW assigned Persistent ID
 664  * @devpg0_flag: Device Page0 flag
 665  * @dev_type: SAS/SATA/PCIE device type
 666  * @is_hidden: Should be exposed to upper layers or not
 667  * @host_exposed: Already exposed to host or not
 668  * @io_unit_port: IO Unit port ID
 669  * @non_stl: Is this device not to be attached with SAS TL
 670  * @io_throttle_enabled: I/O throttling needed or not
 671  * @q_depth: Device specific Queue Depth
 672  * @wwid: World wide ID
 673  * @enclosure_logical_id: Enclosure logical identifier
 674  * @dev_spec: Device type specific information
 675  * @ref_count: Reference count
 676  */
 677 struct mpi3mr_tgt_dev {
 678         struct list_head list;
 679         struct scsi_target *starget;
 680         u16 dev_handle;
 681         u16 parent_handle;
 682         u16 slot;
 683         u16 encl_handle;
 684         u16 perst_id;
 685         u16 devpg0_flag;
 686         u8 dev_type;
 687         u8 is_hidden;
 688         u8 host_exposed;
 689         u8 io_unit_port;
 690         u8 non_stl;
 691         u8 io_throttle_enabled;
 692         u16 q_depth;
 693         u64 wwid;
 694         u64 enclosure_logical_id;
 695         union _form_spec_inf dev_spec;
 696         struct kref ref_count;
 697 };
 698
 699 /**
 700  * mpi3mr_tgtdev_get - k reference incrementor
 701  * @s: Target device reference
 702  *
 703  * Increment target device reference count.
 704  */
 705 static inline void mpi3mr_tgtdev_get(struct mpi3mr_tgt_dev *s)
 706 {
 707         kref_get(&s->ref_count);
 708 }
 709
 710 /**
 711  * mpi3mr_free_tgtdev - target device memory dealloctor
 712  * @r: k reference pointer of the target device
 713  *
 714  * Free target device memory when no reference.
 715  */
 716 static inline void mpi3mr_free_tgtdev(struct kref *r)
 717 {
 718         kfree(container_of(r, struct mpi3mr_tgt_dev, ref_count));
 719 }
 720
 721 /**
 722  * mpi3mr_tgtdev_put - k reference decrementor
 723  * @s: Target device reference
 724  *
 725  * Decrement target device reference count.
 726  */
 727 static inline void mpi3mr_tgtdev_put(struct mpi3mr_tgt_dev *s)
 728 {
 729         kref_put(&s->ref_count, mpi3mr_free_tgtdev);
 730 }
 731
 732
 733 /**
 734  * struct mpi3mr_stgt_priv_data - SCSI target private structure
 735  *
 736  * @starget: Scsi_target pointer
 737  * @dev_handle: FW device handle
 738  * @perst_id: FW assigned Persistent ID
 739  * @num_luns: Number of Logical Units
 740  * @block_io: I/O blocked to the device or not
 741  * @dev_removed: Device removed in the Firmware
 742  * @dev_removedelay: Device is waiting to be removed in FW
 743  * @dev_type: Device type
 744  * @io_throttle_enabled: I/O throttling needed or not
 745  * @io_divert: Flag indicates io divert is on or off for the dev
 746  * @throttle_group: Pointer to throttle group info
 747  * @tgt_dev: Internal target device pointer
 748  * @pend_count: Counter to track pending I/Os during error
 749  *              handling
 750  */
 751 struct mpi3mr_stgt_priv_data {
 752         struct scsi_target *starget;
 753         u16 dev_handle;
 754         u16 perst_id;
 755         u32 num_luns;
 756         atomic_t block_io;
 757         u8 dev_removed;
 758         u8 dev_removedelay;
 759         u8 dev_type;
 760         u8 io_throttle_enabled;
 761         u8 io_divert;
 762         struct mpi3mr_throttle_group_info *throttle_group;
 763         struct mpi3mr_tgt_dev *tgt_dev;
 764         u32 pend_count;
 765 };
 766
 767 /**
 768  * struct mpi3mr_stgt_priv_data - SCSI device private structure
 769  *
 770  * @tgt_priv_data: Scsi_target private data pointer
 771  * @lun_id: LUN ID of the device
 772  * @ncq_prio_enable: NCQ priority enable for SATA device
 773  * @pend_count: Counter to track pending I/Os during error
 774  *              handling
 775  */
 776 struct mpi3mr_sdev_priv_data {
 777         struct mpi3mr_stgt_priv_data *tgt_priv_data;
 778         u32 lun_id;
 779         u8 ncq_prio_enable;
 780         u32 pend_count;
 781 };
 782
 783 /**
 784  * struct mpi3mr_drv_cmd - Internal command tracker
 785  *
 786  * @mutex: Command mutex
 787  * @done: Completeor for wakeup
 788  * @reply: Firmware reply for internal commands
 789  * @sensebuf: Sensebuf for SCSI IO commands
 790  * @iou_rc: IO Unit control reason code
 791  * @state: Command State
 792  * @dev_handle: Firmware handle for device specific commands
 793  * @ioc_status: IOC status from the firmware
 794  * @ioc_loginfo:IOC log info from the firmware
 795  * @is_waiting: Is the command issued in block mode
 796  * @is_sense: Is Sense data present
 797  * @retry_count: Retry count for retriable commands
 798  * @host_tag: Host tag used by the command
 799  * @callback: Callback for non blocking commands
 800  */
 801 struct mpi3mr_drv_cmd {
 802         struct mutex mutex;
 803         struct completion done;
 804         void *reply;
 805         u8 *sensebuf;
 806         u8 iou_rc;
 807         u16 state;
 808         u16 dev_handle;
 809         u16 ioc_status;
 810         u32 ioc_loginfo;
 811         u8 is_waiting;
 812         u8 is_sense;
 813         u8 retry_count;
 814         u16 host_tag;
 815
 816         void (*callback)(struct mpi3mr_ioc *mrioc,
 817             struct mpi3mr_drv_cmd *drv_cmd);
 818 };
 819
 820 /**
 821  * struct dma_memory_desc - memory descriptor structure to store
 822  * virtual address, dma address and size for any generic dma
 823  * memory allocations in the driver.
 824  *
 825  * @size: buffer size
 826  * @addr: virtual address
 827  * @dma_addr: dma address
 828  */
 829 struct dma_memory_desc {
 830         u32 size;
 831         void *addr;
 832         dma_addr_t dma_addr;
 833 };
 834
 835
 836 /**
 837  * struct chain_element - memory descriptor structure to store
 838  * virtual and dma addresses for chain elements.
 839  *
 840  * @addr: virtual address
 841  * @dma_addr: dma address
 842  */
 843 struct chain_element {
 844         void *addr;
 845         dma_addr_t dma_addr;
 846 };
 847
 848 /**
 849  * struct scmd_priv - SCSI command private data
 850  *
 851  * @host_tag: Host tag specific to operational queue
 852  * @in_lld_scope: Command in LLD scope or not
 853  * @meta_sg_valid: DIX command with meta data SGL or not
 854  * @scmd: SCSI Command pointer
 855  * @req_q_idx: Operational request queue index
 856  * @chain_idx: Chain frame index
 857  * @meta_chain_idx: Chain frame index of meta data SGL
 858  * @mpi3mr_scsiio_req: MPI SCSI IO request
 859  */
 860 struct scmd_priv {
 861         u16 host_tag;
 862         u8 in_lld_scope;
 863         u8 meta_sg_valid;
 864         struct scsi_cmnd *scmd;
 865         u16 req_q_idx;
 866         int chain_idx;
 867         int meta_chain_idx;
 868         u8 mpi3mr_scsiio_req[MPI3MR_ADMIN_REQ_FRAME_SZ];
 869 };
 870
 871 /**
 872  * struct mpi3mr_ioc - Adapter anchor structure stored in shost
 873  * private data
 874  *
 875  * @list: List pointer
 876  * @pdev: PCI device pointer
 877  * @shost: Scsi_Host pointer
 878  * @id: Controller ID
 879  * @cpu_count: Number of online CPUs
 880  * @irqpoll_sleep: usleep unit used in threaded isr irqpoll
 881  * @name: Controller ASCII name
 882  * @driver_name: Driver ASCII name
 883  * @sysif_regs: System interface registers virtual address
 884  * @sysif_regs_phys: System interface registers physical address
 885  * @bars: PCI BARS
 886  * @dma_mask: DMA mask
 887  * @msix_count: Number of MSIX vectors used
 888  * @intr_enabled: Is interrupts enabled
 889  * @num_admin_req: Number of admin requests
 890  * @admin_req_q_sz: Admin request queue size
 891  * @admin_req_pi: Admin request queue producer index
 892  * @admin_req_ci: Admin request queue consumer index
 893  * @admin_req_base: Admin request queue base virtual address
 894  * @admin_req_dma: Admin request queue base dma address
 895  * @admin_req_lock: Admin queue access lock
 896  * @num_admin_replies: Number of admin replies
 897  * @admin_reply_q_sz: Admin reply queue size
 898  * @admin_reply_ci: Admin reply queue consumer index
 899  * @admin_reply_ephase:Admin reply queue expected phase
 900  * @admin_reply_base: Admin reply queue base virtual address
 901  * @admin_reply_dma: Admin reply queue base dma address
 902  * @ready_timeout: Controller ready timeout
 903  * @intr_info: Interrupt cookie pointer
 904  * @intr_info_count: Number of interrupt cookies
 905  * @is_intr_info_set: Flag to indicate intr info is setup
 906  * @num_queues: Number of operational queues
 907  * @num_op_req_q: Number of operational request queues
 908  * @req_qinfo: Operational request queue info pointer
 909  * @num_op_reply_q: Number of operational reply queues
 910  * @op_reply_qinfo: Operational reply queue info pointer
 911  * @init_cmds: Command tracker for initialization commands
 912  * @cfg_cmds: Command tracker for configuration requests
 913  * @facts: Cached IOC facts data
 914  * @op_reply_desc_sz: Operational reply descriptor size
 915  * @num_reply_bufs: Number of reply buffers allocated
 916  * @reply_buf_pool: Reply buffer pool
 917  * @reply_buf: Reply buffer base virtual address
 918  * @reply_buf_dma: Reply buffer DMA address
 919  * @reply_buf_dma_max_address: Reply DMA address max limit
 920  * @reply_free_qsz: Reply free queue size
 921  * @reply_free_q_pool: Reply free queue pool
 922  * @reply_free_q: Reply free queue base virtual address
 923  * @reply_free_q_dma: Reply free queue base DMA address
 924  * @reply_free_queue_lock: Reply free queue lock
 925  * @reply_free_queue_host_index: Reply free queue host index
 926  * @num_sense_bufs: Number of sense buffers
 927  * @sense_buf_pool: Sense buffer pool
 928  * @sense_buf: Sense buffer base virtual address
 929  * @sense_buf_dma: Sense buffer base DMA address
 930  * @sense_buf_q_sz: Sense buffer queue size
 931  * @sense_buf_q_pool: Sense buffer queue pool
 932  * @sense_buf_q: Sense buffer queue virtual address
 933  * @sense_buf_q_dma: Sense buffer queue DMA address
 934  * @sbq_lock: Sense buffer queue lock
 935  * @sbq_host_index: Sense buffer queuehost index
 936  * @event_masks: Event mask bitmap
 937  * @fwevt_worker_name: Firmware event worker thread name
 938  * @fwevt_worker_thread: Firmware event worker thread
 939  * @fwevt_lock: Firmware event lock
 940  * @fwevt_list: Firmware event list
 941  * @watchdog_work_q_name: Fault watchdog worker thread name
 942  * @watchdog_work_q: Fault watchdog worker thread
 943  * @watchdog_work: Fault watchdog work
 944  * @watchdog_lock: Fault watchdog lock
 945  * @is_driver_loading: Is driver still loading
 946  * @scan_started: Async scan started
 947  * @scan_failed: Asycn scan failed
 948  * @stop_drv_processing: Stop all command processing
 949  * @device_refresh_on: Don't process the events until devices are refreshed
 950  * @max_host_ios: Maximum host I/O count
 951  * @chain_buf_count: Chain buffer count
 952  * @chain_buf_pool: Chain buffer pool
 953  * @chain_sgl_list: Chain SGL list
 954  * @chain_bitmap_sz: Chain buffer allocator bitmap size
 955  * @chain_bitmap: Chain buffer allocator bitmap
 956  * @chain_buf_lock: Chain buffer list lock
 957  * @bsg_cmds: Command tracker for BSG command
 958  * @host_tm_cmds: Command tracker for task management commands
 959  * @dev_rmhs_cmds: Command tracker for device removal commands
 960  * @evtack_cmds: Command tracker for event ack commands
 961  * @devrem_bitmap_sz: Device removal bitmap size
 962  * @devrem_bitmap: Device removal bitmap
 963  * @dev_handle_bitmap_sz: Device handle bitmap size
 964  * @removepend_bitmap: Remove pending bitmap
 965  * @delayed_rmhs_list: Delayed device removal list
 966  * @evtack_cmds_bitmap_sz: Event Ack bitmap size
 967  * @evtack_cmds_bitmap: Event Ack bitmap
 968  * @delayed_evtack_cmds_list: Delayed event acknowledgment list
 969  * @ts_update_counter: Timestamp update counter
 970  * @reset_in_progress: Reset in progress flag
 971  * @unrecoverable: Controller unrecoverable flag
 972  * @prev_reset_result: Result of previous reset
 973  * @reset_mutex: Controller reset mutex
 974  * @reset_waitq: Controller reset  wait queue
 975  * @prepare_for_reset: Prepare for reset event received
 976  * @prepare_for_reset_timeout_counter: Prepare for reset timeout
 977  * @prp_list_virt: NVMe encapsulated PRP list virtual base
 978  * @prp_list_dma: NVMe encapsulated PRP list DMA
 979  * @prp_sz: NVME encapsulated PRP list size
 980  * @diagsave_timeout: Diagnostic information save timeout
 981  * @logging_level: Controller debug logging level
 982  * @flush_io_count: I/O count to flush after reset
 983  * @current_event: Firmware event currently in process
 984  * @driver_info: Driver, Kernel, OS information to firmware
 985  * @change_count: Topology change count
 986  * @pel_enabled: Persistent Event Log(PEL) enabled or not
 987  * @pel_abort_requested: PEL abort is requested or not
 988  * @pel_class: PEL Class identifier
 989  * @pel_locale: PEL Locale identifier
 990  * @pel_cmds: Command tracker for PEL wait command
 991  * @pel_abort_cmd: Command tracker for PEL abort command
 992  * @pel_newest_seqnum: Newest PEL sequenece number
 993  * @pel_seqnum_virt: PEL sequence number virtual address
 994  * @pel_seqnum_dma: PEL sequence number DMA address
 995  * @pel_seqnum_sz: PEL sequenece number size
 996  * @op_reply_q_offset: Operational reply queue offset with MSIx
 997  * @default_qcount: Total Default queues
 998  * @active_poll_qcount: Currently active poll queue count
 999  * @requested_poll_qcount: User requested poll queue count
1000  * @bsg_dev: BSG device structure
1001  * @bsg_queue: Request queue for BSG device
1002  * @stop_bsgs: Stop BSG request flag
1003  * @logdata_buf: Circular buffer to store log data entries
1004  * @logdata_buf_idx: Index of entry in buffer to store
1005  * @logdata_entry_sz: log data entry size
1006  * @pend_large_data_sz: Counter to track pending large data
1007  * @io_throttle_data_length: I/O size to track in 512b blocks
1008  * @io_throttle_high: I/O size to start throttle in 512b blocks
1009  * @io_throttle_low: I/O size to stop throttle in 512b blocks
1010  * @num_io_throttle_group: Maximum number of throttle groups
1011  * @throttle_groups: Pointer to throttle group info structures
1012  * @cfg_page: Default memory for configuration pages
1013  * @cfg_page_dma: Configuration page DMA address
1014  * @cfg_page_sz: Default configuration page memory size
1015  * @sas_transport_enabled: SAS transport enabled or not
1016  * @scsi_device_channel: Channel ID for SCSI devices
1017  * @transport_cmds: Command tracker for SAS transport commands
1018  * @sas_hba: SAS node for the controller
1019  * @sas_expander_list: SAS node list of expanders
1020  * @sas_node_lock: Lock to protect SAS node list
1021  * @hba_port_table_list: List of HBA Ports
1022  * @enclosure_list: List of Enclosure objects
1023  */
1024 struct mpi3mr_ioc {
1025         struct list_head list;
1026         struct pci_dev *pdev;
1027         struct Scsi_Host *shost;
1028         u8 id;
1029         int cpu_count;
1030         bool enable_segqueue;
1031         u32 irqpoll_sleep;
1032
1033         char name[MPI3MR_NAME_LENGTH];
1034         char driver_name[MPI3MR_NAME_LENGTH];
1035
1036         volatile struct mpi3_sysif_registers __iomem *sysif_regs;
1037         resource_size_t sysif_regs_phys;
1038         int bars;
1039         u64 dma_mask;
1040
1041         u16 msix_count;
1042         u8 intr_enabled;
1043
1044         u16 num_admin_req;
1045         u32 admin_req_q_sz;
1046         u16 admin_req_pi;
1047         u16 admin_req_ci;
1048         void *admin_req_base;
1049         dma_addr_t admin_req_dma;
1050         spinlock_t admin_req_lock;
1051
1052         u16 num_admin_replies;
1053         u32 admin_reply_q_sz;
1054         u16 admin_reply_ci;
1055         u8 admin_reply_ephase;
1056         void *admin_reply_base;
1057         dma_addr_t admin_reply_dma;
1058
1059         u32 ready_timeout;
1060
1061         struct mpi3mr_intr_info *intr_info;
1062         u16 intr_info_count;
1063         bool is_intr_info_set;
1064
1065         u16 num_queues;
1066         u16 num_op_req_q;
1067         struct op_req_qinfo *req_qinfo;
1068
1069         u16 num_op_reply_q;
1070         struct op_reply_qinfo *op_reply_qinfo;
1071
1072         struct mpi3mr_drv_cmd init_cmds;
1073         struct mpi3mr_drv_cmd cfg_cmds;
1074         struct mpi3mr_ioc_facts facts;
1075         u16 op_reply_desc_sz;
1076
1077         u32 num_reply_bufs;
1078         struct dma_pool *reply_buf_pool;
1079         u8 *reply_buf;
1080         dma_addr_t reply_buf_dma;
1081         dma_addr_t reply_buf_dma_max_address;
1082
1083         u16 reply_free_qsz;
1084         u16 reply_sz;
1085         struct dma_pool *reply_free_q_pool;
1086         __le64 *reply_free_q;
1087         dma_addr_t reply_free_q_dma;
1088         spinlock_t reply_free_queue_lock;
1089         u32 reply_free_queue_host_index;
1090
1091         u32 num_sense_bufs;
1092         struct dma_pool *sense_buf_pool;
1093         u8 *sense_buf;
1094         dma_addr_t sense_buf_dma;
1095
1096         u16 sense_buf_q_sz;
1097         struct dma_pool *sense_buf_q_pool;
1098         __le64 *sense_buf_q;
1099         dma_addr_t sense_buf_q_dma;
1100         spinlock_t sbq_lock;
1101         u32 sbq_host_index;
1102         u32 event_masks[MPI3_EVENT_NOTIFY_EVENTMASK_WORDS];
1103
1104         char fwevt_worker_name[MPI3MR_NAME_LENGTH];
1105         struct workqueue_struct *fwevt_worker_thread;
1106         spinlock_t fwevt_lock;
1107         struct list_head fwevt_list;
1108
1109         char watchdog_work_q_name[20];
1110         struct workqueue_struct *watchdog_work_q;
1111         struct delayed_work watchdog_work;
1112         spinlock_t watchdog_lock;
1113
1114         u8 is_driver_loading;
1115         u8 scan_started;
1116         u16 scan_failed;
1117         u8 stop_drv_processing;
1118         u8 device_refresh_on;
1119
1120         u16 max_host_ios;
1121         spinlock_t tgtdev_lock;
1122         struct list_head tgtdev_list;
1123
1124         u32 chain_buf_count;
1125         struct dma_pool *chain_buf_pool;
1126         struct chain_element *chain_sgl_list;
1127         u16  chain_bitmap_sz;
1128         void *chain_bitmap;
1129         spinlock_t chain_buf_lock;
1130
1131         struct mpi3mr_drv_cmd bsg_cmds;
1132         struct mpi3mr_drv_cmd host_tm_cmds;
1133         struct mpi3mr_drv_cmd dev_rmhs_cmds[MPI3MR_NUM_DEVRMCMD];
1134         struct mpi3mr_drv_cmd evtack_cmds[MPI3MR_NUM_EVTACKCMD];
1135         u16 devrem_bitmap_sz;
1136         void *devrem_bitmap;
1137         u16 dev_handle_bitmap_sz;
1138         void *removepend_bitmap;
1139         struct list_head delayed_rmhs_list;
1140         u16 evtack_cmds_bitmap_sz;
1141         void *evtack_cmds_bitmap;
1142         struct list_head delayed_evtack_cmds_list;
1143
1144         u32 ts_update_counter;
1145         u8 reset_in_progress;
1146         u8 unrecoverable;
1147         int prev_reset_result;
1148         struct mutex reset_mutex;
1149         wait_queue_head_t reset_waitq;
1150
1151         u8 prepare_for_reset;
1152         u16 prepare_for_reset_timeout_counter;
1153
1154         void *prp_list_virt;
1155         dma_addr_t prp_list_dma;
1156         u32 prp_sz;
1157
1158         u16 diagsave_timeout;
1159         int logging_level;
1160         u16 flush_io_count;
1161
1162         struct mpi3mr_fwevt *current_event;
1163         struct mpi3_driver_info_layout driver_info;
1164         u16 change_count;
1165
1166         u8 pel_enabled;
1167         u8 pel_abort_requested;
1168         u8 pel_class;
1169         u16 pel_locale;
1170         struct mpi3mr_drv_cmd pel_cmds;
1171         struct mpi3mr_drv_cmd pel_abort_cmd;
1172
1173         u32 pel_newest_seqnum;
1174         void *pel_seqnum_virt;
1175         dma_addr_t pel_seqnum_dma;
1176         u32 pel_seqnum_sz;
1177
1178         u16 op_reply_q_offset;
1179         u16 default_qcount;
1180         u16 active_poll_qcount;
1181         u16 requested_poll_qcount;
1182
1183         struct device bsg_dev;
1184         struct request_queue *bsg_queue;
1185         u8 stop_bsgs;
1186         u8 *logdata_buf;
1187         u16 logdata_buf_idx;
1188         u16 logdata_entry_sz;
1189
1190         atomic_t pend_large_data_sz;
1191         u32 io_throttle_data_length;
1192         u32 io_throttle_high;
1193         u32 io_throttle_low;
1194         u16 num_io_throttle_group;
1195         struct mpi3mr_throttle_group_info *throttle_groups;
1196
1197         void *cfg_page;
1198         dma_addr_t cfg_page_dma;
1199         u16 cfg_page_sz;
1200
1201         u8 sas_transport_enabled;
1202         u8 scsi_device_channel;
1203         struct mpi3mr_drv_cmd transport_cmds;
1204         struct mpi3mr_sas_node sas_hba;
1205         struct list_head sas_expander_list;
1206         spinlock_t sas_node_lock;
1207         struct list_head hba_port_table_list;
1208         struct list_head enclosure_list;
1209 };
1210
1211 /**
1212  * struct mpi3mr_fwevt - Firmware event structure.
1213  *
1214  * @list: list head
1215  * @work: Work structure
1216  * @mrioc: Adapter instance reference
1217  * @event_id: MPI3 firmware event ID
1218  * @send_ack: Event acknowledgment required or not
1219  * @process_evt: Bottomhalf processing required or not
1220  * @evt_ctx: Event context to send in Ack
1221  * @event_data_size: size of the event data in bytes
1222  * @pending_at_sml: waiting for device add/remove API to complete
1223  * @discard: discard this event
1224  * @ref_count: kref count
1225  * @event_data: Actual MPI3 event data
1226  */
1227 struct mpi3mr_fwevt {
1228         struct list_head list;
1229         struct work_struct work;
1230         struct mpi3mr_ioc *mrioc;
1231         u16 event_id;
1232         bool send_ack;
1233         bool process_evt;
1234         u32 evt_ctx;
1235         u16 event_data_size;
1236         bool pending_at_sml;
1237         bool discard;
1238         struct kref ref_count;
1239         char event_data[] __aligned(4);
1240 };
1241
1242
1243 /**
1244  * struct delayed_dev_rmhs_node - Delayed device removal node
1245  *
1246  * @list: list head
1247  * @handle: Device handle
1248  * @iou_rc: IO Unit Control Reason Code
1249  */
1250 struct delayed_dev_rmhs_node {
1251         struct list_head list;
1252         u16 handle;
1253         u8 iou_rc;
1254 };
1255
1256 /**
1257  * struct delayed_evt_ack_node - Delayed event ack node
1258  * @list: list head
1259  * @event: MPI3 event ID
1260  * @event_ctx: event context
1261  */
1262 struct delayed_evt_ack_node {
1263         struct list_head list;
1264         u8 event;
1265         u32 event_ctx;
1266 };
1267
1268 int mpi3mr_setup_resources(struct mpi3mr_ioc *mrioc);
1269 void mpi3mr_cleanup_resources(struct mpi3mr_ioc *mrioc);
1270 int mpi3mr_init_ioc(struct mpi3mr_ioc *mrioc);
1271 int mpi3mr_reinit_ioc(struct mpi3mr_ioc *mrioc, u8 is_resume);
1272 void mpi3mr_cleanup_ioc(struct mpi3mr_ioc *mrioc);
1273 int mpi3mr_issue_port_enable(struct mpi3mr_ioc *mrioc, u8 async);
1274 int mpi3mr_admin_request_post(struct mpi3mr_ioc *mrioc, void *admin_req,
1275 u16 admin_req_sz, u8 ignore_reset);
1276 int mpi3mr_op_request_post(struct mpi3mr_ioc *mrioc,
1277                            struct op_req_qinfo *opreqq, u8 *req);
1278 void mpi3mr_add_sg_single(void *paddr, u8 flags, u32 length,
1279                           dma_addr_t dma_addr);
1280 void mpi3mr_build_zero_len_sge(void *paddr);
1281 void *mpi3mr_get_sensebuf_virt_addr(struct mpi3mr_ioc *mrioc,
1282                                      dma_addr_t phys_addr);
1283 void *mpi3mr_get_reply_virt_addr(struct mpi3mr_ioc *mrioc,
1284                                      dma_addr_t phys_addr);
1285 void mpi3mr_repost_sense_buf(struct mpi3mr_ioc *mrioc,
1286                                      u64 sense_buf_dma);
1287
1288 void mpi3mr_memset_buffers(struct mpi3mr_ioc *mrioc);
1289 void mpi3mr_free_mem(struct mpi3mr_ioc *mrioc);
1290 void mpi3mr_os_handle_events(struct mpi3mr_ioc *mrioc,
1291                              struct mpi3_event_notification_reply *event_reply);
1292 void mpi3mr_process_op_reply_desc(struct mpi3mr_ioc *mrioc,
1293                                   struct mpi3_default_reply_descriptor *reply_desc,
1294                                   u64 *reply_dma, u16 qidx);
1295 void mpi3mr_start_watchdog(struct mpi3mr_ioc *mrioc);
1296 void mpi3mr_stop_watchdog(struct mpi3mr_ioc *mrioc);
1297
1298 int mpi3mr_soft_reset_handler(struct mpi3mr_ioc *mrioc,
1299                               u32 reset_reason, u8 snapdump);
1300 void mpi3mr_ioc_disable_intr(struct mpi3mr_ioc *mrioc);
1301 void mpi3mr_ioc_enable_intr(struct mpi3mr_ioc *mrioc);
1302
1303 enum mpi3mr_iocstate mpi3mr_get_iocstate(struct mpi3mr_ioc *mrioc);
1304 int mpi3mr_process_event_ack(struct mpi3mr_ioc *mrioc, u8 event,
1305                           u32 event_ctx);
1306
1307 void mpi3mr_wait_for_host_io(struct mpi3mr_ioc *mrioc, u32 timeout);
1308 void mpi3mr_cleanup_fwevt_list(struct mpi3mr_ioc *mrioc);
1309 void mpi3mr_flush_host_io(struct mpi3mr_ioc *mrioc);
1310 void mpi3mr_invalidate_devhandles(struct mpi3mr_ioc *mrioc);
1311 void mpi3mr_rfresh_tgtdevs(struct mpi3mr_ioc *mrioc);
1312 void mpi3mr_flush_delayed_cmd_lists(struct mpi3mr_ioc *mrioc);
1313 void mpi3mr_check_rh_fault_ioc(struct mpi3mr_ioc *mrioc, u32 reason_code);
1314 void mpi3mr_print_fault_info(struct mpi3mr_ioc *mrioc);
1315 void mpi3mr_check_rh_fault_ioc(struct mpi3mr_ioc *mrioc, u32 reason_code);
1316 int mpi3mr_process_op_reply_q(struct mpi3mr_ioc *mrioc,
1317         struct op_reply_qinfo *op_reply_q);
1318 int mpi3mr_blk_mq_poll(struct Scsi_Host *shost, unsigned int queue_num);
1319 void mpi3mr_bsg_init(struct mpi3mr_ioc *mrioc);
1320 void mpi3mr_bsg_exit(struct mpi3mr_ioc *mrioc);
1321 int mpi3mr_issue_tm(struct mpi3mr_ioc *mrioc, u8 tm_type,
1322         u16 handle, uint lun, u16 htag, ulong timeout,
1323         struct mpi3mr_drv_cmd *drv_cmd,
1324         u8 *resp_code, struct scsi_cmnd *scmd);
1325 struct mpi3mr_tgt_dev *mpi3mr_get_tgtdev_by_handle(
1326         struct mpi3mr_ioc *mrioc, u16 handle);
1327 void mpi3mr_pel_get_seqnum_complete(struct mpi3mr_ioc *mrioc,
1328         struct mpi3mr_drv_cmd *drv_cmd);
1329 int mpi3mr_pel_get_seqnum_post(struct mpi3mr_ioc *mrioc,
1330         struct mpi3mr_drv_cmd *drv_cmd);
1331 void mpi3mr_app_save_logdata(struct mpi3mr_ioc *mrioc, char *event_data,
1332         u16 event_data_size);
1333 struct mpi3mr_enclosure_node *mpi3mr_enclosure_find_by_handle(
1334         struct mpi3mr_ioc *mrioc, u16 handle);
1335 extern const struct attribute_group *mpi3mr_host_groups[];
1336 extern const struct attribute_group *mpi3mr_dev_groups[];
1337
1338 extern struct sas_function_template mpi3mr_transport_functions;
1339 extern struct scsi_transport_template *mpi3mr_transport_template;
1340
1341 int mpi3mr_cfg_get_dev_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1342         struct mpi3_device_page0 *dev_pg0, u16 pg_sz, u32 form, u32 form_spec);
1343 int mpi3mr_cfg_get_sas_phy_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1344         struct mpi3_sas_phy_page0 *phy_pg0, u16 pg_sz, u32 form,
1345         u32 form_spec);
1346 int mpi3mr_cfg_get_sas_phy_pg1(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1347         struct mpi3_sas_phy_page1 *phy_pg1, u16 pg_sz, u32 form,
1348         u32 form_spec);
1349 int mpi3mr_cfg_get_sas_exp_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1350         struct mpi3_sas_expander_page0 *exp_pg0, u16 pg_sz, u32 form,
1351         u32 form_spec);
1352 int mpi3mr_cfg_get_sas_exp_pg1(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1353         struct mpi3_sas_expander_page1 *exp_pg1, u16 pg_sz, u32 form,
1354         u32 form_spec);
1355 int mpi3mr_cfg_get_enclosure_pg0(struct mpi3mr_ioc *mrioc, u16 *ioc_status,
1356         struct mpi3_enclosure_page0 *encl_pg0, u16 pg_sz, u32 form,
1357         u32 form_spec);
1358 int mpi3mr_cfg_get_sas_io_unit_pg0(struct mpi3mr_ioc *mrioc,
1359         struct mpi3_sas_io_unit_page0 *sas_io_unit_pg0, u16 pg_sz);
1360 int mpi3mr_cfg_get_sas_io_unit_pg1(struct mpi3mr_ioc *mrioc,
1361         struct mpi3_sas_io_unit_page1 *sas_io_unit_pg1, u16 pg_sz);
1362 int mpi3mr_cfg_set_sas_io_unit_pg1(struct mpi3mr_ioc *mrioc,
1363         struct mpi3_sas_io_unit_page1 *sas_io_unit_pg1, u16 pg_sz);
1364 int mpi3mr_cfg_get_driver_pg1(struct mpi3mr_ioc *mrioc,
1365         struct mpi3_driver_page1 *driver_pg1, u16 pg_sz);
1366
1367 u8 mpi3mr_is_expander_device(u16 device_info);
1368 int mpi3mr_expander_add(struct mpi3mr_ioc *mrioc, u16 handle);
1369 void mpi3mr_expander_remove(struct mpi3mr_ioc *mrioc, u64 sas_address,
1370         struct mpi3mr_hba_port *hba_port);
1371 struct mpi3mr_sas_node *__mpi3mr_expander_find_by_handle(struct mpi3mr_ioc
1372         *mrioc, u16 handle);
1373 struct mpi3mr_hba_port *mpi3mr_get_hba_port_by_id(struct mpi3mr_ioc *mrioc,
1374         u8 port_id);
1375 void mpi3mr_sas_host_refresh(struct mpi3mr_ioc *mrioc);
1376 void mpi3mr_sas_host_add(struct mpi3mr_ioc *mrioc);
1377 void mpi3mr_update_links(struct mpi3mr_ioc *mrioc,
1378         u64 sas_address_parent, u16 handle, u8 phy_number, u8 link_rate,
1379         struct mpi3mr_hba_port *hba_port);
1380 void mpi3mr_remove_tgtdev_from_host(struct mpi3mr_ioc *mrioc,
1381         struct mpi3mr_tgt_dev *tgtdev);
1382 int mpi3mr_report_tgtdev_to_sas_transport(struct mpi3mr_ioc *mrioc,
1383         struct mpi3mr_tgt_dev *tgtdev);
1384 void mpi3mr_remove_tgtdev_from_sas_transport(struct mpi3mr_ioc *mrioc,
1385         struct mpi3mr_tgt_dev *tgtdev);
1386 struct mpi3mr_tgt_dev *__mpi3mr_get_tgtdev_by_addr_and_rphy(
1387         struct mpi3mr_ioc *mrioc, u64 sas_address, struct sas_rphy *rphy);
1388 void mpi3mr_print_device_event_notice(struct mpi3mr_ioc *mrioc,
1389         bool device_add);
1390 void mpi3mr_refresh_sas_ports(struct mpi3mr_ioc *mrioc);
1391 void mpi3mr_refresh_expanders(struct mpi3mr_ioc *mrioc);
1392 void mpi3mr_add_event_wait_for_device_refresh(struct mpi3mr_ioc *mrioc);
1393 void mpi3mr_flush_drv_cmds(struct mpi3mr_ioc *mrioc);
1394 void mpi3mr_flush_cmds_for_unrecovered_controller(struct mpi3mr_ioc *mrioc);
1395 void mpi3mr_free_enclosure_list(struct mpi3mr_ioc *mrioc);
1396 #endif /*MPI3MR_H_INCLUDED*/