mpsvar.h revision 268197
1212420Sken/*- 2212420Sken * Copyright (c) 2009 Yahoo! Inc. 3237683Sken * Copyright (c) 2011, 2012 LSI Corp. 4212420Sken * All rights reserved. 5212420Sken * 6212420Sken * Redistribution and use in source and binary forms, with or without 7212420Sken * modification, are permitted provided that the following conditions 8212420Sken * are met: 9212420Sken * 1. Redistributions of source code must retain the above copyright 10212420Sken * notice, this list of conditions and the following disclaimer. 11212420Sken * 2. Redistributions in binary form must reproduce the above copyright 12212420Sken * notice, this list of conditions and the following disclaimer in the 13212420Sken * documentation and/or other materials provided with the distribution. 14212420Sken * 15212420Sken * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16212420Sken * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17212420Sken * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18212420Sken * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19212420Sken * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20212420Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21212420Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22212420Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23212420Sken * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24212420Sken * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25212420Sken * SUCH DAMAGE. 26230592Sken * 27230592Sken * LSI MPT-Fusion Host Adapter FreeBSD 28230592Sken * 29230592Sken * $FreeBSD: stable/10/sys/dev/mps/mpsvar.h 268197 2014-07-02 23:32:05Z scottl $ 30230592Sken */ 31212420Sken 32212420Sken#ifndef _MPSVAR_H 33212420Sken#define _MPSVAR_H 34212420Sken 35253550Sken#define MPS_DRIVER_VERSION "16.00.00.00-fbsd" 36230592Sken 37212420Sken#define MPS_DB_MAX_WAIT 2500 38212420Sken 39212420Sken#define MPS_REQ_FRAMES 1024 40212420Sken#define MPS_EVT_REPLY_FRAMES 32 41212420Sken#define MPS_REPLY_FRAMES MPS_REQ_FRAMES 42219036Sken#define MPS_CHAIN_FRAMES 2048 43212420Sken#define MPS_SENSE_LEN SSD_FULL_SIZE 44212420Sken#define MPS_MSI_COUNT 1 45212420Sken#define MPS_SGE64_SIZE 12 46212420Sken#define MPS_SGE32_SIZE 8 47212420Sken#define MPS_SGC_SIZE 8 48212420Sken 49230592Sken#define CAN_SLEEP 1 50230592Sken#define NO_SLEEP 0 51230592Sken 52212420Sken#define MPS_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 53212420Sken 54230592Sken#define MPS_SCSI_RI_INVALID_FRAME (0x00000002) 55231240Sken#define MPS_STRING_LENGTH 64 56230592Sken 57237683Sken#include <sys/endian.h> 58237683Sken 59230592Sken/* 60230592Sken * host mapping related macro definitions 61230592Sken */ 62230592Sken#define MPS_MAPTABLE_BAD_IDX 0xFFFFFFFF 63230592Sken#define MPS_DPM_BAD_IDX 0xFFFF 64230592Sken#define MPS_ENCTABLE_BAD_IDX 0xFF 65230592Sken#define MPS_MAX_MISSING_COUNT 0x0F 66230592Sken#define MPS_DEV_RESERVED 0x20000000 67230592Sken#define MPS_MAP_IN_USE 0x10000000 68230592Sken#define MPS_RAID_CHANNEL 1 69230592Sken#define MPS_MAP_BAD_ID 0xFFFFFFFF 70230592Sken 71230592Sken/* 72230592Sken * WarpDrive controller 73230592Sken */ 74230592Sken#define MPS_CHIP_WD_DEVICE_ID 0x007E 75230592Sken#define MPS_WD_LSI_OEM 0x80 76230592Sken#define MPS_WD_HIDE_EXPOSE_MASK 0x03 77230592Sken#define MPS_WD_HIDE_ALWAYS 0x00 78230592Sken#define MPS_WD_EXPOSE_ALWAYS 0x01 79230592Sken#define MPS_WD_HIDE_IF_VOLUME 0x02 80230592Sken#define MPS_WD_RETRY 0x01 81230592Sken#define MPS_MAN_PAGE10_SIZE 0x5C /* Hardcode for now */ 82230592Sken#define MPS_MAX_DISKS_IN_VOL 10 83230592Sken 84230592Sken/* 85230592Sken * WarpDrive Event Logging 86230592Sken */ 87230592Sken#define MPI2_WD_LOG_ENTRY 0x8002 88230592Sken#define MPI2_WD_SSD_THROTTLING 0x0041 89230592Sken#define MPI2_WD_DRIVE_LIFE_WARN 0x0043 90230592Sken#define MPI2_WD_DRIVE_LIFE_DEAD 0x0044 91230592Sken#define MPI2_WD_RAIL_MON_FAIL 0x004D 92230592Sken 93230592Skentypedef uint8_t u8; 94230592Skentypedef uint16_t u16; 95230592Skentypedef uint32_t u32; 96230592Skentypedef uint64_t u64; 97230592Sken 98230592Sken/** 99230592Sken * struct dev_mapping_table - device mapping information 100230592Sken * @physical_id: SAS address for drives or WWID for RAID volumes 101230592Sken * @device_info: bitfield provides detailed info about the device 102230592Sken * @phy_bits: bitfields indicating controller phys 103230592Sken * @dpm_entry_num: index of this device in device persistent map table 104230592Sken * @dev_handle: device handle for the device pointed by this entry 105230592Sken * @channel: target channel 106230592Sken * @id: target id 107230592Sken * @missing_count: number of times the device not detected by driver 108230592Sken * @hide_flag: Hide this physical disk/not (foreign configuration) 109230592Sken * @init_complete: Whether the start of the day checks completed or not 110230592Sken */ 111230592Skenstruct dev_mapping_table { 112230592Sken u64 physical_id; 113230592Sken u32 device_info; 114230592Sken u32 phy_bits; 115230592Sken u16 dpm_entry_num; 116230592Sken u16 dev_handle; 117230592Sken u8 reserved1; 118230592Sken u8 channel; 119230592Sken u16 id; 120230592Sken u8 missing_count; 121230592Sken u8 init_complete; 122230592Sken u8 TLR_bits; 123230592Sken u8 reserved2; 124230592Sken}; 125230592Sken 126230592Sken/** 127230592Sken * struct enc_mapping_table - mapping information about an enclosure 128230592Sken * @enclosure_id: Logical ID of this enclosure 129230592Sken * @start_index: index to the entry in dev_mapping_table 130230592Sken * @phy_bits: bitfields indicating controller phys 131230592Sken * @dpm_entry_num: index of this enclosure in device persistent map table 132230592Sken * @enc_handle: device handle for the enclosure pointed by this entry 133230592Sken * @num_slots: number of slots in the enclosure 134230592Sken * @start_slot: Starting slot id 135230592Sken * @missing_count: number of times the device not detected by driver 136230592Sken * @removal_flag: used to mark the device for removal 137230592Sken * @skip_search: used as a flag to include/exclude enclosure for search 138230592Sken * @init_complete: Whether the start of the day checks completed or not 139230592Sken */ 140230592Skenstruct enc_mapping_table { 141230592Sken u64 enclosure_id; 142230592Sken u32 start_index; 143230592Sken u32 phy_bits; 144230592Sken u16 dpm_entry_num; 145230592Sken u16 enc_handle; 146230592Sken u16 num_slots; 147230592Sken u16 start_slot; 148230592Sken u8 missing_count; 149230592Sken u8 removal_flag; 150230592Sken u8 skip_search; 151230592Sken u8 init_complete; 152230592Sken}; 153230592Sken 154230592Sken/** 155230592Sken * struct map_removal_table - entries to be removed from mapping table 156230592Sken * @dpm_entry_num: index of this device in device persistent map table 157230592Sken * @dev_handle: device handle for the device pointed by this entry 158230592Sken */ 159230592Skenstruct map_removal_table{ 160230592Sken u16 dpm_entry_num; 161230592Sken u16 dev_handle; 162230592Sken}; 163230592Sken 164230592Skentypedef struct mps_fw_diagnostic_buffer { 165230592Sken size_t size; 166230592Sken uint8_t extended_type; 167230592Sken uint8_t buffer_type; 168230592Sken uint8_t force_release; 169230592Sken uint32_t product_specific[23]; 170230592Sken uint8_t immediate; 171230592Sken uint8_t enabled; 172230592Sken uint8_t valid_data; 173230592Sken uint8_t owned_by_firmware; 174230592Sken uint32_t unique_id; 175230592Sken} mps_fw_diagnostic_buffer_t; 176230592Sken 177212420Skenstruct mps_softc; 178212420Skenstruct mps_command; 179212420Skenstruct mpssas_softc; 180230592Skenunion ccb; 181212420Skenstruct mpssas_target; 182230592Skenstruct mps_column_map; 183212420Sken 184212420SkenMALLOC_DECLARE(M_MPT2); 185212420Sken 186212420Skentypedef void mps_evt_callback_t(struct mps_softc *, uintptr_t, 187212420Sken MPI2_EVENT_NOTIFICATION_REPLY *reply); 188212420Skentypedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm); 189212420Sken 190212420Skenstruct mps_chain { 191212420Sken TAILQ_ENTRY(mps_chain) chain_link; 192212420Sken MPI2_SGE_IO_UNION *chain; 193212420Sken uint32_t chain_busaddr; 194212420Sken}; 195212420Sken 196216088Sken/* 197216088Sken * This needs to be at least 2 to support SMP passthrough. 198216088Sken */ 199230592Sken#define MPS_IOVEC_COUNT 2 200216088Sken 201212420Skenstruct mps_command { 202212420Sken TAILQ_ENTRY(mps_command) cm_link; 203230592Sken TAILQ_ENTRY(mps_command) cm_recovery; 204212420Sken struct mps_softc *cm_sc; 205230592Sken union ccb *cm_ccb; 206212420Sken void *cm_data; 207212420Sken u_int cm_length; 208230592Sken u_int cm_out_len; 209216088Sken struct uio cm_uio; 210216088Sken struct iovec cm_iovec[MPS_IOVEC_COUNT]; 211216088Sken u_int cm_max_segs; 212212420Sken u_int cm_sglsize; 213212420Sken MPI2_SGE_IO_UNION *cm_sge; 214212420Sken uint8_t *cm_req; 215212420Sken uint8_t *cm_reply; 216212420Sken uint32_t cm_reply_data; 217212420Sken mps_command_callback_t *cm_complete; 218212420Sken void *cm_complete_data; 219212420Sken struct mpssas_target *cm_targ; 220212420Sken MPI2_REQUEST_DESCRIPTOR_UNION cm_desc; 221230592Sken u_int cm_lun; 222212420Sken u_int cm_flags; 223212420Sken#define MPS_CM_FLAGS_POLLED (1 << 0) 224212420Sken#define MPS_CM_FLAGS_COMPLETE (1 << 1) 225212420Sken#define MPS_CM_FLAGS_SGE_SIMPLE (1 << 2) 226212420Sken#define MPS_CM_FLAGS_DATAOUT (1 << 3) 227212420Sken#define MPS_CM_FLAGS_DATAIN (1 << 4) 228212420Sken#define MPS_CM_FLAGS_WAKEUP (1 << 5) 229230592Sken#define MPS_CM_FLAGS_DD_IO (1 << 6) 230216088Sken#define MPS_CM_FLAGS_USE_UIO (1 << 7) 231216088Sken#define MPS_CM_FLAGS_SMP_PASS (1 << 8) 232218812Sken#define MPS_CM_FLAGS_CHAIN_FAILED (1 << 9) 233218812Sken#define MPS_CM_FLAGS_ERROR_MASK MPS_CM_FLAGS_CHAIN_FAILED 234246713Skib#define MPS_CM_FLAGS_USE_CCB (1 << 10) 235212420Sken u_int cm_state; 236212420Sken#define MPS_CM_STATE_FREE 0 237212420Sken#define MPS_CM_STATE_BUSY 1 238212420Sken#define MPS_CM_STATE_TIMEDOUT 2 239212420Sken bus_dmamap_t cm_dmamap; 240212420Sken struct scsi_sense_data *cm_sense; 241212420Sken TAILQ_HEAD(, mps_chain) cm_chain_list; 242212420Sken uint32_t cm_req_busaddr; 243212420Sken uint32_t cm_sense_busaddr; 244212420Sken struct callout cm_callout; 245212420Sken}; 246212420Sken 247230592Skenstruct mps_column_map { 248230592Sken uint16_t dev_handle; 249230592Sken uint8_t phys_disk_num; 250230592Sken}; 251230592Sken 252212420Skenstruct mps_event_handle { 253212420Sken TAILQ_ENTRY(mps_event_handle) eh_list; 254212420Sken mps_evt_callback_t *callback; 255212420Sken void *data; 256237683Sken u32 mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 257212420Sken}; 258212420Sken 259212420Skenstruct mps_softc { 260212420Sken device_t mps_dev; 261212420Sken struct cdev *mps_cdev; 262212420Sken u_int mps_flags; 263212420Sken#define MPS_FLAGS_INTX (1 << 0) 264212420Sken#define MPS_FLAGS_MSI (1 << 1) 265212420Sken#define MPS_FLAGS_BUSY (1 << 2) 266212420Sken#define MPS_FLAGS_SHUTDOWN (1 << 3) 267230592Sken#define MPS_FLAGS_DIAGRESET (1 << 4) 268230592Sken#define MPS_FLAGS_ATTACH_DONE (1 << 5) 269230592Sken#define MPS_FLAGS_WD_AVAILABLE (1 << 6) 270212420Sken u_int mps_debug; 271230592Sken u_int disable_msix; 272230592Sken u_int disable_msi; 273213535Sken int tm_cmds_active; 274218812Sken int io_cmds_active; 275218812Sken int io_cmds_highwater; 276218812Sken int chain_free; 277230592Sken int max_chains; 278218812Sken int chain_free_lowwater; 279230592Sken#if __FreeBSD_version >= 900030 280218812Sken uint64_t chain_alloc_fail; 281230592Sken#endif 282212420Sken struct sysctl_ctx_list sysctl_ctx; 283212420Sken struct sysctl_oid *sysctl_tree; 284230592Sken char fw_version[16]; 285212420Sken struct mps_command *commands; 286212420Sken struct mps_chain *chains; 287212420Sken struct callout periodic; 288212420Sken 289212420Sken struct mpssas_softc *sassc; 290231240Sken char tmp_string[MPS_STRING_LENGTH]; 291212420Sken TAILQ_HEAD(, mps_command) req_list; 292230592Sken TAILQ_HEAD(, mps_command) high_priority_req_list; 293212420Sken TAILQ_HEAD(, mps_chain) chain_list; 294213535Sken TAILQ_HEAD(, mps_command) tm_list; 295212420Sken int replypostindex; 296212420Sken int replyfreeindex; 297212420Sken 298212420Sken struct resource *mps_regs_resource; 299212420Sken bus_space_handle_t mps_bhandle; 300212420Sken bus_space_tag_t mps_btag; 301212420Sken int mps_regs_rid; 302212420Sken 303212420Sken bus_dma_tag_t mps_parent_dmat; 304212420Sken bus_dma_tag_t buffer_dmat; 305212420Sken 306212420Sken MPI2_IOC_FACTS_REPLY *facts; 307212420Sken int num_reqs; 308212420Sken int num_replies; 309212420Sken int fqdepth; /* Free queue */ 310212420Sken int pqdepth; /* Post queue */ 311212420Sken 312237683Sken u32 event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 313212420Sken TAILQ_HEAD(, mps_event_handle) event_list; 314212420Sken struct mps_event_handle *mps_log_eh; 315212420Sken 316212420Sken struct mtx mps_mtx; 317212420Sken struct intr_config_hook mps_ich; 318212420Sken struct resource *mps_irq[MPS_MSI_COUNT]; 319212420Sken void *mps_intrhand[MPS_MSI_COUNT]; 320212420Sken int mps_irq_rid[MPS_MSI_COUNT]; 321212420Sken 322212420Sken uint8_t *req_frames; 323212420Sken bus_addr_t req_busaddr; 324212420Sken bus_dma_tag_t req_dmat; 325212420Sken bus_dmamap_t req_map; 326212420Sken 327212420Sken uint8_t *reply_frames; 328212420Sken bus_addr_t reply_busaddr; 329212420Sken bus_dma_tag_t reply_dmat; 330212420Sken bus_dmamap_t reply_map; 331212420Sken 332212420Sken struct scsi_sense_data *sense_frames; 333212420Sken bus_addr_t sense_busaddr; 334212420Sken bus_dma_tag_t sense_dmat; 335212420Sken bus_dmamap_t sense_map; 336212420Sken 337212420Sken uint8_t *chain_frames; 338212420Sken bus_addr_t chain_busaddr; 339212420Sken bus_dma_tag_t chain_dmat; 340212420Sken bus_dmamap_t chain_map; 341212420Sken 342212420Sken MPI2_REPLY_DESCRIPTORS_UNION *post_queue; 343212420Sken bus_addr_t post_busaddr; 344212420Sken uint32_t *free_queue; 345212420Sken bus_addr_t free_busaddr; 346212420Sken bus_dma_tag_t queues_dmat; 347212420Sken bus_dmamap_t queues_map; 348230592Sken 349230592Sken uint8_t *fw_diag_buffer; 350230592Sken bus_addr_t fw_diag_busaddr; 351230592Sken bus_dma_tag_t fw_diag_dmat; 352230592Sken bus_dmamap_t fw_diag_map; 353230592Sken 354230592Sken uint8_t ir_firmware; 355230592Sken 356230592Sken /* static config pages */ 357230592Sken Mpi2IOCPage8_t ioc_pg8; 358230592Sken 359230592Sken /* host mapping support */ 360230592Sken struct dev_mapping_table *mapping_table; 361230592Sken struct enc_mapping_table *enclosure_table; 362230592Sken struct map_removal_table *removal_table; 363230592Sken uint8_t *dpm_entry_used; 364230592Sken uint8_t *dpm_flush_entry; 365230592Sken Mpi2DriverMappingPage0_t *dpm_pg0; 366230592Sken uint16_t max_devices; 367230592Sken uint16_t max_enclosures; 368230592Sken uint16_t max_expanders; 369230592Sken uint8_t max_volumes; 370230592Sken uint8_t num_enc_table_entries; 371230592Sken uint8_t num_rsvd_entries; 372230592Sken uint8_t num_channels; 373230592Sken uint16_t max_dpm_entries; 374230592Sken uint8_t is_dpm_enable; 375230592Sken uint8_t track_mapping_events; 376230592Sken uint32_t pending_map_events; 377230592Sken uint8_t mt_full_retry; 378230592Sken uint8_t mt_add_device_failed; 379230592Sken 380230592Sken /* FW diag Buffer List */ 381230592Sken mps_fw_diagnostic_buffer_t 382230592Sken fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT]; 383230592Sken 384230592Sken /* Event Recording IOCTL support */ 385230592Sken uint32_t events_to_record[4]; 386230592Sken mps_event_entry_t recorded_events[MPS_EVENT_QUEUE_SIZE]; 387230592Sken uint8_t event_index; 388230592Sken uint32_t event_number; 389230592Sken 390230592Sken /* EEDP and TLR support */ 391230592Sken uint8_t eedp_enabled; 392230592Sken uint8_t control_TLR; 393230592Sken 394230592Sken /* Shutdown Event Handler */ 395230592Sken eventhandler_tag shutdown_eh; 396230592Sken 397230592Sken /* To track topo events during reset */ 398230592Sken#define MPS_DIAG_RESET_TIMEOUT 300000 399230592Sken uint8_t wait_for_port_enable; 400230592Sken uint8_t port_enable_complete; 401237683Sken uint8_t msleep_fake_chan; 402230592Sken 403230592Sken /* WD controller */ 404237683Sken uint8_t WD_available; 405230592Sken uint8_t WD_valid_config; 406230592Sken uint8_t WD_hide_expose; 407230592Sken 408230592Sken /* Direct Drive for WarpDrive */ 409230592Sken uint8_t DD_num_phys_disks; 410230592Sken uint16_t DD_dev_handle; 411230592Sken uint32_t DD_stripe_size; 412230592Sken uint32_t DD_stripe_exponent; 413230592Sken uint32_t DD_block_size; 414230592Sken uint16_t DD_block_exponent; 415230592Sken uint64_t DD_max_lba; 416230592Sken struct mps_column_map DD_column_map[MPS_MAX_DISKS_IN_VOL]; 417254116Sscottl 418254116Sscottl char exclude_ids[80]; 419254117Sscottl struct timeval lastfail; 420212420Sken}; 421212420Sken 422212420Skenstruct mps_config_params { 423212420Sken MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr; 424212420Sken u_int action; 425212420Sken u_int page_address; /* Attributes, not a phys address */ 426212420Sken u_int status; 427212420Sken void *buffer; 428212420Sken u_int length; 429212420Sken int timeout; 430212420Sken void (*callback)(struct mps_softc *, struct mps_config_params *); 431212420Sken void *cbdata; 432212420Sken}; 433212420Sken 434230592Skenstruct scsi_read_capacity_eedp 435230592Sken{ 436230592Sken uint8_t addr[8]; 437230592Sken uint8_t length[4]; 438230592Sken uint8_t protect; 439230592Sken}; 440230592Sken 441212420Skenstatic __inline uint32_t 442212420Skenmps_regread(struct mps_softc *sc, uint32_t offset) 443212420Sken{ 444212420Sken return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset)); 445212420Sken} 446212420Sken 447212420Skenstatic __inline void 448212420Skenmps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val) 449212420Sken{ 450212420Sken bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val); 451212420Sken} 452212420Sken 453237683Sken/* free_queue must have Little Endian address 454237683Sken * TODO- cm_reply_data is unwanted. We can remove it. 455237683Sken * */ 456212420Skenstatic __inline void 457212420Skenmps_free_reply(struct mps_softc *sc, uint32_t busaddr) 458212420Sken{ 459212420Sken if (++sc->replyfreeindex >= sc->fqdepth) 460212420Sken sc->replyfreeindex = 0; 461237683Sken sc->free_queue[sc->replyfreeindex] = htole32(busaddr); 462212420Sken mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex); 463212420Sken} 464212420Sken 465212420Skenstatic __inline struct mps_chain * 466212420Skenmps_alloc_chain(struct mps_softc *sc) 467212420Sken{ 468212420Sken struct mps_chain *chain; 469212420Sken 470218812Sken if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) { 471212420Sken TAILQ_REMOVE(&sc->chain_list, chain, chain_link); 472218812Sken sc->chain_free--; 473218812Sken if (sc->chain_free < sc->chain_free_lowwater) 474218812Sken sc->chain_free_lowwater = sc->chain_free; 475230592Sken } 476230592Sken#if __FreeBSD_version >= 900030 477230592Sken else 478218812Sken sc->chain_alloc_fail++; 479230592Sken#endif 480212420Sken return (chain); 481212420Sken} 482212420Sken 483212420Skenstatic __inline void 484212420Skenmps_free_chain(struct mps_softc *sc, struct mps_chain *chain) 485212420Sken{ 486212420Sken#if 0 487212420Sken bzero(chain->chain, 128); 488212420Sken#endif 489218812Sken sc->chain_free++; 490212420Sken TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link); 491212420Sken} 492212420Sken 493212420Skenstatic __inline void 494212420Skenmps_free_command(struct mps_softc *sc, struct mps_command *cm) 495212420Sken{ 496212420Sken struct mps_chain *chain, *chain_temp; 497212420Sken 498230592Sken if (cm->cm_reply != NULL) 499212420Sken mps_free_reply(sc, cm->cm_reply_data); 500230592Sken cm->cm_reply = NULL; 501212420Sken cm->cm_flags = 0; 502212420Sken cm->cm_complete = NULL; 503212420Sken cm->cm_complete_data = NULL; 504230592Sken cm->cm_ccb = NULL; 505230592Sken cm->cm_targ = NULL; 506216088Sken cm->cm_max_segs = 0; 507230592Sken cm->cm_lun = 0; 508212420Sken cm->cm_state = MPS_CM_STATE_FREE; 509231240Sken cm->cm_data = NULL; 510231240Sken cm->cm_length = 0; 511231240Sken cm->cm_out_len = 0; 512231240Sken cm->cm_sglsize = 0; 513231240Sken cm->cm_sge = NULL; 514231240Sken 515212420Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 516212420Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 517212420Sken mps_free_chain(sc, chain); 518212420Sken } 519212420Sken TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link); 520212420Sken} 521212420Sken 522212420Skenstatic __inline struct mps_command * 523212420Skenmps_alloc_command(struct mps_softc *sc) 524212420Sken{ 525212420Sken struct mps_command *cm; 526212420Sken 527212420Sken cm = TAILQ_FIRST(&sc->req_list); 528212420Sken if (cm == NULL) 529212420Sken return (NULL); 530212420Sken 531212420Sken TAILQ_REMOVE(&sc->req_list, cm, cm_link); 532212420Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 533212420Sken cm->cm_state = MPS_CM_STATE_BUSY; 534212420Sken return (cm); 535212420Sken} 536212420Sken 537212420Skenstatic __inline void 538230592Skenmps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm) 539230592Sken{ 540230592Sken struct mps_chain *chain, *chain_temp; 541230592Sken 542230592Sken if (cm->cm_reply != NULL) 543230592Sken mps_free_reply(sc, cm->cm_reply_data); 544230592Sken cm->cm_reply = NULL; 545230592Sken cm->cm_flags = 0; 546230592Sken cm->cm_complete = NULL; 547230592Sken cm->cm_complete_data = NULL; 548230592Sken cm->cm_ccb = NULL; 549230592Sken cm->cm_targ = NULL; 550230592Sken cm->cm_lun = 0; 551230592Sken cm->cm_state = MPS_CM_STATE_FREE; 552230592Sken TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 553230592Sken TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 554230592Sken mps_free_chain(sc, chain); 555230592Sken } 556230592Sken TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link); 557230592Sken} 558230592Sken 559230592Skenstatic __inline struct mps_command * 560230592Skenmps_alloc_high_priority_command(struct mps_softc *sc) 561230592Sken{ 562230592Sken struct mps_command *cm; 563230592Sken 564230592Sken cm = TAILQ_FIRST(&sc->high_priority_req_list); 565230592Sken if (cm == NULL) 566230592Sken return (NULL); 567230592Sken 568230592Sken TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link); 569230592Sken KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 570230592Sken cm->cm_state = MPS_CM_STATE_BUSY; 571230592Sken return (cm); 572230592Sken} 573230592Sken 574230592Skenstatic __inline void 575212420Skenmps_lock(struct mps_softc *sc) 576212420Sken{ 577212420Sken mtx_lock(&sc->mps_mtx); 578212420Sken} 579212420Sken 580212420Skenstatic __inline void 581212420Skenmps_unlock(struct mps_softc *sc) 582212420Sken{ 583212420Sken mtx_unlock(&sc->mps_mtx); 584212420Sken} 585212420Sken 586253460Sscottl#define MPS_INFO (1 << 0) /* Basic info */ 587253460Sscottl#define MPS_FAULT (1 << 1) /* Hardware faults */ 588253460Sscottl#define MPS_EVENT (1 << 2) /* Event data from the controller */ 589253460Sscottl#define MPS_LOG (1 << 3) /* Log data from the controller */ 590253460Sscottl#define MPS_RECOVERY (1 << 4) /* Command error recovery tracing */ 591253460Sscottl#define MPS_ERROR (1 << 5) /* Parameter errors, programming bugs */ 592253460Sscottl#define MPS_INIT (1 << 6) /* Things related to system init */ 593253460Sscottl#define MPS_XINFO (1 << 7) /* More detailed/noisy info */ 594253460Sscottl#define MPS_USER (1 << 8) /* Trace user-generated commands */ 595253460Sscottl#define MPS_MAPPING (1 << 9) /* Trace device mappings */ 596253460Sscottl#define MPS_TRACE (1 << 10) /* Function-by-function trace */ 597212420Sken 598212420Sken#define mps_printf(sc, args...) \ 599212420Sken device_printf((sc)->mps_dev, ##args) 600212420Sken 601230592Sken#define mps_vprintf(sc, args...) \ 602230592Skendo { \ 603230592Sken if (bootverbose) \ 604230592Sken mps_printf(sc, ##args); \ 605230592Sken} while (0) 606230592Sken 607212420Sken#define mps_dprint(sc, level, msg, args...) \ 608212420Skendo { \ 609253460Sscottl if ((sc)->mps_debug & (level)) \ 610253460Sscottl device_printf((sc)->mps_dev, msg, ##args); \ 611212420Sken} while (0) 612212420Sken 613212420Sken#define mps_dprint_field(sc, level, msg, args...) \ 614212420Skendo { \ 615253460Sscottl if ((sc)->mps_debug & (level)) \ 616212420Sken printf("\t" msg, ##args); \ 617212420Sken} while (0) 618212420Sken 619212420Sken#define MPS_PRINTFIELD_START(sc, tag...) \ 620253460Sscottl mps_dprint((sc), MPS_XINFO, ##tag); \ 621253460Sscottl mps_dprint_field((sc), MPS_XINFO, ":\n") 622212420Sken#define MPS_PRINTFIELD_END(sc, tag) \ 623253460Sscottl mps_dprint((sc), MPS_XINFO, tag "\n") 624212420Sken#define MPS_PRINTFIELD(sc, facts, attr, fmt) \ 625253460Sscottl mps_dprint_field((sc), MPS_XINFO, #attr ": " #fmt "\n", (facts)->attr) 626212420Sken 627212420Sken#define MPS_EVENTFIELD_START(sc, tag...) \ 628212420Sken mps_dprint((sc), MPS_EVENT, ##tag); \ 629212420Sken mps_dprint_field((sc), MPS_EVENT, ":\n") 630212420Sken#define MPS_EVENTFIELD(sc, facts, attr, fmt) \ 631212420Sken mps_dprint_field((sc), MPS_EVENT, #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 676212420Skenint mps_attach(struct mps_softc *sc); 677212420Skenint mps_free(struct mps_softc *sc); 678212420Skenvoid mps_intr(void *); 679212420Skenvoid mps_intr_msi(void *); 680212420Skenvoid mps_intr_locked(void *); 681237683Skenint mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *, 682212420Sken void *, struct mps_event_handle **); 683230592Skenint mps_restart(struct mps_softc *); 684237683Skenint mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *); 685237683Skenvoid mps_deregister_events(struct mps_softc *, struct mps_event_handle *); 686213839Smdfint mps_push_sge(struct mps_command *, void *, size_t, int); 687213839Smdfint mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int); 688212420Skenint mps_attach_sas(struct mps_softc *sc); 689212420Skenint mps_detach_sas(struct mps_softc *sc); 690212420Skenint mps_read_config_page(struct mps_softc *, struct mps_config_params *); 691212420Skenint mps_write_config_page(struct mps_softc *, struct mps_config_params *); 692212420Skenvoid mps_memaddr_cb(void *, bus_dma_segment_t *, int , int ); 693216088Skenvoid mpi_init_sge(struct mps_command *cm, void *req, void *sge); 694212420Skenint mps_attach_user(struct mps_softc *); 695212420Skenvoid mps_detach_user(struct mps_softc *); 696230592Skenvoid mpssas_record_event(struct mps_softc *sc, 697230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event_reply); 698212420Sken 699230592Skenint mps_map_command(struct mps_softc *sc, struct mps_command *cm); 700253550Skenint mps_wait_command(struct mps_softc *sc, struct mps_command *cm, int timeout, 701253550Sken int sleep_flag); 702230592Skenint mps_request_polled(struct mps_softc *sc, struct mps_command *cm); 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 *); 734230592Skenint mps_mapping_is_reinit_required(struct mps_softc *); 735230592Skenvoid mps_mapping_free_memory(struct mps_softc *sc); 736230592Skenint mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 737230592Sken Mpi2DriverMappingPage0_t *, u16 ); 738230592Skenvoid mps_mapping_exit(struct mps_softc *); 739230592Skenvoid mps_mapping_check_devices(struct mps_softc *, int); 740230592Skenint mps_mapping_allocate_memory(struct mps_softc *sc); 741230592Skenunsigned int mps_mapping_get_sas_id(struct mps_softc *, uint64_t , u16); 742230592Skenunsigned int mps_mapping_get_sas_id_from_handle(struct mps_softc *sc, 743230592Sken u16 handle); 744230592Skenunsigned int mps_mapping_get_raid_id(struct mps_softc *sc, u64 wwid, 745230592Sken u16 handle); 746230592Skenunsigned int mps_mapping_get_raid_id_from_handle(struct mps_softc *sc, 747230592Sken u16 volHandle); 748230592Skenvoid mps_mapping_enclosure_dev_status_change_event(struct mps_softc *, 749230592Sken Mpi2EventDataSasEnclDevStatusChange_t *event_data); 750230592Skenvoid mps_mapping_ir_config_change_event(struct mps_softc *sc, 751230592Sken Mpi2EventDataIrConfigChangeList_t *event_data); 752230592Sken 753230592Skenvoid mpssas_evt_handler(struct mps_softc *sc, uintptr_t data, 754230592Sken MPI2_EVENT_NOTIFICATION_REPLY *event); 755230592Skenvoid mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle); 756231240Skenvoid mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle); 757230592Skenint mpssas_startup(struct mps_softc *sc); 758231240Skenstruct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t); 759268197Sscottlvoid mpssas_realloc_targets(struct mps_softc *sc, int maxtargets); 760268197Sscottlstruct mps_command * mpssas_alloc_tm(struct mps_softc *sc); 761268197Sscottlvoid mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm); 762230592Sken 763212420SkenSYSCTL_DECL(_hw_mps); 764212420Sken 765230592Sken/* Compatibility shims for different OS versions */ 766230592Sken#if __FreeBSD_version >= 800001 767230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 768230592Sken kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 769230592Sken#define mps_kproc_exit(arg) kproc_exit(arg) 770230592Sken#else 771230592Sken#define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 772230592Sken kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 773230592Sken#define mps_kproc_exit(arg) kthread_exit(arg) 774212420Sken#endif 775212420Sken 776230592Sken#if defined(CAM_PRIORITY_XPT) 777230592Sken#define MPS_PRIORITY_XPT CAM_PRIORITY_XPT 778230592Sken#else 779230592Sken#define MPS_PRIORITY_XPT 5 780230592Sken#endif 781237683Sken 782237683Sken#if __FreeBSD_version < 800107 783237683Sken// Prior to FreeBSD-8.0 scp3_flags was not defined. 784237683Sken#define spc3_flags reserved 785237683Sken 786237683Sken#define SPC3_SID_PROTECT 0x01 787237683Sken#define SPC3_SID_3PC 0x08 788237683Sken#define SPC3_SID_TPGS_MASK 0x30 789237683Sken#define SPC3_SID_TPGS_IMPLICIT 0x10 790237683Sken#define SPC3_SID_TPGS_EXPLICIT 0x20 791237683Sken#define SPC3_SID_ACC 0x40 792237683Sken#define SPC3_SID_SCCS 0x80 793237683Sken 794237683Sken#define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE 795230592Sken#endif 796230592Sken 797237683Sken#endif 798237683Sken 799