mprvar.h revision 303029
1/*- 2 * Copyright (c) 2009 Yahoo! Inc. 3 * Copyright (c) 2011-2015 LSI Corp. 4 * Copyright (c) 2013-2016 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: stable/11/sys/dev/mpr/mprvar.h 303029 2016-07-19 16:46:27Z slm $ 31 */ 32 33#ifndef _MPRVAR_H 34#define _MPRVAR_H 35 36#define MPR_DRIVER_VERSION "13.01.00.00-fbsd" 37 38#define MPR_DB_MAX_WAIT 2500 39 40#define MPR_REQ_FRAMES 1024 41#define MPR_EVT_REPLY_FRAMES 32 42#define MPR_REPLY_FRAMES MPR_REQ_FRAMES 43#define MPR_CHAIN_FRAMES 2048 44#define MPR_MAXIO_PAGES (-1) 45#define MPR_SENSE_LEN SSD_FULL_SIZE 46#define MPR_MSI_COUNT 1 47#define MPR_SGE64_SIZE 12 48#define MPR_SGE32_SIZE 8 49#define MPR_SGC_SIZE 8 50#define MPR_DEFAULT_CHAIN_SEG_SIZE 8 51#define MPR_MAX_CHAIN_ELEMENT_SIZE 16 52 53#define MPR_FUNCTRACE(sc) \ 54 mpr_dprint((sc), MPR_TRACE, "%s\n", __func__) 55 56#define CAN_SLEEP 1 57#define NO_SLEEP 0 58 59#define MPR_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */ 60#define MPR_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */ 61 62#define IFAULT_IOP_OVER_TEMP_THRESHOLD_EXCEEDED 0x2810 63 64#define MPR_SCSI_RI_INVALID_FRAME (0x00000002) 65#define MPR_STRING_LENGTH 64 66 67#define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */ 68 69#include <sys/endian.h> 70 71/* 72 * host mapping related macro definitions 73 */ 74#define MPR_MAPTABLE_BAD_IDX 0xFFFFFFFF 75#define MPR_DPM_BAD_IDX 0xFFFF 76#define MPR_ENCTABLE_BAD_IDX 0xFF 77#define MPR_MAX_MISSING_COUNT 0x0F 78#define MPR_DEV_RESERVED 0x20000000 79#define MPR_MAP_IN_USE 0x10000000 80#define MPR_RAID_CHANNEL 1 81#define MPR_MAP_BAD_ID 0xFFFFFFFF 82 83typedef uint8_t u8; 84typedef uint16_t u16; 85typedef uint32_t u32; 86typedef uint64_t u64; 87 88/** 89 * struct dev_mapping_table - device mapping information 90 * @physical_id: SAS address for drives or WWID for RAID volumes 91 * @device_info: bitfield provides detailed info about the device 92 * @phy_bits: bitfields indicating controller phys 93 * @dpm_entry_num: index of this device in device persistent map table 94 * @dev_handle: device handle for the device pointed by this entry 95 * @channel: target channel 96 * @id: target id 97 * @missing_count: number of times the device not detected by driver 98 * @hide_flag: Hide this physical disk/not (foreign configuration) 99 * @init_complete: Whether the start of the day checks completed or not 100 * @TLR_bits: Turn TLR support on or off 101 */ 102struct dev_mapping_table { 103 u64 physical_id; 104 u32 device_info; 105 u32 phy_bits; 106 u16 dpm_entry_num; 107 u16 dev_handle; 108 u8 reserved1; 109 u8 channel; 110 u16 id; 111 u8 missing_count; 112 u8 init_complete; 113 u8 TLR_bits; 114 u8 reserved2; 115}; 116 117/** 118 * struct enc_mapping_table - mapping information about an enclosure 119 * @enclosure_id: Logical ID of this enclosure 120 * @start_index: index to the entry in dev_mapping_table 121 * @phy_bits: bitfields indicating controller phys 122 * @dpm_entry_num: index of this enclosure in device persistent map table 123 * @enc_handle: device handle for the enclosure pointed by this entry 124 * @num_slots: number of slots in the enclosure 125 * @start_slot: Starting slot id 126 * @missing_count: number of times the device not detected by driver 127 * @removal_flag: used to mark the device for removal 128 * @skip_search: used as a flag to include/exclude enclosure for search 129 * @init_complete: Whether the start of the day checks completed or not 130 */ 131struct enc_mapping_table { 132 u64 enclosure_id; 133 u32 start_index; 134 u32 phy_bits; 135 u16 dpm_entry_num; 136 u16 enc_handle; 137 u16 num_slots; 138 u16 start_slot; 139 u8 missing_count; 140 u8 removal_flag; 141 u8 skip_search; 142 u8 init_complete; 143}; 144 145/** 146 * struct map_removal_table - entries to be removed from mapping table 147 * @dpm_entry_num: index of this device in device persistent map table 148 * @dev_handle: device handle for the device pointed by this entry 149 */ 150struct map_removal_table{ 151 u16 dpm_entry_num; 152 u16 dev_handle; 153}; 154 155typedef struct mpr_fw_diagnostic_buffer { 156 size_t size; 157 uint8_t extended_type; 158 uint8_t buffer_type; 159 uint8_t force_release; 160 uint32_t product_specific[23]; 161 uint8_t immediate; 162 uint8_t enabled; 163 uint8_t valid_data; 164 uint8_t owned_by_firmware; 165 uint32_t unique_id; 166} mpr_fw_diagnostic_buffer_t; 167 168struct mpr_softc; 169struct mpr_command; 170struct mprsas_softc; 171union ccb; 172struct mprsas_target; 173struct mpr_column_map; 174 175MALLOC_DECLARE(M_MPR); 176 177typedef void mpr_evt_callback_t(struct mpr_softc *, uintptr_t, 178 MPI2_EVENT_NOTIFICATION_REPLY *reply); 179typedef void mpr_command_callback_t(struct mpr_softc *, struct mpr_command *cm); 180 181struct mpr_chain { 182 TAILQ_ENTRY(mpr_chain) chain_link; 183 void *chain; 184 uint64_t chain_busaddr; 185}; 186 187/* 188 * This needs to be at least 2 to support SMP passthrough. 189 */ 190#define MPR_IOVEC_COUNT 2 191 192struct mpr_command { 193 TAILQ_ENTRY(mpr_command) cm_link; 194 TAILQ_ENTRY(mpr_command) cm_recovery; 195 struct mpr_softc *cm_sc; 196 union ccb *cm_ccb; 197 void *cm_data; 198 u_int cm_length; 199 u_int cm_out_len; 200 struct uio cm_uio; 201 struct iovec cm_iovec[MPR_IOVEC_COUNT]; 202 u_int cm_max_segs; 203 u_int cm_sglsize; 204 void *cm_sge; 205 uint8_t *cm_req; 206 uint8_t *cm_reply; 207 uint32_t cm_reply_data; 208 mpr_command_callback_t *cm_complete; 209 void *cm_complete_data; 210 struct mprsas_target *cm_targ; 211 MPI2_REQUEST_DESCRIPTOR_UNION cm_desc; 212 u_int cm_lun; 213 u_int cm_flags; 214#define MPR_CM_FLAGS_POLLED (1 << 0) 215#define MPR_CM_FLAGS_COMPLETE (1 << 1) 216#define MPR_CM_FLAGS_SGE_SIMPLE (1 << 2) 217#define MPR_CM_FLAGS_DATAOUT (1 << 3) 218#define MPR_CM_FLAGS_DATAIN (1 << 4) 219#define MPR_CM_FLAGS_WAKEUP (1 << 5) 220#define MPR_CM_FLAGS_USE_UIO (1 << 6) 221#define MPR_CM_FLAGS_SMP_PASS (1 << 7) 222#define MPR_CM_FLAGS_CHAIN_FAILED (1 << 8) 223#define MPR_CM_FLAGS_ERROR_MASK MPR_CM_FLAGS_CHAIN_FAILED 224#define MPR_CM_FLAGS_USE_CCB (1 << 9) 225#define MPR_CM_FLAGS_SATA_ID_TIMEOUT (1 << 10) 226 u_int cm_state; 227#define MPR_CM_STATE_FREE 0 228#define MPR_CM_STATE_BUSY 1 229#define MPR_CM_STATE_TIMEDOUT 2 230 bus_dmamap_t cm_dmamap; 231 struct scsi_sense_data *cm_sense; 232 TAILQ_HEAD(, mpr_chain) cm_chain_list; 233 uint32_t cm_req_busaddr; 234 uint32_t cm_sense_busaddr; 235 struct callout cm_callout; 236}; 237 238struct mpr_column_map { 239 uint16_t dev_handle; 240 uint8_t phys_disk_num; 241}; 242 243struct mpr_event_handle { 244 TAILQ_ENTRY(mpr_event_handle) eh_list; 245 mpr_evt_callback_t *callback; 246 void *data; 247 uint8_t mask[16]; 248}; 249 250struct mpr_softc { 251 device_t mpr_dev; 252 struct cdev *mpr_cdev; 253 u_int mpr_flags; 254#define MPR_FLAGS_INTX (1 << 0) 255#define MPR_FLAGS_MSI (1 << 1) 256#define MPR_FLAGS_BUSY (1 << 2) 257#define MPR_FLAGS_SHUTDOWN (1 << 3) 258#define MPR_FLAGS_DIAGRESET (1 << 4) 259#define MPR_FLAGS_ATTACH_DONE (1 << 5) 260 u_int mpr_debug; 261 u_int disable_msix; 262 u_int disable_msi; 263 int tm_cmds_active; 264 int io_cmds_active; 265 int io_cmds_highwater; 266 int chain_free; 267 int max_chains; 268 int max_io_pages; 269 int chain_free_lowwater; 270 uint32_t chain_frame_size; 271 uint16_t chain_seg_size; 272 u_int enable_ssu; 273 int spinup_wait_time; 274 uint64_t chain_alloc_fail; 275 struct sysctl_ctx_list sysctl_ctx; 276 struct sysctl_oid *sysctl_tree; 277 char fw_version[16]; 278 struct mpr_command *commands; 279 struct mpr_chain *chains; 280 struct callout periodic; 281 282 struct mprsas_softc *sassc; 283 char tmp_string[MPR_STRING_LENGTH]; 284 TAILQ_HEAD(, mpr_command) req_list; 285 TAILQ_HEAD(, mpr_command) high_priority_req_list; 286 TAILQ_HEAD(, mpr_chain) chain_list; 287 TAILQ_HEAD(, mpr_command) tm_list; 288 int replypostindex; 289 int replyfreeindex; 290 291 struct resource *mpr_regs_resource; 292 bus_space_handle_t mpr_bhandle; 293 bus_space_tag_t mpr_btag; 294 int mpr_regs_rid; 295 296 bus_dma_tag_t mpr_parent_dmat; 297 bus_dma_tag_t buffer_dmat; 298 299 MPI2_IOC_FACTS_REPLY *facts; 300 int num_reqs; 301 int num_replies; 302 int fqdepth; /* Free queue */ 303 int pqdepth; /* Post queue */ 304 305 uint8_t event_mask[16]; 306 TAILQ_HEAD(, mpr_event_handle) event_list; 307 struct mpr_event_handle *mpr_log_eh; 308 309 struct mtx mpr_mtx; 310 struct intr_config_hook mpr_ich; 311 struct resource *mpr_irq[MPR_MSI_COUNT]; 312 void *mpr_intrhand[MPR_MSI_COUNT]; 313 int mpr_irq_rid[MPR_MSI_COUNT]; 314 315 uint8_t *req_frames; 316 bus_addr_t req_busaddr; 317 bus_dma_tag_t req_dmat; 318 bus_dmamap_t req_map; 319 320 uint8_t *reply_frames; 321 bus_addr_t reply_busaddr; 322 bus_dma_tag_t reply_dmat; 323 bus_dmamap_t reply_map; 324 325 struct scsi_sense_data *sense_frames; 326 bus_addr_t sense_busaddr; 327 bus_dma_tag_t sense_dmat; 328 bus_dmamap_t sense_map; 329 330 uint8_t *chain_frames; 331 bus_addr_t chain_busaddr; 332 bus_dma_tag_t chain_dmat; 333 bus_dmamap_t chain_map; 334 335 MPI2_REPLY_DESCRIPTORS_UNION *post_queue; 336 bus_addr_t post_busaddr; 337 uint32_t *free_queue; 338 bus_addr_t free_busaddr; 339 bus_dma_tag_t queues_dmat; 340 bus_dmamap_t queues_map; 341 342 uint8_t *fw_diag_buffer; 343 bus_addr_t fw_diag_busaddr; 344 bus_dma_tag_t fw_diag_dmat; 345 bus_dmamap_t fw_diag_map; 346 347 uint8_t ir_firmware; 348 349 /* static config pages */ 350 Mpi2IOCPage8_t ioc_pg8; 351 Mpi2IOUnitPage8_t iounit_pg8; 352 353 /* host mapping support */ 354 struct dev_mapping_table *mapping_table; 355 struct enc_mapping_table *enclosure_table; 356 struct map_removal_table *removal_table; 357 uint8_t *dpm_entry_used; 358 uint8_t *dpm_flush_entry; 359 Mpi2DriverMappingPage0_t *dpm_pg0; 360 uint16_t max_devices; 361 uint16_t max_enclosures; 362 uint16_t max_expanders; 363 uint8_t max_volumes; 364 uint8_t num_enc_table_entries; 365 uint8_t num_rsvd_entries; 366 uint8_t num_channels; 367 uint16_t max_dpm_entries; 368 uint8_t is_dpm_enable; 369 uint8_t track_mapping_events; 370 uint32_t pending_map_events; 371 uint8_t mt_full_retry; 372 uint8_t mt_add_device_failed; 373 374 /* FW diag Buffer List */ 375 mpr_fw_diagnostic_buffer_t 376 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT]; 377 378 /* Event Recording IOCTL support */ 379 uint32_t events_to_record[4]; 380 mpr_event_entry_t recorded_events[MPR_EVENT_QUEUE_SIZE]; 381 uint8_t event_index; 382 uint32_t event_number; 383 384 /* EEDP and TLR support */ 385 uint8_t eedp_enabled; 386 uint8_t control_TLR; 387 388 /* Shutdown Event Handler */ 389 eventhandler_tag shutdown_eh; 390 391 /* To track topo events during reset */ 392#define MPR_DIAG_RESET_TIMEOUT 300000 393 uint8_t wait_for_port_enable; 394 uint8_t port_enable_complete; 395 uint8_t msleep_fake_chan; 396 397 /* StartStopUnit command handling at shutdown */ 398 uint32_t SSU_refcount; 399 uint8_t SSU_started; 400 401 char exclude_ids[80]; 402 struct timeval lastfail; 403}; 404 405struct mpr_config_params { 406 MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr; 407 u_int action; 408 u_int page_address; /* Attributes, not a phys address */ 409 u_int status; 410 void *buffer; 411 u_int length; 412 int timeout; 413 void (*callback)(struct mpr_softc *, struct mpr_config_params *); 414 void *cbdata; 415}; 416 417struct scsi_read_capacity_eedp 418{ 419 uint8_t addr[8]; 420 uint8_t length[4]; 421 uint8_t protect; 422}; 423 424static __inline uint32_t 425mpr_regread(struct mpr_softc *sc, uint32_t offset) 426{ 427 return (bus_space_read_4(sc->mpr_btag, sc->mpr_bhandle, offset)); 428} 429 430static __inline void 431mpr_regwrite(struct mpr_softc *sc, uint32_t offset, uint32_t val) 432{ 433 bus_space_write_4(sc->mpr_btag, sc->mpr_bhandle, offset, val); 434} 435 436/* free_queue must have Little Endian address 437 * TODO- cm_reply_data is unwanted. We can remove it. 438 * */ 439static __inline void 440mpr_free_reply(struct mpr_softc *sc, uint32_t busaddr) 441{ 442 if (++sc->replyfreeindex >= sc->fqdepth) 443 sc->replyfreeindex = 0; 444 sc->free_queue[sc->replyfreeindex] = htole32(busaddr); 445 mpr_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex); 446} 447 448static __inline struct mpr_chain * 449mpr_alloc_chain(struct mpr_softc *sc) 450{ 451 struct mpr_chain *chain; 452 453 if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) { 454 TAILQ_REMOVE(&sc->chain_list, chain, chain_link); 455 sc->chain_free--; 456 if (sc->chain_free < sc->chain_free_lowwater) 457 sc->chain_free_lowwater = sc->chain_free; 458 } else 459 sc->chain_alloc_fail++; 460 return (chain); 461} 462 463static __inline void 464mpr_free_chain(struct mpr_softc *sc, struct mpr_chain *chain) 465{ 466#if 0 467 bzero(chain->chain, 128); 468#endif 469 sc->chain_free++; 470 TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link); 471} 472 473static __inline void 474mpr_free_command(struct mpr_softc *sc, struct mpr_command *cm) 475{ 476 struct mpr_chain *chain, *chain_temp; 477 478 if (cm->cm_reply != NULL) 479 mpr_free_reply(sc, cm->cm_reply_data); 480 cm->cm_reply = NULL; 481 cm->cm_flags = 0; 482 cm->cm_complete = NULL; 483 cm->cm_complete_data = NULL; 484 cm->cm_ccb = NULL; 485 cm->cm_targ = NULL; 486 cm->cm_max_segs = 0; 487 cm->cm_lun = 0; 488 cm->cm_state = MPR_CM_STATE_FREE; 489 cm->cm_data = NULL; 490 cm->cm_length = 0; 491 cm->cm_out_len = 0; 492 cm->cm_sglsize = 0; 493 cm->cm_sge = NULL; 494 495 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 496 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 497 mpr_free_chain(sc, chain); 498 } 499 TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link); 500} 501 502static __inline struct mpr_command * 503mpr_alloc_command(struct mpr_softc *sc) 504{ 505 struct mpr_command *cm; 506 507 cm = TAILQ_FIRST(&sc->req_list); 508 if (cm == NULL) 509 return (NULL); 510 511 TAILQ_REMOVE(&sc->req_list, cm, cm_link); 512 KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy command\n")); 513 cm->cm_state = MPR_CM_STATE_BUSY; 514 return (cm); 515} 516 517static __inline void 518mpr_free_high_priority_command(struct mpr_softc *sc, struct mpr_command *cm) 519{ 520 struct mpr_chain *chain, *chain_temp; 521 522 if (cm->cm_reply != NULL) 523 mpr_free_reply(sc, cm->cm_reply_data); 524 cm->cm_reply = NULL; 525 cm->cm_flags = 0; 526 cm->cm_complete = NULL; 527 cm->cm_complete_data = NULL; 528 cm->cm_ccb = NULL; 529 cm->cm_targ = NULL; 530 cm->cm_lun = 0; 531 cm->cm_state = MPR_CM_STATE_FREE; 532 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) { 533 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link); 534 mpr_free_chain(sc, chain); 535 } 536 TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link); 537} 538 539static __inline struct mpr_command * 540mpr_alloc_high_priority_command(struct mpr_softc *sc) 541{ 542 struct mpr_command *cm; 543 544 cm = TAILQ_FIRST(&sc->high_priority_req_list); 545 if (cm == NULL) 546 return (NULL); 547 548 TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link); 549 KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy command\n")); 550 cm->cm_state = MPR_CM_STATE_BUSY; 551 return (cm); 552} 553 554static __inline void 555mpr_lock(struct mpr_softc *sc) 556{ 557 mtx_lock(&sc->mpr_mtx); 558} 559 560static __inline void 561mpr_unlock(struct mpr_softc *sc) 562{ 563 mtx_unlock(&sc->mpr_mtx); 564} 565 566#define MPR_INFO (1 << 0) /* Basic info */ 567#define MPR_FAULT (1 << 1) /* Hardware faults */ 568#define MPR_EVENT (1 << 2) /* Event data from the controller */ 569#define MPR_LOG (1 << 3) /* Log data from the controller */ 570#define MPR_RECOVERY (1 << 4) /* Command error recovery tracing */ 571#define MPR_ERROR (1 << 5) /* Parameter errors, programming bugs */ 572#define MPR_INIT (1 << 6) /* Things related to system init */ 573#define MPR_XINFO (1 << 7) /* More detailed/noisy info */ 574#define MPR_USER (1 << 8) /* Trace user-generated commands */ 575#define MPR_MAPPING (1 << 9) /* Trace device mappings */ 576#define MPR_TRACE (1 << 10) /* Function-by-function trace */ 577 578#define MPR_SSU_DISABLE_SSD_DISABLE_HDD 0 579#define MPR_SSU_ENABLE_SSD_DISABLE_HDD 1 580#define MPR_SSU_DISABLE_SSD_ENABLE_HDD 2 581#define MPR_SSU_ENABLE_SSD_ENABLE_HDD 3 582 583#define mpr_printf(sc, args...) \ 584 device_printf((sc)->mpr_dev, ##args) 585 586#define mpr_vprintf(sc, args...) \ 587do { \ 588 if (bootverbose) \ 589 mpr_printf(sc, ##args); \ 590} while (0) 591 592#define mpr_dprint(sc, level, msg, args...) \ 593do { \ 594 if ((sc)->mpr_debug & (level)) \ 595 device_printf((sc)->mpr_dev, msg, ##args); \ 596} while (0) 597 598#define mpr_dprint_field(sc, level, msg, args...) \ 599do { \ 600 if ((sc)->mpr_debug & (level)) \ 601 printf("\t" msg, ##args); \ 602} while (0) 603 604#define MPR_PRINTFIELD_START(sc, tag...) \ 605 mpr_dprint((sc), MPR_INFO, ##tag); \ 606 mpr_dprint_field((sc), MPR_INFO, ":\n") 607#define MPR_PRINTFIELD_END(sc, tag) \ 608 mpr_dprint((sc), MPR_INFO, tag "\n") 609#define MPR_PRINTFIELD(sc, facts, attr, fmt) \ 610 mpr_dprint_field((sc), MPR_INFO, #attr ": " #fmt "\n", (facts)->attr) 611 612#define MPR_EVENTFIELD_START(sc, tag...) \ 613 mpr_dprint((sc), MPR_EVENT, ##tag); \ 614 mpr_dprint_field((sc), MPR_EVENT, ":\n") 615#define MPR_EVENTFIELD(sc, facts, attr, fmt) \ 616 mpr_dprint_field((sc), MPR_EVENT, #attr ": " #fmt "\n", (facts)->attr) 617 618static __inline void 619mpr_from_u64(uint64_t data, U64 *mpr) 620{ 621 (mpr)->High = htole32((uint32_t)((data) >> 32)); 622 (mpr)->Low = htole32((uint32_t)((data) & 0xffffffff)); 623} 624 625static __inline uint64_t 626mpr_to_u64(U64 *data) 627{ 628 return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low)); 629} 630 631static __inline void 632mpr_mask_intr(struct mpr_softc *sc) 633{ 634 uint32_t mask; 635 636 mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 637 mask |= MPI2_HIM_REPLY_INT_MASK; 638 mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 639} 640 641static __inline void 642mpr_unmask_intr(struct mpr_softc *sc) 643{ 644 uint32_t mask; 645 646 mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET); 647 mask &= ~MPI2_HIM_REPLY_INT_MASK; 648 mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask); 649} 650 651int mpr_pci_setup_interrupts(struct mpr_softc *sc); 652int mpr_pci_restore(struct mpr_softc *sc); 653 654int mpr_attach(struct mpr_softc *sc); 655int mpr_free(struct mpr_softc *sc); 656void mpr_intr(void *); 657void mpr_intr_msi(void *); 658void mpr_intr_locked(void *); 659int mpr_register_events(struct mpr_softc *, uint8_t *, mpr_evt_callback_t *, 660 void *, struct mpr_event_handle **); 661int mpr_restart(struct mpr_softc *); 662int mpr_update_events(struct mpr_softc *, struct mpr_event_handle *, uint8_t *); 663int mpr_deregister_events(struct mpr_softc *, struct mpr_event_handle *); 664int mpr_push_sge(struct mpr_command *, MPI2_SGE_SIMPLE64 *, size_t, int); 665int mpr_push_ieee_sge(struct mpr_command *, void *, int); 666int mpr_add_dmaseg(struct mpr_command *, vm_paddr_t, size_t, u_int, int); 667int mpr_attach_sas(struct mpr_softc *sc); 668int mpr_detach_sas(struct mpr_softc *sc); 669int mpr_read_config_page(struct mpr_softc *, struct mpr_config_params *); 670int mpr_write_config_page(struct mpr_softc *, struct mpr_config_params *); 671void mpr_memaddr_cb(void *, bus_dma_segment_t *, int , int ); 672void mpr_init_sge(struct mpr_command *cm, void *req, void *sge); 673int mpr_attach_user(struct mpr_softc *); 674void mpr_detach_user(struct mpr_softc *); 675void mprsas_record_event(struct mpr_softc *sc, 676 MPI2_EVENT_NOTIFICATION_REPLY *event_reply); 677 678int mpr_map_command(struct mpr_softc *sc, struct mpr_command *cm); 679int mpr_wait_command(struct mpr_softc *sc, struct mpr_command *cm, int timeout, 680 int sleep_flag); 681int mpr_request_polled(struct mpr_softc *sc, struct mpr_command *cm); 682 683int mpr_config_get_bios_pg3(struct mpr_softc *sc, Mpi2ConfigReply_t 684 *mpi_reply, Mpi2BiosPage3_t *config_page); 685int mpr_config_get_raid_volume_pg0(struct mpr_softc *sc, Mpi2ConfigReply_t 686 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address); 687int mpr_config_get_ioc_pg8(struct mpr_softc *sc, Mpi2ConfigReply_t *, 688 Mpi2IOCPage8_t *); 689int mpr_config_get_iounit_pg8(struct mpr_softc *sc, 690 Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage8_t *config_page); 691int mpr_config_get_sas_device_pg0(struct mpr_softc *, Mpi2ConfigReply_t *, 692 Mpi2SasDevicePage0_t *, u32 , u16 ); 693int mpr_config_get_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *, 694 Mpi2DriverMappingPage0_t *, u16 ); 695int mpr_config_get_raid_volume_pg1(struct mpr_softc *sc, 696 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form, 697 u16 handle); 698int mpr_config_get_volume_wwid(struct mpr_softc *sc, u16 volume_handle, 699 u64 *wwid); 700int mpr_config_get_raid_pd_pg0(struct mpr_softc *sc, 701 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page, 702 u32 page_address); 703void mprsas_ir_shutdown(struct mpr_softc *sc); 704 705int mpr_reinit(struct mpr_softc *sc); 706void mprsas_handle_reinit(struct mpr_softc *sc); 707 708void mpr_base_static_config_pages(struct mpr_softc *sc); 709 710int mpr_mapping_initialize(struct mpr_softc *); 711void mpr_mapping_topology_change_event(struct mpr_softc *, 712 Mpi2EventDataSasTopologyChangeList_t *); 713int mpr_mapping_is_reinit_required(struct mpr_softc *); 714void mpr_mapping_free_memory(struct mpr_softc *sc); 715int mpr_config_set_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *, 716 Mpi2DriverMappingPage0_t *, u16 ); 717void mpr_mapping_exit(struct mpr_softc *); 718void mpr_mapping_check_devices(struct mpr_softc *, int); 719int mpr_mapping_allocate_memory(struct mpr_softc *sc); 720unsigned int mpr_mapping_get_sas_id(struct mpr_softc *, uint64_t , u16); 721unsigned int mpr_mapping_get_sas_id_from_handle(struct mpr_softc *sc, 722 u16 handle); 723unsigned int mpr_mapping_get_raid_id(struct mpr_softc *sc, u64 wwid, 724 u16 handle); 725unsigned int mpr_mapping_get_raid_id_from_handle(struct mpr_softc *sc, 726 u16 volHandle); 727void mpr_mapping_enclosure_dev_status_change_event(struct mpr_softc *, 728 Mpi2EventDataSasEnclDevStatusChange_t *event_data); 729void mpr_mapping_ir_config_change_event(struct mpr_softc *sc, 730 Mpi2EventDataIrConfigChangeList_t *event_data); 731 732void mprsas_evt_handler(struct mpr_softc *sc, uintptr_t data, 733 MPI2_EVENT_NOTIFICATION_REPLY *event); 734void mprsas_prepare_remove(struct mprsas_softc *sassc, uint16_t handle); 735void mprsas_prepare_volume_remove(struct mprsas_softc *sassc, uint16_t handle); 736int mprsas_startup(struct mpr_softc *sc); 737struct mprsas_target * mprsas_find_target_by_handle(struct mprsas_softc *, int, 738 uint16_t); 739void mprsas_realloc_targets(struct mpr_softc *sc, int maxtargets); 740struct mpr_command * mprsas_alloc_tm(struct mpr_softc *sc); 741void mprsas_free_tm(struct mpr_softc *sc, struct mpr_command *tm); 742void mprsas_release_simq_reinit(struct mprsas_softc *sassc); 743int mprsas_send_reset(struct mpr_softc *sc, struct mpr_command *tm, 744 uint8_t type); 745 746SYSCTL_DECL(_hw_mpr); 747 748/* Compatibility shims for different OS versions */ 749#if __FreeBSD_version >= 800001 750#define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 751 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 752#define mpr_kproc_exit(arg) kproc_exit(arg) 753#else 754#define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \ 755 kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) 756#define mpr_kproc_exit(arg) kthread_exit(arg) 757#endif 758 759#if defined(CAM_PRIORITY_XPT) 760#define MPR_PRIORITY_XPT CAM_PRIORITY_XPT 761#else 762#define MPR_PRIORITY_XPT 5 763#endif 764 765#if __FreeBSD_version < 800107 766// Prior to FreeBSD-8.0 scp3_flags was not defined. 767#define spc3_flags reserved 768 769#define SPC3_SID_PROTECT 0x01 770#define SPC3_SID_3PC 0x08 771#define SPC3_SID_TPGS_MASK 0x30 772#define SPC3_SID_TPGS_IMPLICIT 0x10 773#define SPC3_SID_TPGS_EXPLICIT 0x20 774#define SPC3_SID_ACC 0x40 775#define SPC3_SID_SCCS 0x80 776 777#define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE 778#endif 779 780#endif 781 782