drivers/scsi/mpt2sas/mpt2sas_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/mpt2sas/mpt2_base.h
   6  * Copyright (C) 2007-2012  LSI Corporation
   7  *  (mailto:DL-MPTFusionLinux@lsi.com)
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * NO WARRANTY
  20  * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
  21  * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
  22  * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
  23  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
  24  * solely responsible for determining the appropriateness of using and
  25  * distributing the Program and assumes all risks associated with its
  26  * exercise of rights under this Agreement, including but not limited to
  27  * the risks and costs of program errors, damage to or loss of data,
  28  * programs or equipment, and unavailability or interruption of operations.
  29
  30  * DISCLAIMER OF LIABILITY
  31  * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
  32  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
  34  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  35  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  36  * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
  37  * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES
  38
  39  * You should have received a copy of the GNU General Public License
  40  * along with this program; if not, write to the Free Software
  41  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  42  * USA.
  43  */
  44
  45 #ifndef MPT2SAS_BASE_H_INCLUDED
  46 #define MPT2SAS_BASE_H_INCLUDED
  47
  48 #include "mpi/mpi2_type.h"
  49 #include "mpi/mpi2.h"
  50 #include "mpi/mpi2_ioc.h"
  51 #include "mpi/mpi2_cnfg.h"
  52 #include "mpi/mpi2_init.h"
  53 #include "mpi/mpi2_raid.h"
  54 #include "mpi/mpi2_tool.h"
  55 #include "mpi/mpi2_sas.h"
  56
  57 #include <scsi/scsi.h>
  58 #include <scsi/scsi_cmnd.h>
  59 #include <scsi/scsi_device.h>
  60 #include <scsi/scsi_host.h>
  61 #include <scsi/scsi_tcq.h>
  62 #include <scsi/scsi_transport_sas.h>
  63 #include <scsi/scsi_dbg.h>
  64 #include <scsi/scsi_eh.h>
  65
  66 #include "mpt2sas_debug.h"
  67
  68 /* driver versioning info */
  69 #define MPT2SAS_DRIVER_NAME             "mpt2sas"
  70 #define MPT2SAS_AUTHOR  "LSI Corporation <DL-MPTFusionLinux@lsi.com>"
  71 #define MPT2SAS_DESCRIPTION     "LSI MPT Fusion SAS 2.0 Device Driver"
  72 #define MPT2SAS_DRIVER_VERSION          "14.100.00.00"
  73 #define MPT2SAS_MAJOR_VERSION           14
  74 #define MPT2SAS_MINOR_VERSION           100
  75 #define MPT2SAS_BUILD_VERSION           00
  76 #define MPT2SAS_RELEASE_VERSION         00
  77
  78 /*
  79  * Set MPT2SAS_SG_DEPTH value based on user input.
  80  */
  81 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
  82 #if     CONFIG_SCSI_MPT2SAS_MAX_SGE  < 16
  83 #define MPT2SAS_SG_DEPTH       16
  84 #elif CONFIG_SCSI_MPT2SAS_MAX_SGE  > 128
  85 #define MPT2SAS_SG_DEPTH       128
  86 #else
  87 #define MPT2SAS_SG_DEPTH       CONFIG_SCSI_MPT2SAS_MAX_SGE
  88 #endif
  89 #else
  90 #define MPT2SAS_SG_DEPTH       128 /* MAX_HW_SEGMENTS */
  91 #endif
  92
  93
  94 /*
  95  * Generic Defines
  96  */
  97 #define MPT2SAS_SATA_QUEUE_DEPTH        32
  98 #define MPT2SAS_SAS_QUEUE_DEPTH         254
  99 #define MPT2SAS_RAID_QUEUE_DEPTH        128
 100
 101 #define MPT_NAME_LENGTH                 32      /* generic length of strings */
 102 #define MPT_STRING_LENGTH               64
 103
 104 #define MPT_MAX_CALLBACKS               16
 105
 106
 107 #define  CAN_SLEEP                      1
 108 #define  NO_SLEEP                       0
 109
 110 #define INTERNAL_CMDS_COUNT             10      /* reserved cmds */
 111
 112 #define MPI2_HIM_MASK                   0xFFFFFFFF /* mask every bit*/
 113
 114 #define MPT2SAS_INVALID_DEVICE_HANDLE   0xFFFF
 115
 116
 117 /*
 118  * reset phases
 119  */
 120 #define MPT2_IOC_PRE_RESET              1 /* prior to host reset */
 121 #define MPT2_IOC_AFTER_RESET            2 /* just after host reset */
 122 #define MPT2_IOC_DONE_RESET             3 /* links re-initialized */
 123
 124 /*
 125  * logging format
 126  */
 127 #define MPT2SAS_FMT                     "%s: "
 128 #define MPT2SAS_INFO_FMT                KERN_INFO MPT2SAS_FMT
 129 #define MPT2SAS_NOTE_FMT                KERN_NOTICE MPT2SAS_FMT
 130 #define MPT2SAS_WARN_FMT                KERN_WARNING MPT2SAS_FMT
 131 #define MPT2SAS_ERR_FMT                 KERN_ERR MPT2SAS_FMT
 132
 133 /*
 134  * Dell HBA branding
 135  */
 136 #define MPT2SAS_DELL_BRANDING_SIZE                 32
 137
 138 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
 139 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
 140 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
 141 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
 142 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
 143 #define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
 144 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
 145
 146 /*
 147  * Dell HBA SSDIDs
 148  */
 149 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID           0x1F1C
 150 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID       0x1F1D
 151 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID    0x1F1E
 152 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID       0x1F1F
 153 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID      0x1F20
 154 #define MPT2SAS_DELL_PERC_H200_SSDID               0x1F21
 155 #define MPT2SAS_DELL_6GBPS_SAS_SSDID               0x1F22
 156
 157 /*
 158  * Intel HBA branding
 159  */
 160 #define MPT2SAS_INTEL_RMS25JB080_BRANDING    \
 161                                 "Intel(R) Integrated RAID Module RMS25JB080"
 162 #define MPT2SAS_INTEL_RMS25JB040_BRANDING    \
 163                                 "Intel(R) Integrated RAID Module RMS25JB040"
 164 #define MPT2SAS_INTEL_RMS25KB080_BRANDING    \
 165                                 "Intel(R) Integrated RAID Module RMS25KB080"
 166 #define MPT2SAS_INTEL_RMS25KB040_BRANDING    \
 167                                 "Intel(R) Integrated RAID Module RMS25KB040"
 168 #define MPT2SAS_INTEL_RMS2LL080_BRANDING        \
 169                                 "Intel Integrated RAID Module RMS2LL080"
 170 #define MPT2SAS_INTEL_RMS2LL040_BRANDING        \
 171                                 "Intel Integrated RAID Module RMS2LL040"
 172 #define MPT2SAS_INTEL_RS25GB008_BRANDING       \
 173                                 "Intel(R) RAID Controller RS25GB008"
 174 #define MPT2SAS_INTEL_SSD910_BRANDING          \
 175                                 "Intel(R) SSD 910 Series"
 176 /*
 177  * Intel HBA SSDIDs
 178  */
 179 #define MPT2SAS_INTEL_RMS25JB080_SSDID         0x3516
 180 #define MPT2SAS_INTEL_RMS25JB040_SSDID         0x3517
 181 #define MPT2SAS_INTEL_RMS25KB080_SSDID         0x3518
 182 #define MPT2SAS_INTEL_RMS25KB040_SSDID         0x3519
 183 #define MPT2SAS_INTEL_RMS2LL080_SSDID          0x350E
 184 #define MPT2SAS_INTEL_RMS2LL040_SSDID          0x350F
 185 #define MPT2SAS_INTEL_RS25GB008_SSDID          0x3000
 186 #define MPT2SAS_INTEL_SSD910_SSDID             0x3700
 187
 188 /*
 189  * HP HBA branding
 190  */
 191 #define MPT2SAS_HP_3PAR_SSVID                0x1590
 192 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING        "HP H220 Host Bus Adapter"
 193 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING        "HP H221 Host Bus Adapter"
 194 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING "HP H222 Host Bus Adapter"
 195 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING    "HP H220i Host Bus Adapter"
 196 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING    "HP H210i Host Bus Adapter"
 197
 198 /*
 199  * HO HBA SSDIDs
 200  */
 201 #define MPT2SAS_HP_2_4_INTERNAL_SSDID            0x0041
 202 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID            0x0042
 203 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID    0x0043
 204 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID        0x0044
 205 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID        0x0046
 206
 207 /*
 208  *  WarpDrive Specific Log codes
 209  */
 210
 211 #define MPT2_WARPDRIVE_LOGENTRY         (0x8002)
 212 #define MPT2_WARPDRIVE_LC_SSDT          (0x41)
 213 #define MPT2_WARPDRIVE_LC_SSDLW         (0x43)
 214 #define MPT2_WARPDRIVE_LC_SSDLF         (0x44)
 215 #define MPT2_WARPDRIVE_LC_BRMF          (0x4D)
 216
 217 /*
 218  * per target private data
 219  */
 220 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
 221 #define MPT_TARGET_FLAGS_VOLUME         0x02
 222 #define MPT_TARGET_FLAGS_DELETED        0x04
 223
 224 /**
 225  * struct MPT2SAS_TARGET - starget private hostdata
 226  * @starget: starget object
 227  * @sas_address: target sas address
 228  * @raid_device: raid_device pointer to access volume data
 229  * @handle: device handle
 230  * @num_luns: number luns
 231  * @flags: MPT_TARGET_FLAGS_XXX flags
 232  * @deleted: target flaged for deletion
 233  * @tm_busy: target is busy with TM request.
 234  */
 235 struct MPT2SAS_TARGET {
 236         struct scsi_target *starget;
 237         u64     sas_address;
 238         struct _raid_device *raid_device;
 239         u16     handle;
 240         int     num_luns;
 241         u32     flags;
 242         u8      deleted;
 243         u8      tm_busy;
 244 };
 245
 246
 247 /*
 248  * per device private data
 249  */
 250 #define MPT_DEVICE_FLAGS_INIT           0x01
 251 #define MPT_DEVICE_TLR_ON               0x02
 252
 253 /**
 254  * struct MPT2SAS_DEVICE - sdev private hostdata
 255  * @sas_target: starget private hostdata
 256  * @lun: lun number
 257  * @flags: MPT_DEVICE_XXX flags
 258  * @configured_lun: lun is configured
 259  * @block: device is in SDEV_BLOCK state
 260  * @tlr_snoop_check: flag used in determining whether to disable TLR
 261  */
 262
 263 /* OEM Identifiers */
 264 #define MFG10_OEM_ID_INVALID                   (0x00000000)
 265 #define MFG10_OEM_ID_DELL                      (0x00000001)
 266 #define MFG10_OEM_ID_FSC                       (0x00000002)
 267 #define MFG10_OEM_ID_SUN                       (0x00000003)
 268 #define MFG10_OEM_ID_IBM                       (0x00000004)
 269
 270 /* GENERIC Flags 0*/
 271 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
 272 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
 273 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
 274 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
 275 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
 276
 277 /* OEM Specific Flags will come from OEM specific header files */
 278 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
 279     MPI2_CONFIG_PAGE_HEADER Header;                                 /* 00h */
 280     U8                      OEMIdentifier;                          /* 04h */
 281     U8                      Reserved1;                              /* 05h */
 282     U16                     Reserved2;                              /* 08h */
 283     U32                     Reserved3;                              /* 0Ch */
 284     U32                     GenericFlags0;                          /* 10h */
 285     U32                     GenericFlags1;                          /* 14h */
 286     U32                     Reserved4;                              /* 18h */
 287     U32                     OEMSpecificFlags0;                      /* 1Ch */
 288     U32                     OEMSpecificFlags1;                      /* 20h */
 289     U32                     Reserved5[18];                          /* 24h-60h*/
 290 } MPI2_CONFIG_PAGE_MAN_10,
 291   MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
 292   Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
 293
 294 #define MFG_PAGE10_HIDE_SSDS_MASK       (0x00000003)
 295 #define MFG_PAGE10_HIDE_ALL_DISKS       (0x00)
 296 #define MFG_PAGE10_EXPOSE_ALL_DISKS     (0x01)
 297 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT  (0x02)
 298
 299
 300 struct MPT2SAS_DEVICE {
 301         struct MPT2SAS_TARGET *sas_target;
 302         unsigned int    lun;
 303         u32     flags;
 304         u8      configured_lun;
 305         u8      block;
 306         u8      tlr_snoop_check;
 307 };
 308
 309 #define MPT2_CMD_NOT_USED       0x8000  /* free */
 310 #define MPT2_CMD_COMPLETE       0x0001  /* completed */
 311 #define MPT2_CMD_PENDING        0x0002  /* pending */
 312 #define MPT2_CMD_REPLY_VALID    0x0004  /* reply is valid */
 313 #define MPT2_CMD_RESET          0x0008  /* host reset dropped the command */
 314
 315 /**
 316  * struct _internal_cmd - internal commands struct
 317  * @mutex: mutex
 318  * @done: completion
 319  * @reply: reply message pointer
 320  * @sense: sense data
 321  * @status: MPT2_CMD_XXX status
 322  * @smid: system message id
 323  */
 324 struct _internal_cmd {
 325         struct mutex mutex;
 326         struct completion done;
 327         void    *reply;
 328         void    *sense;
 329         u16     status;
 330         u16     smid;
 331 };
 332
 333
 334 /**
 335  * struct _sas_device - attached device information
 336  * @list: sas device list
 337  * @starget: starget object
 338  * @sas_address: device sas address
 339  * @device_name: retrieved from the SAS IDENTIFY frame.
 340  * @handle: device handle
 341  * @sas_address_parent: sas address of parent expander or sas host
 342  * @enclosure_handle: enclosure handle
 343  * @enclosure_logical_id: enclosure logical identifier
 344  * @volume_handle: volume handle (valid when hidden raid member)
 345  * @volume_wwid: volume unique identifier
 346  * @device_info: bitfield provides detailed info about the device
 347  * @id: target id
 348  * @channel: target channel
 349  * @slot: number number
 350  * @phy: phy identifier provided in sas device page 0
 351  * @responding: used in _scsih_sas_device_mark_responding
 352  */
 353 struct _sas_device {
 354         struct list_head list;
 355         struct scsi_target *starget;
 356         u64     sas_address;
 357         u64     device_name;
 358         u16     handle;
 359         u64     sas_address_parent;
 360         u16     enclosure_handle;
 361         u64     enclosure_logical_id;
 362         u16     volume_handle;
 363         u64     volume_wwid;
 364         u32     device_info;
 365         int     id;
 366         int     channel;
 367         u16     slot;
 368         u8      phy;
 369         u8      responding;
 370 };
 371
 372 /**
 373  * struct _raid_device - raid volume link list
 374  * @list: sas device list
 375  * @starget: starget object
 376  * @sdev: scsi device struct (volumes are single lun)
 377  * @wwid: unique identifier for the volume
 378  * @handle: device handle
 379  * @block_size: Block size of the volume
 380  * @id: target id
 381  * @channel: target channel
 382  * @volume_type: the raid level
 383  * @device_info: bitfield provides detailed info about the hidden components
 384  * @num_pds: number of hidden raid components
 385  * @responding: used in _scsih_raid_device_mark_responding
 386  * @percent_complete: resync percent complete
 387  * @direct_io_enabled: Whether direct io to PDs are allowed or not
 388  * @stripe_exponent: X where 2powX is the stripe sz in blocks
 389  * @block_exponent: X where 2powX is the block sz in bytes
 390  * @max_lba: Maximum number of LBA in the volume
 391  * @stripe_sz: Stripe Size of the volume
 392  * @device_info: Device info of the volume member disk
 393  * @pd_handle: Array of handles of the physical drives for direct I/O in le16
 394  */
 395 #define MPT_MAX_WARPDRIVE_PDS           8
 396 struct _raid_device {
 397         struct list_head list;
 398         struct scsi_target *starget;
 399         struct scsi_device *sdev;
 400         u64     wwid;
 401         u16     handle;
 402         u16     block_sz;
 403         int     id;
 404         int     channel;
 405         u8      volume_type;
 406         u8      num_pds;
 407         u8      responding;
 408         u8      percent_complete;
 409         u8      direct_io_enabled;
 410         u8      stripe_exponent;
 411         u8      block_exponent;
 412         u64     max_lba;
 413         u32     stripe_sz;
 414         u32     device_info;
 415         u16     pd_handle[MPT_MAX_WARPDRIVE_PDS];
 416 };
 417
 418 /**
 419  * struct _boot_device - boot device info
 420  * @is_raid: flag to indicate whether this is volume
 421  * @device: holds pointer for either struct _sas_device or
 422  *     struct _raid_device
 423  */
 424 struct _boot_device {
 425         u8 is_raid;
 426         void *device;
 427 };
 428
 429 /**
 430  * struct _sas_port - wide/narrow sas port information
 431  * @port_list: list of ports belonging to expander
 432  * @num_phys: number of phys belonging to this port
 433  * @remote_identify: attached device identification
 434  * @rphy: sas transport rphy object
 435  * @port: sas transport wide/narrow port object
 436  * @phy_list: _sas_phy list objects belonging to this port
 437  */
 438 struct _sas_port {
 439         struct list_head port_list;
 440         u8      num_phys;
 441         struct sas_identify remote_identify;
 442         struct sas_rphy *rphy;
 443         struct sas_port *port;
 444         struct list_head phy_list;
 445 };
 446
 447 /**
 448  * struct _sas_phy - phy information
 449  * @port_siblings: list of phys belonging to a port
 450  * @identify: phy identification
 451  * @remote_identify: attached device identification
 452  * @phy: sas transport phy object
 453  * @phy_id: unique phy id
 454  * @handle: device handle for this phy
 455  * @attached_handle: device handle for attached device
 456  * @phy_belongs_to_port: port has been created for this phy
 457  */
 458 struct _sas_phy {
 459         struct list_head port_siblings;
 460         struct sas_identify identify;
 461         struct sas_identify remote_identify;
 462         struct sas_phy *phy;
 463         u8      phy_id;
 464         u16     handle;
 465         u16     attached_handle;
 466         u8      phy_belongs_to_port;
 467 };
 468
 469 /**
 470  * struct _sas_node - sas_host/expander information
 471  * @list: list of expanders
 472  * @parent_dev: parent device class
 473  * @num_phys: number phys belonging to this sas_host/expander
 474  * @sas_address: sas address of this sas_host/expander
 475  * @handle: handle for this sas_host/expander
 476  * @sas_address_parent: sas address of parent expander or sas host
 477  * @enclosure_handle: handle for this a member of an enclosure
 478  * @device_info: bitwise defining capabilities of this sas_host/expander
 479  * @responding: used in _scsih_expander_device_mark_responding
 480  * @phy: a list of phys that make up this sas_host/expander
 481  * @sas_port_list: list of ports attached to this sas_host/expander
 482  */
 483 struct _sas_node {
 484         struct list_head list;
 485         struct device *parent_dev;
 486         u8      num_phys;
 487         u64     sas_address;
 488         u16     handle;
 489         u64     sas_address_parent;
 490         u16     enclosure_handle;
 491         u64     enclosure_logical_id;
 492         u8      responding;
 493         struct  _sas_phy *phy;
 494         struct list_head sas_port_list;
 495 };
 496
 497 /**
 498  * enum reset_type - reset state
 499  * @FORCE_BIG_HAMMER: issue diagnostic reset
 500  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
 501  */
 502 enum reset_type {
 503         FORCE_BIG_HAMMER,
 504         SOFT_RESET,
 505 };
 506
 507 /**
 508  * struct chain_tracker - firmware chain tracker
 509  * @chain_buffer: chain buffer
 510  * @chain_buffer_dma: physical address
 511  * @tracker_list: list of free request (ioc->free_chain_list)
 512  */
 513 struct chain_tracker {
 514         void *chain_buffer;
 515         dma_addr_t chain_buffer_dma;
 516         struct list_head tracker_list;
 517 };
 518
 519 /**
 520  * struct scsiio_tracker - scsi mf request tracker
 521  * @smid: system message id
 522  * @scmd: scsi request pointer
 523  * @cb_idx: callback index
 524  * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
 525  * @chain_list: list of chains associated to this IO
 526  * @tracker_list: list of free request (ioc->free_list)
 527  */
 528 struct scsiio_tracker {
 529         u16     smid;
 530         struct scsi_cmnd *scmd;
 531         u8      cb_idx;
 532         u8      direct_io;
 533         struct list_head chain_list;
 534         struct list_head tracker_list;
 535 };
 536
 537 /**
 538  * struct request_tracker - firmware request tracker
 539  * @smid: system message id
 540  * @cb_idx: callback index
 541  * @tracker_list: list of free request (ioc->free_list)
 542  */
 543 struct request_tracker {
 544         u16     smid;
 545         u8      cb_idx;
 546         struct list_head tracker_list;
 547 };
 548
 549 /**
 550  * struct _tr_list - target reset list
 551  * @handle: device handle
 552  * @state: state machine
 553  */
 554 struct _tr_list {
 555         struct list_head list;
 556         u16     handle;
 557         u16     state;
 558 };
 559
 560 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
 561
 562 /**
 563  * struct adapter_reply_queue - the reply queue struct
 564  * @ioc: per adapter object
 565  * @msix_index: msix index into vector table
 566  * @vector: irq vector
 567  * @reply_post_host_index: head index in the pool where FW completes IO
 568  * @reply_post_free: reply post base virt address
 569  * @name: the name registered to request_irq()
 570  * @busy: isr is actively processing replies on another cpu
 571  * @list: this list
 572 */
 573 struct adapter_reply_queue {
 574         struct MPT2SAS_ADAPTER  *ioc;
 575         u8                      msix_index;
 576         unsigned int            vector;
 577         u32                     reply_post_host_index;
 578         Mpi2ReplyDescriptorsUnion_t *reply_post_free;
 579         char                    name[MPT_NAME_LENGTH];
 580         atomic_t                busy;
 581         struct list_head        list;
 582 };
 583
 584 /* IOC Facts and Port Facts converted from little endian to cpu */
 585 union mpi2_version_union {
 586         MPI2_VERSION_STRUCT             Struct;
 587         u32                             Word;
 588 };
 589
 590 struct mpt2sas_facts {
 591         u16                     MsgVersion;
 592         u16                     HeaderVersion;
 593         u8                      IOCNumber;
 594         u8                      VP_ID;
 595         u8                      VF_ID;
 596         u16                     IOCExceptions;
 597         u16                     IOCStatus;
 598         u32                     IOCLogInfo;
 599         u8                      MaxChainDepth;
 600         u8                      WhoInit;
 601         u8                      NumberOfPorts;
 602         u8                      MaxMSIxVectors;
 603         u16                     RequestCredit;
 604         u16                     ProductID;
 605         u32                     IOCCapabilities;
 606         union mpi2_version_union        FWVersion;
 607         u16                     IOCRequestFrameSize;
 608         u16                     Reserved3;
 609         u16                     MaxInitiators;
 610         u16                     MaxTargets;
 611         u16                     MaxSasExpanders;
 612         u16                     MaxEnclosures;
 613         u16                     ProtocolFlags;
 614         u16                     HighPriorityCredit;
 615         u16                     MaxReplyDescriptorPostQueueDepth;
 616         u8                      ReplyFrameSize;
 617         u8                      MaxVolumes;
 618         u16                     MaxDevHandle;
 619         u16                     MaxPersistentEntries;
 620         u16                     MinDevHandle;
 621 };
 622
 623 struct mpt2sas_port_facts {
 624         u8                      PortNumber;
 625         u8                      VP_ID;
 626         u8                      VF_ID;
 627         u8                      PortType;
 628         u16                     MaxPostedCmdBuffers;
 629 };
 630
 631 /**
 632  * enum mutex_type - task management mutex type
 633  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
 634  * @TM_MUTEX_ON: mutex is required
 635  */
 636 enum mutex_type {
 637         TM_MUTEX_OFF = 0,
 638         TM_MUTEX_ON = 1,
 639 };
 640
 641 typedef void (*MPT2SAS_FLUSH_RUNNING_CMDS)(struct MPT2SAS_ADAPTER *ioc);
 642 /**
 643  * struct MPT2SAS_ADAPTER - per adapter struct
 644  * @list: ioc_list
 645  * @shost: shost object
 646  * @id: unique adapter id
 647  * @cpu_count: number online cpus
 648  * @name: generic ioc string
 649  * @tmp_string: tmp string used for logging
 650  * @pdev: pci pdev object
 651  * @chip: memory mapped register space
 652  * @chip_phys: physical addrss prior to mapping
 653  * @logging_level: see mpt2sas_debug.h
 654  * @fwfault_debug: debuging FW timeouts
 655  * @ir_firmware: IR firmware present
 656  * @bars: bitmask of BAR's that must be configured
 657  * @mask_interrupts: ignore interrupt
 658  * @fault_reset_work_q_name: fw fault work queue
 659  * @fault_reset_work_q: ""
 660  * @fault_reset_work: ""
 661  * @firmware_event_name: fw event work queue
 662  * @firmware_event_thread: ""
 663  * @fw_events_off: flag to turn off fw event handling
 664  * @fw_event_lock:
 665  * @fw_event_list: list of fw events
 666  * @aen_event_read_flag: event log was read
 667  * @broadcast_aen_busy: broadcast aen waiting to be serviced
 668  * @shost_recovery: host reset in progress
 669  * @ioc_reset_in_progress_lock:
 670  * @ioc_link_reset_in_progress: phy/hard reset in progress
 671  * @ignore_loginfos: ignore loginfos during task management
 672  * @remove_host: flag for when driver unloads, to avoid sending dev resets
 673  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
 674  * @wait_for_discovery_to_complete: flag set at driver load time when
 675  *                                               waiting on reporting devices
 676  * @is_driver_loading: flag set at driver load time
 677  * @port_enable_failed: flag set when port enable has failed
 678  * @start_scan: flag set from scan_start callback, cleared from _mpt2sas_fw_work
 679  * @start_scan_failed: means port enable failed, return's the ioc_status
 680  * @msix_enable: flag indicating msix is enabled
 681  * @msix_vector_count: number msix vectors
 682  * @cpu_msix_table: table for mapping cpus to msix index
 683  * @cpu_msix_table_sz: table size
 684  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
 685  * @scsi_io_cb_idx: shost generated commands
 686  * @tm_cb_idx: task management commands
 687  * @scsih_cb_idx: scsih internal commands
 688  * @transport_cb_idx: transport internal commands
 689  * @ctl_cb_idx: clt internal commands
 690  * @base_cb_idx: base internal commands
 691  * @config_cb_idx: base internal commands
 692  * @tm_tr_cb_idx : device removal target reset handshake
 693  * @tm_tr_volume_cb_idx : volume removal target reset
 694  * @base_cmds:
 695  * @transport_cmds:
 696  * @scsih_cmds:
 697  * @tm_cmds:
 698  * @ctl_cmds:
 699  * @config_cmds:
 700  * @base_add_sg_single: handler for either 32/64 bit sgl's
 701  * @event_type: bits indicating which events to log
 702  * @event_context: unique id for each logged event
 703  * @event_log: event log pointer
 704  * @event_masks: events that are masked
 705  * @facts: static facts data
 706  * @pfacts: static port facts data
 707  * @manu_pg0: static manufacturing page 0
 708  * @manu_pg10: static manufacturing page 10
 709  * @bios_pg2: static bios page 2
 710  * @bios_pg3: static bios page 3
 711  * @ioc_pg8: static ioc page 8
 712  * @iounit_pg0: static iounit page 0
 713  * @iounit_pg1: static iounit page 1
 714  * @sas_hba: sas host object
 715  * @sas_expander_list: expander object list
 716  * @sas_node_lock:
 717  * @sas_device_list: sas device object list
 718  * @sas_device_init_list: sas device object list (used only at init time)
 719  * @sas_device_lock:
 720  * @io_missing_delay: time for IO completed by fw when PDR enabled
 721  * @device_missing_delay: time for device missing by fw when PDR enabled
 722  * @sas_id : used for setting volume target IDs
 723  * @blocking_handles: bitmask used to identify which devices need blocking
 724  * @pd_handles : bitmask for PD handles
 725  * @pd_handles_sz : size of pd_handle bitmask
 726  * @config_page_sz: config page size
 727  * @config_page: reserve memory for config page payload
 728  * @config_page_dma:
 729  * @hba_queue_depth: hba request queue depth
 730  * @sge_size: sg element size for either 32/64 bit
 731  * @scsiio_depth: SCSI_IO queue depth
 732  * @request_sz: per request frame size
 733  * @request: pool of request frames
 734  * @request_dma:
 735  * @request_dma_sz:
 736  * @scsi_lookup: firmware request tracker list
 737  * @scsi_lookup_lock:
 738  * @free_list: free list of request
 739  * @chain: pool of chains
 740  * @pending_io_count:
 741  * @reset_wq:
 742  * @chain_dma:
 743  * @max_sges_in_main_message: number sg elements in main message
 744  * @max_sges_in_chain_message: number sg elements per chain
 745  * @chains_needed_per_io: max chains per io
 746  * @chain_offset_value_for_main_message: location 1st sg in main
 747  * @chain_depth: total chains allocated
 748  * @hi_priority_smid:
 749  * @hi_priority:
 750  * @hi_priority_dma:
 751  * @hi_priority_depth:
 752  * @hpr_lookup:
 753  * @hpr_free_list:
 754  * @internal_smid:
 755  * @internal:
 756  * @internal_dma:
 757  * @internal_depth:
 758  * @internal_lookup:
 759  * @internal_free_list:
 760  * @sense: pool of sense
 761  * @sense_dma:
 762  * @sense_dma_pool:
 763  * @reply_depth: hba reply queue depth:
 764  * @reply_sz: per reply frame size:
 765  * @reply: pool of replys:
 766  * @reply_dma:
 767  * @reply_dma_pool:
 768  * @reply_free_queue_depth: reply free depth
 769  * @reply_free: pool for reply free queue (32 bit addr)
 770  * @reply_free_dma:
 771  * @reply_free_dma_pool:
 772  * @reply_free_host_index: tail index in pool to insert free replys
 773  * @reply_post_queue_depth: reply post queue depth
 774  * @reply_post_free: pool for reply post (64bit descriptor)
 775  * @reply_post_free_dma:
 776  * @reply_queue_count: number of reply queue's
 777  * @reply_queue_list: link list contaning the reply queue info
 778  * @reply_post_host_index: head index in the pool where FW completes IO
 779  * @delayed_tr_list: target reset link list
 780  * @delayed_tr_volume_list: volume target reset link list
 781  */
 782 struct MPT2SAS_ADAPTER {
 783         struct list_head list;
 784         struct Scsi_Host *shost;
 785         u8              id;
 786         int             cpu_count;
 787         char            name[MPT_NAME_LENGTH];
 788         char            tmp_string[MPT_STRING_LENGTH];
 789         struct pci_dev  *pdev;
 790         Mpi2SystemInterfaceRegs_t __iomem *chip;
 791         resource_size_t chip_phys;
 792         int             logging_level;
 793         int             fwfault_debug;
 794         u8              ir_firmware;
 795         int             bars;
 796         u8              mask_interrupts;
 797
 798         /* fw fault handler */
 799         char            fault_reset_work_q_name[20];
 800         struct workqueue_struct *fault_reset_work_q;
 801         struct delayed_work fault_reset_work;
 802
 803         /* fw event handler */
 804         char            firmware_event_name[20];
 805         struct workqueue_struct *firmware_event_thread;
 806         spinlock_t      fw_event_lock;
 807         struct list_head fw_event_list;
 808
 809          /* misc flags */
 810         int             aen_event_read_flag;
 811         u8              broadcast_aen_busy;
 812         u16             broadcast_aen_pending;
 813         u8              shost_recovery;
 814
 815         struct mutex    reset_in_progress_mutex;
 816         spinlock_t      ioc_reset_in_progress_lock;
 817         u8              ioc_link_reset_in_progress;
 818         u8              ioc_reset_in_progress_status;
 819
 820         u8              ignore_loginfos;
 821         u8              remove_host;
 822         u8              pci_error_recovery;
 823         u8              wait_for_discovery_to_complete;
 824         struct completion       port_enable_done;
 825         u8              is_driver_loading;
 826         u8              port_enable_failed;
 827
 828         u8              start_scan;
 829         u16             start_scan_failed;
 830
 831         u8              msix_enable;
 832         u16             msix_vector_count;
 833         u8              *cpu_msix_table;
 834         resource_size_t **reply_post_host_index;
 835         u16             cpu_msix_table_sz;
 836         u32             ioc_reset_count;
 837         MPT2SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
 838
 839         /* internal commands, callback index */
 840         u8              scsi_io_cb_idx;
 841         u8              tm_cb_idx;
 842         u8              transport_cb_idx;
 843         u8              scsih_cb_idx;
 844         u8              ctl_cb_idx;
 845         u8              base_cb_idx;
 846         u8              port_enable_cb_idx;
 847         u8              config_cb_idx;
 848         u8              tm_tr_cb_idx;
 849         u8              tm_tr_volume_cb_idx;
 850         u8              tm_sas_control_cb_idx;
 851         struct _internal_cmd base_cmds;
 852         struct _internal_cmd port_enable_cmds;
 853         struct _internal_cmd transport_cmds;
 854         struct _internal_cmd scsih_cmds;
 855         struct _internal_cmd tm_cmds;
 856         struct _internal_cmd ctl_cmds;
 857         struct _internal_cmd config_cmds;
 858
 859         MPT_ADD_SGE     base_add_sg_single;
 860
 861         /* event log */
 862         u32             event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 863         u32             event_context;
 864         void            *event_log;
 865         u32             event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 866
 867         /* static config pages */
 868         struct mpt2sas_facts facts;
 869         struct mpt2sas_port_facts *pfacts;
 870         Mpi2ManufacturingPage0_t manu_pg0;
 871         Mpi2BiosPage2_t bios_pg2;
 872         Mpi2BiosPage3_t bios_pg3;
 873         Mpi2IOCPage8_t ioc_pg8;
 874         Mpi2IOUnitPage0_t iounit_pg0;
 875         Mpi2IOUnitPage1_t iounit_pg1;
 876
 877         struct _boot_device req_boot_device;
 878         struct _boot_device req_alt_boot_device;
 879         struct _boot_device current_boot_device;
 880
 881         /* sas hba, expander, and device list */
 882         struct _sas_node sas_hba;
 883         struct list_head sas_expander_list;
 884         spinlock_t      sas_node_lock;
 885         struct list_head sas_device_list;
 886         struct list_head sas_device_init_list;
 887         spinlock_t      sas_device_lock;
 888         struct list_head raid_device_list;
 889         spinlock_t      raid_device_lock;
 890         u8              io_missing_delay;
 891         u16             device_missing_delay;
 892         int             sas_id;
 893         void            *blocking_handles;
 894         void            *pd_handles;
 895         u16             pd_handles_sz;
 896
 897         /* config page */
 898         u16             config_page_sz;
 899         void            *config_page;
 900         dma_addr_t      config_page_dma;
 901
 902         /* scsiio request */
 903         u16             hba_queue_depth;
 904         u16             sge_size;
 905         u16             scsiio_depth;
 906         u16             request_sz;
 907         u8              *request;
 908         dma_addr_t      request_dma;
 909         u32             request_dma_sz;
 910         struct scsiio_tracker *scsi_lookup;
 911         ulong           scsi_lookup_pages;
 912         spinlock_t      scsi_lookup_lock;
 913         struct list_head free_list;
 914         int             pending_io_count;
 915         wait_queue_head_t reset_wq;
 916
 917         /* chain */
 918         struct chain_tracker *chain_lookup;
 919         struct list_head free_chain_list;
 920         struct dma_pool *chain_dma_pool;
 921         ulong           chain_pages;
 922         u16             max_sges_in_main_message;
 923         u16             max_sges_in_chain_message;
 924         u16             chains_needed_per_io;
 925         u16             chain_offset_value_for_main_message;
 926         u32             chain_depth;
 927
 928         /* hi-priority queue */
 929         u16             hi_priority_smid;
 930         u8              *hi_priority;
 931         dma_addr_t      hi_priority_dma;
 932         u16             hi_priority_depth;
 933         struct request_tracker *hpr_lookup;
 934         struct list_head hpr_free_list;
 935
 936         /* internal queue */
 937         u16             internal_smid;
 938         u8              *internal;
 939         dma_addr_t      internal_dma;
 940         u16             internal_depth;
 941         struct request_tracker *internal_lookup;
 942         struct list_head internal_free_list;
 943
 944         /* sense */
 945         u8              *sense;
 946         dma_addr_t      sense_dma;
 947         struct dma_pool *sense_dma_pool;
 948
 949         /* reply */
 950         u16             reply_sz;
 951         u8              *reply;
 952         dma_addr_t      reply_dma;
 953         u32             reply_dma_max_address;
 954         u32             reply_dma_min_address;
 955         struct dma_pool *reply_dma_pool;
 956
 957         /* reply free queue */
 958         u16             reply_free_queue_depth;
 959         __le32          *reply_free;
 960         dma_addr_t      reply_free_dma;
 961         struct dma_pool *reply_free_dma_pool;
 962         u32             reply_free_host_index;
 963
 964         /* reply post queue */
 965         u16             reply_post_queue_depth;
 966         Mpi2ReplyDescriptorsUnion_t *reply_post_free;
 967         dma_addr_t      reply_post_free_dma;
 968         struct dma_pool *reply_post_free_dma_pool;
 969         u8              reply_queue_count;
 970         struct list_head reply_queue_list;
 971
 972         struct list_head delayed_tr_list;
 973         struct list_head delayed_tr_volume_list;
 974
 975         /* diag buffer support */
 976         u8              *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
 977         u32             diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
 978         dma_addr_t      diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
 979         u8              diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
 980         u32             unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
 981         Mpi2ManufacturingPage10_t manu_pg10;
 982         u32             product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
 983         u32             diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
 984         u32             ring_buffer_offset;
 985         u32             ring_buffer_sz;
 986         u8              is_warpdrive;
 987         u8              hide_ir_msg;
 988         u8              mfg_pg10_hide_flag;
 989         u8              hide_drives;
 990
 991 };
 992
 993 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 994     u32 reply);
 995
 996
 997 /* base shared API */
 998 extern struct list_head mpt2sas_ioc_list;
 999 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
