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: releng/10.3/sys/dev/mps/mpsvar.h 281564 2015-04-15 21:47:15Z slm $ 31230592Sken */ 32212420Sken 33212420Sken#ifndef _MPSVAR_H 34212420Sken#define _MPSVAR_H 35212420Sken 36281564Sslm#define MPS_DRIVER_VERSION "20.00.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 44212420Sken#define MPS_SENSE_LEN SSD_FULL_SIZE 45212420Sken#define MPS_MSI_COUNT 1 46212420Sken#define MPS_SGE64_SIZE 12 47212420Sken#define MPS_SGE32_SIZE 8 48212420Sken#define MPS_SGC_SIZE 8 49212420Sken 50230592Sken#define CAN_SLEEP 1 51230592Sken#define NO_SLEEP 0 52230592Sken 53212420Sken#define MPS_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 54281564Sslm#define MPS_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */ 55212420Sken 56230592Sken#define MPS_SCSI_RI_INVALID_FRAME (0x00000002) 57231240Sken#define MPS_STRING_LENGTH 64 58230592Sken 59281564Sslm#define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */ 60281564Sslm 61237683Sken#include <sys/endian.h> 62237683Sken 63230592Sken/* 64230592Sken * host mapping related macro definitions 65230592Sken */ 66230592Sken#define MPS_MAPTABLE_BAD_IDX 0xFFFFFFFF 67230592Sken#define MPS_DPM_BAD_IDX 0xFFFF 68230592Sken#define MPS_ENCTABLE_BAD_IDX 0xFF 69230592Sken#define MPS_MAX_MISSING_COUNT 0x0F 70230592Sken#define MPS_DEV_RESERVED 0x20000000 71230592Sken#define MPS_MAP_IN_USE 0x10000000 72230592Sken#define MPS_RAID_CHANNEL 1 73230592Sken#define MPS_MAP_BAD_ID 0xFFFFFFFF 74230592Sken 75230592Sken/* 76230592Sken * WarpDrive controller 77230592Sken */ 78230592Sken#define MPS_CHIP_WD_DEVICE_ID 0x007E 79230592Sken#define MPS_WD_LSI_OEM 0x80 80230592Sken#define MPS_WD_HIDE_EXPOSE_MASK 0x03 81230592Sken#define MPS_WD_HIDE_ALWAYS 0x00 82230592Sken#define MPS_WD_EXPOSE_ALWAYS 0x01 83230592Sken#define MPS_WD_HIDE_IF_VOLUME 0x02 84230592Sken#define MPS_WD_RETRY 0x01 85230592Sken#define MPS_MAN_PAGE10_SIZE 0x5C /* Hardcode for now */ 86230592Sken#define MPS_MAX_DISKS_IN_VOL 10 87230592Sken 88230592Sken/* 89230592Sken * WarpDrive Event Logging 90230592Sken */ 91230592Sken#define MPI2_WD_LOG_ENTRY 0x8002 92230592Sken#define MPI2_WD_SSD_THROTTLING 0x0041 93230592Sken#define MPI2_WD_DRIVE_LIFE_WARN 0x0043 94230592Sken#define MPI2_WD_DRIVE_LIFE_DEAD 0x0044 95230592Sken#define MPI2_WD_RAIL_MON_FAIL 0x004D 96230592Sken 97230592Skentypedef uint8_t u8; 98230592Skentypedef uint16_t u16; 99230592Skentypedef uint32_t u32; 100230592Skentypedef uint64_t u64; 101230592Sken 102230592Sken/** 103230592Sken * struct dev_mapping_table - device mapping information 104230592Sken * @physical_id: SAS address for drives or WWID for RAID volumes 105230592Sken * @device_info: bitfield provides detailed info about the device 106230592Sken * @phy_bits: bitfields indicating controller phys 107230592Sken * @dpm_entry_num: index of this device in device persistent map table 108230592Sken * @dev_handle: device handle for the device pointed by this entry 109230592Sken * @channel: target channel 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; 121230592Sken u8 reserved1; 122230592Sken u8 channel; 123230592Sken u16 id; 124230592Sken u8 missing_count; 125230592Sken u8 init_complete; 126230592Sken u8 TLR_bits; 127230592Sken u8 reserved2; 128230592Sken}; 129230592Sken 130230592Sken/** 131230592Sken * struct enc_mapping_table - mapping information about an enclosure 132230592Sken * @enclosure_id: Logical ID of this enclosure 133230592Sken * @start_index: index to the entry in dev_mapping_table 134230592Sken * @phy_bits: bitfields indicating controller phys 135230592Sken * @dpm_entry_num: index of this enclosure in device persistent map table 136230592Sken * @enc_handle: device handle for the enclosure pointed by this entry 137230592Sken * @num_slots: number of slots in the enclosure 138230592Sken * @start_slot: Starting slot id 139230592Sken * @missing_count: number of times the device not detected by driver 140230592Sken * @removal_flag: used to mark the device for removal 141230592Sken * @skip_search: used as a flag to include/exclude enclosure for search 142230592Sken * @init_complete: Whether the start of the day checks completed or not 143230592Sken */ 144230592Skenstruct enc_mapping_table { 145230592Sken u64 enclosure_id; 146230592Sken u32 start_index; 147230592Sken u32 phy_bits; 148230592Sken u16 dpm_entry_num; 149230592Sken u16 enc_handle; 150230592Sken u16 num_slots; 151230592Sken u16 start_slot; 152230592Sken u8 missing_count; 153230592Sken u8 removal_flag; 154230592Sken u8 skip_search; 155230592Sken u8 init_complete; 156230592Sken}; 157230592Sken 158230592Sken/** 159230592Sken * struct map_removal_table - entries to be removed from mapping table 160230592Sken * @dpm_entry_num: index of this device in device persistent map table 161230592Sken * @dev_handle: device handle for the device pointed by this entry 162230592Sken */ 163230592Skenstruct map_removal_table{ 164230592Sken u16 dpm_entry_num; 165230592Sken u16 dev_handle; 166230592Sken}; 167230592Sken 168230592Skentypedef struct mps_fw_diagnostic_buffer { 169230592Sken size_t size; 170230592Sken uint8_t extended_type; 171230592Sken uint8_t buffer_type; 172230592Sken uint8_t force_release; 173230592Sken uint32_t product_specific[23]; 174230592Sken uint8_t immediate; 175230592Sken uint8_t enabled; 176230592Sken uint8_t valid_data; 177230592Sken uint8_t owned_by_firmware; 178230592Sken uint32_t unique_id; 179230592Sken} mps_fw_diagnostic_buffer_t; 180230592Sken 181212420Skenstruct mps_softc; 182212420Skenstruct mps_command; 183212420Skenstruct mpssas_softc; 184230592Skenunion ccb; 185212420Skenstruct mpssas_target; 186230592Skenstruct mps_column_map; 187212420Sken 188212420SkenMALLOC_DECLARE(M_MPT2); 189212420Sken 190212420Skentypedef void mps_evt_callback_t(struct mps_softc *, uintptr_t, 191212420Sken MPI2_EVENT_NOTIFICATION_REPLY *reply); 192212420Skentypedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm); 193212420Sken 194212420Skenstruct mps_chain { 195212420Sken TAILQ_ENTRY(mps_chain) chain_link; 196212420Sken MPI2_SGE_IO_UNION *chain; 197212420Sken uint32_t chain_busaddr; 198212420Sken}; 199212420Sken 200216088Sken/* 201216088Sken * This needs to be at least 2 to support SMP passthrough. 202216088Sken */ 203230592Sken#define MPS_IOVEC_COUNT 2 204216088Sken 205212420Skenstruct mps_command { 206212420Sken TAILQ_ENTRY(mps_command) cm_link; 207230592Sken TAILQ_ENTRY(mps_command) cm_recovery; 208212420Sken struct mps_softc *cm_sc; 209230592Sken union ccb *cm_ccb; 210212420Sken void *cm_data; 211212420Sken u_int cm_length; 212230592Sken u_int cm_out_len; 213216088Sken struct uio cm_uio; 214216088Sken struct iovec cm_iovec[MPS_IOVEC_COUNT]; 215216088Sken u_int cm_max_segs; 216212420Sken u_int cm_sglsize; 217212420Sken MPI2_SGE_IO_UNION *cm_sge; 218212420Sken uint8_t *cm_req; 219212420Sken uint8_t *cm_reply; 220212420Sken uint32_t cm_reply_data; 221212420Sken mps_command_callback_t *cm_complete; 222212420Sken void *cm_complete_data; 223212420Sken struct mpssas_target *cm_targ; 224212420Sken MPI2_REQUEST_DESCRIPTOR_UNION cm_desc; 225230592Sken u_int cm_lun; 226212420Sken u_int cm_flags; 227212420Sken#define MPS_CM_FLAGS_POLLED (1 << 0) 228212420Sken#define MPS_CM_FLAGS_COMPLETE (1 << 1) 229212420Sken#define MPS_CM_FLAGS_SGE_SIMPLE (1 << 2) 230212420Sken#define MPS_CM_FLAGS_DATAOUT (1 << 3) 231212420Sken#define MPS_CM_FLAGS_DATAIN (1 << 4) 232212420Sken#define MPS_CM_FLAGS_WAKEUP (1 << 5) 233230592Sken#define MPS_CM_FLAGS_DD_IO (1 << 6) 234216088Sken#define MPS_CM_FLAGS_USE_UIO (1 << 7) 235216088Sken#define MPS_CM_FLAGS_SMP_PASS (1 << 8) 236218812Sken#define MPS_CM_FLAGS_CHAIN_FAILED (1 << 9) 237218812Sken#define MPS_CM_FLAGS_ERROR_MASK MPS_CM_FLAGS_CHAIN_FAILED 238246713Skib#define MPS_CM_FLAGS_USE_CCB (1 << 10) 239281564Sslm#define MPS_CM_FLAGS_SATA_ID_TIMEOUT (1 << 11) 240212420Sken u_int cm_state; 241212420Sken#define MPS_CM_STATE_FREE 0 242212420Sken#define MPS_CM_STATE_BUSY 1 243212420Sken#define MPS_CM_STATE_TIMEDOUT 2 244212420Sken bus_dmamap_t cm_dmamap; 245212420Sken struct scsi_sense_data *cm_sense; 246212420Sken TAILQ_HEAD(, mps_chain) cm_chain_list; 247212420Sken uint32_t cm_req_busaddr; 248212420Sken uint32_t cm_sense_busaddr; 249212420Sken struct callout cm_callout; 250212420Sken}; 251212420Sken 252230592Skenstruct mps_column_map { 253230592Sken uint16_t dev_handle; 254230592Sken uint8_t phys_disk_num; 255230592Sken}; 256230592Sken 257212420Skenstruct mps_event_handle { 258212420Sken TAILQ_ENTRY(mps_event_handle) eh_list; 259212420Sken mps_evt_callback_t *callback; 260212420Sken void *data; 261237683Sken u32 mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 262212420Sken}; 263212420Sken 264212420Skenstruct mps_softc { 265212420Sken device_t mps_dev; 266212420Sken struct cdev *mps_cdev; 267212420Sken u_int mps_flags; 268212420Sken#define MPS_FLAGS_INTX (1 << 0) 269212420Sken#define MPS_FLAGS_MSI (1 << 1) 270212420Sken#define MPS_FLAGS_BUSY (1 << 2) 271212420Sken#define MPS_FLAGS_SHUTDOWN (1 << 3) 272230592Sken#define MPS_FLAGS_DIAGRESET (1 << 4) 273230592Sken#define MPS_FLAGS_ATTACH_DONE (1 << 5) 274230592Sken#define MPS_FLAGS_WD_AVAILABLE (1 << 6) 275212420Sken u_int mps_debug; 276230592Sken u_int disable_msix; 277230592Sken u_int disable_msi; 278213535Sken int tm_cmds_active; 279218812Sken int io_cmds_active; 280218812Sken int io_cmds_highwater; 281218812Sken int chain_free; 282230592Sken int max_chains; 283218812Sken int chain_free_lowwater; 284281564Sslm u_int enable_ssu; 285281564Sslm int spinup_wait_time; 286230592Sken#if __FreeBSD_version >= 900030 287218812Sken uint64_t chain_alloc_fail; 288230592Sken#endif 289212420Sken struct sysctl_ctx_list sysctl_ctx; 290212420Sken struct sysctl_oid *sysctl_tree; 291230592Sken char fw_version[16]; 292212420Sken struct mps_command *commands; 293212420Sken struct mps_chain *chains; 294212420Sken struct callout periodic; 295212420Sken 296212420Sken struct mpssas_softc *sassc; 297231240Sken char tmp_string[MPS_STRING_LENGTH]; 298212420Sken TAILQ_HEAD(, mps_command) req_list; 299230592Sken TAILQ_HEAD(, mps_command) high_priority_req_list; 300212420Sken TAILQ_HEAD(, mps_chain) chain_list; 301213535Sken TAILQ_HEAD(, mps_command) tm_list; 302212420Sken int replypostindex; 303212420Sken int replyfreeindex; 304212420Sken 305212420Sken struct resource *mps_regs_resource; 306212420Sken bus_space_handle_t mps_bhandle; 307212420Sken bus_space_tag_t mps_btag; 308212420Sken int mps_regs_rid; 309212420Sken 310212420Sken bus_dma_tag_t mps_parent_dmat; 311212420Sken bus_dma_tag_t buffer_dmat; 312212420Sken 313212420Sken MPI2_IOC_FACTS_REPLY *facts; 314212420Sken int num_reqs; 315212420Sken int num_replies; 316212420Sken int fqdepth; /* Free queue */ 317212420Sken int pqdepth; /* Post queue */ 318212420Sken 319237683Sken u32 event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 320212420Sken TAILQ_HEAD(, mps_event_handle) event_list; 321212420Sken struct mps_event_handle *mps_log_eh; 322212420Sken 323212420Sken struct mtx mps_mtx; 324212420Sken struct intr_config_hook mps_ich; 325212420Sken struct resource *mps_irq[MPS_MSI_COUNT]; 326212420Sken void *mps_intrhand[MPS_MSI_COUNT]; 327212420Sken int mps_irq_rid[MPS_MSI_COUNT]; 328212420Sken 329212420Sken uint8_t *req_frames; 330212420Sken bus_addr_t req_busaddr; 331212420Sken bus_dma_tag_t req_dmat; 332212420Sken bus_dmamap_t req_map; 333212420Sken 334212420Sken uint8_t *reply_frames; 335212420Sken bus_addr_t reply_busaddr; 336212420Sken bus_dma_tag_t reply_dmat; 337212420Sken bus_dmamap_t reply_map; 338212420Sken 339212420Sken struct scsi_sense_data *sense_frames; 340212420Sken bus_addr_t sense_busaddr; 341212420Sken bus_dma_tag_t sense_dmat; 342212420Sken bus_dmamap_t sense_map; 343212420Sken 344212420Sken uint8_t *chain_frames; 345212420Sken bus_addr_t chain_busaddr; 346212420Sken bus_dma_tag_t chain_dmat; 347212420Sken bus_dmamap_t chain_map; 348212420Sken 349212420Sken MPI2_REPLY_DESCRIPTORS_UNION *post_queue; 350212420Sken bus_addr_t post_busaddr; 351212420Sken uint32_t *free_queue; 352212420Sken bus_addr_t free_busaddr; 353212420Sken bus_dma_tag_t queues_dmat; 354212420Sken bus_dmamap_t queues_map; 355230592Sken 356230592Sken uint8_t *fw_diag_buffer; 357230592Sken bus_addr_t fw_diag_busaddr; 358230592Sken bus_dma_tag_t fw_diag_dmat; 359230592Sken bus_dmamap_t fw_diag_map; 360230592Sken 361230592Sken uint8_t ir_firmware; 362230592Sken 363230592Sken /* static config pages */ 364230592Sken Mpi2IOCPage8_t ioc_pg8; 365230592Sken 366230592Sken /* host mapping support */ 367230592Sken struct dev_mapping_table *mapping_table; 368230592Sken struct enc_mapping_table *enclosure_table; 369230592Sken struct map_removal_table *removal_table; 370230592Sken uint8_t *dpm_entry_used; 371230592Sken uint8_t *dpm_flush_entry; 372230592Sken Mpi2DriverMappingPage0_t *dpm_pg0; 373230592Sken uint16_t max_devices; 374230592Sken uint16_t max_enclosures; 375230592Sken uint16_t max_expanders; 376230592Sken uint8_t max_volumes; 377230592Sken uint8_t num_enc_table_entries; 378230592Sken uint8_t num_rsvd_entries; 379230592Sken uint8_t num_channels; 380230592Sken uint16_t max_dpm_entries; 381230592Sken uint8_t is_dpm_enable; 382230592Sken uint8_t track_mapping_events; 383230592Sken uint32_t pending_map_events; 384230592Sken uint8_t mt_full_retry; 385230592Sken uint8_t mt_add_device_failed; 386230592Sken 387230592Sken /* FW diag Buffer List */ 388230592Sken mps_fw_diagnostic_buffer_t 389230592Sken fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT]; 390230592Sken 391230592Sken /* Event Recording IOCTL support */ 392230592Sken uint32_t events_to_record[4]; 393230592Sken mps_event_entry_t recorded_events[MPS_EVENT_QUEUE_SIZE]; 394230592Sken uint8_t event_index; 395230592Sken uint32_t event_number; 396230592Sken 397230592Sken /* EEDP and TLR support */ 398230592Sken uint8_t eedp_enabled; 399230592Sken uint8_t control_TLR; 400230592Sken 401230592Sken /* Shutdown Event Handler */ 402230592Sken eventhandler_tag shutdown_eh; 403230592Sken 404230592Sken /* To track topo events during reset */ 405230592Sken#define MPS_DIAG_RESET_TIMEOUT 300000 406230592Sken uint8_t wait_for_port_enable; 407230592Sken uint8_t port_enable_complete; 408237683Sken uint8_t msleep_fake_chan; 409230592Sken 410230592Sken /* WD controller */ 411237683Sken uint8_t WD_available; 412230592Sken uint8_t WD_valid_config; 413230592Sken uint8_t WD_hide_expose; 414230592Sken 415230592Sken /* Direct Drive for WarpDrive */ 416230592Sken uint8_t DD_num_phys_disks; 417230592Sken uint16_t DD_dev_handle; 418230592Sken uint32_t DD_stripe_size; 419230592Sken uint32_t DD_stripe_exponent; 420230592Sken uint32_t DD_block_size; 421230592Sken uint16_t DD_block_exponent; 422230592Sken uint64_t DD_max_lba; 423230592Sken struct mps_column_map DD_column_map[MPS_MAX_DISKS_IN_VOL]; 424254116Sscottl 425254116Sscottl char exclude_ids[80]; 426254117Sscottl struct timeval lastfail; 427270250Sslm 428270250Sslm /* StartStopUnit command handling at shutdown */ 429270250Sslm uint32_t SSU_refcount; 430270250Sslm uint8_t SSU_started; 431212420Sken}; 432212420Sken 433212420Skenstruct mps_config_params { 434212420Sken MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr; 435212420Sken u_int action; 436212420Sken u_int page_address; /* Attributes, not a phys address */ 437212420Sken u_int status; 438212420Sken void *buffer; 439212420Sken u_int length; 440212420Sken int timeout; 441212420Sken void (*callback)(struct mps_softc *, struct mps_config_params *); 442212420Sken void *cbdata; 443212420Sken}; 444212420Sken 445230592Skenstruct scsi_read_capacity_eedp 446230592Sken{ 447230592Sken uint8_t addr[8]; 448230592Sken uint8_t length[4]; 449230592Sken uint8_t protect; 450230592Sken}; 451230592Sken 452212420Skenstatic __inline uint32_t 453212420Skenmps_regread(struct mps_softc *sc, uint32_t offset) 454212420Sken{ 455212420Sken return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset)); 456212420Sken} 457212420Sken 458212420Skenstatic __inline void 459212420Skenmps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val) 460212420Sken{ 461212420Sken bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val); 462212420Sken} 463212420Sken 464237683Sken/* free_queue must have Little Endian address 465237683Sken * TODO- cm_reply_data is unwanted. We can remove it. 466237683Sken * */ 467212420Skenstatic __inline void 468212420Skenmps_free_reply(struct mps_softc *sc, uint32_t busaddr) 469212420Sken{ 470212420Sken if (++sc->replyfreeindex >= sc->fqdepth) 471212420Sken sc->replyfreeindex = 0; 472237683Sken sc->free_queue[sc->replyfreeindex] = htole32(busaddr); 473212420Sken mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex); 474212420Sken} 475212420Sken 476212420Skenstatic __inline struct mps_chain * 477212420Skenmps_alloc_chain(struct mps_softc *sc) 478212420Sken{ 479212420Sken struct mps_chain *chain; 480212420Sken 481218812Sken if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) { 482212420Sken TAILQ_REMOVE(&sc->chain_list, chain, chain_link); 483218812Sken sc->chain_free--; 484218812Sken if (sc->chain_free < sc->chain_free_lowwater) 485218812Sken sc->chain_free_lowwater = sc->chain_free; 486230592Sken } 487230592Sken#if __FreeBSD_version >= 900030 488230592Sken else 489218812Sken sc->chain_alloc_fail++; 490230592Sken#endif 491212420Sken return (chain); 492212420Sken} 493212420Sken 494212420Skenstatic __inline void 495212420Skenmps_free_chain(struct mps_softc *sc, struct mps_chain *chain) 496212420Sken{ 497212420Sken#if 0 498212420Sken bzero(chain->chain, 128); 499212420Sken#endif 500218812Sken sc->chain_free++; 501212420Sken TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link); 502212420Sken} 503212420Sken 504212420Skenstatic __inline void 505212420Skenmps_free_command(struct mps_softc *sc, struct mps_command *cm) 506212420Sken{ 507212420Sken struct mps_chain *chain, *chain_temp; 508212420Sken 509230592Sken if (cm->cm_reply != NULL) 510212420Sken mps_free_reply(sc, cm->cm_reply_data); 511230592Sken cm->cm_reply = NULL; 512212420Sken cm->cm_flags = 0; 513212420Sken cm->cm_complete = NULL; 514212420Sken cm->cm_complete_data = NULL; 515230592Sken cm->cm_ccb = NULL; 516230592Sken cm->cm_targ = NULL; 517216088Sken cm->cm_max_segs = 0; 518230592Sken cm->cm_lun = 0; 519212420Sken cm->cm_state = MPS_CM_STATE_FREE; 520231240Sken cm->cm_data = NULL; 521231240Sken cm->cm_length = 0; 522231240Sken cm->cm_out_len = 0; 523231240Sken cm->cm_sglsize = 0; 524231240Sken cm->cm_sge = NULL; 525231240Sken 526212420Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 527212420Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 528212420Sken mps_free_chain(sc, chain); 529212420Sken } 530212420Sken TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link); 531212420Sken} 532212420Sken 533212420Skenstatic __inline struct mps_command * 534212420Skenmps_alloc_command(struct mps_softc *sc) 535212420Sken{ 536212420Sken struct mps_command *cm; 537212420Sken 538212420Sken cm = TAILQ_FIRST(&sc->req_list); 539212420Sken if (cm == NULL) 540212420Sken return (NULL); 541212420Sken 542212420Sken TAILQ_REMOVE(&sc->req_list, cm, cm_link); 543212420Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 544212420Sken cm->cm_state = MPS_CM_STATE_BUSY; 545212420Sken return (cm); 546212420Sken} 547212420Sken 548212420Skenstatic __inline void 549230592Skenmps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm) 550230592Sken{ 551230592Sken struct mps_chain *chain, *chain_temp; 552230592Sken 553230592Sken if (cm->cm_reply != NULL) 554230592Sken mps_free_reply(sc, cm->cm_reply_data); 555230592Sken cm->cm_reply = NULL; 556230592Sken cm->cm_flags = 0; 557230592Sken cm->cm_complete = NULL; 558230592Sken cm->cm_complete_data = NULL; 559230592Sken cm->cm_ccb = NULL; 560230592Sken cm->cm_targ = NULL; 561230592Sken cm->cm_lun = 0; 562230592Sken cm->cm_state = MPS_CM_STATE_FREE; 563230592Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 564230592Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 565230592Sken mps_free_chain(sc, chain); 566230592Sken } 567230592Sken TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link); 568230592Sken} 569230592Sken 570230592Skenstatic __inline struct mps_command * 571230592Skenmps_alloc_high_priority_command(struct mps_softc *sc) 572230592Sken{ 573230592Sken struct mps_command *cm; 574230592Sken 575230592Sken cm = TAILQ_FIRST(&sc->high_priority_req_list); 576230592Sken if (cm == NULL) 577230592Sken return (NULL); 578230592Sken 579230592Sken TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link); 580230592Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 581230592Sken cm->cm_state = MPS_CM_STATE_BUSY; 582230592Sken return (cm); 583230592Sken} 584230592Sken 585230592Skenstatic __inline void 586212420Skenmps_lock(struct mps_softc *sc) 587212420Sken{ 588212420Sken mtx_lock(&sc->mps_mtx); 589212420Sken} 590212420Sken 591212420Skenstatic __inline void 592212420Skenmps_unlock(struct mps_softc *sc) 593212420Sken{ 594212420Sken mtx_unlock(&sc->mps_mtx); 595212420Sken} 596212420Sken 597253460Sscottl#define MPS_INFO (1 << 0) /* Basic info */ 598253460Sscottl#define MPS_FAULT (1 << 1) /* Hardware faults */ 599253460Sscottl#define MPS_EVENT (1 << 2) /* Event data from the controller */ 600253460Sscottl#define MPS_LOG (1 << 3) /* Log data from the controller */ 601253460Sscottl#define MPS_RECOVERY (1 << 4) /* Command error recovery tracing */ 602253460Sscottl#define MPS_ERROR (1 << 5) /* Parameter errors, programming bugs */ 603253460Sscottl#define MPS_INIT (1 << 6) /* Things related to system init */ 604253460Sscottl#define MPS_XINFO (1 << 7) /* More detailed/noisy info */ 605253460Sscottl#define MPS_USER (1 << 8) /* Trace user-generated commands */ 606253460Sscottl#define MPS_MAPPING (1 << 9) /* Trace device mappings */ 607253460Sscottl#define MPS_TRACE (1 << 10) /* Function-by-function trace */ 608212420Sken 609281564Sslm#define MPS_SSU_DISABLE_SSD_DISABLE_HDD 0 610281564Sslm#define MPS_SSU_ENABLE_SSD_DISABLE_HDD 1 611281564Sslm#define MPS_SSU_DISABLE_SSD_ENABLE_HDD 2 612281564Sslm#define MPS_SSU_ENABLE_SSD_ENABLE_HDD 3 613281564Sslm 614212420Sken#define mps_printf(sc, args...) \ 615212420Sken device_printf((sc)->mps_dev, ##args) 616212420Sken 617230592Sken#define mps_vprintf(sc, args...) \ 618230592Skendo { \ 619230592Sken if (bootverbose) \ 620230592Sken mps_printf(sc, ##args); \ 621230592Sken} while (0) 622230592Sken 623212420Sken#define mps_dprint(sc, level, msg, args...) \ 624212420Skendo { \ 625253460Sscottl if ((sc)->mps_debug & (level)) \ 626253460Sscottl device_printf((sc)->mps_dev, msg, ##args); \ 627212420Sken} while (0) 628212420Sken 629212420Sken#define mps_dprint_field(sc, level, msg, args...) \ 630212420Skendo { \ 631253460Sscottl if ((sc)->mps_debug & (level)) \ 632212420Sken printf("\t" msg, ##args); \ 633212420Sken} while (0) 634212420Sken 635212420Sken#define MPS_PRINTFIELD_START(sc, tag...) \ 636253460Sscottl mps_dprint((sc), MPS_XINFO, ##tag); \ 637253460Sscottl mps_dprint_field((sc), MPS_XINFO, ":\n") 638212420Sken#define MPS_PRINTFIELD_END(sc, tag) \ 639253460Sscottl mps_dprint((sc), MPS_XINFO, tag "\n") 640212420Sken#define MPS_PRINTFIELD(sc, facts, attr, fmt) \ 641253460Sscottl mps_dprint_field((sc), MPS_XINFO, #attr ": " #fmt "\n", (facts)->attr) 642212420Sken 643212420Sken#define MPS_EVENTFIELD_START(sc, tag...) \ 644212420Sken mps_dprint((sc), MPS_EVENT, ##tag); \ 645212420Sken mps_dprint_field((sc), MPS_EVENT, ":\n") 646212420Sken#define MPS_EVENTFIELD(sc, facts, attr, fmt) \ 647212420Sken mps_dprint_field((sc), MPS_EVENT, #attr ": " #fmt "\n", (facts)->attr) 648212420Sken 649253460Sscottl#define MPS_FUNCTRACE(sc) \ 650253460Sscottl mps_dprint((sc), MPS_TRACE, "%s\n", __func__) 651253460Sscottl 652237683Sken#define CAN_SLEEP 1 653237683Sken#define NO_SLEEP 0 654237683Sken 655212420Skenstatic __inline void 656212420Skenmps_from_u64(uint64_t data, U64 *mps) 657212420Sken{ 658238974Smav (mps)->High = htole32((uint32_t)((data) >> 32)); 659238974Smav (mps)->Low = htole32((uint32_t)((data) & 0xffffffff)); 660212420Sken} 661212420Sken 662212420Skenstatic __inline uint64_t 663212420Skenmps_to_u64(U64 *data) 664212420Sken{ 665212420Sken 666238974Smav return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low)); 667212420Sken} 668212420Sken 669212420Skenstatic __inline void 670212420Skenmps_mask_intr(struct mps_softc *sc) 671212420Sken{ 672212420Sken uint32_t mask; 673212420Sken 674212420Sken mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 675212420Sken mask |= MPI2_HIM_REPLY_INT_MASK; 676212420Sken mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 677212420Sken} 678212420Sken 679212420Skenstatic __inline void 680212420Skenmps_unmask_intr(struct mps_softc *sc) 681212420Sken{ 682212420Sken uint32_t mask; 683212420Sken 684212420Sken mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 685212420Sken mask &= ~MPI2_HIM_REPLY_INT_MASK; 686212420Sken mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 687212420Sken} 688212420Sken 689230592Skenint mps_pci_setup_interrupts(struct mps_softc *sc); 690230592Skenint mps_pci_restore(struct mps_softc *sc); 691230592Sken 692212420Skenint mps_attach(struct mps_softc *sc); 693212420Skenint mps_free(struct mps_softc *sc); 694212420Skenvoid mps_intr(void *); 695212420Skenvoid mps_intr_msi(void *); 696212420Skenvoid mps_intr_locked(void *); 697237683Skenint mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *, 698212420Sken void *, struct mps_event_handle **); 699230592Skenint mps_restart(struct mps_softc *); 700237683Skenint mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *); 701237683Skenvoid mps_deregister_events(struct mps_softc *, struct mps_event_handle *); 702213839Smdfint mps_push_sge(struct mps_command *, void *, size_t, int); 703213839Smdfint mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int); 704212420Skenint mps_attach_sas(struct mps_softc *sc); 705212420Skenint mps_detach_sas(struct mps_softc *sc); 706212420Skenint mps_read_config_page(struct mps_softc *, struct mps_config_params *); 707212420Skenint mps_write_config_page(struct mps_softc *, struct mps_config_params *); 708212420Skenvoid mps_memaddr_cb(void *, bus_dma_segment_t *, int , int ); 709216088Skenvoid mpi_init_sge(struct mps_command *cm, void *req, void *sge); 710212420Skenint mps_attach_user(struct mps_softc *); 711212420Skenvoid mps_detach_user(struct mps_softc *); 712230592Skenvoid mpssas_record_event(struct mps_softc *sc, 713230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event_reply); 714212420Sken 715230592Skenint mps_map_command(struct mps_softc *sc, struct mps_command *cm); 716253550Skenint mps_wait_command(struct mps_softc *sc, struct mps_command *cm, int timeout, 717253550Sken int sleep_flag); 718230592Skenint mps_request_polled(struct mps_softc *sc, struct mps_command *cm); 719230592Sken 720230592Skenint mps_config_get_bios_pg3(struct mps_softc *sc, Mpi2ConfigReply_t 721230592Sken *mpi_reply, Mpi2BiosPage3_t *config_page); 722230592Skenint mps_config_get_raid_volume_pg0(struct mps_softc *sc, Mpi2ConfigReply_t 723230592Sken *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address); 724230592Skenint mps_config_get_ioc_pg8(struct mps_softc *sc, Mpi2ConfigReply_t *, 725230592Sken Mpi2IOCPage8_t *); 726230592Skenint mps_config_get_man_pg10(struct mps_softc *sc, Mpi2ConfigReply_t *mpi_reply); 727230592Skenint mps_config_get_sas_device_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 728230592Sken Mpi2SasDevicePage0_t *, u32 , u16 ); 729230592Skenint mps_config_get_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 730230592Sken Mpi2DriverMappingPage0_t *, u16 ); 731230592Skenint mps_config_get_raid_volume_pg1(struct mps_softc *sc, 732230592Sken Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, 733230592Sken u16 handle); 734230592Skenint mps_config_get_volume_wwid(struct mps_softc *sc, u16 volume_handle, 735230592Sken u64 *wwid); 736230592Skenint mps_config_get_raid_pd_pg0(struct mps_softc *sc, 737230592Sken Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, 738230592Sken u32 page_address); 739230592Skenvoid mpssas_ir_shutdown(struct mps_softc *sc); 740230592Sken 741230592Skenint mps_reinit(struct mps_softc *sc); 742230592Skenvoid mpssas_handle_reinit(struct mps_softc *sc); 743230592Sken 744230592Skenvoid mps_base_static_config_pages(struct mps_softc *sc); 745230592Skenvoid mps_wd_config_pages(struct mps_softc *sc); 746230592Sken 747230592Skenint mps_mapping_initialize(struct mps_softc *); 748230592Skenvoid mps_mapping_topology_change_event(struct mps_softc *, 749230592Sken Mpi2EventDataSasTopologyChangeList_t *); 750230592Skenint mps_mapping_is_reinit_required(struct mps_softc *); 751230592Skenvoid mps_mapping_free_memory(struct mps_softc *sc); 752230592Skenint mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 753230592Sken Mpi2DriverMappingPage0_t *, u16 ); 754230592Skenvoid mps_mapping_exit(struct mps_softc *); 755230592Skenvoid mps_mapping_check_devices(struct mps_softc *, int); 756230592Skenint mps_mapping_allocate_memory(struct mps_softc *sc); 757230592Skenunsigned int mps_mapping_get_sas_id(struct mps_softc *, uint64_t , u16); 758230592Skenunsigned int mps_mapping_get_sas_id_from_handle(struct mps_softc *sc, 759230592Sken u16 handle); 760230592Skenunsigned int mps_mapping_get_raid_id(struct mps_softc *sc, u64 wwid, 761230592Sken u16 handle); 762230592Skenunsigned int mps_mapping_get_raid_id_from_handle(struct mps_softc *sc, 763230592Sken u16 volHandle); 764230592Skenvoid mps_mapping_enclosure_dev_status_change_event(struct mps_softc *, 765230592Sken Mpi2EventDataSasEnclDevStatusChange_t *event_data); 766230592Skenvoid mps_mapping_ir_config_change_event(struct mps_softc *sc, 767230592Sken Mpi2EventDataIrConfigChangeList_t *event_data); 768230592Sken 769230592Skenvoid mpssas_evt_handler(struct mps_softc *sc, uintptr_t data, 770230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event); 771230592Skenvoid mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle); 772231240Skenvoid mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle); 773230592Skenint mpssas_startup(struct mps_softc *sc); 774231240Skenstruct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t); 775268197Sscottlvoid mpssas_realloc_targets(struct mps_softc *sc, int maxtargets); 776268197Sscottlstruct mps_command * mpssas_alloc_tm(struct mps_softc *sc); 777268197Sscottlvoid mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm); 778270250Sslmvoid mpssas_release_simq_reinit(struct mpssas_softc *sassc); 779281564Sslmint mpssas_send_reset(struct mps_softc *sc, struct mps_command *tm, 780281564Sslm uint8_t type); 781230592Sken 782212420SkenSYSCTL_DECL(_hw_mps); 783212420Sken 784230592Sken/* Compatibility shims for different OS versions */ 785230592Sken#if __FreeBSD_version >= 800001 786230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 787230592Sken kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 788230592Sken#define mps_kproc_exit(arg) kproc_exit(arg) 789230592Sken#else 790230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 791230592Sken kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 792230592Sken#define mps_kproc_exit(arg) kthread_exit(arg) 793212420Sken#endif 794212420Sken 795230592Sken#if defined(CAM_PRIORITY_XPT) 796230592Sken#define MPS_PRIORITY_XPT CAM_PRIORITY_XPT 797230592Sken#else 798230592Sken#define MPS_PRIORITY_XPT 5 799230592Sken#endif 800237683Sken 801237683Sken#if __FreeBSD_version < 800107 802237683Sken// Prior to FreeBSD-8.0 scp3_flags was not defined. 803237683Sken#define spc3_flags reserved 804237683Sken 805237683Sken#define SPC3_SID_PROTECT 0x01 806237683Sken#define SPC3_SID_3PC 0x08 807237683Sken#define SPC3_SID_TPGS_MASK 0x30 808237683Sken#define SPC3_SID_TPGS_IMPLICIT 0x10 809237683Sken#define SPC3_SID_TPGS_EXPLICIT 0x20 810237683Sken#define SPC3_SID_ACC 0x40 811237683Sken#define SPC3_SID_SCCS 0x80 812237683Sken 813237683Sken#define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE 814230592Sken#endif 815230592Sken 816237683Sken#endif 817237683Sken 818