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