drivers/scsi/mpt3sas/mpt3sas_base.h

   1 /*
   2  * This is the Fusion MPT base driver providing common API layer interface
   3  * for access to MPT (Message Passing Technology) firmware.
   4  *
   5  * This code is based on drivers/scsi/mpt3sas/mpt3sas_base.h
   6  * Copyright (C) 2012-2014  LSI Corporation
   7  * Copyright (C) 2013-2014 Avago Technologies
   8  *  (mailto: MPT-FusionLinux.pdl@avagotech.com)
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * NO WARRANTY
  21  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  22  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  23  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  24  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  25  * solely responsible for determining the appropriateness of using and
  26  * distributing the Program and assumes all risks associated with its
  27  * exercise of rights under this Agreement, including but not limited to
  28  * the risks and costs of program errors, damage to or loss of data,
  29  * programs or equipment, and unavailability or interruption of operations.
  30
  31  * DISCLAIMER OF LIABILITY
  32  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  33  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  35  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  38  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  39
  40  * You should have received a copy of the GNU General Public License
  41  * along with this program; if not, write to the Free Software
  42  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  43  * USA.
  44  */
  45
  46 #ifndef MPT3SAS_BASE_H_INCLUDED
  47 #define MPT3SAS_BASE_H_INCLUDED
  48
  49 #include "mpi/mpi2_type.h"
  50 #include "mpi/mpi2.h"
  51 #include "mpi/mpi2_ioc.h"
  52 #include "mpi/mpi2_cnfg.h"
  53 #include "mpi/mpi2_init.h"
  54 #include "mpi/mpi2_raid.h"
  55 #include "mpi/mpi2_tool.h"
  56 #include "mpi/mpi2_sas.h"
  57
  58 #include <scsi/scsi.h>
  59 #include <scsi/scsi_cmnd.h>
  60 #include <scsi/scsi_device.h>
  61 #include <scsi/scsi_host.h>
  62 #include <scsi/scsi_tcq.h>
  63 #include <scsi/scsi_transport_sas.h>
  64 #include <scsi/scsi_dbg.h>
  65 #include <scsi/scsi_eh.h>
  66 #include <linux/pci.h>
  67 #include <linux/poll.h>
  68
  69 #include "mpt3sas_debug.h"
  70 #include "mpt3sas_trigger_diag.h"
  71
  72 /* driver versioning info */
  73 #define MPT3SAS_DRIVER_NAME             "mpt3sas"
  74 #define MPT2SAS_DRIVER_NAME             "mpt2sas"
  75 #define MPT3SAS_AUTHOR "Avago Technologies <MPT-FusionLinux.pdl@avagotech.com>"
  76 #define MPT3SAS_DESCRIPTION     "LSI MPT Fusion SAS 3.0 Device Driver"
  77 #define MPT2SAS_DESCRIPTION     "LSI MPT Fusion SAS 2.0 Device Driver"
  78 #define MPT3SAS_DRIVER_VERSION          "09.100.00.00"
  79 #define MPT2SAS_DRIVER_VERSION          "20.101.00.00"
  80 #define MPT3SAS_MAJOR_VERSION           9
  81 #define MPT3SAS_MINOR_VERSION           100
  82 #define MPT3SAS_BUILD_VERSION           0
  83 #define MPT3SAS_RELEASE_VERSION 00
  84
  85 /*
  86  * Set MPT3SAS_SG_DEPTH value based on user input.
  87  */
  88 #define MPT_MAX_PHYS_SEGMENTS   SCSI_MAX_SG_SEGMENTS
  89 #define MPT_MIN_PHYS_SEGMENTS   16
  90
  91 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
  92 #define MPT3SAS_SG_DEPTH                CONFIG_SCSI_MPT3SAS_MAX_SGE
  93 #else
  94 #define MPT3SAS_SG_DEPTH                MPT_MAX_PHYS_SEGMENTS
  95 #endif
  96
  97 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
  98 #define MPT2SAS_SG_DEPTH                CONFIG_SCSI_MPT2SAS_MAX_SGE
  99 #else
 100 #define MPT2SAS_SG_DEPTH                MPT_MAX_PHYS_SEGMENTS
 101 #endif
 102
 103 /*
 104  * Generic Defines
 105  */
 106 #define MPT3SAS_SATA_QUEUE_DEPTH        32
 107 #define MPT3SAS_SAS_QUEUE_DEPTH         254
 108 #define MPT3SAS_RAID_QUEUE_DEPTH        128
 109
 110 #define MPT_NAME_LENGTH                 32      /* generic length of strings */
 111 #define MPT_STRING_LENGTH               64
 112
 113 #define MPT_MAX_CALLBACKS               32
 114
 115
 116 #define  CAN_SLEEP                      1
 117 #define  NO_SLEEP                       0
 118
 119 #define INTERNAL_CMDS_COUNT             10      /* reserved cmds */
 120
 121 #define MPI3_HIM_MASK                   0xFFFFFFFF /* mask every bit*/
 122
 123 #define MPT3SAS_INVALID_DEVICE_HANDLE   0xFFFF
 124
 125 /*
 126  * reset phases
 127  */
 128 #define MPT3_IOC_PRE_RESET              1 /* prior to host reset */
 129 #define MPT3_IOC_AFTER_RESET            2 /* just after host reset */
 130 #define MPT3_IOC_DONE_RESET             3 /* links re-initialized */
 131
 132 /*
 133  * logging format
 134  */
 135 #define MPT3SAS_FMT                     "%s: "
 136
 137 /*
 138  * per target private data
 139  */
 140 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
 141 #define MPT_TARGET_FLAGS_VOLUME         0x02
 142 #define MPT_TARGET_FLAGS_DELETED        0x04
 143 #define MPT_TARGET_FASTPATH_IO          0x08
 144
 145 /*
 146  * Intel HBA branding
 147  */
 148 #define MPT3SAS_INTEL_RMS3JC080_BRANDING       \
 149         "Intel(R) Integrated RAID Module RMS3JC080"
 150 #define MPT3SAS_INTEL_RS3GC008_BRANDING       \
 151         "Intel(R) RAID Controller RS3GC008"
 152 #define MPT3SAS_INTEL_RS3FC044_BRANDING       \
 153         "Intel(R) RAID Controller RS3FC044"
 154 #define MPT3SAS_INTEL_RS3UC080_BRANDING       \
 155         "Intel(R) RAID Controller RS3UC080"
 156
 157 /*
 158  * Intel HBA SSDIDs
 159  */
 160 #define MPT3SAS_INTEL_RMS3JC080_SSDID   0x3521
 161 #define MPT3SAS_INTEL_RS3GC008_SSDID    0x3522
 162 #define MPT3SAS_INTEL_RS3FC044_SSDID    0x3523
 163 #define MPT3SAS_INTEL_RS3UC080_SSDID    0x3524
 164
 165 /*
 166  * Dell HBA branding
 167  */
 168 #define MPT3SAS_DELL_12G_HBA_BRANDING       \
 169         "Dell 12Gbps HBA"
 170
 171 /*
 172  * Dell HBA SSDIDs
 173  */
 174 #define MPT3SAS_DELL_12G_HBA_SSDID      0x1F46
 175
 176 /*
 177  * Cisco HBA branding
 178  */
 179 #define MPT3SAS_CISCO_12G_8E_HBA_BRANDING               \
 180                 "Cisco 9300-8E 12G SAS HBA"
 181 #define MPT3SAS_CISCO_12G_8I_HBA_BRANDING               \
 182                 "Cisco 9300-8i 12G SAS HBA"
 183 #define MPT3SAS_CISCO_12G_AVILA_HBA_BRANDING    \
 184                 "Cisco 12G Modular SAS Pass through Controller"
 185 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_BRANDING         \
 186                 "UCS C3X60 12G SAS Pass through Controller"
 187 /*
 188  * Cisco HBA SSSDIDs
 189  */
 190 #define MPT3SAS_CISCO_12G_8E_HBA_SSDID  0x14C
 191 #define MPT3SAS_CISCO_12G_8I_HBA_SSDID  0x154
 192 #define MPT3SAS_CISCO_12G_AVILA_HBA_SSDID  0x155
 193 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_SSDID  0x156
 194
 195 /*
 196  * status bits for ioc->diag_buffer_status
 197  */
 198 #define MPT3_DIAG_BUFFER_IS_REGISTERED  (0x01)
 199 #define MPT3_DIAG_BUFFER_IS_RELEASED    (0x02)
 200 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET  (0x04)
 201
 202 /*
 203  * Combined Reply Queue constants,
 204  * There are twelve Supplemental Reply Post Host Index Registers
 205  * and each register is at offset 0x10 bytes from the previous one.
 206  */
 207 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
 208 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
 209
 210 /* OEM Identifiers */
 211 #define MFG10_OEM_ID_INVALID                   (0x00000000)
 212 #define MFG10_OEM_ID_DELL                      (0x00000001)
 213 #define MFG10_OEM_ID_FSC                       (0x00000002)
 214 #define MFG10_OEM_ID_SUN                       (0x00000003)
 215 #define MFG10_OEM_ID_IBM                       (0x00000004)
 216
 217 /* GENERIC Flags 0*/
 218 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
 219 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
 220 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
 221 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
 222 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
 223
 224 #define VIRTUAL_IO_FAILED_RETRY                 (0x32010081)
 225
 226 /* OEM Specific Flags will come from OEM specific header files */
 227 struct Mpi2ManufacturingPage10_t {
 228         MPI2_CONFIG_PAGE_HEADER Header;         /* 00h */
 229         U8      OEMIdentifier;                  /* 04h */
 230         U8      Reserved1;                      /* 05h */
 231         U16     Reserved2;                      /* 08h */
 232         U32     Reserved3;                      /* 0Ch */
 233         U32     GenericFlags0;                  /* 10h */
 234         U32     GenericFlags1;                  /* 14h */
 235         U32     Reserved4;                      /* 18h */
 236         U32     OEMSpecificFlags0;              /* 1Ch */
 237         U32     OEMSpecificFlags1;              /* 20h */
 238         U32     Reserved5[18];                  /* 24h - 60h*/
 239 };
 240
 241
 242 /* Miscellaneous options */
 243 struct Mpi2ManufacturingPage11_t {
 244         MPI2_CONFIG_PAGE_HEADER Header;         /* 00h */
 245         __le32  Reserved1;                      /* 04h */
 246         u8      Reserved2;                      /* 08h */
 247         u8      EEDPTagMode;                    /* 09h */
 248         u8      Reserved3;                      /* 0Ah */
 249         u8      Reserved4;                      /* 0Bh */
 250         __le32  Reserved5[23];                  /* 0Ch-60h*/
 251 };
 252
 253 /**
 254  * struct MPT3SAS_TARGET - starget private hostdata
 255  * @starget: starget object
 256  * @sas_address: target sas address
 257  * @handle: device handle
 258  * @num_luns: number luns
 259  * @flags: MPT_TARGET_FLAGS_XXX flags
 260  * @deleted: target flaged for deletion
 261  * @tm_busy: target is busy with TM request.
 262  */
 263 struct MPT3SAS_TARGET {
 264         struct scsi_target *starget;
 265         u64     sas_address;
 266         u16     handle;
 267         int     num_luns;
 268         u32     flags;
 269         u8      deleted;
 270         u8      tm_busy;
 271 };
 272
 273
 274 /*
 275  * per device private data
 276  */
 277 #define MPT_DEVICE_FLAGS_INIT           0x01
 278 #define MPT_DEVICE_TLR_ON               0x02
 279
 280 /**
 281  * struct MPT3SAS_DEVICE - sdev private hostdata
 282  * @sas_target: starget private hostdata
 283  * @lun: lun number
 284  * @flags: MPT_DEVICE_XXX flags
 285  * @configured_lun: lun is configured
 286  * @block: device is in SDEV_BLOCK state
 287  * @tlr_snoop_check: flag used in determining whether to disable TLR
 288  * @eedp_enable: eedp support enable bit
 289  * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
 290  * @eedp_block_length: block size
 291  */
 292 struct MPT3SAS_DEVICE {
 293         struct MPT3SAS_TARGET *sas_target;
 294         unsigned int    lun;
 295         u32     flags;
 296         u8      configured_lun;
 297         u8      block;
 298         u8      tlr_snoop_check;
 299 };
 300
 301 #define MPT3_CMD_NOT_USED       0x8000  /* free */
 302 #define MPT3_CMD_COMPLETE       0x0001  /* completed */
 303 #define MPT3_CMD_PENDING        0x0002  /* pending */
 304 #define MPT3_CMD_REPLY_VALID    0x0004  /* reply is valid */
 305 #define MPT3_CMD_RESET          0x0008  /* host reset dropped the command */
 306
 307 /**
 308  * struct _internal_cmd - internal commands struct
 309  * @mutex: mutex
 310  * @done: completion
 311  * @reply: reply message pointer
 312  * @sense: sense data
 313  * @status: MPT3_CMD_XXX status
 314  * @smid: system message id
 315  */
 316 struct _internal_cmd {
 317         struct mutex mutex;
 318         struct completion done;
 319         void    *reply;
 320         void    *sense;
 321         u16     status;
 322         u16     smid;
 323 };
 324
 325
 326
 327 /**
 328  * struct _sas_device - attached device information
 329  * @list: sas device list
 330  * @starget: starget object
 331  * @sas_address: device sas address
 332  * @device_name: retrieved from the SAS IDENTIFY frame.
 333  * @handle: device handle
 334  * @sas_address_parent: sas address of parent expander or sas host
 335  * @enclosure_handle: enclosure handle
 336  * @enclosure_logical_id: enclosure logical identifier
 337  * @volume_handle: volume handle (valid when hidden raid member)
 338  * @volume_wwid: volume unique identifier
 339  * @device_info: bitfield provides detailed info about the device
 340  * @id: target id
 341  * @channel: target channel
 342  * @slot: number number
 343  * @phy: phy identifier provided in sas device page 0
 344  * @responding: used in _scsih_sas_device_mark_responding
 345  * @fast_path: fast path feature enable bit
 346  * @pfa_led_on: flag for PFA LED status
 347  * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
 348  *      addition routine.
 349  */
 350 struct _sas_device {
 351         struct list_head list;
 352         struct scsi_target *starget;
 353         u64     sas_address;
 354         u64     device_name;
 355         u16     handle;
 356         u64     sas_address_parent;
 357         u16     enclosure_handle;
 358         u64     enclosure_logical_id;
 359         u16     volume_handle;
 360         u64     volume_wwid;
 361         u32     device_info;
 362         int     id;
 363         int     channel;
 364         u16     slot;
 365         u8      phy;
 366         u8      responding;
 367         u8      fast_path;
 368         u8      pfa_led_on;
 369         u8      pend_sas_rphy_add;
 370         u8      enclosure_level;
 371         u8      connector_name[4];
 372 };
 373
 374 /**
 375  * struct _raid_device - raid volume link list
 376  * @list: sas device list
 377  * @starget: starget object
 378  * @sdev: scsi device struct (volumes are single lun)
 379  * @wwid: unique identifier for the volume
 380  * @handle: device handle
 381  * @id: target id
 382  * @channel: target channel
 383  * @volume_type: the raid level
 384  * @device_info: bitfield provides detailed info about the hidden components
 385  * @num_pds: number of hidden raid components
 386  * @responding: used in _scsih_raid_device_mark_responding
 387  * @percent_complete: resync percent complete
 388  */
 389 #define MPT_MAX_WARPDRIVE_PDS           8
 390 struct _raid_device {
 391         struct list_head list;
 392         struct scsi_target *starget;
 393         struct scsi_device *sdev;
 394         u64     wwid;
 395         u16     handle;
 396         int     id;
 397         int     channel;
 398         u8      volume_type;
 399         u8      num_pds;
 400         u8      responding;
 401         u8      percent_complete;
 402         u32     device_info;
 403 };
 404
 405 /**
 406  * struct _boot_device - boot device info
 407  * @is_raid: flag to indicate whether this is volume
 408  * @device: holds pointer for either struct _sas_device or
 409  *     struct _raid_device
 410  */
 411 struct _boot_device {
 412         u8 is_raid;
 413         void *device;
 414 };
 415
 416 /**
 417  * struct _sas_port - wide/narrow sas port information
 418  * @port_list: list of ports belonging to expander
 419  * @num_phys: number of phys belonging to this port
 420  * @remote_identify: attached device identification
 421  * @rphy: sas transport rphy object
 422  * @port: sas transport wide/narrow port object
 423  * @phy_list: _sas_phy list objects belonging to this port
 424  */
 425 struct _sas_port {
 426         struct list_head port_list;
 427         u8      num_phys;
 428         struct sas_identify remote_identify;
 429         struct sas_rphy *rphy;
 430         struct sas_port *port;
 431         struct list_head phy_list;
 432 };
 433
 434 /**
 435  * struct _sas_phy - phy information
 436  * @port_siblings: list of phys belonging to a port
 437  * @identify: phy identification
 438  * @remote_identify: attached device identification
 439  * @phy: sas transport phy object
 440  * @phy_id: unique phy id
 441  * @handle: device handle for this phy
 442  * @attached_handle: device handle for attached device
 443  * @phy_belongs_to_port: port has been created for this phy
 444  */
 445 struct _sas_phy {
 446         struct list_head port_siblings;
 447         struct sas_identify identify;
 448         struct sas_identify remote_identify;
 449         struct sas_phy *phy;
 450         u8      phy_id;
 451         u16     handle;
 452         u16     attached_handle;
 453         u8      phy_belongs_to_port;
 454 };
 455
 456 /**
 457  * struct _sas_node - sas_host/expander information
 458  * @list: list of expanders
 459  * @parent_dev: parent device class
 460  * @num_phys: number phys belonging to this sas_host/expander
 461  * @sas_address: sas address of this sas_host/expander
 462  * @handle: handle for this sas_host/expander
 463  * @sas_address_parent: sas address of parent expander or sas host
 464  * @enclosure_handle: handle for this a member of an enclosure
 465  * @device_info: bitwise defining capabilities of this sas_host/expander
 466  * @responding: used in _scsih_expander_device_mark_responding
 467  * @phy: a list of phys that make up this sas_host/expander
 468  * @sas_port_list: list of ports attached to this sas_host/expander
 469  */
 470 struct _sas_node {
 471         struct list_head list;
 472         struct device *parent_dev;
 473         u8      num_phys;
 474         u64     sas_address;
 475         u16     handle;
 476         u64     sas_address_parent;
 477         u16     enclosure_handle;
 478         u64     enclosure_logical_id;
 479         u8      responding;
 480         struct  _sas_phy *phy;
 481         struct list_head sas_port_list;
 482 };
 483
 484 /**
 485  * enum reset_type - reset state
 486  * @FORCE_BIG_HAMMER: issue diagnostic reset
 487  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
 488  */
 489 enum reset_type {
 490         FORCE_BIG_HAMMER,
 491         SOFT_RESET,
 492 };
 493
 494 /**
 495  * struct chain_tracker - firmware chain tracker
 496  * @chain_buffer: chain buffer
 497  * @chain_buffer_dma: physical address
 498  * @tracker_list: list of free request (ioc->free_chain_list)
 499  */
 500 struct chain_tracker {
 501         void *chain_buffer;
 502         dma_addr_t chain_buffer_dma;
 503         struct list_head tracker_list;
 504 };
 505
 506 /**
 507  * struct scsiio_tracker - scsi mf request tracker
 508  * @smid: system message id
 509  * @scmd: scsi request pointer
 510  * @cb_idx: callback index
 511  * @tracker_list: list of free request (ioc->free_list)
 512  */
 513 struct scsiio_tracker {
 514         u16     smid;
 515         struct scsi_cmnd *scmd;
 516         u8      cb_idx;
 517         struct list_head chain_list;
 518         struct list_head tracker_list;
 519 };
 520
 521 /**
 522  * struct request_tracker - firmware request tracker
 523  * @smid: system message id
 524  * @cb_idx: callback index
 525  * @tracker_list: list of free request (ioc->free_list)
 526  */
 527 struct request_tracker {
 528         u16     smid;
 529         u8      cb_idx;
 530         struct list_head tracker_list;
 531 };
 532
 533 /**
 534  * struct _tr_list - target reset list
 535  * @handle: device handle
 536  * @state: state machine
 537  */
 538 struct _tr_list {
 539         struct list_head list;
 540         u16     handle;
 541         u16     state;
 542 };
 543
 544
 545 /**
 546  * struct adapter_reply_queue - the reply queue struct
 547  * @ioc: per adapter object
 548  * @msix_index: msix index into vector table
 549  * @vector: irq vector
 550  * @reply_post_host_index: head index in the pool where FW completes IO
 551  * @reply_post_free: reply post base virt address
 552  * @name: the name registered to request_irq()
 553  * @busy: isr is actively processing replies on another cpu
 554  * @list: this list
 555 */
 556 struct adapter_reply_queue {
 557         struct MPT3SAS_ADAPTER  *ioc;
 558         u8                      msix_index;
 559         unsigned int            vector;
 560         u32                     reply_post_host_index;
 561         Mpi2ReplyDescriptorsUnion_t *reply_post_free;
 562         char                    name[MPT_NAME_LENGTH];
 563         atomic_t                busy;
 564         cpumask_var_t           affinity_hint;
 565         struct list_head        list;
 566 };
 567
 568 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
 569
 570 /* SAS3.0 support */
 571 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
 572                 struct scsi_cmnd *scmd, u16 smid);
 573 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
 574                 dma_addr_t data_out_dma, size_t data_out_sz,
 575                 dma_addr_t data_in_dma, size_t data_in_sz);
 576 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
 577                 void *paddr);
 578
 579
 580
 581 /* IOC Facts and Port Facts converted from little endian to cpu */
 582 union mpi3_version_union {
 583         MPI2_VERSION_STRUCT             Struct;
 584         u32                             Word;
 585 };
 586
 587 struct mpt3sas_facts {
 588         u16                     MsgVersion;
 589         u16                     HeaderVersion;
 590         u8                      IOCNumber;
 591         u8                      VP_ID;
 592         u8                      VF_ID;
 593         u16                     IOCExceptions;
 594         u16                     IOCStatus;
 595         u32                     IOCLogInfo;
 596         u8                      MaxChainDepth;
 597         u8                      WhoInit;
 598         u8                      NumberOfPorts;
 599         u8                      MaxMSIxVectors;
 600         u16                     RequestCredit;
 601         u16                     ProductID;
 602         u32                     IOCCapabilities;
 603         union mpi3_version_union        FWVersion;
 604         u16                     IOCRequestFrameSize;
 605         u16                     Reserved3;
 606         u16                     MaxInitiators;
 607         u16                     MaxTargets;
 608         u16                     MaxSasExpanders;
 609         u16                     MaxEnclosures;
 610         u16                     ProtocolFlags;
 611         u16                     HighPriorityCredit;
 612         u16                     MaxReplyDescriptorPostQueueDepth;
 613         u8                      ReplyFrameSize;
 614         u8                      MaxVolumes;
 615         u16                     MaxDevHandle;
 616         u16                     MaxPersistentEntries;
 617         u16                     MinDevHandle;
 618 };
 619
 620 struct mpt3sas_port_facts {
 621         u8                      PortNumber;
 622         u8                      VP_ID;
 623         u8                      VF_ID;
 624         u8                      PortType;
 625         u16                     MaxPostedCmdBuffers;
 626 };
 627
 628 struct reply_post_struct {
 629         Mpi2ReplyDescriptorsUnion_t     *reply_post_free;
 630         dma_addr_t                      reply_post_free_dma;
 631 };
 632
 633 /**
 634  * enum mutex_type - task management mutex type
 635  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
 636  * @TM_MUTEX_ON: mutex is required
 637  */
 638 enum mutex_type {
 639         TM_MUTEX_OFF = 0,
 640         TM_MUTEX_ON = 1,
 641 };
 642
 643 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
 644 /**
 645  * struct MPT3SAS_ADAPTER - per adapter struct
 646  * @list: ioc_list
 647  * @shost: shost object
 648  * @id: unique adapter id
 649  * @cpu_count: number online cpus
 650  * @name: generic ioc string
 651  * @tmp_string: tmp string used for logging
 652  * @pdev: pci pdev object
 653  * @pio_chip: physical io register space
 654  * @chip: memory mapped register space
 655  * @chip_phys: physical addrss prior to mapping
 656  * @logging_level: see mpt3sas_debug.h
 657  * @fwfault_debug: debuging FW timeouts
 658  * @ir_firmware: IR firmware present
 659  * @bars: bitmask of BAR's that must be configured
 660  * @mask_interrupts: ignore interrupt
 661  * @dma_mask: used to set the consistent dma mask
 662  * @fault_reset_work_q_name: fw fault work queue
 663  * @fault_reset_work_q: ""
 664  * @fault_reset_work: ""
 665  * @firmware_event_name: fw event work queue
 666  * @firmware_event_thread: ""
 667  * @fw_event_lock:
 668  * @fw_event_list: list of fw events
 669  * @aen_event_read_flag: event log was read
 670  * @broadcast_aen_busy: broadcast aen waiting to be serviced
 671  * @shost_recovery: host reset in progress
 672  * @ioc_reset_in_progress_lock:
 673  * @ioc_link_reset_in_progress: phy/hard reset in progress
 674  * @ignore_loginfos: ignore loginfos during task management
 675  * @remove_host: flag for when driver unloads, to avoid sending dev resets
 676  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
 677  * @wait_for_discovery_to_complete: flag set at driver load time when
 678  *                                               waiting on reporting devices
 679  * @is_driver_loading: flag set at driver load time
 680  * @port_enable_failed: flag set when port enable has failed
 681  * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
 682  * @start_scan_failed: means port enable failed, return's the ioc_status
 683  * @msix_enable: flag indicating msix is enabled
 684  * @msix_vector_count: number msix vectors
 685  * @cpu_msix_table: table for mapping cpus to msix index
 686  * @cpu_msix_table_sz: table size
 687  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
 688  * @scsi_io_cb_idx: shost generated commands
 689  * @tm_cb_idx: task management commands
 690  * @scsih_cb_idx: scsih internal commands
 691  * @transport_cb_idx: transport internal commands
 692  * @ctl_cb_idx: clt internal commands
 693  * @base_cb_idx: base internal commands
 694  * @config_cb_idx: base internal commands
 695  * @tm_tr_cb_idx : device removal target reset handshake
 696  * @tm_tr_volume_cb_idx : volume removal target reset
 697  * @base_cmds:
 698  * @transport_cmds:
 699  * @scsih_cmds:
 700  * @tm_cmds:
 701  * @ctl_cmds:
 702  * @config_cmds:
 703  * @base_add_sg_single: handler for either 32/64 bit sgl's
 704  * @event_type: bits indicating which events to log
 705  * @event_context: unique id for each logged event
 706  * @event_log: event log pointer
 707  * @event_masks: events that are masked
 708  * @facts: static facts data
 709  * @pfacts: static port facts data
 710  * @manu_pg0: static manufacturing page 0
 711  * @manu_pg10: static manufacturing page 10
 712  * @manu_pg11: static manufacturing page 11
 713  * @bios_pg2: static bios page 2
 714  * @bios_pg3: static bios page 3
 715  * @ioc_pg8: static ioc page 8
 716  * @iounit_pg0: static iounit page 0
 717  * @iounit_pg1: static iounit page 1
 718  * @iounit_pg8: static iounit page 8
 719  * @sas_hba: sas host object
 720  * @sas_expander_list: expander object list
 721  * @sas_node_lock:
 722  * @sas_device_list: sas device object list
 723  * @sas_device_init_list: sas device object list (used only at init time)
 724  * @sas_device_lock:
 725  * @io_missing_delay: time for IO completed by fw when PDR enabled
 726  * @device_missing_delay: time for device missing by fw when PDR enabled
 727  * @sas_id : used for setting volume target IDs
 728  * @blocking_handles: bitmask used to identify which devices need blocking
 729  * @pd_handles : bitmask for PD handles
 730  * @pd_handles_sz : size of pd_handle bitmask
 731  * @config_page_sz: config page size
 732  * @config_page: reserve memory for config page payload
 733  * @config_page_dma:
 734  * @hba_queue_depth: hba request queue depth
 735  * @sge_size: sg element size for either 32/64 bit
 736  * @scsiio_depth: SCSI_IO queue depth
 737  * @request_sz: per request frame size
 738  * @request: pool of request frames
 739  * @request_dma:
 740  * @request_dma_sz:
 741  * @scsi_lookup: firmware request tracker list
 742  * @scsi_lookup_lock:
 743  * @free_list: free list of request
 744  * @pending_io_count:
 745  * @reset_wq:
 746  * @chain: pool of chains
 747  * @chain_dma:
 748  * @max_sges_in_main_message: number sg elements in main message
 749  * @max_sges_in_chain_message: number sg elements per chain
 750  * @chains_needed_per_io: max chains per io
 751  * @chain_depth: total chains allocated
 752  * @hi_priority_smid:
 753  * @hi_priority:
 754  * @hi_priority_dma:
 755  * @hi_priority_depth:
 756  * @hpr_lookup:
 757  * @hpr_free_list:
 758  * @internal_smid:
 759  * @internal:
 760  * @internal_dma:
 761  * @internal_depth:
 762  * @internal_lookup:
 763  * @internal_free_list:
 764  * @sense: pool of sense
 765  * @sense_dma:
 766  * @sense_dma_pool:
 767  * @reply_depth: hba reply queue depth:
 768  * @reply_sz: per reply frame size:
 769  * @reply: pool of replys:
 770  * @reply_dma:
 771  * @reply_dma_pool:
 772  * @reply_free_queue_depth: reply free depth
 773  * @reply_free: pool for reply free queue (32 bit addr)
 774  * @reply_free_dma:
 775  * @reply_free_dma_pool:
 776  * @reply_free_host_index: tail index in pool to insert free replys
 777  * @reply_post_queue_depth: reply post queue depth
 778  * @reply_post_struct: struct for reply_post_free physical & virt address
 779  * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
 780  * @rdpq_array_enable: rdpq_array support is enabled in the driver
 781  * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
 782  *                              is assigned only ones
 783  * @reply_queue_count: number of reply queue's
 784  * @reply_queue_list: link list contaning the reply queue info
 785  * @msix96_vector: 96 MSI-X vector support
 786  * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
 787  * @delayed_tr_list: target reset link list
 788  * @delayed_tr_volume_list: volume target reset link list
 789  * @@temp_sensors_count: flag to carry the number of temperature sensors
 790  */
 791 struct MPT3SAS_ADAPTER {
 792         struct list_head list;
 793         struct Scsi_Host *shost;
 794         u8              id;
 795         int             cpu_count;
 796         char            name[MPT_NAME_LENGTH];
 797         char            tmp_string[MPT_STRING_LENGTH];
 798         struct pci_dev  *pdev;
 799         Mpi2SystemInterfaceRegs_t __iomem *chip;
 800         resource_size_t chip_phys;
 801         int             logging_level;
 802         int             fwfault_debug;
 803         u8              ir_firmware;
 804         int             bars;
 805         u8              mask_interrupts;
 806         int             dma_mask;
 807
 808         /* fw fault handler */
 809         char            fault_reset_work_q_name[20];
 810         struct workqueue_struct *fault_reset_work_q;
 811         struct delayed_work fault_reset_work;
 812
 813         /* fw event handler */
 814         char            firmware_event_name[20];
 815         struct workqueue_struct *firmware_event_thread;
 816         spinlock_t      fw_event_lock;
 817         struct list_head fw_event_list;
 818
 819          /* misc flags */
 820         int             aen_event_read_flag;
 821         u8              broadcast_aen_busy;
 822         u16             broadcast_aen_pending;
 823         u8              shost_recovery;
 824
 825         struct mutex    reset_in_progress_mutex;
 826         spinlock_t      ioc_reset_in_progress_lock;
 827         u8              ioc_link_reset_in_progress;
 828         u8              ioc_reset_in_progress_status;
 829
 830         u8              ignore_loginfos;
 831         u8              remove_host;
 832         u8              pci_error_recovery;
 833         u8              wait_for_discovery_to_complete;
 834         u8              is_driver_loading;
 835         u8              port_enable_failed;
 836         u8              start_scan;
 837         u16             start_scan_failed;
 838
 839         u8              msix_enable;
 840         u16             msix_vector_count;
 841         u8              *cpu_msix_table;
 842         u16             cpu_msix_table_sz;
 843         u32             ioc_reset_count;
 844         MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
 845
 846         /* internal commands, callback index */
 847         u8              scsi_io_cb_idx;
 848         u8              tm_cb_idx;
 849         u8              transport_cb_idx;
 850         u8              scsih_cb_idx;
 851         u8              ctl_cb_idx;
 852         u8              base_cb_idx;
 853         u8              port_enable_cb_idx;
 854         u8              config_cb_idx;
 855         u8              tm_tr_cb_idx;
 856         u8              tm_tr_volume_cb_idx;
 857         u8              tm_sas_control_cb_idx;
 858         struct _internal_cmd base_cmds;
 859         struct _internal_cmd port_enable_cmds;
 860         struct _internal_cmd transport_cmds;
 861         struct _internal_cmd scsih_cmds;
 862         struct _internal_cmd tm_cmds;
 863         struct _internal_cmd ctl_cmds;
 864         struct _internal_cmd config_cmds;
 865
 866         MPT_ADD_SGE     base_add_sg_single;
 867
 868         /* function ptr for either IEEE or MPI sg elements */
 869         MPT_BUILD_SG_SCMD build_sg_scmd;
 870         MPT_BUILD_SG    build_sg;
 871         MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
 872         u16             sge_size_ieee;
 873         u16             hba_mpi_version_belonged;
 874
 875         /* function ptr for MPI sg elements only */
 876         MPT_BUILD_SG    build_sg_mpi;
 877         MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
 878
 879         /* event log */
 880         u32             event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 881         u32             event_context;
 882         void            *event_log;
 883         u32             event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 884
 885         /* static config pages */
 886         struct mpt3sas_facts facts;
 887         struct mpt3sas_port_facts *pfacts;
 888         Mpi2ManufacturingPage0_t manu_pg0;
 889         struct Mpi2ManufacturingPage10_t manu_pg10;
 890         struct Mpi2ManufacturingPage11_t manu_pg11;
 891         Mpi2BiosPage2_t bios_pg2;
 892         Mpi2BiosPage3_t bios_pg3;
 893         Mpi2IOCPage8_t ioc_pg8;
 894         Mpi2IOUnitPage0_t iounit_pg0;
 895         Mpi2IOUnitPage1_t iounit_pg1;
 896         Mpi2IOUnitPage8_t iounit_pg8;
 897
 898         struct _boot_device req_boot_device;
 899         struct _boot_device req_alt_boot_device;
 900         struct _boot_device current_boot_device;
 901
 902         /* sas hba, expander, and device list */
 903         struct _sas_node sas_hba;
 904         struct list_head sas_expander_list;
 905         spinlock_t      sas_node_lock;
 906         struct list_head sas_device_list;
 907         struct list_head sas_device_init_list;
 908         spinlock_t      sas_device_lock;
 909         struct list_head raid_device_list;
 910         spinlock_t      raid_device_lock;
 911         u8              io_missing_delay;
 912         u16             device_missing_delay;
 913         int             sas_id;
 914
 915         void            *blocking_handles;
 916         void            *pd_handles;
 917         u16             pd_handles_sz;
 918
 919         /* config page */
 920         u16             config_page_sz;
 921         void            *config_page;
 922         dma_addr_t      config_page_dma;
 923
 924         /* scsiio request */
 925         u16             hba_queue_depth;
 926         u16             sge_size;
 927         u16             scsiio_depth;
 928         u16             request_sz;
 929         u8              *request;
 930         dma_addr_t      request_dma;
 931         u32             request_dma_sz;
 932         struct scsiio_tracker *scsi_lookup;
 933         ulong           scsi_lookup_pages;
 934         spinlock_t      scsi_lookup_lock;
 935         struct list_head free_list;
 936         int             pending_io_count;
 937         wait_queue_head_t reset_wq;
 938
 939         /* chain */
 940         struct chain_tracker *chain_lookup;
 941         struct list_head free_chain_list;
 942         struct dma_pool *chain_dma_pool;
 943         ulong           chain_pages;
 944         u16             max_sges_in_main_message;
 945         u16             max_sges_in_chain_message;
 946         u16             chains_needed_per_io;
 947         u32             chain_depth;
 948
 949         /* hi-priority queue */
 950         u16             hi_priority_smid;
 951         u8              *hi_priority;
 952         dma_addr_t      hi_priority_dma;
 953         u16             hi_priority_depth;
 954         struct request_tracker *hpr_lookup;
 955         struct list_head hpr_free_list;
 956
 957         /* internal queue */
 958         u16             internal_smid;
 959         u8              *internal;
 960         dma_addr_t      internal_dma;
 961         u16             internal_depth;
 962         struct request_tracker *internal_lookup;
 963         struct list_head internal_free_list;
 964
 965         /* sense */
 966         u8              *sense;
 967         dma_addr_t      sense_dma;
 968         struct dma_pool *sense_dma_pool;
 969
 970         /* reply */
 971         u16             reply_sz;
 972         u8              *reply;
 973         dma_addr_t      reply_dma;
 974         u32             reply_dma_max_address;
 975         u32             reply_dma_min_address;
 976         struct dma_pool *reply_dma_pool;
 977
 978         /* reply free queue */
 979         u16             reply_free_queue_depth;
 980         __le32          *reply_free;
 981         dma_addr_t      reply_free_dma;
 982         struct dma_pool *reply_free_dma_pool;
 983         u32             reply_free_host_index;
 984
 985         /* reply post queue */
 986         u16             reply_post_queue_depth;
 987         struct reply_post_struct *reply_post;
 988         u8              rdpq_array_capable;
 989         u8              rdpq_array_enable;
 990         u8              rdpq_array_enable_assigned;
 991         struct dma_pool *reply_post_free_dma_pool;
 992         u8              reply_queue_count;
 993         struct list_head reply_queue_list;
 994
 995         u8              msix96_vector;
 996         /* reply post register index */
 997         resource_size_t **replyPostRegisterIndex;
 998
 999         struct list_head delayed_tr_list;
1000         struct list_head delayed_tr_volume_list;
1001         u8              temp_sensors_count;
1002
1003         /* diag buffer support */
1004         u8              *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
1005         u32             diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
1006         dma_addr_t      diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
1007         u8              diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
1008         u32             unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
1009         u32             product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
1010         u32             diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
1011         u32             ring_buffer_offset;
1012         u32             ring_buffer_sz;
1013         spinlock_t      diag_trigger_lock;
1014         u8              diag_trigger_active;
1015         struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
1016         struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
1017         struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
1018         struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
1019 };
1020
1021 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1022         u32 reply);
1023
1024
1025 /* base shared API */
1026 extern struct list_head mpt3sas_ioc_list;
1027 extern char    driver_name[MPT_NAME_LENGTH];
1028
1029 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
1030 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
1031
1032 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
1033 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
1034 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1035 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1036 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1037         enum reset_type type);
1038
1039 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1040 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1041 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1042         u16 smid);
1043 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1044
1045 /* hi-priority queue */
1046 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1047 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1048         struct scsi_cmnd *scmd);
1049
1050 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1051 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1052 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1053         u16 handle);
1054 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1055         u16 handle);
1056 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1057 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1058 void mpt3sas_base_initialize_callback_handler(void);
1059 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1060 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1061
1062 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1063         u32 reply);
1064 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1065         u8 msix_index, u32 reply);
1066 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1067         u32 phys_addr);
1068
1069 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1070
1071 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1072 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1073         Mpi2SasIoUnitControlReply_t *mpi_reply,
1074         Mpi2SasIoUnitControlRequest_t *mpi_request);
1075 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1076         Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1077
1078 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1079         u32 *event_type);
1080
1081 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1082
1083 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1084         u16 device_missing_delay, u8 io_missing_delay);
1085
1086 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1087
1088
1089 /* scsih shared API */
1090 extern struct raid_template *mpt3sas_raid_template;
1091 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1092         u32 reply);
1093 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1094
1095 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1096         uint channel, uint id, uint lun, u8 type, u16 smid_task,
1097         ulong timeout, enum mutex_type m_type);
1098 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1099 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1100 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1101 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1102         u64 sas_address);
1103
1104 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1105         struct MPT3SAS_ADAPTER *ioc, u16 handle);
1106 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1107         struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1108 struct _sas_device *mpt3sas_scsih_sas_device_find_by_sas_address(
1109         struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1110
1111 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1112
1113 void scsih_exit(void);
1114 int scsih_init(void);
1115 int scsih_probe(struct pci_dev *pdev, struct Scsi_Host *shost);
1116 void scsih_remove(struct pci_dev *pdev);
1117 void scsih_shutdown(struct pci_dev *pdev);
1118 pci_ers_result_t scsih_pci_error_detected(struct pci_dev *pdev,
1119         pci_channel_state_t state);
1120 pci_ers_result_t scsih_pci_mmio_enabled(struct pci_dev *pdev);
1121 pci_ers_result_t scsih_pci_slot_reset(struct pci_dev *pdev);
1122 void scsih_pci_resume(struct pci_dev *pdev);
1123 int scsih_suspend(struct pci_dev *pdev, pm_message_t state);
1124 int scsih_resume(struct pci_dev *pdev);
1125
1126 int scsih_qcmd(struct Scsi_Host *shost, struct scsi_cmnd *scmd);
1127 int scsih_target_alloc(struct scsi_target *starget);
1128 int scsih_slave_alloc(struct scsi_device *sdev);
1129 int scsih_slave_configure(struct scsi_device *sdev);
1130 void scsih_target_destroy(struct scsi_target *starget);
1131 void scsih_slave_destroy(struct scsi_device *sdev);
1132 int scsih_scan_finished(struct Scsi_Host *shost, unsigned long time);
1133 void scsih_scan_start(struct Scsi_Host *shost);
1134 int scsih_change_queue_depth(struct scsi_device *sdev, int qdepth);
1135 int scsih_abort(struct scsi_cmnd *scmd);
1136 int scsih_dev_reset(struct scsi_cmnd *scmd);
1137 int scsih_target_reset(struct scsi_cmnd *scmd);
1138 int scsih_host_reset(struct scsi_cmnd *scmd);
1139 int scsih_bios_param(struct scsi_device *sdev, struct block_device *bdev,
1140         sector_t capacity, int params[]);
1141
1142 int scsih_is_raid(struct device *dev);
1143 void scsih_get_resync(struct device *dev);
1144 void scsih_get_state(struct device *dev);
1145
1146 /* config shared API */
1147 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1148         u32 reply);
1149 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1150         u8 *num_phys);
1151 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1152         Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1153 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1154         Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1155         u16 sz);
1156 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1157         Mpi2ConfigReply_t *mpi_reply,
1158         struct Mpi2ManufacturingPage10_t *config_page);
1159
1160 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1161         Mpi2ConfigReply_t *mpi_reply,
1162         struct Mpi2ManufacturingPage11_t  *config_page);
1163 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1164         Mpi2ConfigReply_t *mpi_reply,
1165         struct Mpi2ManufacturingPage11_t *config_page);
1166
1167 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1168         *mpi_reply, Mpi2BiosPage2_t *config_page);
1169 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1170         *mpi_reply, Mpi2BiosPage3_t *config_page);
1171 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1172         *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1173 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1174         Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1175         u32 form, u32 handle);
1176 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1177         Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1178         u32 form, u32 handle);
1179 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1180         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1181         u16 sz);
1182 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1183         *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1184 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1185         *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1186 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1187         *mpi_reply, Mpi2IOUnitPage8_t *config_page);
1188 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1189         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1190         u16 sz);
1191 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1192         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1193         u16 sz);
1194 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1195         *mpi_reply, Mpi2IOCPage8_t *config_page);
1196 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1197         Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1198         u32 form, u32 handle);
1199 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1200         Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1201         u32 phy_number, u16 handle);
1202 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1203         Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1204         u32 form, u32 handle);
1205 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1206         *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1207 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1208         *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1209 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1210         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1211         u32 handle);
1212 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1213         u8 *num_pds);
1214 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1215         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1216         u32 handle, u16 sz);
1217 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1218         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1219         u32 form, u32 form_specific);
1220 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1221         u16 *volume_handle);
1222 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1223         u16 volume_handle, u64 *wwid);
1224
1225 /* ctl shared API */
1226 extern struct device_attribute *mpt3sas_host_attrs[];
1227 extern struct device_attribute *mpt3sas_dev_attrs[];
1228 long ctl_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1229 unsigned int ctl_poll(struct file *filep, poll_table *wait);
1230 int ctl_fasync(int fd, struct file *filep, int mode);
1231 long ctl_ioctl_compat(struct file *file, unsigned cmd, unsigned long arg);
1232 void ctl_init(void);
1233 void ctl_exit(void);
1234 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1235         u32 reply);
1236 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1237 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1238         u8 msix_index, u32 reply);
1239 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1240         Mpi2EventNotificationReply_t *mpi_reply);
1241
1242 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1243         u8 bits_to_regsiter);
1244 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1245         u8 *issue_reset);
1246
1247 /* transport shared API */
1248 extern struct scsi_transport_template *mpt3sas_transport_template;
1249 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1250         u32 reply);
1251 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1252         u16 handle, u64 sas_address);
1253 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1254         u64 sas_address_parent);
1255 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1256         *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1257 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1258         struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1259         struct device *parent_dev);
1260 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1261         u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1262 extern struct sas_function_template mpt3sas_transport_functions;
1263 extern struct scsi_transport_template *mpt3sas_transport_template;
1264 extern int scsi_internal_device_block(struct scsi_device *sdev);
1265 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1266                                 enum scsi_device_state new_state);
1267 /* trigger data externs */
1268 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1269         struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1270 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1271         struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1272 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1273         u32 tigger_bitmask);
1274 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1275         u16 log_entry_qualifier);
1276 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1277         u8 asc, u8 ascq);
1278 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1279         u32 loginfo);
1280 #endif /* MPT3SAS_BASE_H_INCLUDED */