1 /*- 2 * Copyright (c) 2009 Yahoo! Inc. 3 * Copyright (c) 2011-2015 LSI Corp. 4 * Copyright (c) 2013-2015 Avago Technologies 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef _MPSVAR_H 34 #define _MPSVAR_H 35 36 #define MPS_DRIVER_VERSION "21.02.00.00-fbsd" 37 38 #define MPS_DB_MAX_WAIT 2500 39 40 #define MPS_REQ_FRAMES 1024 41 #define MPS_EVT_REPLY_FRAMES 32 42 #define MPS_REPLY_FRAMES MPS_REQ_FRAMES 43 #define MPS_CHAIN_FRAMES 2048 44 #define MPS_MAXIO_PAGES (-1) 45 #define MPS_SENSE_LEN SSD_FULL_SIZE 46 #define MPS_MSI_COUNT 1 47 #define MPS_SGE64_SIZE 12 48 #define MPS_SGE32_SIZE 8 49 #define MPS_SGC_SIZE 8 50 51 #define CAN_SLEEP 1 52 #define NO_SLEEP 0 53 54 #define MPS_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 55 #define MPS_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */ 56 #define MPS_MISSING_CHECK_DELAY 10 /* 10 seconds between missing check */ 57 58 #define MPS_SCSI_RI_INVALID_FRAME (0x00000002) 59 #define MPS_STRING_LENGTH 64 60 61 #define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */ 62 63 #include <sys/endian.h> 64 65 /* 66 * host mapping related macro definitions 67 */ 68 #define MPS_MAPTABLE_BAD_IDX 0xFFFFFFFF 69 #define MPS_DPM_BAD_IDX 0xFFFF 70 #define MPS_ENCTABLE_BAD_IDX 0xFF 71 #define MPS_MAX_MISSING_COUNT 0x0F 72 #define MPS_DEV_RESERVED 0x20000000 73 #define MPS_MAP_IN_USE 0x10000000 74 #define MPS_MAP_BAD_ID 0xFFFFFFFF 75 76 /* 77 * WarpDrive controller 78 */ 79 #define MPS_CHIP_WD_DEVICE_ID 0x007E 80 #define MPS_WD_LSI_OEM 0x80 81 #define MPS_WD_HIDE_EXPOSE_MASK 0x03 82 #define MPS_WD_HIDE_ALWAYS 0x00 83 #define MPS_WD_EXPOSE_ALWAYS 0x01 84 #define MPS_WD_HIDE_IF_VOLUME 0x02 85 #define MPS_WD_RETRY 0x01 86 #define MPS_MAN_PAGE10_SIZE 0x5C /* Hardcode for now */ 87 #define MPS_MAX_DISKS_IN_VOL 10 88 89 /* 90 * WarpDrive Event Logging 91 */ 92 #define MPI2_WD_LOG_ENTRY 0x8002 93 #define MPI2_WD_SSD_THROTTLING 0x0041 94 #define MPI2_WD_DRIVE_LIFE_WARN 0x0043 95 #define MPI2_WD_DRIVE_LIFE_DEAD 0x0044 96 #define MPI2_WD_RAIL_MON_FAIL 0x004D 97 98 typedef uint8_t u8; 99 typedef uint16_t u16; 100 typedef uint32_t u32; 101 typedef uint64_t u64; 102 103 /** 104 * struct dev_mapping_table - device mapping information 105 * @physical_id: SAS address for drives or WWID for RAID volumes 106 * @device_info: bitfield provides detailed info about the device 107 * @phy_bits: bitfields indicating controller phys 108 * @dpm_entry_num: index of this device in device persistent map table 109 * @dev_handle: device handle for the device pointed by this entry 110 * @id: target id 111 * @missing_count: number of times the device not detected by driver 112 * @hide_flag: Hide this physical disk/not (foreign configuration) 113 * @init_complete: Whether the start of the day checks completed or not 114 */ 115 struct dev_mapping_table { 116 u64 physical_id; 117 u32 device_info; 118 u32 phy_bits; 119 u16 dpm_entry_num; 120 u16 dev_handle; 121 u16 reserved1; 122 u16 id; 123 u8 missing_count; 124 u8 init_complete; 125 u8 TLR_bits; 126 u8 reserved2; 127 }; 128 129 /** 130 * struct enc_mapping_table - mapping information about an enclosure 131 * @enclosure_id: Logical ID of this enclosure 132 * @start_index: index to the entry in dev_mapping_table 133 * @phy_bits: bitfields indicating controller phys 134 * @dpm_entry_num: index of this enclosure in device persistent map table 135 * @enc_handle: device handle for the enclosure pointed by this entry 136 * @num_slots: number of slots in the enclosure 137 * @start_slot: Starting slot id 138 * @missing_count: number of times the device not detected by driver 139 * @removal_flag: used to mark the device for removal 140 * @skip_search: used as a flag to include/exclude enclosure for search 141 * @init_complete: Whether the start of the day checks completed or not 142 */ 143 struct enc_mapping_table { 144 u64 enclosure_id; 145 u32 start_index; 146 u32 phy_bits; 147 u16 dpm_entry_num; 148 u16 enc_handle; 149 u16 num_slots; 150 u16 start_slot; 151 u8 missing_count; 152 u8 removal_flag; 153 u8 skip_search; 154 u8 init_complete; 155 }; 156 157 /** 158 * struct map_removal_table - entries to be removed from mapping table 159 * @dpm_entry_num: index of this device in device persistent map table 160 * @dev_handle: device handle for the device pointed by this entry 161 */ 162 struct map_removal_table{ 163 u16 dpm_entry_num; 164 u16 dev_handle; 165 }; 166 167 typedef struct mps_fw_diagnostic_buffer { 168 size_t size; 169 uint8_t extended_type; 170 uint8_t buffer_type; 171 uint8_t force_release; 172 uint32_t product_specific[23]; 173 uint8_t immediate; 174 uint8_t enabled; 175 uint8_t valid_data; 176 uint8_t owned_by_firmware; 177 uint32_t unique_id; 178 } mps_fw_diagnostic_buffer_t; 179 180 struct mps_softc; 181 struct mps_command; 182 struct mpssas_softc; 183 union ccb; 184 struct mpssas_target; 185 struct mps_column_map; 186 187 MALLOC_DECLARE(M_MPT2); 188 189 typedef void mps_evt_callback_t(struct mps_softc *, uintptr_t, 190 MPI2_EVENT_NOTIFICATION_REPLY *reply); 191 typedef void mps_command_callback_t(struct mps_softc *, struct mps_command *cm); 192 193 struct mps_chain { 194 TAILQ_ENTRY(mps_chain) chain_link; 195 MPI2_SGE_IO_UNION *chain; 196 uint32_t chain_busaddr; 197 }; 198 199 /* 200 * This needs to be at least 2 to support SMP passthrough. 201 */ 202 #define MPS_IOVEC_COUNT 2 203 204 struct mps_command { 205 TAILQ_ENTRY(mps_command) cm_link; 206 TAILQ_ENTRY(mps_command) cm_recovery; 207 struct mps_softc *cm_sc; 208 union ccb *cm_ccb; 209 void *cm_data; 210 u_int cm_length; 211 u_int cm_out_len; 212 struct uio cm_uio; 213 struct iovec cm_iovec[MPS_IOVEC_COUNT]; 214 u_int cm_max_segs; 215 u_int cm_sglsize; 216 MPI2_SGE_IO_UNION *cm_sge; 217 uint8_t *cm_req; 218 uint8_t *cm_reply; 219 uint32_t cm_reply_data; 220 mps_command_callback_t *cm_complete; 221 void *cm_complete_data; 222 struct mpssas_target *cm_targ; 223 MPI2_REQUEST_DESCRIPTOR_UNION cm_desc; 224 u_int cm_lun; 225 u_int cm_flags; 226 #define MPS_CM_FLAGS_POLLED (1 << 0) 227 #define MPS_CM_FLAGS_COMPLETE (1 << 1) 228 #define MPS_CM_FLAGS_SGE_SIMPLE (1 << 2) 229 #define MPS_CM_FLAGS_DATAOUT (1 << 3) 230 #define MPS_CM_FLAGS_DATAIN (1 << 4) 231 #define MPS_CM_FLAGS_WAKEUP (1 << 5) 232 #define MPS_CM_FLAGS_DD_IO (1 << 6) 233 #define MPS_CM_FLAGS_USE_UIO (1 << 7) 234 #define MPS_CM_FLAGS_SMP_PASS (1 << 8) 235 #define MPS_CM_FLAGS_CHAIN_FAILED (1 << 9) 236 #define MPS_CM_FLAGS_ERROR_MASK MPS_CM_FLAGS_CHAIN_FAILED 237 #define MPS_CM_FLAGS_USE_CCB (1 << 10) 238 #define MPS_CM_FLAGS_SATA_ID_TIMEOUT (1 << 11) 239 u_int cm_state; 240 #define MPS_CM_STATE_FREE 0 241 #define MPS_CM_STATE_BUSY 1 242 #define MPS_CM_STATE_TIMEDOUT 2 243 bus_dmamap_t cm_dmamap; 244 struct scsi_sense_data *cm_sense; 245 TAILQ_HEAD(, mps_chain) cm_chain_list; 246 uint32_t cm_req_busaddr; 247 uint32_t cm_sense_busaddr; 248 struct callout cm_callout; 249 }; 250 251 struct mps_column_map { 252 uint16_t dev_handle; 253 uint8_t phys_disk_num; 254 }; 255 256 struct mps_event_handle { 257 TAILQ_ENTRY(mps_event_handle) eh_list; 258 mps_evt_callback_t *callback; 259 void *data; 260 u32 mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 261 }; 262 263 struct mps_softc { 264 device_t mps_dev; 265 struct cdev *mps_cdev; 266 u_int mps_flags; 267 #define MPS_FLAGS_INTX (1 << 0) 268 #define MPS_FLAGS_MSI (1 << 1) 269 #define MPS_FLAGS_BUSY (1 << 2) 270 #define MPS_FLAGS_SHUTDOWN (1 << 3) 271 #define MPS_FLAGS_DIAGRESET (1 << 4) 272 #define MPS_FLAGS_ATTACH_DONE (1 << 5) 273 #define MPS_FLAGS_WD_AVAILABLE (1 << 6) 274 u_int mps_debug; 275 u_int disable_msix; 276 u_int disable_msi; 277 int tm_cmds_active; 278 int io_cmds_active; 279 int io_cmds_highwater; 280 int chain_free; 281 int max_chains; 282 int max_io_pages; 283 int chain_free_lowwater; 284 u_int enable_ssu; 285 int spinup_wait_time; 286 int use_phynum; 287 uint64_t chain_alloc_fail; 288 struct sysctl_ctx_list sysctl_ctx; 289 struct sysctl_oid *sysctl_tree; 290 char fw_version[16]; 291 struct mps_command *commands; 292 struct mps_chain *chains; 293 struct callout periodic; 294 struct callout device_check_callout; 295 296 struct mpssas_softc *sassc; 297 char tmp_string[MPS_STRING_LENGTH]; 298 TAILQ_HEAD(, mps_command) req_list; 299 TAILQ_HEAD(, mps_command) high_priority_req_list; 300 TAILQ_HEAD(, mps_chain) chain_list; 301 TAILQ_HEAD(, mps_command) tm_list; 302 int replypostindex; 303 int replyfreeindex; 304 305 struct resource *mps_regs_resource; 306 bus_space_handle_t mps_bhandle; 307 bus_space_tag_t mps_btag; 308 int mps_regs_rid; 309 310 bus_dma_tag_t mps_parent_dmat; 311 bus_dma_tag_t buffer_dmat; 312 313 MPI2_IOC_FACTS_REPLY *facts; 314 int num_reqs; 315 int num_replies; 316 int fqdepth; /* Free queue */ 317 int pqdepth; /* Post queue */ 318 319 u32 event_mask[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 320 TAILQ_HEAD(, mps_event_handle) event_list; 321 struct mps_event_handle *mps_log_eh; 322 323 struct mtx mps_mtx; 324 struct intr_config_hook mps_ich; 325 struct resource *mps_irq[MPS_MSI_COUNT]; 326 void *mps_intrhand[MPS_MSI_COUNT]; 327 int mps_irq_rid[MPS_MSI_COUNT]; 328 329 uint8_t *req_frames; 330 bus_addr_t req_busaddr; 331 bus_dma_tag_t req_dmat; 332 bus_dmamap_t req_map; 333 334 uint8_t *reply_frames; 335 bus_addr_t reply_busaddr; 336 bus_dma_tag_t reply_dmat; 337 bus_dmamap_t reply_map; 338 339 struct scsi_sense_data *sense_frames; 340 bus_addr_t sense_busaddr; 341 bus_dma_tag_t sense_dmat; 342 bus_dmamap_t sense_map; 343 344 uint8_t *chain_frames; 345 bus_addr_t chain_busaddr; 346 bus_dma_tag_t chain_dmat; 347 bus_dmamap_t chain_map; 348 349 MPI2_REPLY_DESCRIPTORS_UNION *post_queue; 350 bus_addr_t post_busaddr; 351 uint32_t *free_queue; 352 bus_addr_t free_busaddr; 353 bus_dma_tag_t queues_dmat; 354 bus_dmamap_t queues_map; 355 356 uint8_t *fw_diag_buffer; 357 bus_addr_t fw_diag_busaddr; 358 bus_dma_tag_t fw_diag_dmat; 359 bus_dmamap_t fw_diag_map; 360 361 uint8_t ir_firmware; 362 363 /* static config pages */ 364 Mpi2IOCPage8_t ioc_pg8; 365 366 /* host mapping support */ 367 struct dev_mapping_table *mapping_table; 368 struct enc_mapping_table *enclosure_table; 369 struct map_removal_table *removal_table; 370 uint8_t *dpm_entry_used; 371 uint8_t *dpm_flush_entry; 372 Mpi2DriverMappingPage0_t *dpm_pg0; 373 uint16_t max_devices; 374 uint16_t max_enclosures; 375 uint16_t max_expanders; 376 uint8_t max_volumes; 377 uint8_t num_enc_table_entries; 378 uint8_t num_rsvd_entries; 379 uint16_t max_dpm_entries; 380 uint8_t is_dpm_enable; 381 uint8_t track_mapping_events; 382 uint32_t pending_map_events; 383 384 /* FW diag Buffer List */ 385 mps_fw_diagnostic_buffer_t 386 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT]; 387 388 /* Event Recording IOCTL support */ 389 uint32_t events_to_record[4]; 390 mps_event_entry_t recorded_events[MPS_EVENT_QUEUE_SIZE]; 391 uint8_t event_index; 392 uint32_t event_number; 393 394 /* EEDP and TLR support */ 395 uint8_t eedp_enabled; 396 uint8_t control_TLR; 397 398 /* Shutdown Event Handler */ 399 eventhandler_tag shutdown_eh; 400 401 /* To track topo events during reset */ 402 #define MPS_DIAG_RESET_TIMEOUT 300000 403 uint8_t wait_for_port_enable; 404 uint8_t port_enable_complete; 405 uint8_t msleep_fake_chan; 406 407 /* WD controller */ 408 uint8_t WD_available; 409 uint8_t WD_valid_config; 410 uint8_t WD_hide_expose; 411 412 /* Direct Drive for WarpDrive */ 413 uint8_t DD_num_phys_disks; 414 uint16_t DD_dev_handle; 415 uint32_t DD_stripe_size; 416 uint32_t DD_stripe_exponent; 417 uint32_t DD_block_size; 418 uint16_t DD_block_exponent; 419 uint64_t DD_max_lba; 420 struct mps_column_map DD_column_map[MPS_MAX_DISKS_IN_VOL]; 421 422 char exclude_ids[80]; 423 struct timeval lastfail; 424 425 /* StartStopUnit command handling at shutdown */ 426 uint32_t SSU_refcount; 427 uint8_t SSU_started; 428 }; 429 430 struct mps_config_params { 431 MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr; 432 u_int action; 433 u_int page_address; /* Attributes, not a phys address */ 434 u_int status; 435 void *buffer; 436 u_int length; 437 int timeout; 438 void (*callback)(struct mps_softc *, struct mps_config_params *); 439 void *cbdata; 440 }; 441 442 struct scsi_read_capacity_eedp 443 { 444 uint8_t addr[8]; 445 uint8_t length[4]; 446 uint8_t protect; 447 }; 448 449 static __inline uint32_t 450 mps_regread(struct mps_softc *sc, uint32_t offset) 451 { 452 return (bus_space_read_4(sc->mps_btag, sc->mps_bhandle, offset)); 453 } 454 455 static __inline void 456 mps_regwrite(struct mps_softc *sc, uint32_t offset, uint32_t val) 457 { 458 bus_space_write_4(sc->mps_btag, sc->mps_bhandle, offset, val); 459 } 460 461 /* free_queue must have Little Endian address 462 * TODO- cm_reply_data is unwanted. We can remove it. 463 * */ 464 static __inline void 465 mps_free_reply(struct mps_softc *sc, uint32_t busaddr) 466 { 467 if (++sc->replyfreeindex >= sc->fqdepth) 468 sc->replyfreeindex = 0; 469 sc->free_queue[sc->replyfreeindex] = htole32(busaddr); 470 mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex); 471 } 472 473 static __inline struct mps_chain * 474 mps_alloc_chain(struct mps_softc *sc) 475 { 476 struct mps_chain *chain; 477 478 if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) { 479 TAILQ_REMOVE(&sc->chain_list, chain, chain_link); 480 sc->chain_free--; 481 if (sc->chain_free < sc->chain_free_lowwater) 482 sc->chain_free_lowwater = sc->chain_free; 483 } else 484 sc->chain_alloc_fail++; 485 return (chain); 486 } 487 488 static __inline void 489 mps_free_chain(struct mps_softc *sc, struct mps_chain *chain) 490 { 491 sc->chain_free++; 492 TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link); 493 } 494 495 static __inline void 496 mps_free_command(struct mps_softc *sc, struct mps_command *cm) 497 { 498 struct mps_chain *chain, *chain_temp; 499 500 if (cm->cm_reply != NULL) 501 mps_free_reply(sc, cm->cm_reply_data); 502 cm->cm_reply = NULL; 503 cm->cm_flags = 0; 504 cm->cm_complete = NULL; 505 cm->cm_complete_data = NULL; 506 cm->cm_ccb = NULL; 507 cm->cm_targ = NULL; 508 cm->cm_max_segs = 0; 509 cm->cm_lun = 0; 510 cm->cm_state = MPS_CM_STATE_FREE; 511 cm->cm_data = NULL; 512 cm->cm_length = 0; 513 cm->cm_out_len = 0; 514 cm->cm_sglsize = 0; 515 cm->cm_sge = NULL; 516 517 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 518 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 519 mps_free_chain(sc, chain); 520 } 521 TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link); 522 } 523 524 static __inline struct mps_command * 525 mps_alloc_command(struct mps_softc *sc) 526 { 527 struct mps_command *cm; 528 529 cm = TAILQ_FIRST(&sc->req_list); 530 if (cm == NULL) 531 return (NULL); 532 533 TAILQ_REMOVE(&sc->req_list, cm, cm_link); 534 KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 535 cm->cm_state = MPS_CM_STATE_BUSY; 536 return (cm); 537 } 538 539 static __inline void 540 mps_free_high_priority_command(struct mps_softc *sc, struct mps_command *cm) 541 { 542 struct mps_chain *chain, *chain_temp; 543 544 if (cm->cm_reply != NULL) 545 mps_free_reply(sc, cm->cm_reply_data); 546 cm->cm_reply = NULL; 547 cm->cm_flags = 0; 548 cm->cm_complete = NULL; 549 cm->cm_complete_data = NULL; 550 cm->cm_ccb = NULL; 551 cm->cm_targ = NULL; 552 cm->cm_lun = 0; 553 cm->cm_state = MPS_CM_STATE_FREE; 554 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 555 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 556 mps_free_chain(sc, chain); 557 } 558 TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link); 559 } 560 561 static __inline struct mps_command * 562 mps_alloc_high_priority_command(struct mps_softc *sc) 563 { 564 struct mps_command *cm; 565 566 cm = TAILQ_FIRST(&sc->high_priority_req_list); 567 if (cm == NULL) 568 return (NULL); 569 570 TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link); 571 KASSERT(cm->cm_state == MPS_CM_STATE_FREE, ("mps: Allocating busy command\n")); 572 cm->cm_state = MPS_CM_STATE_BUSY; 573 return (cm); 574 } 575 576 static __inline void 577 mps_lock(struct mps_softc *sc) 578 { 579 mtx_lock(&sc->mps_mtx); 580 } 581 582 static __inline void 583 mps_unlock(struct mps_softc *sc) 584 { 585 mtx_unlock(&sc->mps_mtx); 586 } 587 588 #define MPS_INFO (1 << 0) /* Basic info */ 589 #define MPS_FAULT (1 << 1) /* Hardware faults */ 590 #define MPS_EVENT (1 << 2) /* Event data from the controller */ 591 #define MPS_LOG (1 << 3) /* Log data from the controller */ 592 #define MPS_RECOVERY (1 << 4) /* Command error recovery tracing */ 593 #define MPS_ERROR (1 << 5) /* Parameter errors, programming bugs */ 594 #define MPS_INIT (1 << 6) /* Things related to system init */ 595 #define MPS_XINFO (1 << 7) /* More detailed/noisy info */ 596 #define MPS_USER (1 << 8) /* Trace user-generated commands */ 597 #define MPS_MAPPING (1 << 9) /* Trace device mappings */ 598 #define MPS_TRACE (1 << 10) /* Function-by-function trace */ 599 600 #define MPS_SSU_DISABLE_SSD_DISABLE_HDD 0 601 #define MPS_SSU_ENABLE_SSD_DISABLE_HDD 1 602 #define MPS_SSU_DISABLE_SSD_ENABLE_HDD 2 603 #define MPS_SSU_ENABLE_SSD_ENABLE_HDD 3 604 605 #define mps_printf(sc, args...) \ 606 device_printf((sc)->mps_dev, ##args) 607 608 #define mps_print_field(sc, msg, args...) \ 609 printf("\t" msg, ##args) 610 611 #define mps_vprintf(sc, args...) \ 612 do { \ 613 if (bootverbose) \ 614 mps_printf(sc, ##args); \ 615 } while (0) 616 617 #define mps_dprint(sc, level, msg, args...) \ 618 do { \ 619 if ((sc)->mps_debug & (level)) \ 620 device_printf((sc)->mps_dev, msg, ##args); \ 621 } while (0) 622 623 #define MPS_PRINTFIELD_START(sc, tag...) \ 624 mps_printf((sc), ##tag); \ 625 mps_print_field((sc), ":\n") 626 #define MPS_PRINTFIELD_END(sc, tag) \ 627 mps_printf((sc), tag "\n") 628 #define MPS_PRINTFIELD(sc, facts, attr, fmt) \ 629 mps_print_field((sc), #attr ": " #fmt "\n", (facts)->attr) 630 631 #define MPS_FUNCTRACE(sc) \ 632 mps_dprint((sc), MPS_TRACE, "%s\n", __func__) 633 634 #define CAN_SLEEP 1 635 #define NO_SLEEP 0 636 637 static __inline void 638 mps_from_u64(uint64_t data, U64 *mps) 639 { 640 (mps)->High = htole32((uint32_t)((data) >> 32)); 641 (mps)->Low = htole32((uint32_t)((data) & 0xffffffff)); 642 } 643 644 static __inline uint64_t 645 mps_to_u64(U64 *data) 646 { 647 648 return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low)); 649 } 650 651 static __inline void 652 mps_mask_intr(struct mps_softc *sc) 653 { 654 uint32_t mask; 655 656 mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 657 mask |= MPI2_HIM_REPLY_INT_MASK; 658 mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 659 } 660 661 static __inline void 662 mps_unmask_intr(struct mps_softc *sc) 663 { 664 uint32_t mask; 665 666 mask = mps_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 667 mask &= ~MPI2_HIM_REPLY_INT_MASK; 668 mps_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 669 } 670 671 int mps_pci_setup_interrupts(struct mps_softc *sc); 672 int mps_pci_restore(struct mps_softc *sc); 673 674 int mps_attach(struct mps_softc *sc); 675 int mps_free(struct mps_softc *sc); 676 void mps_intr(void *); 677 void mps_intr_msi(void *); 678 void mps_intr_locked(void *); 679 int mps_register_events(struct mps_softc *, u32 *, mps_evt_callback_t *, 680 void *, struct mps_event_handle **); 681 int mps_restart(struct mps_softc *); 682 int mps_update_events(struct mps_softc *, struct mps_event_handle *, u32 *); 683 void mps_deregister_events(struct mps_softc *, struct mps_event_handle *); 684 int mps_push_sge(struct mps_command *, void *, size_t, int); 685 int mps_add_dmaseg(struct mps_command *, vm_paddr_t, size_t, u_int, int); 686 int mps_attach_sas(struct mps_softc *sc); 687 int mps_detach_sas(struct mps_softc *sc); 688 int mps_read_config_page(struct mps_softc *, struct mps_config_params *); 689 int mps_write_config_page(struct mps_softc *, struct mps_config_params *); 690 void mps_memaddr_cb(void *, bus_dma_segment_t *, int , int ); 691 void mpi_init_sge(struct mps_command *cm, void *req, void *sge); 692 int mps_attach_user(struct mps_softc *); 693 void mps_detach_user(struct mps_softc *); 694 void mpssas_record_event(struct mps_softc *sc, 695 MPI2_EVENT_NOTIFICATION_REPLY *event_reply); 696 697 int mps_map_command(struct mps_softc *sc, struct mps_command *cm); 698 int mps_wait_command(struct mps_softc *sc, struct mps_command *cm, int timeout, 699 int sleep_flag); 700 701 int mps_config_get_bios_pg3(struct mps_softc *sc, Mpi2ConfigReply_t 702 *mpi_reply, Mpi2BiosPage3_t *config_page); 703 int mps_config_get_raid_volume_pg0(struct mps_softc *sc, Mpi2ConfigReply_t 704 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address); 705 int mps_config_get_ioc_pg8(struct mps_softc *sc, Mpi2ConfigReply_t *, 706 Mpi2IOCPage8_t *); 707 int mps_config_get_man_pg10(struct mps_softc *sc, Mpi2ConfigReply_t *mpi_reply); 708 int mps_config_get_sas_device_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 709 Mpi2SasDevicePage0_t *, u32 , u16 ); 710 int mps_config_get_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 711 Mpi2DriverMappingPage0_t *, u16 ); 712 int mps_config_get_raid_volume_pg1(struct mps_softc *sc, 713 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, 714 u16 handle); 715 int mps_config_get_volume_wwid(struct mps_softc *sc, u16 volume_handle, 716 u64 *wwid); 717 int mps_config_get_raid_pd_pg0(struct mps_softc *sc, 718 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, 719 u32 page_address); 720 void mpssas_ir_shutdown(struct mps_softc *sc); 721 722 int mps_reinit(struct mps_softc *sc); 723 void mpssas_handle_reinit(struct mps_softc *sc); 724 725 void mps_base_static_config_pages(struct mps_softc *sc); 726 void mps_wd_config_pages(struct mps_softc *sc); 727 728 int mps_mapping_initialize(struct mps_softc *); 729 void mps_mapping_topology_change_event(struct mps_softc *, 730 Mpi2EventDataSasTopologyChangeList_t *); 731 void mps_mapping_free_memory(struct mps_softc *sc); 732 int mps_config_set_dpm_pg0(struct mps_softc *, Mpi2ConfigReply_t *, 733 Mpi2DriverMappingPage0_t *, u16 ); 734 void mps_mapping_exit(struct mps_softc *); 735 void mps_mapping_check_devices(void *); 736 int mps_mapping_allocate_memory(struct mps_softc *sc); 737 unsigned int mps_mapping_get_tid(struct mps_softc *, uint64_t , u16); 738 unsigned int mps_mapping_get_tid_from_handle(struct mps_softc *sc, 739 u16 handle); 740 unsigned int mps_mapping_get_raid_tid(struct mps_softc *sc, u64 wwid, 741 u16 volHandle); 742 unsigned int mps_mapping_get_raid_tid_from_handle(struct mps_softc *sc, 743 u16 volHandle); 744 void mps_mapping_enclosure_dev_status_change_event(struct mps_softc *, 745 Mpi2EventDataSasEnclDevStatusChange_t *event_data); 746 void mps_mapping_ir_config_change_event(struct mps_softc *sc, 747 Mpi2EventDataIrConfigChangeList_t *event_data); 748 int mps_mapping_dump(SYSCTL_HANDLER_ARGS); 749 int mps_mapping_encl_dump(SYSCTL_HANDLER_ARGS); 750 751 void mpssas_evt_handler(struct mps_softc *sc, uintptr_t data, 752 MPI2_EVENT_NOTIFICATION_REPLY *event); 753 void mpssas_prepare_remove(struct mpssas_softc *sassc, uint16_t handle); 754 void mpssas_prepare_volume_remove(struct mpssas_softc *sassc, uint16_t handle); 755 int mpssas_startup(struct mps_softc *sc); 756 struct mpssas_target * mpssas_find_target_by_handle(struct mpssas_softc *, int, uint16_t); 757 void mpssas_realloc_targets(struct mps_softc *sc, int maxtargets); 758 struct mps_command * mpssas_alloc_tm(struct mps_softc *sc); 759 void mpssas_free_tm(struct mps_softc *sc, struct mps_command *tm); 760 void mpssas_release_simq_reinit(struct mpssas_softc *sassc); 761 int mpssas_send_reset(struct mps_softc *sc, struct mps_command *tm, 762 uint8_t type); 763 764 SYSCTL_DECL(_hw_mps); 765 766 /* Compatibility shims for different OS versions */ 767 #if __FreeBSD_version >= 800001 768 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 769 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 770 #define mps_kproc_exit(arg) kproc_exit(arg) 771 #else 772 #define mps_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 773 kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 774 #define mps_kproc_exit(arg) kthread_exit(arg) 775 #endif 776 777 #if defined(CAM_PRIORITY_XPT) 778 #define MPS_PRIORITY_XPT CAM_PRIORITY_XPT 779 #else 780 #define MPS_PRIORITY_XPT 5 781 #endif 782 783 #if __FreeBSD_version < 800107 784 // Prior to FreeBSD-8.0 scp3_flags was not defined. 785 #define spc3_flags reserved 786 787 #define SPC3_SID_PROTECT 0x01 788 #define SPC3_SID_3PC 0x08 789 #define SPC3_SID_TPGS_MASK 0x30 790 #define SPC3_SID_TPGS_IMPLICIT 0x10 791 #define SPC3_SID_TPGS_EXPLICIT 0x20 792 #define SPC3_SID_ACC 0x40 793 #define SPC3_SID_SCCS 0x80 794 795 #define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE 796 #endif 797 798 #endif 799 800