1000 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
1001
1002 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
1003 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
1004 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
1005 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
1006 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
1007     enum reset_type type);
1008
1009 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1010 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1011 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
1012 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
1013     u16 smid);
1014 void mpt2sas_base_flush_reply_queues(struct MPT2SAS_ADAPTER *ioc);
1015
1016 /* hi-priority queue */
1017 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1018 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
1019     struct scsi_cmnd *scmd);
1020
1021 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
1022 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1023 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1024     u16 handle);
1025 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1026 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1027     u16 io_index);
1028 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
1029 void mpt2sas_base_initialize_callback_handler(void);
1030 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1031 void mpt2sas_base_release_callback_handler(u8 cb_idx);
1032
1033 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1034     u32 reply);
1035 u8 mpt2sas_port_enable_done(struct MPT2SAS_ADAPTER *ioc, u16 smid,
1036         u8 msix_index,  u32 reply);
1037 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
1038
1039 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
1040
1041 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
1042 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
1043     Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
1044     *mpi_request);
1045 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
1046     Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1047 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
1048
1049 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
1050
1051 int mpt2sas_port_enable(struct MPT2SAS_ADAPTER *ioc);
1052
1053 /* scsih shared API */
1054 u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1055     u32 reply);
1056 int mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle,
1057         uint channel, uint id, uint lun, u8 type, u16 smid_task,
1058         ulong timeout, unsigned long serial_number, enum mutex_type m_type);
1059 void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1060 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
1061 void mpt2sas_expander_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1062 void mpt2sas_device_remove_by_sas_address(struct MPT2SAS_ADAPTER *ioc,
1063                 u64 sas_address);
1064 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
1065     u16 handle);
1066 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
1067     *ioc, u64 sas_address);
1068 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
1069     struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
1070
1071 void mpt2sas_port_enable_complete(struct MPT2SAS_ADAPTER *ioc);
1072
1073 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1074
1075 /* config shared API */
1076 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1077     u32 reply);
1078 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
1079 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
1080     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1081 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
1082     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
1083 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1084     *mpi_reply, Mpi2BiosPage2_t *config_page);
1085 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1086     *mpi_reply, Mpi2BiosPage3_t *config_page);
1087 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1088     *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1089 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1090     *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
1091 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1092     *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
1093 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1094     *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
1095 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1096     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1097 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1098     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1099 int mpt2sas_config_get_iounit_pg3(struct MPT2SAS_ADAPTER *ioc,
1100         Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage3_t *config_page, u16 sz);
1101 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1102     *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1103 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
1104     Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
1105 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1106     *mpi_reply, Mpi2IOCPage8_t *config_page);
1107 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1108     *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
1109 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1110     *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
1111 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1112     *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
1113 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1114     *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1115 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1116     *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1117 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1118     *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
1119 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
1120 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1121     *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
1122 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1123     *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
1124     u32 form_specific);
1125 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
1126     u16 *volume_handle);
1127 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
1128     u64 *wwid);
1129 /* ctl shared API */
1130 extern struct device_attribute *mpt2sas_host_attrs[];
1131 extern struct device_attribute *mpt2sas_dev_attrs[];
1132 void mpt2sas_ctl_init(void);
1133 void mpt2sas_ctl_exit(void);
1134 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1135     u32 reply);
1136 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
1137 u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
1138     u32 reply);
1139 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
1140     Mpi2EventNotificationReply_t *mpi_reply);
1141
1142 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
1143         u8 bits_to_regsiter);
1144
1145 /* transport shared API */
1146 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1147     u32 reply);
1148 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
1149      u16 handle, u64 sas_address);
1150 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
1151      u64 sas_address_parent);
1152 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1153     *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1154 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
1155     *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
1156 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
1157      u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1158 extern struct sas_function_template mpt2sas_transport_functions;
1159 extern struct scsi_transport_template *mpt2sas_transport_template;
1160 extern int scsi_internal_device_block(struct scsi_device *sdev);
1161 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
1162     u8 msix_index, u32 reply);
1163 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1164                                         enum scsi_device_state new_state);
1165
1166 #endif /* MPT2SAS_BASE_H_INCLUDED */