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 MPT3SAS_AUTHOR "Avago Technologies <MPT-FusionLinux.pdl@avagotech.com>"
  75 #define MPT3SAS_DESCRIPTION     "LSI MPT Fusion SAS 3.0 Device Driver"
  76 #define MPT3SAS_DRIVER_VERSION          "09.102.00.00"
  77 #define MPT3SAS_MAJOR_VERSION           9
  78 #define MPT3SAS_MINOR_VERSION           102
  79 #define MPT3SAS_BUILD_VERSION           0
  80 #define MPT3SAS_RELEASE_VERSION 00
  81
  82 #define MPT2SAS_DRIVER_NAME             "mpt2sas"
  83 #define MPT2SAS_DESCRIPTION     "LSI MPT Fusion SAS 2.0 Device Driver"
  84 #define MPT2SAS_DRIVER_VERSION          "20.102.00.00"
  85 #define MPT2SAS_MAJOR_VERSION           20
  86 #define MPT2SAS_MINOR_VERSION           102
  87 #define MPT2SAS_BUILD_VERSION           0
  88 #define MPT2SAS_RELEASE_VERSION 00
  89
  90 /*
  91  * Set MPT3SAS_SG_DEPTH value based on user input.
  92  */
  93 #define MPT_MAX_PHYS_SEGMENTS   SCSI_MAX_SG_SEGMENTS
  94 #define MPT_MIN_PHYS_SEGMENTS   16
  95
  96 #ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE
  97 #define MPT3SAS_SG_DEPTH                CONFIG_SCSI_MPT3SAS_MAX_SGE
  98 #else
  99 #define MPT3SAS_SG_DEPTH                MPT_MAX_PHYS_SEGMENTS
 100 #endif
 101
 102 #ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE
 103 #define MPT2SAS_SG_DEPTH                CONFIG_SCSI_MPT2SAS_MAX_SGE
 104 #else
 105 #define MPT2SAS_SG_DEPTH                MPT_MAX_PHYS_SEGMENTS
 106 #endif
 107
 108 /*
 109  * Generic Defines
 110  */
 111 #define MPT3SAS_SATA_QUEUE_DEPTH        32
 112 #define MPT3SAS_SAS_QUEUE_DEPTH         254
 113 #define MPT3SAS_RAID_QUEUE_DEPTH        128
 114
 115 #define MPT_NAME_LENGTH                 32      /* generic length of strings */
 116 #define MPT_STRING_LENGTH               64
 117
 118 #define MPT_MAX_CALLBACKS               32
 119
 120
 121 #define  CAN_SLEEP                      1
 122 #define  NO_SLEEP                       0
 123
 124 #define INTERNAL_CMDS_COUNT             10      /* reserved cmds */
 125
 126 #define MPI3_HIM_MASK                   0xFFFFFFFF /* mask every bit*/
 127
 128 #define MPT3SAS_INVALID_DEVICE_HANDLE   0xFFFF
 129
 130 /*
 131  * reset phases
 132  */
 133 #define MPT3_IOC_PRE_RESET              1 /* prior to host reset */
 134 #define MPT3_IOC_AFTER_RESET            2 /* just after host reset */
 135 #define MPT3_IOC_DONE_RESET             3 /* links re-initialized */
 136
 137 /*
 138  * logging format
 139  */
 140 #define MPT3SAS_FMT                     "%s: "
 141
 142 /*
 143  *  WarpDrive Specific Log codes
 144  */
 145
 146 #define MPT2_WARPDRIVE_LOGENTRY         (0x8002)
 147 #define MPT2_WARPDRIVE_LC_SSDT                  (0x41)
 148 #define MPT2_WARPDRIVE_LC_SSDLW         (0x43)
 149 #define MPT2_WARPDRIVE_LC_SSDLF         (0x44)
 150 #define MPT2_WARPDRIVE_LC_BRMF                  (0x4D)
 151
 152 /*
 153  * per target private data
 154  */
 155 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
 156 #define MPT_TARGET_FLAGS_VOLUME         0x02
 157 #define MPT_TARGET_FLAGS_DELETED        0x04
 158 #define MPT_TARGET_FASTPATH_IO          0x08
 159
 160 #define SAS2_PCI_DEVICE_B0_REVISION     (0x01)
 161 #define SAS3_PCI_DEVICE_C0_REVISION     (0x02)
 162
 163 /*
 164  * Intel HBA branding
 165  */
 166 #define MPT2SAS_INTEL_RMS25JB080_BRANDING    \
 167         "Intel(R) Integrated RAID Module RMS25JB080"
 168 #define MPT2SAS_INTEL_RMS25JB040_BRANDING    \
 169         "Intel(R) Integrated RAID Module RMS25JB040"
 170 #define MPT2SAS_INTEL_RMS25KB080_BRANDING    \
 171         "Intel(R) Integrated RAID Module RMS25KB080"
 172 #define MPT2SAS_INTEL_RMS25KB040_BRANDING    \
 173         "Intel(R) Integrated RAID Module RMS25KB040"
 174 #define MPT2SAS_INTEL_RMS25LB040_BRANDING       \
 175         "Intel(R) Integrated RAID Module RMS25LB040"
 176 #define MPT2SAS_INTEL_RMS25LB080_BRANDING       \
 177         "Intel(R) Integrated RAID Module RMS25LB080"
 178 #define MPT2SAS_INTEL_RMS2LL080_BRANDING        \
 179         "Intel Integrated RAID Module RMS2LL080"
 180 #define MPT2SAS_INTEL_RMS2LL040_BRANDING        \
 181         "Intel Integrated RAID Module RMS2LL040"
 182 #define MPT2SAS_INTEL_RS25GB008_BRANDING       \
 183         "Intel(R) RAID Controller RS25GB008"
 184 #define MPT2SAS_INTEL_SSD910_BRANDING          \
 185         "Intel(R) SSD 910 Series"
 186
 187 #define MPT3SAS_INTEL_RMS3JC080_BRANDING       \
 188         "Intel(R) Integrated RAID Module RMS3JC080"
 189 #define MPT3SAS_INTEL_RS3GC008_BRANDING       \
 190         "Intel(R) RAID Controller RS3GC008"
 191 #define MPT3SAS_INTEL_RS3FC044_BRANDING       \
 192         "Intel(R) RAID Controller RS3FC044"
 193 #define MPT3SAS_INTEL_RS3UC080_BRANDING       \
 194         "Intel(R) RAID Controller RS3UC080"
 195
 196 /*
 197  * Intel HBA SSDIDs
 198  */
 199 #define MPT2SAS_INTEL_RMS25JB080_SSDID          0x3516
 200 #define MPT2SAS_INTEL_RMS25JB040_SSDID          0x3517
 201 #define MPT2SAS_INTEL_RMS25KB080_SSDID          0x3518
 202 #define MPT2SAS_INTEL_RMS25KB040_SSDID          0x3519
 203 #define MPT2SAS_INTEL_RMS25LB040_SSDID          0x351A
 204 #define MPT2SAS_INTEL_RMS25LB080_SSDID          0x351B
 205 #define MPT2SAS_INTEL_RMS2LL080_SSDID           0x350E
 206 #define MPT2SAS_INTEL_RMS2LL040_SSDID           0x350F
 207 #define MPT2SAS_INTEL_RS25GB008_SSDID           0x3000
 208 #define MPT2SAS_INTEL_SSD910_SSDID              0x3700
 209
 210 #define MPT3SAS_INTEL_RMS3JC080_SSDID           0x3521
 211 #define MPT3SAS_INTEL_RS3GC008_SSDID            0x3522
 212 #define MPT3SAS_INTEL_RS3FC044_SSDID            0x3523
 213 #define MPT3SAS_INTEL_RS3UC080_SSDID            0x3524
 214
 215 /*
 216  * Dell HBA branding
 217  */
 218 #define MPT2SAS_DELL_BRANDING_SIZE                 32
 219
 220 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
 221 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
 222 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
 223 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
 224 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
 225 #define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
 226 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
 227
 228 #define MPT3SAS_DELL_12G_HBA_BRANDING       \
 229         "Dell 12Gbps HBA"
 230
 231 /*
 232  * Dell HBA SSDIDs
 233  */
 234 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID        0x1F1C
 235 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID    0x1F1D
 236 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID 0x1F1E
 237 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID    0x1F1F
 238 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID   0x1F20
 239 #define MPT2SAS_DELL_PERC_H200_SSDID            0x1F21
 240 #define MPT2SAS_DELL_6GBPS_SAS_SSDID            0x1F22
 241
 242 #define MPT3SAS_DELL_12G_HBA_SSDID              0x1F46
 243
 244 /*
 245  * Cisco HBA branding
 246  */
 247 #define MPT3SAS_CISCO_12G_8E_HBA_BRANDING               \
 248         "Cisco 9300-8E 12G SAS HBA"
 249 #define MPT3SAS_CISCO_12G_8I_HBA_BRANDING               \
 250         "Cisco 9300-8i 12G SAS HBA"
 251 #define MPT3SAS_CISCO_12G_AVILA_HBA_BRANDING    \
 252         "Cisco 12G Modular SAS Pass through Controller"
 253 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_BRANDING         \
 254         "UCS C3X60 12G SAS Pass through Controller"
 255 /*
 256  * Cisco HBA SSSDIDs
 257  */
 258 #define MPT3SAS_CISCO_12G_8E_HBA_SSDID  0x14C
 259 #define MPT3SAS_CISCO_12G_8I_HBA_SSDID  0x154
 260 #define MPT3SAS_CISCO_12G_AVILA_HBA_SSDID  0x155
 261 #define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_SSDID  0x156
 262
 263 /*
 264  * status bits for ioc->diag_buffer_status
 265  */
 266 #define MPT3_DIAG_BUFFER_IS_REGISTERED  (0x01)
 267 #define MPT3_DIAG_BUFFER_IS_RELEASED    (0x02)
 268 #define MPT3_DIAG_BUFFER_IS_DIAG_RESET  (0x04)
 269
 270 /*
 271  * HP HBA branding
 272  */
 273 #define MPT2SAS_HP_3PAR_SSVID                0x1590
 274
 275 #define MPT2SAS_HP_2_4_INTERNAL_BRANDING        \
 276         "HP H220 Host Bus Adapter"
 277 #define MPT2SAS_HP_2_4_EXTERNAL_BRANDING        \
 278         "HP H221 Host Bus Adapter"
 279 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING   \
 280         "HP H222 Host Bus Adapter"
 281 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING       \
 282         "HP H220i Host Bus Adapter"
 283 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING       \
 284         "HP H210i Host Bus Adapter"
 285
 286 /*
 287  * HO HBA SSDIDs
 288  */
 289 #define MPT2SAS_HP_2_4_INTERNAL_SSDID                   0x0041
 290 #define MPT2SAS_HP_2_4_EXTERNAL_SSDID                   0x0042
 291 #define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID      0x0043
 292 #define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID          0x0044
 293 #define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID          0x0046
 294
 295 /*
 296  * Combined Reply Queue constants,
 297  * There are twelve Supplemental Reply Post Host Index Registers
 298  * and each register is at offset 0x10 bytes from the previous one.
 299  */
 300 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT 12
 301 #define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)
 302
 303 /* OEM Identifiers */
 304 #define MFG10_OEM_ID_INVALID                   (0x00000000)
 305 #define MFG10_OEM_ID_DELL                      (0x00000001)
 306 #define MFG10_OEM_ID_FSC                       (0x00000002)
 307 #define MFG10_OEM_ID_SUN                       (0x00000003)
 308 #define MFG10_OEM_ID_IBM                       (0x00000004)
 309
 310 /* GENERIC Flags 0*/
 311 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
 312 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
 313 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
 314 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
 315 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
 316
 317 #define VIRTUAL_IO_FAILED_RETRY                 (0x32010081)
 318
 319 /* OEM Specific Flags will come from OEM specific header files */
 320 struct Mpi2ManufacturingPage10_t {
 321         MPI2_CONFIG_PAGE_HEADER Header;         /* 00h */
 322         U8      OEMIdentifier;                  /* 04h */
 323         U8      Reserved1;                      /* 05h */
 324         U16     Reserved2;                      /* 08h */
 325         U32     Reserved3;                      /* 0Ch */
 326         U32     GenericFlags0;                  /* 10h */
 327         U32     GenericFlags1;                  /* 14h */
 328         U32     Reserved4;                      /* 18h */
 329         U32     OEMSpecificFlags0;              /* 1Ch */
 330         U32     OEMSpecificFlags1;              /* 20h */
 331         U32     Reserved5[18];                  /* 24h - 60h*/
 332 };
 333
 334
 335 /* Miscellaneous options */
 336 struct Mpi2ManufacturingPage11_t {
 337         MPI2_CONFIG_PAGE_HEADER Header;         /* 00h */
 338         __le32  Reserved1;                      /* 04h */
 339         u8      Reserved2;                      /* 08h */
 340         u8      EEDPTagMode;                    /* 09h */
 341         u8      Reserved3;                      /* 0Ah */
 342         u8      Reserved4;                      /* 0Bh */
 343         __le32  Reserved5[23];                  /* 0Ch-60h*/
 344 };
 345
 346 /**
 347  * struct MPT3SAS_TARGET - starget private hostdata
 348  * @starget: starget object
 349  * @sas_address: target sas address
 350  * @raid_device: raid_device pointer to access volume data
 351  * @handle: device handle
 352  * @num_luns: number luns
 353  * @flags: MPT_TARGET_FLAGS_XXX flags
 354  * @deleted: target flaged for deletion
 355  * @tm_busy: target is busy with TM request.
 356  * @sdev: The sas_device associated with this target
 357  */
 358 struct MPT3SAS_TARGET {
 359         struct scsi_target *starget;
 360         u64     sas_address;
 361         struct _raid_device *raid_device;
 362         u16     handle;
 363         int     num_luns;
 364         u32     flags;
 365         u8      deleted;
 366         u8      tm_busy;
 367         struct _sas_device *sdev;
 368 };
 369
 370
 371 /*
 372  * per device private data
 373  */
 374 #define MPT_DEVICE_FLAGS_INIT           0x01
 375 #define MPT_DEVICE_TLR_ON               0x02
 376
 377 #define MFG_PAGE10_HIDE_SSDS_MASK       (0x00000003)
 378 #define MFG_PAGE10_HIDE_ALL_DISKS       (0x00)
 379 #define MFG_PAGE10_EXPOSE_ALL_DISKS     (0x01)
 380 #define MFG_PAGE10_HIDE_IF_VOL_PRESENT  (0x02)
 381
 382 /**
 383  * struct MPT3SAS_DEVICE - sdev private hostdata
 384  * @sas_target: starget private hostdata
 385  * @lun: lun number
 386  * @flags: MPT_DEVICE_XXX flags
 387  * @configured_lun: lun is configured
 388  * @block: device is in SDEV_BLOCK state
 389  * @tlr_snoop_check: flag used in determining whether to disable TLR
 390  * @eedp_enable: eedp support enable bit
 391  * @eedp_type: 0(type_1), 1(type_2), 2(type_3)
 392  * @eedp_block_length: block size
 393  * @ata_command_pending: SATL passthrough outstanding for device
 394  */
 395 struct MPT3SAS_DEVICE {
 396         struct MPT3SAS_TARGET *sas_target;
 397         unsigned int    lun;
 398         u32     flags;
 399         u8      configured_lun;
 400         u8      block;
 401         u8      tlr_snoop_check;
 402         /*
 403          * Bug workaround for SATL handling: the mpt2/3sas firmware
 404          * doesn't return BUSY or TASK_SET_FULL for subsequent
 405          * commands while a SATL pass through is in operation as the
 406          * spec requires, it simply does nothing with them until the
 407          * pass through completes, causing them possibly to timeout if
 408          * the passthrough is a long executing command (like format or
 409          * secure erase).  This variable allows us to do the right
 410          * thing while a SATL command is pending.
 411          */
 412         unsigned long ata_command_pending;
 413 };
 414
 415 #define MPT3_CMD_NOT_USED       0x8000  /* free */
 416 #define MPT3_CMD_COMPLETE       0x0001  /* completed */
 417 #define MPT3_CMD_PENDING        0x0002  /* pending */
 418 #define MPT3_CMD_REPLY_VALID    0x0004  /* reply is valid */
 419 #define MPT3_CMD_RESET          0x0008  /* host reset dropped the command */
 420
 421 /**
 422  * struct _internal_cmd - internal commands struct
 423  * @mutex: mutex
 424  * @done: completion
 425  * @reply: reply message pointer
 426  * @sense: sense data
 427  * @status: MPT3_CMD_XXX status
 428  * @smid: system message id
 429  */
 430 struct _internal_cmd {
 431         struct mutex mutex;
 432         struct completion done;
 433         void    *reply;
 434         void    *sense;
 435         u16     status;
 436         u16     smid;
 437 };
 438
 439
 440
 441 /**
 442  * struct _sas_device - attached device information
 443  * @list: sas device list
 444  * @starget: starget object
 445  * @sas_address: device sas address
 446  * @device_name: retrieved from the SAS IDENTIFY frame.
 447  * @handle: device handle
 448  * @sas_address_parent: sas address of parent expander or sas host
 449  * @enclosure_handle: enclosure handle
 450  * @enclosure_logical_id: enclosure logical identifier
 451  * @volume_handle: volume handle (valid when hidden raid member)
 452  * @volume_wwid: volume unique identifier
 453  * @device_info: bitfield provides detailed info about the device
 454  * @id: target id
 455  * @channel: target channel
 456  * @slot: number number
 457  * @phy: phy identifier provided in sas device page 0
 458  * @responding: used in _scsih_sas_device_mark_responding
 459  * @fast_path: fast path feature enable bit
 460  * @pfa_led_on: flag for PFA LED status
 461  * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()
 462  *      addition routine.
 463  */
 464 struct _sas_device {
 465         struct list_head list;
 466         struct scsi_target *starget;
 467         u64     sas_address;
 468         u64     device_name;
 469         u16     handle;
 470         u64     sas_address_parent;
 471         u16     enclosure_handle;
 472         u64     enclosure_logical_id;
 473         u16     volume_handle;
 474         u64     volume_wwid;
 475         u32     device_info;
 476         int     id;
 477         int     channel;
 478         u16     slot;
 479         u8      phy;
 480         u8      responding;
 481         u8      fast_path;
 482         u8      pfa_led_on;
 483         u8      pend_sas_rphy_add;
 484         u8      enclosure_level;
 485         u8      connector_name[4];
 486         struct kref refcount;
 487 };
 488
 489 static inline void sas_device_get(struct _sas_device *s)
 490 {
 491         kref_get(&s->refcount);
 492 }
 493
 494 static inline void sas_device_free(struct kref *r)
 495 {
 496         kfree(container_of(r, struct _sas_device, refcount));
 497 }
 498
 499 static inline void sas_device_put(struct _sas_device *s)
 500 {
 501         kref_put(&s->refcount, sas_device_free);
 502 }
 503
 504 /**
 505  * struct _raid_device - raid volume link list
 506  * @list: sas device list
 507  * @starget: starget object
 508  * @sdev: scsi device struct (volumes are single lun)
 509  * @wwid: unique identifier for the volume
 510  * @handle: device handle
 511  * @block_size: Block size of the volume
 512  * @id: target id
 513  * @channel: target channel
 514  * @volume_type: the raid level
 515  * @device_info: bitfield provides detailed info about the hidden components
 516  * @num_pds: number of hidden raid components
 517  * @responding: used in _scsih_raid_device_mark_responding
 518  * @percent_complete: resync percent complete
 519  * @direct_io_enabled: Whether direct io to PDs are allowed or not
 520  * @stripe_exponent: X where 2powX is the stripe sz in blocks
 521  * @block_exponent: X where 2powX is the block sz in bytes
 522  * @max_lba: Maximum number of LBA in the volume
 523  * @stripe_sz: Stripe Size of the volume
 524  * @device_info: Device info of the volume member disk
 525  * @pd_handle: Array of handles of the physical drives for direct I/O in le16
 526  */
 527 #define MPT_MAX_WARPDRIVE_PDS           8
 528 struct _raid_device {
 529         struct list_head list;
 530         struct scsi_target *starget;
 531         struct scsi_device *sdev;
 532         u64     wwid;
 533         u16     handle;
 534         u16     block_sz;
 535         int     id;
 536         int     channel;
 537         u8      volume_type;
 538         u8      num_pds;
 539         u8      responding;
 540         u8      percent_complete;
 541         u8      direct_io_enabled;
 542         u8      stripe_exponent;
 543         u8      block_exponent;
 544         u64     max_lba;
 545         u32     stripe_sz;
 546         u32     device_info;
 547         u16     pd_handle[MPT_MAX_WARPDRIVE_PDS];
 548 };
 549
 550 /**
 551  * struct _boot_device - boot device info
 552  * @is_raid: flag to indicate whether this is volume
 553  * @device: holds pointer for either struct _sas_device or
 554  *     struct _raid_device
 555  */
 556 struct _boot_device {
 557         u8 is_raid;
 558         void *device;
 559 };
 560
 561 /**
 562  * struct _sas_port - wide/narrow sas port information
 563  * @port_list: list of ports belonging to expander
 564  * @num_phys: number of phys belonging to this port
 565  * @remote_identify: attached device identification
 566  * @rphy: sas transport rphy object
 567  * @port: sas transport wide/narrow port object
 568  * @phy_list: _sas_phy list objects belonging to this port
 569  */
 570 struct _sas_port {
 571         struct list_head port_list;
 572         u8      num_phys;
 573         struct sas_identify remote_identify;
 574         struct sas_rphy *rphy;
 575         struct sas_port *port;
 576         struct list_head phy_list;
 577 };
 578
 579 /**
 580  * struct _sas_phy - phy information
 581  * @port_siblings: list of phys belonging to a port
 582  * @identify: phy identification
 583  * @remote_identify: attached device identification
 584  * @phy: sas transport phy object
 585  * @phy_id: unique phy id
 586  * @handle: device handle for this phy
 587  * @attached_handle: device handle for attached device
 588  * @phy_belongs_to_port: port has been created for this phy
 589  */
 590 struct _sas_phy {
 591         struct list_head port_siblings;
 592         struct sas_identify identify;
 593         struct sas_identify remote_identify;
 594         struct sas_phy *phy;
 595         u8      phy_id;
 596         u16     handle;
 597         u16     attached_handle;
 598         u8      phy_belongs_to_port;
 599 };
 600
 601 /**
 602  * struct _sas_node - sas_host/expander information
 603  * @list: list of expanders
 604  * @parent_dev: parent device class
 605  * @num_phys: number phys belonging to this sas_host/expander
 606  * @sas_address: sas address of this sas_host/expander
 607  * @handle: handle for this sas_host/expander
 608  * @sas_address_parent: sas address of parent expander or sas host
 609  * @enclosure_handle: handle for this a member of an enclosure
 610  * @device_info: bitwise defining capabilities of this sas_host/expander
 611  * @responding: used in _scsih_expander_device_mark_responding
 612  * @phy: a list of phys that make up this sas_host/expander
 613  * @sas_port_list: list of ports attached to this sas_host/expander
 614  */
 615 struct _sas_node {
 616         struct list_head list;
 617         struct device *parent_dev;
 618         u8      num_phys;
 619         u64     sas_address;
 620         u16     handle;
 621         u64     sas_address_parent;
 622         u16     enclosure_handle;
 623         u64     enclosure_logical_id;
 624         u8      responding;
 625         struct  _sas_phy *phy;
 626         struct list_head sas_port_list;
 627 };
 628
 629 /**
 630  * enum reset_type - reset state
 631  * @FORCE_BIG_HAMMER: issue diagnostic reset
 632  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
 633  */
 634 enum reset_type {
 635         FORCE_BIG_HAMMER,
 636         SOFT_RESET,
 637 };
 638
 639 /**
 640  * struct chain_tracker - firmware chain tracker
 641  * @chain_buffer: chain buffer
 642  * @chain_buffer_dma: physical address
 643  * @tracker_list: list of free request (ioc->free_chain_list)
 644  */
 645 struct chain_tracker {
 646         void *chain_buffer;
 647         dma_addr_t chain_buffer_dma;
 648         struct list_head tracker_list;
 649 };
 650
 651 /**
 652  * struct scsiio_tracker - scsi mf request tracker
 653  * @smid: system message id
 654  * @scmd: scsi request pointer
 655  * @cb_idx: callback index
 656  * @direct_io: To indicate whether I/O is direct (WARPDRIVE)
 657  * @tracker_list: list of free request (ioc->free_list)
 658  * @msix_io: IO's msix
 659  */
 660 struct scsiio_tracker {
 661         u16     smid;
 662         struct scsi_cmnd *scmd;
 663         u8      cb_idx;
 664         u8      direct_io;
 665         struct list_head chain_list;
 666         struct list_head tracker_list;
 667         u16     msix_io;
 668 };
 669
 670 /**
 671  * struct request_tracker - firmware request tracker
 672  * @smid: system message id
 673  * @cb_idx: callback index
 674  * @tracker_list: list of free request (ioc->free_list)
 675  */
 676 struct request_tracker {
 677         u16     smid;
 678         u8      cb_idx;
 679         struct list_head tracker_list;
 680 };
 681
 682 /**
 683  * struct _tr_list - target reset list
 684  * @handle: device handle
 685  * @state: state machine
 686  */
 687 struct _tr_list {
 688         struct list_head list;
 689         u16     handle;
 690         u16     state;
 691 };
 692
 693
 694 /**
 695  * struct adapter_reply_queue - the reply queue struct
 696  * @ioc: per adapter object
 697  * @msix_index: msix index into vector table
 698  * @vector: irq vector
 699  * @reply_post_host_index: head index in the pool where FW completes IO
 700  * @reply_post_free: reply post base virt address
 701  * @name: the name registered to request_irq()
 702  * @busy: isr is actively processing replies on another cpu
 703  * @list: this list
 704 */
 705 struct adapter_reply_queue {
 706         struct MPT3SAS_ADAPTER  *ioc;
 707         u8                      msix_index;
 708         unsigned int            vector;
 709         u32                     reply_post_host_index;
 710         Mpi2ReplyDescriptorsUnion_t *reply_post_free;
 711         char                    name[MPT_NAME_LENGTH];
 712         atomic_t                busy;
 713         cpumask_var_t           affinity_hint;
 714         struct list_head        list;
 715 };
 716
 717 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
 718
 719 /* SAS3.0 support */
 720 typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,
 721                 struct scsi_cmnd *scmd, u16 smid);
 722 typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,
 723                 dma_addr_t data_out_dma, size_t data_out_sz,
 724                 dma_addr_t data_in_dma, size_t data_in_sz);
 725 typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,
 726                 void *paddr);
 727
 728
 729
 730 /* IOC Facts and Port Facts converted from little endian to cpu */
 731 union mpi3_version_union {
 732         MPI2_VERSION_STRUCT             Struct;
 733         u32                             Word;
 734 };
 735
 736 struct mpt3sas_facts {
 737         u16                     MsgVersion;
 738         u16                     HeaderVersion;
 739         u8                      IOCNumber;
 740         u8                      VP_ID;
 741         u8                      VF_ID;
 742         u16                     IOCExceptions;
 743         u16                     IOCStatus;
 744         u32                     IOCLogInfo;
 745         u8                      MaxChainDepth;
 746         u8                      WhoInit;
 747         u8                      NumberOfPorts;
 748         u8                      MaxMSIxVectors;
 749         u16                     RequestCredit;
 750         u16                     ProductID;
 751         u32                     IOCCapabilities;
 752         union mpi3_version_union        FWVersion;
 753         u16                     IOCRequestFrameSize;
 754         u16                     Reserved3;
 755         u16                     MaxInitiators;
 756         u16                     MaxTargets;
 757         u16                     MaxSasExpanders;
 758         u16                     MaxEnclosures;
 759         u16                     ProtocolFlags;
 760         u16                     HighPriorityCredit;
 761         u16                     MaxReplyDescriptorPostQueueDepth;
 762         u8                      ReplyFrameSize;
 763         u8                      MaxVolumes;
 764         u16                     MaxDevHandle;
 765         u16                     MaxPersistentEntries;
 766         u16                     MinDevHandle;
 767 };
 768
 769 struct mpt3sas_port_facts {
 770         u8                      PortNumber;
 771         u8                      VP_ID;
 772         u8                      VF_ID;
 773         u8                      PortType;
 774         u16                     MaxPostedCmdBuffers;
 775 };
 776
 777 struct reply_post_struct {
 778         Mpi2ReplyDescriptorsUnion_t     *reply_post_free;
 779         dma_addr_t                      reply_post_free_dma;
 780 };
 781
 782 /**
 783  * enum mutex_type - task management mutex type
 784  * @TM_MUTEX_OFF: mutex is not required becuase calling function is acquiring it
 785  * @TM_MUTEX_ON: mutex is required
 786  */
 787 enum mutex_type {
 788         TM_MUTEX_OFF = 0,
 789         TM_MUTEX_ON = 1,
 790 };
 791
 792 typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);
 793 /**
 794  * struct MPT3SAS_ADAPTER - per adapter struct
 795  * @list: ioc_list
 796  * @shost: shost object
 797  * @id: unique adapter id
 798  * @cpu_count: number online cpus
 799  * @name: generic ioc string
 800  * @tmp_string: tmp string used for logging
 801  * @pdev: pci pdev object
 802  * @pio_chip: physical io register space
 803  * @chip: memory mapped register space
 804  * @chip_phys: physical addrss prior to mapping
 805  * @logging_level: see mpt3sas_debug.h
 806  * @fwfault_debug: debuging FW timeouts
 807  * @ir_firmware: IR firmware present
 808  * @bars: bitmask of BAR's that must be configured
 809  * @mask_interrupts: ignore interrupt
 810  * @dma_mask: used to set the consistent dma mask
 811  * @fault_reset_work_q_name: fw fault work queue
 812  * @fault_reset_work_q: ""
 813  * @fault_reset_work: ""
 814  * @firmware_event_name: fw event work queue
 815  * @firmware_event_thread: ""
 816  * @fw_event_lock:
 817  * @fw_event_list: list of fw events
 818  * @aen_event_read_flag: event log was read
 819  * @broadcast_aen_busy: broadcast aen waiting to be serviced
 820  * @shost_recovery: host reset in progress
 821  * @ioc_reset_in_progress_lock:
 822  * @ioc_link_reset_in_progress: phy/hard reset in progress
 823  * @ignore_loginfos: ignore loginfos during task management
 824  * @remove_host: flag for when driver unloads, to avoid sending dev resets
 825  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
 826  * @wait_for_discovery_to_complete: flag set at driver load time when
 827  *                                               waiting on reporting devices
 828  * @is_driver_loading: flag set at driver load time
 829  * @port_enable_failed: flag set when port enable has failed
 830  * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work
 831  * @start_scan_failed: means port enable failed, return's the ioc_status
 832  * @msix_enable: flag indicating msix is enabled
 833  * @msix_vector_count: number msix vectors
 834  * @cpu_msix_table: table for mapping cpus to msix index
 835  * @cpu_msix_table_sz: table size
 836  * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands
 837  * @scsi_io_cb_idx: shost generated commands
 838  * @tm_cb_idx: task management commands
 839  * @scsih_cb_idx: scsih internal commands
 840  * @transport_cb_idx: transport internal commands
 841  * @ctl_cb_idx: clt internal commands
 842  * @base_cb_idx: base internal commands
 843  * @config_cb_idx: base internal commands
 844  * @tm_tr_cb_idx : device removal target reset handshake
 845  * @tm_tr_volume_cb_idx : volume removal target reset
 846  * @base_cmds:
 847  * @transport_cmds:
 848  * @scsih_cmds:
 849  * @tm_cmds:
 850  * @ctl_cmds:
 851  * @config_cmds:
 852  * @base_add_sg_single: handler for either 32/64 bit sgl's
 853  * @event_type: bits indicating which events to log
 854  * @event_context: unique id for each logged event
 855  * @event_log: event log pointer
 856  * @event_masks: events that are masked
 857  * @facts: static facts data
 858  * @pfacts: static port facts data
 859  * @manu_pg0: static manufacturing page 0
 860  * @manu_pg10: static manufacturing page 10
 861  * @manu_pg11: static manufacturing page 11
 862  * @bios_pg2: static bios page 2
 863  * @bios_pg3: static bios page 3
 864  * @ioc_pg8: static ioc page 8
 865  * @iounit_pg0: static iounit page 0
 866  * @iounit_pg1: static iounit page 1
 867  * @iounit_pg8: static iounit page 8
 868  * @sas_hba: sas host object
 869  * @sas_expander_list: expander object list
 870  * @sas_node_lock:
 871  * @sas_device_list: sas device object list
 872  * @sas_device_init_list: sas device object list (used only at init time)
 873  * @sas_device_lock:
 874  * @io_missing_delay: time for IO completed by fw when PDR enabled
 875  * @device_missing_delay: time for device missing by fw when PDR enabled
 876  * @sas_id : used for setting volume target IDs
 877  * @blocking_handles: bitmask used to identify which devices need blocking
 878  * @pd_handles : bitmask for PD handles
 879  * @pd_handles_sz : size of pd_handle bitmask
 880  * @config_page_sz: config page size
 881  * @config_page: reserve memory for config page payload
 882  * @config_page_dma:
 883  * @hba_queue_depth: hba request queue depth
 884  * @sge_size: sg element size for either 32/64 bit
 885  * @scsiio_depth: SCSI_IO queue depth
 886  * @request_sz: per request frame size
 887  * @request: pool of request frames
 888  * @request_dma:
 889  * @request_dma_sz:
 890  * @scsi_lookup: firmware request tracker list
 891  * @scsi_lookup_lock:
 892  * @free_list: free list of request
 893  * @pending_io_count:
 894  * @reset_wq:
 895  * @chain: pool of chains
 896  * @chain_dma:
 897  * @max_sges_in_main_message: number sg elements in main message
 898  * @max_sges_in_chain_message: number sg elements per chain
 899  * @chains_needed_per_io: max chains per io
 900  * @chain_depth: total chains allocated
 901  * @hi_priority_smid:
 902  * @hi_priority:
 903  * @hi_priority_dma:
 904  * @hi_priority_depth:
 905  * @hpr_lookup:
 906  * @hpr_free_list:
 907  * @internal_smid:
 908  * @internal:
 909  * @internal_dma:
 910  * @internal_depth:
 911  * @internal_lookup:
 912  * @internal_free_list:
 913  * @sense: pool of sense
 914  * @sense_dma:
 915  * @sense_dma_pool:
 916  * @reply_depth: hba reply queue depth:
 917  * @reply_sz: per reply frame size:
 918  * @reply: pool of replys:
 919  * @reply_dma:
 920  * @reply_dma_pool:
 921  * @reply_free_queue_depth: reply free depth
 922  * @reply_free: pool for reply free queue (32 bit addr)
 923  * @reply_free_dma:
 924  * @reply_free_dma_pool:
 925  * @reply_free_host_index: tail index in pool to insert free replys
 926  * @reply_post_queue_depth: reply post queue depth
 927  * @reply_post_struct: struct for reply_post_free physical & virt address
 928  * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init
 929  * @rdpq_array_enable: rdpq_array support is enabled in the driver
 930  * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag
 931  *                              is assigned only ones
 932  * @reply_queue_count: number of reply queue's
 933  * @reply_queue_list: link list contaning the reply queue info
 934  * @msix96_vector: 96 MSI-X vector support
 935  * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue
 936  * @delayed_tr_list: target reset link list
 937  * @delayed_tr_volume_list: volume target reset link list
 938  * @temp_sensors_count: flag to carry the number of temperature sensors
 939  * @pci_access_mutex: Mutex to synchronize ioctl,sysfs show path and
 940  *      pci resource handling. PCI resource freeing will lead to free
 941  *      vital hardware/memory resource, which might be in use by cli/sysfs
 942  *      path functions resulting in Null pointer reference followed by kernel
 943  *      crash. To avoid the above race condition we use mutex syncrhonization
 944  *      which ensures the syncrhonization between cli/sysfs_show path.
 945  */
 946 struct MPT3SAS_ADAPTER {
 947         struct list_head list;
 948         struct Scsi_Host *shost;
 949         u8              id;
 950         int             cpu_count;
 951         char            name[MPT_NAME_LENGTH];
 952         char            driver_name[MPT_NAME_LENGTH];
 953         char            tmp_string[MPT_STRING_LENGTH];
 954         struct pci_dev  *pdev;
 955         Mpi2SystemInterfaceRegs_t __iomem *chip;
 956         resource_size_t chip_phys;
 957         int             logging_level;
 958         int             fwfault_debug;
 959         u8              ir_firmware;
 960         int             bars;
 961         u8              mask_interrupts;
 962         int             dma_mask;
 963
 964         /* fw fault handler */
 965         char            fault_reset_work_q_name[20];
 966         struct workqueue_struct *fault_reset_work_q;
 967         struct delayed_work fault_reset_work;
 968
 969         /* fw event handler */
 970         char            firmware_event_name[20];
 971         struct workqueue_struct *firmware_event_thread;
 972         spinlock_t      fw_event_lock;
 973         struct list_head fw_event_list;
 974
 975          /* misc flags */
 976         int             aen_event_read_flag;
 977         u8              broadcast_aen_busy;
 978         u16             broadcast_aen_pending;
 979         u8              shost_recovery;
 980
 981         struct mutex    reset_in_progress_mutex;
 982         spinlock_t      ioc_reset_in_progress_lock;
 983         u8              ioc_link_reset_in_progress;
 984         u8              ioc_reset_in_progress_status;
 985
 986         u8              ignore_loginfos;
 987         u8              remove_host;
 988         u8              pci_error_recovery;
 989         u8              wait_for_discovery_to_complete;
 990         u8              is_driver_loading;
 991         u8              port_enable_failed;
 992         u8              start_scan;
 993         u16             start_scan_failed;
 994
 995         u8              msix_enable;
 996         u16             msix_vector_count;
 997         u8              *cpu_msix_table;
 998         u16             cpu_msix_table_sz;
 999         resource_size_t __iomem **reply_post_host_index;
1000         u32             ioc_reset_count;
1001         MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;
1002         u32             non_operational_loop;
1003
1004         /* internal commands, callback index */
1005         u8              scsi_io_cb_idx;
1006         u8              tm_cb_idx;
1007         u8              transport_cb_idx;
1008         u8              scsih_cb_idx;
1009         u8              ctl_cb_idx;
1010         u8              base_cb_idx;
1011         u8              port_enable_cb_idx;
1012         u8              config_cb_idx;
1013         u8              tm_tr_cb_idx;
1014         u8              tm_tr_volume_cb_idx;
1015         u8              tm_sas_control_cb_idx;
1016         struct _internal_cmd base_cmds;
1017         struct _internal_cmd port_enable_cmds;
1018         struct _internal_cmd transport_cmds;
1019         struct _internal_cmd scsih_cmds;
1020         struct _internal_cmd tm_cmds;
1021         struct _internal_cmd ctl_cmds;
1022         struct _internal_cmd config_cmds;
1023
1024         MPT_ADD_SGE     base_add_sg_single;
1025
1026         /* function ptr for either IEEE or MPI sg elements */
1027         MPT_BUILD_SG_SCMD build_sg_scmd;
1028         MPT_BUILD_SG    build_sg;
1029         MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;
1030         u16             sge_size_ieee;
1031         u16             hba_mpi_version_belonged;
1032
1033         /* function ptr for MPI sg elements only */
1034         MPT_BUILD_SG    build_sg_mpi;
1035         MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;
1036
1037         /* event log */
1038         u32             event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
1039         u32             event_context;
1040         void            *event_log;
1041         u32             event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
1042
1043         /* static config pages */
1044         struct mpt3sas_facts facts;
1045         struct mpt3sas_port_facts *pfacts;
1046         Mpi2ManufacturingPage0_t manu_pg0;
1047         struct Mpi2ManufacturingPage10_t manu_pg10;
1048         struct Mpi2ManufacturingPage11_t manu_pg11;
1049         Mpi2BiosPage2_t bios_pg2;
1050         Mpi2BiosPage3_t bios_pg3;
1051         Mpi2IOCPage8_t ioc_pg8;
1052         Mpi2IOUnitPage0_t iounit_pg0;
1053         Mpi2IOUnitPage1_t iounit_pg1;
1054         Mpi2IOUnitPage8_t iounit_pg8;
1055
1056         struct _boot_device req_boot_device;
1057         struct _boot_device req_alt_boot_device;
1058         struct _boot_device current_boot_device;
1059
1060         /* sas hba, expander, and device list */
1061         struct _sas_node sas_hba;
1062         struct list_head sas_expander_list;
1063         spinlock_t      sas_node_lock;
1064         struct list_head sas_device_list;
1065         struct list_head sas_device_init_list;
1066         spinlock_t      sas_device_lock;
1067         struct list_head raid_device_list;
1068         spinlock_t      raid_device_lock;
1069         u8              io_missing_delay;
1070         u16             device_missing_delay;
1071         int             sas_id;
1072
1073         void            *blocking_handles;
1074         void            *pd_handles;
1075         u16             pd_handles_sz;
1076
1077         /* config page */
1078         u16             config_page_sz;
1079         void            *config_page;
1080         dma_addr_t      config_page_dma;
1081
1082         /* scsiio request */
1083         u16             hba_queue_depth;
1084         u16             sge_size;
1085         u16             scsiio_depth;
1086         u16             request_sz;
1087         u8              *request;
1088         dma_addr_t      request_dma;
1089         u32             request_dma_sz;
1090         struct scsiio_tracker *scsi_lookup;
1091         ulong           scsi_lookup_pages;
1092         spinlock_t      scsi_lookup_lock;
1093         struct list_head free_list;
1094         int             pending_io_count;
1095         wait_queue_head_t reset_wq;
1096
1097         /* chain */
1098         struct chain_tracker *chain_lookup;
1099         struct list_head free_chain_list;
1100         struct dma_pool *chain_dma_pool;
1101         ulong           chain_pages;
1102         u16             max_sges_in_main_message;
1103         u16             max_sges_in_chain_message;
1104         u16             chains_needed_per_io;
1105         u32             chain_depth;
1106
1107         /* hi-priority queue */
1108         u16             hi_priority_smid;
1109         u8              *hi_priority;
1110         dma_addr_t      hi_priority_dma;
1111         u16             hi_priority_depth;
1112         struct request_tracker *hpr_lookup;
1113         struct list_head hpr_free_list;
1114
1115         /* internal queue */
1116         u16             internal_smid;
1117         u8              *internal;
1118         dma_addr_t      internal_dma;
1119         u16             internal_depth;
1120         struct request_tracker *internal_lookup;
1121         struct list_head internal_free_list;
1122
1123         /* sense */
1124         u8              *sense;
1125         dma_addr_t      sense_dma;
1126         struct dma_pool *sense_dma_pool;
1127
1128         /* reply */
1129         u16             reply_sz;
1130         u8              *reply;
1131         dma_addr_t      reply_dma;
1132         u32             reply_dma_max_address;
1133         u32             reply_dma_min_address;
1134         struct dma_pool *reply_dma_pool;
1135
1136         /* reply free queue */
1137         u16             reply_free_queue_depth;
1138         __le32          *reply_free;
1139         dma_addr_t      reply_free_dma;
1140         struct dma_pool *reply_free_dma_pool;
1141         u32             reply_free_host_index;
1142
1143         /* reply post queue */
1144         u16             reply_post_queue_depth;
1145         struct reply_post_struct *reply_post;
1146         u8              rdpq_array_capable;
1147         u8              rdpq_array_enable;
1148         u8              rdpq_array_enable_assigned;
1149         struct dma_pool *reply_post_free_dma_pool;
1150         u8              reply_queue_count;
1151         struct list_head reply_queue_list;
1152
1153         u8              msix96_vector;
1154         /* reply post register index */
1155         resource_size_t **replyPostRegisterIndex;
1156
1157         struct list_head delayed_tr_list;
1158         struct list_head delayed_tr_volume_list;
1159         u8              temp_sensors_count;
1160         struct mutex pci_access_mutex;
1161
1162         /* diag buffer support */
1163         u8              *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
1164         u32             diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
1165         dma_addr_t      diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
1166         u8              diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
1167         u32             unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
1168         u32             product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
1169         u32             diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
1170         u32             ring_buffer_offset;
1171         u32             ring_buffer_sz;
1172         u8              is_warpdrive;
1173         u8              hide_ir_msg;
1174         u8              mfg_pg10_hide_flag;
1175         u8              hide_drives;
1176         spinlock_t      diag_trigger_lock;
1177         u8              diag_trigger_active;
1178         struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;
1179         struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;
1180         struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;
1181         struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;
1182 };
1183
1184 typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1185         u32 reply);
1186
1187
1188 /* base shared API */
1189 extern struct list_head mpt3sas_ioc_list;
1190 extern char    driver_name[MPT_NAME_LENGTH];
1191 /* spinlock on list operations over IOCs
1192  * Case: when multiple warpdrive cards(IOCs) are in use
1193  * Each IOC will added to the ioc list structure on initialization.
1194  * Watchdog threads run at regular intervals to check IOC for any
1195  * fault conditions which will trigger the dead_ioc thread to
1196  * deallocate pci resource, resulting deleting the IOC netry from list,
1197  * this deletion need to protected by spinlock to enusre that
1198  * ioc removal is syncrhonized, if not synchronized it might lead to
1199  * list_del corruption as the ioc list is traversed in cli path.
1200  */
1201 extern spinlock_t gioc_lock;
1202
1203 void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);
1204 void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);
1205
1206 int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);
1207 void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);
1208 int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);
1209 void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);
1210 int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc, int sleep_flag,
1211         enum reset_type type);
1212
1213 void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1214 void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1215 __le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,
1216         u16 smid);
1217 void mpt3sas_base_flush_reply_queues(struct MPT3SAS_ADAPTER *ioc);
1218
1219 /* hi-priority queue */
1220 u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1221 u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,
1222         struct scsi_cmnd *scmd);
1223
1224 u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);
1225 void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1226 void mpt3sas_base_put_smid_scsi_io(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1227         u16 handle);
1228 void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1229         u16 handle);
1230 void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc,
1231         u16 smid, u16 msix_task);
1232 void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1233 void mpt3sas_base_initialize_callback_handler(void);
1234 u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);
1235 void mpt3sas_base_release_callback_handler(u8 cb_idx);
1236
1237 u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1238         u32 reply);
1239 u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,
1240         u8 msix_index, u32 reply);
1241 void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,
1242         u32 phys_addr);
1243
1244 u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);
1245
1246 void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);
1247 int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,
1248         Mpi2SasIoUnitControlReply_t *mpi_reply,
1249         Mpi2SasIoUnitControlRequest_t *mpi_request);
1250 int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,
1251         Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
1252
1253 void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,
1254         u32 *event_type);
1255
1256 void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);
1257
1258 void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,
1259         u16 device_missing_delay, u8 io_missing_delay);
1260
1261 int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);
1262
1263
1264 /* scsih shared API */
1265 u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,
1266         u32 reply);
1267 void mpt3sas_scsih_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1268
1269 int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1270         uint channel, uint id, uint lun, u8 type, u16 smid_task,
1271         ulong timeout, enum mutex_type m_type);
1272 void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1273 void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1274 void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1275 void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
1276         u64 sas_address);
1277
1278 struct _sas_node *mpt3sas_scsih_expander_find_by_handle(
1279         struct MPT3SAS_ADAPTER *ioc, u16 handle);
1280 struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(
1281         struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1282 struct _sas_device *mpt3sas_get_sdev_by_addr(
1283          struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1284 struct _sas_device *__mpt3sas_get_sdev_by_addr(
1285          struct MPT3SAS_ADAPTER *ioc, u64 sas_address);
1286
1287 void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);
1288 struct _raid_device *
1289 mpt3sas_raid_device_find_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle);
1290
1291 /* config shared API */
1292 u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1293         u32 reply);
1294 int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,
1295         u8 *num_phys);
1296 int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,
1297         Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
1298 int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,
1299         Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,
1300         u16 sz);
1301 int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,
1302         Mpi2ConfigReply_t *mpi_reply,
1303         struct Mpi2ManufacturingPage10_t *config_page);
1304
1305 int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1306         Mpi2ConfigReply_t *mpi_reply,
1307         struct Mpi2ManufacturingPage11_t  *config_page);
1308 int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,
1309         Mpi2ConfigReply_t *mpi_reply,
1310         struct Mpi2ManufacturingPage11_t *config_page);
1311
1312 int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1313         *mpi_reply, Mpi2BiosPage2_t *config_page);
1314 int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1315         *mpi_reply, Mpi2BiosPage3_t *config_page);
1316 int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1317         *mpi_reply, Mpi2IOUnitPage0_t *config_page);
1318 int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,
1319         Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,
1320         u32 form, u32 handle);
1321 int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,
1322         Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,
1323         u32 form, u32 handle);
1324 int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,
1325         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,
1326         u16 sz);
1327 int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1328         *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1329 int mpt3sas_config_get_iounit_pg3(struct MPT3SAS_ADAPTER *ioc,
1330         Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage3_t *config_page, u16 sz);
1331 int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1332         *mpi_reply, Mpi2IOUnitPage1_t *config_page);
1333 int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1334         *mpi_reply, Mpi2IOUnitPage8_t *config_page);
1335 int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1336         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1337         u16 sz);
1338 int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,
1339         Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,
1340         u16 sz);
1341 int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1342         *mpi_reply, Mpi2IOCPage8_t *config_page);
1343 int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,
1344         Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,
1345         u32 form, u32 handle);
1346 int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,
1347         Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,
1348         u32 phy_number, u16 handle);
1349 int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,
1350         Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,
1351         u32 form, u32 handle);
1352 int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1353         *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
1354 int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t
1355         *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
1356 int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,
1357         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
1358         u32 handle);
1359 int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,
1360         u8 *num_pds);
1361 int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,
1362         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,
1363         u32 handle, u16 sz);
1364 int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,
1365         Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
1366         u32 form, u32 form_specific);
1367 int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,
1368         u16 *volume_handle);
1369 int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,
1370         u16 volume_handle, u64 *wwid);
1371
1372 /* ctl shared API */
1373 extern struct device_attribute *mpt3sas_host_attrs[];
1374 extern struct device_attribute *mpt3sas_dev_attrs[];
1375 void mpt3sas_ctl_init(ushort hbas_to_enumerate);
1376 void mpt3sas_ctl_exit(ushort hbas_to_enumerate);
1377 u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1378         u32 reply);
1379 void mpt3sas_ctl_reset_handler(struct MPT3SAS_ADAPTER *ioc, int reset_phase);
1380 u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,
1381         u8 msix_index, u32 reply);
1382 void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,
1383         Mpi2EventNotificationReply_t *mpi_reply);
1384
1385 void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,
1386         u8 bits_to_regsiter);
1387 int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,
1388         u8 *issue_reset);
1389
1390 /* transport shared API */
1391 extern struct scsi_transport_template *mpt3sas_transport_template;
1392 u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
1393         u32 reply);
1394 struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,
1395         u16 handle, u64 sas_address);
1396 void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,
1397         u64 sas_address_parent);
1398 int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy
1399         *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
1400 int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,
1401         struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,
1402         struct device *parent_dev);
1403 void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,
1404         u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
1405 extern struct sas_function_template mpt3sas_transport_functions;
1406 extern struct scsi_transport_template *mpt3sas_transport_template;
1407 extern int scsi_internal_device_block(struct scsi_device *sdev);
1408 extern int scsi_internal_device_unblock(struct scsi_device *sdev,
1409                                 enum scsi_device_state new_state);
1410 /* trigger data externs */
1411 void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
1412         struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1413 void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,
1414         struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);
1415 void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,
1416         u32 tigger_bitmask);
1417 void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,
1418         u16 log_entry_qualifier);
1419 void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,
1420         u8 asc, u8 ascq);
1421 void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,
1422         u32 loginfo);
1423
1424 /* warpdrive APIs */
1425 u8 mpt3sas_get_num_volumes(struct MPT3SAS_ADAPTER *ioc);
1426 void mpt3sas_init_warpdrive_properties(struct MPT3SAS_ADAPTER *ioc,
1427         struct _raid_device *raid_device);
1428 u8
1429 mpt3sas_scsi_direct_io_get(struct MPT3SAS_ADAPTER *ioc, u16 smid);
1430 void
1431 mpt3sas_scsi_direct_io_set(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 direct_io);
1432 void
1433 mpt3sas_setup_direct_io(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd *scmd,
1434         struct _raid_device *raid_device, Mpi2SCSIIORequest_t *mpi_request,
1435         u16 smid);
1436
1437 #endif /* MPT3SAS_BASE_H_INCLUDED */