2 * Copyright (c) 2009 Yahoo! Inc.
3 * Copyright (c) 2011-2015 LSI Corp.
4 * Copyright (c) 2013-2015 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
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 /* Communications core for Avago Technologies (LSI) MPT2 */
38 /* TODO Move headers to mpsvar */
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/selinfo.h>
45 #include <sys/mutex.h>
46 #include <sys/module.h>
50 #include <sys/malloc.h>
52 #include <sys/sysctl.h>
54 #include <sys/queue.h>
55 #include <sys/kthread.h>
56 #include <sys/taskqueue.h>
57 #include <sys/endian.h>
58 #include <sys/eventhandler.h>
61 #include <machine/bus.h>
62 #include <machine/resource.h>
66 #include <dev/pci/pcivar.h>
69 #include <cam/scsi/scsi_all.h>
71 #include <dev/mps/mpi/mpi2_type.h>
72 #include <dev/mps/mpi/mpi2.h>
73 #include <dev/mps/mpi/mpi2_ioc.h>
74 #include <dev/mps/mpi/mpi2_sas.h>
75 #include <dev/mps/mpi/mpi2_cnfg.h>
76 #include <dev/mps/mpi/mpi2_init.h>
77 #include <dev/mps/mpi/mpi2_tool.h>
78 #include <dev/mps/mps_ioctl.h>
79 #include <dev/mps/mpsvar.h>
80 #include <dev/mps/mps_table.h>
82 static int mps_diag_reset(struct mps_softc *sc, int sleep_flag);
83 static int mps_init_queues(struct mps_softc *sc);
84 static void mps_resize_queues(struct mps_softc *sc);
85 static int mps_message_unit_reset(struct mps_softc *sc, int sleep_flag);
86 static int mps_transition_operational(struct mps_softc *sc);
87 static int mps_iocfacts_allocate(struct mps_softc *sc, uint8_t attaching);
88 static void mps_iocfacts_free(struct mps_softc *sc);
89 static void mps_startup(void *arg);
90 static int mps_send_iocinit(struct mps_softc *sc);
91 static int mps_alloc_queues(struct mps_softc *sc);
92 static int mps_alloc_hw_queues(struct mps_softc *sc);
93 static int mps_alloc_replies(struct mps_softc *sc);
94 static int mps_alloc_requests(struct mps_softc *sc);
95 static int mps_attach_log(struct mps_softc *sc);
96 static __inline void mps_complete_command(struct mps_softc *sc,
97 struct mps_command *cm);
98 static void mps_dispatch_event(struct mps_softc *sc, uintptr_t data,
99 MPI2_EVENT_NOTIFICATION_REPLY *reply);
100 static void mps_config_complete(struct mps_softc *sc, struct mps_command *cm);
101 static void mps_periodic(void *);
102 static int mps_reregister_events(struct mps_softc *sc);
103 static void mps_enqueue_request(struct mps_softc *sc, struct mps_command *cm);
104 static int mps_get_iocfacts(struct mps_softc *sc, MPI2_IOC_FACTS_REPLY *facts);
105 static int mps_wait_db_ack(struct mps_softc *sc, int timeout, int sleep_flag);
106 static int mps_debug_sysctl(SYSCTL_HANDLER_ARGS);
107 static void mps_parse_debug(struct mps_softc *sc, char *list);
109 SYSCTL_NODE(_hw, OID_AUTO, mps, CTLFLAG_RD, 0, "MPS Driver Parameters");
111 MALLOC_DEFINE(M_MPT2, "mps", "mpt2 driver memory");
114 * Do a "Diagnostic Reset" aka a hard reset. This should get the chip out of
115 * any state and back to its initialization state machine.
117 static char mpt2_reset_magic[] = { 0x00, 0x0f, 0x04, 0x0b, 0x02, 0x07, 0x0d };
119 /* Added this union to smoothly convert le64toh cm->cm_desc.Words.
120 * Compiler only support unint64_t to be passed as argument.
121 * Otherwise it will throw below error
122 * "aggregate value used where an integer was expected"
125 typedef union _reply_descriptor {
131 }reply_descriptor,address_descriptor;
133 /* Rate limit chain-fail messages to 1 per minute */
134 static struct timeval mps_chainfail_interval = { 60, 0 };
137 * sleep_flag can be either CAN_SLEEP or NO_SLEEP.
138 * If this function is called from process context, it can sleep
139 * and there is no harm to sleep, in case if this fuction is called
140 * from Interrupt handler, we can not sleep and need NO_SLEEP flag set.
141 * based on sleep flags driver will call either msleep, pause or DELAY.
142 * msleep and pause are of same variant, but pause is used when mps_mtx
143 * is not hold by driver.
147 mps_diag_reset(struct mps_softc *sc,int sleep_flag)
150 int i, error, tries = 0;
151 uint8_t first_wait_done = FALSE;
153 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
155 /* Clear any pending interrupts */
156 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
159 * Force NO_SLEEP for threads prohibited to sleep
160 * e.a Thread from interrupt handler are prohibited to sleep.
162 if (curthread->td_no_sleeping != 0)
163 sleep_flag = NO_SLEEP;
165 mps_dprint(sc, MPS_INIT, "sequence start, sleep_flag= %d\n", sleep_flag);
167 /* Push the magic sequence */
169 while (tries++ < 20) {
170 for (i = 0; i < sizeof(mpt2_reset_magic); i++)
171 mps_regwrite(sc, MPI2_WRITE_SEQUENCE_OFFSET,
172 mpt2_reset_magic[i]);
174 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
175 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
177 else if (sleep_flag == CAN_SLEEP)
178 pause("mpsdiag", hz/10);
182 reg = mps_regread(sc, MPI2_HOST_DIAGNOSTIC_OFFSET);
183 if (reg & MPI2_DIAG_DIAG_WRITE_ENABLE) {
189 mps_dprint(sc, MPS_INIT, "sequence failed, error=%d, exit\n",
194 /* Send the actual reset. XXX need to refresh the reg? */
195 reg |= MPI2_DIAG_RESET_ADAPTER;
196 mps_dprint(sc, MPS_INIT, "sequence success, sending reset, reg= 0x%x\n",
198 mps_regwrite(sc, MPI2_HOST_DIAGNOSTIC_OFFSET, reg);
200 /* Wait up to 300 seconds in 50ms intervals */
202 for (i = 0; i < 6000; i++) {
204 * Wait 50 msec. If this is the first time through, wait 256
205 * msec to satisfy Diag Reset timing requirements.
207 if (first_wait_done) {
208 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
209 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
211 else if (sleep_flag == CAN_SLEEP)
212 pause("mpsdiag", hz/20);
217 first_wait_done = TRUE;
220 * Check for the RESET_ADAPTER bit to be cleared first, then
221 * wait for the RESET state to be cleared, which takes a little
224 reg = mps_regread(sc, MPI2_HOST_DIAGNOSTIC_OFFSET);
225 if (reg & MPI2_DIAG_RESET_ADAPTER) {
228 reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
229 if ((reg & MPI2_IOC_STATE_MASK) != MPI2_IOC_STATE_RESET) {
235 mps_dprint(sc, MPS_INIT, "reset failed, error= %d, exit\n",
240 mps_regwrite(sc, MPI2_WRITE_SEQUENCE_OFFSET, 0x0);
241 mps_dprint(sc, MPS_INIT, "diag reset success, exit\n");
247 mps_message_unit_reset(struct mps_softc *sc, int sleep_flag)
253 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
256 mps_regwrite(sc, MPI2_DOORBELL_OFFSET,
257 MPI2_FUNCTION_IOC_MESSAGE_UNIT_RESET <<
258 MPI2_DOORBELL_FUNCTION_SHIFT);
260 if (mps_wait_db_ack(sc, 5, sleep_flag) != 0) {
261 mps_dprint(sc, MPS_INIT|MPS_FAULT,
262 "Doorbell handshake failed\n");
266 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
271 mps_transition_ready(struct mps_softc *sc)
274 int error, tries = 0;
278 /* If we are in attach call, do not sleep */
279 sleep_flags = (sc->mps_flags & MPS_FLAGS_ATTACH_DONE)
280 ? CAN_SLEEP:NO_SLEEP;
283 mps_dprint(sc, MPS_INIT, "%s entered, sleep_flags= %d\n",
284 __func__, sleep_flags);
286 while (tries++ < 1200) {
287 reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
288 mps_dprint(sc, MPS_INIT, " Doorbell= 0x%x\n", reg);
291 * Ensure the IOC is ready to talk. If it's not, try
294 if (reg & MPI2_DOORBELL_USED) {
295 mps_dprint(sc, MPS_INIT, " Not ready, sending diag "
297 mps_diag_reset(sc, sleep_flags);
302 /* Is the adapter owned by another peer? */
303 if ((reg & MPI2_DOORBELL_WHO_INIT_MASK) ==
304 (MPI2_WHOINIT_PCI_PEER << MPI2_DOORBELL_WHO_INIT_SHIFT)) {
305 mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC is under the "
306 "control of another peer host, aborting "
307 "initialization.\n");
312 state = reg & MPI2_IOC_STATE_MASK;
313 if (state == MPI2_IOC_STATE_READY) {
317 } else if (state == MPI2_IOC_STATE_FAULT) {
318 mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC in fault "
319 "state 0x%x, resetting\n",
320 state & MPI2_DOORBELL_FAULT_CODE_MASK);
321 mps_diag_reset(sc, sleep_flags);
322 } else if (state == MPI2_IOC_STATE_OPERATIONAL) {
323 /* Need to take ownership */
324 mps_message_unit_reset(sc, sleep_flags);
325 } else if (state == MPI2_IOC_STATE_RESET) {
326 /* Wait a bit, IOC might be in transition */
327 mps_dprint(sc, MPS_INIT|MPS_FAULT,
328 "IOC in unexpected reset state\n");
330 mps_dprint(sc, MPS_INIT|MPS_FAULT,
331 "IOC in unknown state 0x%x\n", state);
336 /* Wait 50ms for things to settle down. */
341 mps_dprint(sc, MPS_INIT|MPS_FAULT,
342 "Cannot transition IOC to ready\n");
343 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
349 mps_transition_operational(struct mps_softc *sc)
357 reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
358 mps_dprint(sc, MPS_INIT, "%s entered, Doorbell= 0x%x\n", __func__, reg);
360 state = reg & MPI2_IOC_STATE_MASK;
361 if (state != MPI2_IOC_STATE_READY) {
362 mps_dprint(sc, MPS_INIT, "IOC not ready\n");
363 if ((error = mps_transition_ready(sc)) != 0) {
364 mps_dprint(sc, MPS_INIT|MPS_FAULT,
365 "failed to transition ready, exit\n");
370 error = mps_send_iocinit(sc);
371 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
377 mps_resize_queues(struct mps_softc *sc)
382 * Size the queues. Since the reply queues always need one free
383 * entry, we'll deduct one reply message here. The LSI documents
384 * suggest instead to add a count to the request queue, but I think
385 * that it's better to deduct from reply queue.
387 prireqcr = MAX(1, sc->max_prireqframes);
388 prireqcr = MIN(prireqcr, sc->facts->HighPriorityCredit);
390 reqcr = MAX(2, sc->max_reqframes);
391 reqcr = MIN(reqcr, sc->facts->RequestCredit);
393 sc->num_reqs = prireqcr + reqcr;
394 sc->num_replies = MIN(sc->max_replyframes + sc->max_evtframes,
395 sc->facts->MaxReplyDescriptorPostQueueDepth) - 1;
398 * Figure out the number of MSIx-based queues. If the firmware or
399 * user has done something crazy and not allowed enough credit for
400 * the queues to be useful then don't enable multi-queue.
402 if (sc->facts->MaxMSIxVectors < 2)
405 if (sc->msi_msgs > 1) {
406 sc->msi_msgs = MIN(sc->msi_msgs, mp_ncpus);
407 sc->msi_msgs = MIN(sc->msi_msgs, sc->facts->MaxMSIxVectors);
408 if (sc->num_reqs / sc->msi_msgs < 2)
412 mps_dprint(sc, MPS_INIT, "Sized queues to q=%d reqs=%d replies=%d\n",
413 sc->msi_msgs, sc->num_reqs, sc->num_replies);
417 * This is called during attach and when re-initializing due to a Diag Reset.
418 * IOC Facts is used to allocate many of the structures needed by the driver.
419 * If called from attach, de-allocation is not required because the driver has
420 * not allocated any structures yet, but if called from a Diag Reset, previously
421 * allocated structures based on IOC Facts will need to be freed and re-
422 * allocated bases on the latest IOC Facts.
425 mps_iocfacts_allocate(struct mps_softc *sc, uint8_t attaching)
428 Mpi2IOCFactsReply_t saved_facts;
429 uint8_t saved_mode, reallocating;
431 mps_dprint(sc, MPS_INIT|MPS_TRACE, "%s entered\n", __func__);
433 /* Save old IOC Facts and then only reallocate if Facts have changed */
435 bcopy(sc->facts, &saved_facts, sizeof(MPI2_IOC_FACTS_REPLY));
439 * Get IOC Facts. In all cases throughout this function, panic if doing
440 * a re-initialization and only return the error if attaching so the OS
443 if ((error = mps_get_iocfacts(sc, sc->facts)) != 0) {
445 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to get "
446 "IOC Facts with error %d, exit\n", error);
449 panic("%s failed to get IOC Facts with error %d\n",
454 MPS_DPRINT_PAGE(sc, MPS_XINFO, iocfacts, sc->facts);
456 snprintf(sc->fw_version, sizeof(sc->fw_version),
457 "%02d.%02d.%02d.%02d",
458 sc->facts->FWVersion.Struct.Major,
459 sc->facts->FWVersion.Struct.Minor,
460 sc->facts->FWVersion.Struct.Unit,
461 sc->facts->FWVersion.Struct.Dev);
463 mps_dprint(sc, MPS_INFO, "Firmware: %s, Driver: %s\n", sc->fw_version,
465 mps_dprint(sc, MPS_INFO, "IOCCapabilities: %b\n",
466 sc->facts->IOCCapabilities,
467 "\20" "\3ScsiTaskFull" "\4DiagTrace" "\5SnapBuf" "\6ExtBuf"
468 "\7EEDP" "\10BiDirTarg" "\11Multicast" "\14TransRetry" "\15IR"
469 "\16EventReplay" "\17RaidAccel" "\20MSIXIndex" "\21HostDisc");
472 * If the chip doesn't support event replay then a hard reset will be
473 * required to trigger a full discovery. Do the reset here then
474 * retransition to Ready. A hard reset might have already been done,
475 * but it doesn't hurt to do it again. Only do this if attaching, not
478 if (attaching && ((sc->facts->IOCCapabilities &
479 MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY) == 0)) {
480 mps_dprint(sc, MPS_INIT, "No event replay, reseting\n");
481 mps_diag_reset(sc, NO_SLEEP);
482 if ((error = mps_transition_ready(sc)) != 0) {
483 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to "
484 "transition to ready with error %d, exit\n",
491 * Set flag if IR Firmware is loaded. If the RAID Capability has
492 * changed from the previous IOC Facts, log a warning, but only if
493 * checking this after a Diag Reset and not during attach.
495 saved_mode = sc->ir_firmware;
496 if (sc->facts->IOCCapabilities &
497 MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID)
500 if (sc->ir_firmware != saved_mode) {
501 mps_dprint(sc, MPS_INIT|MPS_FAULT, "new IR/IT mode "
502 "in IOC Facts does not match previous mode\n");
506 /* Only deallocate and reallocate if relevant IOC Facts have changed */
507 reallocating = FALSE;
508 sc->mps_flags &= ~MPS_FLAGS_REALLOCATED;
511 ((saved_facts.MsgVersion != sc->facts->MsgVersion) ||
512 (saved_facts.HeaderVersion != sc->facts->HeaderVersion) ||
513 (saved_facts.MaxChainDepth != sc->facts->MaxChainDepth) ||
514 (saved_facts.RequestCredit != sc->facts->RequestCredit) ||
515 (saved_facts.ProductID != sc->facts->ProductID) ||
516 (saved_facts.IOCCapabilities != sc->facts->IOCCapabilities) ||
517 (saved_facts.IOCRequestFrameSize !=
518 sc->facts->IOCRequestFrameSize) ||
519 (saved_facts.MaxTargets != sc->facts->MaxTargets) ||
520 (saved_facts.MaxSasExpanders != sc->facts->MaxSasExpanders) ||
521 (saved_facts.MaxEnclosures != sc->facts->MaxEnclosures) ||
522 (saved_facts.HighPriorityCredit != sc->facts->HighPriorityCredit) ||
523 (saved_facts.MaxReplyDescriptorPostQueueDepth !=
524 sc->facts->MaxReplyDescriptorPostQueueDepth) ||
525 (saved_facts.ReplyFrameSize != sc->facts->ReplyFrameSize) ||
526 (saved_facts.MaxVolumes != sc->facts->MaxVolumes) ||
527 (saved_facts.MaxPersistentEntries !=
528 sc->facts->MaxPersistentEntries))) {
531 /* Record that we reallocated everything */
532 sc->mps_flags |= MPS_FLAGS_REALLOCATED;
536 * Some things should be done if attaching or re-allocating after a Diag
537 * Reset, but are not needed after a Diag Reset if the FW has not
540 if (attaching || reallocating) {
542 * Check if controller supports FW diag buffers and set flag to
545 if (sc->facts->IOCCapabilities &
546 MPI2_IOCFACTS_CAPABILITY_DIAG_TRACE_BUFFER)
547 sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_TRACE].
549 if (sc->facts->IOCCapabilities &
550 MPI2_IOCFACTS_CAPABILITY_SNAPSHOT_BUFFER)
551 sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_SNAPSHOT].
553 if (sc->facts->IOCCapabilities &
554 MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER)
555 sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_EXTENDED].
559 * Set flag if EEDP is supported and if TLR is supported.
561 if (sc->facts->IOCCapabilities & MPI2_IOCFACTS_CAPABILITY_EEDP)
562 sc->eedp_enabled = TRUE;
563 if (sc->facts->IOCCapabilities & MPI2_IOCFACTS_CAPABILITY_TLR)
564 sc->control_TLR = TRUE;
566 mps_resize_queues(sc);
569 * Initialize all Tail Queues
571 TAILQ_INIT(&sc->req_list);
572 TAILQ_INIT(&sc->high_priority_req_list);
573 TAILQ_INIT(&sc->chain_list);
574 TAILQ_INIT(&sc->tm_list);
578 * If doing a Diag Reset and the FW is significantly different
579 * (reallocating will be set above in IOC Facts comparison), then all
580 * buffers based on the IOC Facts will need to be freed before they are
584 mps_iocfacts_free(sc);
585 mpssas_realloc_targets(sc, saved_facts.MaxTargets +
586 saved_facts.MaxVolumes);
590 * Any deallocation has been completed. Now start reallocating
591 * if needed. Will only need to reallocate if attaching or if the new
592 * IOC Facts are different from the previous IOC Facts after a Diag
593 * Reset. Targets have already been allocated above if needed.
596 while (attaching || reallocating) {
597 if ((error = mps_alloc_hw_queues(sc)) != 0)
599 if ((error = mps_alloc_replies(sc)) != 0)
601 if ((error = mps_alloc_requests(sc)) != 0)
603 if ((error = mps_alloc_queues(sc)) != 0)
609 mps_dprint(sc, MPS_INIT|MPS_FAULT,
610 "Failed to alloc queues with error %d\n", error);
615 /* Always initialize the queues */
616 bzero(sc->free_queue, sc->fqdepth * 4);
620 * Always get the chip out of the reset state, but only panic if not
621 * attaching. If attaching and there is an error, that is handled by
624 error = mps_transition_operational(sc);
626 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to "
627 "transition to operational with error %d\n", error);
633 * Finish the queue initialization.
634 * These are set here instead of in mps_init_queues() because the
635 * IOC resets these values during the state transition in
636 * mps_transition_operational(). The free index is set to 1
637 * because the corresponding index in the IOC is set to 0, and the
638 * IOC treats the queues as full if both are set to the same value.
639 * Hence the reason that the queue can't hold all of the possible
642 sc->replypostindex = 0;
643 mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
644 mps_regwrite(sc, MPI2_REPLY_POST_HOST_INDEX_OFFSET, 0);
647 * Attach the subsystems so they can prepare their event masks.
648 * XXX Should be dynamic so that IM/IR and user modules can attach
652 mps_dprint(sc, MPS_INIT, "Attaching subsystems\n");
653 if ((error = mps_attach_log(sc)) != 0)
655 if ((error = mps_attach_sas(sc)) != 0)
657 if ((error = mps_attach_user(sc)) != 0)
662 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to attach all "
663 "subsystems: error %d\n", error);
669 * XXX If the number of MSI-X vectors changes during re-init, this
670 * won't see it and adjust.
672 if (attaching && (error = mps_pci_setup_interrupts(sc)) != 0) {
673 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to setup "
680 * Set flag if this is a WD controller. This shouldn't ever change, but
681 * reset it after a Diag Reset, just in case.
683 sc->WD_available = FALSE;
684 if (pci_get_device(sc->mps_dev) == MPI2_MFGPAGE_DEVID_SSS6200)
685 sc->WD_available = TRUE;
691 * This is called if memory is being free (during detach for example) and when
692 * buffers need to be reallocated due to a Diag Reset.
695 mps_iocfacts_free(struct mps_softc *sc)
697 struct mps_command *cm;
700 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
702 if (sc->free_busaddr != 0)
703 bus_dmamap_unload(sc->queues_dmat, sc->queues_map);
704 if (sc->free_queue != NULL)
705 bus_dmamem_free(sc->queues_dmat, sc->free_queue,
707 if (sc->queues_dmat != NULL)
708 bus_dma_tag_destroy(sc->queues_dmat);
710 if (sc->chain_busaddr != 0)
711 bus_dmamap_unload(sc->chain_dmat, sc->chain_map);
712 if (sc->chain_frames != NULL)
713 bus_dmamem_free(sc->chain_dmat, sc->chain_frames,
715 if (sc->chain_dmat != NULL)
716 bus_dma_tag_destroy(sc->chain_dmat);
718 if (sc->sense_busaddr != 0)
719 bus_dmamap_unload(sc->sense_dmat, sc->sense_map);
720 if (sc->sense_frames != NULL)
721 bus_dmamem_free(sc->sense_dmat, sc->sense_frames,
723 if (sc->sense_dmat != NULL)
724 bus_dma_tag_destroy(sc->sense_dmat);
726 if (sc->reply_busaddr != 0)
727 bus_dmamap_unload(sc->reply_dmat, sc->reply_map);
728 if (sc->reply_frames != NULL)
729 bus_dmamem_free(sc->reply_dmat, sc->reply_frames,
731 if (sc->reply_dmat != NULL)
732 bus_dma_tag_destroy(sc->reply_dmat);
734 if (sc->req_busaddr != 0)
735 bus_dmamap_unload(sc->req_dmat, sc->req_map);
736 if (sc->req_frames != NULL)
737 bus_dmamem_free(sc->req_dmat, sc->req_frames, sc->req_map);
738 if (sc->req_dmat != NULL)
739 bus_dma_tag_destroy(sc->req_dmat);
741 if (sc->chains != NULL)
742 free(sc->chains, M_MPT2);
743 if (sc->commands != NULL) {
744 for (i = 1; i < sc->num_reqs; i++) {
745 cm = &sc->commands[i];
746 bus_dmamap_destroy(sc->buffer_dmat, cm->cm_dmamap);
748 free(sc->commands, M_MPT2);
750 if (sc->buffer_dmat != NULL)
751 bus_dma_tag_destroy(sc->buffer_dmat);
753 mps_pci_free_interrupts(sc);
754 free(sc->queues, M_MPT2);
759 * The terms diag reset and hard reset are used interchangeably in the MPI
760 * docs to mean resetting the controller chip. In this code diag reset
761 * cleans everything up, and the hard reset function just sends the reset
762 * sequence to the chip. This should probably be refactored so that every
763 * subsystem gets a reset notification of some sort, and can clean up
767 mps_reinit(struct mps_softc *sc)
770 struct mpssas_softc *sassc;
776 mtx_assert(&sc->mps_mtx, MA_OWNED);
778 mps_dprint(sc, MPS_INIT|MPS_INFO, "Reinitializing controller\n");
779 if (sc->mps_flags & MPS_FLAGS_DIAGRESET) {
780 mps_dprint(sc, MPS_INIT, "Reset already in progress\n");
784 /* make sure the completion callbacks can recognize they're getting
785 * a NULL cm_reply due to a reset.
787 sc->mps_flags |= MPS_FLAGS_DIAGRESET;
790 * Mask interrupts here.
792 mps_dprint(sc, MPS_INIT, "masking interrupts and resetting\n");
795 error = mps_diag_reset(sc, CAN_SLEEP);
797 /* XXXSL No need to panic here */
798 panic("%s hard reset failed with error %d\n",
802 /* Restore the PCI state, including the MSI-X registers */
805 /* Give the I/O subsystem special priority to get itself prepared */
806 mpssas_handle_reinit(sc);
809 * Get IOC Facts and allocate all structures based on this information.
810 * The attach function will also call mps_iocfacts_allocate at startup.
811 * If relevant values have changed in IOC Facts, this function will free
812 * all of the memory based on IOC Facts and reallocate that memory.
814 if ((error = mps_iocfacts_allocate(sc, FALSE)) != 0) {
815 panic("%s IOC Facts based allocation failed with error %d\n",
820 * Mapping structures will be re-allocated after getting IOC Page8, so
821 * free these structures here.
823 mps_mapping_exit(sc);
826 * The static page function currently read is IOC Page8. Others can be
827 * added in future. It's possible that the values in IOC Page8 have
828 * changed after a Diag Reset due to user modification, so always read
829 * these. Interrupts are masked, so unmask them before getting config
833 sc->mps_flags &= ~MPS_FLAGS_DIAGRESET;
834 mps_base_static_config_pages(sc);
837 * Some mapping info is based in IOC Page8 data, so re-initialize the
840 mps_mapping_initialize(sc);
843 * Restart will reload the event masks clobbered by the reset, and
844 * then enable the port.
846 mps_reregister_events(sc);
848 /* the end of discovery will release the simq, so we're done. */
849 mps_dprint(sc, MPS_INIT|MPS_XINFO, "Finished sc %p post %u free %u\n",
850 sc, sc->replypostindex, sc->replyfreeindex);
852 mpssas_release_simq_reinit(sassc);
853 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
858 /* Wait for the chip to ACK a word that we've put into its FIFO
859 * Wait for <timeout> seconds. In single loop wait for busy loop
860 * for 500 microseconds.
861 * Total is [ 0.5 * (2000 * <timeout>) ] in miliseconds.
864 mps_wait_db_ack(struct mps_softc *sc, int timeout, int sleep_flag)
872 cntdn = (sleep_flag == CAN_SLEEP) ? 1000*timeout : 2000*timeout;
874 int_status = mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET);
875 if (!(int_status & MPI2_HIS_SYS2IOC_DB_STATUS)) {
876 mps_dprint(sc, MPS_TRACE,
877 "%s: successful count(%d), timeout(%d)\n",
878 __func__, count, timeout);
880 } else if (int_status & MPI2_HIS_IOC2SYS_DB_STATUS) {
881 doorbell = mps_regread(sc, MPI2_DOORBELL_OFFSET);
882 if ((doorbell & MPI2_IOC_STATE_MASK) ==
883 MPI2_IOC_STATE_FAULT) {
884 mps_dprint(sc, MPS_FAULT,
885 "fault_state(0x%04x)!\n", doorbell);
888 } else if (int_status == 0xFFFFFFFF)
891 /* If it can sleep, sleep for 1 milisecond, else busy loop for
893 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
894 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
896 else if (sleep_flag == CAN_SLEEP)
897 pause("mpsdba", hz/1000);
904 mps_dprint(sc, MPS_FAULT, "%s: failed due to timeout count(%d), "
905 "int_status(%x)!\n", __func__, count, int_status);
910 /* Wait for the chip to signal that the next word in its FIFO can be fetched */
912 mps_wait_db_int(struct mps_softc *sc)
916 for (retry = 0; retry < MPS_DB_MAX_WAIT; retry++) {
917 if ((mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET) &
918 MPI2_HIS_IOC2SYS_DB_STATUS) != 0)
925 /* Step through the synchronous command state machine, i.e. "Doorbell mode" */
927 mps_request_sync(struct mps_softc *sc, void *req, MPI2_DEFAULT_REPLY *reply,
928 int req_sz, int reply_sz, int timeout)
932 int i, count, ioc_sz, residual;
933 int sleep_flags = CAN_SLEEP;
935 if (curthread->td_no_sleeping != 0)
936 sleep_flags = NO_SLEEP;
939 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
942 if (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED)
946 * Announce that a message is coming through the doorbell. Messages
947 * are pushed at 32bit words, so round up if needed.
949 count = (req_sz + 3) / 4;
950 mps_regwrite(sc, MPI2_DOORBELL_OFFSET,
951 (MPI2_FUNCTION_HANDSHAKE << MPI2_DOORBELL_FUNCTION_SHIFT) |
952 (count << MPI2_DOORBELL_ADD_DWORDS_SHIFT));
955 if (mps_wait_db_int(sc) ||
956 (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED) == 0) {
957 mps_dprint(sc, MPS_FAULT, "Doorbell failed to activate\n");
960 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
961 if (mps_wait_db_ack(sc, 5, sleep_flags) != 0) {
962 mps_dprint(sc, MPS_FAULT, "Doorbell handshake failed\n");
967 /* Clock out the message data synchronously in 32-bit dwords*/
968 data32 = (uint32_t *)req;
969 for (i = 0; i < count; i++) {
970 mps_regwrite(sc, MPI2_DOORBELL_OFFSET, htole32(data32[i]));
971 if (mps_wait_db_ack(sc, 5, sleep_flags) != 0) {
972 mps_dprint(sc, MPS_FAULT,
973 "Timeout while writing doorbell\n");
979 /* Clock in the reply in 16-bit words. The total length of the
980 * message is always in the 4th byte, so clock out the first 2 words
981 * manually, then loop the rest.
983 data16 = (uint16_t *)reply;
984 if (mps_wait_db_int(sc) != 0) {
985 mps_dprint(sc, MPS_FAULT, "Timeout reading doorbell 0\n");
989 mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_DATA_MASK;
990 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
991 if (mps_wait_db_int(sc) != 0) {
992 mps_dprint(sc, MPS_FAULT, "Timeout reading doorbell 1\n");
996 mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_DATA_MASK;
997 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
999 /* Number of 32bit words in the message */
1000 ioc_sz = reply->MsgLength;
1003 * Figure out how many 16bit words to clock in without overrunning.
1004 * The precision loss with dividing reply_sz can safely be
1005 * ignored because the messages can only be multiples of 32bits.
1008 count = MIN((reply_sz / 4), ioc_sz) * 2;
1009 if (count < ioc_sz * 2) {
1010 residual = ioc_sz * 2 - count;
1011 mps_dprint(sc, MPS_ERROR, "Driver error, throwing away %d "
1012 "residual message words\n", residual);
1015 for (i = 2; i < count; i++) {
1016 if (mps_wait_db_int(sc) != 0) {
1017 mps_dprint(sc, MPS_FAULT,
1018 "Timeout reading doorbell %d\n", i);
1021 data16[i] = mps_regread(sc, MPI2_DOORBELL_OFFSET) &
1022 MPI2_DOORBELL_DATA_MASK;
1023 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1027 * Pull out residual words that won't fit into the provided buffer.
1028 * This keeps the chip from hanging due to a driver programming
1031 while (residual--) {
1032 if (mps_wait_db_int(sc) != 0) {
1033 mps_dprint(sc, MPS_FAULT,
1034 "Timeout reading doorbell\n");
1037 (void)mps_regread(sc, MPI2_DOORBELL_OFFSET);
1038 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1042 if (mps_wait_db_int(sc) != 0) {
1043 mps_dprint(sc, MPS_FAULT, "Timeout waiting to exit doorbell\n");
1046 if (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED)
1047 mps_dprint(sc, MPS_FAULT, "Warning, doorbell still active\n");
1048 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1054 mps_enqueue_request(struct mps_softc *sc, struct mps_command *cm)
1056 reply_descriptor rd;
1058 mps_dprint(sc, MPS_TRACE, "SMID %u cm %p ccb %p\n",
1059 cm->cm_desc.Default.SMID, cm, cm->cm_ccb);
1061 if (sc->mps_flags & MPS_FLAGS_ATTACH_DONE && !(sc->mps_flags & MPS_FLAGS_SHUTDOWN))
1062 mtx_assert(&sc->mps_mtx, MA_OWNED);
1064 if (++sc->io_cmds_active > sc->io_cmds_highwater)
1065 sc->io_cmds_highwater++;
1066 rd.u.low = cm->cm_desc.Words.Low;
1067 rd.u.high = cm->cm_desc.Words.High;
1068 rd.word = htole64(rd.word);
1069 /* TODO-We may need to make below regwrite atomic */
1070 mps_regwrite(sc, MPI2_REQUEST_DESCRIPTOR_POST_LOW_OFFSET,
1072 mps_regwrite(sc, MPI2_REQUEST_DESCRIPTOR_POST_HIGH_OFFSET,
1077 * Just the FACTS, ma'am.
1080 mps_get_iocfacts(struct mps_softc *sc, MPI2_IOC_FACTS_REPLY *facts)
1082 MPI2_DEFAULT_REPLY *reply;
1083 MPI2_IOC_FACTS_REQUEST request;
1084 int error, req_sz, reply_sz;
1087 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1089 req_sz = sizeof(MPI2_IOC_FACTS_REQUEST);
1090 reply_sz = sizeof(MPI2_IOC_FACTS_REPLY);
1091 reply = (MPI2_DEFAULT_REPLY *)facts;
1093 bzero(&request, req_sz);
1094 request.Function = MPI2_FUNCTION_IOC_FACTS;
1095 error = mps_request_sync(sc, &request, reply, req_sz, reply_sz, 5);
1096 mps_dprint(sc, MPS_INIT, "%s exit error= %d\n", __func__, error);
1102 mps_send_iocinit(struct mps_softc *sc)
1104 MPI2_IOC_INIT_REQUEST init;
1105 MPI2_DEFAULT_REPLY reply;
1106 int req_sz, reply_sz, error;
1108 uint64_t time_in_msec;
1111 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1113 req_sz = sizeof(MPI2_IOC_INIT_REQUEST);
1114 reply_sz = sizeof(MPI2_IOC_INIT_REPLY);
1115 bzero(&init, req_sz);
1116 bzero(&reply, reply_sz);
1119 * Fill in the init block. Note that most addresses are
1120 * deliberately in the lower 32bits of memory. This is a micro-
1121 * optimzation for PCI/PCIX, though it's not clear if it helps PCIe.
1123 init.Function = MPI2_FUNCTION_IOC_INIT;
1124 init.WhoInit = MPI2_WHOINIT_HOST_DRIVER;
1125 init.MsgVersion = htole16(MPI2_VERSION);
1126 init.HeaderVersion = htole16(MPI2_HEADER_VERSION);
1127 init.SystemRequestFrameSize = htole16(sc->facts->IOCRequestFrameSize);
1128 init.ReplyDescriptorPostQueueDepth = htole16(sc->pqdepth);
1129 init.ReplyFreeQueueDepth = htole16(sc->fqdepth);
1130 init.SenseBufferAddressHigh = 0;
1131 init.SystemReplyAddressHigh = 0;
1132 init.SystemRequestFrameBaseAddress.High = 0;
1133 init.SystemRequestFrameBaseAddress.Low = htole32((uint32_t)sc->req_busaddr);
1134 init.ReplyDescriptorPostQueueAddress.High = 0;
1135 init.ReplyDescriptorPostQueueAddress.Low = htole32((uint32_t)sc->post_busaddr);
1136 init.ReplyFreeQueueAddress.High = 0;
1137 init.ReplyFreeQueueAddress.Low = htole32((uint32_t)sc->free_busaddr);
1139 time_in_msec = (now.tv_sec * 1000 + now.tv_usec/1000);
1140 init.TimeStamp.High = htole32((time_in_msec >> 32) & 0xFFFFFFFF);
1141 init.TimeStamp.Low = htole32(time_in_msec & 0xFFFFFFFF);
1143 error = mps_request_sync(sc, &init, &reply, req_sz, reply_sz, 5);
1144 if ((reply.IOCStatus & MPI2_IOCSTATUS_MASK) != MPI2_IOCSTATUS_SUCCESS)
1147 mps_dprint(sc, MPS_INIT, "IOCInit status= 0x%x\n", reply.IOCStatus);
1148 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
1153 mps_memaddr_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
1158 *addr = segs[0].ds_addr;
1162 mps_alloc_queues(struct mps_softc *sc)
1164 struct mps_queue *q;
1168 mps_dprint(sc, MPS_INIT|MPS_XINFO, "Allocating %d I/O queues\n", nq);
1170 sc->queues = malloc(sizeof(struct mps_queue) * nq, M_MPT2,
1172 if (sc->queues == NULL)
1175 for (i = 0; i < nq; i++) {
1177 mps_dprint(sc, MPS_INIT, "Configuring queue %d %p\n", i, q);
1186 mps_alloc_hw_queues(struct mps_softc *sc)
1188 bus_addr_t queues_busaddr;
1190 int qsize, fqsize, pqsize;
1193 * The reply free queue contains 4 byte entries in multiples of 16 and
1194 * aligned on a 16 byte boundary. There must always be an unused entry.
1195 * This queue supplies fresh reply frames for the firmware to use.
1197 * The reply descriptor post queue contains 8 byte entries in
1198 * multiples of 16 and aligned on a 16 byte boundary. This queue
1199 * contains filled-in reply frames sent from the firmware to the host.
1201 * These two queues are allocated together for simplicity.
1203 sc->fqdepth = roundup2(sc->num_replies + 1, 16);
1204 sc->pqdepth = roundup2(sc->num_replies + 1, 16);
1205 fqsize= sc->fqdepth * 4;
1206 pqsize = sc->pqdepth * 8;
1207 qsize = fqsize + pqsize;
1209 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1210 16, 0, /* algnmnt, boundary */
1211 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1212 BUS_SPACE_MAXADDR, /* highaddr */
1213 NULL, NULL, /* filter, filterarg */
1214 qsize, /* maxsize */
1216 qsize, /* maxsegsize */
1218 NULL, NULL, /* lockfunc, lockarg */
1219 &sc->queues_dmat)) {
1220 mps_dprint(sc, MPS_ERROR, "Cannot allocate queues DMA tag\n");
1223 if (bus_dmamem_alloc(sc->queues_dmat, (void **)&queues, BUS_DMA_NOWAIT,
1225 mps_dprint(sc, MPS_ERROR, "Cannot allocate queues memory\n");
1228 bzero(queues, qsize);
1229 bus_dmamap_load(sc->queues_dmat, sc->queues_map, queues, qsize,
1230 mps_memaddr_cb, &queues_busaddr, 0);
1232 sc->free_queue = (uint32_t *)queues;
1233 sc->free_busaddr = queues_busaddr;
1234 sc->post_queue = (MPI2_REPLY_DESCRIPTORS_UNION *)(queues + fqsize);
1235 sc->post_busaddr = queues_busaddr + fqsize;
1241 mps_alloc_replies(struct mps_softc *sc)
1243 int rsize, num_replies;
1246 * sc->num_replies should be one less than sc->fqdepth. We need to
1247 * allocate space for sc->fqdepth replies, but only sc->num_replies
1248 * replies can be used at once.
1250 num_replies = max(sc->fqdepth, sc->num_replies);
1252 rsize = sc->facts->ReplyFrameSize * num_replies * 4;
1253 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1254 4, 0, /* algnmnt, boundary */
1255 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1256 BUS_SPACE_MAXADDR, /* highaddr */
1257 NULL, NULL, /* filter, filterarg */
1258 rsize, /* maxsize */
1260 rsize, /* maxsegsize */
1262 NULL, NULL, /* lockfunc, lockarg */
1264 mps_dprint(sc, MPS_ERROR, "Cannot allocate replies DMA tag\n");
1267 if (bus_dmamem_alloc(sc->reply_dmat, (void **)&sc->reply_frames,
1268 BUS_DMA_NOWAIT, &sc->reply_map)) {
1269 mps_dprint(sc, MPS_ERROR, "Cannot allocate replies memory\n");
1272 bzero(sc->reply_frames, rsize);
1273 bus_dmamap_load(sc->reply_dmat, sc->reply_map, sc->reply_frames, rsize,
1274 mps_memaddr_cb, &sc->reply_busaddr, 0);
1280 mps_alloc_requests(struct mps_softc *sc)
1282 struct mps_command *cm;
1283 struct mps_chain *chain;
1284 int i, rsize, nsegs;
1286 rsize = sc->facts->IOCRequestFrameSize * sc->num_reqs * 4;
1287 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1288 16, 0, /* algnmnt, boundary */
1289 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1290 BUS_SPACE_MAXADDR, /* highaddr */
1291 NULL, NULL, /* filter, filterarg */
1292 rsize, /* maxsize */
1294 rsize, /* maxsegsize */
1296 NULL, NULL, /* lockfunc, lockarg */
1298 mps_dprint(sc, MPS_ERROR, "Cannot allocate request DMA tag\n");
1301 if (bus_dmamem_alloc(sc->req_dmat, (void **)&sc->req_frames,
1302 BUS_DMA_NOWAIT, &sc->req_map)) {
1303 mps_dprint(sc, MPS_ERROR, "Cannot allocate request memory\n");
1306 bzero(sc->req_frames, rsize);
1307 bus_dmamap_load(sc->req_dmat, sc->req_map, sc->req_frames, rsize,
1308 mps_memaddr_cb, &sc->req_busaddr, 0);
1310 rsize = sc->facts->IOCRequestFrameSize * sc->max_chains * 4;
1311 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1312 16, 0, /* algnmnt, boundary */
1313 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1314 BUS_SPACE_MAXADDR, /* highaddr */
1315 NULL, NULL, /* filter, filterarg */
1316 rsize, /* maxsize */
1318 rsize, /* maxsegsize */
1320 NULL, NULL, /* lockfunc, lockarg */
1322 mps_dprint(sc, MPS_ERROR, "Cannot allocate chain DMA tag\n");
1325 if (bus_dmamem_alloc(sc->chain_dmat, (void **)&sc->chain_frames,
1326 BUS_DMA_NOWAIT, &sc->chain_map)) {
1327 mps_dprint(sc, MPS_ERROR, "Cannot allocate chain memory\n");
1330 bzero(sc->chain_frames, rsize);
1331 bus_dmamap_load(sc->chain_dmat, sc->chain_map, sc->chain_frames, rsize,
1332 mps_memaddr_cb, &sc->chain_busaddr, 0);
1334 rsize = MPS_SENSE_LEN * sc->num_reqs;
1335 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1336 1, 0, /* algnmnt, boundary */
1337 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1338 BUS_SPACE_MAXADDR, /* highaddr */
1339 NULL, NULL, /* filter, filterarg */
1340 rsize, /* maxsize */
1342 rsize, /* maxsegsize */
1344 NULL, NULL, /* lockfunc, lockarg */
1346 mps_dprint(sc, MPS_ERROR, "Cannot allocate sense DMA tag\n");
1349 if (bus_dmamem_alloc(sc->sense_dmat, (void **)&sc->sense_frames,
1350 BUS_DMA_NOWAIT, &sc->sense_map)) {
1351 mps_dprint(sc, MPS_ERROR, "Cannot allocate sense memory\n");
1354 bzero(sc->sense_frames, rsize);
1355 bus_dmamap_load(sc->sense_dmat, sc->sense_map, sc->sense_frames, rsize,
1356 mps_memaddr_cb, &sc->sense_busaddr, 0);
1358 sc->chains = malloc(sizeof(struct mps_chain) * sc->max_chains, M_MPT2,
1361 mps_dprint(sc, MPS_ERROR, "Cannot allocate chains memory\n");
1364 for (i = 0; i < sc->max_chains; i++) {
1365 chain = &sc->chains[i];
1366 chain->chain = (MPI2_SGE_IO_UNION *)(sc->chain_frames +
1367 i * sc->facts->IOCRequestFrameSize * 4);
1368 chain->chain_busaddr = sc->chain_busaddr +
1369 i * sc->facts->IOCRequestFrameSize * 4;
1370 mps_free_chain(sc, chain);
1371 sc->chain_free_lowwater++;
1374 /* XXX Need to pick a more precise value */
1375 nsegs = (MAXPHYS / PAGE_SIZE) + 1;
1376 if (bus_dma_tag_create( sc->mps_parent_dmat, /* parent */
1377 1, 0, /* algnmnt, boundary */
1378 BUS_SPACE_MAXADDR, /* lowaddr */
1379 BUS_SPACE_MAXADDR, /* highaddr */
1380 NULL, NULL, /* filter, filterarg */
1381 BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
1382 nsegs, /* nsegments */
1383 BUS_SPACE_MAXSIZE_24BIT,/* maxsegsize */
1384 BUS_DMA_ALLOCNOW, /* flags */
1385 busdma_lock_mutex, /* lockfunc */
1386 &sc->mps_mtx, /* lockarg */
1387 &sc->buffer_dmat)) {
1388 mps_dprint(sc, MPS_ERROR, "Cannot allocate buffer DMA tag\n");
1393 * SMID 0 cannot be used as a free command per the firmware spec.
1394 * Just drop that command instead of risking accounting bugs.
1396 sc->commands = malloc(sizeof(struct mps_command) * sc->num_reqs,
1397 M_MPT2, M_WAITOK | M_ZERO);
1399 mps_dprint(sc, MPS_ERROR, "Cannot allocate command memory\n");
1402 for (i = 1; i < sc->num_reqs; i++) {
1403 cm = &sc->commands[i];
1404 cm->cm_req = sc->req_frames +
1405 i * sc->facts->IOCRequestFrameSize * 4;
1406 cm->cm_req_busaddr = sc->req_busaddr +
1407 i * sc->facts->IOCRequestFrameSize * 4;
1408 cm->cm_sense = &sc->sense_frames[i];
1409 cm->cm_sense_busaddr = sc->sense_busaddr + i * MPS_SENSE_LEN;
1410 cm->cm_desc.Default.SMID = i;
1412 TAILQ_INIT(&cm->cm_chain_list);
1413 callout_init_mtx(&cm->cm_callout, &sc->mps_mtx, 0);
1415 /* XXX Is a failure here a critical problem? */
1416 if (bus_dmamap_create(sc->buffer_dmat, 0, &cm->cm_dmamap) == 0)
1417 if (i <= sc->facts->HighPriorityCredit)
1418 mps_free_high_priority_command(sc, cm);
1420 mps_free_command(sc, cm);
1422 panic("failed to allocate command %d\n", i);
1432 mps_init_queues(struct mps_softc *sc)
1436 memset((uint8_t *)sc->post_queue, 0xff, sc->pqdepth * 8);
1439 * According to the spec, we need to use one less reply than we
1440 * have space for on the queue. So sc->num_replies (the number we
1441 * use) should be less than sc->fqdepth (allocated size).
1443 if (sc->num_replies >= sc->fqdepth)
1447 * Initialize all of the free queue entries.
1449 for (i = 0; i < sc->fqdepth; i++)
1450 sc->free_queue[i] = sc->reply_busaddr + (i * sc->facts->ReplyFrameSize * 4);
1451 sc->replyfreeindex = sc->num_replies;
1456 /* Get the driver parameter tunables. Lowest priority are the driver defaults.
1457 * Next are the global settings, if they exist. Highest are the per-unit
1458 * settings, if they exist.
1461 mps_get_tunables(struct mps_softc *sc)
1463 char tmpstr[80], mps_debug[80];
1465 /* XXX default to some debugging for now */
1466 sc->mps_debug = MPS_INFO|MPS_FAULT;
1467 sc->disable_msix = 0;
1468 sc->disable_msi = 0;
1469 sc->max_msix = MPS_MSIX_MAX;
1470 sc->max_chains = MPS_CHAIN_FRAMES;
1471 sc->max_io_pages = MPS_MAXIO_PAGES;
1472 sc->enable_ssu = MPS_SSU_ENABLE_SSD_DISABLE_HDD;
1473 sc->spinup_wait_time = DEFAULT_SPINUP_WAIT;
1475 sc->max_reqframes = MPS_REQ_FRAMES;
1476 sc->max_prireqframes = MPS_PRI_REQ_FRAMES;
1477 sc->max_replyframes = MPS_REPLY_FRAMES;
1478 sc->max_evtframes = MPS_EVT_REPLY_FRAMES;
1481 * Grab the global variables.
1483 bzero(mps_debug, 80);
1484 if (TUNABLE_STR_FETCH("hw.mps.debug_level", mps_debug, 80) != 0)
1485 mps_parse_debug(sc, mps_debug);
1486 TUNABLE_INT_FETCH("hw.mps.disable_msix", &sc->disable_msix);
1487 TUNABLE_INT_FETCH("hw.mps.disable_msi", &sc->disable_msi);
1488 TUNABLE_INT_FETCH("hw.mps.max_msix", &sc->max_msix);
1489 TUNABLE_INT_FETCH("hw.mps.max_chains", &sc->max_chains);
1490 TUNABLE_INT_FETCH("hw.mps.max_io_pages", &sc->max_io_pages);
1491 TUNABLE_INT_FETCH("hw.mps.enable_ssu", &sc->enable_ssu);
1492 TUNABLE_INT_FETCH("hw.mps.spinup_wait_time", &sc->spinup_wait_time);
1493 TUNABLE_INT_FETCH("hw.mps.use_phy_num", &sc->use_phynum);
1494 TUNABLE_INT_FETCH("hw.mps.max_reqframes", &sc->max_reqframes);
1495 TUNABLE_INT_FETCH("hw.mps.max_prireqframes", &sc->max_prireqframes);
1496 TUNABLE_INT_FETCH("hw.mps.max_replyframes", &sc->max_replyframes);
1497 TUNABLE_INT_FETCH("hw.mps.max_evtframes", &sc->max_evtframes);
1499 /* Grab the unit-instance variables */
1500 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.debug_level",
1501 device_get_unit(sc->mps_dev));
1502 bzero(mps_debug, 80);
1503 if (TUNABLE_STR_FETCH(tmpstr, mps_debug, 80) != 0)
1504 mps_parse_debug(sc, mps_debug);
1506 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.disable_msix",
1507 device_get_unit(sc->mps_dev));
1508 TUNABLE_INT_FETCH(tmpstr, &sc->disable_msix);
1510 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.disable_msi",
1511 device_get_unit(sc->mps_dev));
1512 TUNABLE_INT_FETCH(tmpstr, &sc->disable_msi);
1514 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_msix",
1515 device_get_unit(sc->mps_dev));
1516 TUNABLE_INT_FETCH(tmpstr, &sc->max_msix);
1518 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_chains",
1519 device_get_unit(sc->mps_dev));
1520 TUNABLE_INT_FETCH(tmpstr, &sc->max_chains);
1522 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_io_pages",
1523 device_get_unit(sc->mps_dev));
1524 TUNABLE_INT_FETCH(tmpstr, &sc->max_io_pages);
1526 bzero(sc->exclude_ids, sizeof(sc->exclude_ids));
1527 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.exclude_ids",
1528 device_get_unit(sc->mps_dev));
1529 TUNABLE_STR_FETCH(tmpstr, sc->exclude_ids, sizeof(sc->exclude_ids));
1531 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.enable_ssu",
1532 device_get_unit(sc->mps_dev));
1533 TUNABLE_INT_FETCH(tmpstr, &sc->enable_ssu);
1535 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.spinup_wait_time",
1536 device_get_unit(sc->mps_dev));
1537 TUNABLE_INT_FETCH(tmpstr, &sc->spinup_wait_time);
1539 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.use_phy_num",
1540 device_get_unit(sc->mps_dev));
1541 TUNABLE_INT_FETCH(tmpstr, &sc->use_phynum);
1543 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_reqframes",
1544 device_get_unit(sc->mps_dev));
1545 TUNABLE_INT_FETCH(tmpstr, &sc->max_reqframes);
1547 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_prireqframes",
1548 device_get_unit(sc->mps_dev));
1549 TUNABLE_INT_FETCH(tmpstr, &sc->max_prireqframes);
1551 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_replyframes",
1552 device_get_unit(sc->mps_dev));
1553 TUNABLE_INT_FETCH(tmpstr, &sc->max_replyframes);
1555 snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_evtframes",
1556 device_get_unit(sc->mps_dev));
1557 TUNABLE_INT_FETCH(tmpstr, &sc->max_evtframes);
1562 mps_setup_sysctl(struct mps_softc *sc)
1564 struct sysctl_ctx_list *sysctl_ctx = NULL;
1565 struct sysctl_oid *sysctl_tree = NULL;
1566 char tmpstr[80], tmpstr2[80];
1569 * Setup the sysctl variable so the user can change the debug level
1572 snprintf(tmpstr, sizeof(tmpstr), "MPS controller %d",
1573 device_get_unit(sc->mps_dev));
1574 snprintf(tmpstr2, sizeof(tmpstr2), "%d", device_get_unit(sc->mps_dev));
1576 sysctl_ctx = device_get_sysctl_ctx(sc->mps_dev);
1577 if (sysctl_ctx != NULL)
1578 sysctl_tree = device_get_sysctl_tree(sc->mps_dev);
1580 if (sysctl_tree == NULL) {
1581 sysctl_ctx_init(&sc->sysctl_ctx);
1582 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
1583 SYSCTL_STATIC_CHILDREN(_hw_mps), OID_AUTO, tmpstr2,
1584 CTLFLAG_RD, 0, tmpstr);
1585 if (sc->sysctl_tree == NULL)
1587 sysctl_ctx = &sc->sysctl_ctx;
1588 sysctl_tree = sc->sysctl_tree;
1591 SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1592 OID_AUTO, "debug_level", CTLTYPE_STRING | CTLFLAG_RW |CTLFLAG_MPSAFE,
1593 sc, 0, mps_debug_sysctl, "A", "mps debug level");
1595 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1596 OID_AUTO, "disable_msix", CTLFLAG_RD, &sc->disable_msix, 0,
1597 "Disable the use of MSI-X interrupts");
1599 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1600 OID_AUTO, "disable_msi", CTLFLAG_RD, &sc->disable_msi, 0,
1601 "Disable the use of MSI interrupts");
1603 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1604 OID_AUTO, "max_msix", CTLFLAG_RD, &sc->max_msix, 0,
1605 "User-defined maximum number of MSIX queues");
1607 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1608 OID_AUTO, "msix_msgs", CTLFLAG_RD, &sc->msi_msgs, 0,
1609 "Negotiated number of MSIX queues");
1611 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1612 OID_AUTO, "max_reqframes", CTLFLAG_RD, &sc->max_reqframes, 0,
1613 "Total number of allocated request frames");
1615 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1616 OID_AUTO, "max_prireqframes", CTLFLAG_RD, &sc->max_prireqframes, 0,
1617 "Total number of allocated high priority request frames");
1619 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1620 OID_AUTO, "max_replyframes", CTLFLAG_RD, &sc->max_replyframes, 0,
1621 "Total number of allocated reply frames");
1623 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1624 OID_AUTO, "max_evtframes", CTLFLAG_RD, &sc->max_evtframes, 0,
1625 "Total number of event frames allocated");
1627 SYSCTL_ADD_STRING(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1628 OID_AUTO, "firmware_version", CTLFLAG_RW, sc->fw_version,
1629 strlen(sc->fw_version), "firmware version");
1631 SYSCTL_ADD_STRING(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1632 OID_AUTO, "driver_version", CTLFLAG_RW, MPS_DRIVER_VERSION,
1633 strlen(MPS_DRIVER_VERSION), "driver version");
1635 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1636 OID_AUTO, "io_cmds_active", CTLFLAG_RD,
1637 &sc->io_cmds_active, 0, "number of currently active commands");
1639 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1640 OID_AUTO, "io_cmds_highwater", CTLFLAG_RD,
1641 &sc->io_cmds_highwater, 0, "maximum active commands seen");
1643 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1644 OID_AUTO, "chain_free", CTLFLAG_RD,
1645 &sc->chain_free, 0, "number of free chain elements");
1647 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1648 OID_AUTO, "chain_free_lowwater", CTLFLAG_RD,
1649 &sc->chain_free_lowwater, 0,"lowest number of free chain elements");
1651 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1652 OID_AUTO, "max_chains", CTLFLAG_RD,
1653 &sc->max_chains, 0,"maximum chain frames that will be allocated");
1655 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1656 OID_AUTO, "max_io_pages", CTLFLAG_RD,
1657 &sc->max_io_pages, 0,"maximum pages to allow per I/O (if <1 use "
1660 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1661 OID_AUTO, "enable_ssu", CTLFLAG_RW, &sc->enable_ssu, 0,
1662 "enable SSU to SATA SSD/HDD at shutdown");
1664 SYSCTL_ADD_UQUAD(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1665 OID_AUTO, "chain_alloc_fail", CTLFLAG_RD,
1666 &sc->chain_alloc_fail, "chain allocation failures");
1668 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1669 OID_AUTO, "spinup_wait_time", CTLFLAG_RD,
1670 &sc->spinup_wait_time, DEFAULT_SPINUP_WAIT, "seconds to wait for "
1671 "spinup after SATA ID error");
1673 SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1674 OID_AUTO, "mapping_table_dump", CTLTYPE_STRING | CTLFLAG_RD, sc, 0,
1675 mps_mapping_dump, "A", "Mapping Table Dump");
1677 SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1678 OID_AUTO, "encl_table_dump", CTLTYPE_STRING | CTLFLAG_RD, sc, 0,
1679 mps_mapping_encl_dump, "A", "Enclosure Table Dump");
1681 SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1682 OID_AUTO, "use_phy_num", CTLFLAG_RD, &sc->use_phynum, 0,
1683 "Use the phy number for enumeration");
1686 static struct mps_debug_string {
1689 } mps_debug_strings[] = {
1691 {"fault", MPS_FAULT},
1692 {"event", MPS_EVENT},
1694 {"recovery", MPS_RECOVERY},
1695 {"error", MPS_ERROR},
1697 {"xinfo", MPS_XINFO},
1699 {"mapping", MPS_MAPPING},
1700 {"trace", MPS_TRACE}
1703 enum mps_debug_level_combiner {
1710 mps_debug_sysctl(SYSCTL_HANDLER_ARGS)
1712 struct mps_softc *sc;
1713 struct mps_debug_string *string;
1717 int i, len, debug, error;
1719 sc = (struct mps_softc *)arg1;
1721 error = sysctl_wire_old_buffer(req, 0);
1725 sbuf = sbuf_new_for_sysctl(NULL, NULL, 128, req);
1726 debug = sc->mps_debug;
1728 sbuf_printf(sbuf, "%#x", debug);
1730 sz = sizeof(mps_debug_strings) / sizeof(mps_debug_strings[0]);
1731 for (i = 0; i < sz; i++) {
1732 string = &mps_debug_strings[i];
1733 if (debug & string->flag)
1734 sbuf_printf(sbuf, ",%s", string->name);
1737 error = sbuf_finish(sbuf);
1740 if (error || req->newptr == NULL)
1743 len = req->newlen - req->newidx;
1747 buffer = malloc(len, M_MPT2, M_ZERO|M_WAITOK);
1748 error = SYSCTL_IN(req, buffer, len);
1750 mps_parse_debug(sc, buffer);
1752 free(buffer, M_MPT2);
1757 mps_parse_debug(struct mps_softc *sc, char *list)
1759 struct mps_debug_string *string;
1760 enum mps_debug_level_combiner op;
1761 char *token, *endtoken;
1765 if (list == NULL || *list == '\0')
1771 } else if (*list == '-') {
1780 sz = sizeof(mps_debug_strings) / sizeof(mps_debug_strings[0]);
1781 while ((token = strsep(&list, ":,")) != NULL) {
1783 /* Handle integer flags */
1784 flags |= strtol(token, &endtoken, 0);
1785 if (token != endtoken)
1788 /* Handle text flags */
1789 for (i = 0; i < sz; i++) {
1790 string = &mps_debug_strings[i];
1791 if (strcasecmp(token, string->name) == 0) {
1792 flags |= string->flag;
1800 sc->mps_debug = flags;
1803 sc->mps_debug |= flags;
1806 sc->mps_debug &= (~flags);
1814 mps_attach(struct mps_softc *sc)
1819 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1821 mtx_init(&sc->mps_mtx, "MPT2SAS lock", NULL, MTX_DEF);
1822 callout_init_mtx(&sc->periodic, &sc->mps_mtx, 0);
1823 callout_init_mtx(&sc->device_check_callout, &sc->mps_mtx, 0);
1824 TAILQ_INIT(&sc->event_list);
1825 timevalclear(&sc->lastfail);
1827 if ((error = mps_transition_ready(sc)) != 0) {
1828 mps_dprint(sc, MPS_INIT|MPS_FAULT, "failed to transition "
1833 sc->facts = malloc(sizeof(MPI2_IOC_FACTS_REPLY), M_MPT2,
1836 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Cannot allocate memory, "
1842 * Get IOC Facts and allocate all structures based on this information.
1843 * A Diag Reset will also call mps_iocfacts_allocate and re-read the IOC
1844 * Facts. If relevant values have changed in IOC Facts, this function
1845 * will free all of the memory based on IOC Facts and reallocate that
1846 * memory. If this fails, any allocated memory should already be freed.
1848 if ((error = mps_iocfacts_allocate(sc, TRUE)) != 0) {
1849 mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC Facts based allocation "
1850 "failed with error %d, exit\n", error);
1854 /* Start the periodic watchdog check on the IOC Doorbell */
1858 * The portenable will kick off discovery events that will drive the
1859 * rest of the initialization process. The CAM/SAS module will
1860 * hold up the boot sequence until discovery is complete.
1862 sc->mps_ich.ich_func = mps_startup;
1863 sc->mps_ich.ich_arg = sc;
1864 if (config_intrhook_establish(&sc->mps_ich) != 0) {
1865 mps_dprint(sc, MPS_INIT|MPS_ERROR,
1866 "Cannot establish MPS config hook\n");
1871 * Allow IR to shutdown gracefully when shutdown occurs.
1873 sc->shutdown_eh = EVENTHANDLER_REGISTER(shutdown_final,
1874 mpssas_ir_shutdown, sc, SHUTDOWN_PRI_DEFAULT);
1876 if (sc->shutdown_eh == NULL)
1877 mps_dprint(sc, MPS_INIT|MPS_ERROR,
1878 "shutdown event registration failed\n");
1880 mps_setup_sysctl(sc);
1882 sc->mps_flags |= MPS_FLAGS_ATTACH_DONE;
1883 mps_dprint(sc, MPS_INIT, "%s exit error= %d\n", __func__, error);
1888 /* Run through any late-start handlers. */
1890 mps_startup(void *arg)
1892 struct mps_softc *sc;
1894 sc = (struct mps_softc *)arg;
1895 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1898 mps_unmask_intr(sc);
1900 /* initialize device mapping tables */
1901 mps_base_static_config_pages(sc);
1902 mps_mapping_initialize(sc);
1906 mps_dprint(sc, MPS_INIT, "disestablish config intrhook\n");
1907 config_intrhook_disestablish(&sc->mps_ich);
1908 sc->mps_ich.ich_arg = NULL;
1910 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
1913 /* Periodic watchdog. Is called with the driver lock already held. */
1915 mps_periodic(void *arg)
1917 struct mps_softc *sc;
1920 sc = (struct mps_softc *)arg;
1921 if (sc->mps_flags & MPS_FLAGS_SHUTDOWN)
1924 db = mps_regread(sc, MPI2_DOORBELL_OFFSET);
1925 if ((db & MPI2_IOC_STATE_MASK) == MPI2_IOC_STATE_FAULT) {
1926 mps_dprint(sc, MPS_FAULT, "IOC Fault 0x%08x, Resetting\n", db);
1930 callout_reset(&sc->periodic, MPS_PERIODIC_DELAY * hz, mps_periodic, sc);
1934 mps_log_evt_handler(struct mps_softc *sc, uintptr_t data,
1935 MPI2_EVENT_NOTIFICATION_REPLY *event)
1937 MPI2_EVENT_DATA_LOG_ENTRY_ADDED *entry;
1939 MPS_DPRINT_EVENT(sc, generic, event);
1941 switch (event->Event) {
1942 case MPI2_EVENT_LOG_DATA:
1943 mps_dprint(sc, MPS_EVENT, "MPI2_EVENT_LOG_DATA:\n");
1944 if (sc->mps_debug & MPS_EVENT)
1945 hexdump(event->EventData, event->EventDataLength, NULL, 0);
1947 case MPI2_EVENT_LOG_ENTRY_ADDED:
1948 entry = (MPI2_EVENT_DATA_LOG_ENTRY_ADDED *)event->EventData;
1949 mps_dprint(sc, MPS_EVENT, "MPI2_EVENT_LOG_ENTRY_ADDED event "
1950 "0x%x Sequence %d:\n", entry->LogEntryQualifier,
1951 entry->LogSequence);
1960 mps_attach_log(struct mps_softc *sc)
1962 u32 events[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
1965 setbit(events, MPI2_EVENT_LOG_DATA);
1966 setbit(events, MPI2_EVENT_LOG_ENTRY_ADDED);
1968 mps_register_events(sc, events, mps_log_evt_handler, NULL,
1975 mps_detach_log(struct mps_softc *sc)
1978 if (sc->mps_log_eh != NULL)
1979 mps_deregister_events(sc, sc->mps_log_eh);
1984 * Free all of the driver resources and detach submodules. Should be called
1985 * without the lock held.
1988 mps_free(struct mps_softc *sc)
1992 mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1993 /* Turn off the watchdog */
1995 sc->mps_flags |= MPS_FLAGS_SHUTDOWN;
1997 /* Lock must not be held for this */
1998 callout_drain(&sc->periodic);
1999 callout_drain(&sc->device_check_callout);
2001 if (((error = mps_detach_log(sc)) != 0) ||
2002 ((error = mps_detach_sas(sc)) != 0)) {
2003 mps_dprint(sc, MPS_INIT|MPS_FAULT, "failed to detach "
2004 "subsystems, exit\n");
2008 mps_detach_user(sc);
2010 /* Put the IOC back in the READY state. */
2012 if ((error = mps_transition_ready(sc)) != 0) {
2018 if (sc->facts != NULL)
2019 free(sc->facts, M_MPT2);
2022 * Free all buffers that are based on IOC Facts. A Diag Reset may need
2023 * to free these buffers too.
2025 mps_iocfacts_free(sc);
2027 if (sc->sysctl_tree != NULL)
2028 sysctl_ctx_free(&sc->sysctl_ctx);
2030 /* Deregister the shutdown function */
2031 if (sc->shutdown_eh != NULL)
2032 EVENTHANDLER_DEREGISTER(shutdown_final, sc->shutdown_eh);
2034 mtx_destroy(&sc->mps_mtx);
2035 mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
2040 static __inline void
2041 mps_complete_command(struct mps_softc *sc, struct mps_command *cm)
2046 mps_dprint(sc, MPS_ERROR, "Completing NULL command\n");
2050 if (cm->cm_flags & MPS_CM_FLAGS_POLLED)
2051 cm->cm_flags |= MPS_CM_FLAGS_COMPLETE;
2053 if (cm->cm_complete != NULL) {
2054 mps_dprint(sc, MPS_TRACE,
2055 "%s cm %p calling cm_complete %p data %p reply %p\n",
2056 __func__, cm, cm->cm_complete, cm->cm_complete_data,
2058 cm->cm_complete(sc, cm);
2061 if (cm->cm_flags & MPS_CM_FLAGS_WAKEUP) {
2062 mps_dprint(sc, MPS_TRACE, "waking up %p\n", cm);
2066 if (cm->cm_sc->io_cmds_active != 0) {
2067 cm->cm_sc->io_cmds_active--;
2069 mps_dprint(sc, MPS_ERROR, "Warning: io_cmds_active is "
2070 "out of sync - resynching to 0\n");
2076 mps_sas_log_info(struct mps_softc *sc , u32 log_info)
2078 union loginfo_type {
2087 union loginfo_type sas_loginfo;
2088 char *originator_str = NULL;
2090 sas_loginfo.loginfo = log_info;
2091 if (sas_loginfo.dw.bus_type != 3 /*SAS*/)
2094 /* each nexus loss loginfo */
2095 if (log_info == 0x31170000)
2098 /* eat the loginfos associated with task aborts */
2099 if ((log_info == 30050000 || log_info ==
2100 0x31140000 || log_info == 0x31130000))
2103 switch (sas_loginfo.dw.originator) {
2105 originator_str = "IOP";
2108 originator_str = "PL";
2111 originator_str = "IR";
2115 mps_dprint(sc, MPS_LOG, "log_info(0x%08x): originator(%s), "
2116 "code(0x%02x), sub_code(0x%04x)\n", log_info,
2117 originator_str, sas_loginfo.dw.code,
2118 sas_loginfo.dw.subcode);
2122 mps_display_reply_info(struct mps_softc *sc, uint8_t *reply)
2124 MPI2DefaultReply_t *mpi_reply;
2127 mpi_reply = (MPI2DefaultReply_t*)reply;
2128 sc_status = le16toh(mpi_reply->IOCStatus);
2129 if (sc_status & MPI2_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE)
2130 mps_sas_log_info(sc, le32toh(mpi_reply->IOCLogInfo));
2133 mps_intr(void *data)
2135 struct mps_softc *sc;
2138 sc = (struct mps_softc *)data;
2139 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2142 * Check interrupt status register to flush the bus. This is
2143 * needed for both INTx interrupts and driver-driven polling
2145 status = mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET);
2146 if ((status & MPI2_HIS_REPLY_DESCRIPTOR_INTERRUPT) == 0)
2150 mps_intr_locked(data);
2156 * In theory, MSI/MSIX interrupts shouldn't need to read any registers on the
2157 * chip. Hopefully this theory is correct.
2160 mps_intr_msi(void *data)
2162 struct mps_softc *sc;
2164 sc = (struct mps_softc *)data;
2165 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2167 mps_intr_locked(data);
2173 * The locking is overly broad and simplistic, but easy to deal with for now.
2176 mps_intr_locked(void *data)
2178 MPI2_REPLY_DESCRIPTORS_UNION *desc;
2179 struct mps_softc *sc;
2180 struct mps_command *cm = NULL;
2183 MPI2_DIAG_RELEASE_REPLY *rel_rep;
2184 mps_fw_diagnostic_buffer_t *pBuffer;
2186 sc = (struct mps_softc *)data;
2188 pq = sc->replypostindex;
2189 mps_dprint(sc, MPS_TRACE,
2190 "%s sc %p starting with replypostindex %u\n",
2191 __func__, sc, sc->replypostindex);
2195 desc = &sc->post_queue[sc->replypostindex];
2196 flags = desc->Default.ReplyFlags &
2197 MPI2_RPY_DESCRIPT_FLAGS_TYPE_MASK;
2198 if ((flags == MPI2_RPY_DESCRIPT_FLAGS_UNUSED)
2199 || (le32toh(desc->Words.High) == 0xffffffff))
2202 /* increment the replypostindex now, so that event handlers
2203 * and cm completion handlers which decide to do a diag
2204 * reset can zero it without it getting incremented again
2205 * afterwards, and we break out of this loop on the next
2206 * iteration since the reply post queue has been cleared to
2207 * 0xFF and all descriptors look unused (which they are).
2209 if (++sc->replypostindex >= sc->pqdepth)
2210 sc->replypostindex = 0;
2213 case MPI2_RPY_DESCRIPT_FLAGS_SCSI_IO_SUCCESS:
2214 cm = &sc->commands[le16toh(desc->SCSIIOSuccess.SMID)];
2215 cm->cm_reply = NULL;
2217 case MPI2_RPY_DESCRIPT_FLAGS_ADDRESS_REPLY:
2223 * Re-compose the reply address from the address
2224 * sent back from the chip. The ReplyFrameAddress
2225 * is the lower 32 bits of the physical address of
2226 * particular reply frame. Convert that address to
2227 * host format, and then use that to provide the
2228 * offset against the virtual address base
2229 * (sc->reply_frames).
2231 baddr = le32toh(desc->AddressReply.ReplyFrameAddress);
2232 reply = sc->reply_frames +
2233 (baddr - ((uint32_t)sc->reply_busaddr));
2235 * Make sure the reply we got back is in a valid
2236 * range. If not, go ahead and panic here, since
2237 * we'll probably panic as soon as we deference the
2238 * reply pointer anyway.
2240 if ((reply < sc->reply_frames)
2241 || (reply > (sc->reply_frames +
2242 (sc->fqdepth * sc->facts->ReplyFrameSize * 4)))) {
2243 printf("%s: WARNING: reply %p out of range!\n",
2245 printf("%s: reply_frames %p, fqdepth %d, "
2246 "frame size %d\n", __func__,
2247 sc->reply_frames, sc->fqdepth,
2248 sc->facts->ReplyFrameSize * 4);
2249 printf("%s: baddr %#x,\n", __func__, baddr);
2250 /* LSI-TODO. See Linux Code. Need Graceful exit*/
2251 panic("Reply address out of range");
2253 if (le16toh(desc->AddressReply.SMID) == 0) {
2254 if (((MPI2_DEFAULT_REPLY *)reply)->Function ==
2255 MPI2_FUNCTION_DIAG_BUFFER_POST) {
2257 * If SMID is 0 for Diag Buffer Post,
2258 * this implies that the reply is due to
2259 * a release function with a status that
2260 * the buffer has been released. Set
2261 * the buffer flags accordingly.
2264 (MPI2_DIAG_RELEASE_REPLY *)reply;
2265 if ((le16toh(rel_rep->IOCStatus) &
2266 MPI2_IOCSTATUS_MASK) ==
2267 MPI2_IOCSTATUS_DIAGNOSTIC_RELEASED)
2270 &sc->fw_diag_buffer_list[
2271 rel_rep->BufferType];
2272 pBuffer->valid_data = TRUE;
2273 pBuffer->owned_by_firmware =
2275 pBuffer->immediate = FALSE;
2278 mps_dispatch_event(sc, baddr,
2279 (MPI2_EVENT_NOTIFICATION_REPLY *)
2282 cm = &sc->commands[le16toh(desc->AddressReply.SMID)];
2283 cm->cm_reply = reply;
2285 le32toh(desc->AddressReply.ReplyFrameAddress);
2289 case MPI2_RPY_DESCRIPT_FLAGS_TARGETASSIST_SUCCESS:
2290 case MPI2_RPY_DESCRIPT_FLAGS_TARGET_COMMAND_BUFFER:
2291 case MPI2_RPY_DESCRIPT_FLAGS_RAID_ACCELERATOR_SUCCESS:
2294 mps_dprint(sc, MPS_ERROR, "Unhandled reply 0x%x\n",
2295 desc->Default.ReplyFlags);
2302 // Print Error reply frame
2304 mps_display_reply_info(sc,cm->cm_reply);
2305 mps_complete_command(sc, cm);
2308 desc->Words.Low = 0xffffffff;
2309 desc->Words.High = 0xffffffff;
2312 if (pq != sc->replypostindex) {
2313 mps_dprint(sc, MPS_TRACE,
2314 "%s sc %p writing postindex %d\n",
2315 __func__, sc, sc->replypostindex);
2316 mps_regwrite(sc, MPI2_REPLY_POST_HOST_INDEX_OFFSET, sc->replypostindex);
2323 mps_dispatch_event(struct mps_softc *sc, uintptr_t data,
2324 MPI2_EVENT_NOTIFICATION_REPLY *reply)
2326 struct mps_event_handle *eh;
2327 int event, handled = 0;
2329 event = le16toh(reply->Event);
2330 TAILQ_FOREACH(eh, &sc->event_list, eh_list) {
2331 if (isset(eh->mask, event)) {
2332 eh->callback(sc, data, reply);
2338 mps_dprint(sc, MPS_EVENT, "Unhandled event 0x%x\n", le16toh(event));
2341 * This is the only place that the event/reply should be freed.
2342 * Anything wanting to hold onto the event data should have
2343 * already copied it into their own storage.
2345 mps_free_reply(sc, data);
2349 mps_reregister_events_complete(struct mps_softc *sc, struct mps_command *cm)
2351 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2354 MPS_DPRINT_EVENT(sc, generic,
2355 (MPI2_EVENT_NOTIFICATION_REPLY *)cm->cm_reply);
2357 mps_free_command(sc, cm);
2359 /* next, send a port enable */
2364 * For both register_events and update_events, the caller supplies a bitmap
2365 * of events that it _wants_. These functions then turn that into a bitmask
2366 * suitable for the controller.
2369 mps_register_events(struct mps_softc *sc, u32 *mask,
2370 mps_evt_callback_t *cb, void *data, struct mps_event_handle **handle)
2372 struct mps_event_handle *eh;
2375 eh = malloc(sizeof(struct mps_event_handle), M_MPT2, M_WAITOK|M_ZERO);
2377 mps_dprint(sc, MPS_ERROR, "Cannot allocate event memory\n");
2382 TAILQ_INSERT_TAIL(&sc->event_list, eh, eh_list);
2384 error = mps_update_events(sc, eh, mask);
2391 mps_update_events(struct mps_softc *sc, struct mps_event_handle *handle,
2394 MPI2_EVENT_NOTIFICATION_REQUEST *evtreq;
2395 MPI2_EVENT_NOTIFICATION_REPLY *reply = NULL;
2396 struct mps_command *cm;
2399 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2401 if ((mask != NULL) && (handle != NULL))
2402 bcopy(mask, &handle->mask[0], sizeof(u32) *
2403 MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2405 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2406 sc->event_mask[i] = -1;
2408 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2409 sc->event_mask[i] &= ~handle->mask[i];
2412 if ((cm = mps_alloc_command(sc)) == NULL)
2414 evtreq = (MPI2_EVENT_NOTIFICATION_REQUEST *)cm->cm_req;
2415 evtreq->Function = MPI2_FUNCTION_EVENT_NOTIFICATION;
2416 evtreq->MsgFlags = 0;
2417 evtreq->SASBroadcastPrimitiveMasks = 0;
2418 #ifdef MPS_DEBUG_ALL_EVENTS
2420 u_char fullmask[16];
2421 memset(fullmask, 0x00, 16);
2422 bcopy(fullmask, &evtreq->EventMasks[0], sizeof(u32) *
2423 MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2426 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2427 evtreq->EventMasks[i] =
2428 htole32(sc->event_mask[i]);
2430 cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
2433 error = mps_wait_command(sc, &cm, 60, 0);
2435 reply = (MPI2_EVENT_NOTIFICATION_REPLY *)cm->cm_reply;
2436 if ((reply == NULL) ||
2437 (reply->IOCStatus & MPI2_IOCSTATUS_MASK) != MPI2_IOCSTATUS_SUCCESS)
2441 MPS_DPRINT_EVENT(sc, generic, reply);
2443 mps_dprint(sc, MPS_TRACE, "%s finished error %d\n", __func__, error);
2446 mps_free_command(sc, cm);
2451 mps_reregister_events(struct mps_softc *sc)
2453 MPI2_EVENT_NOTIFICATION_REQUEST *evtreq;
2454 struct mps_command *cm;
2455 struct mps_event_handle *eh;
2458 mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2460 /* first, reregister events */
2462 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2463 sc->event_mask[i] = -1;
2465 TAILQ_FOREACH(eh, &sc->event_list, eh_list) {
2466 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2467 sc->event_mask[i] &= ~eh->mask[i];
2470 if ((cm = mps_alloc_command(sc)) == NULL)
2472 evtreq = (MPI2_EVENT_NOTIFICATION_REQUEST *)cm->cm_req;
2473 evtreq->Function = MPI2_FUNCTION_EVENT_NOTIFICATION;
2474 evtreq->MsgFlags = 0;
2475 evtreq->SASBroadcastPrimitiveMasks = 0;
2476 #ifdef MPS_DEBUG_ALL_EVENTS
2478 u_char fullmask[16];
2479 memset(fullmask, 0x00, 16);
2480 bcopy(fullmask, &evtreq->EventMasks[0], sizeof(u32) *
2481 MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2484 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2485 evtreq->EventMasks[i] =
2486 htole32(sc->event_mask[i]);
2488 cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
2490 cm->cm_complete = mps_reregister_events_complete;
2492 error = mps_map_command(sc, cm);
2494 mps_dprint(sc, MPS_TRACE, "%s finished with error %d\n", __func__,
2500 mps_deregister_events(struct mps_softc *sc, struct mps_event_handle *handle)
2503 TAILQ_REMOVE(&sc->event_list, handle, eh_list);
2504 free(handle, M_MPT2);
2508 * Add a chain element as the next SGE for the specified command.
2509 * Reset cm_sge and cm_sgesize to indicate all the available space.
2512 mps_add_chain(struct mps_command *cm)
2514 MPI2_SGE_CHAIN32 *sgc;
2515 struct mps_chain *chain;
2518 if (cm->cm_sglsize < MPS_SGC_SIZE)
2519 panic("MPS: Need SGE Error Code\n");
2521 chain = mps_alloc_chain(cm->cm_sc);
2525 space = (int)cm->cm_sc->facts->IOCRequestFrameSize * 4;
2528 * Note: a double-linked list is used to make it easier to
2529 * walk for debugging.
2531 TAILQ_INSERT_TAIL(&cm->cm_chain_list, chain, chain_link);
2533 sgc = (MPI2_SGE_CHAIN32 *)&cm->cm_sge->MpiChain;
2534 sgc->Length = htole16(space);
2535 sgc->NextChainOffset = 0;
2536 /* TODO Looks like bug in Setting sgc->Flags.
2537 * sgc->Flags = ( MPI2_SGE_FLAGS_CHAIN_ELEMENT | MPI2_SGE_FLAGS_64_BIT_ADDRESSING |
2538 * MPI2_SGE_FLAGS_SYSTEM_ADDRESS) << MPI2_SGE_FLAGS_SHIFT
2539 * This is fine.. because we are not using simple element. In case of
2540 * MPI2_SGE_CHAIN32, we have separate Length and Flags feild.
2542 sgc->Flags = MPI2_SGE_FLAGS_CHAIN_ELEMENT;
2543 sgc->Address = htole32(chain->chain_busaddr);
2545 cm->cm_sge = (MPI2_SGE_IO_UNION *)&chain->chain->MpiSimple;
2546 cm->cm_sglsize = space;
2551 * Add one scatter-gather element (chain, simple, transaction context)
2552 * to the scatter-gather list for a command. Maintain cm_sglsize and
2553 * cm_sge as the remaining size and pointer to the next SGE to fill
2557 mps_push_sge(struct mps_command *cm, void *sgep, size_t len, int segsleft)
2559 MPI2_SGE_TRANSACTION_UNION *tc = sgep;
2560 MPI2_SGE_SIMPLE64 *sge = sgep;
2562 uint32_t saved_buf_len, saved_address_low, saved_address_high;
2564 type = (tc->Flags & MPI2_SGE_FLAGS_ELEMENT_MASK);
2568 case MPI2_SGE_FLAGS_TRANSACTION_ELEMENT: {
2569 if (len != tc->DetailsLength + 4)
2570 panic("TC %p length %u or %zu?", tc,
2571 tc->DetailsLength + 4, len);
2574 case MPI2_SGE_FLAGS_CHAIN_ELEMENT:
2575 /* Driver only uses 32-bit chain elements */
2576 if (len != MPS_SGC_SIZE)
2577 panic("CHAIN %p length %u or %zu?", sgep,
2580 case MPI2_SGE_FLAGS_SIMPLE_ELEMENT:
2581 /* Driver only uses 64-bit SGE simple elements */
2582 if (len != MPS_SGE64_SIZE)
2583 panic("SGE simple %p length %u or %zu?", sge,
2584 MPS_SGE64_SIZE, len);
2585 if (((le32toh(sge->FlagsLength) >> MPI2_SGE_FLAGS_SHIFT) &
2586 MPI2_SGE_FLAGS_ADDRESS_SIZE) == 0)
2587 panic("SGE simple %p not marked 64-bit?", sge);
2591 panic("Unexpected SGE %p, flags %02x", tc, tc->Flags);
2596 * case 1: 1 more segment, enough room for it
2597 * case 2: 2 more segments, enough room for both
2598 * case 3: >=2 more segments, only enough room for 1 and a chain
2599 * case 4: >=1 more segment, enough room for only a chain
2600 * case 5: >=1 more segment, no room for anything (error)
2604 * There should be room for at least a chain element, or this
2605 * code is buggy. Case (5).
2607 if (cm->cm_sglsize < MPS_SGC_SIZE)
2608 panic("MPS: Need SGE Error Code\n");
2610 if (segsleft >= 2 &&
2611 cm->cm_sglsize < len + MPS_SGC_SIZE + MPS_SGE64_SIZE) {
2613 * There are 2 or more segments left to add, and only
2614 * enough room for 1 and a chain. Case (3).
2616 * Mark as last element in this chain if necessary.
2618 if (type == MPI2_SGE_FLAGS_SIMPLE_ELEMENT) {
2619 sge->FlagsLength |= htole32(
2620 MPI2_SGE_FLAGS_LAST_ELEMENT << MPI2_SGE_FLAGS_SHIFT);
2624 * Add the item then a chain. Do the chain now,
2625 * rather than on the next iteration, to simplify
2626 * understanding the code.
2628 cm->cm_sglsize -= len;
2629 bcopy(sgep, cm->cm_sge, len);
2630 cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge + len);
2631 return (mps_add_chain(cm));
2634 if (segsleft >= 1 && cm->cm_sglsize < len + MPS_SGC_SIZE) {
2636 * 1 or more segment, enough room for only a chain.
2637 * Hope the previous element wasn't a Simple entry
2638 * that needed to be marked with
2639 * MPI2_SGE_FLAGS_LAST_ELEMENT. Case (4).
2641 if ((error = mps_add_chain(cm)) != 0)
2646 /* Case 1: 1 more segment, enough room for it. */
2647 if (segsleft == 1 && cm->cm_sglsize < len)
2648 panic("1 seg left and no room? %u versus %zu",
2649 cm->cm_sglsize, len);
2651 /* Case 2: 2 more segments, enough room for both */
2652 if (segsleft == 2 && cm->cm_sglsize < len + MPS_SGE64_SIZE)
2653 panic("2 segs left and no room? %u versus %zu",
2654 cm->cm_sglsize, len);
2657 if (segsleft == 1 && type == MPI2_SGE_FLAGS_SIMPLE_ELEMENT) {
2659 * If this is a bi-directional request, need to account for that
2660 * here. Save the pre-filled sge values. These will be used
2661 * either for the 2nd SGL or for a single direction SGL. If
2662 * cm_out_len is non-zero, this is a bi-directional request, so
2663 * fill in the OUT SGL first, then the IN SGL, otherwise just
2664 * fill in the IN SGL. Note that at this time, when filling in
2665 * 2 SGL's for a bi-directional request, they both use the same
2666 * DMA buffer (same cm command).
2668 saved_buf_len = le32toh(sge->FlagsLength) & 0x00FFFFFF;
2669 saved_address_low = sge->Address.Low;
2670 saved_address_high = sge->Address.High;
2671 if (cm->cm_out_len) {
2672 sge->FlagsLength = htole32(cm->cm_out_len |
2673 ((uint32_t)(MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2674 MPI2_SGE_FLAGS_END_OF_BUFFER |
2675 MPI2_SGE_FLAGS_HOST_TO_IOC |
2676 MPI2_SGE_FLAGS_64_BIT_ADDRESSING) <<
2677 MPI2_SGE_FLAGS_SHIFT));
2678 cm->cm_sglsize -= len;
2679 bcopy(sgep, cm->cm_sge, len);
2680 cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge
2684 ((uint32_t)(MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2685 MPI2_SGE_FLAGS_END_OF_BUFFER |
2686 MPI2_SGE_FLAGS_LAST_ELEMENT |
2687 MPI2_SGE_FLAGS_END_OF_LIST |
2688 MPI2_SGE_FLAGS_64_BIT_ADDRESSING) <<
2689 MPI2_SGE_FLAGS_SHIFT);
2690 if (cm->cm_flags & MPS_CM_FLAGS_DATAIN) {
2692 ((uint32_t)(MPI2_SGE_FLAGS_IOC_TO_HOST) <<
2693 MPI2_SGE_FLAGS_SHIFT);
2696 ((uint32_t)(MPI2_SGE_FLAGS_HOST_TO_IOC) <<
2697 MPI2_SGE_FLAGS_SHIFT);
2699 sge->FlagsLength = htole32(saved_buf_len);
2700 sge->Address.Low = saved_address_low;
2701 sge->Address.High = saved_address_high;
2704 cm->cm_sglsize -= len;
2705 bcopy(sgep, cm->cm_sge, len);
2706 cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge + len);
2711 * Add one dma segment to the scatter-gather list for a command.
2714 mps_add_dmaseg(struct mps_command *cm, vm_paddr_t pa, size_t len, u_int flags,
2717 MPI2_SGE_SIMPLE64 sge;
2720 * This driver always uses 64-bit address elements for simplicity.
2722 bzero(&sge, sizeof(sge));
2723 flags |= MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2724 MPI2_SGE_FLAGS_64_BIT_ADDRESSING;
2725 sge.FlagsLength = htole32(len | (flags << MPI2_SGE_FLAGS_SHIFT));
2726 mps_from_u64(pa, &sge.Address);
2728 return (mps_push_sge(cm, &sge, sizeof sge, segsleft));
2732 mps_data_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
2734 struct mps_softc *sc;
2735 struct mps_command *cm;
2736 u_int i, dir, sflags;
2738 cm = (struct mps_command *)arg;
2742 * In this case, just print out a warning and let the chip tell the
2743 * user they did the wrong thing.
2745 if ((cm->cm_max_segs != 0) && (nsegs > cm->cm_max_segs)) {
2746 mps_dprint(sc, MPS_ERROR,
2747 "%s: warning: busdma returned %d segments, "
2748 "more than the %d allowed\n", __func__, nsegs,
2753 * Set up DMA direction flags. Bi-directional requests are also handled
2754 * here. In that case, both direction flags will be set.
2757 if (cm->cm_flags & MPS_CM_FLAGS_SMP_PASS) {
2759 * We have to add a special case for SMP passthrough, there
2760 * is no easy way to generically handle it. The first
2761 * S/G element is used for the command (therefore the
2762 * direction bit needs to be set). The second one is used
2763 * for the reply. We'll leave it to the caller to make
2764 * sure we only have two buffers.
2767 * Even though the busdma man page says it doesn't make
2768 * sense to have both direction flags, it does in this case.
2769 * We have one s/g element being accessed in each direction.
2771 dir = BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD;
2774 * Set the direction flag on the first buffer in the SMP
2775 * passthrough request. We'll clear it for the second one.
2777 sflags |= MPI2_SGE_FLAGS_DIRECTION |
2778 MPI2_SGE_FLAGS_END_OF_BUFFER;
2779 } else if (cm->cm_flags & MPS_CM_FLAGS_DATAOUT) {
2780 sflags |= MPI2_SGE_FLAGS_HOST_TO_IOC;
2781 dir = BUS_DMASYNC_PREWRITE;
2783 dir = BUS_DMASYNC_PREREAD;
2785 for (i = 0; i < nsegs; i++) {
2786 if ((cm->cm_flags & MPS_CM_FLAGS_SMP_PASS) && (i != 0)) {
2787 sflags &= ~MPI2_SGE_FLAGS_DIRECTION;
2789 error = mps_add_dmaseg(cm, segs[i].ds_addr, segs[i].ds_len,
2792 /* Resource shortage, roll back! */
2793 if (ratecheck(&sc->lastfail, &mps_chainfail_interval))
2794 mps_dprint(sc, MPS_INFO, "Out of chain frames, "
2795 "consider increasing hw.mps.max_chains.\n");
2796 cm->cm_flags |= MPS_CM_FLAGS_CHAIN_FAILED;
2797 mps_complete_command(sc, cm);
2802 bus_dmamap_sync(sc->buffer_dmat, cm->cm_dmamap, dir);
2803 mps_enqueue_request(sc, cm);
2809 mps_data_cb2(void *arg, bus_dma_segment_t *segs, int nsegs, bus_size_t mapsize,
2812 mps_data_cb(arg, segs, nsegs, error);
2816 * This is the routine to enqueue commands ansynchronously.
2817 * Note that the only error path here is from bus_dmamap_load(), which can
2818 * return EINPROGRESS if it is waiting for resources. Other than this, it's
2819 * assumed that if you have a command in-hand, then you have enough credits
2823 mps_map_command(struct mps_softc *sc, struct mps_command *cm)
2827 if (cm->cm_flags & MPS_CM_FLAGS_USE_UIO) {
2828 error = bus_dmamap_load_uio(sc->buffer_dmat, cm->cm_dmamap,
2829 &cm->cm_uio, mps_data_cb2, cm, 0);
2830 } else if (cm->cm_flags & MPS_CM_FLAGS_USE_CCB) {
2831 error = bus_dmamap_load_ccb(sc->buffer_dmat, cm->cm_dmamap,
2832 cm->cm_data, mps_data_cb, cm, 0);
2833 } else if ((cm->cm_data != NULL) && (cm->cm_length != 0)) {
2834 error = bus_dmamap_load(sc->buffer_dmat, cm->cm_dmamap,
2835 cm->cm_data, cm->cm_length, mps_data_cb, cm, 0);
2837 /* Add a zero-length element as needed */
2838 if (cm->cm_sge != NULL)
2839 mps_add_dmaseg(cm, 0, 0, 0, 1);
2840 mps_enqueue_request(sc, cm);
2847 * This is the routine to enqueue commands synchronously. An error of
2848 * EINPROGRESS from mps_map_command() is ignored since the command will
2849 * be executed and enqueued automatically. Other errors come from msleep().
2852 mps_wait_command(struct mps_softc *sc, struct mps_command **cmp, int timeout,
2856 struct timeval cur_time, start_time;
2857 struct mps_command *cm = *cmp;
2859 if (sc->mps_flags & MPS_FLAGS_DIAGRESET)
2862 cm->cm_complete = NULL;
2863 cm->cm_flags |= MPS_CM_FLAGS_POLLED;
2864 error = mps_map_command(sc, cm);
2865 if ((error != 0) && (error != EINPROGRESS))
2869 * Check for context and wait for 50 mSec at a time until time has
2870 * expired or the command has finished. If msleep can't be used, need
2873 if (curthread->td_no_sleeping != 0)
2874 sleep_flag = NO_SLEEP;
2875 getmicrouptime(&start_time);
2876 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP) {
2877 cm->cm_flags |= MPS_CM_FLAGS_WAKEUP;
2878 error = msleep(cm, &sc->mps_mtx, 0, "mpswait", timeout*hz);
2879 if (error == EWOULDBLOCK) {
2881 * Record the actual elapsed time in the case of a
2882 * timeout for the message below.
2884 getmicrouptime(&cur_time);
2885 timevalsub(&cur_time, &start_time);
2888 while ((cm->cm_flags & MPS_CM_FLAGS_COMPLETE) == 0) {
2889 mps_intr_locked(sc);
2890 if (sleep_flag == CAN_SLEEP)
2891 pause("mpswait", hz/20);
2895 getmicrouptime(&cur_time);
2896 timevalsub(&cur_time, &start_time);
2897 if (cur_time.tv_sec > timeout) {
2898 error = EWOULDBLOCK;
2904 if (error == EWOULDBLOCK) {
2905 mps_dprint(sc, MPS_FAULT, "Calling Reinit from %s, timeout=%d,"
2906 " elapsed=%jd\n", __func__, timeout,
2907 (intmax_t)cur_time.tv_sec);
2908 rc = mps_reinit(sc);
2909 mps_dprint(sc, MPS_FAULT, "Reinit %s\n", (rc == 0) ? "success" :
2911 if (sc->mps_flags & MPS_FLAGS_REALLOCATED) {
2913 * Tell the caller that we freed the command in a
2924 * The MPT driver had a verbose interface for config pages. In this driver,
2925 * reduce it to much simpler terms, similar to the Linux driver.
2928 mps_read_config_page(struct mps_softc *sc, struct mps_config_params *params)
2930 MPI2_CONFIG_REQUEST *req;
2931 struct mps_command *cm;
2934 if (sc->mps_flags & MPS_FLAGS_BUSY) {
2938 cm = mps_alloc_command(sc);
2943 req = (MPI2_CONFIG_REQUEST *)cm->cm_req;
2944 req->Function = MPI2_FUNCTION_CONFIG;
2945 req->Action = params->action;
2947 req->ChainOffset = 0;
2948 req->PageAddress = params->page_address;
2949 if (params->hdr.Struct.PageType == MPI2_CONFIG_PAGETYPE_EXTENDED) {
2950 MPI2_CONFIG_EXTENDED_PAGE_HEADER *hdr;
2952 hdr = ¶ms->hdr.Ext;
2953 req->ExtPageType = hdr->ExtPageType;
2954 req->ExtPageLength = hdr->ExtPageLength;
2955 req->Header.PageType = MPI2_CONFIG_PAGETYPE_EXTENDED;
2956 req->Header.PageLength = 0; /* Must be set to zero */
2957 req->Header.PageNumber = hdr->PageNumber;
2958 req->Header.PageVersion = hdr->PageVersion;
2960 MPI2_CONFIG_PAGE_HEADER *hdr;
2962 hdr = ¶ms->hdr.Struct;
2963 req->Header.PageType = hdr->PageType;
2964 req->Header.PageNumber = hdr->PageNumber;
2965 req->Header.PageLength = hdr->PageLength;
2966 req->Header.PageVersion = hdr->PageVersion;
2969 cm->cm_data = params->buffer;
2970 cm->cm_length = params->length;
2971 if (cm->cm_data != NULL) {
2972 cm->cm_sge = &req->PageBufferSGE;
2973 cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
2974 cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
2977 cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
2979 cm->cm_complete_data = params;
2980 if (params->callback != NULL) {
2981 cm->cm_complete = mps_config_complete;
2982 return (mps_map_command(sc, cm));
2984 error = mps_wait_command(sc, &cm, 0, CAN_SLEEP);
2986 mps_dprint(sc, MPS_FAULT,
2987 "Error %d reading config page\n", error);
2989 mps_free_command(sc, cm);
2992 mps_config_complete(sc, cm);
2999 mps_write_config_page(struct mps_softc *sc, struct mps_config_params *params)
3005 mps_config_complete(struct mps_softc *sc, struct mps_command *cm)
3007 MPI2_CONFIG_REPLY *reply;
3008 struct mps_config_params *params;
3011 params = cm->cm_complete_data;
3013 if (cm->cm_data != NULL) {
3014 bus_dmamap_sync(sc->buffer_dmat, cm->cm_dmamap,
3015 BUS_DMASYNC_POSTREAD);
3016 bus_dmamap_unload(sc->buffer_dmat, cm->cm_dmamap);
3020 * XXX KDM need to do more error recovery? This results in the
3021 * device in question not getting probed.
3023 if ((cm->cm_flags & MPS_CM_FLAGS_ERROR_MASK) != 0) {
3024 params->status = MPI2_IOCSTATUS_BUSY;
3028 reply = (MPI2_CONFIG_REPLY *)cm->cm_reply;
3029 if (reply == NULL) {
3030 params->status = MPI2_IOCSTATUS_BUSY;
3033 params->status = reply->IOCStatus;
3034 if (params->hdr.Struct.PageType == MPI2_CONFIG_PAGETYPE_EXTENDED) {
3035 params->hdr.Ext.ExtPageType = reply->ExtPageType;
3036 params->hdr.Ext.ExtPageLength = reply->ExtPageLength;
3037 params->hdr.Ext.PageType = reply->Header.PageType;
3038 params->hdr.Ext.PageNumber = reply->Header.PageNumber;
3039 params->hdr.Ext.PageVersion = reply->Header.PageVersion;
3041 params->hdr.Struct.PageType = reply->Header.PageType;
3042 params->hdr.Struct.PageNumber = reply->Header.PageNumber;
3043 params->hdr.Struct.PageLength = reply->Header.PageLength;
3044 params->hdr.Struct.PageVersion = reply->Header.PageVersion;
3048 mps_free_command(sc, cm);
3049 if (params->callback != NULL)
3050 params->callback(sc, params);