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-2010  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          "07.100.00.00"
  73 #define MPT2SAS_MAJOR_VERSION           07
  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 #define  CAN_SLEEP                      1
 107 #define  NO_SLEEP                       0
 108
 109 #define INTERNAL_CMDS_COUNT             10      /* reserved cmds */
 110
 111 #define MPI2_HIM_MASK                   0xFFFFFFFF /* mask every bit*/
 112
 113 #define MPT2SAS_INVALID_DEVICE_HANDLE   0xFFFF
 114
 115
 116 /*
 117  * reset phases
 118  */
 119 #define MPT2_IOC_PRE_RESET              1 /* prior to host reset */
 120 #define MPT2_IOC_AFTER_RESET            2 /* just after host reset */
 121 #define MPT2_IOC_DONE_RESET             3 /* links re-initialized */
 122
 123 /*
 124  * logging format
 125  */
 126 #define MPT2SAS_FMT                     "%s: "
 127 #define MPT2SAS_INFO_FMT                KERN_INFO MPT2SAS_FMT
 128 #define MPT2SAS_NOTE_FMT                KERN_NOTICE MPT2SAS_FMT
 129 #define MPT2SAS_WARN_FMT                KERN_WARNING MPT2SAS_FMT
 130 #define MPT2SAS_ERR_FMT                 KERN_ERR MPT2SAS_FMT
 131
 132 /*
 133  * Dell HBA branding
 134  */
 135 #define MPT2SAS_DELL_BRANDING_SIZE                 32
 136
 137 #define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING        "Dell 6Gbps SAS HBA"
 138 #define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING    "Dell PERC H200 Adapter"
 139 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"
 140 #define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING    "Dell PERC H200 Modular"
 141 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING   "Dell PERC H200 Embedded"
 142 #define MPT2SAS_DELL_PERC_H200_BRANDING            "Dell PERC H200"
 143 #define MPT2SAS_DELL_6GBPS_SAS_BRANDING            "Dell 6Gbps SAS"
 144
 145 /*
 146  * Dell HBA SSDIDs
 147  */
 148 #define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID           0x1F1C
 149 #define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID       0x1F1D
 150 #define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID    0x1F1E
 151 #define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID       0x1F1F
 152 #define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID      0x1F20
 153 #define MPT2SAS_DELL_PERC_H200_SSDID               0x1F21
 154 #define MPT2SAS_DELL_6GBPS_SAS_SSDID               0x1F22
 155
 156 /*
 157  * per target private data
 158  */
 159 #define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01
 160 #define MPT_TARGET_FLAGS_VOLUME         0x02
 161 #define MPT_TARGET_FLAGS_DELETED        0x04
 162
 163 /**
 164  * struct MPT2SAS_TARGET - starget private hostdata
 165  * @starget: starget object
 166  * @sas_address: target sas address
 167  * @handle: device handle
 168  * @num_luns: number luns
 169  * @flags: MPT_TARGET_FLAGS_XXX flags
 170  * @deleted: target flaged for deletion
 171  * @tm_busy: target is busy with TM request.
 172  */
 173 struct MPT2SAS_TARGET {
 174         struct scsi_target *starget;
 175         u64     sas_address;
 176         u16     handle;
 177         int     num_luns;
 178         u32     flags;
 179         u8      deleted;
 180         u8      tm_busy;
 181 };
 182
 183 /*
 184  * per device private data
 185  */
 186 #define MPT_DEVICE_FLAGS_INIT           0x01
 187 #define MPT_DEVICE_TLR_ON               0x02
 188
 189 /**
 190  * struct MPT2SAS_DEVICE - sdev private hostdata
 191  * @sas_target: starget private hostdata
 192  * @lun: lun number
 193  * @flags: MPT_DEVICE_XXX flags
 194  * @configured_lun: lun is configured
 195  * @block: device is in SDEV_BLOCK state
 196  * @tlr_snoop_check: flag used in determining whether to disable TLR
 197  */
 198
 199 /* OEM Identifiers */
 200 #define MFG10_OEM_ID_INVALID                   (0x00000000)
 201 #define MFG10_OEM_ID_DELL                      (0x00000001)
 202 #define MFG10_OEM_ID_FSC                       (0x00000002)
 203 #define MFG10_OEM_ID_SUN                       (0x00000003)
 204 #define MFG10_OEM_ID_IBM                       (0x00000004)
 205
 206 /* GENERIC Flags 0*/
 207 #define MFG10_GF0_OCE_DISABLED                 (0x00000001)
 208 #define MFG10_GF0_R1E_DRIVE_COUNT              (0x00000002)
 209 #define MFG10_GF0_R10_DISPLAY                  (0x00000004)
 210 #define MFG10_GF0_SSD_DATA_SCRUB_DISABLE       (0x00000008)
 211 #define MFG10_GF0_SINGLE_DRIVE_R0              (0x00000010)
 212
 213 /* OEM Specific Flags will come from OEM specific header files */
 214 typedef struct _MPI2_CONFIG_PAGE_MAN_10 {
 215     MPI2_CONFIG_PAGE_HEADER Header;                                 /* 00h */
 216     U8                      OEMIdentifier;                          /* 04h */
 217     U8                      Reserved1;                              /* 05h */
 218     U16                     Reserved2;                              /* 08h */
 219     U32                     Reserved3;                              /* 0Ch */
 220     U32                     GenericFlags0;                          /* 10h */
 221     U32                     GenericFlags1;                          /* 14h */
 222     U32                     Reserved4;                              /* 18h */
 223     U32                     OEMSpecificFlags0;                      /* 1Ch */
 224     U32                     OEMSpecificFlags1;                      /* 20h */
 225     U32                     Reserved5[18];                          /* 24h-60h*/
 226 } MPI2_CONFIG_PAGE_MAN_10,
 227   MPI2_POINTER PTR_MPI2_CONFIG_PAGE_MAN_10,
 228   Mpi2ManufacturingPage10_t, MPI2_POINTER pMpi2ManufacturingPage10_t;
 229
 230 struct MPT2SAS_DEVICE {
 231         struct MPT2SAS_TARGET *sas_target;
 232         unsigned int    lun;
 233         u32     flags;
 234         u8      configured_lun;
 235         u8      block;
 236         u8      tlr_snoop_check;
 237 };
 238
 239 #define MPT2_CMD_NOT_USED       0x8000  /* free */
 240 #define MPT2_CMD_COMPLETE       0x0001  /* completed */
 241 #define MPT2_CMD_PENDING        0x0002  /* pending */
 242 #define MPT2_CMD_REPLY_VALID    0x0004  /* reply is valid */
 243 #define MPT2_CMD_RESET          0x0008  /* host reset dropped the command */
 244
 245 /**
 246  * struct _internal_cmd - internal commands struct
 247  * @mutex: mutex
 248  * @done: completion
 249  * @reply: reply message pointer
 250  * @sense: sense data
 251  * @status: MPT2_CMD_XXX status
 252  * @smid: system message id
 253  */
 254 struct _internal_cmd {
 255         struct mutex mutex;
 256         struct completion done;
 257         void    *reply;
 258         void    *sense;
 259         u16     status;
 260         u16     smid;
 261 };
 262
 263
 264 /**
 265  * struct _sas_device - attached device information
 266  * @list: sas device list
 267  * @starget: starget object
 268  * @sas_address: device sas address
 269  * @device_name: retrieved from the SAS IDENTIFY frame.
 270  * @handle: device handle
 271  * @sas_address_parent: sas address of parent expander or sas host
 272  * @enclosure_handle: enclosure handle
 273  * @enclosure_logical_id: enclosure logical identifier
 274  * @volume_handle: volume handle (valid when hidden raid member)
 275  * @volume_wwid: volume unique identifier
 276  * @device_info: bitfield provides detailed info about the device
 277  * @id: target id
 278  * @channel: target channel
 279  * @slot: number number
 280  * @phy: phy identifier provided in sas device page 0
 281  * @responding: used in _scsih_sas_device_mark_responding
 282  */
 283 struct _sas_device {
 284         struct list_head list;
 285         struct scsi_target *starget;
 286         u64     sas_address;
 287         u64     device_name;
 288         u16     handle;
 289         u64     sas_address_parent;
 290         u16     enclosure_handle;
 291         u64     enclosure_logical_id;
 292         u16     volume_handle;
 293         u64     volume_wwid;
 294         u32     device_info;
 295         int     id;
 296         int     channel;
 297         u16     slot;
 298         u8      phy;
 299         u8      responding;
 300 };
 301
 302 /**
 303  * struct _raid_device - raid volume link list
 304  * @list: sas device list
 305  * @starget: starget object
 306  * @sdev: scsi device struct (volumes are single lun)
 307  * @wwid: unique identifier for the volume
 308  * @handle: device handle
 309  * @id: target id
 310  * @channel: target channel
 311  * @volume_type: the raid level
 312  * @device_info: bitfield provides detailed info about the hidden components
 313  * @num_pds: number of hidden raid components
 314  * @responding: used in _scsih_raid_device_mark_responding
 315  * @percent_complete: resync percent complete
 316  */
 317 struct _raid_device {
 318         struct list_head list;
 319         struct scsi_target *starget;
 320         struct scsi_device *sdev;
 321         u64     wwid;
 322         u16     handle;
 323         int     id;
 324         int     channel;
 325         u8      volume_type;
 326         u32     device_info;
 327         u8      num_pds;
 328         u8      responding;
 329         u8      percent_complete;
 330 };
 331
 332 /**
 333  * struct _boot_device - boot device info
 334  * @is_raid: flag to indicate whether this is volume
 335  * @device: holds pointer for either struct _sas_device or
 336  *     struct _raid_device
 337  */
 338 struct _boot_device {
 339         u8 is_raid;
 340         void *device;
 341 };
 342
 343 /**
 344  * struct _sas_port - wide/narrow sas port information
 345  * @port_list: list of ports belonging to expander
 346  * @num_phys: number of phys belonging to this port
 347  * @remote_identify: attached device identification
 348  * @rphy: sas transport rphy object
 349  * @port: sas transport wide/narrow port object
 350  * @phy_list: _sas_phy list objects belonging to this port
 351  */
 352 struct _sas_port {
 353         struct list_head port_list;
 354         u8      num_phys;
 355         struct sas_identify remote_identify;
 356         struct sas_rphy *rphy;
 357         struct sas_port *port;
 358         struct list_head phy_list;
 359 };
 360
 361 /**
 362  * struct _sas_phy - phy information
 363  * @port_siblings: list of phys belonging to a port
 364  * @identify: phy identification
 365  * @remote_identify: attached device identification
 366  * @phy: sas transport phy object
 367  * @phy_id: unique phy id
 368  * @handle: device handle for this phy
 369  * @attached_handle: device handle for attached device
 370  * @phy_belongs_to_port: port has been created for this phy
 371  */
 372 struct _sas_phy {
 373         struct list_head port_siblings;
 374         struct sas_identify identify;
 375         struct sas_identify remote_identify;
 376         struct sas_phy *phy;
 377         u8      phy_id;
 378         u16     handle;
 379         u16     attached_handle;
 380         u8      phy_belongs_to_port;
 381 };
 382
 383 /**
 384  * struct _sas_node - sas_host/expander information
 385  * @list: list of expanders
 386  * @parent_dev: parent device class
 387  * @num_phys: number phys belonging to this sas_host/expander
 388  * @sas_address: sas address of this sas_host/expander
 389  * @handle: handle for this sas_host/expander
 390  * @sas_address_parent: sas address of parent expander or sas host
 391  * @enclosure_handle: handle for this a member of an enclosure
 392  * @device_info: bitwise defining capabilities of this sas_host/expander
 393  * @responding: used in _scsih_expander_device_mark_responding
 394  * @phy: a list of phys that make up this sas_host/expander
 395  * @sas_port_list: list of ports attached to this sas_host/expander
 396  */
 397 struct _sas_node {
 398         struct list_head list;
 399         struct device *parent_dev;
 400         u8      num_phys;
 401         u64     sas_address;
 402         u16     handle;
 403         u64     sas_address_parent;
 404         u16     enclosure_handle;
 405         u64     enclosure_logical_id;
 406         u8      responding;
 407         struct  _sas_phy *phy;
 408         struct list_head sas_port_list;
 409 };
 410
 411 /**
 412  * enum reset_type - reset state
 413  * @FORCE_BIG_HAMMER: issue diagnostic reset
 414  * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer
 415  */
 416 enum reset_type {
 417         FORCE_BIG_HAMMER,
 418         SOFT_RESET,
 419 };
 420
 421 /**
 422  * struct chain_tracker - firmware chain tracker
 423  * @chain_buffer: chain buffer
 424  * @chain_buffer_dma: physical address
 425  * @tracker_list: list of free request (ioc->free_chain_list)
 426  */
 427 struct chain_tracker {
 428         void *chain_buffer;
 429         dma_addr_t chain_buffer_dma;
 430         struct list_head tracker_list;
 431 };
 432
 433 /**
 434  * struct request_tracker - firmware request tracker
 435  * @smid: system message id
 436  * @scmd: scsi request pointer
 437  * @cb_idx: callback index
 438  * @chain_list: list of chains associated to this IO
 439  * @tracker_list: list of free request (ioc->free_list)
 440  */
 441 struct request_tracker {
 442         u16     smid;
 443         struct scsi_cmnd *scmd;
 444         u8      cb_idx;
 445         struct list_head chain_list;
 446         struct list_head tracker_list;
 447 };
 448
 449 /**
 450  * struct _tr_list - target reset list
 451  * @handle: device handle
 452  * @state: state machine
 453  */
 454 struct _tr_list {
 455         struct list_head list;
 456         u16     handle;
 457         u16     state;
 458 };
 459
 460 typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);
 461
 462 /**
 463  * struct MPT2SAS_ADAPTER - per adapter struct
 464  * @list: ioc_list
 465  * @shost: shost object
 466  * @id: unique adapter id
 467  * @pci_irq: irq number
 468  * @name: generic ioc string
 469  * @tmp_string: tmp string used for logging
 470  * @pdev: pci pdev object
 471  * @chip: memory mapped register space
 472  * @chip_phys: physical addrss prior to mapping
 473  * @logging_level: see mpt2sas_debug.h
 474  * @fwfault_debug: debuging FW timeouts
 475  * @ir_firmware: IR firmware present
 476  * @bars: bitmask of BAR's that must be configured
 477  * @mask_interrupts: ignore interrupt
 478  * @fault_reset_work_q_name: fw fault work queue
 479  * @fault_reset_work_q: ""
 480  * @fault_reset_work: ""
 481  * @firmware_event_name: fw event work queue
 482  * @firmware_event_thread: ""
 483  * @fw_events_off: flag to turn off fw event handling
 484  * @fw_event_lock:
 485  * @fw_event_list: list of fw events
 486  * @aen_event_read_flag: event log was read
 487  * @broadcast_aen_busy: broadcast aen waiting to be serviced
 488  * @shost_recovery: host reset in progress
 489  * @ioc_reset_in_progress_lock:
 490  * @ioc_link_reset_in_progress: phy/hard reset in progress
 491  * @ignore_loginfos: ignore loginfos during task management
 492  * @remove_host: flag for when driver unloads, to avoid sending dev resets
 493  * @pci_error_recovery: flag to prevent ioc access until slot reset completes
 494  * @wait_for_port_enable_to_complete:
 495  * @msix_enable: flag indicating msix is enabled
 496  * @msix_vector_count: number msix vectors
 497  * @msix_table: virt address to the msix table
 498  * @msix_table_backup: backup msix table
 499  * @scsi_io_cb_idx: shost generated commands
 500  * @tm_cb_idx: task management commands
 501  * @scsih_cb_idx: scsih internal commands
 502  * @transport_cb_idx: transport internal commands
 503  * @ctl_cb_idx: clt internal commands
 504  * @base_cb_idx: base internal commands
 505  * @config_cb_idx: base internal commands
 506  * @tm_tr_cb_idx : device removal target reset handshake
 507  * @tm_tr_volume_cb_idx : volume removal target reset
 508  * @base_cmds:
 509  * @transport_cmds:
 510  * @scsih_cmds:
 511  * @tm_cmds:
 512  * @ctl_cmds:
 513  * @config_cmds:
 514  * @base_add_sg_single: handler for either 32/64 bit sgl's
 515  * @event_type: bits indicating which events to log
 516  * @event_context: unique id for each logged event
 517  * @event_log: event log pointer
 518  * @event_masks: events that are masked
 519  * @facts: static facts data
 520  * @pfacts: static port facts data
 521  * @manu_pg0: static manufacturing page 0
 522  * @manu_pg10: static manufacturing page 10
 523  * @bios_pg2: static bios page 2
 524  * @bios_pg3: static bios page 3
 525  * @ioc_pg8: static ioc page 8
 526  * @iounit_pg0: static iounit page 0
 527  * @iounit_pg1: static iounit page 1
 528  * @sas_hba: sas host object
 529  * @sas_expander_list: expander object list
 530  * @sas_node_lock:
 531  * @sas_device_list: sas device object list
 532  * @sas_device_init_list: sas device object list (used only at init time)
 533  * @sas_device_lock:
 534  * @io_missing_delay: time for IO completed by fw when PDR enabled
 535  * @device_missing_delay: time for device missing by fw when PDR enabled
 536  * @sas_id : used for setting volume target IDs
 537  * @pd_handles : bitmask for PD handles
 538  * @pd_handles_sz : size of pd_handle bitmask
 539  * @config_page_sz: config page size
 540  * @config_page: reserve memory for config page payload
 541  * @config_page_dma:
 542  * @hba_queue_depth: hba request queue depth
 543  * @sge_size: sg element size for either 32/64 bit
 544  * @scsiio_depth: SCSI_IO queue depth
 545  * @request_sz: per request frame size
 546  * @request: pool of request frames
 547  * @request_dma:
 548  * @request_dma_sz:
 549  * @scsi_lookup: firmware request tracker list
 550  * @scsi_lookup_lock:
 551  * @free_list: free list of request
 552  * @chain: pool of chains
 553  * @pending_io_count:
 554  * @reset_wq:
 555  * @chain_dma:
 556  * @max_sges_in_main_message: number sg elements in main message
 557  * @max_sges_in_chain_message: number sg elements per chain
 558  * @chains_needed_per_io: max chains per io
 559  * @chain_offset_value_for_main_message: location 1st sg in main
 560  * @chain_depth: total chains allocated
 561  * @hi_priority_smid:
 562  * @hi_priority:
 563  * @hi_priority_dma:
 564  * @hi_priority_depth:
 565  * @hpr_lookup:
 566  * @hpr_free_list:
 567  * @internal_smid:
 568  * @internal:
 569  * @internal_dma:
 570  * @internal_depth:
 571  * @internal_lookup:
 572  * @internal_free_list:
 573  * @sense: pool of sense
 574  * @sense_dma:
 575  * @sense_dma_pool:
 576  * @reply_depth: hba reply queue depth:
 577  * @reply_sz: per reply frame size:
 578  * @reply: pool of replys:
 579  * @reply_dma:
 580  * @reply_dma_pool:
 581  * @reply_free_queue_depth: reply free depth
 582  * @reply_free: pool for reply free queue (32 bit addr)
 583  * @reply_free_dma:
 584  * @reply_free_dma_pool:
 585  * @reply_free_host_index: tail index in pool to insert free replys
 586  * @reply_post_queue_depth: reply post queue depth
 587  * @reply_post_free: pool for reply post (64bit descriptor)
 588  * @reply_post_free_dma:
 589  * @reply_post_free_dma_pool:
 590  * @reply_post_host_index: head index in the pool where FW completes IO
 591  * @delayed_tr_list: target reset link list
 592  * @delayed_tr_volume_list: volume target reset link list
 593  */
 594 struct MPT2SAS_ADAPTER {
 595         struct list_head list;
 596         struct Scsi_Host *shost;
 597         u8              id;
 598         u32             pci_irq;
 599         char            name[MPT_NAME_LENGTH];
 600         char            tmp_string[MPT_STRING_LENGTH];
 601         struct pci_dev  *pdev;
 602         Mpi2SystemInterfaceRegs_t __iomem *chip;
 603         resource_size_t chip_phys;
 604         int             logging_level;
 605         int             fwfault_debug;
 606         u8              ir_firmware;
 607         int             bars;
 608         u8              mask_interrupts;
 609
 610         /* fw fault handler */
 611         char            fault_reset_work_q_name[20];
 612         struct workqueue_struct *fault_reset_work_q;
 613         struct delayed_work fault_reset_work;
 614
 615         /* fw event handler */
 616         char            firmware_event_name[20];
 617         struct workqueue_struct *firmware_event_thread;
 618         spinlock_t      fw_event_lock;
 619         struct list_head fw_event_list;
 620
 621          /* misc flags */
 622         int             aen_event_read_flag;
 623         u8              broadcast_aen_busy;
 624         u8              shost_recovery;
 625
 626         struct mutex    reset_in_progress_mutex;
 627         struct completion       shost_recovery_done;
 628         spinlock_t      ioc_reset_in_progress_lock;
 629         u8              ioc_link_reset_in_progress;
 630         int             ioc_reset_in_progress_status;
 631
 632         u8              ignore_loginfos;
 633         u8              remove_host;
 634         u8              pci_error_recovery;
 635         u8              wait_for_port_enable_to_complete;
 636
 637         u8              msix_enable;
 638         u16             msix_vector_count;
 639         u32             *msix_table;
 640         u32             *msix_table_backup;
 641         u32             ioc_reset_count;
 642
 643         /* internal commands, callback index */
 644         u8              scsi_io_cb_idx;
 645         u8              tm_cb_idx;
 646         u8              transport_cb_idx;
 647         u8              scsih_cb_idx;
 648         u8              ctl_cb_idx;
 649         u8              base_cb_idx;
 650         u8              config_cb_idx;
 651         u8              tm_tr_cb_idx;
 652         u8              tm_tr_volume_cb_idx;
 653         u8              tm_sas_control_cb_idx;
 654         struct _internal_cmd base_cmds;
 655         struct _internal_cmd transport_cmds;
 656         struct _internal_cmd scsih_cmds;
 657         struct _internal_cmd tm_cmds;
 658         struct _internal_cmd ctl_cmds;
 659         struct _internal_cmd config_cmds;
 660
 661         MPT_ADD_SGE     base_add_sg_single;
 662
 663         /* event log */
 664         u32             event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 665         u32             event_context;
 666         void            *event_log;
 667         u32             event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
 668
 669         /* static config pages */
 670         Mpi2IOCFactsReply_t facts;
 671         Mpi2PortFactsReply_t *pfacts;
 672         Mpi2ManufacturingPage0_t manu_pg0;
 673         Mpi2BiosPage2_t bios_pg2;
 674         Mpi2BiosPage3_t bios_pg3;
 675         Mpi2IOCPage8_t ioc_pg8;
 676         Mpi2IOUnitPage0_t iounit_pg0;
 677         Mpi2IOUnitPage1_t iounit_pg1;
 678
 679         struct _boot_device req_boot_device;
 680         struct _boot_device req_alt_boot_device;
 681         struct _boot_device current_boot_device;
 682
 683         /* sas hba, expander, and device list */
 684         struct _sas_node sas_hba;
 685         struct list_head sas_expander_list;
 686         spinlock_t      sas_node_lock;
 687         struct list_head sas_device_list;
 688         struct list_head sas_device_init_list;
 689         spinlock_t      sas_device_lock;
 690         struct list_head raid_device_list;
 691         spinlock_t      raid_device_lock;
 692         u8              io_missing_delay;
 693         u16             device_missing_delay;
 694         int             sas_id;
 695
 696         void            *pd_handles;
 697         u16             pd_handles_sz;
 698
 699         /* config page */
 700         u16             config_page_sz;
 701         void            *config_page;
 702         dma_addr_t      config_page_dma;
 703
 704         /* scsiio request */
 705         u16             hba_queue_depth;
 706         u16             sge_size;
 707         u16             scsiio_depth;
 708         u16             request_sz;
 709         u8              *request;
 710         dma_addr_t      request_dma;
 711         u32             request_dma_sz;
 712         struct request_tracker *scsi_lookup;
 713         ulong           scsi_lookup_pages;
 714         spinlock_t      scsi_lookup_lock;
 715         struct list_head free_list;
 716         int             pending_io_count;
 717         wait_queue_head_t reset_wq;
 718
 719         /* chain */
 720         struct chain_tracker *chain_lookup;
 721         struct list_head free_chain_list;
 722         struct dma_pool *chain_dma_pool;
 723         ulong           chain_pages;
 724         u16             max_sges_in_main_message;
 725         u16             max_sges_in_chain_message;
 726         u16             chains_needed_per_io;
 727         u16             chain_offset_value_for_main_message;
 728         u32             chain_depth;
 729
 730         /* hi-priority queue */
 731         u16             hi_priority_smid;
 732         u8              *hi_priority;
 733         dma_addr_t      hi_priority_dma;
 734         u16             hi_priority_depth;
 735         struct request_tracker *hpr_lookup;
 736         struct list_head hpr_free_list;
 737
 738         /* internal queue */
 739         u16             internal_smid;
 740         u8              *internal;
 741         dma_addr_t      internal_dma;
 742         u16             internal_depth;
 743         struct request_tracker *internal_lookup;
 744         struct list_head internal_free_list;
 745
 746         /* sense */
 747         u8              *sense;
 748         dma_addr_t      sense_dma;
 749         struct dma_pool *sense_dma_pool;
 750
 751         /* reply */
 752         u16             reply_sz;
 753         u8              *reply;
 754         dma_addr_t      reply_dma;
 755         u32             reply_dma_max_address;
 756         u32             reply_dma_min_address;
 757         struct dma_pool *reply_dma_pool;
 758
 759         /* reply free queue */
 760         u16             reply_free_queue_depth;
 761         u32             *reply_free;
 762         dma_addr_t      reply_free_dma;
 763         struct dma_pool *reply_free_dma_pool;
 764         u32             reply_free_host_index;
 765
 766         /* reply post queue */
 767         u16             reply_post_queue_depth;
 768         Mpi2ReplyDescriptorsUnion_t *reply_post_free;
 769         dma_addr_t      reply_post_free_dma;
 770         struct dma_pool *reply_post_free_dma_pool;
 771         u32             reply_post_host_index;
 772
 773         struct list_head delayed_tr_list;
 774         struct list_head delayed_tr_volume_list;
 775
 776         /* diag buffer support */
 777         u8              *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];
 778         u32             diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];
 779         dma_addr_t      diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];
 780         u8              diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];
 781         u32             unique_id[MPI2_DIAG_BUF_TYPE_COUNT];
 782         Mpi2ManufacturingPage10_t manu_pg10;
 783         u32             product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];
 784         u32             diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];
 785         u32             ring_buffer_offset;
 786         u32             ring_buffer_sz;
 787 };
 788
 789 typedef u8 (*MPT_CALLBACK)(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 790     u32 reply);
 791
 792
 793 /* base shared API */
 794 extern struct list_head mpt2sas_ioc_list;
 795 void mpt2sas_base_start_watchdog(struct MPT2SAS_ADAPTER *ioc);
 796 void mpt2sas_base_stop_watchdog(struct MPT2SAS_ADAPTER *ioc);
 797
 798 int mpt2sas_base_attach(struct MPT2SAS_ADAPTER *ioc);
 799 void mpt2sas_base_detach(struct MPT2SAS_ADAPTER *ioc);
 800 int mpt2sas_base_map_resources(struct MPT2SAS_ADAPTER *ioc);
 801 void mpt2sas_base_free_resources(struct MPT2SAS_ADAPTER *ioc);
 802 int mpt2sas_base_hard_reset_handler(struct MPT2SAS_ADAPTER *ioc, int sleep_flag,
 803     enum reset_type type);
 804
 805 void *mpt2sas_base_get_msg_frame(struct MPT2SAS_ADAPTER *ioc, u16 smid);
 806 void *mpt2sas_base_get_sense_buffer(struct MPT2SAS_ADAPTER *ioc, u16 smid);
 807 void mpt2sas_base_build_zero_len_sge(struct MPT2SAS_ADAPTER *ioc, void *paddr);
 808 __le32 mpt2sas_base_get_sense_buffer_dma(struct MPT2SAS_ADAPTER *ioc,
 809     u16 smid);
 810
 811 /* hi-priority queue */
 812 u16 mpt2sas_base_get_smid_hpr(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
 813 u16 mpt2sas_base_get_smid_scsiio(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx,
 814     struct scsi_cmnd *scmd);
 815
 816 u16 mpt2sas_base_get_smid(struct MPT2SAS_ADAPTER *ioc, u8 cb_idx);
 817 void mpt2sas_base_free_smid(struct MPT2SAS_ADAPTER *ioc, u16 smid);
 818 void mpt2sas_base_put_smid_scsi_io(struct MPT2SAS_ADAPTER *ioc, u16 smid,
 819     u16 handle);
 820 void mpt2sas_base_put_smid_hi_priority(struct MPT2SAS_ADAPTER *ioc, u16 smid);
 821 void mpt2sas_base_put_smid_target_assist(struct MPT2SAS_ADAPTER *ioc, u16 smid,
 822     u16 io_index);
 823 void mpt2sas_base_put_smid_default(struct MPT2SAS_ADAPTER *ioc, u16 smid);
 824 void mpt2sas_base_initialize_callback_handler(void);
 825 u8 mpt2sas_base_register_callback_handler(MPT_CALLBACK cb_func);
 826 void mpt2sas_base_release_callback_handler(u8 cb_idx);
 827
 828 u8 mpt2sas_base_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 829     u32 reply);
 830 void *mpt2sas_base_get_reply_virt_addr(struct MPT2SAS_ADAPTER *ioc, u32 phys_addr);
 831
 832 u32 mpt2sas_base_get_iocstate(struct MPT2SAS_ADAPTER *ioc, int cooked);
 833
 834 void mpt2sas_base_fault_info(struct MPT2SAS_ADAPTER *ioc , u16 fault_code);
 835 int mpt2sas_base_sas_iounit_control(struct MPT2SAS_ADAPTER *ioc,
 836     Mpi2SasIoUnitControlReply_t *mpi_reply, Mpi2SasIoUnitControlRequest_t
 837     *mpi_request);
 838 int mpt2sas_base_scsi_enclosure_processor(struct MPT2SAS_ADAPTER *ioc,
 839     Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);
 840 void mpt2sas_base_validate_event_type(struct MPT2SAS_ADAPTER *ioc, u32 *event_type);
 841
 842 void mpt2sas_halt_firmware(struct MPT2SAS_ADAPTER *ioc);
 843
 844 /* scsih shared API */
 845 u8 mpt2sas_scsih_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
 846     u32 reply);
 847 int mpt2sas_scsih_issue_tm(struct MPT2SAS_ADAPTER *ioc, u16 handle,
 848     uint channel, uint id, uint lun, u8 type, u16 smid_task,
 849     ulong timeout, struct scsi_cmnd *scmd);
 850 void mpt2sas_scsih_set_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
 851 void mpt2sas_scsih_clear_tm_flag(struct MPT2SAS_ADAPTER *ioc, u16 handle);
 852 void mpt2sas_expander_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
 853 void mpt2sas_device_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
 854 struct _sas_node *mpt2sas_scsih_expander_find_by_handle(struct MPT2SAS_ADAPTER *ioc,
 855     u16 handle);
 856 struct _sas_node *mpt2sas_scsih_expander_find_by_sas_address(struct MPT2SAS_ADAPTER
 857     *ioc, u64 sas_address);
 858 struct _sas_device *mpt2sas_scsih_sas_device_find_by_sas_address(
 859     struct MPT2SAS_ADAPTER *ioc, u64 sas_address);
 860
 861 void mpt2sas_scsih_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
 862
 863 /* config shared API */
 864 u8 mpt2sas_config_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 865     u32 reply);
 866 int mpt2sas_config_get_number_hba_phys(struct MPT2SAS_ADAPTER *ioc, u8 *num_phys);
 867 int mpt2sas_config_get_manufacturing_pg0(struct MPT2SAS_ADAPTER *ioc,
 868     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);
 869 int mpt2sas_config_get_manufacturing_pg10(struct MPT2SAS_ADAPTER *ioc,
 870     Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage10_t *config_page);
 871 int mpt2sas_config_get_bios_pg2(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 872     *mpi_reply, Mpi2BiosPage2_t *config_page);
 873 int mpt2sas_config_get_bios_pg3(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 874     *mpi_reply, Mpi2BiosPage3_t *config_page);
 875 int mpt2sas_config_get_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 876     *mpi_reply, Mpi2IOUnitPage0_t *config_page);
 877 int mpt2sas_config_get_sas_device_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 878     *mpi_reply, Mpi2SasDevicePage0_t *config_page, u32 form, u32 handle);
 879 int mpt2sas_config_get_sas_device_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 880     *mpi_reply, Mpi2SasDevicePage1_t *config_page, u32 form, u32 handle);
 881 int mpt2sas_config_get_sas_iounit_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 882     *mpi_reply, Mpi2SasIOUnitPage0_t *config_page, u16 sz);
 883 int mpt2sas_config_get_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 884     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
 885 int mpt2sas_config_set_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 886     *mpi_reply, Mpi2IOUnitPage1_t *config_page);
 887 int mpt2sas_config_get_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 888     *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
 889 int mpt2sas_config_set_sas_iounit_pg1(struct MPT2SAS_ADAPTER *ioc,
 890     Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page, u16 sz);
 891 int mpt2sas_config_get_ioc_pg8(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 892     *mpi_reply, Mpi2IOCPage8_t *config_page);
 893 int mpt2sas_config_get_expander_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 894     *mpi_reply, Mpi2ExpanderPage0_t *config_page, u32 form, u32 handle);
 895 int mpt2sas_config_get_expander_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 896     *mpi_reply, Mpi2ExpanderPage1_t *config_page, u32 phy_number, u16 handle);
 897 int mpt2sas_config_get_enclosure_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 898     *mpi_reply, Mpi2SasEnclosurePage0_t *config_page, u32 form, u32 handle);
 899 int mpt2sas_config_get_phy_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 900     *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);
 901 int mpt2sas_config_get_phy_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 902     *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);
 903 int mpt2sas_config_get_raid_volume_pg1(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 904     *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, u32 handle);
 905 int mpt2sas_config_get_number_pds(struct MPT2SAS_ADAPTER *ioc, u16 handle, u8 *num_pds);
 906 int mpt2sas_config_get_raid_volume_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 907     *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form, u32 handle, u16 sz);
 908 int mpt2sas_config_get_phys_disk_pg0(struct MPT2SAS_ADAPTER *ioc, Mpi2ConfigReply_t
 909     *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, u32 form,
 910     u32 form_specific);
 911 int mpt2sas_config_get_volume_handle(struct MPT2SAS_ADAPTER *ioc, u16 pd_handle,
 912     u16 *volume_handle);
 913 int mpt2sas_config_get_volume_wwid(struct MPT2SAS_ADAPTER *ioc, u16 volume_handle,
 914     u64 *wwid);
 915 /* ctl shared API */
 916 extern struct device_attribute *mpt2sas_host_attrs[];
 917 extern struct device_attribute *mpt2sas_dev_attrs[];
 918 void mpt2sas_ctl_init(void);
 919 void mpt2sas_ctl_exit(void);
 920 u8 mpt2sas_ctl_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 921     u32 reply);
 922 void mpt2sas_ctl_reset_handler(struct MPT2SAS_ADAPTER *ioc, int reset_phase);
 923 u8 mpt2sas_ctl_event_callback(struct MPT2SAS_ADAPTER *ioc, u8 msix_index,
 924     u32 reply);
 925 void mpt2sas_ctl_add_to_event_log(struct MPT2SAS_ADAPTER *ioc,
 926     Mpi2EventNotificationReply_t *mpi_reply);
 927
 928 void mpt2sas_enable_diag_buffer(struct MPT2SAS_ADAPTER *ioc,
 929         u8 bits_to_regsiter);
 930
 931 /* transport shared API */
 932 u8 mpt2sas_transport_done(struct MPT2SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
 933     u32 reply);
 934 struct _sas_port *mpt2sas_transport_port_add(struct MPT2SAS_ADAPTER *ioc,
 935      u16 handle, u64 sas_address);
 936 void mpt2sas_transport_port_remove(struct MPT2SAS_ADAPTER *ioc, u64 sas_address,
 937      u64 sas_address_parent);
 938 int mpt2sas_transport_add_host_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
 939     *mpt2sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);
 940 int mpt2sas_transport_add_expander_phy(struct MPT2SAS_ADAPTER *ioc, struct _sas_phy
 941     *mpt2sas_phy, Mpi2ExpanderPage1_t expander_pg1, struct device *parent_dev);
 942 void mpt2sas_transport_update_links(struct MPT2SAS_ADAPTER *ioc,
 943      u64 sas_address, u16 handle, u8 phy_number, u8 link_rate);
 944 extern struct sas_function_template mpt2sas_transport_functions;
 945 extern struct scsi_transport_template *mpt2sas_transport_template;
 946 extern int scsi_internal_device_block(struct scsi_device *sdev);
 947 extern u8 mpt2sas_stm_zero_smid_handler(struct MPT2SAS_ADAPTER *ioc,
 948     u8 msix_index, u32 reply);
 949 extern int scsi_internal_device_unblock(struct scsi_device *sdev);
 950
 951 #endif /* MPT2SAS_BASE_H_INCLUDED */