2071 lines · c
1/*2 * This is the Fusion MPT base driver providing common API layer interface3 * for access to MPT (Message Passing Technology) firmware.4 *5 * This code is based on drivers/scsi/mpt3sas/mpt3sas_base.h6 * Copyright (C) 2012-2014 LSI Corporation7 * Copyright (C) 2013-2014 Avago Technologies8 * (mailto: MPT-FusionLinux.pdl@avagotech.com)9 *10 * This program is free software; you can redistribute it and/or11 * modify it under the terms of the GNU General Public License12 * as published by the Free Software Foundation; either version 213 * 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 of17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the18 * GNU General Public License for more details.19 *20 * NO WARRANTY21 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR22 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT23 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,24 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is25 * solely responsible for determining the appropriateness of using and26 * distributing the Program and assumes all risks associated with its27 * exercise of rights under this Agreement, including but not limited to28 * 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 LIABILITY32 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY33 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL34 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND35 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR36 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE37 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED38 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES39 40 * You should have received a copy of the GNU General Public License41 * along with this program; if not, write to the Free Software42 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,43 * USA.44 */45 46#ifndef MPT3SAS_BASE_H_INCLUDED47#define MPT3SAS_BASE_H_INCLUDED48 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#include "mpi/mpi2_pci.h"58#include "mpi/mpi2_image.h"59 60#include <scsi/scsi.h>61#include <scsi/scsi_cmnd.h>62#include <scsi/scsi_device.h>63#include <scsi/scsi_host.h>64#include <scsi/scsi_tcq.h>65#include <scsi/scsi_transport_sas.h>66#include <scsi/scsi_dbg.h>67#include <scsi/scsi_eh.h>68#include <linux/pci.h>69#include <linux/poll.h>70#include <linux/irq_poll.h>71 72#include "mpt3sas_debug.h"73#include "mpt3sas_trigger_diag.h"74#include "mpt3sas_trigger_pages.h"75 76/* driver versioning info */77#define MPT3SAS_DRIVER_NAME "mpt3sas"78#define MPT3SAS_AUTHOR "Avago Technologies <MPT-FusionLinux.pdl@avagotech.com>"79#define MPT3SAS_DESCRIPTION "LSI MPT Fusion SAS 3.0 Device Driver"80#define MPT3SAS_DRIVER_VERSION "48.100.00.00"81#define MPT3SAS_MAJOR_VERSION 4882#define MPT3SAS_MINOR_VERSION 10083#define MPT3SAS_BUILD_VERSION 084#define MPT3SAS_RELEASE_VERSION 0085 86#define MPT2SAS_DRIVER_NAME "mpt2sas"87#define MPT2SAS_DESCRIPTION "LSI MPT Fusion SAS 2.0 Device Driver"88#define MPT2SAS_DRIVER_VERSION "20.102.00.00"89#define MPT2SAS_MAJOR_VERSION 2090#define MPT2SAS_MINOR_VERSION 10291#define MPT2SAS_BUILD_VERSION 092#define MPT2SAS_RELEASE_VERSION 0093 94/* CoreDump: Default timeout */95#define MPT3SAS_DEFAULT_COREDUMP_TIMEOUT_SECONDS (15) /*15 seconds*/96#define MPT3SAS_COREDUMP_LOOP_DONE (0xFF)97#define MPT3SAS_TIMESYNC_TIMEOUT_SECONDS (10) /* 10 seconds */98#define MPT3SAS_TIMESYNC_UPDATE_INTERVAL (900) /* 15 minutes */99#define MPT3SAS_TIMESYNC_UNIT_MASK (0x80) /* bit 7 */100#define MPT3SAS_TIMESYNC_MASK (0x7F) /* 0 - 6 bits */101#define SECONDS_PER_MIN (60)102#define SECONDS_PER_HOUR (3600)103#define MPT3SAS_COREDUMP_LOOP_DONE (0xFF)104#define MPI26_SET_IOC_PARAMETER_SYNC_TIMESTAMP (0x81)105 106/*107 * Set MPT3SAS_SG_DEPTH value based on user input.108 */109#define MPT_MAX_PHYS_SEGMENTS SG_CHUNK_SIZE110#define MPT_MIN_PHYS_SEGMENTS 16111#define MPT_KDUMP_MIN_PHYS_SEGMENTS 32112 113#define MCPU_MAX_CHAINS_PER_IO 3114 115#ifdef CONFIG_SCSI_MPT3SAS_MAX_SGE116#define MPT3SAS_SG_DEPTH CONFIG_SCSI_MPT3SAS_MAX_SGE117#else118#define MPT3SAS_SG_DEPTH MPT_MAX_PHYS_SEGMENTS119#endif120 121#ifdef CONFIG_SCSI_MPT2SAS_MAX_SGE122#define MPT2SAS_SG_DEPTH CONFIG_SCSI_MPT2SAS_MAX_SGE123#else124#define MPT2SAS_SG_DEPTH MPT_MAX_PHYS_SEGMENTS125#endif126 127/*128 * Generic Defines129 */130#define MPT3SAS_SATA_QUEUE_DEPTH 32131#define MPT3SAS_SAS_QUEUE_DEPTH 254132#define MPT3SAS_RAID_QUEUE_DEPTH 128133#define MPT3SAS_KDUMP_SCSI_IO_DEPTH 200134 135#define MPT3SAS_RAID_MAX_SECTORS 8192136#define MPT3SAS_HOST_PAGE_SIZE_4K 12137#define MPT3SAS_NVME_QUEUE_DEPTH 128138#define MPT_NAME_LENGTH 32 /* generic length of strings */139#define MPT_STRING_LENGTH 64140#define MPI_FRAME_START_OFFSET 256141#define REPLY_FREE_POOL_SIZE 512 /*(32 maxcredix *4)*(4 times)*/142 143#define MPT_MAX_CALLBACKS 32144 145#define MPT_MAX_HBA_NUM_PHYS 32146 147#define INTERNAL_CMDS_COUNT 10 /* reserved cmds */148/* reserved for issuing internally framed scsi io cmds */149#define INTERNAL_SCSIIO_CMDS_COUNT 3150 151#define MPI3_HIM_MASK 0xFFFFFFFF /* mask every bit*/152 153#define MPT3SAS_INVALID_DEVICE_HANDLE 0xFFFF154 155#define MAX_CHAIN_ELEMT_SZ 16156#define DEFAULT_NUM_FWCHAIN_ELEMTS 8157 158#define IO_UNIT_CONTROL_SHUTDOWN_TIMEOUT 6159#define FW_IMG_HDR_READ_TIMEOUT 15160 161#define IOC_OPERATIONAL_WAIT_COUNT 10162 163/*164 * NVMe defines165 */166#define NVME_PRP_SIZE 8 /* PRP size */167#define NVME_ERROR_RESPONSE_SIZE 16 /* Max NVME Error Response */168#define NVME_TASK_ABORT_MIN_TIMEOUT 6169#define NVME_TASK_ABORT_MAX_TIMEOUT 60170#define NVME_TASK_MNGT_CUSTOM_MASK (0x0010)171#define NVME_PRP_PAGE_SIZE 4096 /* Page size */172 173struct mpt3sas_nvme_cmd {174 u8 rsvd[24];175 __le64 prp1;176 __le64 prp2;177};178 179/*180 * logging format181 */182#define ioc_err(ioc, fmt, ...) \183 pr_err("%s: " fmt, (ioc)->name, ##__VA_ARGS__)184#define ioc_notice(ioc, fmt, ...) \185 pr_notice("%s: " fmt, (ioc)->name, ##__VA_ARGS__)186#define ioc_warn(ioc, fmt, ...) \187 pr_warn("%s: " fmt, (ioc)->name, ##__VA_ARGS__)188#define ioc_info(ioc, fmt, ...) \189 pr_info("%s: " fmt, (ioc)->name, ##__VA_ARGS__)190 191/*192 * WarpDrive Specific Log codes193 */194 195#define MPT2_WARPDRIVE_LOGENTRY (0x8002)196#define MPT2_WARPDRIVE_LC_SSDT (0x41)197#define MPT2_WARPDRIVE_LC_SSDLW (0x43)198#define MPT2_WARPDRIVE_LC_SSDLF (0x44)199#define MPT2_WARPDRIVE_LC_BRMF (0x4D)200 201/*202 * per target private data203 */204#define MPT_TARGET_FLAGS_RAID_COMPONENT 0x01205#define MPT_TARGET_FLAGS_VOLUME 0x02206#define MPT_TARGET_FLAGS_DELETED 0x04207#define MPT_TARGET_FASTPATH_IO 0x08208#define MPT_TARGET_FLAGS_PCIE_DEVICE 0x10209 210#define SAS2_PCI_DEVICE_B0_REVISION (0x01)211#define SAS3_PCI_DEVICE_C0_REVISION (0x02)212 213/* Atlas PCIe Switch Management Port */214#define MPI26_ATLAS_PCIe_SWITCH_DEVID (0x00B2)215 216/*217 * Intel HBA branding218 */219#define MPT2SAS_INTEL_RMS25JB080_BRANDING \220 "Intel(R) Integrated RAID Module RMS25JB080"221#define MPT2SAS_INTEL_RMS25JB040_BRANDING \222 "Intel(R) Integrated RAID Module RMS25JB040"223#define MPT2SAS_INTEL_RMS25KB080_BRANDING \224 "Intel(R) Integrated RAID Module RMS25KB080"225#define MPT2SAS_INTEL_RMS25KB040_BRANDING \226 "Intel(R) Integrated RAID Module RMS25KB040"227#define MPT2SAS_INTEL_RMS25LB040_BRANDING \228 "Intel(R) Integrated RAID Module RMS25LB040"229#define MPT2SAS_INTEL_RMS25LB080_BRANDING \230 "Intel(R) Integrated RAID Module RMS25LB080"231#define MPT2SAS_INTEL_RMS2LL080_BRANDING \232 "Intel Integrated RAID Module RMS2LL080"233#define MPT2SAS_INTEL_RMS2LL040_BRANDING \234 "Intel Integrated RAID Module RMS2LL040"235#define MPT2SAS_INTEL_RS25GB008_BRANDING \236 "Intel(R) RAID Controller RS25GB008"237#define MPT2SAS_INTEL_SSD910_BRANDING \238 "Intel(R) SSD 910 Series"239 240#define MPT3SAS_INTEL_RMS3JC080_BRANDING \241 "Intel(R) Integrated RAID Module RMS3JC080"242#define MPT3SAS_INTEL_RS3GC008_BRANDING \243 "Intel(R) RAID Controller RS3GC008"244#define MPT3SAS_INTEL_RS3FC044_BRANDING \245 "Intel(R) RAID Controller RS3FC044"246#define MPT3SAS_INTEL_RS3UC080_BRANDING \247 "Intel(R) RAID Controller RS3UC080"248 249/*250 * Intel HBA SSDIDs251 */252#define MPT2SAS_INTEL_RMS25JB080_SSDID 0x3516253#define MPT2SAS_INTEL_RMS25JB040_SSDID 0x3517254#define MPT2SAS_INTEL_RMS25KB080_SSDID 0x3518255#define MPT2SAS_INTEL_RMS25KB040_SSDID 0x3519256#define MPT2SAS_INTEL_RMS25LB040_SSDID 0x351A257#define MPT2SAS_INTEL_RMS25LB080_SSDID 0x351B258#define MPT2SAS_INTEL_RMS2LL080_SSDID 0x350E259#define MPT2SAS_INTEL_RMS2LL040_SSDID 0x350F260#define MPT2SAS_INTEL_RS25GB008_SSDID 0x3000261#define MPT2SAS_INTEL_SSD910_SSDID 0x3700262 263#define MPT3SAS_INTEL_RMS3JC080_SSDID 0x3521264#define MPT3SAS_INTEL_RS3GC008_SSDID 0x3522265#define MPT3SAS_INTEL_RS3FC044_SSDID 0x3523266#define MPT3SAS_INTEL_RS3UC080_SSDID 0x3524267 268/*269 * Dell HBA branding270 */271#define MPT2SAS_DELL_BRANDING_SIZE 32272 273#define MPT2SAS_DELL_6GBPS_SAS_HBA_BRANDING "Dell 6Gbps SAS HBA"274#define MPT2SAS_DELL_PERC_H200_ADAPTER_BRANDING "Dell PERC H200 Adapter"275#define MPT2SAS_DELL_PERC_H200_INTEGRATED_BRANDING "Dell PERC H200 Integrated"276#define MPT2SAS_DELL_PERC_H200_MODULAR_BRANDING "Dell PERC H200 Modular"277#define MPT2SAS_DELL_PERC_H200_EMBEDDED_BRANDING "Dell PERC H200 Embedded"278#define MPT2SAS_DELL_PERC_H200_BRANDING "Dell PERC H200"279#define MPT2SAS_DELL_6GBPS_SAS_BRANDING "Dell 6Gbps SAS"280 281#define MPT3SAS_DELL_12G_HBA_BRANDING \282 "Dell 12Gbps HBA"283 284/*285 * Dell HBA SSDIDs286 */287#define MPT2SAS_DELL_6GBPS_SAS_HBA_SSDID 0x1F1C288#define MPT2SAS_DELL_PERC_H200_ADAPTER_SSDID 0x1F1D289#define MPT2SAS_DELL_PERC_H200_INTEGRATED_SSDID 0x1F1E290#define MPT2SAS_DELL_PERC_H200_MODULAR_SSDID 0x1F1F291#define MPT2SAS_DELL_PERC_H200_EMBEDDED_SSDID 0x1F20292#define MPT2SAS_DELL_PERC_H200_SSDID 0x1F21293#define MPT2SAS_DELL_6GBPS_SAS_SSDID 0x1F22294 295#define MPT3SAS_DELL_12G_HBA_SSDID 0x1F46296 297/*298 * Cisco HBA branding299 */300#define MPT3SAS_CISCO_12G_8E_HBA_BRANDING \301 "Cisco 9300-8E 12G SAS HBA"302#define MPT3SAS_CISCO_12G_8I_HBA_BRANDING \303 "Cisco 9300-8i 12G SAS HBA"304#define MPT3SAS_CISCO_12G_AVILA_HBA_BRANDING \305 "Cisco 12G Modular SAS Pass through Controller"306#define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_BRANDING \307 "UCS C3X60 12G SAS Pass through Controller"308/*309 * Cisco HBA SSSDIDs310 */311#define MPT3SAS_CISCO_12G_8E_HBA_SSDID 0x14C312#define MPT3SAS_CISCO_12G_8I_HBA_SSDID 0x154313#define MPT3SAS_CISCO_12G_AVILA_HBA_SSDID 0x155314#define MPT3SAS_CISCO_12G_COLUSA_MEZZANINE_HBA_SSDID 0x156315 316/*317 * status bits for ioc->diag_buffer_status318 */319#define MPT3_DIAG_BUFFER_IS_REGISTERED (0x01)320#define MPT3_DIAG_BUFFER_IS_RELEASED (0x02)321#define MPT3_DIAG_BUFFER_IS_DIAG_RESET (0x04)322#define MPT3_DIAG_BUFFER_IS_DRIVER_ALLOCATED (0x08)323#define MPT3_DIAG_BUFFER_IS_APP_OWNED (0x10)324 325/*326 * HP HBA branding327 */328#define MPT2SAS_HP_3PAR_SSVID 0x1590329 330#define MPT2SAS_HP_2_4_INTERNAL_BRANDING \331 "HP H220 Host Bus Adapter"332#define MPT2SAS_HP_2_4_EXTERNAL_BRANDING \333 "HP H221 Host Bus Adapter"334#define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_BRANDING \335 "HP H222 Host Bus Adapter"336#define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_BRANDING \337 "HP H220i Host Bus Adapter"338#define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_BRANDING \339 "HP H210i Host Bus Adapter"340 341/*342 * HO HBA SSDIDs343 */344#define MPT2SAS_HP_2_4_INTERNAL_SSDID 0x0041345#define MPT2SAS_HP_2_4_EXTERNAL_SSDID 0x0042346#define MPT2SAS_HP_1_4_INTERNAL_1_4_EXTERNAL_SSDID 0x0043347#define MPT2SAS_HP_EMBEDDED_2_4_INTERNAL_SSDID 0x0044348#define MPT2SAS_HP_DAUGHTER_2_4_INTERNAL_SSDID 0x0046349 350/*351 * Combined Reply Queue constants,352 * There are twelve Supplemental Reply Post Host Index Registers353 * and each register is at offset 0x10 bytes from the previous one.354 */355#define MAX_COMBINED_MSIX_VECTORS(gen35) ((gen35 == 1) ? 16 : 8)356#define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT_G3 12357#define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_COUNT_G35 16358#define MPT3_SUP_REPLY_POST_HOST_INDEX_REG_OFFSET (0x10)359#define MPT3_MIN_IRQS 1360 361/* OEM Identifiers */362#define MFG10_OEM_ID_INVALID (0x00000000)363#define MFG10_OEM_ID_DELL (0x00000001)364#define MFG10_OEM_ID_FSC (0x00000002)365#define MFG10_OEM_ID_SUN (0x00000003)366#define MFG10_OEM_ID_IBM (0x00000004)367 368/* GENERIC Flags 0*/369#define MFG10_GF0_OCE_DISABLED (0x00000001)370#define MFG10_GF0_R1E_DRIVE_COUNT (0x00000002)371#define MFG10_GF0_R10_DISPLAY (0x00000004)372#define MFG10_GF0_SSD_DATA_SCRUB_DISABLE (0x00000008)373#define MFG10_GF0_SINGLE_DRIVE_R0 (0x00000010)374 375#define VIRTUAL_IO_FAILED_RETRY (0x32010081)376 377/* High IOPs definitions */378#define MPT3SAS_DEVICE_HIGH_IOPS_DEPTH 8379#define MPT3SAS_HIGH_IOPS_REPLY_QUEUES 8380#define MPT3SAS_HIGH_IOPS_BATCH_COUNT 16381#define MPT3SAS_GEN35_MAX_MSIX_QUEUES 128382#define RDPQ_MAX_INDEX_IN_ONE_CHUNK 16383 384/* OEM Specific Flags will come from OEM specific header files */385struct Mpi2ManufacturingPage10_t {386 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */387 U8 OEMIdentifier; /* 04h */388 U8 Reserved1; /* 05h */389 U16 Reserved2; /* 08h */390 U32 Reserved3; /* 0Ch */391 U32 GenericFlags0; /* 10h */392 U32 GenericFlags1; /* 14h */393 U32 Reserved4; /* 18h */394 U32 OEMSpecificFlags0; /* 1Ch */395 U32 OEMSpecificFlags1; /* 20h */396 U32 Reserved5[18]; /* 24h - 60h*/397};398 399 400/* Miscellaneous options */401struct Mpi2ManufacturingPage11_t {402 MPI2_CONFIG_PAGE_HEADER Header; /* 00h */403 __le32 Reserved1; /* 04h */404 u8 Reserved2; /* 08h */405 u8 EEDPTagMode; /* 09h */406 u8 Reserved3; /* 0Ah */407 u8 Reserved4; /* 0Bh */408 __le32 Reserved5[8]; /* 0Ch-2Ch */409 u16 AddlFlags2; /* 2Ch */410 u8 AddlFlags3; /* 2Eh */411 u8 Reserved6; /* 2Fh */412 __le32 Reserved7[7]; /* 30h - 4Bh */413 u8 NVMeAbortTO; /* 4Ch */414 u8 NumPerDevEvents; /* 4Dh */415 u8 HostTraceBufferDecrementSizeKB; /* 4Eh */416 u8 HostTraceBufferFlags; /* 4Fh */417 u16 HostTraceBufferMaxSizeKB; /* 50h */418 u16 HostTraceBufferMinSizeKB; /* 52h */419 u8 CoreDumpTOSec; /* 54h */420 u8 TimeSyncInterval; /* 55h */421 u16 Reserved9; /* 56h */422 __le32 Reserved10; /* 58h */423};424 425/**426 * struct MPT3SAS_TARGET - starget private hostdata427 * @starget: starget object428 * @sas_address: target sas address429 * @raid_device: raid_device pointer to access volume data430 * @handle: device handle431 * @num_luns: number luns432 * @flags: MPT_TARGET_FLAGS_XXX flags433 * @deleted: target flaged for deletion434 * @tm_busy: target is busy with TM request.435 * @port: hba port entry containing target's port number info436 * @sas_dev: The sas_device associated with this target437 * @pcie_dev: The pcie device associated with this target438 */439struct MPT3SAS_TARGET {440 struct scsi_target *starget;441 u64 sas_address;442 struct _raid_device *raid_device;443 u16 handle;444 int num_luns;445 u32 flags;446 u8 deleted;447 u8 tm_busy;448 struct hba_port *port;449 struct _sas_device *sas_dev;450 struct _pcie_device *pcie_dev;451};452 453 454/*455 * per device private data456 */457#define MPT_DEVICE_FLAGS_INIT 0x01458 459#define MFG_PAGE10_HIDE_SSDS_MASK (0x00000003)460#define MFG_PAGE10_HIDE_ALL_DISKS (0x00)461#define MFG_PAGE10_EXPOSE_ALL_DISKS (0x01)462#define MFG_PAGE10_HIDE_IF_VOL_PRESENT (0x02)463 464/**465 * struct MPT3SAS_DEVICE - sdev private hostdata466 * @sas_target: starget private hostdata467 * @lun: lun number468 * @flags: MPT_DEVICE_XXX flags469 * @configured_lun: lun is configured470 * @block: device is in SDEV_BLOCK state471 * @tlr_snoop_check: flag used in determining whether to disable TLR472 * @eedp_enable: eedp support enable bit473 * @eedp_type: 0(type_1), 1(type_2), 2(type_3)474 * @eedp_block_length: block size475 * @ata_command_pending: SATL passthrough outstanding for device476 */477struct MPT3SAS_DEVICE {478 struct MPT3SAS_TARGET *sas_target;479 unsigned int lun;480 u32 flags;481 u8 configured_lun;482 u8 block;483 u8 tlr_snoop_check;484 u8 ignore_delay_remove;485 /* Iopriority Command Handling */486 u8 ncq_prio_enable;487 /*488 * Bug workaround for SATL handling: the mpt2/3sas firmware489 * doesn't return BUSY or TASK_SET_FULL for subsequent490 * commands while a SATL pass through is in operation as the491 * spec requires, it simply does nothing with them until the492 * pass through completes, causing them possibly to timeout if493 * the passthrough is a long executing command (like format or494 * secure erase). This variable allows us to do the right495 * thing while a SATL command is pending.496 */497 unsigned long ata_command_pending;498 499};500 501#define MPT3_CMD_NOT_USED 0x8000 /* free */502#define MPT3_CMD_COMPLETE 0x0001 /* completed */503#define MPT3_CMD_PENDING 0x0002 /* pending */504#define MPT3_CMD_REPLY_VALID 0x0004 /* reply is valid */505#define MPT3_CMD_RESET 0x0008 /* host reset dropped the command */506#define MPT3_CMD_COMPLETE_ASYNC 0x0010 /* tells whether cmd completes in same thread or not */507 508/**509 * struct _internal_cmd - internal commands struct510 * @mutex: mutex511 * @done: completion512 * @reply: reply message pointer513 * @sense: sense data514 * @status: MPT3_CMD_XXX status515 * @smid: system message id516 */517struct _internal_cmd {518 struct mutex mutex;519 struct completion done;520 void *reply;521 void *sense;522 u16 status;523 u16 smid;524};525 526 527 528/**529 * struct _sas_device - attached device information530 * @list: sas device list531 * @starget: starget object532 * @sas_address: device sas address533 * @device_name: retrieved from the SAS IDENTIFY frame.534 * @handle: device handle535 * @sas_address_parent: sas address of parent expander or sas host536 * @enclosure_handle: enclosure handle537 * @enclosure_logical_id: enclosure logical identifier538 * @volume_handle: volume handle (valid when hidden raid member)539 * @volume_wwid: volume unique identifier540 * @device_info: bitfield provides detailed info about the device541 * @id: target id542 * @channel: target channel543 * @slot: number number544 * @phy: phy identifier provided in sas device page 0545 * @responding: used in _scsih_sas_device_mark_responding546 * @fast_path: fast path feature enable bit547 * @pfa_led_on: flag for PFA LED status548 * @pend_sas_rphy_add: flag to check if device is in sas_rphy_add()549 * addition routine.550 * @chassis_slot: chassis slot551 * @is_chassis_slot_valid: chassis slot valid or not552 * @port: hba port entry containing device's port number info553 * @rphy: device's sas_rphy address used to identify this device structure in554 * target_alloc callback function555 */556struct _sas_device {557 struct list_head list;558 struct scsi_target *starget;559 u64 sas_address;560 u64 device_name;561 u16 handle;562 u64 sas_address_parent;563 u16 enclosure_handle;564 u64 enclosure_logical_id;565 u16 volume_handle;566 u64 volume_wwid;567 u32 device_info;568 int id;569 int channel;570 u16 slot;571 u8 phy;572 u8 responding;573 u8 fast_path;574 u8 pfa_led_on;575 u8 pend_sas_rphy_add;576 u8 enclosure_level;577 u8 chassis_slot;578 u8 is_chassis_slot_valid;579 u8 connector_name[5];580 struct kref refcount;581 u8 port_type;582 struct hba_port *port;583 struct sas_rphy *rphy;584};585 586static inline void sas_device_get(struct _sas_device *s)587{588 kref_get(&s->refcount);589}590 591static inline void sas_device_free(struct kref *r)592{593 kfree(container_of(r, struct _sas_device, refcount));594}595 596static inline void sas_device_put(struct _sas_device *s)597{598 kref_put(&s->refcount, sas_device_free);599}600 601/*602 * struct _pcie_device - attached PCIe device information603 * @list: pcie device list604 * @starget: starget object605 * @wwid: device WWID606 * @handle: device handle607 * @device_info: bitfield provides detailed info about the device608 * @id: target id609 * @channel: target channel610 * @slot: slot number611 * @port_num: port number612 * @responding: used in _scsih_pcie_device_mark_responding613 * @fast_path: fast path feature enable bit614 * @nvme_mdts: MaximumDataTransferSize from PCIe Device Page 2 for615 * NVMe device only616 * @enclosure_handle: enclosure handle617 * @enclosure_logical_id: enclosure logical identifier618 * @enclosure_level: The level of device's enclosure from the controller619 * @connector_name: ASCII value of the Connector's name620 * @serial_number: pointer of serial number string allocated runtime621 * @access_status: Device's Access Status622 * @shutdown_latency: NVMe device's RTD3 Entry Latency623 * @refcount: reference count for deletion624 */625struct _pcie_device {626 struct list_head list;627 struct scsi_target *starget;628 u64 wwid;629 u16 handle;630 u32 device_info;631 int id;632 int channel;633 u16 slot;634 u8 port_num;635 u8 responding;636 u8 fast_path;637 u32 nvme_mdts;638 u16 enclosure_handle;639 u64 enclosure_logical_id;640 u8 enclosure_level;641 u8 connector_name[4];642 u8 *serial_number;643 u8 reset_timeout;644 u8 access_status;645 u16 shutdown_latency;646 struct kref refcount;647};648/**649 * pcie_device_get - Increment the pcie device reference count650 *651 * @p: pcie_device object652 *653 * When ever this function called it will increment the654 * reference count of the pcie device for which this function called.655 *656 */657static inline void pcie_device_get(struct _pcie_device *p)658{659 kref_get(&p->refcount);660}661 662/**663 * pcie_device_free - Release the pcie device object664 * @r - kref object665 *666 * Free's the pcie device object. It will be called when reference count667 * reaches to zero.668 */669static inline void pcie_device_free(struct kref *r)670{671 kfree(container_of(r, struct _pcie_device, refcount));672}673 674/**675 * pcie_device_put - Decrement the pcie device reference count676 *677 * @p: pcie_device object678 *679 * When ever this function called it will decrement the680 * reference count of the pcie device for which this function called.681 *682 * When refernce count reaches to Zero, this will call pcie_device_free to the683 * pcie_device object.684 */685static inline void pcie_device_put(struct _pcie_device *p)686{687 kref_put(&p->refcount, pcie_device_free);688}689/**690 * struct _raid_device - raid volume link list691 * @list: sas device list692 * @starget: starget object693 * @sdev: scsi device struct (volumes are single lun)694 * @wwid: unique identifier for the volume695 * @handle: device handle696 * @block_size: Block size of the volume697 * @id: target id698 * @channel: target channel699 * @volume_type: the raid level700 * @device_info: bitfield provides detailed info about the hidden components701 * @num_pds: number of hidden raid components702 * @responding: used in _scsih_raid_device_mark_responding703 * @percent_complete: resync percent complete704 * @direct_io_enabled: Whether direct io to PDs are allowed or not705 * @stripe_exponent: X where 2powX is the stripe sz in blocks706 * @block_exponent: X where 2powX is the block sz in bytes707 * @max_lba: Maximum number of LBA in the volume708 * @stripe_sz: Stripe Size of the volume709 * @device_info: Device info of the volume member disk710 * @pd_handle: Array of handles of the physical drives for direct I/O in le16711 */712#define MPT_MAX_WARPDRIVE_PDS 8713struct _raid_device {714 struct list_head list;715 struct scsi_target *starget;716 struct scsi_device *sdev;717 u64 wwid;718 u16 handle;719 u16 block_sz;720 int id;721 int channel;722 u8 volume_type;723 u8 num_pds;724 u8 responding;725 u8 percent_complete;726 u8 direct_io_enabled;727 u8 stripe_exponent;728 u8 block_exponent;729 u64 max_lba;730 u32 stripe_sz;731 u32 device_info;732 u16 pd_handle[MPT_MAX_WARPDRIVE_PDS];733};734 735/**736 * struct _boot_device - boot device info737 *738 * @channel: sas, raid, or pcie channel739 * @device: holds pointer for struct _sas_device, struct _raid_device or740 * struct _pcie_device741 */742struct _boot_device {743 int channel;744 void *device;745};746 747/**748 * struct _sas_port - wide/narrow sas port information749 * @port_list: list of ports belonging to expander750 * @num_phys: number of phys belonging to this port751 * @remote_identify: attached device identification752 * @rphy: sas transport rphy object753 * @port: sas transport wide/narrow port object754 * @hba_port: hba port entry containing port's port number info755 * @phy_list: _sas_phy list objects belonging to this port756 */757struct _sas_port {758 struct list_head port_list;759 u8 num_phys;760 struct sas_identify remote_identify;761 struct sas_rphy *rphy;762 struct sas_port *port;763 struct hba_port *hba_port;764 struct list_head phy_list;765};766 767/**768 * struct _sas_phy - phy information769 * @port_siblings: list of phys belonging to a port770 * @identify: phy identification771 * @remote_identify: attached device identification772 * @phy: sas transport phy object773 * @phy_id: unique phy id774 * @handle: device handle for this phy775 * @attached_handle: device handle for attached device776 * @phy_belongs_to_port: port has been created for this phy777 * @port: hba port entry containing port number info778 */779struct _sas_phy {780 struct list_head port_siblings;781 struct sas_identify identify;782 struct sas_identify remote_identify;783 struct sas_phy *phy;784 u8 phy_id;785 u16 handle;786 u16 attached_handle;787 u8 phy_belongs_to_port;788 u8 hba_vphy;789 struct hba_port *port;790};791 792/**793 * struct _sas_node - sas_host/expander information794 * @list: list of expanders795 * @parent_dev: parent device class796 * @num_phys: number phys belonging to this sas_host/expander797 * @sas_address: sas address of this sas_host/expander798 * @handle: handle for this sas_host/expander799 * @sas_address_parent: sas address of parent expander or sas host800 * @enclosure_handle: handle for this a member of an enclosure801 * @device_info: bitwise defining capabilities of this sas_host/expander802 * @responding: used in _scsih_expander_device_mark_responding803 * @nr_phys_allocated: Allocated memory for this many count phys804 * @phy: a list of phys that make up this sas_host/expander805 * @sas_port_list: list of ports attached to this sas_host/expander806 * @port: hba port entry containing node's port number info807 * @rphy: sas_rphy object of this expander808 */809struct _sas_node {810 struct list_head list;811 struct device *parent_dev;812 u8 num_phys;813 u64 sas_address;814 u16 handle;815 u64 sas_address_parent;816 u16 enclosure_handle;817 u64 enclosure_logical_id;818 u8 responding;819 u8 nr_phys_allocated;820 struct hba_port *port;821 struct _sas_phy *phy;822 struct list_head sas_port_list;823 struct sas_rphy *rphy;824};825 826/**827 * struct _enclosure_node - enclosure information828 * @list: list of enclosures829 * @pg0: enclosure pg0;830 */831struct _enclosure_node {832 struct list_head list;833 Mpi2SasEnclosurePage0_t pg0;834};835 836/**837 * enum reset_type - reset state838 * @FORCE_BIG_HAMMER: issue diagnostic reset839 * @SOFT_RESET: issue message_unit_reset, if fails to to big hammer840 */841enum reset_type {842 FORCE_BIG_HAMMER,843 SOFT_RESET,844};845 846/**847 * struct pcie_sg_list - PCIe SGL buffer (contiguous per I/O)848 * @pcie_sgl: PCIe native SGL for NVMe devices849 * @pcie_sgl_dma: physical address850 */851struct pcie_sg_list {852 void *pcie_sgl;853 dma_addr_t pcie_sgl_dma;854};855 856/**857 * struct chain_tracker - firmware chain tracker858 * @chain_buffer: chain buffer859 * @chain_buffer_dma: physical address860 * @tracker_list: list of free request (ioc->free_chain_list)861 */862struct chain_tracker {863 void *chain_buffer;864 dma_addr_t chain_buffer_dma;865};866 867struct chain_lookup {868 struct chain_tracker *chains_per_smid;869 atomic_t chain_offset;870};871 872/**873 * struct scsiio_tracker - scsi mf request tracker874 * @smid: system message id875 * @cb_idx: callback index876 * @direct_io: To indicate whether I/O is direct (WARPDRIVE)877 * @chain_list: list of associated firmware chain tracker878 * @msix_io: IO's msix879 */880struct scsiio_tracker {881 u16 smid;882 struct scsi_cmnd *scmd;883 u8 cb_idx;884 u8 direct_io;885 struct pcie_sg_list pcie_sg_list;886 struct list_head chain_list;887 u16 msix_io;888};889 890/**891 * struct request_tracker - firmware request tracker892 * @smid: system message id893 * @cb_idx: callback index894 * @tracker_list: list of free request (ioc->free_list)895 */896struct request_tracker {897 u16 smid;898 u8 cb_idx;899 struct list_head tracker_list;900};901 902/**903 * struct _tr_list - target reset list904 * @handle: device handle905 * @state: state machine906 */907struct _tr_list {908 struct list_head list;909 u16 handle;910 u16 state;911};912 913/**914 * struct _sc_list - delayed SAS_IO_UNIT_CONTROL message list915 * @handle: device handle916 */917struct _sc_list {918 struct list_head list;919 u16 handle;920};921 922/**923 * struct _event_ack_list - delayed event acknowledgment list924 * @Event: Event ID925 * @EventContext: used to track the event uniquely926 */927struct _event_ack_list {928 struct list_head list;929 U16 Event;930 U32 EventContext;931};932 933/**934 * struct adapter_reply_queue - the reply queue struct935 * @ioc: per adapter object936 * @msix_index: msix index into vector table937 * @vector: irq vector938 * @reply_post_host_index: head index in the pool where FW completes IO939 * @reply_post_free: reply post base virt address940 * @name: the name registered to request_irq()941 * @busy: isr is actively processing replies on another cpu942 * @os_irq: irq number943 * @irqpoll: irq_poll object944 * @irq_poll_scheduled: Tells whether irq poll is scheduled or not945 * @is_iouring_poll_q: Tells whether reply queues is assigned946 * to io uring poll queues or not947 * @list: this list948*/949struct adapter_reply_queue {950 struct MPT3SAS_ADAPTER *ioc;951 u8 msix_index;952 u32 reply_post_host_index;953 Mpi2ReplyDescriptorsUnion_t *reply_post_free;954 char name[MPT_NAME_LENGTH];955 atomic_t busy;956 u32 os_irq;957 struct irq_poll irqpoll;958 bool irq_poll_scheduled;959 bool irq_line_enable;960 bool is_iouring_poll_q;961 struct list_head list;962};963 964/**965 * struct io_uring_poll_queue - the io uring poll queue structure966 * @busy: Tells whether io uring poll queue is busy or not967 * @pause: Tells whether IOs are paused on io uring poll queue or not968 * @reply_q: reply queue mapped for io uring poll queue969 */970struct io_uring_poll_queue {971 atomic_t busy;972 atomic_t pause;973 struct adapter_reply_queue *reply_q;974};975 976typedef void (*MPT_ADD_SGE)(void *paddr, u32 flags_length, dma_addr_t dma_addr);977 978/* SAS3.0 support */979typedef int (*MPT_BUILD_SG_SCMD)(struct MPT3SAS_ADAPTER *ioc,980 struct scsi_cmnd *scmd, u16 smid, struct _pcie_device *pcie_device);981typedef void (*MPT_BUILD_SG)(struct MPT3SAS_ADAPTER *ioc, void *psge,982 dma_addr_t data_out_dma, size_t data_out_sz,983 dma_addr_t data_in_dma, size_t data_in_sz);984typedef void (*MPT_BUILD_ZERO_LEN_SGE)(struct MPT3SAS_ADAPTER *ioc,985 void *paddr);986 987/* SAS3.5 support */988typedef void (*NVME_BUILD_PRP)(struct MPT3SAS_ADAPTER *ioc, u16 smid,989 Mpi26NVMeEncapsulatedRequest_t *nvme_encap_request,990 dma_addr_t data_out_dma, size_t data_out_sz, dma_addr_t data_in_dma,991 size_t data_in_sz);992 993/* To support atomic and non atomic descriptors*/994typedef void (*PUT_SMID_IO_FP_HIP) (struct MPT3SAS_ADAPTER *ioc, u16 smid,995 u16 funcdep);996typedef void (*PUT_SMID_DEFAULT) (struct MPT3SAS_ADAPTER *ioc, u16 smid);997typedef u32 (*BASE_READ_REG) (const void __iomem *addr);998/*999 * To get high iops reply queue's msix index when high iops mode is enabled1000 * else get the msix index of general reply queues.1001 */1002typedef u8 (*GET_MSIX_INDEX) (struct MPT3SAS_ADAPTER *ioc,1003 struct scsi_cmnd *scmd);1004 1005/* IOC Facts and Port Facts converted from little endian to cpu */1006union mpi3_version_union {1007 MPI2_VERSION_STRUCT Struct;1008 u32 Word;1009};1010 1011struct mpt3sas_facts {1012 u16 MsgVersion;1013 u16 HeaderVersion;1014 u8 IOCNumber;1015 u8 VP_ID;1016 u8 VF_ID;1017 u16 IOCExceptions;1018 u16 IOCStatus;1019 u32 IOCLogInfo;1020 u8 MaxChainDepth;1021 u8 WhoInit;1022 u8 NumberOfPorts;1023 u8 MaxMSIxVectors;1024 u16 RequestCredit;1025 u16 ProductID;1026 u32 IOCCapabilities;1027 union mpi3_version_union FWVersion;1028 u16 IOCRequestFrameSize;1029 u16 IOCMaxChainSegmentSize;1030 u16 MaxInitiators;1031 u16 MaxTargets;1032 u16 MaxSasExpanders;1033 u16 MaxEnclosures;1034 u16 ProtocolFlags;1035 u16 HighPriorityCredit;1036 u16 MaxReplyDescriptorPostQueueDepth;1037 u8 ReplyFrameSize;1038 u8 MaxVolumes;1039 u16 MaxDevHandle;1040 u16 MaxPersistentEntries;1041 u16 MinDevHandle;1042 u8 CurrentHostPageSize;1043};1044 1045struct mpt3sas_port_facts {1046 u8 PortNumber;1047 u8 VP_ID;1048 u8 VF_ID;1049 u8 PortType;1050 u16 MaxPostedCmdBuffers;1051};1052 1053struct reply_post_struct {1054 Mpi2ReplyDescriptorsUnion_t *reply_post_free;1055 dma_addr_t reply_post_free_dma;1056};1057 1058/**1059 * struct virtual_phy - vSES phy structure1060 * sas_address: SAS Address of vSES device1061 * phy_mask: vSES device's phy number1062 * flags: flags used to manage this structure1063 */1064struct virtual_phy {1065 struct list_head list;1066 u64 sas_address;1067 u32 phy_mask;1068 u8 flags;1069};1070 1071#define MPT_VPHY_FLAG_DIRTY_PHY 0x011072 1073/**1074 * struct hba_port - Saves each HBA's Wide/Narrow port info1075 * @sas_address: sas address of this wide/narrow port's attached device1076 * @phy_mask: HBA PHY's belonging to this port1077 * @port_id: port number1078 * @flags: hba port flags1079 * @vphys_mask : mask of vSES devices Phy number1080 * @vphys_list : list containing vSES device structures1081 */1082struct hba_port {1083 struct list_head list;1084 u64 sas_address;1085 u32 phy_mask;1086 u8 port_id;1087 u8 flags;1088 u32 vphys_mask;1089 struct list_head vphys_list;1090};1091 1092/* hba port flags */1093#define HBA_PORT_FLAG_DIRTY_PORT 0x011094#define HBA_PORT_FLAG_NEW_PORT 0x021095 1096#define MULTIPATH_DISABLED_PORT_ID 0xFF1097 1098/**1099 * struct htb_rel_query - diagnostic buffer release reason1100 * @unique_id - unique id associated with this buffer.1101 * @buffer_rel_condition - Release condition ioctl/sysfs/reset1102 * @reserved1103 * @trigger_type - Master/Event/scsi/MPI1104 * @trigger_info_dwords - Data Correspondig to trigger type1105 */1106struct htb_rel_query {1107 u16 buffer_rel_condition;1108 u16 reserved;1109 u32 trigger_type;1110 u32 trigger_info_dwords[2];1111};1112 1113/* Buffer_rel_condition bit fields */1114 1115/* Bit 0 - Diag Buffer not Released */1116#define MPT3_DIAG_BUFFER_NOT_RELEASED (0x00)1117/* Bit 0 - Diag Buffer Released */1118#define MPT3_DIAG_BUFFER_RELEASED (0x01)1119 1120/*1121 * Bit 1 - Diag Buffer Released by IOCTL,1122 * This bit is valid only if Bit 0 is one1123 */1124#define MPT3_DIAG_BUFFER_REL_IOCTL (0x02 | MPT3_DIAG_BUFFER_RELEASED)1125 1126/*1127 * Bit 2 - Diag Buffer Released by Trigger,1128 * This bit is valid only if Bit 0 is one1129 */1130#define MPT3_DIAG_BUFFER_REL_TRIGGER (0x04 | MPT3_DIAG_BUFFER_RELEASED)1131 1132/*1133 * Bit 3 - Diag Buffer Released by SysFs,1134 * This bit is valid only if Bit 0 is one1135 */1136#define MPT3_DIAG_BUFFER_REL_SYSFS (0x08 | MPT3_DIAG_BUFFER_RELEASED)1137 1138/* DIAG RESET Master trigger flags */1139#define MPT_DIAG_RESET_ISSUED_BY_DRIVER 0x000000001140#define MPT_DIAG_RESET_ISSUED_BY_USER 0x000000011141 1142typedef void (*MPT3SAS_FLUSH_RUNNING_CMDS)(struct MPT3SAS_ADAPTER *ioc);1143/**1144 * struct MPT3SAS_ADAPTER - per adapter struct1145 * @list: ioc_list1146 * @shost: shost object1147 * @id: unique adapter id1148 * @cpu_count: number online cpus1149 * @name: generic ioc string1150 * @tmp_string: tmp string used for logging1151 * @pdev: pci pdev object1152 * @pio_chip: physical io register space1153 * @chip: memory mapped register space1154 * @chip_phys: physical addrss prior to mapping1155 * @logging_level: see mpt3sas_debug.h1156 * @fwfault_debug: debuging FW timeouts1157 * @ir_firmware: IR firmware present1158 * @bars: bitmask of BAR's that must be configured1159 * @mask_interrupts: ignore interrupt1160 * @pci_access_mutex: Mutex to synchronize ioctl, sysfs show path and1161 * pci resource handling1162 * @fault_reset_work_q_name: fw fault work queue1163 * @fault_reset_work_q: ""1164 * @fault_reset_work: ""1165 * @firmware_event_thread: fw event work queue1166 * @fw_event_lock:1167 * @fw_event_list: list of fw events1168 * @current_evet: current processing firmware event1169 * @fw_event_cleanup: set to one while cleaning up the fw events1170 * @aen_event_read_flag: event log was read1171 * @broadcast_aen_busy: broadcast aen waiting to be serviced1172 * @shost_recovery: host reset in progress1173 * @ioc_reset_in_progress_lock:1174 * @ioc_link_reset_in_progress: phy/hard reset in progress1175 * @ignore_loginfos: ignore loginfos during task management1176 * @remove_host: flag for when driver unloads, to avoid sending dev resets1177 * @pci_error_recovery: flag to prevent ioc access until slot reset completes1178 * @wait_for_discovery_to_complete: flag set at driver load time when1179 * waiting on reporting devices1180 * @is_driver_loading: flag set at driver load time1181 * @port_enable_failed: flag set when port enable has failed1182 * @start_scan: flag set from scan_start callback, cleared from _mpt3sas_fw_work1183 * @start_scan_failed: means port enable failed, return's the ioc_status1184 * @msix_enable: flag indicating msix is enabled1185 * @msix_vector_count: number msix vectors1186 * @cpu_msix_table: table for mapping cpus to msix index1187 * @cpu_msix_table_sz: table size1188 * @total_io_cnt: Gives total IO count, used to load balance the interrupts1189 * @ioc_coredump_loop: will have non-zero value when FW is in CoreDump state1190 * @timestamp_update_count: Counter to fire timeSync command1191 * time_sync_interval: Time sync interval read from man page 111192 * @high_iops_outstanding: used to load balance the interrupts1193 * within high iops reply queues1194 * @msix_load_balance: Enables load balancing of interrupts across1195 * the multiple MSIXs1196 * @schedule_dead_ioc_flush_running_cmds: callback to flush pending commands1197 * @thresh_hold: Max number of reply descriptors processed1198 * before updating Host Index1199 * @iopoll_q_start_index: starting index of io uring poll queues1200 * in reply queue list1201 * @drv_internal_flags: Bit map internal to driver1202 * @drv_support_bitmap: driver's supported feature bit map1203 * @use_32bit_dma: Flag to use 32 bit consistent dma mask1204 * @scsi_io_cb_idx: shost generated commands1205 * @tm_cb_idx: task management commands1206 * @scsih_cb_idx: scsih internal commands1207 * @transport_cb_idx: transport internal commands1208 * @ctl_cb_idx: clt internal commands1209 * @base_cb_idx: base internal commands1210 * @config_cb_idx: base internal commands1211 * @tm_tr_cb_idx : device removal target reset handshake1212 * @tm_tr_volume_cb_idx : volume removal target reset1213 * @base_cmds:1214 * @transport_cmds:1215 * @scsih_cmds:1216 * @tm_cmds:1217 * @ctl_cmds:1218 * @config_cmds:1219 * @base_add_sg_single: handler for either 32/64 bit sgl's1220 * @event_type: bits indicating which events to log1221 * @event_context: unique id for each logged event1222 * @event_log: event log pointer1223 * @event_masks: events that are masked1224 * @max_shutdown_latency: timeout value for NVMe shutdown operation,1225 * which is equal that NVMe drive's RTD3 Entry Latency1226 * which has reported maximum RTD3 Entry Latency value1227 * among attached NVMe drives.1228 * @facts: static facts data1229 * @prev_fw_facts: previous fw facts data1230 * @pfacts: static port facts data1231 * @manu_pg0: static manufacturing page 01232 * @manu_pg10: static manufacturing page 101233 * @manu_pg11: static manufacturing page 111234 * @bios_pg2: static bios page 21235 * @bios_pg3: static bios page 31236 * @ioc_pg8: static ioc page 81237 * @iounit_pg0: static iounit page 01238 * @iounit_pg1: static iounit page 11239 * @sas_hba: sas host object1240 * @sas_expander_list: expander object list1241 * @enclosure_list: enclosure object list1242 * @sas_node_lock:1243 * @sas_device_list: sas device object list1244 * @sas_device_init_list: sas device object list (used only at init time)1245 * @sas_device_lock:1246 * @pcie_device_list: pcie device object list1247 * @pcie_device_init_list: pcie device object list (used only at init time)1248 * @pcie_device_lock:1249 * @io_missing_delay: time for IO completed by fw when PDR enabled1250 * @device_missing_delay: time for device missing by fw when PDR enabled1251 * @sas_id : used for setting volume target IDs1252 * @pcie_target_id: used for setting pcie target IDs1253 * @blocking_handles: bitmask used to identify which devices need blocking1254 * @pd_handles : bitmask for PD handles1255 * @pd_handles_sz : size of pd_handle bitmask1256 * @config_page_sz: config page size1257 * @config_page: reserve memory for config page payload1258 * @config_page_dma:1259 * @hba_queue_depth: hba request queue depth1260 * @sge_size: sg element size for either 32/64 bit1261 * @scsiio_depth: SCSI_IO queue depth1262 * @request_sz: per request frame size1263 * @request: pool of request frames1264 * @request_dma:1265 * @request_dma_sz:1266 * @scsi_lookup: firmware request tracker list1267 * @scsi_lookup_lock:1268 * @free_list: free list of request1269 * @pending_io_count:1270 * @reset_wq:1271 * @chain: pool of chains1272 * @chain_dma:1273 * @max_sges_in_main_message: number sg elements in main message1274 * @max_sges_in_chain_message: number sg elements per chain1275 * @chains_needed_per_io: max chains per io1276 * @chain_depth: total chains allocated1277 * @chain_segment_sz: gives the max number of1278 * SGEs accommodate on single chain buffer1279 * @hi_priority_smid:1280 * @hi_priority:1281 * @hi_priority_dma:1282 * @hi_priority_depth:1283 * @hpr_lookup:1284 * @hpr_free_list:1285 * @internal_smid:1286 * @internal:1287 * @internal_dma:1288 * @internal_depth:1289 * @internal_lookup:1290 * @internal_free_list:1291 * @sense: pool of sense1292 * @sense_dma:1293 * @sense_dma_pool:1294 * @reply_depth: hba reply queue depth:1295 * @reply_sz: per reply frame size:1296 * @reply: pool of replys:1297 * @reply_dma:1298 * @reply_dma_pool:1299 * @reply_free_queue_depth: reply free depth1300 * @reply_free: pool for reply free queue (32 bit addr)1301 * @reply_free_dma:1302 * @reply_free_dma_pool:1303 * @reply_free_host_index: tail index in pool to insert free replys1304 * @reply_post_queue_depth: reply post queue depth1305 * @reply_post_struct: struct for reply_post_free physical & virt address1306 * @rdpq_array_capable: FW supports multiple reply queue addresses in ioc_init1307 * @rdpq_array_enable: rdpq_array support is enabled in the driver1308 * @rdpq_array_enable_assigned: this ensures that rdpq_array_enable flag1309 * is assigned only ones1310 * @reply_queue_count: number of reply queue's1311 * @reply_queue_list: link list contaning the reply queue info1312 * @msix96_vector: 96 MSI-X vector support1313 * @replyPostRegisterIndex: index of next position in Reply Desc Post Queue1314 * @delayed_tr_list: target reset link list1315 * @delayed_tr_volume_list: volume target reset link list1316 * @delayed_sc_list:1317 * @delayed_event_ack_list:1318 * @temp_sensors_count: flag to carry the number of temperature sensors1319 * @pci_access_mutex: Mutex to synchronize ioctl,sysfs show path and1320 * pci resource handling. PCI resource freeing will lead to free1321 * vital hardware/memory resource, which might be in use by cli/sysfs1322 * path functions resulting in Null pointer reference followed by kernel1323 * crash. To avoid the above race condition we use mutex syncrhonization1324 * which ensures the syncrhonization between cli/sysfs_show path.1325 * @atomic_desc_capable: Atomic Request Descriptor support.1326 * @GET_MSIX_INDEX: Get the msix index of high iops queues.1327 * @multipath_on_hba: flag to determine multipath on hba is enabled or not1328 * @port_table_list: list containing HBA's wide/narrow port's info1329 */1330struct MPT3SAS_ADAPTER {1331 struct list_head list;1332 struct Scsi_Host *shost;1333 u8 id;1334 int cpu_count;1335 char name[MPT_NAME_LENGTH];1336 char driver_name[MPT_NAME_LENGTH - 8];1337 char tmp_string[MPT_STRING_LENGTH];1338 struct pci_dev *pdev;1339 Mpi2SystemInterfaceRegs_t __iomem *chip;1340 phys_addr_t chip_phys;1341 int logging_level;1342 int fwfault_debug;1343 u8 ir_firmware;1344 int bars;1345 u8 mask_interrupts;1346 1347 /* fw fault handler */1348 char fault_reset_work_q_name[20];1349 struct workqueue_struct *fault_reset_work_q;1350 struct delayed_work fault_reset_work;1351 1352 /* fw event handler */1353 struct workqueue_struct *firmware_event_thread;1354 spinlock_t fw_event_lock;1355 struct list_head fw_event_list;1356 struct fw_event_work *current_event;1357 u8 fw_events_cleanup;1358 1359 /* misc flags */1360 int aen_event_read_flag;1361 u8 broadcast_aen_busy;1362 u16 broadcast_aen_pending;1363 u8 shost_recovery;1364 u8 got_task_abort_from_ioctl;1365 1366 struct mutex reset_in_progress_mutex;1367 struct mutex hostdiag_unlock_mutex;1368 spinlock_t ioc_reset_in_progress_lock;1369 u8 ioc_link_reset_in_progress;1370 1371 u8 ignore_loginfos;1372 u8 remove_host;1373 u8 pci_error_recovery;1374 u8 wait_for_discovery_to_complete;1375 u8 is_driver_loading;1376 u8 port_enable_failed;1377 u8 start_scan;1378 u16 start_scan_failed;1379 1380 u8 msix_enable;1381 u16 msix_vector_count;1382 u8 *cpu_msix_table;1383 u16 cpu_msix_table_sz;1384 resource_size_t __iomem **reply_post_host_index;1385 u32 ioc_reset_count;1386 MPT3SAS_FLUSH_RUNNING_CMDS schedule_dead_ioc_flush_running_cmds;1387 u32 non_operational_loop;1388 u8 ioc_coredump_loop;1389 u32 timestamp_update_count;1390 u32 time_sync_interval;1391 atomic64_t total_io_cnt;1392 atomic64_t high_iops_outstanding;1393 bool msix_load_balance;1394 u16 thresh_hold;1395 u8 high_iops_queues;1396 u8 iopoll_q_start_index;1397 u32 drv_internal_flags;1398 u32 drv_support_bitmap;1399 u32 dma_mask;1400 bool enable_sdev_max_qd;1401 bool use_32bit_dma;1402 struct io_uring_poll_queue *io_uring_poll_queues;1403 1404 /* internal commands, callback index */1405 u8 scsi_io_cb_idx;1406 u8 tm_cb_idx;1407 u8 transport_cb_idx;1408 u8 scsih_cb_idx;1409 u8 ctl_cb_idx;1410 u8 base_cb_idx;1411 u8 port_enable_cb_idx;1412 u8 config_cb_idx;1413 u8 tm_tr_cb_idx;1414 u8 tm_tr_volume_cb_idx;1415 u8 tm_sas_control_cb_idx;1416 struct _internal_cmd base_cmds;1417 struct _internal_cmd port_enable_cmds;1418 struct _internal_cmd transport_cmds;1419 struct _internal_cmd scsih_cmds;1420 struct _internal_cmd tm_cmds;1421 struct _internal_cmd ctl_cmds;1422 struct _internal_cmd config_cmds;1423 1424 MPT_ADD_SGE base_add_sg_single;1425 1426 /* function ptr for either IEEE or MPI sg elements */1427 MPT_BUILD_SG_SCMD build_sg_scmd;1428 MPT_BUILD_SG build_sg;1429 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge;1430 u16 sge_size_ieee;1431 u16 hba_mpi_version_belonged;1432 1433 /* function ptr for MPI sg elements only */1434 MPT_BUILD_SG build_sg_mpi;1435 MPT_BUILD_ZERO_LEN_SGE build_zero_len_sge_mpi;1436 1437 /* function ptr for NVMe PRP elements only */1438 NVME_BUILD_PRP build_nvme_prp;1439 1440 /* event log */1441 u32 event_type[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];1442 u32 event_context;1443 void *event_log;1444 u32 event_masks[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];1445 1446 u8 tm_custom_handling;1447 u8 nvme_abort_timeout;1448 u16 max_shutdown_latency;1449 u16 max_wideport_qd;1450 u16 max_narrowport_qd;1451 u16 max_nvme_qd;1452 u8 max_sata_qd;1453 1454 /* static config pages */1455 struct mpt3sas_facts facts;1456 struct mpt3sas_facts prev_fw_facts;1457 struct mpt3sas_port_facts *pfacts;1458 Mpi2ManufacturingPage0_t manu_pg0;1459 struct Mpi2ManufacturingPage10_t manu_pg10;1460 struct Mpi2ManufacturingPage11_t manu_pg11;1461 Mpi2BiosPage2_t bios_pg2;1462 Mpi2BiosPage3_t bios_pg3;1463 Mpi2IOCPage8_t ioc_pg8;1464 Mpi2IOUnitPage0_t iounit_pg0;1465 Mpi2IOUnitPage1_t iounit_pg1;1466 Mpi2IOCPage1_t ioc_pg1_copy;1467 1468 struct _boot_device req_boot_device;1469 struct _boot_device req_alt_boot_device;1470 struct _boot_device current_boot_device;1471 1472 /* sas hba, expander, and device list */1473 struct _sas_node sas_hba;1474 struct list_head sas_expander_list;1475 struct list_head enclosure_list;1476 spinlock_t sas_node_lock;1477 struct list_head sas_device_list;1478 struct list_head sas_device_init_list;1479 spinlock_t sas_device_lock;1480 struct list_head pcie_device_list;1481 struct list_head pcie_device_init_list;1482 spinlock_t pcie_device_lock;1483 1484 struct list_head raid_device_list;1485 spinlock_t raid_device_lock;1486 u8 io_missing_delay;1487 u16 device_missing_delay;1488 int sas_id;1489 int pcie_target_id;1490 1491 void *blocking_handles;1492 void *pd_handles;1493 u16 pd_handles_sz;1494 1495 void *pend_os_device_add;1496 u16 pend_os_device_add_sz;1497 1498 /* config page */1499 u16 config_page_sz;1500 void *config_page;1501 dma_addr_t config_page_dma;1502 void *config_vaddr;1503 1504 /* scsiio request */1505 u16 hba_queue_depth;1506 u16 sge_size;1507 u16 scsiio_depth;1508 u16 request_sz;1509 u8 *request;1510 dma_addr_t request_dma;1511 u32 request_dma_sz;1512 struct pcie_sg_list *pcie_sg_lookup;1513 spinlock_t scsi_lookup_lock;1514 int pending_io_count;1515 wait_queue_head_t reset_wq;1516 u16 *io_queue_num;1517 1518 /* PCIe SGL */1519 struct dma_pool *pcie_sgl_dma_pool;1520 /* Host Page Size */1521 u32 page_size;1522 1523 /* chain */1524 struct chain_lookup *chain_lookup;1525 struct list_head free_chain_list;1526 struct dma_pool *chain_dma_pool;1527 ulong chain_pages;1528 u16 max_sges_in_main_message;1529 u16 max_sges_in_chain_message;1530 u16 chains_needed_per_io;1531 u32 chain_depth;1532 u16 chain_segment_sz;1533 u16 chains_per_prp_buffer;1534 1535 /* hi-priority queue */1536 u16 hi_priority_smid;1537 u8 *hi_priority;1538 dma_addr_t hi_priority_dma;1539 u16 hi_priority_depth;1540 struct request_tracker *hpr_lookup;1541 struct list_head hpr_free_list;1542 1543 /* internal queue */1544 u16 internal_smid;1545 u8 *internal;1546 dma_addr_t internal_dma;1547 u16 internal_depth;1548 struct request_tracker *internal_lookup;1549 struct list_head internal_free_list;1550 1551 /* sense */1552 u8 *sense;1553 dma_addr_t sense_dma;1554 struct dma_pool *sense_dma_pool;1555 1556 /* reply */1557 u16 reply_sz;1558 u8 *reply;1559 dma_addr_t reply_dma;1560 u32 reply_dma_max_address;1561 u32 reply_dma_min_address;1562 struct dma_pool *reply_dma_pool;1563 1564 /* reply free queue */1565 u16 reply_free_queue_depth;1566 __le32 *reply_free;1567 dma_addr_t reply_free_dma;1568 struct dma_pool *reply_free_dma_pool;1569 u32 reply_free_host_index;1570 1571 /* reply post queue */1572 u16 reply_post_queue_depth;1573 struct reply_post_struct *reply_post;1574 u8 rdpq_array_capable;1575 u8 rdpq_array_enable;1576 u8 rdpq_array_enable_assigned;1577 struct dma_pool *reply_post_free_dma_pool;1578 struct dma_pool *reply_post_free_array_dma_pool;1579 Mpi2IOCInitRDPQArrayEntry *reply_post_free_array;1580 dma_addr_t reply_post_free_array_dma;1581 u8 reply_queue_count;1582 struct list_head reply_queue_list;1583 1584 u8 combined_reply_queue;1585 u8 combined_reply_index_count;1586 u8 smp_affinity_enable;1587 /* reply post register index */1588 resource_size_t __iomem **replyPostRegisterIndex;1589 1590 struct list_head delayed_tr_list;1591 struct list_head delayed_tr_volume_list;1592 struct list_head delayed_sc_list;1593 struct list_head delayed_event_ack_list;1594 u8 temp_sensors_count;1595 struct mutex pci_access_mutex;1596 1597 /* diag buffer support */1598 u8 *diag_buffer[MPI2_DIAG_BUF_TYPE_COUNT];1599 u32 diag_buffer_sz[MPI2_DIAG_BUF_TYPE_COUNT];1600 dma_addr_t diag_buffer_dma[MPI2_DIAG_BUF_TYPE_COUNT];1601 u8 diag_buffer_status[MPI2_DIAG_BUF_TYPE_COUNT];1602 u32 unique_id[MPI2_DIAG_BUF_TYPE_COUNT];1603 u32 product_specific[MPI2_DIAG_BUF_TYPE_COUNT][23];1604 u32 diagnostic_flags[MPI2_DIAG_BUF_TYPE_COUNT];1605 u32 ring_buffer_offset;1606 u32 ring_buffer_sz;1607 struct htb_rel_query htb_rel;1608 u8 reset_from_user;1609 u8 is_warpdrive;1610 u8 is_mcpu_endpoint;1611 u8 hide_ir_msg;1612 u8 mfg_pg10_hide_flag;1613 u8 hide_drives;1614 spinlock_t diag_trigger_lock;1615 u8 diag_trigger_active;1616 u8 atomic_desc_capable;1617 BASE_READ_REG base_readl;1618 BASE_READ_REG base_readl_ext_retry;1619 struct SL_WH_MASTER_TRIGGER_T diag_trigger_master;1620 struct SL_WH_EVENT_TRIGGERS_T diag_trigger_event;1621 struct SL_WH_SCSI_TRIGGERS_T diag_trigger_scsi;1622 struct SL_WH_MPI_TRIGGERS_T diag_trigger_mpi;1623 u8 supports_trigger_pages;1624 void *device_remove_in_progress;1625 u16 device_remove_in_progress_sz;1626 u8 is_gen35_ioc;1627 u8 is_aero_ioc;1628 struct dentry *debugfs_root;1629 struct dentry *ioc_dump;1630 PUT_SMID_IO_FP_HIP put_smid_scsi_io;1631 PUT_SMID_IO_FP_HIP put_smid_fast_path;1632 PUT_SMID_IO_FP_HIP put_smid_hi_priority;1633 PUT_SMID_DEFAULT put_smid_default;1634 GET_MSIX_INDEX get_msix_index_for_smlio;1635 1636 u8 multipath_on_hba;1637 struct list_head port_table_list;1638};1639 1640struct mpt3sas_debugfs_buffer {1641 void *buf;1642 u32 len;1643};1644 1645#define MPT_DRV_SUPPORT_BITMAP_MEMMOVE 0x000000011646#define MPT_DRV_SUPPORT_BITMAP_ADDNLQUERY 0x000000021647 1648#define MPT_DRV_INTERNAL_FIRST_PE_ISSUED 0x000000011649 1650typedef u8 (*MPT_CALLBACK)(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,1651 u32 reply);1652 1653/*1654 * struct ATTO_SAS_NVRAM - ATTO NVRAM settings stored1655 * in Manufacturing page 1 used to get1656 * ATTO SasAddr.1657 */1658struct ATTO_SAS_NVRAM {1659 u8 Signature[4];1660 u8 Version;1661#define ATTO_SASNVR_VERSION 01662 1663 u8 Checksum;1664#define ATTO_SASNVR_CKSUM_SEED 0x5A1665 u8 Pad[10];1666 u8 SasAddr[8];1667#define ATTO_SAS_ADDR_ALIGN 641668 u8 Reserved[232];1669};1670 1671#define ATTO_SAS_ADDR_DEVNAME_BIAS 631672 1673union ATTO_SAS_ADDRESS {1674 U8 b[8];1675 U16 w[4];1676 U32 d[2];1677 U64 q;1678};1679 1680/* base shared API */1681extern struct list_head mpt3sas_ioc_list;1682extern char driver_name[MPT_NAME_LENGTH];1683/* spinlock on list operations over IOCs1684 * Case: when multiple warpdrive cards(IOCs) are in use1685 * Each IOC will added to the ioc list structure on initialization.1686 * Watchdog threads run at regular intervals to check IOC for any1687 * fault conditions which will trigger the dead_ioc thread to1688 * deallocate pci resource, resulting deleting the IOC netry from list,1689 * this deletion need to protected by spinlock to enusre that1690 * ioc removal is syncrhonized, if not synchronized it might lead to1691 * list_del corruption as the ioc list is traversed in cli path.1692 */1693extern spinlock_t gioc_lock;1694 1695void mpt3sas_base_start_watchdog(struct MPT3SAS_ADAPTER *ioc);1696void mpt3sas_base_stop_watchdog(struct MPT3SAS_ADAPTER *ioc);1697 1698int mpt3sas_base_attach(struct MPT3SAS_ADAPTER *ioc);1699void mpt3sas_base_detach(struct MPT3SAS_ADAPTER *ioc);1700int mpt3sas_base_map_resources(struct MPT3SAS_ADAPTER *ioc);1701void mpt3sas_base_free_resources(struct MPT3SAS_ADAPTER *ioc);1702void mpt3sas_free_enclosure_list(struct MPT3SAS_ADAPTER *ioc);1703int mpt3sas_base_hard_reset_handler(struct MPT3SAS_ADAPTER *ioc,1704 enum reset_type type);1705 1706void *mpt3sas_base_get_msg_frame(struct MPT3SAS_ADAPTER *ioc, u16 smid);1707void *mpt3sas_base_get_sense_buffer(struct MPT3SAS_ADAPTER *ioc, u16 smid);1708__le32 mpt3sas_base_get_sense_buffer_dma(struct MPT3SAS_ADAPTER *ioc,1709 u16 smid);1710void *mpt3sas_base_get_pcie_sgl(struct MPT3SAS_ADAPTER *ioc, u16 smid);1711dma_addr_t mpt3sas_base_get_pcie_sgl_dma(struct MPT3SAS_ADAPTER *ioc, u16 smid);1712void mpt3sas_base_sync_reply_irqs(struct MPT3SAS_ADAPTER *ioc, u8 poll);1713void mpt3sas_base_mask_interrupts(struct MPT3SAS_ADAPTER *ioc);1714void mpt3sas_base_unmask_interrupts(struct MPT3SAS_ADAPTER *ioc);1715 1716void mpt3sas_base_put_smid_fast_path(struct MPT3SAS_ADAPTER *ioc, u16 smid,1717 u16 handle);1718void mpt3sas_base_put_smid_hi_priority(struct MPT3SAS_ADAPTER *ioc, u16 smid,1719 u16 msix_task);1720void mpt3sas_base_put_smid_nvme_encap(struct MPT3SAS_ADAPTER *ioc, u16 smid);1721void mpt3sas_base_put_smid_default(struct MPT3SAS_ADAPTER *ioc, u16 smid);1722/* hi-priority queue */1723u16 mpt3sas_base_get_smid_hpr(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);1724u16 mpt3sas_base_get_smid_scsiio(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx,1725 struct scsi_cmnd *scmd);1726void mpt3sas_base_clear_st(struct MPT3SAS_ADAPTER *ioc,1727 struct scsiio_tracker *st);1728 1729u16 mpt3sas_base_get_smid(struct MPT3SAS_ADAPTER *ioc, u8 cb_idx);1730void mpt3sas_base_free_smid(struct MPT3SAS_ADAPTER *ioc, u16 smid);1731void mpt3sas_base_initialize_callback_handler(void);1732u8 mpt3sas_base_register_callback_handler(MPT_CALLBACK cb_func);1733void mpt3sas_base_release_callback_handler(u8 cb_idx);1734 1735u8 mpt3sas_base_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,1736 u32 reply);1737u8 mpt3sas_port_enable_done(struct MPT3SAS_ADAPTER *ioc, u16 smid,1738 u8 msix_index, u32 reply);1739void *mpt3sas_base_get_reply_virt_addr(struct MPT3SAS_ADAPTER *ioc,1740 u32 phys_addr);1741 1742u32 mpt3sas_base_get_iocstate(struct MPT3SAS_ADAPTER *ioc, int cooked);1743 1744void mpt3sas_base_fault_info(struct MPT3SAS_ADAPTER *ioc , u16 fault_code);1745#define mpt3sas_print_fault_code(ioc, fault_code) \1746do { pr_err("%s fault info from func: %s\n", ioc->name, __func__); \1747 mpt3sas_base_fault_info(ioc, fault_code); } while (0)1748 1749void mpt3sas_base_coredump_info(struct MPT3SAS_ADAPTER *ioc, u16 fault_code);1750#define mpt3sas_print_coredump_info(ioc, fault_code) \1751do { pr_err("%s fault info from func: %s\n", ioc->name, __func__); \1752 mpt3sas_base_coredump_info(ioc, fault_code); } while (0)1753 1754int mpt3sas_base_wait_for_coredump_completion(struct MPT3SAS_ADAPTER *ioc,1755 const char *caller);1756int mpt3sas_base_sas_iounit_control(struct MPT3SAS_ADAPTER *ioc,1757 Mpi2SasIoUnitControlReply_t *mpi_reply,1758 Mpi2SasIoUnitControlRequest_t *mpi_request);1759int mpt3sas_base_scsi_enclosure_processor(struct MPT3SAS_ADAPTER *ioc,1760 Mpi2SepReply_t *mpi_reply, Mpi2SepRequest_t *mpi_request);1761 1762void mpt3sas_base_validate_event_type(struct MPT3SAS_ADAPTER *ioc,1763 u32 *event_type);1764 1765void mpt3sas_halt_firmware(struct MPT3SAS_ADAPTER *ioc);1766 1767void mpt3sas_base_update_missing_delay(struct MPT3SAS_ADAPTER *ioc,1768 u16 device_missing_delay, u8 io_missing_delay);1769 1770int mpt3sas_base_check_for_fault_and_issue_reset(1771 struct MPT3SAS_ADAPTER *ioc);1772 1773int mpt3sas_port_enable(struct MPT3SAS_ADAPTER *ioc);1774 1775void1776mpt3sas_wait_for_commands_to_complete(struct MPT3SAS_ADAPTER *ioc);1777 1778u8 mpt3sas_base_check_cmd_timeout(struct MPT3SAS_ADAPTER *ioc,1779 u8 status, void *mpi_request, int sz);1780#define mpt3sas_check_cmd_timeout(ioc, status, mpi_request, sz, issue_reset) \1781do { ioc_err(ioc, "In func: %s\n", __func__); \1782 issue_reset = mpt3sas_base_check_cmd_timeout(ioc, \1783 status, mpi_request, sz); } while (0)1784 1785int mpt3sas_wait_for_ioc(struct MPT3SAS_ADAPTER *ioc, int wait_count);1786int mpt3sas_base_make_ioc_ready(struct MPT3SAS_ADAPTER *ioc, enum reset_type type);1787void mpt3sas_base_free_irq(struct MPT3SAS_ADAPTER *ioc);1788void mpt3sas_base_disable_msix(struct MPT3SAS_ADAPTER *ioc);1789int mpt3sas_blk_mq_poll(struct Scsi_Host *shost, unsigned int queue_num);1790void mpt3sas_base_pause_mq_polling(struct MPT3SAS_ADAPTER *ioc);1791void mpt3sas_base_resume_mq_polling(struct MPT3SAS_ADAPTER *ioc);1792int mpt3sas_base_unlock_and_get_host_diagnostic(struct MPT3SAS_ADAPTER *ioc,1793 u32 *host_diagnostic);1794void mpt3sas_base_lock_host_diagnostic(struct MPT3SAS_ADAPTER *ioc);1795 1796/* scsih shared API */1797struct scsi_cmnd *mpt3sas_scsih_scsi_lookup_get(struct MPT3SAS_ADAPTER *ioc,1798 u16 smid);1799u8 mpt3sas_scsih_event_callback(struct MPT3SAS_ADAPTER *ioc, u8 msix_index,1800 u32 reply);1801void mpt3sas_scsih_pre_reset_handler(struct MPT3SAS_ADAPTER *ioc);1802void mpt3sas_scsih_clear_outstanding_scsi_tm_commands(1803 struct MPT3SAS_ADAPTER *ioc);1804void mpt3sas_scsih_reset_done_handler(struct MPT3SAS_ADAPTER *ioc);1805 1806int mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,1807 uint channel, uint id, u64 lun, u8 type, u16 smid_task,1808 u16 msix_task, u8 timeout, u8 tr_method);1809int mpt3sas_scsih_issue_locked_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,1810 uint channel, uint id, u64 lun, u8 type, u16 smid_task,1811 u16 msix_task, u8 timeout, u8 tr_method);1812 1813void mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);1814void mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle);1815void mpt3sas_expander_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,1816 struct hba_port *port);1817void mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,1818 u64 sas_address, struct hba_port *port);1819u8 mpt3sas_check_for_pending_internal_cmds(struct MPT3SAS_ADAPTER *ioc,1820 u16 smid);1821struct hba_port *1822mpt3sas_get_port_by_id(struct MPT3SAS_ADAPTER *ioc, u8 port,1823 u8 bypass_dirty_port_flag);1824 1825struct _sas_node *mpt3sas_scsih_expander_find_by_handle(1826 struct MPT3SAS_ADAPTER *ioc, u16 handle);1827struct _sas_node *mpt3sas_scsih_expander_find_by_sas_address(1828 struct MPT3SAS_ADAPTER *ioc, u64 sas_address,1829 struct hba_port *port);1830struct _sas_device *mpt3sas_get_sdev_by_addr(1831 struct MPT3SAS_ADAPTER *ioc, u64 sas_address,1832 struct hba_port *port);1833struct _sas_device *__mpt3sas_get_sdev_by_addr(1834 struct MPT3SAS_ADAPTER *ioc, u64 sas_address,1835 struct hba_port *port);1836struct _sas_device *mpt3sas_get_sdev_by_handle(struct MPT3SAS_ADAPTER *ioc,1837 u16 handle);1838struct _pcie_device *mpt3sas_get_pdev_by_handle(struct MPT3SAS_ADAPTER *ioc,1839 u16 handle);1840 1841void mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc);1842struct _raid_device *1843mpt3sas_raid_device_find_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle);1844void mpt3sas_scsih_change_queue_depth(struct scsi_device *sdev, int qdepth);1845struct _sas_device *1846__mpt3sas_get_sdev_by_rphy(struct MPT3SAS_ADAPTER *ioc, struct sas_rphy *rphy);1847struct virtual_phy *1848mpt3sas_get_vphy_by_phy(struct MPT3SAS_ADAPTER *ioc,1849 struct hba_port *port, u32 phy);1850 1851/* config shared API */1852u8 mpt3sas_config_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,1853 u32 reply);1854int mpt3sas_config_get_number_hba_phys(struct MPT3SAS_ADAPTER *ioc,1855 u8 *num_phys);1856int mpt3sas_config_get_manufacturing_pg0(struct MPT3SAS_ADAPTER *ioc,1857 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage0_t *config_page);1858int mpt3sas_config_get_manufacturing_pg1(struct MPT3SAS_ADAPTER *ioc,1859 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage1_t *config_page);1860 1861int mpt3sas_config_get_manufacturing_pg7(struct MPT3SAS_ADAPTER *ioc,1862 Mpi2ConfigReply_t *mpi_reply, Mpi2ManufacturingPage7_t *config_page,1863 u16 sz);1864int mpt3sas_config_get_manufacturing_pg10(struct MPT3SAS_ADAPTER *ioc,1865 Mpi2ConfigReply_t *mpi_reply,1866 struct Mpi2ManufacturingPage10_t *config_page);1867 1868int mpt3sas_config_get_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,1869 Mpi2ConfigReply_t *mpi_reply,1870 struct Mpi2ManufacturingPage11_t *config_page);1871int mpt3sas_config_set_manufacturing_pg11(struct MPT3SAS_ADAPTER *ioc,1872 Mpi2ConfigReply_t *mpi_reply,1873 struct Mpi2ManufacturingPage11_t *config_page);1874 1875int mpt3sas_config_get_bios_pg2(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1876 *mpi_reply, Mpi2BiosPage2_t *config_page);1877int mpt3sas_config_get_bios_pg3(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1878 *mpi_reply, Mpi2BiosPage3_t *config_page);1879int mpt3sas_config_set_bios_pg4(struct MPT3SAS_ADAPTER *ioc,1880 Mpi2ConfigReply_t *mpi_reply, Mpi2BiosPage4_t *config_page,1881 int sz_config_page);1882int mpt3sas_config_get_bios_pg4(struct MPT3SAS_ADAPTER *ioc,1883 Mpi2ConfigReply_t *mpi_reply, Mpi2BiosPage4_t *config_page,1884 int sz_config_page);1885int mpt3sas_config_get_iounit_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1886 *mpi_reply, Mpi2IOUnitPage0_t *config_page);1887int mpt3sas_config_get_sas_device_pg0(struct MPT3SAS_ADAPTER *ioc,1888 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage0_t *config_page,1889 u32 form, u32 handle);1890int mpt3sas_config_get_sas_device_pg1(struct MPT3SAS_ADAPTER *ioc,1891 Mpi2ConfigReply_t *mpi_reply, Mpi2SasDevicePage1_t *config_page,1892 u32 form, u32 handle);1893int mpt3sas_config_get_pcie_device_pg0(struct MPT3SAS_ADAPTER *ioc,1894 Mpi2ConfigReply_t *mpi_reply, Mpi26PCIeDevicePage0_t *config_page,1895 u32 form, u32 handle);1896int mpt3sas_config_get_pcie_device_pg2(struct MPT3SAS_ADAPTER *ioc,1897 Mpi2ConfigReply_t *mpi_reply, Mpi26PCIeDevicePage2_t *config_page,1898 u32 form, u32 handle);1899int mpt3sas_config_get_pcie_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,1900 Mpi2ConfigReply_t *mpi_reply, Mpi26PCIeIOUnitPage1_t *config_page,1901 u16 sz);1902int mpt3sas_config_get_sas_iounit_pg0(struct MPT3SAS_ADAPTER *ioc,1903 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage0_t *config_page,1904 u16 sz);1905int mpt3sas_config_get_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1906 *mpi_reply, Mpi2IOUnitPage1_t *config_page);1907int mpt3sas_config_get_iounit_pg3(struct MPT3SAS_ADAPTER *ioc,1908 Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage3_t *config_page, u16 sz);1909int mpt3sas_config_set_iounit_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1910 *mpi_reply, Mpi2IOUnitPage1_t *config_page);1911int mpt3sas_config_get_iounit_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1912 *mpi_reply, Mpi2IOUnitPage8_t *config_page);1913int mpt3sas_config_get_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,1914 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,1915 u16 sz);1916int mpt3sas_config_set_sas_iounit_pg1(struct MPT3SAS_ADAPTER *ioc,1917 Mpi2ConfigReply_t *mpi_reply, Mpi2SasIOUnitPage1_t *config_page,1918 u16 sz);1919int mpt3sas_config_get_ioc_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1920 *mpi_reply, Mpi2IOCPage1_t *config_page);1921int mpt3sas_config_set_ioc_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1922 *mpi_reply, Mpi2IOCPage1_t *config_page);1923int mpt3sas_config_get_ioc_pg8(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1924 *mpi_reply, Mpi2IOCPage8_t *config_page);1925int mpt3sas_config_get_expander_pg0(struct MPT3SAS_ADAPTER *ioc,1926 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage0_t *config_page,1927 u32 form, u32 handle);1928int mpt3sas_config_get_expander_pg1(struct MPT3SAS_ADAPTER *ioc,1929 Mpi2ConfigReply_t *mpi_reply, Mpi2ExpanderPage1_t *config_page,1930 u32 phy_number, u16 handle);1931int mpt3sas_config_get_enclosure_pg0(struct MPT3SAS_ADAPTER *ioc,1932 Mpi2ConfigReply_t *mpi_reply, Mpi2SasEnclosurePage0_t *config_page,1933 u32 form, u32 handle);1934int mpt3sas_config_get_phy_pg0(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1935 *mpi_reply, Mpi2SasPhyPage0_t *config_page, u32 phy_number);1936int mpt3sas_config_get_phy_pg1(struct MPT3SAS_ADAPTER *ioc, Mpi2ConfigReply_t1937 *mpi_reply, Mpi2SasPhyPage1_t *config_page, u32 phy_number);1938int mpt3sas_config_get_raid_volume_pg1(struct MPT3SAS_ADAPTER *ioc,1939 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,1940 u32 handle);1941int mpt3sas_config_get_number_pds(struct MPT3SAS_ADAPTER *ioc, u16 handle,1942 u8 *num_pds);1943int mpt3sas_config_get_raid_volume_pg0(struct MPT3SAS_ADAPTER *ioc,1944 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 form,1945 u32 handle, u16 sz);1946int mpt3sas_config_get_phys_disk_pg0(struct MPT3SAS_ADAPTER *ioc,1947 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,1948 u32 form, u32 form_specific);1949int mpt3sas_config_get_volume_handle(struct MPT3SAS_ADAPTER *ioc, u16 pd_handle,1950 u16 *volume_handle);1951int mpt3sas_config_get_volume_wwid(struct MPT3SAS_ADAPTER *ioc,1952 u16 volume_handle, u64 *wwid);1953int1954mpt3sas_config_get_driver_trigger_pg0(struct MPT3SAS_ADAPTER *ioc,1955 Mpi2ConfigReply_t *mpi_reply, Mpi26DriverTriggerPage0_t *config_page);1956int1957mpt3sas_config_get_driver_trigger_pg1(struct MPT3SAS_ADAPTER *ioc,1958 Mpi2ConfigReply_t *mpi_reply, Mpi26DriverTriggerPage1_t *config_page);1959int1960mpt3sas_config_get_driver_trigger_pg2(struct MPT3SAS_ADAPTER *ioc,1961 Mpi2ConfigReply_t *mpi_reply, Mpi26DriverTriggerPage2_t *config_page);1962int1963mpt3sas_config_get_driver_trigger_pg3(struct MPT3SAS_ADAPTER *ioc,1964 Mpi2ConfigReply_t *mpi_reply, Mpi26DriverTriggerPage3_t *config_page);1965int1966mpt3sas_config_get_driver_trigger_pg4(struct MPT3SAS_ADAPTER *ioc,1967 Mpi2ConfigReply_t *mpi_reply, Mpi26DriverTriggerPage4_t *config_page);1968int1969mpt3sas_config_update_driver_trigger_pg1(struct MPT3SAS_ADAPTER *ioc,1970 struct SL_WH_MASTER_TRIGGER_T *master_tg, bool set);1971int1972mpt3sas_config_update_driver_trigger_pg2(struct MPT3SAS_ADAPTER *ioc,1973 struct SL_WH_EVENT_TRIGGERS_T *event_tg, bool set);1974int1975mpt3sas_config_update_driver_trigger_pg3(struct MPT3SAS_ADAPTER *ioc,1976 struct SL_WH_SCSI_TRIGGERS_T *scsi_tg, bool set);1977int1978mpt3sas_config_update_driver_trigger_pg4(struct MPT3SAS_ADAPTER *ioc,1979 struct SL_WH_MPI_TRIGGERS_T *mpi_tg, bool set);1980 1981/* ctl shared API */1982extern const struct attribute_group *mpt3sas_host_groups[];1983extern const struct attribute_group *mpt3sas_dev_groups[];1984void mpt3sas_ctl_init(ushort hbas_to_enumerate);1985void mpt3sas_ctl_exit(ushort hbas_to_enumerate);1986void mpt3sas_ctl_release(struct MPT3SAS_ADAPTER *ioc);1987u8 mpt3sas_ctl_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,1988 u32 reply);1989void mpt3sas_ctl_pre_reset_handler(struct MPT3SAS_ADAPTER *ioc);1990void mpt3sas_ctl_clear_outstanding_ioctls(struct MPT3SAS_ADAPTER *ioc);1991void mpt3sas_ctl_reset_done_handler(struct MPT3SAS_ADAPTER *ioc);1992u8 mpt3sas_ctl_event_callback(struct MPT3SAS_ADAPTER *ioc,1993 u8 msix_index, u32 reply);1994void mpt3sas_ctl_add_to_event_log(struct MPT3SAS_ADAPTER *ioc,1995 Mpi2EventNotificationReply_t *mpi_reply);1996 1997void mpt3sas_enable_diag_buffer(struct MPT3SAS_ADAPTER *ioc,1998 u8 bits_to_register);1999int mpt3sas_send_diag_release(struct MPT3SAS_ADAPTER *ioc, u8 buffer_type,2000 u8 *issue_reset);2001 2002/* transport shared API */2003extern struct scsi_transport_template *mpt3sas_transport_template;2004u8 mpt3sas_transport_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,2005 u32 reply);2006struct _sas_port *mpt3sas_transport_port_add(struct MPT3SAS_ADAPTER *ioc,2007 u16 handle, u64 sas_address, struct hba_port *port);2008void mpt3sas_transport_port_remove(struct MPT3SAS_ADAPTER *ioc, u64 sas_address,2009 u64 sas_address_parent, struct hba_port *port);2010int mpt3sas_transport_add_host_phy(struct MPT3SAS_ADAPTER *ioc, struct _sas_phy2011 *mpt3sas_phy, Mpi2SasPhyPage0_t phy_pg0, struct device *parent_dev);2012int mpt3sas_transport_add_expander_phy(struct MPT3SAS_ADAPTER *ioc,2013 struct _sas_phy *mpt3sas_phy, Mpi2ExpanderPage1_t expander_pg1,2014 struct device *parent_dev);2015void mpt3sas_transport_update_links(struct MPT3SAS_ADAPTER *ioc,2016 u64 sas_address, u16 handle, u8 phy_number, u8 link_rate,2017 struct hba_port *port);2018extern struct sas_function_template mpt3sas_transport_functions;2019extern struct scsi_transport_template *mpt3sas_transport_template;2020void2021mpt3sas_transport_del_phy_from_an_existing_port(struct MPT3SAS_ADAPTER *ioc,2022 struct _sas_node *sas_node, struct _sas_phy *mpt3sas_phy);2023void2024mpt3sas_transport_add_phy_to_an_existing_port(struct MPT3SAS_ADAPTER *ioc,2025 struct _sas_node *sas_node, struct _sas_phy *mpt3sas_phy,2026 u64 sas_address, struct hba_port *port);2027/* trigger data externs */2028void mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,2029 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);2030void mpt3sas_process_trigger_data(struct MPT3SAS_ADAPTER *ioc,2031 struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data);2032void mpt3sas_trigger_master(struct MPT3SAS_ADAPTER *ioc,2033 u32 trigger_bitmask);2034void mpt3sas_trigger_event(struct MPT3SAS_ADAPTER *ioc, u16 event,2035 u16 log_entry_qualifier);2036void mpt3sas_trigger_scsi(struct MPT3SAS_ADAPTER *ioc, u8 sense_key,2037 u8 asc, u8 ascq);2038void mpt3sas_trigger_mpi(struct MPT3SAS_ADAPTER *ioc, u16 ioc_status,2039 u32 loginfo);2040 2041/* warpdrive APIs */2042u8 mpt3sas_get_num_volumes(struct MPT3SAS_ADAPTER *ioc);2043void mpt3sas_init_warpdrive_properties(struct MPT3SAS_ADAPTER *ioc,2044 struct _raid_device *raid_device);2045void2046mpt3sas_setup_direct_io(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd *scmd,2047 struct _raid_device *raid_device, Mpi25SCSIIORequest_t *mpi_request);2048 2049void mpt3sas_setup_debugfs(struct MPT3SAS_ADAPTER *ioc);2050void mpt3sas_destroy_debugfs(struct MPT3SAS_ADAPTER *ioc);2051void mpt3sas_init_debugfs(void);2052void mpt3sas_exit_debugfs(void);2053 2054/**2055 * _scsih_is_pcie_scsi_device - determines if device is an pcie scsi device2056 * @device_info: bitfield providing information about the device.2057 * Context: none2058 *2059 * Returns 1 if scsi device.2060 */2061static inline int2062mpt3sas_scsih_is_pcie_scsi_device(u32 device_info)2063{2064 if ((device_info &2065 MPI26_PCIE_DEVINFO_MASK_DEVICE_TYPE) == MPI26_PCIE_DEVINFO_SCSI)2066 return 1;2067 else2068 return 0;2069}2070#endif /* MPT3SAS_BASE_H_INCLUDED */2071