1212420Sken/*- 2212420Sken * Copyright (c) 2009 Yahoo! Inc. 3281564Sslm * Copyright (c) 2011-2015 LSI Corp. 4281564Sslm * Copyright (c) 2013-2015 Avago Technologies 5212420Sken * All rights reserved. 6212420Sken * 7212420Sken * Redistribution and use in source and binary forms, with or without 8212420Sken * modification, are permitted provided that the following conditions 9212420Sken * are met: 10212420Sken * 1. Redistributions of source code must retain the above copyright 11212420Sken * notice, this list of conditions and the following disclaimer. 12212420Sken * 2. Redistributions in binary form must reproduce the above copyright 13212420Sken * notice, this list of conditions and the following disclaimer in the 14212420Sken * documentation and/or other materials provided with the distribution. 15212420Sken * 16212420Sken * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17212420Sken * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18212420Sken * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19212420Sken * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20212420Sken * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21212420Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22212420Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23212420Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24212420Sken * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25212420Sken * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26212420Sken * SUCH DAMAGE. 27230592Sken * 28281564Sslm * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD 29230592Sken * 30230592Sken * $FreeBSD: stable/10/sys/dev/mps/mpsvar.h 322661 2017-08-18 15:38:08Z ken $ 31230592Sken */ 32212420Sken 33212420Sken#ifndef _MPSVAR_H 34212420Sken#define _MPSVAR_H 35212420Sken 36319445Sslm#define MPS_DRIVER_VERSION "21.02.00.00-fbsd" 37230592Sken 38212420Sken#define MPS_DB_MAX_WAIT 2500 39212420Sken 40212420Sken#define MPS_REQ_FRAMES 1024 41212420Sken#define MPS_EVT_REPLY_FRAMES 32 42212420Sken#define MPS_REPLY_FRAMES MPS_REQ_FRAMES 43219036Sken#define MPS_CHAIN_FRAMES 2048 44303089Sslm#define MPS_MAXIO_PAGES (-1) 45212420Sken#define MPS_SENSE_LEN SSD_FULL_SIZE 46212420Sken#define MPS_MSI_COUNT 1 47212420Sken#define MPS_SGE64_SIZE 12 48212420Sken#define MPS_SGE32_SIZE 8 49212420Sken#define MPS_SGC_SIZE 8 50212420Sken 51230592Sken#define CAN_SLEEP 1 52230592Sken#define NO_SLEEP 0 53230592Sken 54212420Sken#define MPS_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 55281564Sslm#define MPS_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */ 56319445Sslm#define MPS_MISSING_CHECK_DELAY 10 /* 10 seconds between missing check */ 57212420Sken 58230592Sken#define MPS_SCSI_RI_INVALID_FRAME (0x00000002) 59231240Sken#define MPS_STRING_LENGTH 64 60230592Sken 61281564Sslm#define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */ 62281564Sslm 63237683Sken#include <sys/endian.h> 64237683Sken 65230592Sken/* 66230592Sken * host mapping related macro definitions 67230592Sken */ 68230592Sken#define MPS_MAPTABLE_BAD_IDX 0xFFFFFFFF 69230592Sken#define MPS_DPM_BAD_IDX 0xFFFF 70230592Sken#define MPS_ENCTABLE_BAD_IDX 0xFF 71230592Sken#define MPS_MAX_MISSING_COUNT 0x0F 72230592Sken#define MPS_DEV_RESERVED 0x20000000 73230592Sken#define MPS_MAP_IN_USE 0x10000000 74230592Sken#define MPS_MAP_BAD_ID 0xFFFFFFFF 75230592Sken 76230592Sken/* 77230592Sken * WarpDrive controller 78230592Sken */ 79230592Sken#define MPS_CHIP_WD_DEVICE_ID 0x007E 80230592Sken#define MPS_WD_LSI_OEM 0x80 81230592Sken#define MPS_WD_HIDE_EXPOSE_MASK 0x03 82230592Sken#define MPS_WD_HIDE_ALWAYS 0x00 83230592Sken#define MPS_WD_EXPOSE_ALWAYS 0x01 84230592Sken#define MPS_WD_HIDE_IF_VOLUME 0x02 85230592Sken#define MPS_WD_RETRY 0x01 86230592Sken#define MPS_MAN_PAGE10_SIZE 0x5C /* Hardcode for now */ 87230592Sken#define MPS_MAX_DISKS_IN_VOL 10 88230592Sken 89230592Sken/* 90230592Sken * WarpDrive Event Logging 91230592Sken */ 92230592Sken#define MPI2_WD_LOG_ENTRY 0x8002 93230592Sken#define MPI2_WD_SSD_THROTTLING 0x0041 94230592Sken#define MPI2_WD_DRIVE_LIFE_WARN 0x0043 95230592Sken#define MPI2_WD_DRIVE_LIFE_DEAD 0x0044 96230592Sken#define MPI2_WD_RAIL_MON_FAIL 0x004D 97230592Sken 98230592Skentypedef uint8_t u8; 99230592Skentypedef uint16_t u16; 100230592Skentypedef uint32_t u32; 101230592Skentypedef uint64_t u64; 102230592Sken 103230592Sken/** 104230592Sken * struct dev_mapping_table - device mapping information 105230592Sken * @physical_id: SAS address for drives or WWID for RAID volumes 106230592Sken * @device_info: bitfield provides detailed info about the device 107230592Sken * @phy_bits: bitfields indicating controller phys 108230592Sken * @dpm_entry_num: index of this device in device persistent map table 109230592Sken * @dev_handle: device handle for the device pointed by this entry 110230592Sken * @id: target id 111230592Sken * @missing_count: number of times the device not detected by driver 112230592Sken * @hide_flag: Hide this physical disk/not (foreign configuration) 113230592Sken * @init_complete: Whether the start of the day checks completed or not 114230592Sken */ 115230592Skenstruct dev_mapping_table { 116230592Sken u64 physical_id; 117230592Sken u32 device_info; 118230592Sken u32 phy_bits; 119230592Sken u16 dpm_entry_num; 120230592Sken u16 dev_handle; 121319445Sslm u16 reserved1; 122230592Sken u16 id; 123230592Sken u8 missing_count; 124230592Sken u8 init_complete; 125230592Sken u8 TLR_bits; 126230592Sken u8 reserved2; 127230592Sken}; 128230592Sken 129230592Sken/** 130230592Sken * struct enc_mapping_table - mapping information about an enclosure 131230592Sken * @enclosure_id: Logical ID of this enclosure 132230592Sken * @start_index: index to the entry in dev_mapping_table 133230592Sken * @phy_bits: bitfields indicating controller phys 134230592Sken * @dpm_entry_num: index of this enclosure in device persistent map table 135230592Sken * @enc_handle: device handle for the enclosure pointed by this entry 136230592Sken * @num_slots: number of slots in the enclosure 137230592Sken * @start_slot: Starting slot id 138230592Sken * @missing_count: number of times the device not detected by driver 139230592Sken * @removal_flag: used to mark the device for removal 140230592Sken * @skip_search: used as a flag to include/exclude enclosure for search 141230592Sken * @init_complete: Whether the start of the day checks completed or not 142230592Sken */ 143230592Skenstruct enc_mapping_table { 144230592Sken u64 enclosure_id; 145230592Sken u32 start_index; 146230592Sken u32 phy_bits; 147230592Sken u16 dpm_entry_num; 148230592Sken u16 enc_handle; 149230592Sken u16 num_slots; 150230592Sken u16 start_slot; 151230592Sken u8 missing_count; 152230592Sken u8 removal_flag; 153230592Sken u8 skip_search; 154230592Sken u8 init_complete; 155230592Sken}; 156230592Sken 157230592Sken/** 158230592Sken * struct map_removal_table - entries to be removed from mapping table 159230592Sken * @dpm_entry_num: index of this device in device persistent map table 160230592Sken * @dev_handle: device handle for the device pointed by this entry 161230592Sken */ 162230592Skenstruct map_removal_table{ 163230592Sken u16 dpm_entry_num; 164230592Sken u16 dev_handle; 165230592Sken}; 166230592Sken 167230592Skentypedef struct mps_fw_diagnostic_buffer { 168230592Sken size_t size; 169230592Sken uint8_t extended_type; 170230592Sken uint8_t buffer_type; 171230592Sken uint8_t force_release; 172230592Sken uint32_t product_specific[23]; 173230592Sken uint8_t immediate; 174230592Sken uint8_t enabled; 175230592Sken uint8_t valid_data; 176230592Sken uint8_t owned_by_firmware; 177230592Sken uint32_t unique_id; 178230592Sken} mps_fw_diagnostic_buffer_t; 179230592Sken 180212420Skenstruct mps_softc; 181212420Skenstruct mps_command; 182212420Skenstruct mpssas_softc; 183230592Skenunion ccb; 184212420Skenstruct mpssas_target; 185230592Skenstruct mps_column_map; 186212420Sken 187212420SkenMALLOC_DECLARE(M_MPT2); 188212420Sken 189212420Skentypedef void mps_evt_callback_t(struct mps_softc *, uintptr_t, 190212420Sken MPI2_EVENT_NOTIFICATION_REPLY *reply); 191212420Skentypedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm); 192212420Sken 193212420Skenstruct mps_chain { 194212420Sken TAILQ_ENTRY(mps_chain) chain_link; 195212420Sken MPI2_SGE_IO_UNION *chain; 196212420Sken uint32_t chain_busaddr; 197212420Sken}; 198212420Sken 199216088Sken/* 200216088Sken * This needs to be at least 2 to support SMP passthrough. 201216088Sken */ 202230592Sken#define MPS_IOVEC_COUNT 2 203216088Sken 204212420Skenstruct mps_command { 205212420Sken TAILQ_ENTRY(mps_command) cm_link; 206230592Sken TAILQ_ENTRY(mps_command) cm_recovery; 207212420Sken struct mps_softc *cm_sc; 208230592Sken union ccb *cm_ccb; 209212420Sken void *cm_data; 210212420Sken u_int cm_length; 211230592Sken u_int cm_out_len; 212216088Sken struct uio cm_uio; 213216088Sken struct iovec cm_iovec[MPS_IOVEC_COUNT]; 214216088Sken u_int cm_max_segs; 215212420Sken u_int cm_sglsize; 216212420Sken MPI2_SGE_IO_UNION *cm_sge; 217212420Sken uint8_t *cm_req; 218212420Sken uint8_t *cm_reply; 219212420Sken uint32_t cm_reply_data; 220212420Sken mps_command_callback_t *cm_complete; 221212420Sken void *cm_complete_data; 222212420Sken struct mpssas_target *cm_targ; 223212420Sken MPI2_REQUEST_DESCRIPTOR_UNION cm_desc; 224230592Sken u_int cm_lun; 225212420Sken u_int cm_flags; 226212420Sken#define MPS_CM_FLAGS_POLLED (1 << 0) 227212420Sken#define MPS_CM_FLAGS_COMPLETE (1 << 1) 228212420Sken#define MPS_CM_FLAGS_SGE_SIMPLE (1 << 2) 229212420Sken#define MPS_CM_FLAGS_DATAOUT (1 << 3) 230212420Sken#define MPS_CM_FLAGS_DATAIN (1 << 4) 231212420Sken#define MPS_CM_FLAGS_WAKEUP (1 << 5) 232230592Sken#define MPS_CM_FLAGS_DD_IO (1 << 6) 233216088Sken#define MPS_CM_FLAGS_USE_UIO (1 << 7) 234216088Sken#define MPS_CM_FLAGS_SMP_PASS (1 << 8) 235218812Sken#define MPS_CM_FLAGS_CHAIN_FAILED (1 << 9) 236218812Sken#define MPS_CM_FLAGS_ERROR_MASK MPS_CM_FLAGS_CHAIN_FAILED 237246713Skib#define MPS_CM_FLAGS_USE_CCB (1 << 10) 238281564Sslm#define MPS_CM_FLAGS_SATA_ID_TIMEOUT (1 << 11) 239212420Sken u_int cm_state; 240212420Sken#define MPS_CM_STATE_FREE 0 241212420Sken#define MPS_CM_STATE_BUSY 1 242212420Sken#define MPS_CM_STATE_TIMEDOUT 2 243212420Sken bus_dmamap_t cm_dmamap; 244212420Sken struct scsi_sense_data *cm_sense; 245212420Sken TAILQ_HEAD(, mps_chain) cm_chain_list; 246212420Sken uint32_t cm_req_busaddr; 247212420Sken uint32_t cm_sense_busaddr; 248212420Sken struct callout cm_callout; 249212420Sken}; 250212420Sken 251230592Skenstruct mps_column_map { 252230592Sken uint16_t dev_handle; 253230592Sken uint8_t phys_disk_num; 254230592Sken}; 255230592Sken 256212420Skenstruct mps_event_handle { 257212420Sken TAILQ_ENTRY(mps_event_handle) eh_list; 258212420Sken mps_evt_callback_t *callback; 259212420Sken void *data; 260237683Sken u32 mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 261212420Sken}; 262212420Sken 263212420Skenstruct mps_softc { 264212420Sken device_t mps_dev; 265212420Sken struct cdev *mps_cdev; 266212420Sken u_int mps_flags; 267212420Sken#define MPS_FLAGS_INTX (1 << 0) 268212420Sken#define MPS_FLAGS_MSI (1 << 1) 269212420Sken#define MPS_FLAGS_BUSY (1 << 2) 270212420Sken#define MPS_FLAGS_SHUTDOWN (1 << 3) 271230592Sken#define MPS_FLAGS_DIAGRESET (1 << 4) 272230592Sken#define MPS_FLAGS_ATTACH_DONE (1 << 5) 273230592Sken#define MPS_FLAGS_WD_AVAILABLE (1 << 6) 274322661Sken#define MPS_FLAGS_REALLOCATED (1 << 7) 275212420Sken u_int mps_debug; 276230592Sken u_int disable_msix; 277230592Sken u_int disable_msi; 278322661Sken u_int msi_msgs; 279213535Sken int tm_cmds_active; 280218812Sken int io_cmds_active; 281218812Sken int io_cmds_highwater; 282218812Sken int chain_free; 283230592Sken int max_chains; 284303089Sslm int max_io_pages; 285218812Sken int chain_free_lowwater; 286281564Sslm u_int enable_ssu; 287281564Sslm int spinup_wait_time; 288319436Sslm int use_phynum; 289218812Sken uint64_t chain_alloc_fail; 290212420Sken struct sysctl_ctx_list sysctl_ctx; 291212420Sken struct sysctl_oid *sysctl_tree; 292230592Sken char fw_version[16]; 293212420Sken struct mps_command *commands; 294212420Sken struct mps_chain *chains; 295212420Sken struct callout periodic; 296319445Sslm struct callout device_check_callout; 297212420Sken 298212420Sken struct mpssas_softc *sassc; 299231240Sken char tmp_string[MPS_STRING_LENGTH]; 300212420Sken TAILQ_HEAD(, mps_command) req_list; 301230592Sken TAILQ_HEAD(, mps_command) high_priority_req_list; 302212420Sken TAILQ_HEAD(, mps_chain) chain_list; 303213535Sken TAILQ_HEAD(, mps_command) tm_list; 304212420Sken int replypostindex; 305212420Sken int replyfreeindex; 306212420Sken 307212420Sken struct resource *mps_regs_resource; 308212420Sken bus_space_handle_t mps_bhandle; 309212420Sken bus_space_tag_t mps_btag; 310212420Sken int mps_regs_rid; 311212420Sken 312212420Sken bus_dma_tag_t mps_parent_dmat; 313212420Sken bus_dma_tag_t buffer_dmat; 314212420Sken 315212420Sken MPI2_IOC_FACTS_REPLY *facts; 316212420Sken int num_reqs; 317212420Sken int num_replies; 318212420Sken int fqdepth; /* Free queue */ 319212420Sken int pqdepth; /* Post queue */ 320212420Sken 321237683Sken u32 event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 322212420Sken TAILQ_HEAD(, mps_event_handle) event_list; 323212420Sken struct mps_event_handle *mps_log_eh; 324212420Sken 325212420Sken struct mtx mps_mtx; 326212420Sken struct intr_config_hook mps_ich; 327212420Sken struct resource *mps_irq[MPS_MSI_COUNT]; 328212420Sken void *mps_intrhand[MPS_MSI_COUNT]; 329212420Sken int mps_irq_rid[MPS_MSI_COUNT]; 330212420Sken 331212420Sken uint8_t *req_frames; 332212420Sken bus_addr_t req_busaddr; 333212420Sken bus_dma_tag_t req_dmat; 334212420Sken bus_dmamap_t req_map; 335212420Sken 336212420Sken uint8_t *reply_frames; 337212420Sken bus_addr_t reply_busaddr; 338212420Sken bus_dma_tag_t reply_dmat; 339212420Sken bus_dmamap_t reply_map; 340212420Sken 341212420Sken struct scsi_sense_data *sense_frames; 342212420Sken bus_addr_t sense_busaddr; 343212420Sken bus_dma_tag_t sense_dmat; 344212420Sken bus_dmamap_t sense_map; 345212420Sken 346212420Sken uint8_t *chain_frames; 347212420Sken bus_addr_t chain_busaddr; 348212420Sken bus_dma_tag_t chain_dmat; 349212420Sken bus_dmamap_t chain_map; 350212420Sken 351212420Sken MPI2_REPLY_DESCRIPTORS_UNION *post_queue; 352212420Sken bus_addr_t post_busaddr; 353212420Sken uint32_t *free_queue; 354212420Sken bus_addr_t free_busaddr; 355212420Sken bus_dma_tag_t queues_dmat; 356212420Sken bus_dmamap_t queues_map; 357230592Sken 358230592Sken uint8_t *fw_diag_buffer; 359230592Sken bus_addr_t fw_diag_busaddr; 360230592Sken bus_dma_tag_t fw_diag_dmat; 361230592Sken bus_dmamap_t fw_diag_map; 362230592Sken 363230592Sken uint8_t ir_firmware; 364230592Sken 365230592Sken /* static config pages */ 366230592Sken Mpi2IOCPage8_t ioc_pg8; 367230592Sken 368230592Sken /* host mapping support */ 369230592Sken struct dev_mapping_table *mapping_table; 370230592Sken struct enc_mapping_table *enclosure_table; 371230592Sken struct map_removal_table *removal_table; 372230592Sken uint8_t *dpm_entry_used; 373230592Sken uint8_t *dpm_flush_entry; 374230592Sken Mpi2DriverMappingPage0_t *dpm_pg0; 375230592Sken uint16_t max_devices; 376230592Sken uint16_t max_enclosures; 377230592Sken uint16_t max_expanders; 378230592Sken uint8_t max_volumes; 379230592Sken uint8_t num_enc_table_entries; 380230592Sken uint8_t num_rsvd_entries; 381230592Sken uint16_t max_dpm_entries; 382230592Sken uint8_t is_dpm_enable; 383230592Sken uint8_t track_mapping_events; 384230592Sken uint32_t pending_map_events; 385230592Sken 386230592Sken /* FW diag Buffer List */ 387230592Sken mps_fw_diagnostic_buffer_t 388230592Sken fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT]; 389230592Sken 390230592Sken /* Event Recording IOCTL support */ 391230592Sken uint32_t events_to_record[4]; 392230592Sken mps_event_entry_t recorded_events[MPS_EVENT_QUEUE_SIZE]; 393230592Sken uint8_t event_index; 394230592Sken uint32_t event_number; 395230592Sken 396230592Sken /* EEDP and TLR support */ 397230592Sken uint8_t eedp_enabled; 398230592Sken uint8_t control_TLR; 399230592Sken 400230592Sken /* Shutdown Event Handler */ 401230592Sken eventhandler_tag shutdown_eh; 402230592Sken 403230592Sken /* To track topo events during reset */ 404230592Sken#define MPS_DIAG_RESET_TIMEOUT 300000 405230592Sken uint8_t wait_for_port_enable; 406230592Sken uint8_t port_enable_complete; 407237683Sken uint8_t msleep_fake_chan; 408230592Sken 409230592Sken /* WD controller */ 410237683Sken uint8_t WD_available; 411230592Sken uint8_t WD_valid_config; 412230592Sken uint8_t WD_hide_expose; 413230592Sken 414230592Sken /* Direct Drive for WarpDrive */ 415230592Sken uint8_t DD_num_phys_disks; 416230592Sken uint16_t DD_dev_handle; 417230592Sken uint32_t DD_stripe_size; 418230592Sken uint32_t DD_stripe_exponent; 419230592Sken uint32_t DD_block_size; 420230592Sken uint16_t DD_block_exponent; 421230592Sken uint64_t DD_max_lba; 422230592Sken struct mps_column_map DD_column_map[MPS_MAX_DISKS_IN_VOL]; 423254116Sscottl 424254116Sscottl char exclude_ids[80]; 425254117Sscottl struct timeval lastfail; 426270250Sslm 427270250Sslm /* StartStopUnit command handling at shutdown */ 428270250Sslm uint32_t SSU_refcount; 429270250Sslm uint8_t SSU_started; 430212420Sken}; 431212420Sken 432212420Skenstruct mps_config_params { 433212420Sken MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr; 434212420Sken u_int action; 435212420Sken u_int page_address; /* Attributes, not a phys address */ 436212420Sken u_int status; 437212420Sken void *buffer; 438212420Sken u_int length; 439212420Sken int timeout; 440212420Sken void (*callback)(struct mps_softc *, struct mps_config_params *); 441212420Sken void *cbdata; 442212420Sken}; 443212420Sken 444230592Skenstruct scsi_read_capacity_eedp 445230592Sken{ 446230592Sken uint8_t addr[8]; 447230592Sken uint8_t length[4]; 448230592Sken uint8_t protect; 449230592Sken}; 450230592Sken 451212420Skenstatic __inline uint32_t 452212420Skenmps_regread(struct mps_softc *sc, uint32_t offset) 453212420Sken{ 454212420Sken return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset)); 455212420Sken} 456212420Sken 457212420Skenstatic __inline void 458212420Skenmps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val) 459212420Sken{ 460212420Sken bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val); 461212420Sken} 462212420Sken 463237683Sken/* free_queue must have Little Endian address 464237683Sken * TODO- cm_reply_data is unwanted. We can remove it. 465237683Sken * */ 466212420Skenstatic __inline void 467212420Skenmps_free_reply(struct mps_softc *sc, uint32_t busaddr) 468212420Sken{ 469212420Sken if (++sc->replyfreeindex >= sc->fqdepth) 470212420Sken sc->replyfreeindex = 0; 471237683Sken sc->free_queue[sc->replyfreeindex] = htole32(busaddr); 472212420Sken mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex); 473212420Sken} 474212420Sken 475212420Skenstatic __inline struct mps_chain * 476212420Skenmps_alloc_chain(struct mps_softc *sc) 477212420Sken{ 478212420Sken struct mps_chain *chain; 479212420Sken 480218812Sken if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) { 481212420Sken TAILQ_REMOVE(&sc->chain_list, chain, chain_link); 482218812Sken sc->chain_free--; 483218812Sken if (sc->chain_free < sc->chain_free_lowwater) 484218812Sken sc->chain_free_lowwater = sc->chain_free; 485319436Sslm } else 486218812Sken sc->chain_alloc_fail++; 487212420Sken return (chain); 488212420Sken} 489212420Sken 490212420Skenstatic __inline void 491212420Skenmps_free_chain(struct mps_softc *sc, struct mps_chain *chain) 492212420Sken{ 493218812Sken sc->chain_free++; 494212420Sken TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link); 495212420Sken} 496212420Sken 497212420Skenstatic __inline void 498212420Skenmps_free_command(struct mps_softc *sc, struct mps_command *cm) 499212420Sken{ 500212420Sken struct mps_chain *chain, *chain_temp; 501212420Sken 502230592Sken if (cm->cm_reply != NULL) 503212420Sken mps_free_reply(sc, cm->cm_reply_data); 504230592Sken cm->cm_reply = NULL; 505212420Sken cm->cm_flags = 0; 506212420Sken cm->cm_complete = NULL; 507212420Sken cm->cm_complete_data = NULL; 508230592Sken cm->cm_ccb = NULL; 509230592Sken cm->cm_targ = NULL; 510216088Sken cm->cm_max_segs = 0; 511230592Sken cm->cm_lun = 0; 512212420Sken cm->cm_state = MPS_CM_STATE_FREE; 513231240Sken cm->cm_data = NULL; 514231240Sken cm->cm_length = 0; 515231240Sken cm->cm_out_len = 0; 516231240Sken cm->cm_sglsize = 0; 517231240Sken cm->cm_sge = NULL; 518231240Sken 519212420Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 520212420Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 521212420Sken mps_free_chain(sc, chain); 522212420Sken } 523212420Sken TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link); 524212420Sken} 525212420Sken 526212420Skenstatic __inline struct mps_command * 527212420Skenmps_alloc_command(struct mps_softc *sc) 528212420Sken{ 529212420Sken struct mps_command *cm; 530212420Sken 531212420Sken cm = TAILQ_FIRST(&sc->req_list); 532212420Sken if (cm == NULL) 533212420Sken return (NULL); 534212420Sken 535212420Sken TAILQ_REMOVE(&sc->req_list, cm, cm_link); 536212420Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 537212420Sken cm->cm_state = MPS_CM_STATE_BUSY; 538212420Sken return (cm); 539212420Sken} 540212420Sken 541212420Skenstatic __inline void 542230592Skenmps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm) 543230592Sken{ 544230592Sken struct mps_chain *chain, *chain_temp; 545230592Sken 546230592Sken if (cm->cm_reply != NULL) 547230592Sken mps_free_reply(sc, cm->cm_reply_data); 548230592Sken cm->cm_reply = NULL; 549230592Sken cm->cm_flags = 0; 550230592Sken cm->cm_complete = NULL; 551230592Sken cm->cm_complete_data = NULL; 552230592Sken cm->cm_ccb = NULL; 553230592Sken cm->cm_targ = NULL; 554230592Sken cm->cm_lun = 0; 555230592Sken cm->cm_state = MPS_CM_STATE_FREE; 556230592Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 557230592Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 558230592Sken mps_free_chain(sc, chain); 559230592Sken } 560230592Sken TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link); 561230592Sken} 562230592Sken 563230592Skenstatic __inline struct mps_command * 564230592Skenmps_alloc_high_priority_command(struct mps_softc *sc) 565230592Sken{ 566230592Sken struct mps_command *cm; 567230592Sken 568230592Sken cm = TAILQ_FIRST(&sc->high_priority_req_list); 569230592Sken if (cm == NULL) 570230592Sken return (NULL); 571230592Sken 572230592Sken TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link); 573230592Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 574230592Sken cm->cm_state = MPS_CM_STATE_BUSY; 575230592Sken return (cm); 576230592Sken} 577230592Sken 578230592Skenstatic __inline void 579212420Skenmps_lock(struct mps_softc *sc) 580212420Sken{ 581212420Sken mtx_lock(&sc->mps_mtx); 582212420Sken} 583212420Sken 584212420Skenstatic __inline void 585212420Skenmps_unlock(struct mps_softc *sc) 586212420Sken{ 587212420Sken mtx_unlock(&sc->mps_mtx); 588212420Sken} 589212420Sken 590253460Sscottl#define MPS_INFO (1 << 0) /* Basic info */ 591253460Sscottl#define MPS_FAULT (1 << 1) /* Hardware faults */ 592253460Sscottl#define MPS_EVENT (1 << 2) /* Event data from the controller */ 593253460Sscottl#define MPS_LOG (1 << 3) /* Log data from the controller */ 594253460Sscottl#define MPS_RECOVERY (1 << 4) /* Command error recovery tracing */ 595253460Sscottl#define MPS_ERROR (1 << 5) /* Parameter errors, programming bugs */ 596253460Sscottl#define MPS_INIT (1 << 6) /* Things related to system init */ 597253460Sscottl#define MPS_XINFO (1 << 7) /* More detailed/noisy info */ 598253460Sscottl#define MPS_USER (1 << 8) /* Trace user-generated commands */ 599253460Sscottl#define MPS_MAPPING (1 << 9) /* Trace device mappings */ 600253460Sscottl#define MPS_TRACE (1 << 10) /* Function-by-function trace */ 601212420Sken 602281564Sslm#define MPS_SSU_DISABLE_SSD_DISABLE_HDD 0 603281564Sslm#define MPS_SSU_ENABLE_SSD_DISABLE_HDD 1 604281564Sslm#define MPS_SSU_DISABLE_SSD_ENABLE_HDD 2 605281564Sslm#define MPS_SSU_ENABLE_SSD_ENABLE_HDD 3 606281564Sslm 607212420Sken#define mps_printf(sc, args...) \ 608212420Sken device_printf((sc)->mps_dev, ##args) 609212420Sken 610319436Sslm#define mps_print_field(sc, msg, args...) \ 611319436Sslm printf("\t" msg, ##args) 612319436Sslm 613230592Sken#define mps_vprintf(sc, args...) \ 614230592Skendo { \ 615230592Sken if (bootverbose) \ 616230592Sken mps_printf(sc, ##args); \ 617230592Sken} while (0) 618230592Sken 619212420Sken#define mps_dprint(sc, level, msg, args...) \ 620212420Skendo { \ 621253460Sscottl if ((sc)->mps_debug & (level)) \ 622253460Sscottl device_printf((sc)->mps_dev, msg, ##args); \ 623212420Sken} while (0) 624212420Sken 625212420Sken#define MPS_PRINTFIELD_START(sc, tag...) \ 626319436Sslm mps_printf((sc), ##tag); \ 627319436Sslm mps_print_field((sc), ":\n") 628212420Sken#define MPS_PRINTFIELD_END(sc, tag) \ 629319436Sslm mps_printf((sc), tag "\n") 630212420Sken#define MPS_PRINTFIELD(sc, facts, attr, fmt) \ 631319436Sslm mps_print_field((sc), #attr ": " #fmt "\n", (facts)->attr) 632212420Sken 633253460Sscottl#define MPS_FUNCTRACE(sc) \ 634253460Sscottl mps_dprint((sc), MPS_TRACE, "%s\n", __func__) 635253460Sscottl 636237683Sken#define CAN_SLEEP 1 637237683Sken#define NO_SLEEP 0 638237683Sken 639212420Skenstatic __inline void 640212420Skenmps_from_u64(uint64_t data, U64 *mps) 641212420Sken{ 642238974Smav (mps)->High = htole32((uint32_t)((data) >> 32)); 643238974Smav (mps)->Low = htole32((uint32_t)((data) & 0xffffffff)); 644212420Sken} 645212420Sken 646212420Skenstatic __inline uint64_t 647212420Skenmps_to_u64(U64 *data) 648212420Sken{ 649212420Sken 650238974Smav return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low)); 651212420Sken} 652212420Sken 653212420Skenstatic __inline void 654212420Skenmps_mask_intr(struct mps_softc *sc) 655212420Sken{ 656212420Sken uint32_t mask; 657212420Sken 658212420Sken mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 659212420Sken mask |= MPI2_HIM_REPLY_INT_MASK; 660212420Sken mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 661212420Sken} 662212420Sken 663212420Skenstatic __inline void 664212420Skenmps_unmask_intr(struct mps_softc *sc) 665212420Sken{ 666212420Sken uint32_t mask; 667212420Sken 668212420Sken mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 669212420Sken mask &= ~MPI2_HIM_REPLY_INT_MASK; 670212420Sken mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 671212420Sken} 672212420Sken 673230592Skenint mps_pci_setup_interrupts(struct mps_softc *sc); 674230592Skenint mps_pci_restore(struct mps_softc *sc); 675230592Sken 676322661Skenvoid mps_get_tunables(struct mps_softc *sc); 677212420Skenint mps_attach(struct mps_softc *sc); 678212420Skenint mps_free(struct mps_softc *sc); 679212420Skenvoid mps_intr(void *); 680212420Skenvoid mps_intr_msi(void *); 681212420Skenvoid mps_intr_locked(void *); 682237683Skenint mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *, 683212420Sken void *, struct mps_event_handle **); 684230592Skenint mps_restart(struct mps_softc *); 685237683Skenint mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *); 686237683Skenvoid mps_deregister_events(struct mps_softc *, struct mps_event_handle *); 687213839Smdfint mps_push_sge(struct mps_command *, void *, size_t, int); 688213839Smdfint mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int); 689212420Skenint mps_attach_sas(struct mps_softc *sc); 690212420Skenint mps_detach_sas(struct mps_softc *sc); 691212420Skenint mps_read_config_page(struct mps_softc *, struct mps_config_params *); 692212420Skenint mps_write_config_page(struct mps_softc *, struct mps_config_params *); 693212420Skenvoid mps_memaddr_cb(void *, bus_dma_segment_t *, int , int ); 694216088Skenvoid mpi_init_sge(struct mps_command *cm, void *req, void *sge); 695212420Skenint mps_attach_user(struct mps_softc *); 696212420Skenvoid mps_detach_user(struct mps_softc *); 697230592Skenvoid mpssas_record_event(struct mps_softc *sc, 698230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event_reply); 699212420Sken 700230592Skenint mps_map_command(struct mps_softc *sc, struct mps_command *cm); 701322661Skenint mps_wait_command(struct mps_softc *sc, struct mps_command **cm, int timeout, 702253550Sken int sleep_flag); 703230592Sken 704230592Skenint mps_config_get_bios_pg3(struct mps_softc *sc, Mpi2ConfigReply_t 705230592Sken *mpi_reply, Mpi2BiosPage3_t *config_page); 706230592Skenint mps_config_get_raid_volume_pg0(struct mps_softc *sc, Mpi2ConfigReply_t 707230592Sken *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address); 708230592Skenint mps_config_get_ioc_pg8(struct mps_softc *sc, Mpi2ConfigReply_t *, 709230592Sken Mpi2IOCPage8_t *); 710230592Skenint mps_config_get_man_pg10(struct mps_softc *sc, Mpi2ConfigReply_t *mpi_reply); 711230592Skenint mps_config_get_sas_device_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 712230592Sken Mpi2SasDevicePage0_t *, u32 , u16 ); 713230592Skenint mps_config_get_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 714230592Sken Mpi2DriverMappingPage0_t *, u16 ); 715230592Skenint mps_config_get_raid_volume_pg1(struct mps_softc *sc, 716230592Sken Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, 717230592Sken u16 handle); 718230592Skenint mps_config_get_volume_wwid(struct mps_softc *sc, u16 volume_handle, 719230592Sken u64 *wwid); 720230592Skenint mps_config_get_raid_pd_pg0(struct mps_softc *sc, 721230592Sken Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, 722230592Sken u32 page_address); 723230592Skenvoid mpssas_ir_shutdown(struct mps_softc *sc); 724230592Sken 725230592Skenint mps_reinit(struct mps_softc *sc); 726230592Skenvoid mpssas_handle_reinit(struct mps_softc *sc); 727230592Sken 728230592Skenvoid mps_base_static_config_pages(struct mps_softc *sc); 729230592Skenvoid mps_wd_config_pages(struct mps_softc *sc); 730230592Sken 731230592Skenint mps_mapping_initialize(struct mps_softc *); 732230592Skenvoid mps_mapping_topology_change_event(struct mps_softc *, 733230592Sken Mpi2EventDataSasTopologyChangeList_t *); 734230592Skenvoid mps_mapping_free_memory(struct mps_softc *sc); 735230592Skenint mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 736230592Sken Mpi2DriverMappingPage0_t *, u16 ); 737230592Skenvoid mps_mapping_exit(struct mps_softc *); 738319445Sslmvoid mps_mapping_check_devices(void *); 739230592Skenint mps_mapping_allocate_memory(struct mps_softc *sc); 740319445Sslmunsigned int mps_mapping_get_tid(struct mps_softc *, uint64_t , u16); 741319445Sslmunsigned int mps_mapping_get_tid_from_handle(struct mps_softc *sc, 742230592Sken u16 handle); 743319445Sslmunsigned int mps_mapping_get_raid_tid(struct mps_softc *sc, u64 wwid, 744319445Sslm u16 volHandle); 745319445Sslmunsigned int mps_mapping_get_raid_tid_from_handle(struct mps_softc *sc, 746230592Sken u16 volHandle); 747230592Skenvoid mps_mapping_enclosure_dev_status_change_event(struct mps_softc *, 748230592Sken Mpi2EventDataSasEnclDevStatusChange_t *event_data); 749230592Skenvoid mps_mapping_ir_config_change_event(struct mps_softc *sc, 750230592Sken Mpi2EventDataIrConfigChangeList_t *event_data); 751319436Sslmint mps_mapping_dump(SYSCTL_HANDLER_ARGS); 752319436Sslmint mps_mapping_encl_dump(SYSCTL_HANDLER_ARGS); 753230592Sken 754230592Skenvoid mpssas_evt_handler(struct mps_softc *sc, uintptr_t data, 755230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event); 756230592Skenvoid mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle); 757231240Skenvoid mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle); 758230592Skenint mpssas_startup(struct mps_softc *sc); 759231240Skenstruct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t); 760268197Sscottlvoid mpssas_realloc_targets(struct mps_softc *sc, int maxtargets); 761268197Sscottlstruct mps_command * mpssas_alloc_tm(struct mps_softc *sc); 762268197Sscottlvoid mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm); 763270250Sslmvoid mpssas_release_simq_reinit(struct mpssas_softc *sassc); 764281564Sslmint mpssas_send_reset(struct mps_softc *sc, struct mps_command *tm, 765281564Sslm uint8_t type); 766230592Sken 767212420SkenSYSCTL_DECL(_hw_mps); 768212420Sken 769230592Sken/* Compatibility shims for different OS versions */ 770230592Sken#if __FreeBSD_version >= 800001 771230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 772230592Sken kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 773230592Sken#define mps_kproc_exit(arg) kproc_exit(arg) 774230592Sken#else 775230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 776230592Sken kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 777230592Sken#define mps_kproc_exit(arg) kthread_exit(arg) 778212420Sken#endif 779212420Sken 780230592Sken#if defined(CAM_PRIORITY_XPT) 781230592Sken#define MPS_PRIORITY_XPT CAM_PRIORITY_XPT 782230592Sken#else 783230592Sken#define MPS_PRIORITY_XPT 5 784230592Sken#endif 785237683Sken 786237683Sken#if __FreeBSD_version < 800107 787237683Sken// Prior to FreeBSD-8.0 scp3_flags was not defined. 788237683Sken#define spc3_flags reserved 789237683Sken 790237683Sken#define SPC3_SID_PROTECT 0x01 791237683Sken#define SPC3_SID_3PC 0x08 792237683Sken#define SPC3_SID_TPGS_MASK 0x30 793237683Sken#define SPC3_SID_TPGS_IMPLICIT 0x10 794237683Sken#define SPC3_SID_TPGS_EXPLICIT 0x20 795237683Sken#define SPC3_SID_ACC 0x40 796237683Sken#define SPC3_SID_SCCS 0x80 797237683Sken 798237683Sken#define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE 799230592Sken#endif 800230592Sken 801237683Sken#endif 802237683Sken 803