]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/mpt/mpt.c
This commit was generated by cvs2svn to compensate for changes in r174531,
[FreeBSD/FreeBSD.git] / sys / dev / mpt / mpt.c
1 /*-
2  * Generic routines for LSI Fusion adapters.
3  * FreeBSD Version.
4  *
5  * Copyright (c) 2000, 2001 by Greg Ansley
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice immediately at the beginning of the file, without modification,
12  *    this list of conditions, and the following disclaimer.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 /*-
29  * Copyright (c) 2002, 2006 by Matthew Jacob
30  * All rights reserved.
31  *
32  * Redistribution and use in source and binary forms, with or without
33  * modification, are permitted provided that the following conditions are
34  * met:
35  * 1. Redistributions of source code must retain the above copyright
36  *    notice, this list of conditions and the following disclaimer.
37  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
38  *    substantially similar to the "NO WARRANTY" disclaimer below
39  *    ("Disclaimer") and any redistribution must be conditioned upon including
40  *    a substantially similar Disclaimer requirement for further binary
41  *    redistribution.
42  * 3. Neither the names of the above listed copyright holders nor the names
43  *    of any contributors may be used to endorse or promote products derived
44  *    from this software without specific prior written permission.
45  *
46  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
47  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
50  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
51  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
52  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
53  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
54  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
55  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
56  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57  *
58  * Support from Chris Ellsworth in order to make SAS adapters work
59  * is gratefully acknowledged.
60  *
61  *
62  * Support from LSI-Logic has also gone a great deal toward making this a
63  * workable subsystem and is gratefully acknowledged.
64  */
65 /*-
66  * Copyright (c) 2004, Avid Technology, Inc. and its contributors.
67  * Copyright (c) 2005, WHEEL Sp. z o.o.
68  * Copyright (c) 2004, 2005 Justin T. Gibbs
69  * All rights reserved.
70  *
71  * Redistribution and use in source and binary forms, with or without
72  * modification, are permitted provided that the following conditions are
73  * met:
74  * 1. Redistributions of source code must retain the above copyright
75  *    notice, this list of conditions and the following disclaimer.
76  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
77  *    substantially similar to the "NO WARRANTY" disclaimer below
78  *    ("Disclaimer") and any redistribution must be conditioned upon including
79  *    a substantially similar Disclaimer requirement for further binary
80  *    redistribution.
81  * 3. Neither the names of the above listed copyright holders nor the names
82  *    of any contributors may be used to endorse or promote products derived
83  *    from this software without specific prior written permission.
84  *
85  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
86  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
87  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
88  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
89  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
90  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
91  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
92  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
93  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
94  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF THE COPYRIGHT
95  * OWNER OR CONTRIBUTOR IS ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
96  */
97
98 #include <sys/cdefs.h>
99 __FBSDID("$FreeBSD$");
100
101 #include <dev/mpt/mpt.h>
102 #include <dev/mpt/mpt_cam.h> /* XXX For static handler registration */
103 #include <dev/mpt/mpt_raid.h> /* XXX For static handler registration */
104
105 #include <dev/mpt/mpilib/mpi.h>
106 #include <dev/mpt/mpilib/mpi_ioc.h>
107 #include <dev/mpt/mpilib/mpi_fc.h>
108 #include <dev/mpt/mpilib/mpi_targ.h>
109
110 #include <sys/sysctl.h>
111
112 #define MPT_MAX_TRYS 3
113 #define MPT_MAX_WAIT 300000
114
115 static int maxwait_ack = 0;
116 static int maxwait_int = 0;
117 static int maxwait_state = 0;
118
119 static TAILQ_HEAD(, mpt_softc)  mpt_tailq = TAILQ_HEAD_INITIALIZER(mpt_tailq);
120 mpt_reply_handler_t *mpt_reply_handlers[MPT_NUM_REPLY_HANDLERS];
121
122 static mpt_reply_handler_t mpt_default_reply_handler;
123 static mpt_reply_handler_t mpt_config_reply_handler;
124 static mpt_reply_handler_t mpt_handshake_reply_handler;
125 static mpt_reply_handler_t mpt_event_reply_handler;
126 static void mpt_send_event_ack(struct mpt_softc *mpt, request_t *ack_req,
127                                MSG_EVENT_NOTIFY_REPLY *msg, uint32_t context);
128 static int mpt_send_event_request(struct mpt_softc *mpt, int onoff);
129 static int mpt_soft_reset(struct mpt_softc *mpt);
130 static void mpt_hard_reset(struct mpt_softc *mpt);
131 static int mpt_configure_ioc(struct mpt_softc *mpt, int, int);
132 static int mpt_enable_ioc(struct mpt_softc *mpt, int);
133
134 /************************* Personality Module Support *************************/
135 /*
136  * We include one extra entry that is guaranteed to be NULL
137  * to simplify our itterator.
138  */
139 static struct mpt_personality *mpt_personalities[MPT_MAX_PERSONALITIES + 1];
140 static __inline struct mpt_personality*
141         mpt_pers_find(struct mpt_softc *, u_int);
142 static __inline struct mpt_personality*
143         mpt_pers_find_reverse(struct mpt_softc *, u_int);
144
145 static __inline struct mpt_personality *
146 mpt_pers_find(struct mpt_softc *mpt, u_int start_at)
147 {
148         KASSERT(start_at <= MPT_MAX_PERSONALITIES,
149                 ("mpt_pers_find: starting position out of range\n"));
150
151         while (start_at < MPT_MAX_PERSONALITIES
152             && (mpt->mpt_pers_mask & (0x1 << start_at)) == 0) {
153                 start_at++;
154         }
155         return (mpt_personalities[start_at]);
156 }
157
158 /*
159  * Used infrequently, so no need to optimize like a forward
160  * traversal where we use the MAX+1 is guaranteed to be NULL
161  * trick.
162  */
163 static __inline struct mpt_personality *
164 mpt_pers_find_reverse(struct mpt_softc *mpt, u_int start_at)
165 {
166         while (start_at < MPT_MAX_PERSONALITIES
167             && (mpt->mpt_pers_mask & (0x1 << start_at)) == 0) {
168                 start_at--;
169         }
170         if (start_at < MPT_MAX_PERSONALITIES)
171                 return (mpt_personalities[start_at]);
172         return (NULL);
173 }
174
175 #define MPT_PERS_FOREACH(mpt, pers)                             \
176         for (pers = mpt_pers_find(mpt, /*start_at*/0);          \
177              pers != NULL;                                      \
178              pers = mpt_pers_find(mpt, /*start_at*/pers->id+1))
179
180 #define MPT_PERS_FOREACH_REVERSE(mpt, pers)                             \
181         for (pers = mpt_pers_find_reverse(mpt, MPT_MAX_PERSONALITIES-1);\
182              pers != NULL;                                              \
183              pers = mpt_pers_find_reverse(mpt, /*start_at*/pers->id-1))
184
185 static mpt_load_handler_t      mpt_stdload;
186 static mpt_probe_handler_t     mpt_stdprobe;
187 static mpt_attach_handler_t    mpt_stdattach;
188 static mpt_enable_handler_t    mpt_stdenable;
189 static mpt_ready_handler_t     mpt_stdready;
190 static mpt_event_handler_t     mpt_stdevent;
191 static mpt_reset_handler_t     mpt_stdreset;
192 static mpt_shutdown_handler_t  mpt_stdshutdown;
193 static mpt_detach_handler_t    mpt_stddetach;
194 static mpt_unload_handler_t    mpt_stdunload;
195 static struct mpt_personality mpt_default_personality =
196 {
197         .load           = mpt_stdload,
198         .probe          = mpt_stdprobe,
199         .attach         = mpt_stdattach,
200         .enable         = mpt_stdenable,
201         .ready          = mpt_stdready,
202         .event          = mpt_stdevent,
203         .reset          = mpt_stdreset,
204         .shutdown       = mpt_stdshutdown,
205         .detach         = mpt_stddetach,
206         .unload         = mpt_stdunload
207 };
208
209 static mpt_load_handler_t      mpt_core_load;
210 static mpt_attach_handler_t    mpt_core_attach;
211 static mpt_enable_handler_t    mpt_core_enable;
212 static mpt_reset_handler_t     mpt_core_ioc_reset;
213 static mpt_event_handler_t     mpt_core_event;
214 static mpt_shutdown_handler_t  mpt_core_shutdown;
215 static mpt_shutdown_handler_t  mpt_core_detach;
216 static mpt_unload_handler_t    mpt_core_unload;
217 static struct mpt_personality mpt_core_personality =
218 {
219         .name           = "mpt_core",
220         .load           = mpt_core_load,
221         .attach         = mpt_core_attach,
222         .enable         = mpt_core_enable,
223         .event          = mpt_core_event,
224         .reset          = mpt_core_ioc_reset,
225         .shutdown       = mpt_core_shutdown,
226         .detach         = mpt_core_detach,
227         .unload         = mpt_core_unload,
228 };
229
230 /*
231  * Manual declaration so that DECLARE_MPT_PERSONALITY doesn't need
232  * ordering information.  We want the core to always register FIRST.
233  * other modules are set to SI_ORDER_SECOND.
234  */
235 static moduledata_t mpt_core_mod = {
236         "mpt_core", mpt_modevent, &mpt_core_personality
237 };
238 DECLARE_MODULE(mpt_core, mpt_core_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
239 MODULE_VERSION(mpt_core, 1);
240
241 #define MPT_PERS_ATTACHED(pers, mpt) ((mpt)->mpt_pers_mask & (0x1 << pers->id))
242
243 int
244 mpt_modevent(module_t mod, int type, void *data)
245 {
246         struct mpt_personality *pers;
247         int error;
248
249         pers = (struct mpt_personality *)data;
250
251         error = 0;
252         switch (type) {
253         case MOD_LOAD:
254         {
255                 mpt_load_handler_t **def_handler;
256                 mpt_load_handler_t **pers_handler;
257                 int i;
258
259                 for (i = 0; i < MPT_MAX_PERSONALITIES; i++) {
260                         if (mpt_personalities[i] == NULL)
261                                 break;
262                 }
263                 if (i >= MPT_MAX_PERSONALITIES) {
264                         error = ENOMEM;
265                         break;
266                 }
267                 pers->id = i;
268                 mpt_personalities[i] = pers;
269
270                 /* Install standard/noop handlers for any NULL entries. */
271                 def_handler = MPT_PERS_FIRST_HANDLER(&mpt_default_personality);
272                 pers_handler = MPT_PERS_FIRST_HANDLER(pers);
273                 while (pers_handler <= MPT_PERS_LAST_HANDLER(pers)) {
274                         if (*pers_handler == NULL)
275                                 *pers_handler = *def_handler;
276                         pers_handler++;
277                         def_handler++;
278                 }
279                 
280                 error = (pers->load(pers));
281                 if (error != 0)
282                         mpt_personalities[i] = NULL;
283                 break;
284         }
285         case MOD_SHUTDOWN:
286                 break;
287 #if __FreeBSD_version >= 500000
288         case MOD_QUIESCE:
289                 break;
290 #endif
291         case MOD_UNLOAD:
292                 error = pers->unload(pers);
293                 mpt_personalities[pers->id] = NULL;
294                 break;
295         default:
296                 error = EINVAL;
297                 break;
298         }
299         return (error);
300 }
301
302 int
303 mpt_stdload(struct mpt_personality *pers)
304 {
305         /* Load is always successfull. */
306         return (0);
307 }
308
309 int
310 mpt_stdprobe(struct mpt_softc *mpt)
311 {
312         /* Probe is always successfull. */
313         return (0);
314 }
315
316 int
317 mpt_stdattach(struct mpt_softc *mpt)
318 {
319         /* Attach is always successfull. */
320         return (0);
321 }
322
323 int
324 mpt_stdenable(struct mpt_softc *mpt)
325 {
326         /* Enable is always successfull. */
327         return (0);
328 }
329
330 void
331 mpt_stdready(struct mpt_softc *mpt)
332 {
333 }
334
335
336 int
337 mpt_stdevent(struct mpt_softc *mpt, request_t *req, MSG_EVENT_NOTIFY_REPLY *msg)
338 {
339         mpt_lprt(mpt, MPT_PRT_DEBUG, "mpt_stdevent: 0x%x\n", msg->Event & 0xFF);
340         /* Event was not for us. */
341         return (0);
342 }
343
344 void
345 mpt_stdreset(struct mpt_softc *mpt, int type)
346 {
347 }
348
349 void
350 mpt_stdshutdown(struct mpt_softc *mpt)
351 {
352 }
353
354 void
355 mpt_stddetach(struct mpt_softc *mpt)
356 {
357 }
358
359 int
360 mpt_stdunload(struct mpt_personality *pers)
361 {
362         /* Unload is always successfull. */
363         return (0);
364 }
365
366 /*
367  * Post driver attachment, we may want to perform some global actions.
368  * Here is the hook to do so.
369  */
370
371 static void
372 mpt_postattach(void *unused)
373 {
374         struct mpt_softc *mpt;
375         struct mpt_personality *pers;
376
377         TAILQ_FOREACH(mpt, &mpt_tailq, links) {
378                 MPT_PERS_FOREACH(mpt, pers)
379                         pers->ready(mpt);
380         }
381 }
382 SYSINIT(mptdev, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE, mpt_postattach, NULL);
383
384
385 /******************************* Bus DMA Support ******************************/
386 void
387 mpt_map_rquest(void *arg, bus_dma_segment_t *segs, int nseg, int error)
388 {
389         struct mpt_map_info *map_info;
390
391         map_info = (struct mpt_map_info *)arg;
392         map_info->error = error;
393         map_info->phys = segs->ds_addr;
394 }
395
396 /**************************** Reply/Event Handling ****************************/
397 int
398 mpt_register_handler(struct mpt_softc *mpt, mpt_handler_type type,
399                      mpt_handler_t handler, uint32_t *phandler_id)
400 {
401
402         switch (type) {
403         case MPT_HANDLER_REPLY:
404         {
405                 u_int cbi;
406                 u_int free_cbi;
407
408                 if (phandler_id == NULL)
409                         return (EINVAL);
410
411                 free_cbi = MPT_HANDLER_ID_NONE;
412                 for (cbi = 0; cbi < MPT_NUM_REPLY_HANDLERS; cbi++) {
413                         /*
414                          * If the same handler is registered multiple
415                          * times, don't error out.  Just return the
416                          * index of the original registration.
417                          */
418                         if (mpt_reply_handlers[cbi] == handler.reply_handler) {
419                                 *phandler_id = MPT_CBI_TO_HID(cbi);
420                                 return (0);
421                         }
422
423                         /*
424                          * Fill from the front in the hope that
425                          * all registered handlers consume only a
426                          * single cache line.
427                          *
428                          * We don't break on the first empty slot so
429                          * that the full table is checked to see if
430                          * this handler was previously registered.
431                          */
432                         if (free_cbi == MPT_HANDLER_ID_NONE &&
433                             (mpt_reply_handlers[cbi]
434                           == mpt_default_reply_handler))
435                                 free_cbi = cbi;
436                 }
437                 if (free_cbi == MPT_HANDLER_ID_NONE) {
438                         return (ENOMEM);
439                 }
440                 mpt_reply_handlers[free_cbi] = handler.reply_handler;
441                 *phandler_id = MPT_CBI_TO_HID(free_cbi);
442                 break;
443         }
444         default:
445                 mpt_prt(mpt, "mpt_register_handler unknown type %d\n", type);
446                 return (EINVAL);
447         }
448         return (0);
449 }
450
451 int
452 mpt_deregister_handler(struct mpt_softc *mpt, mpt_handler_type type,
453                        mpt_handler_t handler, uint32_t handler_id)
454 {
455
456         switch (type) {
457         case MPT_HANDLER_REPLY:
458         {
459                 u_int cbi;
460
461                 cbi = MPT_CBI(handler_id);
462                 if (cbi >= MPT_NUM_REPLY_HANDLERS
463                  || mpt_reply_handlers[cbi] != handler.reply_handler)
464                         return (ENOENT);
465                 mpt_reply_handlers[cbi] = mpt_default_reply_handler;
466                 break;
467         }
468         default:
469                 mpt_prt(mpt, "mpt_deregister_handler unknown type %d\n", type);
470                 return (EINVAL);
471         }
472         return (0);
473 }
474
475 static int
476 mpt_default_reply_handler(struct mpt_softc *mpt, request_t *req,
477         uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame)
478 {
479         mpt_prt(mpt,
480             "Default Handler Called: req=%p:%u reply_descriptor=%x frame=%p\n",
481             req, req->serno, reply_desc, reply_frame);
482
483         if (reply_frame != NULL)
484                 mpt_dump_reply_frame(mpt, reply_frame);
485
486         mpt_prt(mpt, "Reply Frame Ignored\n");
487
488         return (/*free_reply*/TRUE);
489 }
490
491 static int
492 mpt_config_reply_handler(struct mpt_softc *mpt, request_t *req,
493  uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame)
494 {
495         if (req != NULL) {
496
497                 if (reply_frame != NULL) {
498                         MSG_CONFIG *cfgp;
499                         MSG_CONFIG_REPLY *reply;
500
501                         cfgp = (MSG_CONFIG *)req->req_vbuf;
502                         reply = (MSG_CONFIG_REPLY *)reply_frame;
503                         req->IOCStatus = le16toh(reply_frame->IOCStatus);
504                         bcopy(&reply->Header, &cfgp->Header,
505                               sizeof(cfgp->Header));
506                         cfgp->ExtPageLength = reply->ExtPageLength;
507                         cfgp->ExtPageType = reply->ExtPageType;
508                 }
509                 req->state &= ~REQ_STATE_QUEUED;
510                 req->state |= REQ_STATE_DONE;
511                 TAILQ_REMOVE(&mpt->request_pending_list, req, links);
512                 if ((req->state & REQ_STATE_NEED_WAKEUP) != 0) {
513                         wakeup(req);
514                 } else if ((req->state & REQ_STATE_TIMEDOUT) != 0) {
515                         /*
516                          * Whew- we can free this request (late completion)
517                          */
518                         mpt_free_request(mpt, req);
519                 }
520         }
521
522         return (TRUE);
523 }
524
525 static int
526 mpt_handshake_reply_handler(struct mpt_softc *mpt, request_t *req,
527  uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame)
528 {
529         /* Nothing to be done. */
530         return (TRUE);
531 }
532
533 static int
534 mpt_event_reply_handler(struct mpt_softc *mpt, request_t *req,
535     uint32_t reply_desc, MSG_DEFAULT_REPLY *reply_frame)
536 {
537         int free_reply;
538
539         KASSERT(reply_frame != NULL, ("null reply in mpt_event_reply_handler"));
540         KASSERT(req != NULL, ("null request in mpt_event_reply_handler"));
541
542         free_reply = TRUE;
543         switch (reply_frame->Function) {
544         case MPI_FUNCTION_EVENT_NOTIFICATION:
545         {
546                 MSG_EVENT_NOTIFY_REPLY *msg;
547                 struct mpt_personality *pers;
548                 u_int handled;
549
550                 handled = 0;
551                 msg = (MSG_EVENT_NOTIFY_REPLY *)reply_frame;
552                 msg->EventDataLength = le16toh(msg->EventDataLength);
553                 msg->IOCStatus = le16toh(msg->IOCStatus);
554                 msg->IOCLogInfo = le32toh(msg->IOCLogInfo);
555                 msg->Event = le32toh(msg->Event);
556                 MPT_PERS_FOREACH(mpt, pers)
557                         handled += pers->event(mpt, req, msg);
558
559                 if (handled == 0 && mpt->mpt_pers_mask == 0) {
560                         mpt_lprt(mpt, MPT_PRT_INFO,
561                                 "No Handlers For Any Event Notify Frames. "
562                                 "Event %#x (ACK %sequired).\n",
563                                 msg->Event, msg->AckRequired? "r" : "not r");
564                 } else if (handled == 0) {
565                         mpt_lprt(mpt,
566                                 msg->AckRequired? MPT_PRT_WARN : MPT_PRT_INFO,
567                                 "Unhandled Event Notify Frame. Event %#x "
568                                 "(ACK %sequired).\n",
569                                 msg->Event, msg->AckRequired? "r" : "not r");
570                 }
571
572                 if (msg->AckRequired) {
573                         request_t *ack_req;
574                         uint32_t context;
575
576                         context = req->index | MPT_REPLY_HANDLER_EVENTS;
577                         ack_req = mpt_get_request(mpt, FALSE);
578                         if (ack_req == NULL) {
579                                 struct mpt_evtf_record *evtf;
580
581                                 evtf = (struct mpt_evtf_record *)reply_frame;
582                                 evtf->context = context;
583                                 LIST_INSERT_HEAD(&mpt->ack_frames, evtf, links);
584                                 free_reply = FALSE;
585                                 break;
586                         }
587                         mpt_send_event_ack(mpt, ack_req, msg, context);
588                         /*
589                          * Don't check for CONTINUATION_REPLY here
590                          */
591                         return (free_reply);
592                 }
593                 break;
594         }
595         case MPI_FUNCTION_PORT_ENABLE:
596                 mpt_lprt(mpt, MPT_PRT_DEBUG , "enable port reply\n");
597                 break;
598         case MPI_FUNCTION_EVENT_ACK:
599                 break;
600         default:
601                 mpt_prt(mpt, "unknown event function: %x\n",
602                         reply_frame->Function);
603                 break;
604         }
605
606         /*
607          * I'm not sure that this continuation stuff works as it should.
608          *
609          * I've had FC async events occur that free the frame up because
610          * the continuation bit isn't set, and then additional async events
611          * then occur using the same context. As you might imagine, this
612          * leads to Very Bad Thing.
613          *
614          *  Let's just be safe for now and not free them up until we figure
615          * out what's actually happening here.
616          */
617 #if     0
618         if ((reply_frame->MsgFlags & MPI_MSGFLAGS_CONTINUATION_REPLY) == 0) {
619                 TAILQ_REMOVE(&mpt->request_pending_list, req, links);
620                 mpt_free_request(mpt, req);
621                 mpt_prt(mpt, "event_reply %x for req %p:%u NOT a continuation",
622                     reply_frame->Function, req, req->serno);
623                 if (reply_frame->Function == MPI_FUNCTION_EVENT_NOTIFICATION) {
624                         MSG_EVENT_NOTIFY_REPLY *msg =
625                             (MSG_EVENT_NOTIFY_REPLY *)reply_frame;
626                         mpt_prtc(mpt, " Event=0x%x AckReq=%d",
627                             msg->Event, msg->AckRequired);
628                 }
629         } else {
630                 mpt_prt(mpt, "event_reply %x for %p:%u IS a continuation",
631                     reply_frame->Function, req, req->serno);
632                 if (reply_frame->Function == MPI_FUNCTION_EVENT_NOTIFICATION) {
633                         MSG_EVENT_NOTIFY_REPLY *msg =
634                             (MSG_EVENT_NOTIFY_REPLY *)reply_frame;
635                         mpt_prtc(mpt, " Event=0x%x AckReq=%d",
636                             msg->Event, msg->AckRequired);
637                 }
638                 mpt_prtc(mpt, "\n");
639         }
640 #endif
641         return (free_reply);
642 }
643
644 /*
645  * Process an asynchronous event from the IOC.
646  */
647 static int
648 mpt_core_event(struct mpt_softc *mpt, request_t *req,
649                MSG_EVENT_NOTIFY_REPLY *msg)
650 {
651         mpt_lprt(mpt, MPT_PRT_DEBUG, "mpt_core_event: 0x%x\n",
652                  msg->Event & 0xFF);
653         switch(msg->Event & 0xFF) {
654         case MPI_EVENT_NONE:
655                 break;
656         case MPI_EVENT_LOG_DATA:
657         {
658                 int i;
659
660                 /* Some error occured that LSI wants logged */
661                 mpt_prt(mpt, "EvtLogData: IOCLogInfo: 0x%08x\n",
662                         msg->IOCLogInfo);
663                 mpt_prt(mpt, "\tEvtLogData: Event Data:");
664                 for (i = 0; i < msg->EventDataLength; i++)
665                         mpt_prtc(mpt, "  %08x", msg->Data[i]);
666                 mpt_prtc(mpt, "\n");
667                 break;
668         }
669         case MPI_EVENT_EVENT_CHANGE:
670                 /*
671                  * This is just an acknowledgement
672                  * of our mpt_send_event_request.
673                  */
674                 break;
675         case MPI_EVENT_SAS_DEVICE_STATUS_CHANGE:
676                 break;
677         default:
678                 return (0);
679                 break;
680         }
681         return (1);
682 }
683
684 static void
685 mpt_send_event_ack(struct mpt_softc *mpt, request_t *ack_req,
686                    MSG_EVENT_NOTIFY_REPLY *msg, uint32_t context)
687 {
688         MSG_EVENT_ACK *ackp;
689
690         ackp = (MSG_EVENT_ACK *)ack_req->req_vbuf;
691         memset(ackp, 0, sizeof (*ackp));
692         ackp->Function = MPI_FUNCTION_EVENT_ACK;
693         ackp->Event = htole32(msg->Event);
694         ackp->EventContext = htole32(msg->EventContext);
695         ackp->MsgContext = htole32(context);
696         mpt_check_doorbell(mpt);
697         mpt_send_cmd(mpt, ack_req);
698 }
699
700 /***************************** Interrupt Handling *****************************/
701 void
702 mpt_intr(void *arg)
703 {
704         struct mpt_softc *mpt;
705         uint32_t reply_desc;
706         int ntrips = 0;
707
708         mpt = (struct mpt_softc *)arg;
709         mpt_lprt(mpt, MPT_PRT_DEBUG2, "enter mpt_intr\n");
710         MPT_LOCK_ASSERT(mpt);
711
712         while ((reply_desc = mpt_pop_reply_queue(mpt)) != MPT_REPLY_EMPTY) {
713                 request_t         *req;
714                 MSG_DEFAULT_REPLY *reply_frame;
715                 uint32_t           reply_baddr;
716                 uint32_t           ctxt_idx;
717                 u_int              cb_index;
718                 u_int              req_index;
719                 int                free_rf;
720
721                 req = NULL;
722                 reply_frame = NULL;
723                 reply_baddr = 0;
724                 if ((reply_desc & MPI_ADDRESS_REPLY_A_BIT) != 0) {
725                         u_int offset;
726                         /*
727                          * Insure that the reply frame is coherent.
728                          */
729                         reply_baddr = MPT_REPLY_BADDR(reply_desc);
730                         offset = reply_baddr - (mpt->reply_phys & 0xFFFFFFFF);
731                         bus_dmamap_sync_range(mpt->reply_dmat,
732                             mpt->reply_dmap, offset, MPT_REPLY_SIZE,
733                             BUS_DMASYNC_POSTREAD);
734                         reply_frame = MPT_REPLY_OTOV(mpt, offset);
735                         ctxt_idx = le32toh(reply_frame->MsgContext);
736                 } else {
737                         uint32_t type;
738
739                         type = MPI_GET_CONTEXT_REPLY_TYPE(reply_desc);
740                         ctxt_idx = reply_desc;
741                         mpt_lprt(mpt, MPT_PRT_DEBUG1, "Context Reply: 0x%08x\n",
742                                     reply_desc);
743
744                         switch (type) {
745                         case MPI_CONTEXT_REPLY_TYPE_SCSI_INIT:
746                                 ctxt_idx &= MPI_CONTEXT_REPLY_CONTEXT_MASK;
747                                 break;
748                         case MPI_CONTEXT_REPLY_TYPE_SCSI_TARGET:
749                                 ctxt_idx = GET_IO_INDEX(reply_desc);
750                                 if (mpt->tgt_cmd_ptrs == NULL) {
751                                         mpt_prt(mpt,
752                                             "mpt_intr: no target cmd ptrs\n");
753                                         reply_desc = MPT_REPLY_EMPTY;
754                                         break;
755                                 }
756                                 if (ctxt_idx >= mpt->tgt_cmds_allocated) {
757                                         mpt_prt(mpt,
758                                             "mpt_intr: bad tgt cmd ctxt %u\n",
759                                             ctxt_idx);
760                                         reply_desc = MPT_REPLY_EMPTY;
761                                         ntrips = 1000;
762                                         break;
763                                 }
764                                 req = mpt->tgt_cmd_ptrs[ctxt_idx];
765                                 if (req == NULL) {
766                                         mpt_prt(mpt, "no request backpointer "
767                                             "at index %u", ctxt_idx);
768                                         reply_desc = MPT_REPLY_EMPTY;
769                                         ntrips = 1000;
770                                         break;
771                                 }
772                                 /*
773                                  * Reformulate ctxt_idx to be just as if
774                                  * it were another type of context reply
775                                  * so the code below will find the request
776                                  * via indexing into the pool.
777                                  */
778                                 ctxt_idx =
779                                     req->index | mpt->scsi_tgt_handler_id;
780                                 req = NULL;
781                                 break;
782                         case MPI_CONTEXT_REPLY_TYPE_LAN:
783                                 mpt_prt(mpt, "LAN CONTEXT REPLY: 0x%08x\n",
784                                     reply_desc);
785                                 reply_desc = MPT_REPLY_EMPTY;
786                                 break;
787                         default:
788                                 mpt_prt(mpt, "Context Reply 0x%08x?\n", type);
789                                 reply_desc = MPT_REPLY_EMPTY;
790                                 break;
791                         }
792                         if (reply_desc == MPT_REPLY_EMPTY) {
793                                 if (ntrips++ > 1000) {
794                                         break;
795                                 }
796                                 continue;
797                         }
798                 }
799
800                 cb_index = MPT_CONTEXT_TO_CBI(ctxt_idx);
801                 req_index = MPT_CONTEXT_TO_REQI(ctxt_idx);
802                 if (req_index < MPT_MAX_REQUESTS(mpt)) {
803                         req = &mpt->request_pool[req_index];
804                 } else {
805                         mpt_prt(mpt, "WARN: mpt_intr index == %d (reply_desc =="
806                             " 0x%x)\n", req_index, reply_desc);
807                 }
808
809                 free_rf = mpt_reply_handlers[cb_index](mpt, req,
810                     reply_desc, reply_frame);
811
812                 if (reply_frame != NULL && free_rf) {
813                         mpt_free_reply(mpt, reply_baddr);
814                 }
815
816                 /*
817                  * If we got ourselves disabled, don't get stuck in a loop
818                  */
819                 if (mpt->disabled) {
820                         mpt_disable_ints(mpt);
821                         break;
822                 }
823                 if (ntrips++ > 1000) {
824                         break;
825                 }
826         }
827         mpt_lprt(mpt, MPT_PRT_DEBUG2, "exit mpt_intr\n");
828 }
829
830 /******************************* Error Recovery *******************************/
831 void
832 mpt_complete_request_chain(struct mpt_softc *mpt, struct req_queue *chain,
833                             u_int iocstatus)
834 {
835         MSG_DEFAULT_REPLY  ioc_status_frame;
836         request_t         *req;
837
838         memset(&ioc_status_frame, 0, sizeof(ioc_status_frame));
839         ioc_status_frame.MsgLength = roundup2(sizeof(ioc_status_frame), 4);
840         ioc_status_frame.IOCStatus = iocstatus;
841         while((req = TAILQ_FIRST(chain)) != NULL) {
842                 MSG_REQUEST_HEADER *msg_hdr;
843                 u_int               cb_index;
844
845                 TAILQ_REMOVE(chain, req, links);
846                 msg_hdr = (MSG_REQUEST_HEADER *)req->req_vbuf;
847                 ioc_status_frame.Function = msg_hdr->Function;
848                 ioc_status_frame.MsgContext = msg_hdr->MsgContext;
849                 cb_index = MPT_CONTEXT_TO_CBI(le32toh(msg_hdr->MsgContext));
850                 mpt_reply_handlers[cb_index](mpt, req, msg_hdr->MsgContext,
851                     &ioc_status_frame);
852         }
853 }
854
855 /********************************* Diagnostics ********************************/
856 /*
857  * Perform a diagnostic dump of a reply frame.
858  */
859 void
860 mpt_dump_reply_frame(struct mpt_softc *mpt, MSG_DEFAULT_REPLY *reply_frame)
861 {
862         mpt_prt(mpt, "Address Reply:\n");
863         mpt_print_reply(reply_frame);
864 }
865
866 /******************************* Doorbell Access ******************************/
867 static __inline uint32_t mpt_rd_db(struct mpt_softc *mpt);
868 static __inline  uint32_t mpt_rd_intr(struct mpt_softc *mpt);
869
870 static __inline uint32_t
871 mpt_rd_db(struct mpt_softc *mpt)
872 {
873         return mpt_read(mpt, MPT_OFFSET_DOORBELL);
874 }
875
876 static __inline uint32_t
877 mpt_rd_intr(struct mpt_softc *mpt)
878 {
879         return mpt_read(mpt, MPT_OFFSET_INTR_STATUS);
880 }
881
882 /* Busy wait for a door bell to be read by IOC */
883 static int
884 mpt_wait_db_ack(struct mpt_softc *mpt)
885 {
886         int i;
887         for (i=0; i < MPT_MAX_WAIT; i++) {
888                 if (!MPT_DB_IS_BUSY(mpt_rd_intr(mpt))) {
889                         maxwait_ack = i > maxwait_ack ? i : maxwait_ack;
890                         return (MPT_OK);
891                 }
892                 DELAY(200);
893         }
894         return (MPT_FAIL);
895 }
896
897 /* Busy wait for a door bell interrupt */
898 static int
899 mpt_wait_db_int(struct mpt_softc *mpt)
900 {
901         int i;
902         for (i = 0; i < MPT_MAX_WAIT; i++) {
903                 if (MPT_DB_INTR(mpt_rd_intr(mpt))) {
904                         maxwait_int = i > maxwait_int ? i : maxwait_int;
905                         return MPT_OK;
906                 }
907                 DELAY(100);
908         }
909         return (MPT_FAIL);
910 }
911
912 /* Wait for IOC to transition to a give state */
913 void
914 mpt_check_doorbell(struct mpt_softc *mpt)
915 {
916         uint32_t db = mpt_rd_db(mpt);
917         if (MPT_STATE(db) != MPT_DB_STATE_RUNNING) {
918                 mpt_prt(mpt, "Device not running\n");
919                 mpt_print_db(db);
920         }
921 }
922
923 /* Wait for IOC to transition to a give state */
924 static int
925 mpt_wait_state(struct mpt_softc *mpt, enum DB_STATE_BITS state)
926 {
927         int i;
928
929         for (i = 0; i < MPT_MAX_WAIT; i++) {
930                 uint32_t db = mpt_rd_db(mpt);
931                 if (MPT_STATE(db) == state) {
932                         maxwait_state = i > maxwait_state ? i : maxwait_state;
933                         return (MPT_OK);
934                 }
935                 DELAY(100);
936         }
937         return (MPT_FAIL);
938 }
939
940
941 /************************* Intialization/Configuration ************************/
942 static int mpt_download_fw(struct mpt_softc *mpt);
943
944 /* Issue the reset COMMAND to the IOC */
945 static int
946 mpt_soft_reset(struct mpt_softc *mpt)
947 {
948         mpt_lprt(mpt, MPT_PRT_DEBUG, "soft reset\n");
949
950         /* Have to use hard reset if we are not in Running state */
951         if (MPT_STATE(mpt_rd_db(mpt)) != MPT_DB_STATE_RUNNING) {
952                 mpt_prt(mpt, "soft reset failed: device not running\n");
953                 return (MPT_FAIL);
954         }
955
956         /* If door bell is in use we don't have a chance of getting
957          * a word in since the IOC probably crashed in message
958          * processing. So don't waste our time.
959          */
960         if (MPT_DB_IS_IN_USE(mpt_rd_db(mpt))) {
961                 mpt_prt(mpt, "soft reset failed: doorbell wedged\n");
962                 return (MPT_FAIL);
963         }
964
965         /* Send the reset request to the IOC */
966         mpt_write(mpt, MPT_OFFSET_DOORBELL,
967             MPI_FUNCTION_IOC_MESSAGE_UNIT_RESET << MPI_DOORBELL_FUNCTION_SHIFT);
968         if (mpt_wait_db_ack(mpt) != MPT_OK) {
969                 mpt_prt(mpt, "soft reset failed: ack timeout\n");
970                 return (MPT_FAIL);
971         }
972
973         /* Wait for the IOC to reload and come out of reset state */
974         if (mpt_wait_state(mpt, MPT_DB_STATE_READY) != MPT_OK) {
975                 mpt_prt(mpt, "soft reset failed: device did not restart\n");
976                 return (MPT_FAIL);
977         }
978
979         return MPT_OK;
980 }
981
982 static int
983 mpt_enable_diag_mode(struct mpt_softc *mpt)
984 {
985         int try;
986
987         try = 20;
988         while (--try) {
989
990                 if ((mpt_read(mpt, MPT_OFFSET_DIAGNOSTIC) & MPI_DIAG_DRWE) != 0)
991                         break;
992
993                 /* Enable diagnostic registers */
994                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, 0xFF);
995                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPI_WRSEQ_1ST_KEY_VALUE);
996                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPI_WRSEQ_2ND_KEY_VALUE);
997                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPI_WRSEQ_3RD_KEY_VALUE);
998                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPI_WRSEQ_4TH_KEY_VALUE);
999                 mpt_write(mpt, MPT_OFFSET_SEQUENCE, MPI_WRSEQ_5TH_KEY_VALUE);
1000
1001                 DELAY(100000);
1002         }
1003         if (try == 0)
1004                 return (EIO);
1005         return (0);
1006 }
1007
1008 static void
1009 mpt_disable_diag_mode(struct mpt_softc *mpt)
1010 {
1011         mpt_write(mpt, MPT_OFFSET_SEQUENCE, 0xFFFFFFFF);
1012 }
1013
1014 /* This is a magic diagnostic reset that resets all the ARM
1015  * processors in the chip.
1016  */
1017 static void
1018 mpt_hard_reset(struct mpt_softc *mpt)
1019 {
1020         int error;
1021         int wait;
1022         uint32_t diagreg;
1023
1024         mpt_lprt(mpt, MPT_PRT_DEBUG, "hard reset\n");
1025
1026         error = mpt_enable_diag_mode(mpt);
1027         if (error) {
1028                 mpt_prt(mpt, "WARNING - Could not enter diagnostic mode !\n");
1029                 mpt_prt(mpt, "Trying to reset anyway.\n");
1030         }
1031
1032         diagreg = mpt_read(mpt, MPT_OFFSET_DIAGNOSTIC);
1033
1034         /*
1035          * This appears to be a workaround required for some
1036          * firmware or hardware revs.
1037          */
1038         mpt_write(mpt, MPT_OFFSET_DIAGNOSTIC, diagreg | MPI_DIAG_DISABLE_ARM);
1039         DELAY(1000);
1040
1041         /* Diag. port is now active so we can now hit the reset bit */
1042         mpt_write(mpt, MPT_OFFSET_DIAGNOSTIC, diagreg | MPI_DIAG_RESET_ADAPTER);
1043
1044         /*
1045          * Ensure that the reset has finished.  We delay 1ms
1046          * prior to reading the register to make sure the chip
1047          * has sufficiently completed its reset to handle register
1048          * accesses.
1049          */
1050         wait = 5000;
1051         do {
1052                 DELAY(1000);
1053                 diagreg = mpt_read(mpt, MPT_OFFSET_DIAGNOSTIC);
1054         } while (--wait && (diagreg & MPI_DIAG_RESET_ADAPTER) == 0);
1055
1056         if (wait == 0) {
1057                 mpt_prt(mpt, "WARNING - Failed hard reset! "
1058                         "Trying to initialize anyway.\n");
1059         }
1060
1061         /*
1062          * If we have firmware to download, it must be loaded before
1063          * the controller will become operational.  Do so now.
1064          */
1065         if (mpt->fw_image != NULL) {
1066
1067                 error = mpt_download_fw(mpt);
1068
1069                 if (error) {
1070                         mpt_prt(mpt, "WARNING - Firmware Download Failed!\n");
1071                         mpt_prt(mpt, "Trying to initialize anyway.\n");
1072                 }
1073         }
1074
1075         /*
1076          * Reseting the controller should have disabled write
1077          * access to the diagnostic registers, but disable
1078          * manually to be sure.
1079          */
1080         mpt_disable_diag_mode(mpt);
1081 }
1082
1083 static void
1084 mpt_core_ioc_reset(struct mpt_softc *mpt, int type)
1085 {
1086         /*
1087          * Complete all pending requests with a status
1088          * appropriate for an IOC reset.
1089          */
1090         mpt_complete_request_chain(mpt, &mpt->request_pending_list,
1091                                    MPI_IOCSTATUS_INVALID_STATE);
1092 }
1093
1094
1095 /*
1096  * Reset the IOC when needed. Try software command first then if needed
1097  * poke at the magic diagnostic reset. Note that a hard reset resets
1098  * *both* IOCs on dual function chips (FC929 && LSI1030) as well as
1099  * fouls up the PCI configuration registers.
1100  */
1101 int
1102 mpt_reset(struct mpt_softc *mpt, int reinit)
1103 {
1104         struct  mpt_personality *pers;
1105         int     ret;
1106         int     retry_cnt = 0;
1107
1108         /*
1109          * Try a soft reset. If that fails, get out the big hammer.
1110          */
1111  again:
1112         if ((ret = mpt_soft_reset(mpt)) != MPT_OK) {
1113                 int     cnt;
1114                 for (cnt = 0; cnt < 5; cnt++) {
1115                         /* Failed; do a hard reset */
1116                         mpt_hard_reset(mpt);
1117
1118                         /*
1119                          * Wait for the IOC to reload
1120                          * and come out of reset state
1121                          */
1122                         ret = mpt_wait_state(mpt, MPT_DB_STATE_READY);
1123                         if (ret == MPT_OK) {
1124                                 break;
1125                         }
1126                         /*
1127                          * Okay- try to check again...
1128                          */
1129                         ret = mpt_wait_state(mpt, MPT_DB_STATE_READY);
1130                         if (ret == MPT_OK) {
1131                                 break;
1132                         }
1133                         mpt_prt(mpt, "mpt_reset: failed hard reset (%d:%d)\n",
1134                             retry_cnt, cnt);
1135                 }
1136         }
1137
1138         if (retry_cnt == 0) {
1139                 /*
1140                  * Invoke reset handlers.  We bump the reset count so
1141                  * that mpt_wait_req() understands that regardless of
1142                  * the specified wait condition, it should stop its wait.
1143                  */
1144                 mpt->reset_cnt++;
1145                 MPT_PERS_FOREACH(mpt, pers)
1146                         pers->reset(mpt, ret);
1147         }
1148
1149         if (reinit) {
1150                 ret = mpt_enable_ioc(mpt, 1);
1151                 if (ret == MPT_OK) {
1152                         mpt_enable_ints(mpt);
1153                 }
1154         }
1155         if (ret != MPT_OK && retry_cnt++ < 2) {
1156                 goto again;
1157         }
1158         return ret;
1159 }
1160
1161 /* Return a command buffer to the free queue */
1162 void
1163 mpt_free_request(struct mpt_softc *mpt, request_t *req)
1164 {
1165         request_t *nxt;
1166         struct mpt_evtf_record *record;
1167         uint32_t reply_baddr;
1168         
1169         if (req == NULL || req != &mpt->request_pool[req->index]) {
1170                 panic("mpt_free_request bad req ptr\n");
1171                 return;
1172         }
1173         if ((nxt = req->chain) != NULL) {
1174                 req->chain = NULL;
1175                 mpt_free_request(mpt, nxt);     /* NB: recursion */
1176         }
1177         KASSERT(req->state != REQ_STATE_FREE, ("freeing free request"));
1178         KASSERT(!(req->state & REQ_STATE_LOCKED), ("freeing locked request"));
1179         MPT_LOCK_ASSERT(mpt);
1180         KASSERT(mpt_req_on_free_list(mpt, req) == 0,
1181             ("mpt_free_request: req %p:%u func %x already on freelist",
1182             req, req->serno, ((MSG_REQUEST_HEADER *)req->req_vbuf)->Function));
1183         KASSERT(mpt_req_on_pending_list(mpt, req) == 0,
1184             ("mpt_free_request: req %p:%u func %x on pending list",
1185             req, req->serno, ((MSG_REQUEST_HEADER *)req->req_vbuf)->Function));
1186 #ifdef  INVARIANTS
1187         mpt_req_not_spcl(mpt, req, "mpt_free_request", __LINE__);
1188 #endif
1189
1190         req->ccb = NULL;
1191         if (LIST_EMPTY(&mpt->ack_frames)) {
1192                 /*
1193                  * Insert free ones at the tail
1194                  */
1195                 req->serno = 0;
1196                 req->state = REQ_STATE_FREE;
1197 #ifdef  INVARIANTS
1198                 memset(req->req_vbuf, 0xff, sizeof (MSG_REQUEST_HEADER));
1199 #endif
1200                 TAILQ_INSERT_TAIL(&mpt->request_free_list, req, links);
1201                 if (mpt->getreqwaiter != 0) {
1202                         mpt->getreqwaiter = 0;
1203                         wakeup(&mpt->request_free_list);
1204                 }
1205                 return;
1206         }
1207
1208         /*
1209          * Process an ack frame deferred due to resource shortage.
1210          */
1211         record = LIST_FIRST(&mpt->ack_frames);
1212         LIST_REMOVE(record, links);
1213         req->state = REQ_STATE_ALLOCATED;
1214         mpt_assign_serno(mpt, req);
1215         mpt_send_event_ack(mpt, req, &record->reply, record->context);
1216         reply_baddr = (uint32_t)((uint8_t *)record - mpt->reply)
1217                     + (mpt->reply_phys & 0xFFFFFFFF);
1218         mpt_free_reply(mpt, reply_baddr);
1219 }
1220
1221 /* Get a command buffer from the free queue */
1222 request_t *
1223 mpt_get_request(struct mpt_softc *mpt, int sleep_ok)
1224 {
1225         request_t *req;
1226
1227 retry:
1228         MPT_LOCK_ASSERT(mpt);
1229         req = TAILQ_FIRST(&mpt->request_free_list);
1230         if (req != NULL) {
1231                 KASSERT(req == &mpt->request_pool[req->index],
1232                     ("mpt_get_request: corrupted request free list\n"));
1233                 KASSERT(req->state == REQ_STATE_FREE,
1234                     ("req %p:%u not free on free list %x index %d function %x",
1235                     req, req->serno, req->state, req->index,
1236                     ((MSG_REQUEST_HEADER *)req->req_vbuf)->Function));
1237                 TAILQ_REMOVE(&mpt->request_free_list, req, links);
1238                 req->state = REQ_STATE_ALLOCATED;
1239                 req->chain = NULL;
1240                 mpt_assign_serno(mpt, req);
1241                 mpt_callout_init(&req->callout);
1242         } else if (sleep_ok != 0) {
1243                 mpt->getreqwaiter = 1;
1244                 mpt_sleep(mpt, &mpt->request_free_list, PUSER, "mptgreq", 0);
1245                 goto retry;
1246         }
1247         return (req);
1248 }
1249
1250 /* Pass the command to the IOC */
1251 void
1252 mpt_send_cmd(struct mpt_softc *mpt, request_t *req)
1253 {
1254         if (mpt->verbose > MPT_PRT_DEBUG2) {
1255                 mpt_dump_request(mpt, req);
1256         }
1257         bus_dmamap_sync(mpt->request_dmat, mpt->request_dmap,
1258             BUS_DMASYNC_PREWRITE);
1259         req->state |= REQ_STATE_QUEUED;
1260         KASSERT(mpt_req_on_free_list(mpt, req) == 0,
1261             ("req %p:%u func %x on freelist list in mpt_send_cmd",
1262             req, req->serno, ((MSG_REQUEST_HEADER *)req->req_vbuf)->Function));
1263         KASSERT(mpt_req_on_pending_list(mpt, req) == 0,
1264             ("req %p:%u func %x already on pending list in mpt_send_cmd",
1265             req, req->serno, ((MSG_REQUEST_HEADER *)req->req_vbuf)->Function));
1266         TAILQ_INSERT_HEAD(&mpt->request_pending_list, req, links);
1267         mpt_write(mpt, MPT_OFFSET_REQUEST_Q, (uint32_t) req->req_pbuf);
1268 }
1269
1270 /*
1271  * Wait for a request to complete.
1272  *
1273  * Inputs:
1274  *      mpt             softc of controller executing request
1275  *      req             request to wait for
1276  *      sleep_ok        nonzero implies may sleep in this context
1277  *      time_ms         timeout in ms.  0 implies no timeout.
1278  *
1279  * Return Values:
1280  *      0               Request completed
1281  *      non-0           Timeout fired before request completion.
1282  */
1283 int
1284 mpt_wait_req(struct mpt_softc *mpt, request_t *req,
1285              mpt_req_state_t state, mpt_req_state_t mask,
1286              int sleep_ok, int time_ms)
1287 {
1288         int   error;
1289         int   timeout;
1290         u_int saved_cnt;
1291
1292         /*
1293          * timeout is in ms.  0 indicates infinite wait.
1294          * Convert to ticks or 500us units depending on
1295          * our sleep mode.
1296          */
1297         if (sleep_ok != 0) {
1298                 timeout = (time_ms * hz) / 1000;
1299         } else {
1300                 timeout = time_ms * 2;
1301         }
1302         req->state |= REQ_STATE_NEED_WAKEUP;
1303         mask &= ~REQ_STATE_NEED_WAKEUP;
1304         saved_cnt = mpt->reset_cnt;
1305         while ((req->state & mask) != state && mpt->reset_cnt == saved_cnt) {
1306                 if (sleep_ok != 0) {
1307                         error = mpt_sleep(mpt, req, PUSER, "mptreq", timeout);
1308                         if (error == EWOULDBLOCK) {
1309                                 timeout = 0;
1310                                 break;
1311                         }
1312                 } else {
1313                         if (time_ms != 0 && --timeout == 0) {
1314                                 break;
1315                         }
1316                         DELAY(500);
1317                         mpt_intr(mpt);
1318                 }
1319         }
1320         req->state &= ~REQ_STATE_NEED_WAKEUP;
1321         if (mpt->reset_cnt != saved_cnt) {
1322                 return (EIO);
1323         }
1324         if (time_ms && timeout <= 0) {
1325                 MSG_REQUEST_HEADER *msg_hdr = req->req_vbuf;
1326                 req->state |= REQ_STATE_TIMEDOUT;
1327                 mpt_prt(mpt, "mpt_wait_req(%x) timed out\n", msg_hdr->Function);
1328                 return (ETIMEDOUT);
1329         }
1330         return (0);
1331 }
1332
1333 /*
1334  * Send a command to the IOC via the handshake register.
1335  *
1336  * Only done at initialization time and for certain unusual
1337  * commands such as device/bus reset as specified by LSI.
1338  */
1339 int
1340 mpt_send_handshake_cmd(struct mpt_softc *mpt, size_t len, void *cmd)
1341 {
1342         int i;
1343         uint32_t data, *data32;
1344
1345         /* Check condition of the IOC */
1346         data = mpt_rd_db(mpt);
1347         if ((MPT_STATE(data) != MPT_DB_STATE_READY
1348           && MPT_STATE(data) != MPT_DB_STATE_RUNNING
1349           && MPT_STATE(data) != MPT_DB_STATE_FAULT)
1350          || MPT_DB_IS_IN_USE(data)) {
1351                 mpt_prt(mpt, "handshake aborted - invalid doorbell state\n");
1352                 mpt_print_db(data);
1353                 return (EBUSY);
1354         }
1355
1356         /* We move things in 32 bit chunks */
1357         len = (len + 3) >> 2;
1358         data32 = cmd;
1359
1360         /* Clear any left over pending doorbell interrupts */
1361         if (MPT_DB_INTR(mpt_rd_intr(mpt)))
1362                 mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1363
1364         /*
1365          * Tell the handshake reg. we are going to send a command
1366          * and how long it is going to be.
1367          */
1368         data = (MPI_FUNCTION_HANDSHAKE << MPI_DOORBELL_FUNCTION_SHIFT) |
1369             (len << MPI_DOORBELL_ADD_DWORDS_SHIFT);
1370         mpt_write(mpt, MPT_OFFSET_DOORBELL, data);
1371
1372         /* Wait for the chip to notice */
1373         if (mpt_wait_db_int(mpt) != MPT_OK) {
1374                 mpt_prt(mpt, "mpt_send_handshake_cmd: db ignored\n");
1375                 return (ETIMEDOUT);
1376         }
1377
1378         /* Clear the interrupt */
1379         mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1380
1381         if (mpt_wait_db_ack(mpt) != MPT_OK) {
1382                 mpt_prt(mpt, "mpt_send_handshake_cmd: db ack timed out\n");
1383                 return (ETIMEDOUT);
1384         }
1385
1386         /* Send the command */
1387         for (i = 0; i < len; i++) {
1388                 mpt_write(mpt, MPT_OFFSET_DOORBELL, htole32(*data32++));
1389                 if (mpt_wait_db_ack(mpt) != MPT_OK) {
1390                         mpt_prt(mpt,
1391                             "mpt_send_handshake_cmd: timeout @ index %d\n", i);
1392                         return (ETIMEDOUT);
1393                 }
1394         }
1395         return MPT_OK;
1396 }
1397
1398 /* Get the response from the handshake register */
1399 int
1400 mpt_recv_handshake_reply(struct mpt_softc *mpt, size_t reply_len, void *reply)
1401 {
1402         int left, reply_left;
1403         u_int16_t *data16;
1404         uint32_t data;
1405         MSG_DEFAULT_REPLY *hdr;
1406
1407         /* We move things out in 16 bit chunks */
1408         reply_len >>= 1;
1409         data16 = (u_int16_t *)reply;
1410
1411         hdr = (MSG_DEFAULT_REPLY *)reply;
1412
1413         /* Get first word */
1414         if (mpt_wait_db_int(mpt) != MPT_OK) {
1415                 mpt_prt(mpt, "mpt_recv_handshake_cmd timeout1\n");
1416                 return ETIMEDOUT;
1417         }
1418         data = mpt_read(mpt, MPT_OFFSET_DOORBELL);
1419         *data16++ = le16toh(data & MPT_DB_DATA_MASK);
1420         mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1421
1422         /* Get Second Word */
1423         if (mpt_wait_db_int(mpt) != MPT_OK) {
1424                 mpt_prt(mpt, "mpt_recv_handshake_cmd timeout2\n");
1425                 return ETIMEDOUT;
1426         }
1427         data = mpt_read(mpt, MPT_OFFSET_DOORBELL);
1428         *data16++ = le16toh(data & MPT_DB_DATA_MASK);
1429         mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1430
1431         /*
1432          * With the second word, we can now look at the length.
1433          * Warn about a reply that's too short (except for IOC FACTS REPLY)
1434          */
1435         if ((reply_len >> 1) != hdr->MsgLength &&
1436             (hdr->Function != MPI_FUNCTION_IOC_FACTS)){
1437 #if __FreeBSD_version >= 500000
1438                 mpt_prt(mpt, "reply length does not match message length: "
1439                         "got %x; expected %zx for function %x\n",
1440                         hdr->MsgLength << 2, reply_len << 1, hdr->Function);
1441 #else
1442                 mpt_prt(mpt, "reply length does not match message length: "
1443                         "got %x; expected %x for function %x\n",
1444                         hdr->MsgLength << 2, reply_len << 1, hdr->Function);
1445 #endif
1446         }
1447
1448         /* Get rest of the reply; but don't overflow the provided buffer */
1449         left = (hdr->MsgLength << 1) - 2;
1450         reply_left =  reply_len - 2;
1451         while (left--) {
1452                 u_int16_t datum;
1453
1454                 if (mpt_wait_db_int(mpt) != MPT_OK) {
1455                         mpt_prt(mpt, "mpt_recv_handshake_cmd timeout3\n");
1456                         return ETIMEDOUT;
1457                 }
1458                 data = mpt_read(mpt, MPT_OFFSET_DOORBELL);
1459                 datum = le16toh(data & MPT_DB_DATA_MASK);
1460
1461                 if (reply_left-- > 0)
1462                         *data16++ = datum;
1463
1464                 mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1465         }
1466
1467         /* One more wait & clear at the end */
1468         if (mpt_wait_db_int(mpt) != MPT_OK) {
1469                 mpt_prt(mpt, "mpt_recv_handshake_cmd timeout4\n");
1470                 return ETIMEDOUT;
1471         }
1472         mpt_write(mpt, MPT_OFFSET_INTR_STATUS, 0);
1473
1474         if ((hdr->IOCStatus & MPI_IOCSTATUS_MASK) != MPI_IOCSTATUS_SUCCESS) {
1475                 if (mpt->verbose >= MPT_PRT_TRACE)
1476                         mpt_print_reply(hdr);
1477                 return (MPT_FAIL | hdr->IOCStatus);
1478         }
1479
1480         return (0);
1481 }
1482
1483 static int
1484 mpt_get_iocfacts(struct mpt_softc *mpt, MSG_IOC_FACTS_REPLY *freplp)
1485 {
1486         MSG_IOC_FACTS f_req;
1487         int error;
1488         
1489         memset(&f_req, 0, sizeof f_req);
1490         f_req.Function = MPI_FUNCTION_IOC_FACTS;
1491         f_req.MsgContext = htole32(MPT_REPLY_HANDLER_HANDSHAKE);
1492         error = mpt_send_handshake_cmd(mpt, sizeof f_req, &f_req);
1493         if (error) {
1494                 return(error);
1495         }
1496         error = mpt_recv_handshake_reply(mpt, sizeof (*freplp), freplp);
1497         return (error);
1498 }
1499
1500 static int
1501 mpt_get_portfacts(struct mpt_softc *mpt, U8 port, MSG_PORT_FACTS_REPLY *freplp)
1502 {
1503         MSG_PORT_FACTS f_req;
1504         int error;
1505         
1506         memset(&f_req, 0, sizeof f_req);
1507         f_req.Function = MPI_FUNCTION_PORT_FACTS;
1508         f_req.PortNumber = port;
1509         f_req.MsgContext = htole32(MPT_REPLY_HANDLER_HANDSHAKE);
1510         error = mpt_send_handshake_cmd(mpt, sizeof f_req, &f_req);
1511         if (error) {
1512                 return(error);
1513         }
1514         error = mpt_recv_handshake_reply(mpt, sizeof (*freplp), freplp);
1515         return (error);
1516 }
1517
1518 /*
1519  * Send the initialization request. This is where we specify how many
1520  * SCSI busses and how many devices per bus we wish to emulate.
1521  * This is also the command that specifies the max size of the reply
1522  * frames from the IOC that we will be allocating.
1523  */
1524 static int
1525 mpt_send_ioc_init(struct mpt_softc *mpt, uint32_t who)
1526 {
1527         int error = 0;
1528         MSG_IOC_INIT init;
1529         MSG_IOC_INIT_REPLY reply;
1530
1531         memset(&init, 0, sizeof init);
1532         init.WhoInit = who;
1533         init.Function = MPI_FUNCTION_IOC_INIT;
1534         init.MaxDevices = 0;    /* at least 256 devices per bus */
1535         init.MaxBuses = 16;     /* at least 16 busses */
1536
1537         init.MsgVersion = htole16(MPI_VERSION);
1538         init.HeaderVersion = htole16(MPI_HEADER_VERSION);
1539         init.ReplyFrameSize = htole16(MPT_REPLY_SIZE);
1540         init.MsgContext = htole32(MPT_REPLY_HANDLER_HANDSHAKE);
1541
1542         if ((error = mpt_send_handshake_cmd(mpt, sizeof init, &init)) != 0) {
1543                 return(error);
1544         }
1545
1546         error = mpt_recv_handshake_reply(mpt, sizeof reply, &reply);
1547         return (error);
1548 }
1549
1550
1551 /*
1552  * Utiltity routine to read configuration headers and pages
1553  */
1554 int
1555 mpt_issue_cfg_req(struct mpt_softc *mpt, request_t *req, cfgparms_t *params,
1556                   bus_addr_t addr, bus_size_t len, int sleep_ok, int timeout_ms)
1557 {
1558         MSG_CONFIG *cfgp;
1559         SGE_SIMPLE32 *se;
1560
1561         cfgp = req->req_vbuf;
1562         memset(cfgp, 0, sizeof *cfgp);
1563         cfgp->Action = params->Action;
1564         cfgp->Function = MPI_FUNCTION_CONFIG;
1565         cfgp->Header.PageVersion = params->PageVersion;
1566         cfgp->Header.PageNumber = params->PageNumber;
1567         cfgp->PageAddress = htole32(params->PageAddress);
1568         if ((params->PageType & MPI_CONFIG_PAGETYPE_MASK) ==
1569             MPI_CONFIG_PAGETYPE_EXTENDED) {
1570                 cfgp->Header.PageType = MPI_CONFIG_PAGETYPE_EXTENDED;
1571                 cfgp->Header.PageLength = 0;
1572                 cfgp->ExtPageLength = htole16(params->ExtPageLength);
1573                 cfgp->ExtPageType = params->ExtPageType;
1574         } else {
1575                 cfgp->Header.PageType = params->PageType;
1576                 cfgp->Header.PageLength = params->PageLength;
1577         }
1578         se = (SGE_SIMPLE32 *)&cfgp->PageBufferSGE;
1579         se->Address = htole32(addr);
1580         MPI_pSGE_SET_LENGTH(se, len);
1581         MPI_pSGE_SET_FLAGS(se, (MPI_SGE_FLAGS_SIMPLE_ELEMENT |
1582             MPI_SGE_FLAGS_LAST_ELEMENT | MPI_SGE_FLAGS_END_OF_BUFFER |
1583             MPI_SGE_FLAGS_END_OF_LIST |
1584             ((params->Action == MPI_CONFIG_ACTION_PAGE_WRITE_CURRENT
1585           || params->Action == MPI_CONFIG_ACTION_PAGE_WRITE_NVRAM)
1586            ? MPI_SGE_FLAGS_HOST_TO_IOC : MPI_SGE_FLAGS_IOC_TO_HOST)));
1587         se->FlagsLength = htole32(se->FlagsLength);
1588         cfgp->MsgContext = htole32(req->index | MPT_REPLY_HANDLER_CONFIG);
1589
1590         mpt_check_doorbell(mpt);
1591         mpt_send_cmd(mpt, req);
1592         return (mpt_wait_req(mpt, req, REQ_STATE_DONE, REQ_STATE_DONE,
1593                              sleep_ok, timeout_ms));
1594 }
1595
1596 int
1597 mpt_read_extcfg_header(struct mpt_softc *mpt, int PageVersion, int PageNumber,
1598                        uint32_t PageAddress, int ExtPageType,
1599                        CONFIG_EXTENDED_PAGE_HEADER *rslt,
1600                        int sleep_ok, int timeout_ms)
1601 {
1602         request_t  *req;
1603         cfgparms_t params;
1604         MSG_CONFIG_REPLY *cfgp;
1605         int         error;
1606
1607         req = mpt_get_request(mpt, sleep_ok);
1608         if (req == NULL) {
1609                 mpt_prt(mpt, "mpt_extread_cfg_header: Get request failed!\n");
1610                 return (ENOMEM);
1611         }
1612
1613         params.Action = MPI_CONFIG_ACTION_PAGE_HEADER;
1614         params.PageVersion = PageVersion;
1615         params.PageLength = 0;
1616         params.PageNumber = PageNumber;
1617         params.PageType = MPI_CONFIG_PAGETYPE_EXTENDED;
1618         params.PageAddress = PageAddress;
1619         params.ExtPageType = ExtPageType;
1620         params.ExtPageLength = 0;
1621         error = mpt_issue_cfg_req(mpt, req, &params, /*addr*/0, /*len*/0,
1622                                   sleep_ok, timeout_ms);
1623         if (error != 0) {
1624                 /*
1625                  * Leave the request. Without resetting the chip, it's
1626                  * still owned by it and we'll just get into trouble
1627                  * freeing it now. Mark it as abandoned so that if it
1628                  * shows up later it can be freed.
1629                  */
1630                 mpt_prt(mpt, "read_extcfg_header timed out\n");
1631                 return (ETIMEDOUT);
1632         }
1633
1634         switch (req->IOCStatus & MPI_IOCSTATUS_MASK) {
1635         case MPI_IOCSTATUS_SUCCESS:
1636                 cfgp = req->req_vbuf;
1637                 rslt->PageVersion = cfgp->Header.PageVersion;
1638                 rslt->PageNumber = cfgp->Header.PageNumber;
1639                 rslt->PageType = cfgp->Header.PageType;
1640                 rslt->ExtPageLength = cfgp->ExtPageLength;
1641                 rslt->ExtPageType = cfgp->ExtPageType;
1642                 error = 0;
1643                 break;
1644         case MPI_IOCSTATUS_CONFIG_INVALID_PAGE:
1645                 mpt_lprt(mpt, MPT_PRT_DEBUG,
1646                     "Invalid Page Type %d Number %d Addr 0x%0x\n",
1647                     MPI_CONFIG_PAGETYPE_EXTENDED, PageNumber, PageAddress);
1648                 error = EINVAL;
1649                 break;
1650         default:
1651                 mpt_prt(mpt, "mpt_read_extcfg_header: Config Info Status %x\n",
1652                         req->IOCStatus);
1653                 error = EIO;
1654                 break;
1655         }
1656         mpt_free_request(mpt, req);
1657         return (error);
1658 }
1659
1660 int
1661 mpt_read_extcfg_page(struct mpt_softc *mpt, int Action, uint32_t PageAddress,
1662                      CONFIG_EXTENDED_PAGE_HEADER *hdr, void *buf, size_t len,
1663                      int sleep_ok, int timeout_ms)
1664 {
1665         request_t    *req;
1666         cfgparms_t    params;
1667         int           error;
1668
1669         req = mpt_get_request(mpt, sleep_ok);
1670         if (req == NULL) {
1671                 mpt_prt(mpt, "mpt_read_cfg_page: Get request failed!\n");
1672                 return (-1);
1673         }
1674
1675         params.Action = Action;
1676         params.PageVersion = hdr->PageVersion;
1677         params.PageLength = 0;
1678         params.PageNumber = hdr->PageNumber;
1679         params.PageType = MPI_CONFIG_PAGETYPE_EXTENDED;
1680         params.PageAddress = PageAddress;
1681         params.ExtPageType = hdr->ExtPageType;
1682         params.ExtPageLength = hdr->ExtPageLength;
1683         error = mpt_issue_cfg_req(mpt, req, &params,
1684                                   req->req_pbuf + MPT_RQSL(mpt),
1685                                   len, sleep_ok, timeout_ms);
1686         if (error != 0) {
1687                 mpt_prt(mpt, "read_extcfg_page(%d) timed out\n", Action);
1688                 return (-1);
1689         }
1690
1691         if ((req->IOCStatus & MPI_IOCSTATUS_MASK) != MPI_IOCSTATUS_SUCCESS) {
1692                 mpt_prt(mpt, "mpt_read_extcfg_page: Config Info Status %x\n",
1693                         req->IOCStatus);
1694                 mpt_free_request(mpt, req);
1695                 return (-1);
1696         }
1697         bus_dmamap_sync(mpt->request_dmat, mpt->request_dmap,
1698             BUS_DMASYNC_POSTREAD);
1699         memcpy(buf, ((uint8_t *)req->req_vbuf)+MPT_RQSL(mpt), len);
1700         mpt_free_request(mpt, req);
1701         return (0);
1702 }
1703
1704 int
1705 mpt_read_cfg_header(struct mpt_softc *mpt, int PageType, int PageNumber,
1706                     uint32_t PageAddress, CONFIG_PAGE_HEADER *rslt,
1707                     int sleep_ok, int timeout_ms)
1708 {
1709         request_t  *req;
1710         cfgparms_t params;
1711         MSG_CONFIG *cfgp;
1712         int         error;
1713
1714         req = mpt_get_request(mpt, sleep_ok);
1715         if (req == NULL) {
1716                 mpt_prt(mpt, "mpt_read_cfg_header: Get request failed!\n");
1717                 return (ENOMEM);
1718         }
1719
1720         params.Action = MPI_CONFIG_ACTION_PAGE_HEADER;
1721         params.PageVersion = 0;
1722         params.PageLength = 0;
1723         params.PageNumber = PageNumber;
1724         params.PageType = PageType;
1725         params.PageAddress = PageAddress;
1726         error = mpt_issue_cfg_req(mpt, req, &params, /*addr*/0, /*len*/0,
1727                                   sleep_ok, timeout_ms);
1728         if (error != 0) {
1729                 /*
1730                  * Leave the request. Without resetting the chip, it's
1731                  * still owned by it and we'll just get into trouble
1732                  * freeing it now. Mark it as abandoned so that if it
1733                  * shows up later it can be freed.
1734                  */
1735                 mpt_prt(mpt, "read_cfg_header timed out\n");
1736                 return (ETIMEDOUT);
1737         }
1738
1739         switch (req->IOCStatus & MPI_IOCSTATUS_MASK) {
1740         case MPI_IOCSTATUS_SUCCESS:
1741                 cfgp = req->req_vbuf;
1742                 bcopy(&cfgp->Header, rslt, sizeof(*rslt));
1743                 error = 0;
1744                 break;
1745         case MPI_IOCSTATUS_CONFIG_INVALID_PAGE:
1746                 mpt_lprt(mpt, MPT_PRT_DEBUG,
1747                     "Invalid Page Type %d Number %d Addr 0x%0x\n",
1748                     PageType, PageNumber, PageAddress);
1749                 error = EINVAL;
1750                 break;
1751         default:
1752                 mpt_prt(mpt, "mpt_read_cfg_header: Config Info Status %x\n",
1753                         req->IOCStatus);
1754                 error = EIO;
1755                 break;
1756         }
1757         mpt_free_request(mpt, req);
1758         return (error);
1759 }
1760
1761 int
1762 mpt_read_cfg_page(struct mpt_softc *mpt, int Action, uint32_t PageAddress,
1763                   CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1764                   int timeout_ms)
1765 {
1766         request_t    *req;
1767         cfgparms_t    params;
1768         int           error;
1769
1770         req = mpt_get_request(mpt, sleep_ok);
1771         if (req == NULL) {
1772                 mpt_prt(mpt, "mpt_read_cfg_page: Get request failed!\n");
1773                 return (-1);
1774         }
1775
1776         params.Action = Action;
1777         params.PageVersion = hdr->PageVersion;
1778         params.PageLength = hdr->PageLength;
1779         params.PageNumber = hdr->PageNumber;
1780         params.PageType = hdr->PageType & MPI_CONFIG_PAGETYPE_MASK;
1781         params.PageAddress = PageAddress;
1782         error = mpt_issue_cfg_req(mpt, req, &params,
1783                                   req->req_pbuf + MPT_RQSL(mpt),
1784                                   len, sleep_ok, timeout_ms);
1785         if (error != 0) {
1786                 mpt_prt(mpt, "read_cfg_page(%d) timed out\n", Action);
1787                 return (-1);
1788         }
1789
1790         if ((req->IOCStatus & MPI_IOCSTATUS_MASK) != MPI_IOCSTATUS_SUCCESS) {
1791                 mpt_prt(mpt, "mpt_read_cfg_page: Config Info Status %x\n",
1792                         req->IOCStatus);
1793                 mpt_free_request(mpt, req);
1794                 return (-1);
1795         }
1796         bus_dmamap_sync(mpt->request_dmat, mpt->request_dmap,
1797             BUS_DMASYNC_POSTREAD);
1798         memcpy(hdr, ((uint8_t *)req->req_vbuf)+MPT_RQSL(mpt), len);
1799         mpt_free_request(mpt, req);
1800         return (0);
1801 }
1802
1803 int
1804 mpt_write_cfg_page(struct mpt_softc *mpt, int Action, uint32_t PageAddress,
1805                    CONFIG_PAGE_HEADER *hdr, size_t len, int sleep_ok,
1806                    int timeout_ms)
1807 {
1808         request_t    *req;
1809         cfgparms_t    params;
1810         u_int         hdr_attr;
1811         int           error;
1812
1813         hdr_attr = hdr->PageType & MPI_CONFIG_PAGEATTR_MASK;
1814         if (hdr_attr != MPI_CONFIG_PAGEATTR_CHANGEABLE &&
1815             hdr_attr != MPI_CONFIG_PAGEATTR_PERSISTENT) {
1816                 mpt_prt(mpt, "page type 0x%x not changeable\n",
1817                         hdr->PageType & MPI_CONFIG_PAGETYPE_MASK);
1818                 return (-1);
1819         }
1820
1821 #if     0
1822         /*
1823          * We shouldn't mask off other bits here.
1824          */
1825         hdr->PageType &= MPI_CONFIG_PAGETYPE_MASK;
1826 #endif
1827
1828         req = mpt_get_request(mpt, sleep_ok);
1829         if (req == NULL)
1830                 return (-1);
1831
1832         memcpy(((caddr_t)req->req_vbuf) + MPT_RQSL(mpt), hdr, len);
1833
1834         /*
1835          * There isn't any point in restoring stripped out attributes
1836          * if you then mask them going down to issue the request.
1837          */
1838
1839         params.Action = Action;
1840         params.PageVersion = hdr->PageVersion;
1841         params.PageLength = hdr->PageLength;
1842         params.PageNumber = hdr->PageNumber;
1843         params.PageAddress = PageAddress;
1844 #if     0
1845         /* Restore stripped out attributes */
1846         hdr->PageType |= hdr_attr;
1847         params.PageType = hdr->PageType & MPI_CONFIG_PAGETYPE_MASK;
1848 #else
1849         params.PageType = hdr->PageType;
1850 #endif
1851         error = mpt_issue_cfg_req(mpt, req, &params,
1852                                   req->req_pbuf + MPT_RQSL(mpt),
1853                                   len, sleep_ok, timeout_ms);
1854         if (error != 0) {
1855                 mpt_prt(mpt, "mpt_write_cfg_page timed out\n");
1856                 return (-1);
1857         }
1858
1859         if ((req->IOCStatus & MPI_IOCSTATUS_MASK) != MPI_IOCSTATUS_SUCCESS) {
1860                 mpt_prt(mpt, "mpt_write_cfg_page: Config Info Status %x\n",
1861                         req->IOCStatus);
1862                 mpt_free_request(mpt, req);
1863                 return (-1);
1864         }
1865         mpt_free_request(mpt, req);
1866         return (0);
1867 }
1868
1869 /*
1870  * Read IOC configuration information
1871  */
1872 static int
1873 mpt_read_config_info_ioc(struct mpt_softc *mpt)
1874 {
1875         CONFIG_PAGE_HEADER hdr;
1876         struct mpt_raid_volume *mpt_raid;
1877         int rv;
1878         int i;
1879         size_t len;
1880
1881         rv = mpt_read_cfg_header(mpt, MPI_CONFIG_PAGETYPE_IOC,
1882                 2, 0, &hdr, FALSE, 5000);
1883         /*
1884          * If it's an invalid page, so what? Not a supported function....
1885          */
1886         if (rv == EINVAL) {
1887                 return (0);
1888         }
1889         if (rv) {
1890                 return (rv);
1891         }
1892
1893         mpt_lprt(mpt, MPT_PRT_DEBUG,
1894             "IOC Page 2 Header: Version %x len %x PageNumber %x PageType %x\n",
1895             hdr.PageVersion, hdr.PageLength << 2,
1896             hdr.PageNumber, hdr.PageType);
1897
1898         len = hdr.PageLength * sizeof(uint32_t);
1899         mpt->ioc_page2 = malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
1900         if (mpt->ioc_page2 == NULL) {
1901                 mpt_prt(mpt, "unable to allocate memory for IOC page 2\n");
1902                 mpt_raid_free_mem(mpt);
1903                 return (ENOMEM);
1904         }
1905         memcpy(&mpt->ioc_page2->Header, &hdr, sizeof(hdr));
1906         rv = mpt_read_cur_cfg_page(mpt, 0,
1907             &mpt->ioc_page2->Header, len, FALSE, 5000);
1908         if (rv) {
1909                 mpt_prt(mpt, "failed to read IOC Page 2\n");
1910                 mpt_raid_free_mem(mpt);
1911                 return (EIO);
1912         }
1913         mpt2host_config_page_ioc2(mpt->ioc_page2);
1914
1915         if (mpt->ioc_page2->CapabilitiesFlags != 0) {
1916                 uint32_t mask;
1917
1918                 mpt_prt(mpt, "Capabilities: (");
1919                 for (mask = 1; mask != 0; mask <<= 1) {
1920                         if ((mpt->ioc_page2->CapabilitiesFlags & mask) == 0) {
1921                                 continue;
1922                         }
1923                         switch (mask) {
1924                         case MPI_IOCPAGE2_CAP_FLAGS_IS_SUPPORT:
1925                                 mpt_prtc(mpt, " RAID-0");
1926                                 break;
1927                         case MPI_IOCPAGE2_CAP_FLAGS_IME_SUPPORT:
1928                                 mpt_prtc(mpt, " RAID-1E");
1929                                 break;
1930                         case MPI_IOCPAGE2_CAP_FLAGS_IM_SUPPORT:
1931                                 mpt_prtc(mpt, " RAID-1");
1932                                 break;
1933                         case MPI_IOCPAGE2_CAP_FLAGS_SES_SUPPORT:
1934                                 mpt_prtc(mpt, " SES");
1935                                 break;
1936                         case MPI_IOCPAGE2_CAP_FLAGS_SAFTE_SUPPORT:
1937                                 mpt_prtc(mpt, " SAFTE");
1938                                 break;
1939                         case MPI_IOCPAGE2_CAP_FLAGS_CROSS_CHANNEL_SUPPORT:
1940                                 mpt_prtc(mpt, " Multi-Channel-Arrays");
1941                         default:
1942                                 break;
1943                         }
1944                 }
1945                 mpt_prtc(mpt, " )\n");
1946                 if ((mpt->ioc_page2->CapabilitiesFlags
1947                    & (MPI_IOCPAGE2_CAP_FLAGS_IS_SUPPORT
1948                     | MPI_IOCPAGE2_CAP_FLAGS_IME_SUPPORT
1949                     | MPI_IOCPAGE2_CAP_FLAGS_IM_SUPPORT)) != 0) {
1950                         mpt_prt(mpt, "%d Active Volume%s(%d Max)\n",
1951                                 mpt->ioc_page2->NumActiveVolumes,
1952                                 mpt->ioc_page2->NumActiveVolumes != 1
1953                               ? "s " : " ",
1954                                 mpt->ioc_page2->MaxVolumes);
1955                         mpt_prt(mpt, "%d Hidden Drive Member%s(%d Max)\n",
1956                                 mpt->ioc_page2->NumActivePhysDisks,
1957                                 mpt->ioc_page2->NumActivePhysDisks != 1
1958                               ? "s " : " ",
1959                                 mpt->ioc_page2->MaxPhysDisks);
1960                 }
1961         }
1962
1963         len = mpt->ioc_page2->MaxVolumes * sizeof(struct mpt_raid_volume);
1964         mpt->raid_volumes = malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
1965         if (mpt->raid_volumes == NULL) {
1966                 mpt_prt(mpt, "Could not allocate RAID volume data\n");
1967                 mpt_raid_free_mem(mpt);
1968                 return (ENOMEM);
1969         }
1970
1971         /*
1972          * Copy critical data out of ioc_page2 so that we can
1973          * safely refresh the page without windows of unreliable
1974          * data.
1975          */
1976         mpt->raid_max_volumes =  mpt->ioc_page2->MaxVolumes;
1977
1978         len = sizeof(*mpt->raid_volumes->config_page) +
1979             (sizeof (RAID_VOL0_PHYS_DISK) * (mpt->ioc_page2->MaxPhysDisks - 1));
1980         for (i = 0; i < mpt->ioc_page2->MaxVolumes; i++) {
1981                 mpt_raid = &mpt->raid_volumes[i];
1982                 mpt_raid->config_page =
1983                     malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
1984                 if (mpt_raid->config_page == NULL) {
1985                         mpt_prt(mpt, "Could not allocate RAID page data\n");
1986                         mpt_raid_free_mem(mpt);
1987                         return (ENOMEM);
1988                 }
1989         }
1990         mpt->raid_page0_len = len;
1991
1992         len = mpt->ioc_page2->MaxPhysDisks * sizeof(struct mpt_raid_disk);
1993         mpt->raid_disks = malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
1994         if (mpt->raid_disks == NULL) {
1995                 mpt_prt(mpt, "Could not allocate RAID disk data\n");
1996                 mpt_raid_free_mem(mpt);
1997                 return (ENOMEM);
1998         }
1999         mpt->raid_max_disks =  mpt->ioc_page2->MaxPhysDisks;
2000
2001         /*
2002          * Load page 3.
2003          */
2004         rv = mpt_read_cfg_header(mpt, MPI_CONFIG_PAGETYPE_IOC,
2005             3, 0, &hdr, FALSE, 5000);
2006         if (rv) {
2007                 mpt_raid_free_mem(mpt);
2008                 return (EIO);
2009         }
2010
2011         mpt_lprt(mpt, MPT_PRT_DEBUG, "IOC Page 3 Header: %x %x %x %x\n",
2012             hdr.PageVersion, hdr.PageLength, hdr.PageNumber, hdr.PageType);
2013
2014         len = hdr.PageLength * sizeof(uint32_t);
2015         mpt->ioc_page3 = malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
2016         if (mpt->ioc_page3 == NULL) {
2017                 mpt_prt(mpt, "unable to allocate memory for IOC page 3\n");
2018                 mpt_raid_free_mem(mpt);
2019                 return (ENOMEM);
2020         }
2021         memcpy(&mpt->ioc_page3->Header, &hdr, sizeof(hdr));
2022         rv = mpt_read_cur_cfg_page(mpt, 0,
2023             &mpt->ioc_page3->Header, len, FALSE, 5000);
2024         if (rv) {
2025                 mpt_raid_free_mem(mpt);
2026                 return (EIO);
2027         }
2028         mpt_raid_wakeup(mpt);
2029         return (0);
2030 }
2031
2032 /*
2033  * Enable IOC port
2034  */
2035 static int
2036 mpt_send_port_enable(struct mpt_softc *mpt, int port)
2037 {
2038         request_t       *req;
2039         MSG_PORT_ENABLE *enable_req;
2040         int              error;
2041
2042         req = mpt_get_request(mpt, /*sleep_ok*/FALSE);
2043         if (req == NULL)
2044                 return (-1);
2045
2046         enable_req = req->req_vbuf;
2047         memset(enable_req, 0,  MPT_RQSL(mpt));
2048
2049         enable_req->Function   = MPI_FUNCTION_PORT_ENABLE;
2050         enable_req->MsgContext = htole32(req->index | MPT_REPLY_HANDLER_CONFIG);
2051         enable_req->PortNumber = port;
2052
2053         mpt_check_doorbell(mpt);
2054         mpt_lprt(mpt, MPT_PRT_DEBUG, "enabling port %d\n", port);
2055
2056         mpt_send_cmd(mpt, req);
2057         error = mpt_wait_req(mpt, req, REQ_STATE_DONE, REQ_STATE_DONE,
2058             FALSE, (mpt->is_sas || mpt->is_fc)? 30000 : 3000);
2059         if (error != 0) {
2060                 mpt_prt(mpt, "port %d enable timed out\n", port);
2061                 return (-1);
2062         }
2063         mpt_free_request(mpt, req);
2064         mpt_lprt(mpt, MPT_PRT_DEBUG, "enabled port %d\n", port);
2065         return (0);
2066 }
2067
2068 /*
2069  * Enable/Disable asynchronous event reporting.
2070  */
2071 static int
2072 mpt_send_event_request(struct mpt_softc *mpt, int onoff)
2073 {
2074         request_t *req;
2075         MSG_EVENT_NOTIFY *enable_req;
2076
2077         req = mpt_get_request(mpt, FALSE);
2078         if (req == NULL) {
2079                 return (ENOMEM);
2080         }
2081         enable_req = req->req_vbuf;
2082         memset(enable_req, 0, sizeof *enable_req);
2083
2084         enable_req->Function   = MPI_FUNCTION_EVENT_NOTIFICATION;
2085         enable_req->MsgContext = htole32(req->index | MPT_REPLY_HANDLER_EVENTS);
2086         enable_req->Switch     = onoff;
2087
2088         mpt_check_doorbell(mpt);
2089         mpt_lprt(mpt, MPT_PRT_DEBUG, "%sabling async events\n",
2090             onoff ? "en" : "dis");
2091         /*
2092          * Send the command off, but don't wait for it.
2093          */
2094         mpt_send_cmd(mpt, req);
2095         return (0);
2096 }
2097
2098 /*
2099  * Un-mask the interrupts on the chip.
2100  */
2101 void
2102 mpt_enable_ints(struct mpt_softc *mpt)
2103 {
2104         /* Unmask every thing except door bell int */
2105         mpt_write(mpt, MPT_OFFSET_INTR_MASK, MPT_INTR_DB_MASK);
2106 }
2107
2108 /*
2109  * Mask the interrupts on the chip.
2110  */
2111 void
2112 mpt_disable_ints(struct mpt_softc *mpt)
2113 {
2114         /* Mask all interrupts */
2115         mpt_write(mpt, MPT_OFFSET_INTR_MASK,
2116             MPT_INTR_REPLY_MASK | MPT_INTR_DB_MASK);
2117 }
2118
2119 static void
2120 mpt_sysctl_attach(struct mpt_softc *mpt)
2121 {
2122 #if __FreeBSD_version >= 500000
2123         struct sysctl_ctx_list *ctx = device_get_sysctl_ctx(mpt->dev);
2124         struct sysctl_oid *tree = device_get_sysctl_tree(mpt->dev);
2125
2126         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
2127                        "debug", CTLFLAG_RW, &mpt->verbose, 0,
2128                        "Debugging/Verbose level");
2129         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
2130                        "role", CTLFLAG_RD, &mpt->role, 0,
2131                        "HBA role");
2132 #ifdef  MPT_TEST_MULTIPATH
2133         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
2134                        "failure_id", CTLFLAG_RW, &mpt->failure_id, -1,
2135                        "Next Target to Fail");
2136 #endif
2137 #endif
2138 }
2139
2140 int
2141 mpt_attach(struct mpt_softc *mpt)
2142 {
2143         struct mpt_personality *pers;
2144         int i;
2145         int error;
2146
2147         TAILQ_INSERT_TAIL(&mpt_tailq, mpt, links);
2148         for (i = 0; i < MPT_MAX_PERSONALITIES; i++) {
2149                 pers = mpt_personalities[i];
2150                 if (pers == NULL) {
2151                         continue;
2152                 }
2153                 if (pers->probe(mpt) == 0) {
2154                         error = pers->attach(mpt);
2155                         if (error != 0) {
2156                                 mpt_detach(mpt);
2157                                 return (error);
2158                         }
2159                         mpt->mpt_pers_mask |= (0x1 << pers->id);
2160                         pers->use_count++;
2161                 }
2162         }
2163
2164         /*
2165          * Now that we've attached everything, do the enable function
2166          * for all of the personalities. This allows the personalities
2167          * to do setups that are appropriate for them prior to enabling
2168          * any ports.
2169          */
2170         for (i = 0; i < MPT_MAX_PERSONALITIES; i++) {
2171                 pers = mpt_personalities[i];
2172                 if (pers != NULL  && MPT_PERS_ATTACHED(pers, mpt) != 0) {
2173                         error = pers->enable(mpt);
2174                         if (error != 0) {
2175                                 mpt_prt(mpt, "personality %s attached but would"
2176                                     " not enable (%d)\n", pers->name, error);
2177                                 mpt_detach(mpt);
2178                                 return (error);
2179                         }
2180                 }
2181         }
2182         return (0);
2183 }
2184
2185 int
2186 mpt_shutdown(struct mpt_softc *mpt)
2187 {
2188         struct mpt_personality *pers;
2189
2190         MPT_PERS_FOREACH_REVERSE(mpt, pers) {
2191                 pers->shutdown(mpt);
2192         }
2193         return (0);
2194 }
2195
2196 int
2197 mpt_detach(struct mpt_softc *mpt)
2198 {
2199         struct mpt_personality *pers;
2200
2201         MPT_PERS_FOREACH_REVERSE(mpt, pers) {
2202                 pers->detach(mpt);
2203                 mpt->mpt_pers_mask &= ~(0x1 << pers->id);
2204                 pers->use_count--;
2205         }
2206         TAILQ_REMOVE(&mpt_tailq, mpt, links);
2207         return (0);
2208 }
2209
2210 int
2211 mpt_core_load(struct mpt_personality *pers)
2212 {
2213         int i;
2214
2215         /*
2216          * Setup core handlers and insert the default handler
2217          * into all "empty slots".
2218          */
2219         for (i = 0; i < MPT_NUM_REPLY_HANDLERS; i++) {
2220                 mpt_reply_handlers[i] = mpt_default_reply_handler;
2221         }
2222
2223         mpt_reply_handlers[MPT_CBI(MPT_REPLY_HANDLER_EVENTS)] =
2224             mpt_event_reply_handler;
2225         mpt_reply_handlers[MPT_CBI(MPT_REPLY_HANDLER_CONFIG)] =
2226             mpt_config_reply_handler;
2227         mpt_reply_handlers[MPT_CBI(MPT_REPLY_HANDLER_HANDSHAKE)] =
2228             mpt_handshake_reply_handler;
2229         return (0);
2230 }
2231
2232 /*
2233  * Initialize per-instance driver data and perform
2234  * initial controller configuration.
2235  */
2236 int
2237 mpt_core_attach(struct mpt_softc *mpt)
2238 {
2239         int val, error;
2240
2241         LIST_INIT(&mpt->ack_frames);
2242         /* Put all request buffers on the free list */
2243         TAILQ_INIT(&mpt->request_pending_list);
2244         TAILQ_INIT(&mpt->request_free_list);
2245         TAILQ_INIT(&mpt->request_timeout_list);
2246         MPT_LOCK(mpt);
2247         for (val = 0; val < MPT_MAX_REQUESTS(mpt); val++) {
2248                 request_t *req = &mpt->request_pool[val];
2249                 req->state = REQ_STATE_ALLOCATED;
2250                 mpt_free_request(mpt, req);
2251         }
2252         MPT_UNLOCK(mpt);
2253         for (val = 0; val < MPT_MAX_LUNS; val++) {
2254                 STAILQ_INIT(&mpt->trt[val].atios);
2255                 STAILQ_INIT(&mpt->trt[val].inots);
2256         }
2257         STAILQ_INIT(&mpt->trt_wildcard.atios);
2258         STAILQ_INIT(&mpt->trt_wildcard.inots);
2259 #ifdef  MPT_TEST_MULTIPATH
2260         mpt->failure_id = -1;
2261 #endif
2262         mpt->scsi_tgt_handler_id = MPT_HANDLER_ID_NONE;
2263         mpt_sysctl_attach(mpt);
2264         mpt_lprt(mpt, MPT_PRT_DEBUG, "doorbell req = %s\n",
2265             mpt_ioc_diag(mpt_read(mpt, MPT_OFFSET_DOORBELL)));
2266
2267         MPT_LOCK(mpt);
2268         error = mpt_configure_ioc(mpt, 0, 0);
2269         MPT_UNLOCK(mpt);
2270
2271         return (error);
2272 }
2273
2274 int
2275 mpt_core_enable(struct mpt_softc *mpt)
2276 {
2277         /*
2278          * We enter with the IOC enabled, but async events
2279          * not enabled, ports not enabled and interrupts
2280          * not enabled.
2281          */
2282         MPT_LOCK(mpt);
2283
2284         /*
2285          * Enable asynchronous event reporting- all personalities
2286          * have attached so that they should be able to now field
2287          * async events.
2288          */
2289         mpt_send_event_request(mpt, 1);
2290
2291         /*
2292          * Catch any pending interrupts
2293          *
2294          * This seems to be crucial- otherwise
2295          * the portenable below times out.
2296          */
2297         mpt_intr(mpt);
2298
2299         /*
2300          * Enable Interrupts
2301          */
2302         mpt_enable_ints(mpt);
2303
2304         /*
2305          * Catch any pending interrupts
2306          *
2307          * This seems to be crucial- otherwise
2308          * the portenable below times out.
2309          */
2310         mpt_intr(mpt);
2311
2312         /*
2313          * Enable the port.
2314          */
2315         if (mpt_send_port_enable(mpt, 0) != MPT_OK) {
2316                 mpt_prt(mpt, "failed to enable port 0\n");
2317                 MPT_UNLOCK(mpt);
2318                 return (ENXIO);
2319         }
2320         MPT_UNLOCK(mpt);
2321         return (0);
2322 }
2323
2324 void
2325 mpt_core_shutdown(struct mpt_softc *mpt)
2326 {
2327         mpt_disable_ints(mpt);
2328 }
2329
2330 void
2331 mpt_core_detach(struct mpt_softc *mpt)
2332 {
2333         /*
2334          * XXX: FREE MEMORY 
2335          */
2336         mpt_disable_ints(mpt);
2337 }
2338
2339 int
2340 mpt_core_unload(struct mpt_personality *pers)
2341 {
2342         /* Unload is always successfull. */
2343         return (0);
2344 }
2345
2346 #define FW_UPLOAD_REQ_SIZE                              \
2347         (sizeof(MSG_FW_UPLOAD) - sizeof(SGE_MPI_UNION)  \
2348        + sizeof(FW_UPLOAD_TCSGE) + sizeof(SGE_SIMPLE32))
2349
2350 static int
2351 mpt_upload_fw(struct mpt_softc *mpt)
2352 {
2353         uint8_t fw_req_buf[FW_UPLOAD_REQ_SIZE];
2354         MSG_FW_UPLOAD_REPLY fw_reply;
2355         MSG_FW_UPLOAD *fw_req;
2356         FW_UPLOAD_TCSGE *tsge;
2357         SGE_SIMPLE32 *sge;
2358         uint32_t flags;
2359         int error;
2360         
2361         memset(&fw_req_buf, 0, sizeof(fw_req_buf));
2362         fw_req = (MSG_FW_UPLOAD *)fw_req_buf;
2363         fw_req->ImageType = MPI_FW_UPLOAD_ITYPE_FW_IOC_MEM;
2364         fw_req->Function = MPI_FUNCTION_FW_UPLOAD;
2365         fw_req->MsgContext = htole32(MPT_REPLY_HANDLER_HANDSHAKE);
2366         tsge = (FW_UPLOAD_TCSGE *)&fw_req->SGL;
2367         tsge->DetailsLength = 12;
2368         tsge->Flags = MPI_SGE_FLAGS_TRANSACTION_ELEMENT;
2369         tsge->ImageSize = htole32(mpt->fw_image_size);
2370         sge = (SGE_SIMPLE32 *)(tsge + 1);
2371         flags = (MPI_SGE_FLAGS_LAST_ELEMENT | MPI_SGE_FLAGS_END_OF_BUFFER
2372               | MPI_SGE_FLAGS_END_OF_LIST | MPI_SGE_FLAGS_SIMPLE_ELEMENT
2373               | MPI_SGE_FLAGS_32_BIT_ADDRESSING | MPI_SGE_FLAGS_IOC_TO_HOST);
2374         flags <<= MPI_SGE_FLAGS_SHIFT;
2375         sge->FlagsLength = htole32(flags | mpt->fw_image_size);
2376         sge->Address = htole32(mpt->fw_phys);
2377         error = mpt_send_handshake_cmd(mpt, sizeof(fw_req_buf), &fw_req_buf);
2378         if (error)
2379                 return(error);
2380         error = mpt_recv_handshake_reply(mpt, sizeof(fw_reply), &fw_reply);
2381         return (error);
2382 }
2383
2384 static void
2385 mpt_diag_outsl(struct mpt_softc *mpt, uint32_t addr,
2386                uint32_t *data, bus_size_t len)
2387 {
2388         uint32_t *data_end;
2389
2390         data_end = data + (roundup2(len, sizeof(uint32_t)) / 4);
2391         if (mpt->is_sas) {
2392                 pci_enable_io(mpt->dev, SYS_RES_IOPORT);
2393         }
2394         mpt_pio_write(mpt, MPT_OFFSET_DIAG_ADDR, addr);
2395         while (data != data_end) {
2396                 mpt_pio_write(mpt, MPT_OFFSET_DIAG_DATA, *data);
2397                 data++;
2398         }
2399         if (mpt->is_sas) {
2400                 pci_disable_io(mpt->dev, SYS_RES_IOPORT);
2401         }
2402 }
2403
2404 static int
2405 mpt_download_fw(struct mpt_softc *mpt)
2406 {
2407         MpiFwHeader_t *fw_hdr;
2408         int error;
2409         uint32_t ext_offset;
2410         uint32_t data;
2411
2412         mpt_prt(mpt, "Downloading Firmware - Image Size %d\n",
2413                 mpt->fw_image_size);
2414
2415         error = mpt_enable_diag_mode(mpt);
2416         if (error != 0) {
2417                 mpt_prt(mpt, "Could not enter diagnostic mode!\n");
2418                 return (EIO);
2419         }
2420
2421         mpt_write(mpt, MPT_OFFSET_DIAGNOSTIC,
2422                   MPI_DIAG_RW_ENABLE|MPI_DIAG_DISABLE_ARM);
2423
2424         fw_hdr = (MpiFwHeader_t *)mpt->fw_image;
2425         mpt_diag_outsl(mpt, fw_hdr->LoadStartAddress, (uint32_t*)fw_hdr,
2426                        fw_hdr->ImageSize);
2427
2428         ext_offset = fw_hdr->NextImageHeaderOffset;
2429         while (ext_offset != 0) {
2430                 MpiExtImageHeader_t *ext;
2431
2432                 ext = (MpiExtImageHeader_t *)((uintptr_t)fw_hdr + ext_offset);
2433                 ext_offset = ext->NextImageHeaderOffset;
2434
2435                 mpt_diag_outsl(mpt, ext->LoadStartAddress, (uint32_t*)ext,
2436                                ext->ImageSize);
2437         }
2438
2439         if (mpt->is_sas) {
2440                 pci_enable_io(mpt->dev, SYS_RES_IOPORT);
2441         }
2442         /* Setup the address to jump to on reset. */
2443         mpt_pio_write(mpt, MPT_OFFSET_DIAG_ADDR, fw_hdr->IopResetRegAddr);
2444         mpt_pio_write(mpt, MPT_OFFSET_DIAG_DATA, fw_hdr->IopResetVectorValue);
2445
2446         /*
2447          * The controller sets the "flash bad" status after attempting
2448          * to auto-boot from flash.  Clear the status so that the controller
2449          * will continue the boot process with our newly installed firmware.
2450          */
2451         mpt_pio_write(mpt, MPT_OFFSET_DIAG_ADDR, MPT_DIAG_MEM_CFG_BASE);
2452         data = mpt_pio_read(mpt, MPT_OFFSET_DIAG_DATA) | MPT_DIAG_MEM_CFG_BADFL;
2453         mpt_pio_write(mpt, MPT_OFFSET_DIAG_ADDR, MPT_DIAG_MEM_CFG_BASE);
2454         mpt_pio_write(mpt, MPT_OFFSET_DIAG_DATA, data);
2455
2456         if (mpt->is_sas) {
2457                 pci_disable_io(mpt->dev, SYS_RES_IOPORT);
2458         }
2459
2460         /*
2461          * Re-enable the processor and clear the boot halt flag.
2462          */
2463         data = mpt_read(mpt, MPT_OFFSET_DIAGNOSTIC);
2464         data &= ~(MPI_DIAG_PREVENT_IOC_BOOT|MPI_DIAG_DISABLE_ARM);
2465         mpt_write(mpt, MPT_OFFSET_DIAGNOSTIC, data);
2466
2467         mpt_disable_diag_mode(mpt);
2468         return (0);
2469 }
2470
2471 /*
2472  * Allocate/Initialize data structures for the controller.  Called
2473  * once at instance startup.
2474  */
2475 static int
2476 mpt_configure_ioc(struct mpt_softc *mpt, int tn, int needreset)
2477 {
2478         PTR_MSG_PORT_FACTS_REPLY pfp;
2479         int error,  port;
2480         size_t len;
2481
2482         if (tn == MPT_MAX_TRYS) {
2483                 return (-1);
2484         }
2485
2486         /*
2487          * No need to reset if the IOC is already in the READY state.
2488          *
2489          * Force reset if initialization failed previously.
2490          * Note that a hard_reset of the second channel of a '929
2491          * will stop operation of the first channel.  Hopefully, if the
2492          * first channel is ok, the second will not require a hard
2493          * reset.
2494          */
2495         if (needreset || MPT_STATE(mpt_rd_db(mpt)) != MPT_DB_STATE_READY) {
2496                 if (mpt_reset(mpt, FALSE) != MPT_OK) {
2497                         return (mpt_configure_ioc(mpt, tn++, 1));
2498                 }
2499                 needreset = 0;
2500         }
2501
2502         if (mpt_get_iocfacts(mpt, &mpt->ioc_facts) != MPT_OK) {
2503                 mpt_prt(mpt, "mpt_get_iocfacts failed\n");
2504                 return (mpt_configure_ioc(mpt, tn++, 1));
2505         }
2506         mpt2host_iocfacts_reply(&mpt->ioc_facts);
2507
2508         mpt_prt(mpt, "MPI Version=%d.%d.%d.%d\n",
2509             mpt->ioc_facts.MsgVersion >> 8,
2510             mpt->ioc_facts.MsgVersion & 0xFF,
2511             mpt->ioc_facts.HeaderVersion >> 8,
2512             mpt->ioc_facts.HeaderVersion & 0xFF);
2513
2514         /*
2515          * Now that we know request frame size, we can calculate
2516          * the actual (reasonable) segment limit for read/write I/O.
2517          *
2518          * This limit is constrained by:
2519          *
2520          *  + The size of each area we allocate per command (and how
2521          *    many chain segments we can fit into it).
2522          *  + The total number of areas we've set up.
2523          *  + The actual chain depth the card will allow.
2524          *
2525          * The first area's segment count is limited by the I/O request
2526          * at the head of it. We cannot allocate realistically more
2527          * than MPT_MAX_REQUESTS areas. Therefore, to account for both
2528          * conditions, we'll just start out with MPT_MAX_REQUESTS-2.
2529          *
2530          */
2531         /* total number of request areas we (can) allocate */
2532         mpt->max_seg_cnt = MPT_MAX_REQUESTS(mpt) - 2;
2533
2534         /* converted to the number of chain areas possible */
2535         mpt->max_seg_cnt *= MPT_NRFM(mpt);
2536
2537         /* limited by the number of chain areas the card will support */
2538         if (mpt->max_seg_cnt > mpt->ioc_facts.MaxChainDepth) {
2539                 mpt_lprt(mpt, MPT_PRT_DEBUG,
2540                     "chain depth limited to %u (from %u)\n",
2541                     mpt->ioc_facts.MaxChainDepth, mpt->max_seg_cnt);
2542                 mpt->max_seg_cnt = mpt->ioc_facts.MaxChainDepth;
2543         }
2544
2545         /* converted to the number of simple sges in chain segments. */
2546         mpt->max_seg_cnt *= (MPT_NSGL(mpt) - 1);
2547
2548         mpt_lprt(mpt, MPT_PRT_DEBUG, "Maximum Segment Count: %u\n",
2549             mpt->max_seg_cnt);
2550         mpt_lprt(mpt, MPT_PRT_DEBUG, "MsgLength=%u IOCNumber = %d\n",
2551             mpt->ioc_facts.MsgLength, mpt->ioc_facts.IOCNumber);
2552         mpt_lprt(mpt, MPT_PRT_DEBUG,
2553             "IOCFACTS: GlobalCredits=%d BlockSize=%u bytes "
2554             "Request Frame Size %u bytes Max Chain Depth %u\n",
2555             mpt->ioc_facts.GlobalCredits, mpt->ioc_facts.BlockSize,
2556             mpt->ioc_facts.RequestFrameSize << 2,
2557             mpt->ioc_facts.MaxChainDepth);
2558         mpt_lprt(mpt, MPT_PRT_DEBUG, "IOCFACTS: Num Ports %d, FWImageSize %d, "
2559             "Flags=%#x\n", mpt->ioc_facts.NumberOfPorts,
2560             mpt->ioc_facts.FWImageSize, mpt->ioc_facts.Flags);
2561
2562         len = mpt->ioc_facts.NumberOfPorts * sizeof (MSG_PORT_FACTS_REPLY);
2563         mpt->port_facts = malloc(len, M_DEVBUF, M_NOWAIT | M_ZERO);
2564         if (mpt->port_facts == NULL) {
2565                 mpt_prt(mpt, "unable to allocate memory for port facts\n");
2566                 return (ENOMEM);
2567         }
2568
2569
2570         if ((mpt->ioc_facts.Flags & MPI_IOCFACTS_FLAGS_FW_DOWNLOAD_BOOT) &&
2571             (mpt->fw_uploaded == 0)) {
2572                 struct mpt_map_info mi;
2573
2574                 /*
2575                  * In some configurations, the IOC's firmware is
2576                  * stored in a shared piece of system NVRAM that
2577                  * is only accessable via the BIOS.  In this
2578                  * case, the firmware keeps a copy of firmware in
2579                  * RAM until the OS driver retrieves it.  Once
2580                  * retrieved, we are responsible for re-downloading
2581                  * the firmware after any hard-reset.
2582                  */
2583                 mpt->fw_image_size = mpt->ioc_facts.FWImageSize;
2584                 error = mpt_dma_tag_create(mpt, mpt->parent_dmat, 1, 0,
2585                     BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
2586                     mpt->fw_image_size, 1, mpt->fw_image_size, 0,
2587                     &mpt->fw_dmat);
2588                 if (error != 0) {
2589                         mpt_prt(mpt, "cannot create firmwarew dma tag\n");
2590                         return (ENOMEM);
2591                 }
2592                 error = bus_dmamem_alloc(mpt->fw_dmat,
2593                     (void **)&mpt->fw_image, BUS_DMA_NOWAIT, &mpt->fw_dmap);
2594                 if (error != 0) {
2595                         mpt_prt(mpt, "cannot allocate firmware memory\n");
2596                         bus_dma_tag_destroy(mpt->fw_dmat);
2597                         return (ENOMEM);
2598                 }
2599                 mi.mpt = mpt;
2600                 mi.error = 0;
2601                 bus_dmamap_load(mpt->fw_dmat, mpt->fw_dmap,
2602                     mpt->fw_image, mpt->fw_image_size, mpt_map_rquest, &mi, 0);
2603                 mpt->fw_phys = mi.phys;
2604
2605                 error = mpt_upload_fw(mpt);
2606                 if (error != 0) {
2607                         mpt_prt(mpt, "firmware upload failed.\n");
2608                         bus_dmamap_unload(mpt->fw_dmat, mpt->fw_dmap);
2609                         bus_dmamem_free(mpt->fw_dmat, mpt->fw_image,
2610                             mpt->fw_dmap);
2611                         bus_dma_tag_destroy(mpt->fw_dmat);
2612                         mpt->fw_image = NULL;
2613                         return (EIO);
2614                 }
2615                 mpt->fw_uploaded = 1;
2616         }
2617
2618         for (port = 0; port < mpt->ioc_facts.NumberOfPorts; port++) {
2619                 pfp = &mpt->port_facts[port];
2620                 error = mpt_get_portfacts(mpt, 0, pfp);
2621                 if (error != MPT_OK) {
2622                         mpt_prt(mpt,
2623                             "mpt_get_portfacts on port %d failed\n", port);
2624                         free(mpt->port_facts, M_DEVBUF);
2625                         mpt->port_facts = NULL;
2626                         return (mpt_configure_ioc(mpt, tn++, 1));
2627                 }
2628                 mpt2host_portfacts_reply(pfp);
2629
2630                 if (port > 0) {
2631                         error = MPT_PRT_INFO;
2632                 } else {
2633                         error = MPT_PRT_DEBUG;
2634                 }
2635                 mpt_lprt(mpt, error,
2636                     "PORTFACTS[%d]: Type %x PFlags %x IID %d MaxDev %d\n",
2637                     port, pfp->PortType, pfp->ProtocolFlags, pfp->PortSCSIID,
2638                     pfp->MaxDevices);
2639
2640         }
2641
2642         /*
2643          * XXX: Not yet supporting more than port 0
2644          */
2645         pfp = &mpt->port_facts[0];
2646         if (pfp->PortType == MPI_PORTFACTS_PORTTYPE_FC) {
2647                 mpt->is_fc = 1;
2648                 mpt->is_sas = 0;
2649                 mpt->is_spi = 0;
2650         } else if (pfp->PortType == MPI_PORTFACTS_PORTTYPE_SAS) {
2651                 mpt->is_fc = 0;
2652                 mpt->is_sas = 1;
2653                 mpt->is_spi = 0;
2654         } else if (pfp->PortType == MPI_PORTFACTS_PORTTYPE_SCSI) {
2655                 mpt->is_fc = 0;
2656                 mpt->is_sas = 0;
2657                 mpt->is_spi = 1;
2658         } else if (pfp->PortType == MPI_PORTFACTS_PORTTYPE_ISCSI) {
2659                 mpt_prt(mpt, "iSCSI not supported yet\n");
2660                 return (ENXIO);
2661         } else if (pfp->PortType == MPI_PORTFACTS_PORTTYPE_INACTIVE) {
2662                 mpt_prt(mpt, "Inactive Port\n");
2663                 return (ENXIO);
2664         } else {
2665                 mpt_prt(mpt, "unknown Port Type %#x\n", pfp->PortType);
2666                 return (ENXIO);
2667         }
2668
2669         /*
2670          * Set our role with what this port supports.
2671          *
2672          * Note this might be changed later in different modules
2673          * if this is different from what is wanted.
2674          */
2675         mpt->role = MPT_ROLE_NONE;
2676         if (pfp->ProtocolFlags & MPI_PORTFACTS_PROTOCOL_INITIATOR) {
2677                 mpt->role |= MPT_ROLE_INITIATOR;
2678         }
2679         if (pfp->ProtocolFlags & MPI_PORTFACTS_PROTOCOL_TARGET) {
2680                 mpt->role |= MPT_ROLE_TARGET;
2681         }
2682
2683         /*
2684          * Enable the IOC
2685          */
2686         if (mpt_enable_ioc(mpt, 0) != MPT_OK) {
2687                 mpt_prt(mpt, "unable to initialize IOC\n");
2688                 return (ENXIO);
2689         }
2690
2691         /*
2692          * Read IOC configuration information.
2693          *
2694          * We need this to determine whether or not we have certain
2695          * settings for Integrated Mirroring (e.g.).
2696          */
2697         mpt_read_config_info_ioc(mpt);
2698
2699         return (0);
2700 }
2701
2702 static int
2703 mpt_enable_ioc(struct mpt_softc *mpt, int portenable)
2704 {
2705         uint32_t pptr;
2706         int val;
2707
2708         if (mpt_send_ioc_init(mpt, MPI_WHOINIT_HOST_DRIVER) != MPT_OK) {
2709                 mpt_prt(mpt, "mpt_send_ioc_init failed\n");
2710                 return (EIO);
2711         }
2712
2713         mpt_lprt(mpt, MPT_PRT_DEBUG, "mpt_send_ioc_init ok\n");
2714
2715         if (mpt_wait_state(mpt, MPT_DB_STATE_RUNNING) != MPT_OK) {
2716                 mpt_prt(mpt, "IOC failed to go to run state\n");
2717                 return (ENXIO);
2718         }
2719         mpt_lprt(mpt, MPT_PRT_DEBUG, "IOC now at RUNSTATE\n");
2720
2721         /*
2722          * Give it reply buffers
2723          *
2724          * Do *not* exceed global credits.
2725          */
2726         for (val = 0, pptr = mpt->reply_phys;
2727             (pptr + MPT_REPLY_SIZE) < (mpt->reply_phys + PAGE_SIZE);
2728              pptr += MPT_REPLY_SIZE) {
2729                 mpt_free_reply(mpt, pptr);
2730                 if (++val == mpt->ioc_facts.GlobalCredits - 1)
2731                         break;
2732         }
2733
2734
2735         /*
2736          * Enable the port if asked. This is only done if we're resetting
2737          * the IOC after initial startup.
2738          */
2739         if (portenable) {
2740                 /*
2741                  * Enable asynchronous event reporting
2742                  */
2743                 mpt_send_event_request(mpt, 1);
2744
2745                 if (mpt_send_port_enable(mpt, 0) != MPT_OK) {
2746                         mpt_prt(mpt, "failed to enable port 0\n");
2747                         return (ENXIO);
2748                 }
2749         }
2750         return (MPT_OK);
2751 }
2752
2753 /*
2754  * Endian Conversion Functions- only used on Big Endian machines
2755  */
2756 #if     _BYTE_ORDER == _BIG_ENDIAN
2757 void
2758 mpt2host_sge_simple_union(SGE_SIMPLE_UNION *sge)
2759 {
2760         MPT_2_HOST32(sge, FlagsLength);
2761         MPT_2_HOST32(sge, u.Address64.Low);
2762         MPT_2_HOST32(sge, u.Address64.High);
2763 }
2764
2765 void
2766 mpt2host_iocfacts_reply(MSG_IOC_FACTS_REPLY *rp)
2767 {
2768         MPT_2_HOST16(rp, MsgVersion);
2769         MPT_2_HOST16(rp, HeaderVersion);
2770         MPT_2_HOST32(rp, MsgContext);
2771         MPT_2_HOST16(rp, IOCExceptions);
2772         MPT_2_HOST16(rp, IOCStatus);
2773         MPT_2_HOST32(rp, IOCLogInfo);
2774         MPT_2_HOST16(rp, ReplyQueueDepth);
2775         MPT_2_HOST16(rp, RequestFrameSize);
2776         MPT_2_HOST16(rp, Reserved_0101_FWVersion);
2777         MPT_2_HOST16(rp, ProductID);
2778         MPT_2_HOST32(rp, CurrentHostMfaHighAddr);
2779         MPT_2_HOST16(rp, GlobalCredits);
2780         MPT_2_HOST32(rp, CurrentSenseBufferHighAddr);
2781         MPT_2_HOST16(rp, CurReplyFrameSize);
2782         MPT_2_HOST32(rp, FWImageSize);
2783         MPT_2_HOST32(rp, IOCCapabilities);
2784         MPT_2_HOST32(rp, FWVersion.Word);
2785         MPT_2_HOST16(rp, HighPriorityQueueDepth);
2786         MPT_2_HOST16(rp, Reserved2);
2787         mpt2host_sge_simple_union(&rp->HostPageBufferSGE);
2788         MPT_2_HOST32(rp, ReplyFifoHostSignalingAddr);
2789 }
2790
2791 void
2792 mpt2host_portfacts_reply(MSG_PORT_FACTS_REPLY *pfp)
2793 {
2794         MPT_2_HOST16(pfp, Reserved);
2795         MPT_2_HOST16(pfp, Reserved1);
2796         MPT_2_HOST32(pfp, MsgContext);
2797         MPT_2_HOST16(pfp, Reserved2);
2798         MPT_2_HOST16(pfp, IOCStatus);
2799         MPT_2_HOST32(pfp, IOCLogInfo);
2800         MPT_2_HOST16(pfp, MaxDevices);
2801         MPT_2_HOST16(pfp, PortSCSIID);
2802         MPT_2_HOST16(pfp, ProtocolFlags);
2803         MPT_2_HOST16(pfp, MaxPostedCmdBuffers);
2804         MPT_2_HOST16(pfp, MaxPersistentIDs);
2805         MPT_2_HOST16(pfp, MaxLanBuckets);
2806         MPT_2_HOST16(pfp, Reserved4);
2807         MPT_2_HOST32(pfp, Reserved5);
2808 }
2809 void
2810 mpt2host_config_page_ioc2(CONFIG_PAGE_IOC_2 *ioc2)
2811 {
2812         int i;
2813         ioc2->CapabilitiesFlags = htole32(ioc2->CapabilitiesFlags);
2814         for (i = 0; i < MPI_IOC_PAGE_2_RAID_VOLUME_MAX; i++) {
2815                 MPT_2_HOST16(ioc2, RaidVolume[i].Reserved3);
2816         }
2817 }
2818
2819 void
2820 mpt2host_config_page_raid_vol_0(CONFIG_PAGE_RAID_VOL_0 *volp)
2821 {
2822         int i;
2823         MPT_2_HOST16(volp, VolumeStatus.Reserved);
2824         MPT_2_HOST16(volp, VolumeSettings.Settings);
2825         MPT_2_HOST32(volp, MaxLBA);
2826         MPT_2_HOST32(volp, MaxLBAHigh);
2827         MPT_2_HOST32(volp, StripeSize);
2828         MPT_2_HOST32(volp, Reserved2);
2829         MPT_2_HOST32(volp, Reserved3);
2830         for (i = 0; i < MPI_RAID_VOL_PAGE_0_PHYSDISK_MAX; i++) {
2831                 MPT_2_HOST16(volp, PhysDisk[i].Reserved);
2832         }
2833 }
2834
2835 void
2836 mpt2host_mpi_raid_vol_indicator(MPI_RAID_VOL_INDICATOR *vi)
2837 {
2838         MPT_2_HOST16(vi, TotalBlocks.High);
2839         MPT_2_HOST16(vi, TotalBlocks.Low);
2840         MPT_2_HOST16(vi, BlocksRemaining.High);
2841         MPT_2_HOST16(vi, BlocksRemaining.Low);
2842 }
2843 #endif