]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/mps/mps.c
MFH
[FreeBSD/FreeBSD.git] / sys / dev / mps / mps.c
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2009 Yahoo! Inc.
5  * Copyright (c) 2011-2015 LSI Corp.
6  * Copyright (c) 2013-2015 Avago Technologies
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
31  *
32  * $FreeBSD$
33  */
34
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37
38 /* Communications core for Avago Technologies (LSI) MPT2 */
39
40 /* TODO Move headers to mpsvar */
41 #include <sys/types.h>
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/kernel.h>
45 #include <sys/selinfo.h>
46 #include <sys/lock.h>
47 #include <sys/mutex.h>
48 #include <sys/module.h>
49 #include <sys/bus.h>
50 #include <sys/conf.h>
51 #include <sys/bio.h>
52 #include <sys/malloc.h>
53 #include <sys/uio.h>
54 #include <sys/sysctl.h>
55 #include <sys/smp.h>
56 #include <sys/queue.h>
57 #include <sys/kthread.h>
58 #include <sys/taskqueue.h>
59 #include <sys/endian.h>
60 #include <sys/eventhandler.h>
61 #include <sys/sbuf.h>
62 #include <sys/priv.h>
63
64 #include <machine/bus.h>
65 #include <machine/resource.h>
66 #include <sys/rman.h>
67 #include <sys/proc.h>
68
69 #include <dev/pci/pcivar.h>
70
71 #include <cam/cam.h>
72 #include <cam/scsi/scsi_all.h>
73
74 #include <dev/mps/mpi/mpi2_type.h>
75 #include <dev/mps/mpi/mpi2.h>
76 #include <dev/mps/mpi/mpi2_ioc.h>
77 #include <dev/mps/mpi/mpi2_sas.h>
78 #include <dev/mps/mpi/mpi2_cnfg.h>
79 #include <dev/mps/mpi/mpi2_init.h>
80 #include <dev/mps/mpi/mpi2_tool.h>
81 #include <dev/mps/mps_ioctl.h>
82 #include <dev/mps/mpsvar.h>
83 #include <dev/mps/mps_table.h>
84
85 static int mps_diag_reset(struct mps_softc *sc, int sleep_flag);
86 static int mps_init_queues(struct mps_softc *sc);
87 static void mps_resize_queues(struct mps_softc *sc);
88 static int mps_message_unit_reset(struct mps_softc *sc, int sleep_flag);
89 static int mps_transition_operational(struct mps_softc *sc);
90 static int mps_iocfacts_allocate(struct mps_softc *sc, uint8_t attaching);
91 static void mps_iocfacts_free(struct mps_softc *sc);
92 static void mps_startup(void *arg);
93 static int mps_send_iocinit(struct mps_softc *sc);
94 static int mps_alloc_queues(struct mps_softc *sc);
95 static int mps_alloc_hw_queues(struct mps_softc *sc);
96 static int mps_alloc_replies(struct mps_softc *sc);
97 static int mps_alloc_requests(struct mps_softc *sc);
98 static int mps_attach_log(struct mps_softc *sc);
99 static __inline void mps_complete_command(struct mps_softc *sc,
100     struct mps_command *cm);
101 static void mps_dispatch_event(struct mps_softc *sc, uintptr_t data,
102     MPI2_EVENT_NOTIFICATION_REPLY *reply);
103 static void mps_config_complete(struct mps_softc *sc, struct mps_command *cm);
104 static void mps_periodic(void *);
105 static int mps_reregister_events(struct mps_softc *sc);
106 static void mps_enqueue_request(struct mps_softc *sc, struct mps_command *cm);
107 static int mps_get_iocfacts(struct mps_softc *sc, MPI2_IOC_FACTS_REPLY *facts);
108 static int mps_wait_db_ack(struct mps_softc *sc, int timeout, int sleep_flag);
109 static int mps_debug_sysctl(SYSCTL_HANDLER_ARGS);
110 static int mps_dump_reqs(SYSCTL_HANDLER_ARGS);
111 static void mps_parse_debug(struct mps_softc *sc, char *list);
112
113 SYSCTL_NODE(_hw, OID_AUTO, mps, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
114     "MPS Driver Parameters");
115
116 MALLOC_DEFINE(M_MPT2, "mps", "mpt2 driver memory");
117 MALLOC_DECLARE(M_MPSUSER);
118
119 /*
120  * Do a "Diagnostic Reset" aka a hard reset.  This should get the chip out of
121  * any state and back to its initialization state machine.
122  */
123 static char mpt2_reset_magic[] = { 0x00, 0x0f, 0x04, 0x0b, 0x02, 0x07, 0x0d };
124
125 /* Added this union to smoothly convert le64toh cm->cm_desc.Words.
126  * Compiler only support unint64_t to be passed as argument.
127  * Otherwise it will throw below error
128  * "aggregate value used where an integer was expected"
129  */
130
131 typedef union _reply_descriptor {
132         u64 word;
133         struct {
134                 u32 low;
135                 u32 high;
136         } u;
137 }reply_descriptor,address_descriptor;
138
139 /* Rate limit chain-fail messages to 1 per minute */
140 static struct timeval mps_chainfail_interval = { 60, 0 };
141
142 /* 
143  * sleep_flag can be either CAN_SLEEP or NO_SLEEP.
144  * If this function is called from process context, it can sleep
145  * and there is no harm to sleep, in case if this fuction is called
146  * from Interrupt handler, we can not sleep and need NO_SLEEP flag set.
147  * based on sleep flags driver will call either msleep, pause or DELAY.
148  * msleep and pause are of same variant, but pause is used when mps_mtx
149  * is not hold by driver.
150  *
151  */
152 static int
153 mps_diag_reset(struct mps_softc *sc,int sleep_flag)
154 {
155         uint32_t reg;
156         int i, error, tries = 0;
157         uint8_t first_wait_done = FALSE;
158
159         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
160
161         /* Clear any pending interrupts */
162         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
163
164         /*
165          * Force NO_SLEEP for threads prohibited to sleep
166          * e.a Thread from interrupt handler are prohibited to sleep.
167          */
168         if (curthread->td_no_sleeping != 0)
169                 sleep_flag = NO_SLEEP;
170
171         mps_dprint(sc, MPS_INIT, "sequence start, sleep_flag= %d\n", sleep_flag);
172  
173         /* Push the magic sequence */
174         error = ETIMEDOUT;
175         while (tries++ < 20) {
176                 for (i = 0; i < sizeof(mpt2_reset_magic); i++)
177                         mps_regwrite(sc, MPI2_WRITE_SEQUENCE_OFFSET,
178                             mpt2_reset_magic[i]);
179                 /* wait 100 msec */
180                 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
181                         msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
182                             "mpsdiag", hz/10);
183                 else if (sleep_flag == CAN_SLEEP)
184                         pause("mpsdiag", hz/10);
185                 else
186                         DELAY(100 * 1000);
187
188                 reg = mps_regread(sc, MPI2_HOST_DIAGNOSTIC_OFFSET);
189                 if (reg & MPI2_DIAG_DIAG_WRITE_ENABLE) {
190                         error = 0;
191                         break;
192                 }
193         }
194         if (error) {
195                 mps_dprint(sc, MPS_INIT, "sequence failed, error=%d, exit\n",
196                     error);
197                 return (error);
198         }
199
200         /* Send the actual reset.  XXX need to refresh the reg? */
201         reg |= MPI2_DIAG_RESET_ADAPTER;
202         mps_dprint(sc, MPS_INIT, "sequence success, sending reset, reg= 0x%x\n",
203                 reg);
204         mps_regwrite(sc, MPI2_HOST_DIAGNOSTIC_OFFSET, reg);
205
206         /* Wait up to 300 seconds in 50ms intervals */
207         error = ETIMEDOUT;
208         for (i = 0; i < 6000; i++) {
209                 /*
210                  * Wait 50 msec. If this is the first time through, wait 256
211                  * msec to satisfy Diag Reset timing requirements.
212                  */
213                 if (first_wait_done) {
214                         if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
215                                 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
216                                     "mpsdiag", hz/20);
217                         else if (sleep_flag == CAN_SLEEP)
218                                 pause("mpsdiag", hz/20);
219                         else
220                                 DELAY(50 * 1000);
221                 } else {
222                         DELAY(256 * 1000);
223                         first_wait_done = TRUE;
224                 }
225                 /*
226                  * Check for the RESET_ADAPTER bit to be cleared first, then
227                  * wait for the RESET state to be cleared, which takes a little
228                  * longer.
229                  */
230                 reg = mps_regread(sc, MPI2_HOST_DIAGNOSTIC_OFFSET);
231                 if (reg & MPI2_DIAG_RESET_ADAPTER) {
232                         continue;
233                 }
234                 reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
235                 if ((reg & MPI2_IOC_STATE_MASK) != MPI2_IOC_STATE_RESET) {
236                         error = 0;
237                         break;
238                 }
239         }
240         if (error) {
241                 mps_dprint(sc, MPS_INIT, "reset failed, error= %d, exit\n",
242                     error);
243                 return (error);
244         }
245
246         mps_regwrite(sc, MPI2_WRITE_SEQUENCE_OFFSET, 0x0);
247         mps_dprint(sc, MPS_INIT, "diag reset success, exit\n");
248
249         return (0);
250 }
251
252 static int
253 mps_message_unit_reset(struct mps_softc *sc, int sleep_flag)
254 {
255         int error;
256
257         MPS_FUNCTRACE(sc);
258
259         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
260
261         error = 0;
262         mps_regwrite(sc, MPI2_DOORBELL_OFFSET,
263             MPI2_FUNCTION_IOC_MESSAGE_UNIT_RESET <<
264             MPI2_DOORBELL_FUNCTION_SHIFT);
265
266         if (mps_wait_db_ack(sc, 5, sleep_flag) != 0) {
267                 mps_dprint(sc, MPS_INIT|MPS_FAULT,
268                     "Doorbell handshake failed\n");
269                 error = ETIMEDOUT;
270         }
271
272         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
273         return (error);
274 }
275
276 static int
277 mps_transition_ready(struct mps_softc *sc)
278 {
279         uint32_t reg, state;
280         int error, tries = 0;
281         int sleep_flags;
282
283         MPS_FUNCTRACE(sc);
284         /* If we are in attach call, do not sleep */
285         sleep_flags = (sc->mps_flags & MPS_FLAGS_ATTACH_DONE)
286                                         ? CAN_SLEEP:NO_SLEEP;
287         error = 0;
288
289         mps_dprint(sc, MPS_INIT, "%s entered, sleep_flags= %d\n",
290            __func__, sleep_flags);
291
292         while (tries++ < 1200) {
293                 reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
294                 mps_dprint(sc, MPS_INIT, "  Doorbell= 0x%x\n", reg);
295
296                 /*
297                  * Ensure the IOC is ready to talk.  If it's not, try
298                  * resetting it.
299                  */
300                 if (reg & MPI2_DOORBELL_USED) {
301                         mps_dprint(sc, MPS_INIT, "  Not ready, sending diag "
302                             "reset\n");
303                         mps_diag_reset(sc, sleep_flags);
304                         DELAY(50000);
305                         continue;
306                 }
307
308                 /* Is the adapter owned by another peer? */
309                 if ((reg & MPI2_DOORBELL_WHO_INIT_MASK) ==
310                     (MPI2_WHOINIT_PCI_PEER << MPI2_DOORBELL_WHO_INIT_SHIFT)) {
311                         mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC is under the "
312                             "control of another peer host, aborting "
313                             "initialization.\n");
314                         error = ENXIO;
315                         break;
316                 }
317                 
318                 state = reg & MPI2_IOC_STATE_MASK;
319                 if (state == MPI2_IOC_STATE_READY) {
320                         /* Ready to go! */
321                         error = 0;
322                         break;
323                 } else if (state == MPI2_IOC_STATE_FAULT) {
324                         mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC in fault "
325                             "state 0x%x, resetting\n",
326                             state & MPI2_DOORBELL_FAULT_CODE_MASK);
327                         mps_diag_reset(sc, sleep_flags);
328                 } else if (state == MPI2_IOC_STATE_OPERATIONAL) {
329                         /* Need to take ownership */
330                         mps_message_unit_reset(sc, sleep_flags);
331                 } else if (state == MPI2_IOC_STATE_RESET) {
332                         /* Wait a bit, IOC might be in transition */
333                         mps_dprint(sc, MPS_INIT|MPS_FAULT,
334                             "IOC in unexpected reset state\n");
335                 } else {
336                         mps_dprint(sc, MPS_INIT|MPS_FAULT,
337                             "IOC in unknown state 0x%x\n", state);
338                         error = EINVAL;
339                         break;
340                 }
341         
342                 /* Wait 50ms for things to settle down. */
343                 DELAY(50000);
344         }
345
346         if (error)
347                 mps_dprint(sc, MPS_INIT|MPS_FAULT,
348                     "Cannot transition IOC to ready\n");
349         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
350
351         return (error);
352 }
353
354 static int
355 mps_transition_operational(struct mps_softc *sc)
356 {
357         uint32_t reg, state;
358         int error;
359
360         MPS_FUNCTRACE(sc);
361
362         error = 0;
363         reg = mps_regread(sc, MPI2_DOORBELL_OFFSET);
364         mps_dprint(sc, MPS_INIT, "%s entered, Doorbell= 0x%x\n", __func__, reg);
365
366         state = reg & MPI2_IOC_STATE_MASK;
367         if (state != MPI2_IOC_STATE_READY) {
368                 mps_dprint(sc, MPS_INIT, "IOC not ready\n");
369                 if ((error = mps_transition_ready(sc)) != 0) {
370                         mps_dprint(sc, MPS_INIT|MPS_FAULT, 
371                             "failed to transition ready, exit\n");
372                         return (error);
373                 }
374         }
375
376         error = mps_send_iocinit(sc);
377         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
378
379         return (error);
380 }
381
382 static void
383 mps_resize_queues(struct mps_softc *sc)
384 {
385         u_int reqcr, prireqcr, maxio, sges_per_frame;
386
387         /*
388          * Size the queues. Since the reply queues always need one free
389          * entry, we'll deduct one reply message here.  The LSI documents
390          * suggest instead to add a count to the request queue, but I think
391          * that it's better to deduct from reply queue.
392          */
393         prireqcr = MAX(1, sc->max_prireqframes);
394         prireqcr = MIN(prireqcr, sc->facts->HighPriorityCredit);
395
396         reqcr = MAX(2, sc->max_reqframes);
397         reqcr = MIN(reqcr, sc->facts->RequestCredit);
398
399         sc->num_reqs = prireqcr + reqcr;
400         sc->num_prireqs = prireqcr;
401         sc->num_replies = MIN(sc->max_replyframes + sc->max_evtframes,
402             sc->facts->MaxReplyDescriptorPostQueueDepth) - 1;
403
404         /* Store the request frame size in bytes rather than as 32bit words */
405         sc->reqframesz = sc->facts->IOCRequestFrameSize * 4;
406
407         /*
408          * Max IO Size is Page Size * the following:
409          * ((SGEs per frame - 1 for chain element) * Max Chain Depth)
410          * + 1 for no chain needed in last frame
411          *
412          * If user suggests a Max IO size to use, use the smaller of the
413          * user's value and the calculated value as long as the user's
414          * value is larger than 0. The user's value is in pages.
415          */
416         sges_per_frame = sc->reqframesz / sizeof(MPI2_SGE_SIMPLE64) - 1;
417         maxio = (sges_per_frame * sc->facts->MaxChainDepth + 1) * PAGE_SIZE;
418
419         /*
420          * If I/O size limitation requested, then use it and pass up to CAM.
421          * If not, use MAXPHYS as an optimization hint, but report HW limit.
422          */
423         if (sc->max_io_pages > 0) {
424                 maxio = min(maxio, sc->max_io_pages * PAGE_SIZE);
425                 sc->maxio = maxio;
426         } else {
427                 sc->maxio = maxio;
428                 maxio = min(maxio, MAXPHYS);
429         }
430
431         sc->num_chains = (maxio / PAGE_SIZE + sges_per_frame - 2) /
432             sges_per_frame * reqcr;
433         if (sc->max_chains > 0 && sc->max_chains < sc->num_chains)
434                 sc->num_chains = sc->max_chains;
435
436         /*
437          * Figure out the number of MSIx-based queues.  If the firmware or
438          * user has done something crazy and not allowed enough credit for
439          * the queues to be useful then don't enable multi-queue.
440          */
441         if (sc->facts->MaxMSIxVectors < 2)
442                 sc->msi_msgs = 1;
443
444         if (sc->msi_msgs > 1) {
445                 sc->msi_msgs = MIN(sc->msi_msgs, mp_ncpus);
446                 sc->msi_msgs = MIN(sc->msi_msgs, sc->facts->MaxMSIxVectors);
447                 if (sc->num_reqs / sc->msi_msgs < 2)
448                         sc->msi_msgs = 1;
449         }
450
451         mps_dprint(sc, MPS_INIT, "Sized queues to q=%d reqs=%d replies=%d\n",
452             sc->msi_msgs, sc->num_reqs, sc->num_replies);
453 }
454
455 /*
456  * This is called during attach and when re-initializing due to a Diag Reset.
457  * IOC Facts is used to allocate many of the structures needed by the driver.
458  * If called from attach, de-allocation is not required because the driver has
459  * not allocated any structures yet, but if called from a Diag Reset, previously
460  * allocated structures based on IOC Facts will need to be freed and re-
461  * allocated bases on the latest IOC Facts.
462  */
463 static int
464 mps_iocfacts_allocate(struct mps_softc *sc, uint8_t attaching)
465 {
466         int error;
467         Mpi2IOCFactsReply_t saved_facts;
468         uint8_t saved_mode, reallocating;
469
470         mps_dprint(sc, MPS_INIT|MPS_TRACE, "%s entered\n", __func__);
471
472         /* Save old IOC Facts and then only reallocate if Facts have changed */
473         if (!attaching) {
474                 bcopy(sc->facts, &saved_facts, sizeof(MPI2_IOC_FACTS_REPLY));
475         }
476
477         /*
478          * Get IOC Facts.  In all cases throughout this function, panic if doing
479          * a re-initialization and only return the error if attaching so the OS
480          * can handle it.
481          */
482         if ((error = mps_get_iocfacts(sc, sc->facts)) != 0) {
483                 if (attaching) {
484                         mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to get "
485                             "IOC Facts with error %d, exit\n", error);
486                         return (error);
487                 } else {
488                         panic("%s failed to get IOC Facts with error %d\n",
489                             __func__, error);
490                 }
491         }
492
493         MPS_DPRINT_PAGE(sc, MPS_XINFO, iocfacts, sc->facts);
494
495         snprintf(sc->fw_version, sizeof(sc->fw_version), 
496             "%02d.%02d.%02d.%02d", 
497             sc->facts->FWVersion.Struct.Major,
498             sc->facts->FWVersion.Struct.Minor,
499             sc->facts->FWVersion.Struct.Unit,
500             sc->facts->FWVersion.Struct.Dev);
501
502         snprintf(sc->msg_version, sizeof(sc->msg_version), "%d.%d",
503             (sc->facts->MsgVersion & MPI2_IOCFACTS_MSGVERSION_MAJOR_MASK) >>
504             MPI2_IOCFACTS_MSGVERSION_MAJOR_SHIFT, 
505             (sc->facts->MsgVersion & MPI2_IOCFACTS_MSGVERSION_MINOR_MASK) >>
506             MPI2_IOCFACTS_MSGVERSION_MINOR_SHIFT);
507
508         mps_dprint(sc, MPS_INFO, "Firmware: %s, Driver: %s\n", sc->fw_version,
509             MPS_DRIVER_VERSION);
510         mps_dprint(sc, MPS_INFO, "IOCCapabilities: %b\n",
511              sc->facts->IOCCapabilities,
512             "\20" "\3ScsiTaskFull" "\4DiagTrace" "\5SnapBuf" "\6ExtBuf"
513             "\7EEDP" "\10BiDirTarg" "\11Multicast" "\14TransRetry" "\15IR"
514             "\16EventReplay" "\17RaidAccel" "\20MSIXIndex" "\21HostDisc");
515
516         /*
517          * If the chip doesn't support event replay then a hard reset will be
518          * required to trigger a full discovery.  Do the reset here then
519          * retransition to Ready.  A hard reset might have already been done,
520          * but it doesn't hurt to do it again.  Only do this if attaching, not
521          * for a Diag Reset.
522          */
523         if (attaching && ((sc->facts->IOCCapabilities &
524             MPI2_IOCFACTS_CAPABILITY_EVENT_REPLAY) == 0)) {
525                 mps_dprint(sc, MPS_INIT, "No event replay, reseting\n");
526                 mps_diag_reset(sc, NO_SLEEP);
527                 if ((error = mps_transition_ready(sc)) != 0) {
528                         mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to "
529                             "transition to ready with error %d, exit\n",
530                             error);
531                         return (error);
532                 }
533         }
534
535         /*
536          * Set flag if IR Firmware is loaded.  If the RAID Capability has
537          * changed from the previous IOC Facts, log a warning, but only if
538          * checking this after a Diag Reset and not during attach.
539          */
540         saved_mode = sc->ir_firmware;
541         if (sc->facts->IOCCapabilities &
542             MPI2_IOCFACTS_CAPABILITY_INTEGRATED_RAID)
543                 sc->ir_firmware = 1;
544         if (!attaching) {
545                 if (sc->ir_firmware != saved_mode) {
546                         mps_dprint(sc, MPS_INIT|MPS_FAULT, "new IR/IT mode "
547                             "in IOC Facts does not match previous mode\n");
548                 }
549         }
550
551         /* Only deallocate and reallocate if relevant IOC Facts have changed */
552         reallocating = FALSE;
553         sc->mps_flags &= ~MPS_FLAGS_REALLOCATED;
554
555         if ((!attaching) &&
556             ((saved_facts.MsgVersion != sc->facts->MsgVersion) ||
557             (saved_facts.HeaderVersion != sc->facts->HeaderVersion) ||
558             (saved_facts.MaxChainDepth != sc->facts->MaxChainDepth) ||
559             (saved_facts.RequestCredit != sc->facts->RequestCredit) ||
560             (saved_facts.ProductID != sc->facts->ProductID) ||
561             (saved_facts.IOCCapabilities != sc->facts->IOCCapabilities) ||
562             (saved_facts.IOCRequestFrameSize !=
563             sc->facts->IOCRequestFrameSize) ||
564             (saved_facts.MaxTargets != sc->facts->MaxTargets) ||
565             (saved_facts.MaxSasExpanders != sc->facts->MaxSasExpanders) ||
566             (saved_facts.MaxEnclosures != sc->facts->MaxEnclosures) ||
567             (saved_facts.HighPriorityCredit != sc->facts->HighPriorityCredit) ||
568             (saved_facts.MaxReplyDescriptorPostQueueDepth !=
569             sc->facts->MaxReplyDescriptorPostQueueDepth) ||
570             (saved_facts.ReplyFrameSize != sc->facts->ReplyFrameSize) ||
571             (saved_facts.MaxVolumes != sc->facts->MaxVolumes) ||
572             (saved_facts.MaxPersistentEntries !=
573             sc->facts->MaxPersistentEntries))) {
574                 reallocating = TRUE;
575
576                 /* Record that we reallocated everything */
577                 sc->mps_flags |= MPS_FLAGS_REALLOCATED;
578         }
579
580         /*
581          * Some things should be done if attaching or re-allocating after a Diag
582          * Reset, but are not needed after a Diag Reset if the FW has not
583          * changed.
584          */
585         if (attaching || reallocating) {
586                 /*
587                  * Check if controller supports FW diag buffers and set flag to
588                  * enable each type.
589                  */
590                 if (sc->facts->IOCCapabilities &
591                     MPI2_IOCFACTS_CAPABILITY_DIAG_TRACE_BUFFER)
592                         sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_TRACE].
593                             enabled = TRUE;
594                 if (sc->facts->IOCCapabilities &
595                     MPI2_IOCFACTS_CAPABILITY_SNAPSHOT_BUFFER)
596                         sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_SNAPSHOT].
597                             enabled = TRUE;
598                 if (sc->facts->IOCCapabilities &
599                     MPI2_IOCFACTS_CAPABILITY_EXTENDED_BUFFER)
600                         sc->fw_diag_buffer_list[MPI2_DIAG_BUF_TYPE_EXTENDED].
601                             enabled = TRUE;
602
603                 /*
604                  * Set flag if EEDP is supported and if TLR is supported.
605                  */
606                 if (sc->facts->IOCCapabilities & MPI2_IOCFACTS_CAPABILITY_EEDP)
607                         sc->eedp_enabled = TRUE;
608                 if (sc->facts->IOCCapabilities & MPI2_IOCFACTS_CAPABILITY_TLR)
609                         sc->control_TLR = TRUE;
610
611                 mps_resize_queues(sc);
612
613                 /*
614                  * Initialize all Tail Queues
615                  */
616                 TAILQ_INIT(&sc->req_list);
617                 TAILQ_INIT(&sc->high_priority_req_list);
618                 TAILQ_INIT(&sc->chain_list);
619                 TAILQ_INIT(&sc->tm_list);
620         }
621
622         /*
623          * If doing a Diag Reset and the FW is significantly different
624          * (reallocating will be set above in IOC Facts comparison), then all
625          * buffers based on the IOC Facts will need to be freed before they are
626          * reallocated.
627          */
628         if (reallocating) {
629                 mps_iocfacts_free(sc);
630                 mpssas_realloc_targets(sc, saved_facts.MaxTargets +
631                     saved_facts.MaxVolumes);
632         }
633
634         /*
635          * Any deallocation has been completed.  Now start reallocating
636          * if needed.  Will only need to reallocate if attaching or if the new
637          * IOC Facts are different from the previous IOC Facts after a Diag
638          * Reset. Targets have already been allocated above if needed.
639          */
640         error = 0;
641         while (attaching || reallocating) {
642                 if ((error = mps_alloc_hw_queues(sc)) != 0)
643                         break;
644                 if ((error = mps_alloc_replies(sc)) != 0)
645                         break;
646                 if ((error = mps_alloc_requests(sc)) != 0)
647                         break;
648                 if ((error = mps_alloc_queues(sc)) != 0)
649                         break;
650
651                 break;
652         }
653         if (error) {
654                 mps_dprint(sc, MPS_INIT|MPS_FAULT,
655                     "Failed to alloc queues with error %d\n", error);
656                 mps_free(sc);
657                 return (error);
658         }
659
660         /* Always initialize the queues */
661         bzero(sc->free_queue, sc->fqdepth * 4);
662         mps_init_queues(sc);
663
664         /*
665          * Always get the chip out of the reset state, but only panic if not
666          * attaching.  If attaching and there is an error, that is handled by
667          * the OS.
668          */
669         error = mps_transition_operational(sc);
670         if (error != 0) {
671                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to "
672                     "transition to operational with error %d\n", error);
673                 mps_free(sc);
674                 return (error);
675         }
676
677         /*
678          * Finish the queue initialization.
679          * These are set here instead of in mps_init_queues() because the
680          * IOC resets these values during the state transition in
681          * mps_transition_operational().  The free index is set to 1
682          * because the corresponding index in the IOC is set to 0, and the
683          * IOC treats the queues as full if both are set to the same value.
684          * Hence the reason that the queue can't hold all of the possible
685          * replies.
686          */
687         sc->replypostindex = 0;
688         mps_regwrite(sc, MPI2_REPLY_FREE_HOST_INDEX_OFFSET, sc->replyfreeindex);
689         mps_regwrite(sc, MPI2_REPLY_POST_HOST_INDEX_OFFSET, 0);
690
691         /*
692          * Attach the subsystems so they can prepare their event masks.
693          * XXX Should be dynamic so that IM/IR and user modules can attach
694          */
695         error = 0;
696         while (attaching) {
697                 mps_dprint(sc, MPS_INIT, "Attaching subsystems\n");
698                 if ((error = mps_attach_log(sc)) != 0)
699                         break;
700                 if ((error = mps_attach_sas(sc)) != 0)
701                         break;
702                 if ((error = mps_attach_user(sc)) != 0)
703                         break;
704                 break;
705         }
706         if (error) {
707                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to attach all "
708                     "subsystems: error %d\n", error);
709                 mps_free(sc);
710                 return (error);
711         }
712
713         /*
714          * XXX If the number of MSI-X vectors changes during re-init, this
715          * won't see it and adjust.
716          */
717         if (attaching && (error = mps_pci_setup_interrupts(sc)) != 0) {
718                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Failed to setup "
719                     "interrupts\n");
720                 mps_free(sc);
721                 return (error);
722         }
723
724         /*
725          * Set flag if this is a WD controller.  This shouldn't ever change, but
726          * reset it after a Diag Reset, just in case.
727          */
728         sc->WD_available = FALSE;
729         if (pci_get_device(sc->mps_dev) == MPI2_MFGPAGE_DEVID_SSS6200)
730                 sc->WD_available = TRUE;
731
732         return (error);
733 }
734
735 /*
736  * This is called if memory is being free (during detach for example) and when
737  * buffers need to be reallocated due to a Diag Reset.
738  */
739 static void
740 mps_iocfacts_free(struct mps_softc *sc)
741 {
742         struct mps_command *cm;
743         int i;
744
745         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
746
747         if (sc->free_busaddr != 0)
748                 bus_dmamap_unload(sc->queues_dmat, sc->queues_map);
749         if (sc->free_queue != NULL)
750                 bus_dmamem_free(sc->queues_dmat, sc->free_queue,
751                     sc->queues_map);
752         if (sc->queues_dmat != NULL)
753                 bus_dma_tag_destroy(sc->queues_dmat);
754
755         if (sc->chain_frames != NULL) {
756                 bus_dmamap_unload(sc->chain_dmat, sc->chain_map);
757                 bus_dmamem_free(sc->chain_dmat, sc->chain_frames,
758                     sc->chain_map);
759         }
760         if (sc->chain_dmat != NULL)
761                 bus_dma_tag_destroy(sc->chain_dmat);
762
763         if (sc->sense_busaddr != 0)
764                 bus_dmamap_unload(sc->sense_dmat, sc->sense_map);
765         if (sc->sense_frames != NULL)
766                 bus_dmamem_free(sc->sense_dmat, sc->sense_frames,
767                     sc->sense_map);
768         if (sc->sense_dmat != NULL)
769                 bus_dma_tag_destroy(sc->sense_dmat);
770
771         if (sc->reply_busaddr != 0)
772                 bus_dmamap_unload(sc->reply_dmat, sc->reply_map);
773         if (sc->reply_frames != NULL)
774                 bus_dmamem_free(sc->reply_dmat, sc->reply_frames,
775                     sc->reply_map);
776         if (sc->reply_dmat != NULL)
777                 bus_dma_tag_destroy(sc->reply_dmat);
778
779         if (sc->req_busaddr != 0)
780                 bus_dmamap_unload(sc->req_dmat, sc->req_map);
781         if (sc->req_frames != NULL)
782                 bus_dmamem_free(sc->req_dmat, sc->req_frames, sc->req_map);
783         if (sc->req_dmat != NULL)
784                 bus_dma_tag_destroy(sc->req_dmat);
785
786         if (sc->chains != NULL)
787                 free(sc->chains, M_MPT2);
788         if (sc->commands != NULL) {
789                 for (i = 1; i < sc->num_reqs; i++) {
790                         cm = &sc->commands[i];
791                         bus_dmamap_destroy(sc->buffer_dmat, cm->cm_dmamap);
792                 }
793                 free(sc->commands, M_MPT2);
794         }
795         if (sc->buffer_dmat != NULL)
796                 bus_dma_tag_destroy(sc->buffer_dmat);
797
798         mps_pci_free_interrupts(sc);
799         free(sc->queues, M_MPT2);
800         sc->queues = NULL;
801 }
802
803 /* 
804  * The terms diag reset and hard reset are used interchangeably in the MPI
805  * docs to mean resetting the controller chip.  In this code diag reset
806  * cleans everything up, and the hard reset function just sends the reset
807  * sequence to the chip.  This should probably be refactored so that every
808  * subsystem gets a reset notification of some sort, and can clean up
809  * appropriately.
810  */
811 int
812 mps_reinit(struct mps_softc *sc)
813 {
814         int error;
815         struct mpssas_softc *sassc;
816
817         sassc = sc->sassc;
818
819         MPS_FUNCTRACE(sc);
820
821         mtx_assert(&sc->mps_mtx, MA_OWNED);
822
823         mps_dprint(sc, MPS_INIT|MPS_INFO, "Reinitializing controller\n");
824         if (sc->mps_flags & MPS_FLAGS_DIAGRESET) {
825                 mps_dprint(sc, MPS_INIT, "Reset already in progress\n");
826                 return 0;
827         }
828
829         /* make sure the completion callbacks can recognize they're getting
830          * a NULL cm_reply due to a reset.
831          */
832         sc->mps_flags |= MPS_FLAGS_DIAGRESET;
833
834         /*
835          * Mask interrupts here.
836          */
837         mps_dprint(sc, MPS_INIT, "masking interrupts and resetting\n");
838         mps_mask_intr(sc);
839
840         error = mps_diag_reset(sc, CAN_SLEEP);
841         if (error != 0) {
842                 /* XXXSL No need to panic here */
843                 panic("%s hard reset failed with error %d\n",
844                     __func__, error);
845         }
846
847         /* Restore the PCI state, including the MSI-X registers */
848         mps_pci_restore(sc);
849
850         /* Give the I/O subsystem special priority to get itself prepared */
851         mpssas_handle_reinit(sc);
852
853         /*
854          * Get IOC Facts and allocate all structures based on this information.
855          * The attach function will also call mps_iocfacts_allocate at startup.
856          * If relevant values have changed in IOC Facts, this function will free
857          * all of the memory based on IOC Facts and reallocate that memory.
858          */
859         if ((error = mps_iocfacts_allocate(sc, FALSE)) != 0) {
860                 panic("%s IOC Facts based allocation failed with error %d\n",
861                     __func__, error);
862         }
863
864         /*
865          * Mapping structures will be re-allocated after getting IOC Page8, so
866          * free these structures here.
867          */
868         mps_mapping_exit(sc);
869
870         /*
871          * The static page function currently read is IOC Page8.  Others can be
872          * added in future.  It's possible that the values in IOC Page8 have
873          * changed after a Diag Reset due to user modification, so always read
874          * these.  Interrupts are masked, so unmask them before getting config
875          * pages.
876          */
877         mps_unmask_intr(sc);
878         sc->mps_flags &= ~MPS_FLAGS_DIAGRESET;
879         mps_base_static_config_pages(sc);
880
881         /*
882          * Some mapping info is based in IOC Page8 data, so re-initialize the
883          * mapping tables.
884          */
885         mps_mapping_initialize(sc);
886
887         /*
888          * Restart will reload the event masks clobbered by the reset, and
889          * then enable the port.
890          */
891         mps_reregister_events(sc);
892
893         /* the end of discovery will release the simq, so we're done. */
894         mps_dprint(sc, MPS_INIT|MPS_XINFO, "Finished sc %p post %u free %u\n", 
895             sc, sc->replypostindex, sc->replyfreeindex);
896
897         mpssas_release_simq_reinit(sassc);
898         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
899
900         return 0;
901 }
902
903 /* Wait for the chip to ACK a word that we've put into its FIFO 
904  * Wait for <timeout> seconds. In single loop wait for busy loop
905  * for 500 microseconds.
906  * Total is [ 0.5 * (2000 * <timeout>) ] in miliseconds.
907  * */
908 static int
909 mps_wait_db_ack(struct mps_softc *sc, int timeout, int sleep_flag)
910 {
911
912         u32 cntdn, count;
913         u32 int_status;
914         u32 doorbell;
915
916         count = 0;
917         cntdn = (sleep_flag == CAN_SLEEP) ? 1000*timeout : 2000*timeout;
918         do {
919                 int_status = mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET);
920                 if (!(int_status & MPI2_HIS_SYS2IOC_DB_STATUS)) {
921                         mps_dprint(sc, MPS_TRACE, 
922                         "%s: successful count(%d), timeout(%d)\n",
923                         __func__, count, timeout);
924                 return 0;
925                 } else if (int_status & MPI2_HIS_IOC2SYS_DB_STATUS) {
926                         doorbell = mps_regread(sc, MPI2_DOORBELL_OFFSET);
927                         if ((doorbell & MPI2_IOC_STATE_MASK) ==
928                                 MPI2_IOC_STATE_FAULT) {
929                                 mps_dprint(sc, MPS_FAULT, 
930                                         "fault_state(0x%04x)!\n", doorbell);
931                                 return (EFAULT);
932                         }
933                 } else if (int_status == 0xFFFFFFFF)
934                         goto out;
935
936                 /* If it can sleep, sleep for 1 milisecond, else busy loop for 
937                 * 0.5 milisecond */
938                 if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP)
939                         msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0, 
940                         "mpsdba", hz/1000);
941                 else if (sleep_flag == CAN_SLEEP)
942                         pause("mpsdba", hz/1000);
943                 else
944                         DELAY(500);
945                 count++;
946         } while (--cntdn);
947
948         out:
949         mps_dprint(sc, MPS_FAULT, "%s: failed due to timeout count(%d), "
950                 "int_status(%x)!\n", __func__, count, int_status);
951         return (ETIMEDOUT);
952
953 }
954
955 /* Wait for the chip to signal that the next word in its FIFO can be fetched */
956 static int
957 mps_wait_db_int(struct mps_softc *sc)
958 {
959         int retry;
960
961         for (retry = 0; retry < MPS_DB_MAX_WAIT; retry++) {
962                 if ((mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET) &
963                     MPI2_HIS_IOC2SYS_DB_STATUS) != 0)
964                         return (0);
965                 DELAY(2000);
966         }
967         return (ETIMEDOUT);
968 }
969
970 /* Step through the synchronous command state machine, i.e. "Doorbell mode" */
971 static int
972 mps_request_sync(struct mps_softc *sc, void *req, MPI2_DEFAULT_REPLY *reply,
973     int req_sz, int reply_sz, int timeout)
974 {
975         uint32_t *data32;
976         uint16_t *data16;
977         int i, count, ioc_sz, residual;
978         int sleep_flags = CAN_SLEEP;
979
980         if (curthread->td_no_sleeping != 0)
981                 sleep_flags = NO_SLEEP;
982
983         /* Step 1 */
984         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
985
986         /* Step 2 */
987         if (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED)
988                 return (EBUSY);
989
990         /* Step 3
991          * Announce that a message is coming through the doorbell.  Messages
992          * are pushed at 32bit words, so round up if needed.
993          */
994         count = (req_sz + 3) / 4;
995         mps_regwrite(sc, MPI2_DOORBELL_OFFSET,
996             (MPI2_FUNCTION_HANDSHAKE << MPI2_DOORBELL_FUNCTION_SHIFT) |
997             (count << MPI2_DOORBELL_ADD_DWORDS_SHIFT));
998
999         /* Step 4 */
1000         if (mps_wait_db_int(sc) ||
1001             (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED) == 0) {
1002                 mps_dprint(sc, MPS_FAULT, "Doorbell failed to activate\n");
1003                 return (ENXIO);
1004         }
1005         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1006         if (mps_wait_db_ack(sc, 5, sleep_flags) != 0) {
1007                 mps_dprint(sc, MPS_FAULT, "Doorbell handshake failed\n");
1008                 return (ENXIO);
1009         }
1010
1011         /* Step 5 */
1012         /* Clock out the message data synchronously in 32-bit dwords*/
1013         data32 = (uint32_t *)req;
1014         for (i = 0; i < count; i++) {
1015                 mps_regwrite(sc, MPI2_DOORBELL_OFFSET, htole32(data32[i]));
1016                 if (mps_wait_db_ack(sc, 5, sleep_flags) != 0) {
1017                         mps_dprint(sc, MPS_FAULT,
1018                             "Timeout while writing doorbell\n");
1019                         return (ENXIO);
1020                 }
1021         }
1022
1023         /* Step 6 */
1024         /* Clock in the reply in 16-bit words.  The total length of the
1025          * message is always in the 4th byte, so clock out the first 2 words
1026          * manually, then loop the rest.
1027          */
1028         data16 = (uint16_t *)reply;
1029         if (mps_wait_db_int(sc) != 0) {
1030                 mps_dprint(sc, MPS_FAULT, "Timeout reading doorbell 0\n");
1031                 return (ENXIO);
1032         }
1033         data16[0] =
1034             mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_DATA_MASK;
1035         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1036         if (mps_wait_db_int(sc) != 0) {
1037                 mps_dprint(sc, MPS_FAULT, "Timeout reading doorbell 1\n");
1038                 return (ENXIO);
1039         }
1040         data16[1] =
1041             mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_DATA_MASK;
1042         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1043
1044         /* Number of 32bit words in the message */
1045         ioc_sz = reply->MsgLength;
1046
1047         /*
1048          * Figure out how many 16bit words to clock in without overrunning.
1049          * The precision loss with dividing reply_sz can safely be
1050          * ignored because the messages can only be multiples of 32bits.
1051          */
1052         residual = 0;
1053         count = MIN((reply_sz / 4), ioc_sz) * 2;
1054         if (count < ioc_sz * 2) {
1055                 residual = ioc_sz * 2 - count;
1056                 mps_dprint(sc, MPS_ERROR, "Driver error, throwing away %d "
1057                     "residual message words\n", residual);
1058         }
1059
1060         for (i = 2; i < count; i++) {
1061                 if (mps_wait_db_int(sc) != 0) {
1062                         mps_dprint(sc, MPS_FAULT,
1063                             "Timeout reading doorbell %d\n", i);
1064                         return (ENXIO);
1065                 }
1066                 data16[i] = mps_regread(sc, MPI2_DOORBELL_OFFSET) &
1067                     MPI2_DOORBELL_DATA_MASK;
1068                 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1069         }
1070
1071         /*
1072          * Pull out residual words that won't fit into the provided buffer.
1073          * This keeps the chip from hanging due to a driver programming
1074          * error.
1075          */
1076         while (residual--) {
1077                 if (mps_wait_db_int(sc) != 0) {
1078                         mps_dprint(sc, MPS_FAULT,
1079                             "Timeout reading doorbell\n");
1080                         return (ENXIO);
1081                 }
1082                 (void)mps_regread(sc, MPI2_DOORBELL_OFFSET);
1083                 mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1084         }
1085
1086         /* Step 7 */
1087         if (mps_wait_db_int(sc) != 0) {
1088                 mps_dprint(sc, MPS_FAULT, "Timeout waiting to exit doorbell\n");
1089                 return (ENXIO);
1090         }
1091         if (mps_regread(sc, MPI2_DOORBELL_OFFSET) & MPI2_DOORBELL_USED)
1092                 mps_dprint(sc, MPS_FAULT, "Warning, doorbell still active\n");
1093         mps_regwrite(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET, 0x0);
1094
1095         return (0);
1096 }
1097
1098 static void
1099 mps_enqueue_request(struct mps_softc *sc, struct mps_command *cm)
1100 {
1101         reply_descriptor rd;
1102         MPS_FUNCTRACE(sc);
1103         mps_dprint(sc, MPS_TRACE, "SMID %u cm %p ccb %p\n",
1104             cm->cm_desc.Default.SMID, cm, cm->cm_ccb);
1105
1106         if (sc->mps_flags & MPS_FLAGS_ATTACH_DONE && !(sc->mps_flags & MPS_FLAGS_SHUTDOWN))
1107                 mtx_assert(&sc->mps_mtx, MA_OWNED);
1108
1109         if (++sc->io_cmds_active > sc->io_cmds_highwater)
1110                 sc->io_cmds_highwater++;
1111         rd.u.low = cm->cm_desc.Words.Low;
1112         rd.u.high = cm->cm_desc.Words.High;
1113         rd.word = htole64(rd.word);
1114
1115         KASSERT(cm->cm_state == MPS_CM_STATE_BUSY, ("command not busy\n"));
1116         cm->cm_state = MPS_CM_STATE_INQUEUE;
1117
1118         /* TODO-We may need to make below regwrite atomic */
1119         mps_regwrite(sc, MPI2_REQUEST_DESCRIPTOR_POST_LOW_OFFSET,
1120             rd.u.low);
1121         mps_regwrite(sc, MPI2_REQUEST_DESCRIPTOR_POST_HIGH_OFFSET,
1122             rd.u.high);
1123 }
1124
1125 /*
1126  * Just the FACTS, ma'am.
1127  */
1128 static int
1129 mps_get_iocfacts(struct mps_softc *sc, MPI2_IOC_FACTS_REPLY *facts)
1130 {
1131         MPI2_DEFAULT_REPLY *reply;
1132         MPI2_IOC_FACTS_REQUEST request;
1133         int error, req_sz, reply_sz;
1134
1135         MPS_FUNCTRACE(sc);
1136         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1137
1138         req_sz = sizeof(MPI2_IOC_FACTS_REQUEST);
1139         reply_sz = sizeof(MPI2_IOC_FACTS_REPLY);
1140         reply = (MPI2_DEFAULT_REPLY *)facts;
1141
1142         bzero(&request, req_sz);
1143         request.Function = MPI2_FUNCTION_IOC_FACTS;
1144         error = mps_request_sync(sc, &request, reply, req_sz, reply_sz, 5);
1145         mps_dprint(sc, MPS_INIT, "%s exit error= %d\n", __func__, error);
1146
1147         return (error);
1148 }
1149
1150 static int
1151 mps_send_iocinit(struct mps_softc *sc)
1152 {
1153         MPI2_IOC_INIT_REQUEST   init;
1154         MPI2_DEFAULT_REPLY      reply;
1155         int req_sz, reply_sz, error;
1156         struct timeval now;
1157         uint64_t time_in_msec;
1158
1159         MPS_FUNCTRACE(sc);
1160         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
1161
1162         /* Do a quick sanity check on proper initialization */
1163         if ((sc->pqdepth == 0) || (sc->fqdepth == 0) || (sc->reqframesz == 0)
1164             || (sc->replyframesz == 0)) {
1165                 mps_dprint(sc, MPS_INIT|MPS_ERROR,
1166                     "Driver not fully initialized for IOCInit\n");
1167                 return (EINVAL);
1168         }
1169
1170         req_sz = sizeof(MPI2_IOC_INIT_REQUEST);
1171         reply_sz = sizeof(MPI2_IOC_INIT_REPLY);
1172         bzero(&init, req_sz);
1173         bzero(&reply, reply_sz);
1174
1175         /*
1176          * Fill in the init block.  Note that most addresses are
1177          * deliberately in the lower 32bits of memory.  This is a micro-
1178          * optimzation for PCI/PCIX, though it's not clear if it helps PCIe.
1179          */
1180         init.Function = MPI2_FUNCTION_IOC_INIT;
1181         init.WhoInit = MPI2_WHOINIT_HOST_DRIVER;
1182         init.MsgVersion = htole16(MPI2_VERSION);
1183         init.HeaderVersion = htole16(MPI2_HEADER_VERSION);
1184         init.SystemRequestFrameSize = htole16((uint16_t)(sc->reqframesz / 4));
1185         init.ReplyDescriptorPostQueueDepth = htole16(sc->pqdepth);
1186         init.ReplyFreeQueueDepth = htole16(sc->fqdepth);
1187         init.SenseBufferAddressHigh = 0;
1188         init.SystemReplyAddressHigh = 0;
1189         init.SystemRequestFrameBaseAddress.High = 0;
1190         init.SystemRequestFrameBaseAddress.Low = htole32((uint32_t)sc->req_busaddr);
1191         init.ReplyDescriptorPostQueueAddress.High = 0;
1192         init.ReplyDescriptorPostQueueAddress.Low = htole32((uint32_t)sc->post_busaddr);
1193         init.ReplyFreeQueueAddress.High = 0;
1194         init.ReplyFreeQueueAddress.Low = htole32((uint32_t)sc->free_busaddr);
1195         getmicrotime(&now);
1196         time_in_msec = (now.tv_sec * 1000 + now.tv_usec/1000);
1197         init.TimeStamp.High = htole32((time_in_msec >> 32) & 0xFFFFFFFF);
1198         init.TimeStamp.Low = htole32(time_in_msec & 0xFFFFFFFF);
1199
1200         error = mps_request_sync(sc, &init, &reply, req_sz, reply_sz, 5);
1201         if ((reply.IOCStatus & MPI2_IOCSTATUS_MASK) != MPI2_IOCSTATUS_SUCCESS)
1202                 error = ENXIO;
1203
1204         mps_dprint(sc, MPS_INIT, "IOCInit status= 0x%x\n", reply.IOCStatus);
1205         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
1206         return (error);
1207 }
1208
1209 void
1210 mps_memaddr_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
1211 {
1212         bus_addr_t *addr;
1213
1214         addr = arg;
1215         *addr = segs[0].ds_addr;
1216 }
1217
1218 void
1219 mps_memaddr_wait_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
1220 {
1221         struct mps_busdma_context *ctx;
1222         int need_unload, need_free;
1223
1224         ctx = (struct mps_busdma_context *)arg;
1225         need_unload = 0;
1226         need_free = 0;
1227
1228         mps_lock(ctx->softc);
1229         ctx->error = error;
1230         ctx->completed = 1;
1231         if ((error == 0) && (ctx->abandoned == 0)) {
1232                 *ctx->addr = segs[0].ds_addr;
1233         } else {
1234                 if (nsegs != 0)
1235                         need_unload = 1;
1236                 if (ctx->abandoned != 0)
1237                         need_free = 1;
1238         }
1239         if (need_free == 0)
1240                 wakeup(ctx);
1241
1242         mps_unlock(ctx->softc);
1243
1244         if (need_unload != 0) {
1245                 bus_dmamap_unload(ctx->buffer_dmat,
1246                                   ctx->buffer_dmamap);
1247                 *ctx->addr = 0;
1248         }
1249
1250         if (need_free != 0)
1251                 free(ctx, M_MPSUSER);
1252 }
1253
1254 static int
1255 mps_alloc_queues(struct mps_softc *sc)
1256 {
1257         struct mps_queue *q;
1258         u_int nq, i;
1259
1260         nq = sc->msi_msgs;
1261         mps_dprint(sc, MPS_INIT|MPS_XINFO, "Allocating %d I/O queues\n", nq);
1262
1263         sc->queues = malloc(sizeof(struct mps_queue) * nq, M_MPT2,
1264             M_NOWAIT|M_ZERO);
1265         if (sc->queues == NULL)
1266                 return (ENOMEM);
1267
1268         for (i = 0; i < nq; i++) {
1269                 q = &sc->queues[i];
1270                 mps_dprint(sc, MPS_INIT, "Configuring queue %d %p\n", i, q);
1271                 q->sc = sc;
1272                 q->qnum = i;
1273         }
1274
1275         return (0);
1276 }
1277
1278 static int
1279 mps_alloc_hw_queues(struct mps_softc *sc)
1280 {
1281         bus_addr_t queues_busaddr;
1282         uint8_t *queues;
1283         int qsize, fqsize, pqsize;
1284
1285         /*
1286          * The reply free queue contains 4 byte entries in multiples of 16 and
1287          * aligned on a 16 byte boundary. There must always be an unused entry.
1288          * This queue supplies fresh reply frames for the firmware to use.
1289          *
1290          * The reply descriptor post queue contains 8 byte entries in
1291          * multiples of 16 and aligned on a 16 byte boundary.  This queue
1292          * contains filled-in reply frames sent from the firmware to the host.
1293          *
1294          * These two queues are allocated together for simplicity.
1295          */
1296         sc->fqdepth = roundup2(sc->num_replies + 1, 16);
1297         sc->pqdepth = roundup2(sc->num_replies + 1, 16);
1298         fqsize= sc->fqdepth * 4;
1299         pqsize = sc->pqdepth * 8;
1300         qsize = fqsize + pqsize;
1301
1302         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1303                                 16, 0,                  /* algnmnt, boundary */
1304                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1305                                 BUS_SPACE_MAXADDR,      /* highaddr */
1306                                 NULL, NULL,             /* filter, filterarg */
1307                                 qsize,                  /* maxsize */
1308                                 1,                      /* nsegments */
1309                                 qsize,                  /* maxsegsize */
1310                                 0,                      /* flags */
1311                                 NULL, NULL,             /* lockfunc, lockarg */
1312                                 &sc->queues_dmat)) {
1313                 mps_dprint(sc, MPS_ERROR, "Cannot allocate queues DMA tag\n");
1314                 return (ENOMEM);
1315         }
1316         if (bus_dmamem_alloc(sc->queues_dmat, (void **)&queues, BUS_DMA_NOWAIT,
1317             &sc->queues_map)) {
1318                 mps_dprint(sc, MPS_ERROR, "Cannot allocate queues memory\n");
1319                 return (ENOMEM);
1320         }
1321         bzero(queues, qsize);
1322         bus_dmamap_load(sc->queues_dmat, sc->queues_map, queues, qsize,
1323             mps_memaddr_cb, &queues_busaddr, 0);
1324
1325         sc->free_queue = (uint32_t *)queues;
1326         sc->free_busaddr = queues_busaddr;
1327         sc->post_queue = (MPI2_REPLY_DESCRIPTORS_UNION *)(queues + fqsize);
1328         sc->post_busaddr = queues_busaddr + fqsize;
1329         mps_dprint(sc, MPS_INIT, "free queue busaddr= %#016jx size= %d\n",
1330             (uintmax_t)sc->free_busaddr, fqsize);
1331         mps_dprint(sc, MPS_INIT, "reply queue busaddr= %#016jx size= %d\n",
1332             (uintmax_t)sc->post_busaddr, pqsize);
1333
1334         return (0);
1335 }
1336
1337 static int
1338 mps_alloc_replies(struct mps_softc *sc)
1339 {
1340         int rsize, num_replies;
1341
1342         /* Store the reply frame size in bytes rather than as 32bit words */
1343         sc->replyframesz = sc->facts->ReplyFrameSize * 4;
1344
1345         /*
1346          * sc->num_replies should be one less than sc->fqdepth.  We need to
1347          * allocate space for sc->fqdepth replies, but only sc->num_replies
1348          * replies can be used at once.
1349          */
1350         num_replies = max(sc->fqdepth, sc->num_replies);
1351
1352         rsize = sc->replyframesz * num_replies; 
1353         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1354                                 4, 0,                   /* algnmnt, boundary */
1355                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1356                                 BUS_SPACE_MAXADDR,      /* highaddr */
1357                                 NULL, NULL,             /* filter, filterarg */
1358                                 rsize,                  /* maxsize */
1359                                 1,                      /* nsegments */
1360                                 rsize,                  /* maxsegsize */
1361                                 0,                      /* flags */
1362                                 NULL, NULL,             /* lockfunc, lockarg */
1363                                 &sc->reply_dmat)) {
1364                 mps_dprint(sc, MPS_ERROR, "Cannot allocate replies DMA tag\n");
1365                 return (ENOMEM);
1366         }
1367         if (bus_dmamem_alloc(sc->reply_dmat, (void **)&sc->reply_frames,
1368             BUS_DMA_NOWAIT, &sc->reply_map)) {
1369                 mps_dprint(sc, MPS_ERROR, "Cannot allocate replies memory\n");
1370                 return (ENOMEM);
1371         }
1372         bzero(sc->reply_frames, rsize);
1373         bus_dmamap_load(sc->reply_dmat, sc->reply_map, sc->reply_frames, rsize,
1374             mps_memaddr_cb, &sc->reply_busaddr, 0);
1375
1376         mps_dprint(sc, MPS_INIT, "reply frames busaddr= %#016jx size= %d\n",
1377             (uintmax_t)sc->reply_busaddr, rsize);
1378
1379         return (0);
1380 }
1381
1382 static void
1383 mps_load_chains_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
1384 {
1385         struct mps_softc *sc = arg;
1386         struct mps_chain *chain;
1387         bus_size_t bo;
1388         int i, o, s;
1389
1390         if (error != 0)
1391                 return;
1392
1393         for (i = 0, o = 0, s = 0; s < nsegs; s++) {
1394                 for (bo = 0; bo + sc->reqframesz <= segs[s].ds_len;
1395                     bo += sc->reqframesz) {
1396                         chain = &sc->chains[i++];
1397                         chain->chain =(MPI2_SGE_IO_UNION *)(sc->chain_frames+o);
1398                         chain->chain_busaddr = segs[s].ds_addr + bo;
1399                         o += sc->reqframesz;
1400                         mps_free_chain(sc, chain);
1401                 }
1402                 if (bo != segs[s].ds_len)
1403                         o += segs[s].ds_len - bo;
1404         }
1405         sc->chain_free_lowwater = i;
1406 }
1407
1408 static int
1409 mps_alloc_requests(struct mps_softc *sc)
1410 {
1411         struct mps_command *cm;
1412         int i, rsize, nsegs;
1413
1414         rsize = sc->reqframesz * sc->num_reqs;
1415         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1416                                 16, 0,                  /* algnmnt, boundary */
1417                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1418                                 BUS_SPACE_MAXADDR,      /* highaddr */
1419                                 NULL, NULL,             /* filter, filterarg */
1420                                 rsize,                  /* maxsize */
1421                                 1,                      /* nsegments */
1422                                 rsize,                  /* maxsegsize */
1423                                 0,                      /* flags */
1424                                 NULL, NULL,             /* lockfunc, lockarg */
1425                                 &sc->req_dmat)) {
1426                 mps_dprint(sc, MPS_ERROR, "Cannot allocate request DMA tag\n");
1427                 return (ENOMEM);
1428         }
1429         if (bus_dmamem_alloc(sc->req_dmat, (void **)&sc->req_frames,
1430             BUS_DMA_NOWAIT, &sc->req_map)) {
1431                 mps_dprint(sc, MPS_ERROR, "Cannot allocate request memory\n");
1432                 return (ENOMEM);
1433         }
1434         bzero(sc->req_frames, rsize);
1435         bus_dmamap_load(sc->req_dmat, sc->req_map, sc->req_frames, rsize,
1436             mps_memaddr_cb, &sc->req_busaddr, 0);
1437         mps_dprint(sc, MPS_INIT, "request frames busaddr= %#016jx size= %d\n",
1438             (uintmax_t)sc->req_busaddr, rsize);
1439
1440         sc->chains = malloc(sizeof(struct mps_chain) * sc->num_chains, M_MPT2,
1441             M_NOWAIT | M_ZERO);
1442         if (!sc->chains) {
1443                 mps_dprint(sc, MPS_ERROR, "Cannot allocate chain memory\n");
1444                 return (ENOMEM);
1445         }
1446         rsize = sc->reqframesz * sc->num_chains;
1447         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1448                                 16, 0,                  /* algnmnt, boundary */
1449                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1450                                 BUS_SPACE_MAXADDR,      /* highaddr */
1451                                 NULL, NULL,             /* filter, filterarg */
1452                                 rsize,                  /* maxsize */
1453                                 howmany(rsize, PAGE_SIZE), /* nsegments */
1454                                 rsize,                  /* maxsegsize */
1455                                 0,                      /* flags */
1456                                 NULL, NULL,             /* lockfunc, lockarg */
1457                                 &sc->chain_dmat)) {
1458                 mps_dprint(sc, MPS_ERROR, "Cannot allocate chain DMA tag\n");
1459                 return (ENOMEM);
1460         }
1461         if (bus_dmamem_alloc(sc->chain_dmat, (void **)&sc->chain_frames,
1462             BUS_DMA_NOWAIT | BUS_DMA_ZERO, &sc->chain_map)) {
1463                 mps_dprint(sc, MPS_ERROR, "Cannot allocate chain memory\n");
1464                 return (ENOMEM);
1465         }
1466         if (bus_dmamap_load(sc->chain_dmat, sc->chain_map, sc->chain_frames,
1467             rsize, mps_load_chains_cb, sc, BUS_DMA_NOWAIT)) {
1468                 mps_dprint(sc, MPS_ERROR, "Cannot load chain memory\n");
1469                 bus_dmamem_free(sc->chain_dmat, sc->chain_frames,
1470                     sc->chain_map);
1471                 return (ENOMEM);
1472         }
1473
1474         rsize = MPS_SENSE_LEN * sc->num_reqs;
1475         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1476                                 1, 0,                   /* algnmnt, boundary */
1477                                 BUS_SPACE_MAXADDR_32BIT,/* lowaddr */
1478                                 BUS_SPACE_MAXADDR,      /* highaddr */
1479                                 NULL, NULL,             /* filter, filterarg */
1480                                 rsize,                  /* maxsize */
1481                                 1,                      /* nsegments */
1482                                 rsize,                  /* maxsegsize */
1483                                 0,                      /* flags */
1484                                 NULL, NULL,             /* lockfunc, lockarg */
1485                                 &sc->sense_dmat)) {
1486                 mps_dprint(sc, MPS_ERROR, "Cannot allocate sense DMA tag\n");
1487                 return (ENOMEM);
1488         }
1489         if (bus_dmamem_alloc(sc->sense_dmat, (void **)&sc->sense_frames,
1490             BUS_DMA_NOWAIT, &sc->sense_map)) {
1491                 mps_dprint(sc, MPS_ERROR, "Cannot allocate sense memory\n");
1492                 return (ENOMEM);
1493         }
1494         bzero(sc->sense_frames, rsize);
1495         bus_dmamap_load(sc->sense_dmat, sc->sense_map, sc->sense_frames, rsize,
1496             mps_memaddr_cb, &sc->sense_busaddr, 0);
1497         mps_dprint(sc, MPS_INIT, "sense frames busaddr= %#016jx size= %d\n",
1498             (uintmax_t)sc->sense_busaddr, rsize);
1499
1500         nsegs = (sc->maxio / PAGE_SIZE) + 1;
1501         if (bus_dma_tag_create( sc->mps_parent_dmat,    /* parent */
1502                                 1, 0,                   /* algnmnt, boundary */
1503                                 BUS_SPACE_MAXADDR,      /* lowaddr */
1504                                 BUS_SPACE_MAXADDR,      /* highaddr */
1505                                 NULL, NULL,             /* filter, filterarg */
1506                                 BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
1507                                 nsegs,                  /* nsegments */
1508                                 BUS_SPACE_MAXSIZE_24BIT,/* maxsegsize */
1509                                 BUS_DMA_ALLOCNOW,       /* flags */
1510                                 busdma_lock_mutex,      /* lockfunc */
1511                                 &sc->mps_mtx,           /* lockarg */
1512                                 &sc->buffer_dmat)) {
1513                 mps_dprint(sc, MPS_ERROR, "Cannot allocate buffer DMA tag\n");
1514                 return (ENOMEM);
1515         }
1516
1517         /*
1518          * SMID 0 cannot be used as a free command per the firmware spec.
1519          * Just drop that command instead of risking accounting bugs.
1520          */
1521         sc->commands = malloc(sizeof(struct mps_command) * sc->num_reqs,
1522             M_MPT2, M_WAITOK | M_ZERO);
1523         for (i = 1; i < sc->num_reqs; i++) {
1524                 cm = &sc->commands[i];
1525                 cm->cm_req = sc->req_frames + i * sc->reqframesz;
1526                 cm->cm_req_busaddr = sc->req_busaddr + i * sc->reqframesz;
1527                 cm->cm_sense = &sc->sense_frames[i];
1528                 cm->cm_sense_busaddr = sc->sense_busaddr + i * MPS_SENSE_LEN;
1529                 cm->cm_desc.Default.SMID = i;
1530                 cm->cm_sc = sc;
1531                 cm->cm_state = MPS_CM_STATE_BUSY;
1532                 TAILQ_INIT(&cm->cm_chain_list);
1533                 callout_init_mtx(&cm->cm_callout, &sc->mps_mtx, 0);
1534
1535                 /* XXX Is a failure here a critical problem? */
1536                 if (bus_dmamap_create(sc->buffer_dmat, 0, &cm->cm_dmamap) == 0)
1537                         if (i <= sc->num_prireqs)
1538                                 mps_free_high_priority_command(sc, cm);
1539                         else
1540                                 mps_free_command(sc, cm);
1541                 else {
1542                         panic("failed to allocate command %d\n", i);
1543                         sc->num_reqs = i;
1544                         break;
1545                 }
1546         }
1547
1548         return (0);
1549 }
1550
1551 static int
1552 mps_init_queues(struct mps_softc *sc)
1553 {
1554         int i;
1555
1556         memset((uint8_t *)sc->post_queue, 0xff, sc->pqdepth * 8);
1557
1558         /*
1559          * According to the spec, we need to use one less reply than we
1560          * have space for on the queue.  So sc->num_replies (the number we
1561          * use) should be less than sc->fqdepth (allocated size).
1562          */
1563         if (sc->num_replies >= sc->fqdepth)
1564                 return (EINVAL);
1565
1566         /*
1567          * Initialize all of the free queue entries.
1568          */
1569         for (i = 0; i < sc->fqdepth; i++)
1570                 sc->free_queue[i] = sc->reply_busaddr + (i * sc->replyframesz);
1571         sc->replyfreeindex = sc->num_replies;
1572
1573         return (0);
1574 }
1575
1576 /* Get the driver parameter tunables.  Lowest priority are the driver defaults.
1577  * Next are the global settings, if they exist.  Highest are the per-unit
1578  * settings, if they exist.
1579  */
1580 void
1581 mps_get_tunables(struct mps_softc *sc)
1582 {
1583         char tmpstr[80], mps_debug[80];
1584
1585         /* XXX default to some debugging for now */
1586         sc->mps_debug = MPS_INFO|MPS_FAULT;
1587         sc->disable_msix = 0;
1588         sc->disable_msi = 0;
1589         sc->max_msix = MPS_MSIX_MAX;
1590         sc->max_chains = MPS_CHAIN_FRAMES;
1591         sc->max_io_pages = MPS_MAXIO_PAGES;
1592         sc->enable_ssu = MPS_SSU_ENABLE_SSD_DISABLE_HDD;
1593         sc->spinup_wait_time = DEFAULT_SPINUP_WAIT;
1594         sc->use_phynum = 1;
1595         sc->max_reqframes = MPS_REQ_FRAMES;
1596         sc->max_prireqframes = MPS_PRI_REQ_FRAMES;
1597         sc->max_replyframes = MPS_REPLY_FRAMES;
1598         sc->max_evtframes = MPS_EVT_REPLY_FRAMES;
1599
1600         /*
1601          * Grab the global variables.
1602          */
1603         bzero(mps_debug, 80);
1604         if (TUNABLE_STR_FETCH("hw.mps.debug_level", mps_debug, 80) != 0)
1605                 mps_parse_debug(sc, mps_debug);
1606         TUNABLE_INT_FETCH("hw.mps.disable_msix", &sc->disable_msix);
1607         TUNABLE_INT_FETCH("hw.mps.disable_msi", &sc->disable_msi);
1608         TUNABLE_INT_FETCH("hw.mps.max_msix", &sc->max_msix);
1609         TUNABLE_INT_FETCH("hw.mps.max_chains", &sc->max_chains);
1610         TUNABLE_INT_FETCH("hw.mps.max_io_pages", &sc->max_io_pages);
1611         TUNABLE_INT_FETCH("hw.mps.enable_ssu", &sc->enable_ssu);
1612         TUNABLE_INT_FETCH("hw.mps.spinup_wait_time", &sc->spinup_wait_time);
1613         TUNABLE_INT_FETCH("hw.mps.use_phy_num", &sc->use_phynum);
1614         TUNABLE_INT_FETCH("hw.mps.max_reqframes", &sc->max_reqframes);
1615         TUNABLE_INT_FETCH("hw.mps.max_prireqframes", &sc->max_prireqframes);
1616         TUNABLE_INT_FETCH("hw.mps.max_replyframes", &sc->max_replyframes);
1617         TUNABLE_INT_FETCH("hw.mps.max_evtframes", &sc->max_evtframes);
1618
1619         /* Grab the unit-instance variables */
1620         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.debug_level",
1621             device_get_unit(sc->mps_dev));
1622         bzero(mps_debug, 80);
1623         if (TUNABLE_STR_FETCH(tmpstr, mps_debug, 80) != 0)
1624                 mps_parse_debug(sc, mps_debug);
1625
1626         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.disable_msix",
1627             device_get_unit(sc->mps_dev));
1628         TUNABLE_INT_FETCH(tmpstr, &sc->disable_msix);
1629
1630         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.disable_msi",
1631             device_get_unit(sc->mps_dev));
1632         TUNABLE_INT_FETCH(tmpstr, &sc->disable_msi);
1633
1634         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_msix",
1635             device_get_unit(sc->mps_dev));
1636         TUNABLE_INT_FETCH(tmpstr, &sc->max_msix);
1637
1638         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_chains",
1639             device_get_unit(sc->mps_dev));
1640         TUNABLE_INT_FETCH(tmpstr, &sc->max_chains);
1641
1642         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_io_pages",
1643             device_get_unit(sc->mps_dev));
1644         TUNABLE_INT_FETCH(tmpstr, &sc->max_io_pages);
1645
1646         bzero(sc->exclude_ids, sizeof(sc->exclude_ids));
1647         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.exclude_ids",
1648             device_get_unit(sc->mps_dev));
1649         TUNABLE_STR_FETCH(tmpstr, sc->exclude_ids, sizeof(sc->exclude_ids));
1650
1651         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.enable_ssu",
1652             device_get_unit(sc->mps_dev));
1653         TUNABLE_INT_FETCH(tmpstr, &sc->enable_ssu);
1654
1655         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.spinup_wait_time",
1656             device_get_unit(sc->mps_dev));
1657         TUNABLE_INT_FETCH(tmpstr, &sc->spinup_wait_time);
1658
1659         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.use_phy_num",
1660             device_get_unit(sc->mps_dev));
1661         TUNABLE_INT_FETCH(tmpstr, &sc->use_phynum);
1662
1663         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_reqframes",
1664             device_get_unit(sc->mps_dev));
1665         TUNABLE_INT_FETCH(tmpstr, &sc->max_reqframes);
1666
1667         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_prireqframes",
1668             device_get_unit(sc->mps_dev));
1669         TUNABLE_INT_FETCH(tmpstr, &sc->max_prireqframes);
1670
1671         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_replyframes",
1672             device_get_unit(sc->mps_dev));
1673         TUNABLE_INT_FETCH(tmpstr, &sc->max_replyframes);
1674
1675         snprintf(tmpstr, sizeof(tmpstr), "dev.mps.%d.max_evtframes",
1676             device_get_unit(sc->mps_dev));
1677         TUNABLE_INT_FETCH(tmpstr, &sc->max_evtframes);
1678
1679 }
1680
1681 static void
1682 mps_setup_sysctl(struct mps_softc *sc)
1683 {
1684         struct sysctl_ctx_list  *sysctl_ctx = NULL;
1685         struct sysctl_oid       *sysctl_tree = NULL;
1686         char tmpstr[80], tmpstr2[80];
1687
1688         /*
1689          * Setup the sysctl variable so the user can change the debug level
1690          * on the fly.
1691          */
1692         snprintf(tmpstr, sizeof(tmpstr), "MPS controller %d",
1693             device_get_unit(sc->mps_dev));
1694         snprintf(tmpstr2, sizeof(tmpstr2), "%d", device_get_unit(sc->mps_dev));
1695
1696         sysctl_ctx = device_get_sysctl_ctx(sc->mps_dev);
1697         if (sysctl_ctx != NULL)
1698                 sysctl_tree = device_get_sysctl_tree(sc->mps_dev);
1699
1700         if (sysctl_tree == NULL) {
1701                 sysctl_ctx_init(&sc->sysctl_ctx);
1702                 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
1703                     SYSCTL_STATIC_CHILDREN(_hw_mps), OID_AUTO, tmpstr2,
1704                     CTLFLAG_RD | CTLFLAG_MPSAFE, 0, tmpstr);
1705                 if (sc->sysctl_tree == NULL)
1706                         return;
1707                 sysctl_ctx = &sc->sysctl_ctx;
1708                 sysctl_tree = sc->sysctl_tree;
1709         }
1710
1711         SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1712             OID_AUTO, "debug_level", CTLTYPE_STRING | CTLFLAG_RW |CTLFLAG_MPSAFE,
1713             sc, 0, mps_debug_sysctl, "A", "mps debug level");
1714
1715         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1716             OID_AUTO, "disable_msix", CTLFLAG_RD, &sc->disable_msix, 0,
1717             "Disable the use of MSI-X interrupts");
1718
1719         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1720             OID_AUTO, "disable_msi", CTLFLAG_RD, &sc->disable_msi, 0,
1721             "Disable the use of MSI interrupts");
1722
1723         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1724             OID_AUTO, "max_msix", CTLFLAG_RD, &sc->max_msix, 0,
1725             "User-defined maximum number of MSIX queues");
1726
1727         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1728             OID_AUTO, "msix_msgs", CTLFLAG_RD, &sc->msi_msgs, 0,
1729             "Negotiated number of MSIX queues");
1730
1731         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1732             OID_AUTO, "max_reqframes", CTLFLAG_RD, &sc->max_reqframes, 0,
1733             "Total number of allocated request frames");
1734
1735         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1736             OID_AUTO, "max_prireqframes", CTLFLAG_RD, &sc->max_prireqframes, 0,
1737             "Total number of allocated high priority request frames");
1738
1739         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1740             OID_AUTO, "max_replyframes", CTLFLAG_RD, &sc->max_replyframes, 0,
1741             "Total number of allocated reply frames");
1742
1743         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1744             OID_AUTO, "max_evtframes", CTLFLAG_RD, &sc->max_evtframes, 0,
1745             "Total number of event frames allocated");
1746
1747         SYSCTL_ADD_STRING(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1748             OID_AUTO, "firmware_version", CTLFLAG_RD, sc->fw_version,
1749             strlen(sc->fw_version), "firmware version");
1750
1751         SYSCTL_ADD_STRING(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1752             OID_AUTO, "driver_version", CTLFLAG_RD, MPS_DRIVER_VERSION,
1753             strlen(MPS_DRIVER_VERSION), "driver version");
1754
1755         SYSCTL_ADD_STRING(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1756             OID_AUTO, "msg_version", CTLFLAG_RD, sc->msg_version,
1757             strlen(sc->msg_version), "message interface version");
1758
1759         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1760             OID_AUTO, "io_cmds_active", CTLFLAG_RD,
1761             &sc->io_cmds_active, 0, "number of currently active commands");
1762
1763         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1764             OID_AUTO, "io_cmds_highwater", CTLFLAG_RD,
1765             &sc->io_cmds_highwater, 0, "maximum active commands seen");
1766
1767         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1768             OID_AUTO, "chain_free", CTLFLAG_RD,
1769             &sc->chain_free, 0, "number of free chain elements");
1770
1771         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1772             OID_AUTO, "chain_free_lowwater", CTLFLAG_RD,
1773             &sc->chain_free_lowwater, 0,"lowest number of free chain elements");
1774
1775         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1776             OID_AUTO, "max_chains", CTLFLAG_RD,
1777             &sc->max_chains, 0,"maximum chain frames that will be allocated");
1778
1779         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1780             OID_AUTO, "max_io_pages", CTLFLAG_RD,
1781             &sc->max_io_pages, 0,"maximum pages to allow per I/O (if <1 use "
1782             "IOCFacts)");
1783
1784         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1785             OID_AUTO, "enable_ssu", CTLFLAG_RW, &sc->enable_ssu, 0,
1786             "enable SSU to SATA SSD/HDD at shutdown");
1787
1788         SYSCTL_ADD_UQUAD(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1789             OID_AUTO, "chain_alloc_fail", CTLFLAG_RD,
1790             &sc->chain_alloc_fail, "chain allocation failures");
1791
1792         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1793             OID_AUTO, "spinup_wait_time", CTLFLAG_RD,
1794             &sc->spinup_wait_time, DEFAULT_SPINUP_WAIT, "seconds to wait for "
1795             "spinup after SATA ID error");
1796
1797         SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1798             OID_AUTO, "mapping_table_dump",
1799             CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT, sc, 0,
1800             mps_mapping_dump, "A", "Mapping Table Dump");
1801
1802         SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1803             OID_AUTO, "encl_table_dump",
1804             CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT, sc, 0,
1805             mps_mapping_encl_dump, "A", "Enclosure Table Dump");
1806
1807         SYSCTL_ADD_PROC(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1808             OID_AUTO, "dump_reqs",
1809             CTLTYPE_OPAQUE | CTLFLAG_RD | CTLFLAG_SKIP | CTLFLAG_NEEDGIANT,
1810             sc, 0, mps_dump_reqs, "I", "Dump Active Requests");
1811
1812         SYSCTL_ADD_INT(sysctl_ctx, SYSCTL_CHILDREN(sysctl_tree),
1813             OID_AUTO, "use_phy_num", CTLFLAG_RD, &sc->use_phynum, 0,
1814             "Use the phy number for enumeration");
1815 }
1816
1817 static struct mps_debug_string {
1818         char    *name;
1819         int     flag;
1820 } mps_debug_strings[] = {
1821         {"info", MPS_INFO},
1822         {"fault", MPS_FAULT},
1823         {"event", MPS_EVENT},
1824         {"log", MPS_LOG},
1825         {"recovery", MPS_RECOVERY},
1826         {"error", MPS_ERROR},
1827         {"init", MPS_INIT},
1828         {"xinfo", MPS_XINFO},
1829         {"user", MPS_USER},
1830         {"mapping", MPS_MAPPING},
1831         {"trace", MPS_TRACE}
1832 };
1833
1834 enum mps_debug_level_combiner {
1835         COMB_NONE,
1836         COMB_ADD,
1837         COMB_SUB
1838 };
1839
1840 static int
1841 mps_debug_sysctl(SYSCTL_HANDLER_ARGS)
1842 {
1843         struct mps_softc *sc;
1844         struct mps_debug_string *string;
1845         struct sbuf *sbuf;
1846         char *buffer;
1847         size_t sz;
1848         int i, len, debug, error;
1849
1850         sc = (struct mps_softc *)arg1;
1851
1852         error = sysctl_wire_old_buffer(req, 0);
1853         if (error != 0)
1854                 return (error);
1855
1856         sbuf = sbuf_new_for_sysctl(NULL, NULL, 128, req);
1857         debug = sc->mps_debug;
1858
1859         sbuf_printf(sbuf, "%#x", debug);
1860
1861         sz = sizeof(mps_debug_strings) / sizeof(mps_debug_strings[0]);
1862         for (i = 0; i < sz; i++) {
1863                 string = &mps_debug_strings[i];
1864                 if (debug & string->flag)
1865                         sbuf_printf(sbuf, ",%s", string->name);
1866         }
1867
1868         error = sbuf_finish(sbuf);
1869         sbuf_delete(sbuf);
1870
1871         if (error || req->newptr == NULL)
1872                 return (error);
1873
1874         len = req->newlen - req->newidx;
1875         if (len == 0)
1876                 return (0);
1877
1878         buffer = malloc(len, M_MPT2, M_ZERO|M_WAITOK);
1879         error = SYSCTL_IN(req, buffer, len);
1880
1881         mps_parse_debug(sc, buffer);
1882
1883         free(buffer, M_MPT2);
1884         return (error);
1885 }
1886
1887 static void
1888 mps_parse_debug(struct mps_softc *sc, char *list)
1889 {
1890         struct mps_debug_string *string;
1891         enum mps_debug_level_combiner op;
1892         char *token, *endtoken;
1893         size_t sz;
1894         int flags, i;
1895
1896         if (list == NULL || *list == '\0')
1897                 return;
1898
1899         if (*list == '+') {
1900                 op = COMB_ADD;
1901                 list++;
1902         } else if (*list == '-') {
1903                 op = COMB_SUB;
1904                 list++;
1905         } else
1906                 op = COMB_NONE;
1907         if (*list == '\0')
1908                 return;
1909
1910         flags = 0;
1911         sz = sizeof(mps_debug_strings) / sizeof(mps_debug_strings[0]);
1912         while ((token = strsep(&list, ":,")) != NULL) {
1913
1914                 /* Handle integer flags */
1915                 flags |= strtol(token, &endtoken, 0);
1916                 if (token != endtoken)
1917                         continue;
1918
1919                 /* Handle text flags */
1920                 for (i = 0; i < sz; i++) {
1921                         string = &mps_debug_strings[i];
1922                         if (strcasecmp(token, string->name) == 0) {
1923                                 flags |= string->flag;
1924                                 break;
1925                         }
1926                 }
1927         }
1928
1929         switch (op) {
1930         case COMB_NONE:
1931                 sc->mps_debug = flags;
1932                 break;
1933         case COMB_ADD:
1934                 sc->mps_debug |= flags;
1935                 break;
1936         case COMB_SUB:
1937                 sc->mps_debug &= (~flags);
1938                 break;
1939         }
1940
1941         return;
1942 }
1943
1944 struct mps_dumpreq_hdr {
1945         uint32_t        smid;
1946         uint32_t        state;
1947         uint32_t        numframes;
1948         uint32_t        deschi;
1949         uint32_t        desclo;
1950 };
1951
1952 static int
1953 mps_dump_reqs(SYSCTL_HANDLER_ARGS)
1954 {
1955         struct mps_softc *sc;
1956         struct mps_chain *chain, *chain1;
1957         struct mps_command *cm;
1958         struct mps_dumpreq_hdr hdr;
1959         struct sbuf *sb;
1960         uint32_t smid, state;
1961         int i, numreqs, error = 0;
1962
1963         sc = (struct mps_softc *)arg1;
1964
1965         if ((error = priv_check(curthread, PRIV_DRIVER)) != 0) {
1966                 printf("priv check error %d\n", error);
1967                 return (error);
1968         }
1969
1970         state = MPS_CM_STATE_INQUEUE;
1971         smid = 1;
1972         numreqs = sc->num_reqs;
1973
1974         if (req->newptr != NULL)
1975                 return (EINVAL);
1976
1977         if (smid == 0 || smid > sc->num_reqs)
1978                 return (EINVAL);
1979         if (numreqs <= 0 || (numreqs + smid > sc->num_reqs))
1980                 numreqs = sc->num_reqs;
1981         sb = sbuf_new_for_sysctl(NULL, NULL, 4096, req);
1982
1983         /* Best effort, no locking */
1984         for (i = smid; i < numreqs; i++) {
1985                 cm = &sc->commands[i];
1986                 if (cm->cm_state != state)
1987                         continue;
1988                 hdr.smid = i;
1989                 hdr.state = cm->cm_state;
1990                 hdr.numframes = 1;
1991                 hdr.deschi = cm->cm_desc.Words.High;
1992                 hdr.desclo = cm->cm_desc.Words.Low;
1993                 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link,
1994                    chain1)
1995                         hdr.numframes++;
1996                 sbuf_bcat(sb, &hdr, sizeof(hdr));
1997                 sbuf_bcat(sb, cm->cm_req, 128);
1998                 TAILQ_FOREACH_SAFE(chain, &cm->cm_chain_list, chain_link,
1999                     chain1)
2000                         sbuf_bcat(sb, chain->chain, 128);
2001         }
2002
2003         error = sbuf_finish(sb);
2004         sbuf_delete(sb);
2005         return (error);
2006 }
2007
2008 int
2009 mps_attach(struct mps_softc *sc)
2010 {
2011         int error;
2012
2013         MPS_FUNCTRACE(sc);
2014         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
2015
2016         mtx_init(&sc->mps_mtx, "MPT2SAS lock", NULL, MTX_DEF);
2017         callout_init_mtx(&sc->periodic, &sc->mps_mtx, 0);
2018         callout_init_mtx(&sc->device_check_callout, &sc->mps_mtx, 0);
2019         TAILQ_INIT(&sc->event_list);
2020         timevalclear(&sc->lastfail);
2021
2022         if ((error = mps_transition_ready(sc)) != 0) {
2023                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "failed to transition "
2024                     "ready\n");
2025                 return (error);
2026         }
2027
2028         sc->facts = malloc(sizeof(MPI2_IOC_FACTS_REPLY), M_MPT2,
2029             M_ZERO|M_NOWAIT);
2030         if(!sc->facts) {
2031                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "Cannot allocate memory, "
2032                     "exit\n");
2033                 return (ENOMEM);
2034         }
2035
2036         /*
2037          * Get IOC Facts and allocate all structures based on this information.
2038          * A Diag Reset will also call mps_iocfacts_allocate and re-read the IOC
2039          * Facts. If relevant values have changed in IOC Facts, this function
2040          * will free all of the memory based on IOC Facts and reallocate that
2041          * memory.  If this fails, any allocated memory should already be freed.
2042          */
2043         if ((error = mps_iocfacts_allocate(sc, TRUE)) != 0) {
2044                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "IOC Facts based allocation "
2045                     "failed with error %d, exit\n", error);
2046                 return (error);
2047         }
2048
2049         /* Start the periodic watchdog check on the IOC Doorbell */
2050         mps_periodic(sc);
2051
2052         /*
2053          * The portenable will kick off discovery events that will drive the
2054          * rest of the initialization process.  The CAM/SAS module will
2055          * hold up the boot sequence until discovery is complete.
2056          */
2057         sc->mps_ich.ich_func = mps_startup;
2058         sc->mps_ich.ich_arg = sc;
2059         if (config_intrhook_establish(&sc->mps_ich) != 0) {
2060                 mps_dprint(sc, MPS_INIT|MPS_ERROR,
2061                     "Cannot establish MPS config hook\n");
2062                 error = EINVAL;
2063         }
2064
2065         /*
2066          * Allow IR to shutdown gracefully when shutdown occurs.
2067          */
2068         sc->shutdown_eh = EVENTHANDLER_REGISTER(shutdown_final,
2069             mpssas_ir_shutdown, sc, SHUTDOWN_PRI_DEFAULT);
2070
2071         if (sc->shutdown_eh == NULL)
2072                 mps_dprint(sc, MPS_INIT|MPS_ERROR,
2073                     "shutdown event registration failed\n");
2074
2075         mps_setup_sysctl(sc);
2076
2077         sc->mps_flags |= MPS_FLAGS_ATTACH_DONE;
2078         mps_dprint(sc, MPS_INIT, "%s exit error= %d\n", __func__, error);
2079
2080         return (error);
2081 }
2082
2083 /* Run through any late-start handlers. */
2084 static void
2085 mps_startup(void *arg)
2086 {
2087         struct mps_softc *sc;
2088
2089         sc = (struct mps_softc *)arg;
2090         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
2091
2092         mps_lock(sc);
2093         mps_unmask_intr(sc);
2094
2095         /* initialize device mapping tables */
2096         mps_base_static_config_pages(sc);
2097         mps_mapping_initialize(sc);
2098         mpssas_startup(sc);
2099         mps_unlock(sc);
2100
2101         mps_dprint(sc, MPS_INIT, "disestablish config intrhook\n");
2102         config_intrhook_disestablish(&sc->mps_ich);
2103         sc->mps_ich.ich_arg = NULL;
2104
2105         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
2106 }
2107
2108 /* Periodic watchdog.  Is called with the driver lock already held. */
2109 static void
2110 mps_periodic(void *arg)
2111 {
2112         struct mps_softc *sc;
2113         uint32_t db;
2114
2115         sc = (struct mps_softc *)arg;
2116         if (sc->mps_flags & MPS_FLAGS_SHUTDOWN)
2117                 return;
2118
2119         db = mps_regread(sc, MPI2_DOORBELL_OFFSET);
2120         if ((db & MPI2_IOC_STATE_MASK) == MPI2_IOC_STATE_FAULT) {
2121                 mps_dprint(sc, MPS_FAULT, "IOC Fault 0x%08x, Resetting\n", db);
2122                 mps_reinit(sc);
2123         }
2124
2125         callout_reset(&sc->periodic, MPS_PERIODIC_DELAY * hz, mps_periodic, sc);
2126 }
2127
2128 static void
2129 mps_log_evt_handler(struct mps_softc *sc, uintptr_t data,
2130     MPI2_EVENT_NOTIFICATION_REPLY *event)
2131 {
2132         MPI2_EVENT_DATA_LOG_ENTRY_ADDED *entry;
2133
2134         MPS_DPRINT_EVENT(sc, generic, event);
2135
2136         switch (event->Event) {
2137         case MPI2_EVENT_LOG_DATA:
2138                 mps_dprint(sc, MPS_EVENT, "MPI2_EVENT_LOG_DATA:\n");
2139                 if (sc->mps_debug & MPS_EVENT)
2140                         hexdump(event->EventData, event->EventDataLength, NULL, 0);
2141                 break;
2142         case MPI2_EVENT_LOG_ENTRY_ADDED:
2143                 entry = (MPI2_EVENT_DATA_LOG_ENTRY_ADDED *)event->EventData;
2144                 mps_dprint(sc, MPS_EVENT, "MPI2_EVENT_LOG_ENTRY_ADDED event "
2145                     "0x%x Sequence %d:\n", entry->LogEntryQualifier,
2146                      entry->LogSequence);
2147                 break;
2148         default:
2149                 break;
2150         }
2151         return;
2152 }
2153
2154 static int
2155 mps_attach_log(struct mps_softc *sc)
2156 {
2157         u32 events[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
2158
2159         bzero(events, 16);
2160         setbit(events, MPI2_EVENT_LOG_DATA);
2161         setbit(events, MPI2_EVENT_LOG_ENTRY_ADDED);
2162
2163         mps_register_events(sc, events, mps_log_evt_handler, NULL,
2164             &sc->mps_log_eh);
2165
2166         return (0);
2167 }
2168
2169 static int
2170 mps_detach_log(struct mps_softc *sc)
2171 {
2172
2173         if (sc->mps_log_eh != NULL)
2174                 mps_deregister_events(sc, sc->mps_log_eh);
2175         return (0);
2176 }
2177
2178 /*
2179  * Free all of the driver resources and detach submodules.  Should be called
2180  * without the lock held.
2181  */
2182 int
2183 mps_free(struct mps_softc *sc)
2184 {
2185         int error;
2186
2187         mps_dprint(sc, MPS_INIT, "%s entered\n", __func__);
2188         /* Turn off the watchdog */
2189         mps_lock(sc);
2190         sc->mps_flags |= MPS_FLAGS_SHUTDOWN;
2191         mps_unlock(sc);
2192         /* Lock must not be held for this */
2193         callout_drain(&sc->periodic);
2194         callout_drain(&sc->device_check_callout);
2195
2196         if (((error = mps_detach_log(sc)) != 0) ||
2197             ((error = mps_detach_sas(sc)) != 0)) {
2198                 mps_dprint(sc, MPS_INIT|MPS_FAULT, "failed to detach "
2199                     "subsystems, exit\n");
2200                 return (error);
2201         }
2202
2203         mps_detach_user(sc);
2204
2205         /* Put the IOC back in the READY state. */
2206         mps_lock(sc);
2207         if ((error = mps_transition_ready(sc)) != 0) {
2208                 mps_unlock(sc);
2209                 return (error);
2210         }
2211         mps_unlock(sc);
2212
2213         if (sc->facts != NULL)
2214                 free(sc->facts, M_MPT2);
2215
2216         /*
2217          * Free all buffers that are based on IOC Facts.  A Diag Reset may need
2218          * to free these buffers too.
2219          */
2220         mps_iocfacts_free(sc);
2221
2222         if (sc->sysctl_tree != NULL)
2223                 sysctl_ctx_free(&sc->sysctl_ctx);
2224
2225         /* Deregister the shutdown function */
2226         if (sc->shutdown_eh != NULL)
2227                 EVENTHANDLER_DEREGISTER(shutdown_final, sc->shutdown_eh);
2228
2229         mtx_destroy(&sc->mps_mtx);
2230         mps_dprint(sc, MPS_INIT, "%s exit\n", __func__);
2231
2232         return (0);
2233 }
2234
2235 static __inline void
2236 mps_complete_command(struct mps_softc *sc, struct mps_command *cm)
2237 {
2238         MPS_FUNCTRACE(sc);
2239
2240         if (cm == NULL) {
2241                 mps_dprint(sc, MPS_ERROR, "Completing NULL command\n");
2242                 return;
2243         }
2244
2245         if (cm->cm_flags & MPS_CM_FLAGS_POLLED)
2246                 cm->cm_flags |= MPS_CM_FLAGS_COMPLETE;
2247
2248         if (cm->cm_complete != NULL) {
2249                 mps_dprint(sc, MPS_TRACE,
2250                            "%s cm %p calling cm_complete %p data %p reply %p\n",
2251                            __func__, cm, cm->cm_complete, cm->cm_complete_data,
2252                            cm->cm_reply);
2253                 cm->cm_complete(sc, cm);
2254         }
2255
2256         if (cm->cm_flags & MPS_CM_FLAGS_WAKEUP) {
2257                 mps_dprint(sc, MPS_TRACE, "waking up %p\n", cm);
2258                 wakeup(cm);
2259         }
2260
2261         if (cm->cm_sc->io_cmds_active != 0) {
2262                 cm->cm_sc->io_cmds_active--;
2263         } else {
2264                 mps_dprint(sc, MPS_ERROR, "Warning: io_cmds_active is "
2265                     "out of sync - resynching to 0\n");
2266         }
2267 }
2268
2269
2270 static void
2271 mps_sas_log_info(struct mps_softc *sc , u32 log_info)
2272 {
2273         union loginfo_type {
2274                 u32     loginfo;
2275                 struct {
2276                         u32     subcode:16;
2277                         u32     code:8;
2278                         u32     originator:4;
2279                         u32     bus_type:4;
2280                 } dw;
2281         };
2282         union loginfo_type sas_loginfo;
2283         char *originator_str = NULL;
2284
2285         sas_loginfo.loginfo = log_info;
2286         if (sas_loginfo.dw.bus_type != 3 /*SAS*/)
2287                 return;
2288
2289         /* each nexus loss loginfo */
2290         if (log_info == 0x31170000)
2291                 return;
2292
2293         /* eat the loginfos associated with task aborts */
2294         if ((log_info == 30050000 || log_info ==
2295             0x31140000 || log_info == 0x31130000))
2296                 return;
2297
2298         switch (sas_loginfo.dw.originator) {
2299         case 0:
2300                 originator_str = "IOP";
2301                 break;
2302         case 1:
2303                 originator_str = "PL";
2304                 break;
2305         case 2:
2306                 originator_str = "IR";
2307                 break;
2308 }
2309
2310         mps_dprint(sc, MPS_LOG, "log_info(0x%08x): originator(%s), "
2311         "code(0x%02x), sub_code(0x%04x)\n", log_info,
2312         originator_str, sas_loginfo.dw.code,
2313         sas_loginfo.dw.subcode);
2314 }
2315
2316 static void
2317 mps_display_reply_info(struct mps_softc *sc, uint8_t *reply)
2318 {
2319         MPI2DefaultReply_t *mpi_reply;
2320         u16 sc_status;
2321
2322         mpi_reply = (MPI2DefaultReply_t*)reply;
2323         sc_status = le16toh(mpi_reply->IOCStatus);
2324         if (sc_status & MPI2_IOCSTATUS_FLAG_LOG_INFO_AVAILABLE)
2325                 mps_sas_log_info(sc, le32toh(mpi_reply->IOCLogInfo));
2326 }
2327 void
2328 mps_intr(void *data)
2329 {
2330         struct mps_softc *sc;
2331         uint32_t status;
2332
2333         sc = (struct mps_softc *)data;
2334         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2335
2336         /*
2337          * Check interrupt status register to flush the bus.  This is
2338          * needed for both INTx interrupts and driver-driven polling
2339          */
2340         status = mps_regread(sc, MPI2_HOST_INTERRUPT_STATUS_OFFSET);
2341         if ((status & MPI2_HIS_REPLY_DESCRIPTOR_INTERRUPT) == 0)
2342                 return;
2343
2344         mps_lock(sc);
2345         mps_intr_locked(data);
2346         mps_unlock(sc);
2347         return;
2348 }
2349
2350 /*
2351  * In theory, MSI/MSIX interrupts shouldn't need to read any registers on the
2352  * chip.  Hopefully this theory is correct.
2353  */
2354 void
2355 mps_intr_msi(void *data)
2356 {
2357         struct mps_softc *sc;
2358
2359         sc = (struct mps_softc *)data;
2360         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2361         mps_lock(sc);
2362         mps_intr_locked(data);
2363         mps_unlock(sc);
2364         return;
2365 }
2366
2367 /*
2368  * The locking is overly broad and simplistic, but easy to deal with for now.
2369  */
2370 void
2371 mps_intr_locked(void *data)
2372 {
2373         MPI2_REPLY_DESCRIPTORS_UNION *desc;
2374         MPI2_DIAG_RELEASE_REPLY *rel_rep;
2375         mps_fw_diagnostic_buffer_t *pBuffer;
2376         struct mps_softc *sc;
2377         struct mps_command *cm = NULL;
2378         uint64_t tdesc;
2379         uint8_t flags;
2380         u_int pq;
2381
2382         sc = (struct mps_softc *)data;
2383
2384         pq = sc->replypostindex;
2385         mps_dprint(sc, MPS_TRACE,
2386             "%s sc %p starting with replypostindex %u\n", 
2387             __func__, sc, sc->replypostindex);
2388
2389         for ( ;; ) {
2390                 cm = NULL;
2391                 desc = &sc->post_queue[sc->replypostindex];
2392
2393                 /*
2394                  * Copy and clear out the descriptor so that any reentry will
2395                  * immediately know that this descriptor has already been
2396                  * looked at.  There is unfortunate casting magic because the
2397                  * MPI API doesn't have a cardinal 64bit type.
2398                  */
2399                 tdesc = 0xffffffffffffffff;
2400                 tdesc = atomic_swap_64((uint64_t *)desc, tdesc);
2401                 desc = (MPI2_REPLY_DESCRIPTORS_UNION *)&tdesc;
2402
2403                 flags = desc->Default.ReplyFlags &
2404                     MPI2_RPY_DESCRIPT_FLAGS_TYPE_MASK;
2405                 if ((flags == MPI2_RPY_DESCRIPT_FLAGS_UNUSED)
2406                  || (le32toh(desc->Words.High) == 0xffffffff))
2407                         break;
2408
2409                 /* increment the replypostindex now, so that event handlers
2410                  * and cm completion handlers which decide to do a diag
2411                  * reset can zero it without it getting incremented again
2412                  * afterwards, and we break out of this loop on the next
2413                  * iteration since the reply post queue has been cleared to
2414                  * 0xFF and all descriptors look unused (which they are).
2415                  */
2416                 if (++sc->replypostindex >= sc->pqdepth)
2417                         sc->replypostindex = 0;
2418
2419                 switch (flags) {
2420                 case MPI2_RPY_DESCRIPT_FLAGS_SCSI_IO_SUCCESS:
2421                         cm = &sc->commands[le16toh(desc->SCSIIOSuccess.SMID)];
2422                         KASSERT(cm->cm_state == MPS_CM_STATE_INQUEUE,
2423                             ("command not inqueue\n"));
2424                         cm->cm_state = MPS_CM_STATE_BUSY;
2425                         cm->cm_reply = NULL;
2426                         break;
2427                 case MPI2_RPY_DESCRIPT_FLAGS_ADDRESS_REPLY:
2428                 {
2429                         uint32_t baddr;
2430                         uint8_t *reply;
2431
2432                         /*
2433                          * Re-compose the reply address from the address
2434                          * sent back from the chip.  The ReplyFrameAddress
2435                          * is the lower 32 bits of the physical address of
2436                          * particular reply frame.  Convert that address to
2437                          * host format, and then use that to provide the
2438                          * offset against the virtual address base
2439                          * (sc->reply_frames).
2440                          */
2441                         baddr = le32toh(desc->AddressReply.ReplyFrameAddress);
2442                         reply = sc->reply_frames +
2443                                 (baddr - ((uint32_t)sc->reply_busaddr));
2444                         /*
2445                          * Make sure the reply we got back is in a valid
2446                          * range.  If not, go ahead and panic here, since
2447                          * we'll probably panic as soon as we deference the
2448                          * reply pointer anyway.
2449                          */
2450                         if ((reply < sc->reply_frames)
2451                          || (reply > (sc->reply_frames +
2452                              (sc->fqdepth * sc->replyframesz)))) {
2453                                 printf("%s: WARNING: reply %p out of range!\n",
2454                                        __func__, reply);
2455                                 printf("%s: reply_frames %p, fqdepth %d, "
2456                                        "frame size %d\n", __func__,
2457                                        sc->reply_frames, sc->fqdepth,
2458                                        sc->replyframesz);
2459                                 printf("%s: baddr %#x,\n", __func__, baddr);
2460                                 /* LSI-TODO. See Linux Code for Graceful exit */
2461                                 panic("Reply address out of range");
2462                         }
2463                         if (le16toh(desc->AddressReply.SMID) == 0) {
2464                                 if (((MPI2_DEFAULT_REPLY *)reply)->Function ==
2465                                     MPI2_FUNCTION_DIAG_BUFFER_POST) {
2466                                         /*
2467                                          * If SMID is 0 for Diag Buffer Post,
2468                                          * this implies that the reply is due to
2469                                          * a release function with a status that
2470                                          * the buffer has been released.  Set
2471                                          * the buffer flags accordingly.
2472                                          */
2473                                         rel_rep =
2474                                             (MPI2_DIAG_RELEASE_REPLY *)reply;
2475                                         if ((le16toh(rel_rep->IOCStatus) &
2476                                             MPI2_IOCSTATUS_MASK) ==
2477                                             MPI2_IOCSTATUS_DIAGNOSTIC_RELEASED)
2478                                         {
2479                                                 pBuffer =
2480                                                     &sc->fw_diag_buffer_list[
2481                                                     rel_rep->BufferType];
2482                                                 pBuffer->valid_data = TRUE;
2483                                                 pBuffer->owned_by_firmware =
2484                                                     FALSE;
2485                                                 pBuffer->immediate = FALSE;
2486                                         }
2487                                 } else
2488                                         mps_dispatch_event(sc, baddr,
2489                                             (MPI2_EVENT_NOTIFICATION_REPLY *)
2490                                             reply);
2491                         } else {
2492                                 /*
2493                                  * Ignore commands not in INQUEUE state
2494                                  * since they've already been completed
2495                                  * via another path.
2496                                  */
2497                                 cm = &sc->commands[
2498                                     le16toh(desc->AddressReply.SMID)];
2499                                 if (cm->cm_state == MPS_CM_STATE_INQUEUE) {
2500                                         cm->cm_state = MPS_CM_STATE_BUSY;
2501                                         cm->cm_reply = reply;
2502                                         cm->cm_reply_data = le32toh(
2503                                             desc->AddressReply.ReplyFrameAddress);
2504                                 } else {
2505                                         mps_dprint(sc, MPS_RECOVERY,
2506                                             "Bad state for ADDRESS_REPLY status,"
2507                                             " ignoring state %d cm %p\n",
2508                                             cm->cm_state, cm);
2509                                 }
2510                         }
2511                         break;
2512                 }
2513                 case MPI2_RPY_DESCRIPT_FLAGS_TARGETASSIST_SUCCESS:
2514                 case MPI2_RPY_DESCRIPT_FLAGS_TARGET_COMMAND_BUFFER:
2515                 case MPI2_RPY_DESCRIPT_FLAGS_RAID_ACCELERATOR_SUCCESS:
2516                 default:
2517                         /* Unhandled */
2518                         mps_dprint(sc, MPS_ERROR, "Unhandled reply 0x%x\n",
2519                             desc->Default.ReplyFlags);
2520                         cm = NULL;
2521                         break;
2522                 }
2523                 
2524
2525                 if (cm != NULL) {
2526                         // Print Error reply frame
2527                         if (cm->cm_reply)
2528                                 mps_display_reply_info(sc,cm->cm_reply);
2529                         mps_complete_command(sc, cm);
2530                 }
2531         }
2532
2533         if (pq != sc->replypostindex) {
2534                 mps_dprint(sc, MPS_TRACE, "%s sc %p writing postindex %d\n",
2535                     __func__, sc, sc->replypostindex);
2536                 mps_regwrite(sc, MPI2_REPLY_POST_HOST_INDEX_OFFSET,
2537                     sc->replypostindex);
2538         }
2539
2540         return;
2541 }
2542
2543 static void
2544 mps_dispatch_event(struct mps_softc *sc, uintptr_t data,
2545     MPI2_EVENT_NOTIFICATION_REPLY *reply)
2546 {
2547         struct mps_event_handle *eh;
2548         int event, handled = 0;
2549
2550         event = le16toh(reply->Event);
2551         TAILQ_FOREACH(eh, &sc->event_list, eh_list) {
2552                 if (isset(eh->mask, event)) {
2553                         eh->callback(sc, data, reply);
2554                         handled++;
2555                 }
2556         }
2557
2558         if (handled == 0)
2559                 mps_dprint(sc, MPS_EVENT, "Unhandled event 0x%x\n", le16toh(event));
2560
2561         /*
2562          * This is the only place that the event/reply should be freed.
2563          * Anything wanting to hold onto the event data should have
2564          * already copied it into their own storage.
2565          */
2566         mps_free_reply(sc, data);
2567 }
2568
2569 static void
2570 mps_reregister_events_complete(struct mps_softc *sc, struct mps_command *cm)
2571 {
2572         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2573
2574         if (cm->cm_reply)
2575                 MPS_DPRINT_EVENT(sc, generic,
2576                         (MPI2_EVENT_NOTIFICATION_REPLY *)cm->cm_reply);
2577
2578         mps_free_command(sc, cm);
2579
2580         /* next, send a port enable */
2581         mpssas_startup(sc);
2582 }
2583
2584 /*
2585  * For both register_events and update_events, the caller supplies a bitmap
2586  * of events that it _wants_.  These functions then turn that into a bitmask
2587  * suitable for the controller.
2588  */
2589 int
2590 mps_register_events(struct mps_softc *sc, u32 *mask,
2591     mps_evt_callback_t *cb, void *data, struct mps_event_handle **handle)
2592 {
2593         struct mps_event_handle *eh;
2594         int error = 0;
2595
2596         eh = malloc(sizeof(struct mps_event_handle), M_MPT2, M_WAITOK|M_ZERO);
2597         eh->callback = cb;
2598         eh->data = data;
2599         TAILQ_INSERT_TAIL(&sc->event_list, eh, eh_list);
2600         if (mask != NULL)
2601                 error = mps_update_events(sc, eh, mask);
2602         *handle = eh;
2603
2604         return (error);
2605 }
2606
2607 int
2608 mps_update_events(struct mps_softc *sc, struct mps_event_handle *handle,
2609     u32 *mask)
2610 {
2611         MPI2_EVENT_NOTIFICATION_REQUEST *evtreq;
2612         MPI2_EVENT_NOTIFICATION_REPLY *reply = NULL;
2613         struct mps_command *cm;
2614         int error, i;
2615
2616         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2617
2618         if ((mask != NULL) && (handle != NULL))
2619                 bcopy(mask, &handle->mask[0], sizeof(u32) * 
2620                                 MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2621     
2622         for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2623                 sc->event_mask[i] = -1;
2624
2625         for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2626                 sc->event_mask[i] &= ~handle->mask[i];
2627
2628
2629         if ((cm = mps_alloc_command(sc)) == NULL)
2630                 return (EBUSY);
2631         evtreq = (MPI2_EVENT_NOTIFICATION_REQUEST *)cm->cm_req;
2632         evtreq->Function = MPI2_FUNCTION_EVENT_NOTIFICATION;
2633         evtreq->MsgFlags = 0;
2634         evtreq->SASBroadcastPrimitiveMasks = 0;
2635 #ifdef MPS_DEBUG_ALL_EVENTS
2636         {
2637                 u_char fullmask[16];
2638                 memset(fullmask, 0x00, 16);
2639                 bcopy(fullmask, &evtreq->EventMasks[0], sizeof(u32) * 
2640                                 MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2641         }
2642 #else
2643         for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2644                 evtreq->EventMasks[i] =
2645                     htole32(sc->event_mask[i]);
2646 #endif
2647         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
2648         cm->cm_data = NULL;
2649
2650         error = mps_wait_command(sc, &cm, 60, 0);
2651         if (cm != NULL)
2652                 reply = (MPI2_EVENT_NOTIFICATION_REPLY *)cm->cm_reply;
2653         if ((reply == NULL) ||
2654             (reply->IOCStatus & MPI2_IOCSTATUS_MASK) != MPI2_IOCSTATUS_SUCCESS)
2655                 error = ENXIO;
2656
2657         if (reply)
2658                 MPS_DPRINT_EVENT(sc, generic, reply);
2659
2660         mps_dprint(sc, MPS_TRACE, "%s finished error %d\n", __func__, error);
2661
2662         if (cm != NULL)
2663                 mps_free_command(sc, cm);
2664         return (error);
2665 }
2666
2667 static int
2668 mps_reregister_events(struct mps_softc *sc)
2669 {
2670         MPI2_EVENT_NOTIFICATION_REQUEST *evtreq;
2671         struct mps_command *cm;
2672         struct mps_event_handle *eh;
2673         int error, i;
2674
2675         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
2676
2677         /* first, reregister events */
2678
2679         for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2680                 sc->event_mask[i] = -1;
2681
2682         TAILQ_FOREACH(eh, &sc->event_list, eh_list) {
2683                 for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2684                         sc->event_mask[i] &= ~eh->mask[i];
2685         }
2686
2687         if ((cm = mps_alloc_command(sc)) == NULL)
2688                 return (EBUSY);
2689         evtreq = (MPI2_EVENT_NOTIFICATION_REQUEST *)cm->cm_req;
2690         evtreq->Function = MPI2_FUNCTION_EVENT_NOTIFICATION;
2691         evtreq->MsgFlags = 0;
2692         evtreq->SASBroadcastPrimitiveMasks = 0;
2693 #ifdef MPS_DEBUG_ALL_EVENTS
2694         {
2695                 u_char fullmask[16];
2696                 memset(fullmask, 0x00, 16);
2697                 bcopy(fullmask, &evtreq->EventMasks[0], sizeof(u32) *
2698                         MPI2_EVENT_NOTIFY_EVENTMASK_WORDS);
2699         }
2700 #else
2701         for (i = 0; i < MPI2_EVENT_NOTIFY_EVENTMASK_WORDS; i++)
2702                 evtreq->EventMasks[i] =
2703                     htole32(sc->event_mask[i]);
2704 #endif
2705         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
2706         cm->cm_data = NULL;
2707         cm->cm_complete = mps_reregister_events_complete;
2708
2709         error = mps_map_command(sc, cm);
2710
2711         mps_dprint(sc, MPS_TRACE, "%s finished with error %d\n", __func__,
2712             error);
2713         return (error);
2714 }
2715
2716 void
2717 mps_deregister_events(struct mps_softc *sc, struct mps_event_handle *handle)
2718 {
2719
2720         TAILQ_REMOVE(&sc->event_list, handle, eh_list);
2721         free(handle, M_MPT2);
2722 }
2723
2724 /*
2725  * Add a chain element as the next SGE for the specified command.
2726  * Reset cm_sge and cm_sgesize to indicate all the available space.
2727  */
2728 static int
2729 mps_add_chain(struct mps_command *cm)
2730 {
2731         MPI2_SGE_CHAIN32 *sgc;
2732         struct mps_chain *chain;
2733         u_int space;
2734
2735         if (cm->cm_sglsize < MPS_SGC_SIZE)
2736                 panic("MPS: Need SGE Error Code\n");
2737
2738         chain = mps_alloc_chain(cm->cm_sc);
2739         if (chain == NULL)
2740                 return (ENOBUFS);
2741
2742         space = cm->cm_sc->reqframesz;
2743
2744         /*
2745          * Note: a double-linked list is used to make it easier to
2746          * walk for debugging.
2747          */
2748         TAILQ_INSERT_TAIL(&cm->cm_chain_list, chain, chain_link);
2749
2750         sgc = (MPI2_SGE_CHAIN32 *)&cm->cm_sge->MpiChain;
2751         sgc->Length = htole16(space);
2752         sgc->NextChainOffset = 0;
2753         /* TODO Looks like bug in Setting sgc->Flags. 
2754          *      sgc->Flags = ( MPI2_SGE_FLAGS_CHAIN_ELEMENT | MPI2_SGE_FLAGS_64_BIT_ADDRESSING |
2755          *                  MPI2_SGE_FLAGS_SYSTEM_ADDRESS) << MPI2_SGE_FLAGS_SHIFT
2756          *      This is fine.. because we are not using simple element. In case of 
2757          *      MPI2_SGE_CHAIN32, we have separate Length and Flags feild.
2758          */
2759         sgc->Flags = MPI2_SGE_FLAGS_CHAIN_ELEMENT;
2760         sgc->Address = htole32(chain->chain_busaddr);
2761
2762         cm->cm_sge = (MPI2_SGE_IO_UNION *)&chain->chain->MpiSimple;
2763         cm->cm_sglsize = space;
2764         return (0);
2765 }
2766
2767 /*
2768  * Add one scatter-gather element (chain, simple, transaction context)
2769  * to the scatter-gather list for a command.  Maintain cm_sglsize and
2770  * cm_sge as the remaining size and pointer to the next SGE to fill
2771  * in, respectively.
2772  */
2773 int
2774 mps_push_sge(struct mps_command *cm, void *sgep, size_t len, int segsleft)
2775 {
2776         MPI2_SGE_TRANSACTION_UNION *tc = sgep;
2777         MPI2_SGE_SIMPLE64 *sge = sgep;
2778         int error, type;
2779         uint32_t saved_buf_len, saved_address_low, saved_address_high;
2780
2781         type = (tc->Flags & MPI2_SGE_FLAGS_ELEMENT_MASK);
2782
2783 #ifdef INVARIANTS
2784         switch (type) {
2785         case MPI2_SGE_FLAGS_TRANSACTION_ELEMENT: {
2786                 if (len != tc->DetailsLength + 4)
2787                         panic("TC %p length %u or %zu?", tc,
2788                             tc->DetailsLength + 4, len);
2789                 }
2790                 break;
2791         case MPI2_SGE_FLAGS_CHAIN_ELEMENT:
2792                 /* Driver only uses 32-bit chain elements */
2793                 if (len != MPS_SGC_SIZE)
2794                         panic("CHAIN %p length %u or %zu?", sgep,
2795                             MPS_SGC_SIZE, len);
2796                 break;
2797         case MPI2_SGE_FLAGS_SIMPLE_ELEMENT:
2798                 /* Driver only uses 64-bit SGE simple elements */
2799                 if (len != MPS_SGE64_SIZE)
2800                         panic("SGE simple %p length %u or %zu?", sge,
2801                             MPS_SGE64_SIZE, len);
2802                 if (((le32toh(sge->FlagsLength) >> MPI2_SGE_FLAGS_SHIFT) &
2803                     MPI2_SGE_FLAGS_ADDRESS_SIZE) == 0)
2804                         panic("SGE simple %p not marked 64-bit?", sge);
2805
2806                 break;
2807         default:
2808                 panic("Unexpected SGE %p, flags %02x", tc, tc->Flags);
2809         }
2810 #endif
2811
2812         /*
2813          * case 1: 1 more segment, enough room for it
2814          * case 2: 2 more segments, enough room for both
2815          * case 3: >=2 more segments, only enough room for 1 and a chain
2816          * case 4: >=1 more segment, enough room for only a chain
2817          * case 5: >=1 more segment, no room for anything (error)
2818          */
2819
2820         /*
2821          * There should be room for at least a chain element, or this
2822          * code is buggy.  Case (5).
2823          */
2824         if (cm->cm_sglsize < MPS_SGC_SIZE)
2825                 panic("MPS: Need SGE Error Code\n");
2826
2827         if (segsleft >= 1 && cm->cm_sglsize < len + MPS_SGC_SIZE) {
2828                 /*
2829                  * 1 or more segment, enough room for only a chain.
2830                  * Hope the previous element wasn't a Simple entry
2831                  * that needed to be marked with
2832                  * MPI2_SGE_FLAGS_LAST_ELEMENT.  Case (4).
2833                  */
2834                 if ((error = mps_add_chain(cm)) != 0)
2835                         return (error);
2836         }
2837
2838         if (segsleft >= 2 &&
2839             cm->cm_sglsize < len + MPS_SGC_SIZE + MPS_SGE64_SIZE) {
2840                 /*
2841                  * There are 2 or more segments left to add, and only
2842                  * enough room for 1 and a chain.  Case (3).
2843                  *
2844                  * Mark as last element in this chain if necessary.
2845                  */
2846                 if (type == MPI2_SGE_FLAGS_SIMPLE_ELEMENT) {
2847                         sge->FlagsLength |= htole32(
2848                             MPI2_SGE_FLAGS_LAST_ELEMENT << MPI2_SGE_FLAGS_SHIFT);
2849                 }
2850
2851                 /*
2852                  * Add the item then a chain.  Do the chain now,
2853                  * rather than on the next iteration, to simplify
2854                  * understanding the code.
2855                  */
2856                 cm->cm_sglsize -= len;
2857                 bcopy(sgep, cm->cm_sge, len);
2858                 cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge + len);
2859                 return (mps_add_chain(cm));
2860         }
2861
2862 #ifdef INVARIANTS
2863         /* Case 1: 1 more segment, enough room for it. */
2864         if (segsleft == 1 && cm->cm_sglsize < len)
2865                 panic("1 seg left and no room? %u versus %zu",
2866                     cm->cm_sglsize, len);
2867
2868         /* Case 2: 2 more segments, enough room for both */
2869         if (segsleft == 2 && cm->cm_sglsize < len + MPS_SGE64_SIZE)
2870                 panic("2 segs left and no room? %u versus %zu",
2871                     cm->cm_sglsize, len);
2872 #endif
2873
2874         if (segsleft == 1 && type == MPI2_SGE_FLAGS_SIMPLE_ELEMENT) {
2875                 /*
2876                  * If this is a bi-directional request, need to account for that
2877                  * here.  Save the pre-filled sge values.  These will be used
2878                  * either for the 2nd SGL or for a single direction SGL.  If
2879                  * cm_out_len is non-zero, this is a bi-directional request, so
2880                  * fill in the OUT SGL first, then the IN SGL, otherwise just
2881                  * fill in the IN SGL.  Note that at this time, when filling in
2882                  * 2 SGL's for a bi-directional request, they both use the same
2883                  * DMA buffer (same cm command).
2884                  */
2885                 saved_buf_len = le32toh(sge->FlagsLength) & 0x00FFFFFF;
2886                 saved_address_low = sge->Address.Low;
2887                 saved_address_high = sge->Address.High;
2888                 if (cm->cm_out_len) {
2889                         sge->FlagsLength = htole32(cm->cm_out_len |
2890                             ((uint32_t)(MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2891                             MPI2_SGE_FLAGS_END_OF_BUFFER |
2892                             MPI2_SGE_FLAGS_HOST_TO_IOC |
2893                             MPI2_SGE_FLAGS_64_BIT_ADDRESSING) <<
2894                             MPI2_SGE_FLAGS_SHIFT));
2895                         cm->cm_sglsize -= len;
2896                         bcopy(sgep, cm->cm_sge, len);
2897                         cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge
2898                             + len);
2899                 }
2900                 saved_buf_len |=
2901                     ((uint32_t)(MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2902                     MPI2_SGE_FLAGS_END_OF_BUFFER |
2903                     MPI2_SGE_FLAGS_LAST_ELEMENT |
2904                     MPI2_SGE_FLAGS_END_OF_LIST |
2905                     MPI2_SGE_FLAGS_64_BIT_ADDRESSING) <<
2906                     MPI2_SGE_FLAGS_SHIFT);
2907                 if (cm->cm_flags & MPS_CM_FLAGS_DATAIN) {
2908                         saved_buf_len |=
2909                             ((uint32_t)(MPI2_SGE_FLAGS_IOC_TO_HOST) <<
2910                             MPI2_SGE_FLAGS_SHIFT);
2911                 } else {
2912                         saved_buf_len |=
2913                             ((uint32_t)(MPI2_SGE_FLAGS_HOST_TO_IOC) <<
2914                             MPI2_SGE_FLAGS_SHIFT);
2915                 }
2916                 sge->FlagsLength = htole32(saved_buf_len);
2917                 sge->Address.Low = saved_address_low;
2918                 sge->Address.High = saved_address_high;
2919         }
2920
2921         cm->cm_sglsize -= len;
2922         bcopy(sgep, cm->cm_sge, len);
2923         cm->cm_sge = (MPI2_SGE_IO_UNION *)((uintptr_t)cm->cm_sge + len);
2924         return (0);
2925 }
2926
2927 /*
2928  * Add one dma segment to the scatter-gather list for a command.
2929  */
2930 int
2931 mps_add_dmaseg(struct mps_command *cm, vm_paddr_t pa, size_t len, u_int flags,
2932     int segsleft)
2933 {
2934         MPI2_SGE_SIMPLE64 sge;
2935
2936         /*
2937          * This driver always uses 64-bit address elements for simplicity.
2938          */
2939         bzero(&sge, sizeof(sge));
2940         flags |= MPI2_SGE_FLAGS_SIMPLE_ELEMENT |
2941             MPI2_SGE_FLAGS_64_BIT_ADDRESSING;
2942         sge.FlagsLength = htole32(len | (flags << MPI2_SGE_FLAGS_SHIFT));
2943         mps_from_u64(pa, &sge.Address);
2944
2945         return (mps_push_sge(cm, &sge, sizeof sge, segsleft));
2946 }
2947
2948 static void
2949 mps_data_cb(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
2950 {
2951         struct mps_softc *sc;
2952         struct mps_command *cm;
2953         u_int i, dir, sflags;
2954
2955         cm = (struct mps_command *)arg;
2956         sc = cm->cm_sc;
2957
2958         /*
2959          * In this case, just print out a warning and let the chip tell the
2960          * user they did the wrong thing.
2961          */
2962         if ((cm->cm_max_segs != 0) && (nsegs > cm->cm_max_segs)) {
2963                 mps_dprint(sc, MPS_ERROR,
2964                            "%s: warning: busdma returned %d segments, "
2965                            "more than the %d allowed\n", __func__, nsegs,
2966                            cm->cm_max_segs);
2967         }
2968
2969         /*
2970          * Set up DMA direction flags.  Bi-directional requests are also handled
2971          * here.  In that case, both direction flags will be set.
2972          */
2973         sflags = 0;
2974         if (cm->cm_flags & MPS_CM_FLAGS_SMP_PASS) {
2975                 /*
2976                  * We have to add a special case for SMP passthrough, there
2977                  * is no easy way to generically handle it.  The first
2978                  * S/G element is used for the command (therefore the
2979                  * direction bit needs to be set).  The second one is used
2980                  * for the reply.  We'll leave it to the caller to make
2981                  * sure we only have two buffers.
2982                  */
2983                 /*
2984                  * Even though the busdma man page says it doesn't make
2985                  * sense to have both direction flags, it does in this case.
2986                  * We have one s/g element being accessed in each direction.
2987                  */
2988                 dir = BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD;
2989
2990                 /*
2991                  * Set the direction flag on the first buffer in the SMP
2992                  * passthrough request.  We'll clear it for the second one.
2993                  */
2994                 sflags |= MPI2_SGE_FLAGS_DIRECTION |
2995                           MPI2_SGE_FLAGS_END_OF_BUFFER;
2996         } else if (cm->cm_flags & MPS_CM_FLAGS_DATAOUT) {
2997                 sflags |= MPI2_SGE_FLAGS_HOST_TO_IOC;
2998                 dir = BUS_DMASYNC_PREWRITE;
2999         } else
3000                 dir = BUS_DMASYNC_PREREAD;
3001
3002         for (i = 0; i < nsegs; i++) {
3003                 if ((cm->cm_flags & MPS_CM_FLAGS_SMP_PASS) && (i != 0)) {
3004                         sflags &= ~MPI2_SGE_FLAGS_DIRECTION;
3005                 }
3006                 error = mps_add_dmaseg(cm, segs[i].ds_addr, segs[i].ds_len,
3007                     sflags, nsegs - i);
3008                 if (error != 0) {
3009                         /* Resource shortage, roll back! */
3010                         if (ratecheck(&sc->lastfail, &mps_chainfail_interval))
3011                                 mps_dprint(sc, MPS_INFO, "Out of chain frames, "
3012                                     "consider increasing hw.mps.max_chains.\n");
3013                         cm->cm_flags |= MPS_CM_FLAGS_CHAIN_FAILED;
3014                         mps_complete_command(sc, cm);
3015                         return;
3016                 }
3017         }
3018
3019         bus_dmamap_sync(sc->buffer_dmat, cm->cm_dmamap, dir);
3020         mps_enqueue_request(sc, cm);
3021
3022         return;
3023 }
3024
3025 static void
3026 mps_data_cb2(void *arg, bus_dma_segment_t *segs, int nsegs, bus_size_t mapsize,
3027              int error)
3028 {
3029         mps_data_cb(arg, segs, nsegs, error);
3030 }
3031
3032 /*
3033  * This is the routine to enqueue commands ansynchronously.
3034  * Note that the only error path here is from bus_dmamap_load(), which can
3035  * return EINPROGRESS if it is waiting for resources.  Other than this, it's
3036  * assumed that if you have a command in-hand, then you have enough credits
3037  * to use it.
3038  */
3039 int
3040 mps_map_command(struct mps_softc *sc, struct mps_command *cm)
3041 {
3042         int error = 0;
3043
3044         if (cm->cm_flags & MPS_CM_FLAGS_USE_UIO) {
3045                 error = bus_dmamap_load_uio(sc->buffer_dmat, cm->cm_dmamap,
3046                     &cm->cm_uio, mps_data_cb2, cm, 0);
3047         } else if (cm->cm_flags & MPS_CM_FLAGS_USE_CCB) {
3048                 error = bus_dmamap_load_ccb(sc->buffer_dmat, cm->cm_dmamap,
3049                     cm->cm_data, mps_data_cb, cm, 0);
3050         } else if ((cm->cm_data != NULL) && (cm->cm_length != 0)) {
3051                 error = bus_dmamap_load(sc->buffer_dmat, cm->cm_dmamap,
3052                     cm->cm_data, cm->cm_length, mps_data_cb, cm, 0);
3053         } else {
3054                 /* Add a zero-length element as needed */
3055                 if (cm->cm_sge != NULL)
3056                         mps_add_dmaseg(cm, 0, 0, 0, 1);
3057                 mps_enqueue_request(sc, cm);    
3058         }
3059
3060         return (error);
3061 }
3062
3063 /*
3064  * This is the routine to enqueue commands synchronously.  An error of
3065  * EINPROGRESS from mps_map_command() is ignored since the command will
3066  * be executed and enqueued automatically.  Other errors come from msleep().
3067  */
3068 int
3069 mps_wait_command(struct mps_softc *sc, struct mps_command **cmp, int timeout,
3070     int sleep_flag)
3071 {
3072         int error, rc;
3073         struct timeval cur_time, start_time;
3074         struct mps_command *cm = *cmp;
3075
3076         if (sc->mps_flags & MPS_FLAGS_DIAGRESET) 
3077                 return  EBUSY;
3078
3079         cm->cm_complete = NULL;
3080         cm->cm_flags |= MPS_CM_FLAGS_POLLED;
3081         error = mps_map_command(sc, cm);
3082         if ((error != 0) && (error != EINPROGRESS))
3083                 return (error);
3084
3085         /*
3086          * Check for context and wait for 50 mSec at a time until time has
3087          * expired or the command has finished.  If msleep can't be used, need
3088          * to poll.
3089          */
3090         if (curthread->td_no_sleeping != 0)
3091                 sleep_flag = NO_SLEEP;
3092         getmicrouptime(&start_time);
3093         if (mtx_owned(&sc->mps_mtx) && sleep_flag == CAN_SLEEP) {
3094                 cm->cm_flags |= MPS_CM_FLAGS_WAKEUP;
3095                 error = msleep(cm, &sc->mps_mtx, 0, "mpswait", timeout*hz);
3096                 if (error == EWOULDBLOCK) {
3097                         /*
3098                          * Record the actual elapsed time in the case of a
3099                          * timeout for the message below.
3100                          */
3101                         getmicrouptime(&cur_time);
3102                         timevalsub(&cur_time, &start_time);
3103                 }
3104         } else {
3105                 while ((cm->cm_flags & MPS_CM_FLAGS_COMPLETE) == 0) {
3106                         mps_intr_locked(sc);
3107                         if (sleep_flag == CAN_SLEEP)
3108                                 pause("mpswait", hz/20);
3109                         else
3110                                 DELAY(50000);
3111                 
3112                         getmicrouptime(&cur_time);
3113                         timevalsub(&cur_time, &start_time);
3114                         if (cur_time.tv_sec > timeout) {
3115                                 error = EWOULDBLOCK;
3116                                 break;
3117                         }
3118                 }
3119         }
3120
3121         if (error == EWOULDBLOCK) {
3122                 if (cm->cm_timeout_handler == NULL) {
3123                         mps_dprint(sc, MPS_FAULT, "Calling Reinit from %s, timeout=%d,"
3124                             " elapsed=%jd\n", __func__, timeout,
3125                             (intmax_t)cur_time.tv_sec);
3126                         rc = mps_reinit(sc);
3127                         mps_dprint(sc, MPS_FAULT, "Reinit %s\n", (rc == 0) ? "success" :
3128                             "failed");
3129                 } else
3130                         cm->cm_timeout_handler(sc, cm);
3131                 if (sc->mps_flags & MPS_FLAGS_REALLOCATED) {
3132                         /*
3133                          * Tell the caller that we freed the command in a
3134                          * reinit.
3135                          */
3136                         *cmp = NULL;
3137                 }
3138                 error = ETIMEDOUT;
3139         }
3140         return (error);
3141 }
3142
3143 /*
3144  * The MPT driver had a verbose interface for config pages.  In this driver,
3145  * reduce it to much simpler terms, similar to the Linux driver.
3146  */
3147 int
3148 mps_read_config_page(struct mps_softc *sc, struct mps_config_params *params)
3149 {
3150         MPI2_CONFIG_REQUEST *req;
3151         struct mps_command *cm;
3152         int error;
3153
3154         if (sc->mps_flags & MPS_FLAGS_BUSY) {
3155                 return (EBUSY);
3156         }
3157
3158         cm = mps_alloc_command(sc);
3159         if (cm == NULL) {
3160                 return (EBUSY);
3161         }
3162
3163         req = (MPI2_CONFIG_REQUEST *)cm->cm_req;
3164         req->Function = MPI2_FUNCTION_CONFIG;
3165         req->Action = params->action;
3166         req->SGLFlags = 0;
3167         req->ChainOffset = 0;
3168         req->PageAddress = params->page_address;
3169         if (params->hdr.Struct.PageType == MPI2_CONFIG_PAGETYPE_EXTENDED) {
3170                 MPI2_CONFIG_EXTENDED_PAGE_HEADER *hdr;
3171
3172                 hdr = &params->hdr.Ext;
3173                 req->ExtPageType = hdr->ExtPageType;
3174                 req->ExtPageLength = hdr->ExtPageLength;
3175                 req->Header.PageType = MPI2_CONFIG_PAGETYPE_EXTENDED;
3176                 req->Header.PageLength = 0; /* Must be set to zero */
3177                 req->Header.PageNumber = hdr->PageNumber;
3178                 req->Header.PageVersion = hdr->PageVersion;
3179         } else {
3180                 MPI2_CONFIG_PAGE_HEADER *hdr;
3181
3182                 hdr = &params->hdr.Struct;
3183                 req->Header.PageType = hdr->PageType;
3184                 req->Header.PageNumber = hdr->PageNumber;
3185                 req->Header.PageLength = hdr->PageLength;
3186                 req->Header.PageVersion = hdr->PageVersion;
3187         }
3188
3189         cm->cm_data = params->buffer;
3190         cm->cm_length = params->length;
3191         if (cm->cm_data != NULL) {
3192                 cm->cm_sge = &req->PageBufferSGE;
3193                 cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
3194                 cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
3195         } else
3196                 cm->cm_sge = NULL;
3197         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
3198
3199         cm->cm_complete_data = params;
3200         if (params->callback != NULL) {
3201                 cm->cm_complete = mps_config_complete;
3202                 return (mps_map_command(sc, cm));
3203         } else {
3204                 error = mps_wait_command(sc, &cm, 0, CAN_SLEEP);
3205                 if (error) {
3206                         mps_dprint(sc, MPS_FAULT,
3207                             "Error %d reading config page\n", error);
3208                         if (cm != NULL)
3209                                 mps_free_command(sc, cm);
3210                         return (error);
3211                 }
3212                 mps_config_complete(sc, cm);
3213         }
3214
3215         return (0);
3216 }
3217
3218 int
3219 mps_write_config_page(struct mps_softc *sc, struct mps_config_params *params)
3220 {
3221         return (EINVAL);
3222 }
3223
3224 static void
3225 mps_config_complete(struct mps_softc *sc, struct mps_command *cm)
3226 {
3227         MPI2_CONFIG_REPLY *reply;
3228         struct mps_config_params *params;
3229
3230         MPS_FUNCTRACE(sc);
3231         params = cm->cm_complete_data;
3232
3233         if (cm->cm_data != NULL) {
3234                 bus_dmamap_sync(sc->buffer_dmat, cm->cm_dmamap,
3235                     BUS_DMASYNC_POSTREAD);
3236                 bus_dmamap_unload(sc->buffer_dmat, cm->cm_dmamap);
3237         }
3238
3239         /*
3240          * XXX KDM need to do more error recovery?  This results in the
3241          * device in question not getting probed.
3242          */
3243         if ((cm->cm_flags & MPS_CM_FLAGS_ERROR_MASK) != 0) {
3244                 params->status = MPI2_IOCSTATUS_BUSY;
3245                 goto done;
3246         }
3247
3248         reply = (MPI2_CONFIG_REPLY *)cm->cm_reply;
3249         if (reply == NULL) {
3250                 params->status = MPI2_IOCSTATUS_BUSY;
3251                 goto done;
3252         }
3253         params->status = reply->IOCStatus;
3254         if (params->hdr.Struct.PageType == MPI2_CONFIG_PAGETYPE_EXTENDED) {
3255                 params->hdr.Ext.ExtPageType = reply->ExtPageType;
3256                 params->hdr.Ext.ExtPageLength = reply->ExtPageLength;
3257                 params->hdr.Ext.PageType = reply->Header.PageType;
3258                 params->hdr.Ext.PageNumber = reply->Header.PageNumber;
3259                 params->hdr.Ext.PageVersion = reply->Header.PageVersion;
3260         } else {
3261                 params->hdr.Struct.PageType = reply->Header.PageType;
3262                 params->hdr.Struct.PageNumber = reply->Header.PageNumber;
3263                 params->hdr.Struct.PageLength = reply->Header.PageLength;
3264                 params->hdr.Struct.PageVersion = reply->Header.PageVersion;
3265         }
3266
3267 done:
3268         mps_free_command(sc, cm);
3269         if (params->callback != NULL)
3270                 params->callback(sc, params);
3271
3272         return;
3273 }