2 * Copyright (c) 2009 Yahoo! Inc.
3 * Copyright (c) 2011-2015 LSI Corp.
4 * Copyright (c) 2013-2016 Avago Technologies
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
28 * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
36 #define MPR_DRIVER_VERSION "15.03.00.00-fbsd"
38 #define MPR_DB_MAX_WAIT 2500
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
54 * PCIe NVMe Specific defines
56 //SLM-for now just use the same value as a SAS disk
57 #define NVME_QDEPTH MPR_REQ_FRAMES
58 #define PRP_ENTRY_SIZE 8
59 #define NVME_CMD_PRP1_OFFSET 24 /* PRP1 offset in NVMe cmd */
60 #define NVME_CMD_PRP2_OFFSET 32 /* PRP2 offset in NVMe cmd */
61 #define NVME_ERROR_RESPONSE_SIZE 16 /* Max NVME Error Response */
62 #define HOST_PAGE_SIZE_4K 12
64 #define MPR_FUNCTRACE(sc) \
65 mpr_dprint((sc), MPR_TRACE, "%s\n", __func__)
70 #define MPR_PERIODIC_DELAY 1 /* 1 second heartbeat/watchdog check */
71 #define MPR_ATA_ID_TIMEOUT 5 /* 5 second timeout for SATA ID cmd */
72 #define MPR_MISSING_CHECK_DELAY 10 /* 10 seconds between missing check */
74 #define IFAULT_IOP_OVER_TEMP_THRESHOLD_EXCEEDED 0x2810
76 #define MPR_SCSI_RI_INVALID_FRAME (0x00000002)
77 #define MPR_STRING_LENGTH 64
79 #define DEFAULT_SPINUP_WAIT 3 /* seconds to wait for spinup */
81 #include <sys/endian.h>
84 * host mapping related macro definitions
86 #define MPR_MAPTABLE_BAD_IDX 0xFFFFFFFF
87 #define MPR_DPM_BAD_IDX 0xFFFF
88 #define MPR_ENCTABLE_BAD_IDX 0xFF
89 #define MPR_MAX_MISSING_COUNT 0x0F
90 #define MPR_DEV_RESERVED 0x20000000
91 #define MPR_MAP_IN_USE 0x10000000
92 #define MPR_MAP_BAD_ID 0xFFFFFFFF
100 * struct dev_mapping_table - device mapping information
101 * @physical_id: SAS address for drives or WWID for RAID volumes
102 * @device_info: bitfield provides detailed info about the device
103 * @phy_bits: bitfields indicating controller phys
104 * @dpm_entry_num: index of this device in device persistent map table
105 * @dev_handle: device handle for the device pointed by this entry
107 * @missing_count: number of times the device not detected by driver
108 * @hide_flag: Hide this physical disk/not (foreign configuration)
109 * @init_complete: Whether the start of the day checks completed or not
110 * @TLR_bits: Turn TLR support on or off
112 struct dev_mapping_table {
127 * struct enc_mapping_table - mapping information about an enclosure
128 * @enclosure_id: Logical ID of this enclosure
129 * @start_index: index to the entry in dev_mapping_table
130 * @phy_bits: bitfields indicating controller phys
131 * @dpm_entry_num: index of this enclosure in device persistent map table
132 * @enc_handle: device handle for the enclosure pointed by this entry
133 * @num_slots: number of slots in the enclosure
134 * @start_slot: Starting slot id
135 * @missing_count: number of times the device not detected by driver
136 * @removal_flag: used to mark the device for removal
137 * @skip_search: used as a flag to include/exclude enclosure for search
138 * @init_complete: Whether the start of the day checks completed or not
140 struct enc_mapping_table {
155 * struct map_removal_table - entries to be removed from mapping table
156 * @dpm_entry_num: index of this device in device persistent map table
157 * @dev_handle: device handle for the device pointed by this entry
159 struct map_removal_table{
164 typedef struct mpr_fw_diagnostic_buffer {
166 uint8_t extended_type;
168 uint8_t force_release;
169 uint32_t product_specific[23];
173 uint8_t owned_by_firmware;
175 } mpr_fw_diagnostic_buffer_t;
181 struct mprsas_target;
182 struct mpr_column_map;
184 MALLOC_DECLARE(M_MPR);
186 typedef void mpr_evt_callback_t(struct mpr_softc *, uintptr_t,
187 MPI2_EVENT_NOTIFICATION_REPLY *reply);
188 typedef void mpr_command_callback_t(struct mpr_softc *, struct mpr_command *cm);
191 TAILQ_ENTRY(mpr_chain) chain_link;
193 uint64_t chain_busaddr;
196 struct mpr_prp_page {
197 TAILQ_ENTRY(mpr_prp_page) prp_page_link;
199 uint64_t prp_page_busaddr;
203 * This needs to be at least 2 to support SMP passthrough.
205 #define MPR_IOVEC_COUNT 2
208 TAILQ_ENTRY(mpr_command) cm_link;
209 TAILQ_ENTRY(mpr_command) cm_recovery;
210 struct mpr_softc *cm_sc;
216 struct iovec cm_iovec[MPR_IOVEC_COUNT];
222 uint32_t cm_reply_data;
223 mpr_command_callback_t *cm_complete;
224 void *cm_complete_data;
225 struct mprsas_target *cm_targ;
226 MPI2_REQUEST_DESCRIPTOR_UNION cm_desc;
229 #define MPR_CM_FLAGS_POLLED (1 << 0)
230 #define MPR_CM_FLAGS_COMPLETE (1 << 1)
231 #define MPR_CM_FLAGS_SGE_SIMPLE (1 << 2)
232 #define MPR_CM_FLAGS_DATAOUT (1 << 3)
233 #define MPR_CM_FLAGS_DATAIN (1 << 4)
234 #define MPR_CM_FLAGS_WAKEUP (1 << 5)
235 #define MPR_CM_FLAGS_USE_UIO (1 << 6)
236 #define MPR_CM_FLAGS_SMP_PASS (1 << 7)
237 #define MPR_CM_FLAGS_CHAIN_FAILED (1 << 8)
238 #define MPR_CM_FLAGS_ERROR_MASK MPR_CM_FLAGS_CHAIN_FAILED
239 #define MPR_CM_FLAGS_USE_CCB (1 << 9)
240 #define MPR_CM_FLAGS_SATA_ID_TIMEOUT (1 << 10)
242 #define MPR_CM_STATE_FREE 0
243 #define MPR_CM_STATE_BUSY 1
244 #define MPR_CM_STATE_TIMEDOUT 2
245 bus_dmamap_t cm_dmamap;
246 struct scsi_sense_data *cm_sense;
247 uint64_t *nvme_error_response;
248 TAILQ_HEAD(, mpr_chain) cm_chain_list;
249 TAILQ_HEAD(, mpr_prp_page) cm_prp_page_list;
250 uint32_t cm_req_busaddr;
251 bus_addr_t cm_sense_busaddr;
252 struct callout cm_callout;
255 struct mpr_column_map {
257 uint8_t phys_disk_num;
260 struct mpr_event_handle {
261 TAILQ_ENTRY(mpr_event_handle) eh_list;
262 mpr_evt_callback_t *callback;
268 struct mpr_softc *sc;
270 MPI2_REPLY_DESCRIPTORS_UNION *post_queue;
273 ck_ring_buffer_t *ringmem;
274 ck_ring_buffer_t *chainmem;
276 ck_ring_t chain_ring;
278 bus_dma_tag_t buffer_dmat;
279 int io_cmds_highwater;
280 int chain_free_lowwater;
281 int chain_alloc_fail;
282 struct resource *irq;
289 struct cdev *mpr_cdev;
291 #define MPR_FLAGS_INTX (1 << 0)
292 #define MPR_FLAGS_MSI (1 << 1)
293 #define MPR_FLAGS_BUSY (1 << 2)
294 #define MPR_FLAGS_SHUTDOWN (1 << 3)
295 #define MPR_FLAGS_DIAGRESET (1 << 4)
296 #define MPR_FLAGS_ATTACH_DONE (1 << 5)
297 #define MPR_FLAGS_GEN35_IOC (1 << 6)
298 #define MPR_FLAGS_REALLOCATED (1 << 7)
303 u_int atomic_desc_capable;
306 int io_cmds_highwater;
311 int chain_free_lowwater;
312 uint32_t chain_frame_size;
313 uint16_t chain_seg_size;
316 int prp_pages_free_lowwater;
318 int spinup_wait_time;
320 uint64_t chain_alloc_fail;
321 uint64_t prp_page_alloc_fail;
322 struct sysctl_ctx_list sysctl_ctx;
323 struct sysctl_oid *sysctl_tree;
325 struct mpr_command *commands;
326 struct mpr_chain *chains;
327 struct mpr_prp_page *prps;
328 struct callout periodic;
329 struct callout device_check_callout;
330 struct mpr_queue *queues;
332 struct mprsas_softc *sassc;
333 char tmp_string[MPR_STRING_LENGTH];
334 TAILQ_HEAD(, mpr_command) req_list;
335 TAILQ_HEAD(, mpr_command) high_priority_req_list;
336 TAILQ_HEAD(, mpr_chain) chain_list;
337 TAILQ_HEAD(, mpr_prp_page) prp_page_list;
338 TAILQ_HEAD(, mpr_command) tm_list;
342 struct resource *mpr_regs_resource;
343 bus_space_handle_t mpr_bhandle;
344 bus_space_tag_t mpr_btag;
347 bus_dma_tag_t mpr_parent_dmat;
348 bus_dma_tag_t buffer_dmat;
350 MPI2_IOC_FACTS_REPLY *facts;
353 int fqdepth; /* Free queue */
354 int pqdepth; /* Post queue */
356 uint8_t event_mask[16];
357 TAILQ_HEAD(, mpr_event_handle) event_list;
358 struct mpr_event_handle *mpr_log_eh;
361 struct intr_config_hook mpr_ich;
364 bus_addr_t req_busaddr;
365 bus_dma_tag_t req_dmat;
366 bus_dmamap_t req_map;
368 uint8_t *reply_frames;
369 bus_addr_t reply_busaddr;
370 bus_dma_tag_t reply_dmat;
371 bus_dmamap_t reply_map;
373 struct scsi_sense_data *sense_frames;
374 bus_addr_t sense_busaddr;
375 bus_dma_tag_t sense_dmat;
376 bus_dmamap_t sense_map;
378 uint8_t *chain_frames;
379 bus_addr_t chain_busaddr;
380 bus_dma_tag_t chain_dmat;
381 bus_dmamap_t chain_map;
384 bus_addr_t prp_page_busaddr;
385 bus_dma_tag_t prp_page_dmat;
386 bus_dmamap_t prp_page_map;
388 MPI2_REPLY_DESCRIPTORS_UNION *post_queue;
389 bus_addr_t post_busaddr;
390 uint32_t *free_queue;
391 bus_addr_t free_busaddr;
392 bus_dma_tag_t queues_dmat;
393 bus_dmamap_t queues_map;
395 uint8_t *fw_diag_buffer;
396 bus_addr_t fw_diag_busaddr;
397 bus_dma_tag_t fw_diag_dmat;
398 bus_dmamap_t fw_diag_map;
402 /* static config pages */
403 Mpi2IOCPage8_t ioc_pg8;
404 Mpi2IOUnitPage8_t iounit_pg8;
406 /* host mapping support */
407 struct dev_mapping_table *mapping_table;
408 struct enc_mapping_table *enclosure_table;
409 struct map_removal_table *removal_table;
410 uint8_t *dpm_entry_used;
411 uint8_t *dpm_flush_entry;
412 Mpi2DriverMappingPage0_t *dpm_pg0;
413 uint16_t max_devices;
414 uint16_t max_enclosures;
415 uint16_t max_expanders;
417 uint8_t num_enc_table_entries;
418 uint8_t num_rsvd_entries;
419 uint16_t max_dpm_entries;
420 uint8_t is_dpm_enable;
421 uint8_t track_mapping_events;
422 uint32_t pending_map_events;
424 /* FW diag Buffer List */
425 mpr_fw_diagnostic_buffer_t
426 fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_COUNT];
428 /* Event Recording IOCTL support */
429 uint32_t events_to_record[4];
430 mpr_event_entry_t recorded_events[MPR_EVENT_QUEUE_SIZE];
432 uint32_t event_number;
434 /* EEDP and TLR support */
435 uint8_t eedp_enabled;
438 /* Shutdown Event Handler */
439 eventhandler_tag shutdown_eh;
441 /* To track topo events during reset */
442 #define MPR_DIAG_RESET_TIMEOUT 300000
443 uint8_t wait_for_port_enable;
444 uint8_t port_enable_complete;
445 uint8_t msleep_fake_chan;
447 /* StartStopUnit command handling at shutdown */
448 uint32_t SSU_refcount;
451 char exclude_ids[80];
452 struct timeval lastfail;
455 struct mpr_config_params {
456 MPI2_CONFIG_EXT_PAGE_HEADER_UNION hdr;
458 u_int page_address; /* Attributes, not a phys address */
463 void (*callback)(struct mpr_softc *, struct mpr_config_params *);
467 struct scsi_read_capacity_eedp
474 static __inline uint32_t
475 mpr_regread(struct mpr_softc *sc, uint32_t offset)
477 return (bus_space_read_4(sc->mpr_btag, sc->mpr_bhandle, offset));
481 mpr_regwrite(struct mpr_softc *sc, uint32_t offset, uint32_t val)
483 bus_space_write_4(sc->mpr_btag, sc->mpr_bhandle, offset, val);
486 /* free_queue must have Little Endian address
487 * TODO- cm_reply_data is unwanted. We can remove it.
490 mpr_free_reply(struct mpr_softc *sc, uint32_t busaddr)
492 if (++sc->replyfreeindex >= sc->fqdepth)
493 sc->replyfreeindex = 0;
494 sc->free_queue[sc->replyfreeindex] = htole32(busaddr);
495 mpr_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
498 static __inline struct mpr_chain *
499 mpr_alloc_chain(struct mpr_softc *sc)
501 struct mpr_chain *chain;
503 if ((chain = TAILQ_FIRST(&sc->chain_list)) != NULL) {
504 TAILQ_REMOVE(&sc->chain_list, chain, chain_link);
506 if (sc->chain_free < sc->chain_free_lowwater)
507 sc->chain_free_lowwater = sc->chain_free;
509 sc->chain_alloc_fail++;
514 mpr_free_chain(struct mpr_softc *sc, struct mpr_chain *chain)
517 bzero(chain->chain, 128);
520 TAILQ_INSERT_TAIL(&sc->chain_list, chain, chain_link);
523 static __inline struct mpr_prp_page *
524 mpr_alloc_prp_page(struct mpr_softc *sc)
526 struct mpr_prp_page *prp_page;
528 if ((prp_page = TAILQ_FIRST(&sc->prp_page_list)) != NULL) {
529 TAILQ_REMOVE(&sc->prp_page_list, prp_page, prp_page_link);
530 sc->prp_pages_free--;
531 if (sc->prp_pages_free < sc->prp_pages_free_lowwater)
532 sc->prp_pages_free_lowwater = sc->prp_pages_free;
534 sc->prp_page_alloc_fail++;
539 mpr_free_prp_page(struct mpr_softc *sc, struct mpr_prp_page *prp_page)
541 sc->prp_pages_free++;
542 TAILQ_INSERT_TAIL(&sc->prp_page_list, prp_page, prp_page_link);
546 mpr_free_command(struct mpr_softc *sc, struct mpr_command *cm)
548 struct mpr_chain *chain, *chain_temp;
549 struct mpr_prp_page *prp_page, *prp_page_temp;
551 if (cm->cm_reply != NULL)
552 mpr_free_reply(sc, cm->cm_reply_data);
555 cm->cm_complete = NULL;
556 cm->cm_complete_data = NULL;
561 cm->cm_state = MPR_CM_STATE_FREE;
568 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
569 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
570 mpr_free_chain(sc, chain);
572 TAILQ_FOREACH_SAFE(prp_page, &cm->cm_prp_page_list, prp_page_link,
574 TAILQ_REMOVE(&cm->cm_prp_page_list, prp_page, prp_page_link);
575 mpr_free_prp_page(sc, prp_page);
577 TAILQ_INSERT_TAIL(&sc->req_list, cm, cm_link);
580 static __inline struct mpr_command *
581 mpr_alloc_command(struct mpr_softc *sc)
583 struct mpr_command *cm;
585 cm = TAILQ_FIRST(&sc->req_list);
589 TAILQ_REMOVE(&sc->req_list, cm, cm_link);
590 KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy "
592 cm->cm_state = MPR_CM_STATE_BUSY;
597 mpr_free_high_priority_command(struct mpr_softc *sc, struct mpr_command *cm)
599 struct mpr_chain *chain, *chain_temp;
601 if (cm->cm_reply != NULL)
602 mpr_free_reply(sc, cm->cm_reply_data);
605 cm->cm_complete = NULL;
606 cm->cm_complete_data = NULL;
610 cm->cm_state = MPR_CM_STATE_FREE;
611 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link, chain_temp) {
612 TAILQ_REMOVE(&cm->cm_chain_list, chain, chain_link);
613 mpr_free_chain(sc, chain);
615 TAILQ_INSERT_TAIL(&sc->high_priority_req_list, cm, cm_link);
618 static __inline struct mpr_command *
619 mpr_alloc_high_priority_command(struct mpr_softc *sc)
621 struct mpr_command *cm;
623 cm = TAILQ_FIRST(&sc->high_priority_req_list);
627 TAILQ_REMOVE(&sc->high_priority_req_list, cm, cm_link);
628 KASSERT(cm->cm_state == MPR_CM_STATE_FREE, ("mpr: Allocating busy "
630 cm->cm_state = MPR_CM_STATE_BUSY;
635 mpr_lock(struct mpr_softc *sc)
637 mtx_lock(&sc->mpr_mtx);
641 mpr_unlock(struct mpr_softc *sc)
643 mtx_unlock(&sc->mpr_mtx);
646 #define MPR_INFO (1 << 0) /* Basic info */
647 #define MPR_FAULT (1 << 1) /* Hardware faults */
648 #define MPR_EVENT (1 << 2) /* Event data from the controller */
649 #define MPR_LOG (1 << 3) /* Log data from the controller */
650 #define MPR_RECOVERY (1 << 4) /* Command error recovery tracing */
651 #define MPR_ERROR (1 << 5) /* Parameter errors, programming bugs */
652 #define MPR_INIT (1 << 6) /* Things related to system init */
653 #define MPR_XINFO (1 << 7) /* More detailed/noisy info */
654 #define MPR_USER (1 << 8) /* Trace user-generated commands */
655 #define MPR_MAPPING (1 << 9) /* Trace device mappings */
656 #define MPR_TRACE (1 << 10) /* Function-by-function trace */
658 #define MPR_SSU_DISABLE_SSD_DISABLE_HDD 0
659 #define MPR_SSU_ENABLE_SSD_DISABLE_HDD 1
660 #define MPR_SSU_DISABLE_SSD_ENABLE_HDD 2
661 #define MPR_SSU_ENABLE_SSD_ENABLE_HDD 3
663 #define mpr_printf(sc, args...) \
664 device_printf((sc)->mpr_dev, ##args)
666 #define mpr_print_field(sc, msg, args...) \
667 printf("\t" msg, ##args)
669 #define mpr_vprintf(sc, args...) \
672 mpr_printf(sc, ##args); \
675 #define mpr_dprint(sc, level, msg, args...) \
677 if ((sc)->mpr_debug & (level)) \
678 device_printf((sc)->mpr_dev, msg, ##args); \
681 #define MPR_PRINTFIELD_START(sc, tag...) \
682 mpr_printf((sc), ##tag); \
683 mpr_print_field((sc), ":\n")
684 #define MPR_PRINTFIELD_END(sc, tag) \
685 mpr_printf((sc), tag "\n")
686 #define MPR_PRINTFIELD(sc, facts, attr, fmt) \
687 mpr_print_field((sc), #attr ": " #fmt "\n", (facts)->attr)
690 mpr_from_u64(uint64_t data, U64 *mpr)
692 (mpr)->High = htole32((uint32_t)((data) >> 32));
693 (mpr)->Low = htole32((uint32_t)((data) & 0xffffffff));
696 static __inline uint64_t
697 mpr_to_u64(U64 *data)
699 return (((uint64_t)le32toh(data->High) << 32) | le32toh(data->Low));
703 mpr_mask_intr(struct mpr_softc *sc)
707 mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
708 mask |= MPI2_HIM_REPLY_INT_MASK;
709 mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
713 mpr_unmask_intr(struct mpr_softc *sc)
717 mask = mpr_regread(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET);
718 mask &= ~MPI2_HIM_REPLY_INT_MASK;
719 mpr_regwrite(sc, MPI2_HOST_INTERRUPT_MASK_OFFSET, mask);
722 int mpr_pci_setup_interrupts(struct mpr_softc *sc);
723 void mpr_pci_free_interrupts(struct mpr_softc *sc);
724 int mpr_pci_restore(struct mpr_softc *sc);
726 void mpr_get_tunables(struct mpr_softc *sc);
727 int mpr_attach(struct mpr_softc *sc);
728 int mpr_free(struct mpr_softc *sc);
729 void mpr_intr(void *);
730 void mpr_intr_msi(void *);
731 void mpr_intr_locked(void *);
732 int mpr_register_events(struct mpr_softc *, uint8_t *, mpr_evt_callback_t *,
733 void *, struct mpr_event_handle **);
734 int mpr_restart(struct mpr_softc *);
735 int mpr_update_events(struct mpr_softc *, struct mpr_event_handle *, uint8_t *);
736 int mpr_deregister_events(struct mpr_softc *, struct mpr_event_handle *);
737 void mpr_build_nvme_prp(struct mpr_softc *sc, struct mpr_command *cm,
738 Mpi26NVMeEncapsulatedRequest_t *nvme_encap_request, void *data,
739 uint32_t data_in_sz, uint32_t data_out_sz);
740 int mpr_push_sge(struct mpr_command *, MPI2_SGE_SIMPLE64 *, size_t, int);
741 int mpr_push_ieee_sge(struct mpr_command *, void *, int);
742 int mpr_add_dmaseg(struct mpr_command *, vm_paddr_t, size_t, u_int, int);
743 int mpr_attach_sas(struct mpr_softc *sc);
744 int mpr_detach_sas(struct mpr_softc *sc);
745 int mpr_read_config_page(struct mpr_softc *, struct mpr_config_params *);
746 int mpr_write_config_page(struct mpr_softc *, struct mpr_config_params *);
747 void mpr_memaddr_cb(void *, bus_dma_segment_t *, int , int );
748 void mpr_init_sge(struct mpr_command *cm, void *req, void *sge);
749 int mpr_attach_user(struct mpr_softc *);
750 void mpr_detach_user(struct mpr_softc *);
751 void mprsas_record_event(struct mpr_softc *sc,
752 MPI2_EVENT_NOTIFICATION_REPLY *event_reply);
754 int mpr_map_command(struct mpr_softc *sc, struct mpr_command *cm);
755 int mpr_wait_command(struct mpr_softc *sc, struct mpr_command **cm, int timeout,
757 int mpr_request_polled(struct mpr_softc *sc, struct mpr_command **cm);
759 int mpr_config_get_bios_pg3(struct mpr_softc *sc, Mpi2ConfigReply_t
760 *mpi_reply, Mpi2BiosPage3_t *config_page);
761 int mpr_config_get_raid_volume_pg0(struct mpr_softc *sc, Mpi2ConfigReply_t
762 *mpi_reply, Mpi2RaidVolPage0_t *config_page, u32 page_address);
763 int mpr_config_get_ioc_pg8(struct mpr_softc *sc, Mpi2ConfigReply_t *,
765 int mpr_config_get_iounit_pg8(struct mpr_softc *sc,
766 Mpi2ConfigReply_t *mpi_reply, Mpi2IOUnitPage8_t *config_page);
767 int mpr_config_get_sas_device_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
768 Mpi2SasDevicePage0_t *, u32 , u16 );
769 int mpr_config_get_pcie_device_pg0(struct mpr_softc *sc, Mpi2ConfigReply_t
770 *mpi_reply, Mpi26PCIeDevicePage0_t *config_page, u32 form, u16 handle);
771 int mpr_config_get_pcie_device_pg2(struct mpr_softc *sc, Mpi2ConfigReply_t
772 *mpi_reply, Mpi26PCIeDevicePage2_t *config_page, u32 form, u16 handle);
773 int mpr_config_get_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
774 Mpi2DriverMappingPage0_t *, u16 );
775 int mpr_config_get_raid_volume_pg1(struct mpr_softc *sc,
776 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidVolPage1_t *config_page, u32 form,
778 int mpr_config_get_volume_wwid(struct mpr_softc *sc, u16 volume_handle,
780 int mpr_config_get_raid_pd_pg0(struct mpr_softc *sc,
781 Mpi2ConfigReply_t *mpi_reply, Mpi2RaidPhysDiskPage0_t *config_page,
783 void mprsas_ir_shutdown(struct mpr_softc *sc);
785 int mpr_reinit(struct mpr_softc *sc);
786 void mprsas_handle_reinit(struct mpr_softc *sc);
788 void mpr_base_static_config_pages(struct mpr_softc *sc);
790 int mpr_mapping_initialize(struct mpr_softc *);
791 void mpr_mapping_topology_change_event(struct mpr_softc *,
792 Mpi2EventDataSasTopologyChangeList_t *);
793 void mpr_mapping_pcie_topology_change_event(struct mpr_softc *sc,
794 Mpi26EventDataPCIeTopologyChangeList_t *event_data);
795 void mpr_mapping_free_memory(struct mpr_softc *sc);
796 int mpr_config_set_dpm_pg0(struct mpr_softc *, Mpi2ConfigReply_t *,
797 Mpi2DriverMappingPage0_t *, u16 );
798 void mpr_mapping_exit(struct mpr_softc *);
799 void mpr_mapping_check_devices(void *);
800 int mpr_mapping_allocate_memory(struct mpr_softc *sc);
801 unsigned int mpr_mapping_get_tid(struct mpr_softc *, uint64_t , u16);
802 unsigned int mpr_mapping_get_tid_from_handle(struct mpr_softc *sc,
804 unsigned int mpr_mapping_get_raid_tid(struct mpr_softc *sc, u64 wwid,
806 unsigned int mpr_mapping_get_raid_tid_from_handle(struct mpr_softc *sc,
808 void mpr_mapping_enclosure_dev_status_change_event(struct mpr_softc *,
809 Mpi2EventDataSasEnclDevStatusChange_t *event_data);
810 void mpr_mapping_ir_config_change_event(struct mpr_softc *sc,
811 Mpi2EventDataIrConfigChangeList_t *event_data);
813 void mprsas_evt_handler(struct mpr_softc *sc, uintptr_t data,
814 MPI2_EVENT_NOTIFICATION_REPLY *event);
815 void mprsas_prepare_remove(struct mprsas_softc *sassc, uint16_t handle);
816 void mprsas_prepare_volume_remove(struct mprsas_softc *sassc, uint16_t handle);
817 int mprsas_startup(struct mpr_softc *sc);
818 struct mprsas_target * mprsas_find_target_by_handle(struct mprsas_softc *, int,
820 void mprsas_realloc_targets(struct mpr_softc *sc, int maxtargets);
821 struct mpr_command * mprsas_alloc_tm(struct mpr_softc *sc);
822 void mprsas_free_tm(struct mpr_softc *sc, struct mpr_command *tm);
823 void mprsas_release_simq_reinit(struct mprsas_softc *sassc);
824 int mprsas_send_reset(struct mpr_softc *sc, struct mpr_command *tm,
827 SYSCTL_DECL(_hw_mpr);
829 /* Compatibility shims for different OS versions */
830 #if __FreeBSD_version >= 800001
831 #define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
832 kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
833 #define mpr_kproc_exit(arg) kproc_exit(arg)
835 #define mpr_kproc_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
836 kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
837 #define mpr_kproc_exit(arg) kthread_exit(arg)
840 #if defined(CAM_PRIORITY_XPT)
841 #define MPR_PRIORITY_XPT CAM_PRIORITY_XPT
843 #define MPR_PRIORITY_XPT 5
846 #if __FreeBSD_version < 800107
847 // Prior to FreeBSD-8.0 scp3_flags was not defined.
848 #define spc3_flags reserved
850 #define SPC3_SID_PROTECT 0x01
851 #define SPC3_SID_3PC 0x08
852 #define SPC3_SID_TPGS_MASK 0x30
853 #define SPC3_SID_TPGS_IMPLICIT 0x10
854 #define SPC3_SID_TPGS_EXPLICIT 0x20
855 #define SPC3_SID_ACC 0x40
856 #define SPC3_SID_SCCS 0x80
858 #define CAM_PRIORITY_NORMAL CAM_PRIORITY_NONE
861 /* Definitions for SCSI unmap translation to NVMe DSM command */
863 /* UNMAP block descriptor structure */
864 struct unmap_blk_desc {
870 /* UNMAP command's data */
871 struct unmap_parm_list {
872 uint16_t unmap_data_len;
873 uint16_t unmap_blk_desc_data_len;
875 struct unmap_blk_desc desc[0];
878 /* SCSI ADDITIONAL SENSE Codes */
879 #define FIXED_SENSE_DATA 0x70
880 #define SCSI_ASC_NO_SENSE 0x00
881 #define SCSI_ASC_PERIPHERAL_DEV_WRITE_FAULT 0x03
882 #define SCSI_ASC_LUN_NOT_READY 0x04
883 #define SCSI_ASC_WARNING 0x0B
884 #define SCSI_ASC_LOG_BLOCK_GUARD_CHECK_FAILED 0x10
885 #define SCSI_ASC_LOG_BLOCK_APPTAG_CHECK_FAILED 0x10
886 #define SCSI_ASC_LOG_BLOCK_REFTAG_CHECK_FAILED 0x10
887 #define SCSI_ASC_UNRECOVERED_READ_ERROR 0x11
888 #define SCSI_ASC_MISCOMPARE_DURING_VERIFY 0x1D
889 #define SCSI_ASC_ACCESS_DENIED_INVALID_LUN_ID 0x20
890 #define SCSI_ASC_ILLEGAL_COMMAND 0x20
891 #define SCSI_ASC_ILLEGAL_BLOCK 0x21
892 #define SCSI_ASC_INVALID_CDB 0x24
893 #define SCSI_ASC_INVALID_LUN 0x25
894 #define SCSI_ASC_INVALID_PARAMETER 0x26
895 #define SCSI_ASC_FORMAT_COMMAND_FAILED 0x31
896 #define SCSI_ASC_INTERNAL_TARGET_FAILURE 0x44
898 /* SCSI ADDITIONAL SENSE Code Qualifiers */
899 #define SCSI_ASCQ_CAUSE_NOT_REPORTABLE 0x00
900 #define SCSI_ASCQ_FORMAT_COMMAND_FAILED 0x01
901 #define SCSI_ASCQ_LOG_BLOCK_GUARD_CHECK_FAILED 0x01
902 #define SCSI_ASCQ_LOG_BLOCK_APPTAG_CHECK_FAILED 0x02
903 #define SCSI_ASCQ_LOG_BLOCK_REFTAG_CHECK_FAILED 0x03
904 #define SCSI_ASCQ_FORMAT_IN_PROGRESS 0x04
905 #define SCSI_ASCQ_POWER_LOSS_EXPECTED 0x08
906 #define SCSI_ASCQ_INVALID_LUN_ID 0x09